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 PXR_USD_PLUGIN_SDR_OSL_OSL_PARSER_H
26 #define PXR_USD_PLUGIN_SDR_OSL_OSL_PARSER_H
27 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/plugin/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 
112 {
113 public:
114  typedef OSL::OSLQuery::Parameter OslParameter;
115 
116  SDROSL_API
118  SDROSL_API
119  ~SdrOslParserPlugin();
120 
121  SDROSL_API
122  NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult& discoveryResult)
123  override;
124 
125  SDROSL_API
126  const NdrTokenVec& GetDiscoveryTypes() const override;
127 
128  SDROSL_API
129  const TfToken& GetSourceType() const override;
130 
131 private:
132  // Gets a vector of properties that are present on the specified OSL
133  // query object
134  NdrPropertyUniquePtrVec _getNodeProperties(const OSL::OSLQuery &query,
135  const NdrNodeDiscoveryResult& discoveryResult) const;
136 
137  // Gets all metadata for the node that's present on the specified OSL
138  // query object
139  NdrTokenMap _getNodeMetadata(const OSL::OSLQuery &query,
140  const NdrTokenMap &baseMetadata) const;
141 
142  // Gets all metadata for the specified OSL parameter
143  NdrTokenMap _getPropertyMetadata(const OslParameter* param,
144  const NdrNodeDiscoveryResult& discoveryResult) const;
145 
146  // Injects any metadata that is generated by the parser. This type of
147  // metadata provides additional hints to the property.
148  void _injectParserMetadata(NdrTokenMap& metadata,
149  const TfToken& typeName) const;
150 
151  // Gets the specified parameter's value as a string. Can handle string,
152  // float, and integer values (if not one of these types, an empty string
153  // is returned).
154  std::string _getParamAsString(const OslParameter& param) const;
155 
156  // Gets a common type + array size (if array) from the OSL parameter
157  std::tuple<TfToken, size_t> _getTypeName(
158  const OslParameter* param,
159  const NdrTokenMap& metadata) const;
160 
161  // Gets the default value of the specified param.
162  VtValue _getDefaultValue(
163  const SdrOslParserPlugin::OslParameter& param,
164  const std::string& oslType,
165  size_t arraySize,
166  const NdrTokenMap& metadata
167  ) const;
168 };
169 
170 PXR_NAMESPACE_CLOSE_SCOPE
171 
172 #endif // PXR_USD_PLUGIN_SDR_OSL_OSL_PARSER_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:111
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:87
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:174