All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.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 PCP_UTILS_H
25 #define PCP_UTILS_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/sdf/layer.h"
31 
32 #include <string>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 // Returns an SdfLayer::FileFormatArguments object with the "target" argument
37 // set to \p target if \p target is not empty.
39 Pcp_GetArgumentsForFileFormatTarget(
40  const std::string& target);
41 
42 // Returns an SdfLayer::FileFormatArguments object with the "target" argument
43 // set to \p target if \p target is not empty and a target is
44 // not embedded within the given \p identifier.
46 Pcp_GetArgumentsForFileFormatTarget(
47  const std::string& identifier,
48  const std::string& target);
49 
50 // \overload
51 // Same as above, but modifies \p args instead of returning by value.
52 void
53 Pcp_GetArgumentsForFileFormatTarget(
54  const std::string& identifier,
55  const std::string& target,
57 
58 // If a target argument is embedded in \p identifier, copies contents of
59 // \p defaultArgs to \p localArgs, removes the "target" argument, and returns
60 // a const reference to \p localArgs. Otherwise, returns a const reference to
61 // \p defaultArgs. This lets us avoid making a copy of \p defaultArgs unless
62 // needed.
64 Pcp_GetArgumentsForFileFormatTarget(
65  const std::string& identifier,
66  const SdfLayer::FileFormatArguments* defaultArgs,
68 
69 PXR_NAMESPACE_CLOSE_SCOPE
70 
71 #endif // PCP_UTILS_H
std::map< std::string, std::string > FileFormatArguments
Type for specifying additional file format-specific arguments to layer API.
Definition: layer.h:119