24 #ifndef PXR_USD_SDF_PATH_H
25 #define PXR_USD_SDF_PATH_H
36 #include <hboost/intrusive_ptr.hpp>
37 #include <hboost/operators.hpp>
43 #include <type_traits>
63 struct Sdf_PathPrimTag;
64 struct Sdf_PathPropTag;
67 static constexpr
size_t Sdf_SizeofPrimPathNode =
sizeof(
void *) * 3;
68 static constexpr
size_t Sdf_SizeofPropPathNode =
sizeof(
void *) * 3;
71 Sdf_PathPrimTag, Sdf_SizeofPrimPathNode, 8>;
74 Sdf_PathPropTag, Sdf_SizeofPropPathNode, 8>;
80 template <
class Handle,
bool Counted,
class PathNode=Sdf_PathNode const>
92 : _poolHandle(
Handle::GetHandle(reinterpret_cast<char
const *>(p))) {
107 : _poolHandle(rhs._poolHandle) {
121 if (Counted && *
this == rhs) {
129 : _poolHandle(rhs._poolHandle) {
130 rhs._poolHandle =
nullptr;
146 _poolHandle =
Handle {
nullptr };
150 get()
const noexcept {
151 return reinterpret_cast<Sdf_PathNode *
>(_poolHandle.GetPtr());
164 explicit operator bool()
const noexcept {
165 return static_cast<bool>(_poolHandle);
169 _poolHandle.swap(rhs._poolHandle);
173 return _poolHandle == rhs._poolHandle;
176 return _poolHandle != rhs._poolHandle;
179 return _poolHandle < rhs._poolHandle;
189 inline void _AddRef()
const {
193 inline void _DecRef()
const {
199 Handle _poolHandle {
nullptr };
309 #if defined(ARCH_COMPILER_GCC) && ARCH_COMPILER_GCC_MAJOR <= 6
313 memset(
this, 0,
sizeof(*
this));
398 return static_cast<bool>(_propPart);
769 const SdfPath &newPrefix,
770 bool fixTargetPaths=
true)
const;
792 std::pair<SdfPath, SdfPath>
794 bool stopAtRootPrim =
false)
const;
891 static std::pair<std::string, bool>
910 return _AsInt() == rhs._AsInt();
915 return !(*
this == rhs);
923 if (_AsInt() == rhs._AsInt()) {
926 if (!_primPart || !rhs._primPart) {
927 return !_primPart && rhs._primPart;
930 return _LessThanInternal(*
this, rhs);
942 return !(rhs < *
this);
948 return !(*
this < rhs);
951 template <
class HashState>
955 uint32_t primPart, propPart;
956 memcpy(&primPart, &path._primPart,
sizeof(primPart));
957 memcpy(&propPart, &path._propPart,
sizeof(propPart));
970 return Hash()(*this);
977 return a._AsInt() < b._AsInt();
1014 : _primPart(std::move(primNode)) {}
1018 : _primPart(std::move(primPart))
1019 , _propPart(std::move(propPart)) {}
1024 : _primPart(primPart)
1025 , _propPart(propPart) {}
1030 : _primPart(primPart)
1031 , _propPart(propPart) {}
1039 _ElementsToString(
bool absolute,
const std::vector<std::string> &elements);
1041 SdfPath _ReplacePrimPrefix(SdfPath
const &oldPrefix,
1042 SdfPath
const &newPrefix)
const;
1044 SdfPath _ReplaceTargetPathPrefixes(SdfPath
const &oldPrefix,
1045 SdfPath
const &newPrefix)
const;
1047 SdfPath _ReplacePropPrefix(SdfPath
const &oldPrefix,
1048 SdfPath
const &newPrefix,
1049 bool fixTargetPaths)
const;
1053 _LessThanInternal(SdfPath
const &lhs, SdfPath
const &rhs);
1055 inline uint64_t _AsInt()
const {
1056 static_assert(
sizeof(*
this) ==
sizeof(uint64_t),
"");
1058 std::memcpy(&ret,
this,
sizeof(*
this));
1062 friend void swap(SdfPath &lhs, SdfPath &rhs) {
1063 lhs._primPart.
swap(rhs._primPart);
1064 lhs._propPart.
swap(rhs._propPart);
1165 template <
class ForwardIterator,
class GetPathFn = Sdf_PathIdentity>
1166 std::pair<ForwardIterator, ForwardIterator>
1168 SdfPath
const &prefix,
1169 GetPathFn
const &getPath = GetPathFn()) {
1171 typename std::iterator_traits<ForwardIterator>::reference;
1174 Compare(GetPathFn
const &getPath) : _getPath(getPath) {}
1175 GetPathFn
const &_getPath;
1176 bool operator()(IterRef
a, SdfPath
const &
b)
const {
1177 return _getPath(a) <
b;
1181 std::pair<ForwardIterator, ForwardIterator>
result;
1184 result.first = std::lower_bound(begin, end, prefix, Compare(getPath));
1188 result.second = TfFindBoundary(result.first, end,
1189 [&prefix, &getPath](IterRef iterRef) {
1190 return getPath(iterRef).HasPrefix(prefix);
1196 template <
class RandomAccessIterator,
class GetPathFn>
1197 RandomAccessIterator
1199 RandomAccessIterator
end,
1200 SdfPath
const &path,
1202 GetPathFn
const &getPath)
1205 typename std::iterator_traits<RandomAccessIterator>::reference;
1208 Compare(GetPathFn
const &getPath) : _getPath(getPath) {}
1209 GetPathFn
const &_getPath;
1210 bool operator()(IterRef
a, SdfPath
const &
b)
const {
1211 return _getPath(a) <
b;
1224 Compare comp(getPath);
1227 RandomAccessIterator
result = std::lower_bound(begin, end, path, comp);
1231 if (!strictPrefix && result != end && getPath(*result) == path) {
1237 if (result == begin) {
1242 if (path.
HasPrefix(getPath(*--result))) {
1252 result = std::lower_bound(begin, end, newPath, comp);
1254 if (result != end && getPath(*result) == newPath) {
1257 if (result == begin) {
1260 if (newPath.
HasPrefix(getPath(*--result))) {
1275 class =
typename std::enable_if<
1277 std::random_access_iterator_tag,
1278 typename std::iterator_traits<
1279 RandomAccessIterator>::iterator_category
1283 RandomAccessIterator
1285 RandomAccessIterator
end,
1286 SdfPath
const &path,
1287 GetPathFn
const &getPath = GetPathFn())
1290 begin, end, path,
false, getPath);
1301 class =
typename std::enable_if<
1303 std::random_access_iterator_tag,
1304 typename std::iterator_traits<
1305 RandomAccessIterator>::iterator_category
1309 RandomAccessIterator
1311 RandomAccessIterator end,
1312 SdfPath
const &path,
1313 GetPathFn
const &getPath = GetPathFn())
1316 begin, end, path,
true, getPath);
1319 template <
class Iter,
class MapParam,
class GetPathFn = Sdf_PathIdentity>
1322 MapParam map, SdfPath
const &path,
bool strictPrefix,
1323 GetPathFn
const &getPath = GetPathFn())
1330 const Iter mapEnd = map.end();
1337 Iter
result = map.lower_bound(path);
1341 if (!strictPrefix && result != mapEnd && getPath(*result) == path)
1346 if (result == map.begin())
1357 return Sdf_PathFindLongestPrefixImpl<Iter, MapParam>(
1366 typename std::set<SdfPath>::const_iterator
1373 typename std::map<SdfPath, T>::const_iterator
1377 typename std::map<SdfPath, T>::const_iterator,
1378 std::map<SdfPath, T>
const &>(map,
path,
false,
1382 typename std::map<SdfPath, T>::iterator
1386 typename std::map<SdfPath, T>::iterator,
1387 std::map<SdfPath, T> &>(map,
path,
false,
1395 typename std::set<SdfPath>::const_iterator
1397 SdfPath
const &path);
1403 typename std::map<SdfPath, T>::const_iterator
1405 std::map<SdfPath, T>
const &map, SdfPath
const &path)
1408 typename std::map<SdfPath, T>::const_iterator,
1409 std::map<SdfPath, T>
const &>(map,
path,
true,
1413 typename std::map<SdfPath, T>::iterator
1415 std::map<SdfPath, T> &map, SdfPath
const &path)
1418 typename std::map<SdfPath, T>::iterator,
1419 std::map<SdfPath, T> &>(map,
path,
true,
1446 #endif // PXR_USD_SDF_PATH_H
SDF_API const char * GetText() const
SDF_API bool IsPrimOrPrimVariantSelectionPath() const
SDF_API SdfPath AppendTarget(const SdfPath &targetPath) const
SDF_API bool IsMapperPath() const
Returns whether the path identifies a connection mapper.
friend void swap(SdfPath &lhs, SdfPath &rhs)
SDF_API iterator & operator++()
SDF_API const std::string & GetName() const
static SDF_API const SdfPath & AbsoluteRootPath()
friend class Sdfext_PathAccess
static constexpr bool IsCounted
Sdf_PathNodeHandleImpl(Sdf_PathNodeHandleImpl const &rhs) noexcept
SDF_API std::string GetElementString() const
SDF_API bool IsExpressionPath() const
Returns whether the path identifies a connection expression.
SDF_API SdfPath AppendExpression() const
iterator(const SdfPath &path)
Sdf_PathNodeHandleImpl(Handle h, bool add_ref=true)
SDF_API SdfPath AppendMapper(const SdfPath &targetPath) const
STATIC_INLINE size_t Hash(const char *s, size_t len)
SDF_API char const * Sdf_PathGetDebuggerPathText(SdfPath const &)
bool operator==(const SdfPath &rhs) const
Equality operator.
Sdf_PathPropPartPool::Handle Sdf_PathPropHandle
SDF_API SdfPath ReplaceTargetPath(const SdfPath &newTargetPath) const
std::pair< ForwardIterator, ForwardIterator > SdfPathFindPrefixedRange(ForwardIterator begin, ForwardIterator end, SdfPath const &prefix, GetPathFn const &getPath=GetPathFn())
static SDF_API bool IsValidPathString(const std::string &pathString, std::string *errMsg=0)
GLsizei const GLchar *const * string
RandomAccessIterator Sdf_PathFindLongestPrefixImpl(RandomAccessIterator begin, RandomAccessIterator end, SdfPath const &path, bool strictPrefix, GetPathFn const &getPath)
SDF_API bool IsAbsoluteRootPath() const
Return true if this path is the AbsoluteRootPath().
GLsizei const GLchar *const * path
SDF_API bool IsMapperArgPath() const
Returns whether the path identifies a connection mapper arg.
SDF_API const SdfPath & GetTargetPath() const
SDF_API bool IsPrimPropertyPath() const
SDF_API SdfPath GetAbsoluteRootOrPrimPath() const
SdfPathAncestorsRange(const SdfPath &path)
SDF_API TfToken GetAsToken() const
Sdf_PathNodeHandleImpl & operator=(Sdf_PathNodeHandleImpl &&rhs) noexcept
bool operator==(const iterator &o) const
GLboolean GLboolean GLboolean GLboolean a
static SDF_API void RemoveDescendentPaths(SdfPathVector *paths)
bool IsEmpty() const noexcept
Returns true if this is the empty path (SdfPath::EmptyPath()).
bool operator==(Sdf_PathNodeHandleImpl const &rhs) const noexcept
**But if you need a result
Sdf_PathNodeHandleImpl(Sdf_PathNode const *p, bool add_ref=true)
auto arg(const Char *name, const T &arg) -> detail::named_arg< Char, T >
SdfPath const & operator()(SdfPath const &arg) const
size_t GetHash() const
Equality operator.
SDF_API std::pair< std::string, std::string > GetVariantSelection() const
SDF_API SdfPath StripAllVariantSelections() const
bool operator!=(const iterator &o) const
SDF_API SdfPath AppendRelationalAttribute(TfToken const &attrName) const
static SDF_API std::vector< std::string > TokenizeIdentifier(const std::string &name)
static SDF_API const SdfPath & EmptyPath()
The empty path value, equivalent to SdfPath().
const SdfPath & operator*() const
bool operator<(const SdfPath &rhs) const
void swap(Sdf_PathNodeHandleImpl &rhs) noexcept
friend void TfHashAppend(HashState &h, SdfPath const &path)
Equality operator.
SDF_API void GetAllTargetPathsRecursively(SdfPathVector *result) const
bool ContainsPropertyElements() const
SDF_API bool IsPrimVariantSelectionPath() const
bool operator!=(Sdf_PathNodeHandleImpl const &rhs) const noexcept
~Sdf_PathNodeHandleImpl()
void intrusive_ptr_add_ref(Sdf_PathNode const *)
SDF_API SdfPath AppendChild(TfToken const &childName) const
static SDF_API bool IsValidNamespacedIdentifier(const std::string &name)
Sdf_PathNode const & operator*() const
bool operator>=(const SdfPath &rhs) const
SDF_API SdfPath AppendVariantSelection(const std::string &variantSet, const std::string &variant) const
SDF_API SdfPath AppendMapperArg(TfToken const &argName) const
SDF_API bool IsAbsolutePath() const
Returns whether the path is absolute.
static SDF_API std::string JoinIdentifier(const std::vector< std::string > &names)
std::vector< TfToken > TfTokenVector
Convenience types.
SDF_API bool ContainsTargetPath() const
static SDF_API bool IsValidIdentifier(const std::string &name)
SdfPath() noexcept=default
SDF_API size_t GetPathElementCount() const
Returns the number of path elements in this path.
GLuint const GLchar * name
SDF_API TfToken GetElementToken() const
Like GetElementString() but return the value as a TfToken.
SDF_API const std::string & GetString() const
SDF_API bool IsPrimPath() const
Returns whether the path identifies a prim.
GLboolean GLboolean GLboolean b
size_t operator()(const SdfPath &path) const
Sdf_PathPrimPartPool::Handle Sdf_PathPrimHandle
Sdf_PathNodeHandleImpl & operator=(Sdf_PathNode const *rhs) noexcept
std::vector< class SdfPath > SdfPathVector
A vector of SdfPaths.
constexpr Sdf_PathNodeHandleImpl() noexcept
SDF_API const TfToken & GetNameToken() const
SDF_API bool HasPrefix(const SdfPath &prefix) const
SDF_API bool IsRelationalAttributePath() const
std::set< class SdfPath > SdfPathSet
A set of SdfPaths.
SDF_API SdfPath AppendProperty(TfToken const &propName) const
SDF_API bool ContainsPrimVariantSelection() const
hboost::intrusive_ptr< const Sdf_PathNode > Sdf_PathNodeConstRefPtr
std::forward_iterator_tag iterator_category
GLfloat GLfloat GLfloat GLfloat h
bool operator<(Sdf_PathNodeHandleImpl const &rhs) const noexcept
SDF_API std::ostream & operator<<(std::ostream &out, const SdfPath &path)
Writes the string representation of path to out.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
const SdfPath * operator->() const
SDF_API SdfPathAncestorsRange GetAncestorsRange() const
SDF_API SdfPath GetCommonPrefix(const SdfPath &path) const
SDF_API TfToken const & GetToken() const
SDF_API bool IsTargetPath() const
Sdf_PathNodeHandleImpl & operator=(Sdf_PathNodeHandleImpl const &rhs)
SDF_API std::pair< SdfPath, SdfPath > RemoveCommonSuffix(const SdfPath &otherPath, bool stopAtRootPrim=false) const
size_t hash_value(SdfPath const &path)
SDF_API bool IsRootPrimPath() const
SDF_API SdfPath AppendPath(const SdfPath &newSuffix) const
SDF_API std::string GetAsString() const
const SdfPath & GetPath() const
void intrusive_ptr_release(Sdf_PathNode const *)
SDF_API SdfPath MakeAbsolutePath(const SdfPath &anchor) const
#define PXR_NAMESPACE_CLOSE_SCOPE
SDF_API bool IsNamespacedPropertyPath() const
SDF_API SdfPath AppendElementToken(const TfToken &elementTok) const
Like AppendElementString() but take the element as a TfToken.
SDF_API SdfPath GetParentPath() const
static SDF_API SdfPathVector GetConciseRelativePaths(const SdfPathVector &paths)
SDF_API SdfPath GetPrimOrPrimVariantSelectionPath() const
SDF_API bool IsPropertyPath() const
static SDF_API std::pair< std::string, bool > StripPrefixNamespace(const std::string &name, const std::string &matchNamespace)
SDF_API friend char const * Sdf_PathGetDebuggerPathText(SdfPath const &)
SDF_API friend difference_type distance(const iterator &first, const iterator &last)
RandomAccessIterator SdfPathFindLongestPrefix(RandomAccessIterator begin, RandomAccessIterator end, SdfPath const &path, GetPathFn const &getPath=GetPathFn())
static SDF_API void RemoveAncestorPaths(SdfPathVector *paths)
SDF_API bool IsAbsoluteRootOrPrimPath() const
Returns whether the path identifies a prim or the absolute root.
RandomAccessIterator SdfPathFindLongestStrictPrefix(RandomAccessIterator begin, RandomAccessIterator end, SdfPath const &path, GetPathFn const &getPath=GetPathFn())
Sdf_PathNode const * operator->() const
bool operator!=(const SdfPath &rhs) const
Inequality operator.
Sdf_PathNodeHandleImpl(Sdf_PathNodeHandleImpl &&rhs) noexcept
SDF_API SdfPathVector GetPrefixes() const
static SDF_API std::string StripNamespace(const std::string &name)
SDF_API SdfPath ReplaceName(TfToken const &newName) const
bool operator<=(const SdfPath &rhs) const
static SDF_API const SdfPath & ReflexiveRelativePath()
The relative path representing "self".
bool operator>(const SdfPath &rhs) const
SDF_API SdfPath AppendElementString(const std::string &element) const
bool operator()(const SdfPath &a, const SdfPath &b) const
VT_TYPE_IS_CHEAP_TO_COPY(class SdfPath)
std::ptrdiff_t difference_type
SDF_API SdfPath MakeRelativePath(const SdfPath &anchor) const
SDF_API SdfPath ReplacePrefix(const SdfPath &oldPrefix, const SdfPath &newPrefix, bool fixTargetPaths=true) const
SDF_API SdfPath GetPrimPath() const
static SDF_API TfTokenVector TokenizeIdentifierAsTokens(const std::string &name)
PcpNodeRef_ChildrenIterator begin(const PcpNodeRef::child_const_range &r)
Support for range-based for loops for PcpNodeRef children ranges.