#include <OslSyntax.h>

Inheritance diagram for OslSyntax:

Public Member Functions
	OslSyntax ()

const string &	getOutputQualifier () const override

const string &	getConstantQualifier () const override

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

Public Member Functions inherited from Syntax
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...

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 &	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 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 Member Functions
static SyntaxPtr	create ()

Static Public Attributes
static const string	OUTPUT_QUALIFIER

static const string	SOURCE_FILE_EXTENSION

static const StringVec	VECTOR_MEMBERS

static const StringVec	VECTOR2_MEMBERS

static const StringVec	VECTOR4_MEMBERS

static const StringVec	COLOR4_MEMBERS

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

static const string	SEMICOLON

static const string	COMMA

Additional Inherited Members
Public Types inherited from Syntax
enum	Punctuation { PARENTHESES, CURLY_BRACKETS, SQUARE_BRACKETS, DOUBLE_SQUARE_BRACKETS }
	Punctuation types. More...

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

Protected Attributes inherited from Syntax
vector< TypeSyntaxPtr >	_typeSyntaxes

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

StringSet	_reservedWords

StringMap	_invalidTokens

Static Protected Attributes inherited from Syntax
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

Syntax class for OSL (Open Shading Language)

Definition at line 20 of file OslSyntax.h.

Constructor & Destructor Documentation

OslSyntax::OslSyntax ( )

Member Function Documentation

static SyntaxPtr OslSyntax::create ( )

inlinestatic

Definition at line 25 of file OslSyntax.h.

const string& OslSyntax::getConstantQualifier ( ) const

inlineoverridevirtual

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

Implements Syntax.

Definition at line 28 of file OslSyntax.h.

const string& OslSyntax::getOutputQualifier ( ) const

overridevirtual

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 from Syntax.

const string& OslSyntax::getSourceFileExtension ( ) const

inlineoverridevirtual

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

Implements Syntax.

Definition at line 29 of file OslSyntax.h.

Member Data Documentation

const StringVec OslSyntax::COLOR4_MEMBERS

static

Definition at line 36 of file OslSyntax.h.

const string OslSyntax::OUTPUT_QUALIFIER

static

Definition at line 29 of file OslSyntax.h.

const string OslSyntax::SOURCE_FILE_EXTENSION

static

Definition at line 32 of file OslSyntax.h.

const StringVec OslSyntax::VECTOR2_MEMBERS

static

Definition at line 34 of file OslSyntax.h.

const StringVec OslSyntax::VECTOR4_MEMBERS

static

Definition at line 35 of file OslSyntax.h.

const StringVec OslSyntax::VECTOR_MEMBERS

static

Definition at line 33 of file OslSyntax.h.

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

MaterialXGenOsl/OslSyntax.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation