dependentNamespaceEditUtils.h

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_PCP_DEPENDENT_NAMESPACE_EDIT_UTILS_H
#define PXR_USD_PCP_DEPENDENT_NAMESPACE_EDIT_UTILS_H
 
#include "pxr/pxr.h"
#include "pxr/usd/pcp/api.h"
#include "pxr/usd/pcp/cache.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/base/tf/hash.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/value.h"
 
#include <string>
#include <unordered_map>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_DECLARE_HANDLES(SdfLayer);
TF_DECLARE_REF_PTRS(PcpLayerStack);
 
class PcpDependentNamespaceEdits {
public:
    struct CompositionFieldEdit {
        SdfLayerHandle layer;
 
        SdfPath path;
 
        TfToken fieldName;
 
        VtValue newFieldValue;
    };
 
    std::vector<CompositionFieldEdit> compositionFieldEdits;
 
    struct MoveEditDescription {
        SdfPath oldPath;
        SdfPath newPath;
    };
    using MoveEditDescriptionVector = std::vector<MoveEditDescription>;
 
    using LayerSpecMoveEdits = std::unordered_map<
        SdfLayerHandle, MoveEditDescriptionVector, TfHash>;
    LayerSpecMoveEdits layerSpecMoves;
 
    using LayerRelocatesEdits = 
        std::unordered_map<SdfLayerHandle, SdfRelocates, TfHash>;
    LayerRelocatesEdits dependentRelocatesEdits;
 
    std::vector<std::string> errors;
 
    std::vector<std::string> warnings;
 
    std::unordered_map<const PcpCache *, MoveEditDescriptionVector> 
        dependentCachePathChanges;
};
 
PCP_API
PcpDependentNamespaceEdits
PcpGatherDependentNamespaceEdits(
    const SdfPath &oldPrimPath,
    const SdfPath &newPrimPath,
    const SdfLayerHandleVector &affectedLayers,
    const PcpLayerStackRefPtr &addRelocatesToLayerStack,
    const SdfLayerHandle &addRelocatesToLayerStackEditLayer,
    const std::vector<const PcpCache *> &dependentCaches);
 
PCP_API
SdfLayerHandleVector
PcpGatherLayersToEditForSpecMove(
    const PcpLayerStackRefPtr &layerStack,
    const SdfPath &oldSpecPath,
    const SdfPath &newSpecPath,
    std::vector<std::string> *errors);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_PCP_NAMESPACE_EDITS_H