All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
oslParser.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 
25 #ifndef SDR_OSLPARSERPLUGIN_H
26 #define SDR_OSLPARSERPLUGIN_H
27 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/sdrOsl/api.h"
32 #include "pxr/base/vt/value.h"
33 #include "pxr/usd/ndr/parserPlugin.h"
34 #include "pxr/usd/sdr/declare.h"
35 #include <OSL/oslquery.h>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 // Forward declarations
40 class NdrNode;
42 
110 {
111 public:
112  typedef OSL::OSLQuery::Parameter OslParameter;
113 
114  SDROSL_API
116  SDROSL_API
117  ~SdrOslParserPlugin();
118 
119  SDROSL_API
120  NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult& discoveryResult)
121  override;
122 
123  SDROSL_API
124  const NdrTokenVec& GetDiscoveryTypes() const override;
125 
126  SDROSL_API
127  const TfToken& GetSourceType() const override;
128 
129 private:
130  // Gets a vector of properties that are present on the specified OSL
131  // query object
132  NdrPropertyUniquePtrVec _getNodeProperties(const OSL::OSLQuery &query,
133  const NdrNodeDiscoveryResult& discoveryResult) const;
134 
135  // Gets all metadata for the node that's present on the specified OSL
136  // query object
137  NdrTokenMap _getNodeMetadata(const OSL::OSLQuery &query,
138  const NdrTokenMap &baseMetadata) const;
139 
140  // Gets all metadata for the specified OSL parameter
141  NdrTokenMap _getPropertyMetadata(const OslParameter* param,
142  const NdrNodeDiscoveryResult& discoveryResult) const;
143 
144  // Injects any metadata that is generated by the parser. This type of
145  // metadata provides additional hints to the property.
146  void _injectParserMetadata(NdrTokenMap& metadata,
147  const TfToken& typeName) const;
148 
149  // Gets the specified parameter's value as a string. Can handle string,
150  // float, and integer values (if not one of these types, an empty string
151  // is returned).
152  std::string _getParamAsString(const OslParameter& param) const;
153 
154  // Gets a common type + array size (if array) from the OSL parameter
155  std::tuple<TfToken, size_t> _getTypeName(
156  const OslParameter* param,
157  const NdrTokenMap& metadata) const;
158 
159  // Gets the default value of the specified param.
160  VtValue _getDefaultValue(
161  const SdrOslParserPlugin::OslParameter& param,
162  const std::string& oslType,
163  size_t arraySize,
164  const NdrTokenMap& metadata
165  ) const;
166 };
167 
168 PXR_NAMESPACE_CLOSE_SCOPE
169 
170 #endif // SDR_OSLPARSERPLUGIN_H
SDROSL_API NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult &discoveryResult) override
Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process...
Interface for parser plugins.
Definition: parserPlugin.h:125
Parses OSL nodes.
Definition: oslParser.h:109
SDROSL_API const TfToken & GetSourceType() const override
Returns the source type that this parser operates on.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Represents an abstract node.
Definition: node.h:48
Represents the raw data of a node, and some other bits of metadata, that were determined via a NdrDis...
SDROSL_API const NdrTokenVec & GetDiscoveryTypes() const override
Returns the types of nodes that this plugin can parse.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182