#include <Syntax.h>

Inheritance diagram for Syntax:

Public Types
enum	Punctuation { PARENTHESES, CURLY_BRACKETS, SQUARE_BRACKETS, DOUBLE_SQUARE_BRACKETS }
	Punctuation types. More...

Public Member Functions
virtual	~Syntax ()

void	registerTypeSyntax (const TypeDesc *type, TypeSyntaxPtr syntax)

void	registerReservedWords (const StringSet &names)

void	registerInvalidTokens (const StringMap &tokens)

const StringSet &	getReservedWords () const
	Returns a set of names that are reserved words for this language syntax. More...

const StringMap &	getInvalidTokens () const
	Returns a mapping from disallowed tokens to replacement strings for this language syntax. More...

const TypeSyntax &	getTypeSyntax (const TypeDesc *type) const

const vector< TypeSyntaxPtr > &	getTypeSyntaxes () const
	Returns an array of all registered type syntax objects. More...

const TypeDesc *	getTypeDescription (const TypeSyntaxPtr &typeSyntax) const

const string &	getTypeName (const TypeDesc *type) const
	Returns the name syntax of the given type. More...

virtual string	getOutputTypeName (const TypeDesc *type) const
	Returns the type name in an output context. More...

const string &	getTypeAlias (const TypeDesc *type) const

const string &	getTypeDefinition (const TypeDesc *type) const

const string &	getDefaultValue (const TypeDesc *type, bool uniform=false) const
	Returns the default value string for the given type. More...

virtual string	getValue (const TypeDesc *type, const Value &value, bool uniform=false) const
	Returns the value string for a given type and value object. More...

virtual string	getValue (const ShaderPort *port, bool uniform=false) const
	Returns the value string for a given shader port object. More...

virtual string	getSwizzledVariable (const string &srcName, const TypeDesc srcType, const string &channels, const TypeDesc dstType) const
	Get syntax for a swizzled variable. More...

virtual ValuePtr	getSwizzledValue (ValuePtr value, const TypeDesc srcType, const string &channels, const TypeDesc dstType) const
	Get swizzled value. More...

virtual const string &	getInputQualifier () const

virtual const string &	getOutputQualifier () const

virtual const string &	getConstantQualifier () const =0

virtual const string &	getUniformQualifier () const

virtual const string &	getNewline () const
	Return the characters used for a newline. More...

virtual const string &	getIndentation () const
	Return the characters used for a single indentation level. More...

virtual const string &	getStringQuote () const
	Return the characters used to begin/end a string definition. More...

virtual const string &	getIncludeStatement () const
	Return the string pattern used for a file include statement. More...

virtual const string &	getSingleLineComment () const
	Return the characters used for single line comment. More...

virtual const string &	getBeginMultiLineComment () const
	Return the characters used to begin a multi line comments block. More...

virtual const string &	getEndMultiLineComment () const
	Return the characters used to end a multi line comments block. More...

virtual const string &	getSourceFileExtension () const =0
	Return the file extension used for source code files in this language. More...

virtual string	getArrayTypeSuffix (const TypeDesc *, const Value &) const
	Return the array suffix to use for declaring an array type. More...

virtual string	getArrayVariableSuffix (const TypeDesc *type, const Value &value) const
	Return the array suffix to use for declaring an array variable. More...

virtual bool	typeSupported (const TypeDesc *type) const

virtual void	makeValidName (string &name) const
	Modify the given name string to remove any invalid characters or tokens. More...

virtual void	makeIdentifier (string &name, IdentifierMap &identifiers) const

virtual string	getVariableName (const string &name, const TypeDesc *type, IdentifierMap &identifiers) const

virtual bool	remapEnumeration (const string &value, const TypeDesc type, const string &enumNames, std::pair< const TypeDesc , ValuePtr > &result) const

Static Public Attributes
static const string	NEWLINE
	Constants with commonly used strings. More...

static const string	SEMICOLON

static const string	COMMA

Protected Member Functions
	Syntax ()
	Protected constructor. More...

Protected Attributes
vector< TypeSyntaxPtr >	_typeSyntaxes

std::unordered_map< const TypeDesc *, size_t >	_typeSyntaxByType

StringSet	_reservedWords

StringMap	_invalidTokens

Static Protected Attributes
static const string	INDENTATION

static const string	STRING_QUOTE

static const string	INCLUDE_STATEMENT

static const string	SINGLE_LINE_COMMENT

static const string	BEGIN_MULTI_LINE_COMMENT

static const string	END_MULTI_LINE_COMMENT

static const std::unordered_map< char, size_t >	CHANNELS_MAPPING

Detailed Description

Base class for syntax objects used by shader generators to emit code with correct syntax for each language.

Definition at line 39 of file Syntax.h.

Member Enumeration Documentation

enum Syntax::Punctuation

Punctuation types.

