fixer.h

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_VALIDATION_USD_VALIDATION_FIXER_H
#define PXR_USD_VALIDATION_USD_VALIDATION_FIXER_H
 
#include "pxr/pxr.h"
#include "pxr/base/tf/token.h"
#include "pxr/usd/usd/timeCode.h"
#include "pxr/usdValidation/usdValidation/api.h"
 
#include <functional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdValidationError;
class UsdEditTarget;
 
using FixerImplFn = 
    std::function<bool(
        const UsdValidationError& e, const UsdEditTarget& editTarget,
        const UsdTimeCode& timeCode)>;
 
using FixerCanApplyFn = 
    std::function<bool(
        const UsdValidationError& e, const UsdEditTarget& editTarget,
        const UsdTimeCode& timeCode)>;
 
class UsdValidationFixer
{
public:
    UsdValidationFixer(const UsdValidationFixer&) = default;
    UsdValidationFixer& operator=(const UsdValidationFixer&) = default;
 
    UsdValidationFixer(UsdValidationFixer&&) noexcept = default;
    UsdValidationFixer& operator=(UsdValidationFixer&&) noexcept = default;
    
    USDVALIDATION_API
    UsdValidationFixer(
        const TfToken &name, const std::string &description, 
        const FixerImplFn &fixerImplFn, const FixerCanApplyFn &canApplyFn,
        const TfTokenVector &keywords = TfTokenVector(),
        const TfToken &errorName = TfToken());
 
    ~UsdValidationFixer() = default;
 
    const TfToken &GetName() const &
    { 
        return _name; 
    }
 
    TfToken GetName() &&
    {
        return std::move(_name);
    }
 
    const std::string &GetDescription() const &
    { 
        return _description; 
    }
 
    std::string GetDescription() &&
    {
        return std::move(_description);
    }
 
    const TfToken &GetErrorName() const &
    { 
        return _errorName; 
    }
 
    TfToken GetErrorName() && 
    { 
        return std::move(_errorName); 
    }
 
    USDVALIDATION_API
    bool IsAssociatedWithErrorName(const TfToken &errorName) const;
 
    const TfTokenVector &GetKeywords() const &
    { 
        return _keywords; 
    }
 
    TfTokenVector GetKeywords() && 
    { 
        return std::move(_keywords); 
    }
 
    USDVALIDATION_API
    bool HasKeyword(const TfToken &keyword) const;
 
    USDVALIDATION_API
    bool CanApplyFix(
        const UsdValidationError &error, const UsdEditTarget &editTarget,
        const UsdTimeCode &timeCode = UsdTimeCode::Default()) const;
 
    USDVALIDATION_API
    bool ApplyFix(
        const UsdValidationError &error, const UsdEditTarget &editTarget, 
        const UsdTimeCode &timeCode = UsdTimeCode::Default()) const;
 
private:
    TfToken _name;
    std::string _description;
    FixerImplFn _fixerImplFn;
    FixerCanApplyFn _canApplyFn;
    TfTokenVector _keywords;
    TfToken _errorName;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_VALIDATION_USD_VALIDATION_FIXER_H