path.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/path.h"
#ifndef _ufePath
#define _ufePath
// ===========================================================================
// Copyright 2018 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================

#include "pathSegment.h"

#include <vector>

UFE_NS_DEF {

class PathComponent;


class UFE_SDK_DECL Path
{
public:

    typedef std::vector<PathSegment> Segments;
    typedef PathSegment::Components  Components;

    Path() = default;

    Path(const Segments& segments);

    Path(Segments&& segments) noexcept;

    Path(const PathSegment& segment);

    Path(PathSegment&& segment) noexcept;

    Path(const Path&) = default;

    Path& operator=(const Path&) = default;

    Path(Path&&) noexcept;

    Path& operator=(Path&& rhs) noexcept;

    Components::size_type size() const;

    bool empty() const;

    bool operator==(const Path& rhs) const;
    bool operator!=(const Path& rhs) const;

    Path operator+(const PathSegment& rhs) const;
    Path operator+(const PathComponent& rhs) const;
    Path operator+(const std::string& rhs) const;

    Path pop() const;

    Path popSegment() const;

    Path popHead() const;

    Path head(int nbComponents) const;

    PathComponent back() const;

    Path sibling(const PathComponent& newTail) const;

    bool startsWith(const Path& prefix) const;

    Path replaceComponent(int index, const PathComponent& replacement) const;

    Path reparent(const Path& originalPrefix, const Path& newPrefix) const;

    Components::const_iterator cbegin() const;
    Components::const_iterator begin() const;
    Components::const_iterator cend() const;
    Components::const_iterator end() const;
    Components::iterator       begin();
    Components::iterator       end();

    Rtid runTimeId() const;

    const Segments& getSegments() const;

    Segments::size_type nbSegments() const;

    std::string string() const;

    std::int32_t hash() const;

private:

    Segments   fSegments;
    // Provide support for component-based access and iteration.  This
    // doubles up space requirements, but components are not expensive
    // (size of a shared pointer, typically two plain pointers).
    Components fComponents;

    // A Path is immutable, so its hash value can be cached once computed.
    // -1 is an illegal hash value.
    mutable std::int32_t fHashValue {-1};
};

}

// Allow for use of Path with std::unordered_map.
namespace std {
template <> struct hash<UFE_VERSIONED_NS::Path> {
    std::size_t operator()(const UFE_VERSIONED_NS::Path& path) const {return path.hash();}
};
}

#endif /* _ufePath */