Enumerator
PARENTHESES
CURLY_BRACKETS
SQUARE_BRACKETS
DOUBLE_SQUARE_BRACKETS

Definition at line 43 of file Syntax.h.

Constructor & Destructor Documentation

virtual Syntax::~Syntax ( )

inlinevirtual

Definition at line 52 of file Syntax.h.

Syntax::Syntax ( )

protected

Protected constructor.

Member Function Documentation

virtual string Syntax::getArrayTypeSuffix	(	const TypeDesc *	,
		const Value &
	)		const

inlinevirtual

Return the array suffix to use for declaring an array type.

Reimplemented in MdlSyntax.

Definition at line 158 of file Syntax.h.

virtual string Syntax::getArrayVariableSuffix	(	const TypeDesc *	type,
		const Value &	value
	)		const

virtual

Return the array suffix to use for declaring an array variable.

Reimplemented in MdlSyntax.

virtual const string& Syntax::getBeginMultiLineComment ( ) const

inlinevirtual

Return the characters used to begin a multi line comments block.

Definition at line 149 of file Syntax.h.

virtual const string& Syntax::getConstantQualifier ( ) const

pure virtual

Get the qualifier used when declaring constant variables. Derived classes must define this method.

Implemented in MdlSyntax, GlslSyntax, MslSyntax, and OslSyntax.

const string& Syntax::getDefaultValue	(	const TypeDesc *	type,
		bool	uniform = `false`
	)		const

Returns the default value string for the given type.

virtual const string& Syntax::getEndMultiLineComment ( ) const

inlinevirtual

Return the characters used to end a multi line comments block.

Definition at line 152 of file Syntax.h.

virtual const string& Syntax::getIncludeStatement ( ) const

inlinevirtual

Return the string pattern used for a file include statement.

Definition at line 143 of file Syntax.h.

virtual const string& Syntax::getIndentation ( ) const

inlinevirtual

Return the characters used for a single indentation level.

Definition at line 137 of file Syntax.h.

virtual const string& Syntax::getInputQualifier ( ) const

inlinevirtual

Returns a type qualifier to be used when declaring types for input variables. Default implementation returns empty string and derived syntax classes should override this method.

Reimplemented in GlslSyntax, MslSyntax, and VkSyntax.

Definition at line 117 of file Syntax.h.

const StringMap& Syntax::getInvalidTokens ( ) const

inline

Returns a mapping from disallowed tokens to replacement strings for this language syntax.

Definition at line 72 of file Syntax.h.

virtual const string& Syntax::getNewline ( ) const

inlinevirtual

Return the characters used for a newline.

Definition at line 134 of file Syntax.h.

virtual const string& Syntax::getOutputQualifier ( ) const

inlinevirtual

Returns a type qualifier to be used when declaring types for output variables. Default implementation returns empty string and derived syntax classes should override this method.

Reimplemented in GlslSyntax, MslSyntax, and OslSyntax.

Definition at line 122 of file Syntax.h.

virtual string Syntax::getOutputTypeName ( const TypeDesc * type ) const

virtual

Returns the type name in an output context.

Reimplemented in MslSyntax.

const StringSet& Syntax::getReservedWords ( ) const

inline

Returns a set of names that are reserved words for this language syntax.

Definition at line 69 of file Syntax.h.

virtual const string& Syntax::getSingleLineComment ( ) const

inlinevirtual

Return the characters used for single line comment.

Definition at line 146 of file Syntax.h.

virtual const string& Syntax::getSourceFileExtension ( ) const

pure virtual

Return the file extension used for source code files in this language.

Implemented in MdlSyntax, GlslSyntax, MslSyntax, and OslSyntax.

virtual const string& Syntax::getStringQuote ( ) const

inlinevirtual

Return the characters used to begin/end a string definition.

Definition at line 140 of file Syntax.h.

virtual ValuePtr Syntax::getSwizzledValue	(	ValuePtr	value,
		const TypeDesc *	srcType,
		const string &	channels,
		const TypeDesc *	dstType
	)		const

virtual

Get swizzled value.

virtual string Syntax::getSwizzledVariable	(	const string &	srcName,
		const TypeDesc *	srcType,
		const string &	channels,
		const TypeDesc *	dstType
	)		const

virtual

Get syntax for a swizzled variable.

Reimplemented in MdlSyntax.

const string& Syntax::getTypeAlias ( const TypeDesc * type ) const

Returns a type alias for the given data type. If not used returns an empty string.

const string& Syntax::getTypeDefinition ( const TypeDesc * type ) const

Returns a custom type definition if needed for the given data type. If not used returns an empty string.

const TypeDesc* Syntax::getTypeDescription ( const TypeSyntaxPtr & typeSyntax ) const

Returns a type description given a type syntax. Throws an exception if the type syntax has not been registered

const string& Syntax::getTypeName ( const TypeDesc * type ) const

Returns the name syntax of the given type.

