HDK
 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 
28 /// \file sdrOsl/oslParser.h
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/plugin/sdrOsl/api.h"
32 #include "pxr/base/vt/value.h"
34 #include "pxr/usd/sdr/declare.h"
35 #include <OSL/oslquery.h>
36 
38 
39 // Forward declarations
40 class NdrNode;
42 
43 /// \class SdrOslParserPlugin
44 ///
45 /// Parses OSL nodes. For more information on parser plugins, see the
46 /// documentation for `NdrParserPlugin`.
47 ///
48 /// \section metadata_schema Metadata Schema
49 /// The following metadata is pulled out of the shader and available on the
50 /// destination as outlined below.
51 ///
52 /// \subsection node_metadata Node Metadata
53 ///
54 /// OSL Metadata Key | Destination
55 /// --------------------- | ------------
56 /// category | GetCategory()
57 /// departments | GetDepartments()
58 /// help | GetHelp()
59 /// label | GetLabel()
60 /// \ref pvars "primvars" | GetPrimvars(), GetAdditionalPrimvarProperties()
61 /// _everything else_ | GetMetadata()
62 ///
63 ///
64 /// \subsection property_metadata Property Metadata
65 ///
66 /// OSL Metadata Key | Destination
67 /// ------------------- | ------------
68 /// connectable | IsConnectable()
69 /// sdrDefinitionName | renames parameter, sends original osl param name to
70 /// | SdrShaderProperty::GetImplementationName()
71 /// page | GetPage()
72 /// help | GetHelp()
73 /// label | GetLabel()
74 /// isDynamicArray | IsDynamicArray()
75 /// \ref opts "options" | GetOptions()
76 /// vstructMemberName | GetVStructMemberName()
77 /// vstructMemberOf | GetVStructMemberOf()
78 /// _everything else_ | GetMetadata()
79 ///
80 ///
81 /// \subsection opts Options Format
82 /// Multiple options are separated with the pipe '|' character; options can be
83 /// specified in one of two ways:
84 /// <ul>
85 /// <li>
86 /// key1|key2|key3|...
87 /// </li>
88 /// <li>
89 /// key1:value1|key2:value2|...
90 /// </li>
91 /// </ul>
92 ///
93 /// In the first case, where the values are not specified, the value of the
94 /// option will be available on the node as an empty string.
95 ///
96 ///
97 /// \subsection pvars Primvar Format
98 /// Multiple primvars are separated with the pipe '|' character; primvars can be
99 /// specified in one of two ways:
100 /// <ul>
101 /// <li>
102 /// A string _not_ prefixed with a '$'; this indicates a normal primvar
103 /// </li>
104 /// <li>
105 /// A string prefixed with '$'; the part after the '$' indicates the
106 /// name of a string-typed input on the node whose value contains
107 /// additional primvars
108 /// </li>
109 /// </ul>
110 ///
112 {
113 public:
114  typedef HOSL::OSLQuery::Parameter OslParameter;
115 
116  SDROSL_API
118  SDROSL_API
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 HOSL::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 HOSL::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(
164  const std::string& oslType,
165  size_t arraySize,
166  const NdrTokenMap& metadata
167  ) const;
168 };
169 
171 
172 #endif // PXR_USD_PLUGIN_SDR_OSL_OSL_PARSER_H
SDROSL_API SdrOslParserPlugin()
std::vector< TfToken > NdrTokenVec
Definition: declare.h:59
SDROSL_API ~SdrOslParserPlugin()
GLenum query
Definition: glew.h:5704
GLfloat param
Definition: glew.h:1530
std::vector< NdrPropertyUniquePtr > NdrPropertyUniquePtrVec
Definition: declare.h:67
Definition: token.h:87
SDROSL_API NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult &discoveryResult) override
Definition: node.h:48
SDROSL_API const NdrTokenVec & GetDiscoveryTypes() const override
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
HOSL::OSLQuery::Parameter OslParameter
Definition: oslParser.h:114
std::unique_ptr< NdrNode > NdrNodeUniquePtr
Definition: declare.h:74
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
SDROSL_API const TfToken & GetSourceType() const override
std::unordered_map< TfToken, std::string, TfToken::HashFunctor > NdrTokenMap
Definition: declare.h:61
Definition: value.h:174