All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
packageUtils.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef AR_PACKAGE_UTILS_H
25 #define AR_PACKAGE_UTILS_H
26 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/ar/api.h"
32 
33 #include <string>
34 #include <vector>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 // --------------------------------------------------------------------- //
63 // --------------------------------------------------------------------- //
64 
66 AR_API
67 bool
68 ArIsPackageRelativePath(const std::string& path);
69 
83 AR_API
84 std::string
85 ArJoinPackageRelativePath(const std::vector<std::string>& paths);
86 
88 AR_API
89 std::string
90 ArJoinPackageRelativePath(const std::pair<std::string, std::string>& paths);
91 
93 AR_API
94 std::string
96  const std::string& packagePath, const std::string& packagedPath);
97 
110 AR_API
111 std::pair<std::string, std::string>
112 ArSplitPackageRelativePathOuter(const std::string& path);
113 
126 AR_API
127 std::pair<std::string, std::string>
128 ArSplitPackageRelativePathInner(const std::string& path);
129 
131 
132 PXR_NAMESPACE_CLOSE_SCOPE
133 
134 #endif // AR_PACKAGE_UTILS_H
AR_API std::pair< std::string, std::string > ArSplitPackageRelativePathOuter(const std::string &path)
Split package-relative path path into a (package path, packaged path) pair.
AR_API std::pair< std::string, std::string > ArSplitPackageRelativePathInner(const std::string &path)
Split package-relative path path into a (package path, packaged path) pair.
AR_API std::string ArJoinPackageRelativePath(const std::vector< std::string > &paths)
Combines the given paths into a single package-relative path, nesting paths as necessary.
AR_API bool ArIsPackageRelativePath(const std::string &path)
Return true if path is a package-relative path, false otherwise.