namespaceEdits.h

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_PCP_NAMESPACE_EDITS_H
#define PXR_USD_PCP_NAMESPACE_EDITS_H
 
#include "pxr/pxr.h"
#include "pxr/usd/pcp/api.h"
#include "pxr/usd/pcp/cache.h"
#include "pxr/base/tf/hashset.h"
 
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
// Forward declarations:
class PcpChanges;
class PcpCacheChanges;
class Pcp_Dependencies;
class PcpLayerStackIdentifier;
class PcpLifeboat;
class PcpNodeRef;
class PcpMapFunction;
 
TF_DECLARE_WEAK_AND_REF_PTRS(PcpLayerStack);
TF_DECLARE_WEAK_AND_REF_PTRS(Pcp_LayerStackRegistry);
SDF_DECLARE_HANDLES(SdfSpec);
 
struct PcpNamespaceEdits {
 
    enum EditType {
        EditPath,        
        EditInherit,     
        EditSpecializes, 
        EditReference,   
        EditPayload,     
        EditRelocate,    
    };
 
    void Swap(PcpNamespaceEdits& rhs)
    {
        cacheSites.swap(rhs.cacheSites);
        layerStackSites.swap(rhs.layerStackSites);
        invalidLayerStackSites.swap(rhs.invalidLayerStackSites);
    }
 
    struct CacheSite {
        size_t cacheIndex;  
        SdfPath oldPath;    
        SdfPath newPath;    
    };
    typedef std::vector<CacheSite> CacheSites;
 
    struct LayerStackSite {
        size_t cacheIndex;              
        EditType type;                  
        PcpLayerStackPtr layerStack;    
        SdfPath sitePath;               
        SdfPath oldPath;                
        SdfPath newPath;                
    };
    typedef std::vector<LayerStackSite> LayerStackSites;
 
    CacheSites cacheSites;
 
    LayerStackSites layerStackSites;
 
    LayerStackSites invalidLayerStackSites;
};
 
PCP_API
PcpNamespaceEdits
PcpComputeNamespaceEdits(const PcpCache *primaryCache,
                         const std::vector<PcpCache*>& caches,
                         const SdfPath& curPath,
                         const SdfPath& newPath,
                         const SdfLayerHandle& relocatesLayer);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_PCP_NAMESPACE_EDITS_H