layerRelocatesEditBuilder.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_PCP_LAYER_RELOCATES_EDIT_BUILDER_H
#define PXR_USD_PCP_LAYER_RELOCATES_EDIT_BUILDER_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/pcp/api.h"
#include "pxr/usd/pcp/errors.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/types.h"
#include "pxr/base/tf/declarePtrs.h"
 
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_DECLARE_HANDLES(SdfLayer);
TF_DECLARE_WEAK_PTRS(PcpLayerStack);
 
class PcpLayerRelocatesEditBuilder {
public:
 
    PCP_API
    PcpLayerRelocatesEditBuilder(
        const PcpLayerStackPtr &layerStack,
        const SdfLayerHandle &addNewRelocatesLayer = nullptr);
 
    PCP_API
    bool Relocate(
        const SdfPath &sourcePath, 
        const SdfPath &targetPath, 
        std::string *whyNot = nullptr);
 
    PCP_API
    bool RemoveRelocate(
        const SdfPath &sourcePath,
        std::string *whyNot = nullptr);
 
    using LayerRelocatesEdit = std::pair<SdfLayerHandle, SdfRelocates>;
 
    using LayerRelocatesEdits = std::vector<LayerRelocatesEdit>;
 
    PCP_API
    LayerRelocatesEdits GetEdits() const;
 
    PCP_API
    const SdfRelocatesMap &GetEditedRelocatesMap() const;
 
private:
    void _UpdateExistingRelocates(
        const SdfPath &source, const SdfPath &target);
 
    void _RemoveRelocatesWithErrors(const PcpErrorVector &errors);
 
    mutable std::optional<SdfRelocatesMap> _relocatesMap;
 
    LayerRelocatesEdits _layerRelocatesEdits;
    SdfLayerHandleSet _layersWithRelocatesChanges;
    size_t _editForNewRelocatesIndex = ~0;
};
 
// Modifies the given relocates in place by moving paths at or under 
// oldPath to be at or under newPath.
// 
// The old path may not be empty but the new path can be. Any relocates
// that become invalid or no-ops are removed from the resulting modified
// relocates. Returns true if any modifications were made to the relocates,
// false otherwise.
bool 
Pcp_ModifyRelocates(
    SdfRelocates *relocates, const SdfPath &oldPath, const SdfPath &newPath);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_PCP_LAYER_RELOCATES_EDIT_BUILDER_H