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_USD_VALIDATOR_H
#define PXR_USD_USD_VALIDATOR_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/token.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/stage.h"
 
#include <functional>
#include <variant>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdValidationError;
using UsdValidationErrorVector = std::vector<UsdValidationError>;
class UsdPrim;
 
struct UsdValidatorMetadata
{
    TfToken name;
 
    PlugPluginPtr pluginPtr;
    
    TfTokenVector keywords;
 
    std::string doc;
 
    TfTokenVector schemaTypes;
 
    bool isSuite;
}; // UsdValidatorMetadata
 
using UsdValidatorMetadataVector = std::vector<UsdValidatorMetadata>;
 
// TODO:
// - TimeCode (Range), leaving right now for brevity. Will introduce in
// subsequent iterations.
//
//
 
 
using UsdValidateLayerTaskFn = std::function<UsdValidationErrorVector(
    const SdfLayerHandle&)>;
using UsdValidateStageTaskFn = std::function<UsdValidationErrorVector(
    const UsdStagePtr&)>;
using UsdValidatePrimTaskFn = std::function<UsdValidationErrorVector(
    const UsdPrim&)>;
 
 
class UsdValidator
{
public:
    USD_API
    explicit UsdValidator(const UsdValidatorMetadata &metadata);
 
    UsdValidator(const UsdValidator &other) = delete;
    UsdValidator &operator=(const UsdValidator&) = delete;
 
    UsdValidator(UsdValidator &&other) noexcept = default;
    UsdValidator& operator=(UsdValidator&&) noexcept = default;
 
    USD_API
    UsdValidator(const UsdValidatorMetadata &metadata,
                 const UsdValidateLayerTaskFn &validateLayerTaskFn);
 
    USD_API
    UsdValidator(const UsdValidatorMetadata &metadata,
                 const UsdValidateStageTaskFn &validateStageTaskFn);
 
    USD_API
    UsdValidator(const UsdValidatorMetadata &metadata,
                 const UsdValidatePrimTaskFn &validatePrimTaskFn);
 
    const UsdValidatorMetadata& GetMetadata() const &
    {
        return _metadata;
    }
 
    UsdValidatorMetadata GetMetadata() &&
    {
        return std::move(_metadata);
    }
 
    USD_API
    UsdValidationErrorVector Validate(const SdfLayerHandle &layer) const;
 
    USD_API
    UsdValidationErrorVector Validate(const UsdStagePtr &usdStage) const;
 
    USD_API
    UsdValidationErrorVector Validate(const UsdPrim& usdPrim) 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;
 
    UsdValidatorMetadata _metadata;
    std::variant<UsdValidateLayerTaskFn, 
                 UsdValidateStageTaskFn,
                 UsdValidatePrimTaskFn> _validateTaskFn;
 
    // 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;
 
}; // UsdValidator
 
class UsdValidatorSuite
{
public:
    USD_API
    UsdValidatorSuite(const UsdValidatorMetadata &metadata,
                      const std::vector<const UsdValidator*>& validators);
 
    UsdValidatorSuite(UsdValidatorSuite &&other) noexcept = default;
 
    UsdValidatorSuite& operator=(UsdValidatorSuite&&) noexcept = default;
 
    const std::vector<const UsdValidator*>& GetContainedValidators() const &
    {
        return _containedValidators;
    }
 
    std::vector<const UsdValidator*> GetContainedValidators() &&
    {
        return std::move(_containedValidators);
    }
 
    const UsdValidatorMetadata& GetMetadata() const &
    {
        return _metadata;
    }
 
    UsdValidatorMetadata GetMetadata() &&
    {
        return std::move(_metadata);
    }
 
private:
    UsdValidatorMetadata _metadata;
    std::vector<const UsdValidator*> _containedValidators;
}; // UsdValidatorSuite
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_VALIDATOR_H