All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rmanArgsParser.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 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 RMAN_ARGS_PARSERPLUGIN_H
26 #define RMAN_ARGS_PARSERPLUGIN_H
27 
29 
30 #include "pxr/pxr.h"
31 #include "rmanArgsParser/api.h"
32 #include "pxr/base/vt/value.h"
33 #include "pxr/usd/ndr/parserPlugin.h"
34 #include "pxr/usd/sdr/declare.h"
35 
36 #include "rmanArgsParser/pugixml/pugixml.hpp"
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 // Forward declarations
41 class NdrNode;
43 struct SdrShaderRepresentation;
44 
104 {
105 public:
106  RMAN_ARGS_PARSER_API
108  RMAN_ARGS_PARSER_API
109  ~RmanArgsParserPlugin();
110 
111  RMAN_ARGS_PARSER_API
112  NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult& discoveryRes) override;
113 
114  RMAN_ARGS_PARSER_API
115  const NdrTokenVec& GetDiscoveryTypes() const override;
116 
117  RMAN_ARGS_PARSER_API
118  const TfToken& GetSourceType() const override;
119 
120 private:
121  // Gets a common type + array size (if array) from the property attributes
122  std::tuple<TfToken, size_t> _GetTypeName(
123  const NdrTokenMap& attributes) const;
124 
125  // Gets a VtValue instance from a string value and a type, array, metadata
126  // hint
127  VtValue _GetVtValue(
128  const std::string& stringValue,
129  TfToken& type,
130  size_t arraySize,
131  const NdrTokenMap& metadata) const;
132 
133  // Emits a deprecation warning to the log
134  void _OutputDeprecationWarning(
135  const TfToken& attrName, const SdrShaderRepresentation& shaderRep,
136  const TfToken& propName) const;
137 
138  // Parses the given child's data as a preparation to be handed off to
139  // `_CreateProperty` to actually be created
140  SdrShaderPropertyUniquePtr _ParseChildElem(
141  const SdrShaderRepresentation& shaderRep, bool isOutput,
142  pugi::xml_node childElement, const std::string& parentPage) const;
143 
144  // Creates a SdrShaderProperty with the given inputs
145  SdrShaderPropertyUniquePtr _CreateProperty(
146  const SdrShaderRepresentation& entry, bool isOutput,
147  NdrTokenMap& attributes, NdrStringVec& validConnectionTypes,
148  NdrOptionVec& options) const;
149 
150  // Injects any metadata that is generated by the parser. This type of
151  // metadata provides additional hints to the property.
152  void _injectParserMetadata(NdrTokenMap& metadata,
153  const TfToken& typeName) const;
154 
155  // Recursively builds up the shaderRep as the shader is parsed
156  void _Parse(SdrShaderRepresentation& shaderRep, pugi::xml_node parent,
157  const std::string& parentPage);
158 
159  // For each child under the specified parent, get the value of the
160  // specified attribute
161  NdrStringVec _GetAttributeValuesFromChildren(
162  pugi::xml_node parent, const char* attrName) const;
163 
164  // Helper methods to get a value out of the attr map (or the default value
165  // if the key doesn't exist on the map)
166  std::string _Get(const NdrTokenMap& map, const TfToken& key,
167  std::string defaultValue) const;
168 
169  TfToken _Get(const NdrTokenMap& map, const TfToken& key,
170  TfToken defaultValue) const;
171 
172  int _Get(const NdrTokenMap& map, const TfToken& key,
173  int defaultValue) const;
174 
175  float _Get(const NdrTokenMap& map, const TfToken& key,
176  float defaultValue) const;
177 };
178 
179 PXR_NAMESPACE_CLOSE_SCOPE
180 
181 #endif // RMAN_ARGS_PARSERPLUGIN_H
RMAN_ARGS_PARSER_API const TfToken & GetSourceType() const override
Returns the source type that this parser operates on.
Interface for parser plugins.
Definition: parserPlugin.h:125
RMAN_ARGS_PARSER_API NdrNodeUniquePtr Parse(const NdrNodeDiscoveryResult &discoveryRes) override
Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process...
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...
Parses Args files.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
RMAN_ARGS_PARSER_API const NdrTokenVec & GetDiscoveryTypes() const override
Returns the types of nodes that this plugin can parse.