const TypeSyntax& Syntax::getTypeSyntax ( const TypeDesc * type ) const

Returns the type syntax object for a named type. Throws an exception if a type syntax is not defined for the given type.

const vector<TypeSyntaxPtr>& Syntax::getTypeSyntaxes ( ) const

inline

Returns an array of all registered type syntax objects.

Definition at line 79 of file Syntax.h.

virtual const string& Syntax::getUniformQualifier ( ) const

inlinevirtual

Get the qualifier used when declaring uniform variables. Default implementation returns empty string and derived syntax classes should override this method.

Reimplemented in MdlSyntax, GlslSyntax, and MslSyntax.

Definition at line 131 of file Syntax.h.

virtual string Syntax::getValue	(	const TypeDesc *	type,
		const Value &	value,
		bool	uniform = `false`
	)		const

virtual

Returns the value string for a given type and value object.

virtual string Syntax::getValue	(	const ShaderPort *	port,
		bool	uniform = `false`
	)		const

virtual

Returns the value string for a given shader port object.

virtual string Syntax::getVariableName	(	const string &	name,
		const TypeDesc *	type,
		IdentifierMap &	identifiers
	)		const

virtual

Create a unique identifier for the given variable name and type. The method is used for naming variables (inputs and outputs) in generated code. Derived classes can override this method to have a custom naming strategy. Default implementation adds a number suffix, or increases an existing number suffix, on the name string if there is a name collision.

virtual void Syntax::makeIdentifier	(	string &	name,
		IdentifierMap &	identifiers
	)		const

virtual

Make sure the given name is a unique identifier, updating it if needed to make it unique.

virtual void Syntax::makeValidName ( string & name ) const

virtual

Modify the given name string to remove any invalid characters or tokens.

Reimplemented in MdlSyntax.

void Syntax::registerInvalidTokens ( const StringMap & tokens )

Register a set string replacements for disallowed tokens for a code generator when naming variables and functions. Multiple calls will add to the internal set of tokens.

void Syntax::registerReservedWords ( const StringSet & names )

Register names that are reserved words not to be used by a code generator when naming variables and functions. Keywords, types, built-in functions etc. should be added to this set. Multiple calls will add to the internal set of names.

void Syntax::registerTypeSyntax	(	const TypeDesc *	type,
		TypeSyntaxPtr	syntax
	)

Register syntax handling for a data type. Required to be set for all supported data types.

virtual bool Syntax::remapEnumeration	(	const string &	value,
		const TypeDesc *	type,
		const string &	enumNames,
		std::pair< const TypeDesc *, ValuePtr > &	result
	)		const

virtual

Given an input specification attempt to remap this to an enumeration which is accepted by the shader generator. The enumeration may be converted to a different type than the input.

Parameters

value	The value string to remap.
type	The type of the value to remap,
enumNames	Type enumeration names
result	Enumeration type and value (returned).

Returns: Return true if the remapping was successful.

Reimplemented in MdlSyntax, MslSyntax, and GlslSyntax.

virtual bool Syntax::typeSupported ( const TypeDesc * type ) const

virtual

Query if given type is suppored in the syntax. By default all types are assumed to be supported.

Reimplemented in MslSyntax, and GlslSyntax.

Member Data Documentation

StringMap Syntax::_invalidTokens

protected

Definition at line 204 of file Syntax.h.

StringSet Syntax::_reservedWords

protected

Definition at line 203 of file Syntax.h.

std::unordered_map<const TypeDesc*, size_t> Syntax::_typeSyntaxByType

protected

Definition at line 201 of file Syntax.h.

vector<TypeSyntaxPtr> Syntax::_typeSyntaxes

protected

Definition at line 200 of file Syntax.h.

const string Syntax::BEGIN_MULTI_LINE_COMMENT

staticprotected

Definition at line 210 of file Syntax.h.

const std::unordered_map<char, size_t> Syntax::CHANNELS_MAPPING

staticprotected

Definition at line 213 of file Syntax.h.

const string Syntax::COMMA

static

Definition at line 194 of file Syntax.h.

const string Syntax::END_MULTI_LINE_COMMENT

staticprotected

Definition at line 211 of file Syntax.h.

const string Syntax::INCLUDE_STATEMENT

staticprotected

Definition at line 208 of file Syntax.h.

const string Syntax::INDENTATION

staticprotected

Definition at line 206 of file Syntax.h.

const string Syntax::NEWLINE

static

Constants with commonly used strings.

Definition at line 192 of file Syntax.h.

const string Syntax::SEMICOLON

static

Definition at line 193 of file Syntax.h.

const string Syntax::SINGLE_LINE_COMMENT

staticprotected

Definition at line 209 of file Syntax.h.

const string Syntax::STRING_QUOTE

staticprotected

Definition at line 207 of file Syntax.h.

The documentation for this class was generated from the following file:

MaterialXGenShader/Syntax.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation