validator.h

Go to the documentation of this file.

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_VALIDATION_USD_VALIDATION_VALIDATOR_H
#define PXR_USD_VALIDATION_USD_VALIDATION_VALIDATOR_H


#include "pxr/pxr.h"
#include "pxr/base/gf/interval.h"
#include "pxr/base/tf/token.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usd/timeCode.h"
#include "pxr/usdValidation/usdValidation/api.h"
#include "pxr/usdValidation/usdValidation/timeRange.h"
#include "pxr/usdValidation/usdValidation/fixer.h"

#include <functional>
#include <string>
#include <variant>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

class UsdValidationError;
using UsdValidationErrorVector = std::vector<UsdValidationError>;
class UsdPrim;

struct UsdValidationValidatorMetadata
{
    TfToken name;

    PlugPluginPtr pluginPtr;

    TfTokenVector keywords;

    std::string doc;

    TfTokenVector schemaTypes;

    bool isTimeDependent = false;

    bool isSuite = false;
}; // UsdValidationValidatorMetadata

using UsdValidationValidatorMetadataVector
    = std::vector<UsdValidationValidatorMetadata>;


using UsdValidateLayerTaskFn = std::function<UsdValidationErrorVector(
    const SdfLayerHandle &)>;
using UsdValidateStageTaskFn = std::function<UsdValidationErrorVector(
    const UsdStagePtr &, const UsdValidationTimeRange)>;
using UsdValidatePrimTaskFn = std::function<UsdValidationErrorVector(
    const UsdPrim &, const UsdValidationTimeRange)>;


class UsdValidationValidator
{
public:
    USDVALIDATION_API
    explicit UsdValidationValidator(
        const UsdValidationValidatorMetadata &metadata);

    UsdValidationValidator(const UsdValidationValidator &other) = delete;
    UsdValidationValidator &operator=(const UsdValidationValidator &) = delete;

    UsdValidationValidator(UsdValidationValidator &&other) noexcept = default;
    UsdValidationValidator &operator=(UsdValidationValidator &&) noexcept
        = default;

    USDVALIDATION_API
    UsdValidationValidator(const UsdValidationValidatorMetadata &metadata,
                           const UsdValidateLayerTaskFn &validateLayerTaskFn,
                           std::vector<UsdValidationFixer> fixers = {});

    USDVALIDATION_API
    UsdValidationValidator(const UsdValidationValidatorMetadata &metadata,
                           const UsdValidateStageTaskFn &validateStageTaskFn,
                           std::vector<UsdValidationFixer> fixers = {});

    USDVALIDATION_API
    UsdValidationValidator(const UsdValidationValidatorMetadata &metadata,
                           const UsdValidatePrimTaskFn &validatePrimTaskFn,
                           std::vector<UsdValidationFixer> fixers = {});

    const UsdValidationValidatorMetadata &GetMetadata() const &
    {
        return _metadata;
    }

    UsdValidationValidatorMetadata GetMetadata() &&
    {
        return std::move(_metadata);
    }

    USDVALIDATION_API
    const std::vector<const UsdValidationFixer *> GetFixers() const;

    USDVALIDATION_API
    const UsdValidationFixer *GetFixerByName(const TfToken &name) const;

    USDVALIDATION_API
    const std::vector<const UsdValidationFixer *> GetFixersByErrorName(
        const TfToken &errorName) const;

    USDVALIDATION_API
    const UsdValidationFixer *GetFixerByNameAndErrorName(
        const TfToken &name, const TfToken &errorName) const;

    USDVALIDATION_API
    const std::vector<const UsdValidationFixer *> GetFixersByKeywords(
        const TfTokenVector &keywords) const;

    USDVALIDATION_API
    UsdValidationErrorVector Validate(const SdfLayerHandle &layer) const;

    USDVALIDATION_API
    UsdValidationErrorVector Validate(
        const UsdStagePtr &usdStage,
        const UsdValidationTimeRange &timeRange = {}) const;

    USDVALIDATION_API
    UsdValidationErrorVector Validate(
        const UsdPrim &usdPrim, 
        const UsdValidationTimeRange &timeRange = {}) const;

private:
    // To make sure registry can query task types on a validator.
    // Registry needs access to _GetValidatorPrimTasks, in order to determine if
    // the contained validators in a suite, which provides schemaTypes metadata
    // are compliant.
    friend class UsdValidationRegistry;
    // In order to distribute validators into different sets based on the type
    // of validation to be performed, ValidationContext needs to access
    // _GetValidateLayerTask, _GetValidateStageTask and _GetValidatePrimTask.
    friend class UsdValidationContext;

    UsdValidationValidatorMetadata _metadata;
    std::variant<UsdValidateLayerTaskFn, UsdValidateStageTaskFn,
                 UsdValidatePrimTaskFn>
        _validateTaskFn;

    std::vector<UsdValidationFixer> _fixers;

    // Return UsdValidateLayerTaskFn if provided by the validator, else a
    // nullptr.
    const UsdValidateLayerTaskFn *_GetValidateLayerTask() const;

    // Return UsdValidateStageTaskFn if provided by the validator, else a
    // nullptr.
    const UsdValidateStageTaskFn *_GetValidateStageTask() const;

    // Return UsdValidatePrimTaskFn if provided by the validator, else a
    // nullptr.
    const UsdValidatePrimTaskFn *_GetValidatePrimTask() const;

    // Helper to validate that all fixers have unique names. Issues a coding
    // error if not unique.
    void _ValidateFixerNames() const;

}; // UsdValidationValidator

class UsdValidationValidatorSuite
{
public:
    USDVALIDATION_API
    UsdValidationValidatorSuite(
        const UsdValidationValidatorMetadata &metadata,
        const std::vector<const UsdValidationValidator *> &validators);

    UsdValidationValidatorSuite(UsdValidationValidatorSuite &&other) noexcept
        = default;

    UsdValidationValidatorSuite &
    operator=(UsdValidationValidatorSuite &&) noexcept
        = default;

    const std::vector<const UsdValidationValidator *> &
    GetContainedValidators() const &
    {
        return _containedValidators;
    }

    std::vector<const UsdValidationValidator *> GetContainedValidators() &&
    {
        return std::move(_containedValidators);
    }

    const UsdValidationValidatorMetadata &GetMetadata() const &
    {
        return _metadata;
    }

    UsdValidationValidatorMetadata GetMetadata() &&
    {
        return std::move(_metadata);
    }

private:
    UsdValidationValidatorMetadata _metadata;
    std::vector<const UsdValidationValidator *> _containedValidators;
}; // UsdValidationValidatorSuite

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_VALIDATION_USD_VALIDATION_VALIDATOR_H