Loading...
Searching...
No Matches
pathUtils.h
Go to the documentation of this file.
1//
2// Copyright 2016 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 PXR_BASE_TF_PATH_UTILS_H
25#define PXR_BASE_TF_PATH_UTILS_H
26
27#include "pxr/pxr.h"
28#include "pxr/base/tf/api.h"
30#include <string>
31#include <vector>
32
33PXR_NAMESPACE_OPEN_SCOPE
34
41
57TF_API
58std::string TfRealPath(std::string const& path,
59 bool allowInaccessibleSuffix = false,
60 std::string* error = 0);
61
71TF_API
72std::string TfNormPath(std::string const& path,
73 bool stripDriveSpecifier = false);
74
93TF_API
94std::string::size_type
95TfFindLongestAccessiblePrefix(std::string const &path, std::string* error = 0);
96
104TF_API
105std::string TfAbsPath(std::string const& path);
106
121TF_API
122std::string TfGetExtension(std::string const& path);
123
126TF_API
127std::string TfReadLink(std::string const& path);
128
130TF_API
131bool TfIsRelativePath(std::string const& path);
132
140TF_API
141std::vector<std::string> TfGlob(std::vector<std::string> const& paths,
142 unsigned int flags=ARCH_GLOB_DEFAULT);
143
150TF_API
151std::vector<std::string> TfGlob(std::string const& path,
152 unsigned int flags=ARCH_GLOB_DEFAULT);
153
154PXR_NAMESPACE_CLOSE_SCOPE
155
156#endif /* PXR_BASE_TF_PATH_UTILS_H */
Architecture dependent file system access.
TF_API std::string TfAbsPath(std::string const &path)
Returns the canonical absolute path of the specified filename.
TF_API std::string::size_type TfFindLongestAccessiblePrefix(std::string const &path, std::string *error=0)
Return the index delimiting the longest accessible prefix of path.
TF_API std::string TfReadLink(std::string const &path)
Returns the value of a symbolic link.
TF_API std::string TfNormPath(std::string const &path, bool stripDriveSpecifier=false)
Normalizes the specified path, eliminating double slashes, etc.
TF_API bool TfIsRelativePath(std::string const &path)
Return true if and only if a path is relative (not absolute).
TF_API std::vector< std::string > TfGlob(std::vector< std::string > const &paths, unsigned int flags=ARCH_GLOB_DEFAULT)
Expands one or more shell glob patterns.
TF_API std::string TfGetExtension(std::string const &path)
Returns the extension for a file path.
TF_API std::string TfRealPath(std::string const &path, bool allowInaccessibleSuffix=false, std::string *error=0)
Returns the canonical path of the specified filename, eliminating any symbolic links encountered in t...