Manages all information related to a parsed shader file. More...

#include <LSGShaderLanguageParser.h>

Classes
struct	LSG_ENGINE_MACRO
struct	LSG_IDENTIFIER
union	LSG_SCALAR
struct	LSG_STRUCT
struct	LSG_STRUCT_DECLARATOR
struct	LSG_STRUCT_MEMBER
Public Types
enum	LSG_SHADER_TYPES { LSG_ST_INVALID = -1, LSG_ST_VERTEX, LSG_ST_PIXEL, LSG_ST_TOTAL }
enum	LSG_STRUCT_BASE { LSG_SB_START = 10000 }
typedef struct lsg::CShaderLanguageParser::LSG_IDENTIFIER *	LPLSG_IDENTIFIER
typedef struct lsg::CShaderLanguageParser::LSG_IDENTIFIER	LPCLSG_IDENTIFIER
typedef union lsg::CShaderLanguageParser::LSG_SCALAR *	LPLSG_SCALAR
typedef union lsg::CShaderLanguageParser::LSG_SCALAR	LPCLSG_SCALAR
typedef struct lsg::CShaderLanguageParser::LSG_STRUCT_MEMBER *	LPLSG_STRUCT_MEMBER
typedef struct lsg::CShaderLanguageParser::LSG_STRUCT_MEMBER	LPCLSG_STRUCT_MEMBER
typedef struct lsg::CShaderLanguageParser::LSG_STRUCT *	LPLSG_STRUCT
typedef struct lsg::CShaderLanguageParser::LSG_STRUCT	LPCLSG_STRUCT
typedef CMap< CString, LSG_STRUCT >	LSG_STRUCT_ARRAY
typedef CMap< CString, LSG_STRUCT > *	LPLSG_STRUCT_ARRAY
typedef CMap< CString, LSG_STRUCT > *const	LPCLSG_STRUCT_ARRAY
typedef struct lsg::CShaderLanguageParser::LSG_STRUCT_DECLARATOR *	LPLSG_STRUCT_DECLARATOR
typedef struct lsg::CShaderLanguageParser::LSG_STRUCT_DECLARATOR	LPCLSG_STRUCT_DECLARATOR
typedef struct lsg::CShaderLanguageParser::LSG_ENGINE_MACRO *	LPLSG_ENGINE_MACRO
typedef struct lsg::CShaderLanguageParser::LSG_ENGINE_MACRO	LPCLSG_ENGINE_MACRO
Public Member Functions
LSE_CALLCTOR	CShaderLanguageParser (LSG_SHADER_TYPES _stType, CShaderLexer *_plLexer)
LSG_SHADER_TYPES LSE_CALL	GetShaderType () const
LSUINT32 LSE_CALL	CreateString (const LSCHAR *_pcText, LSBOOL _bHasQuotes=true)
LSBOOL LSE_CALL	CreateDecimal (const LSCHAR *_pcText, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateFloatingPoint (const LSCHAR *_pcText, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateBool (LSBOOL _bValue, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateIdentifier (const LSCHAR *_pcText, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateArrayAccess (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBase, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndIndex, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreatePostfixOrPrefixIncOrDec (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndOp, LSG_NODE _nType, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateUnaryOp (LSUINT32 _ui32Op, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBase, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateCast (LSUINT64 _ui64Type, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBase, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateMath (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSUINT32 _ui32Op, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateTertiary (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndCond, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateAssignment (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSUINT32 _ui32Op, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateComma (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateIntrinsic (LSUINT32 _ui32Intrinsic, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndExp, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateArgExpList (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateFunctionCall (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndFunction, LSUINT32 _ui32ArgList, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateFieldSelect (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateConstructor (LSUINT64 _ui64Type, LSUINT32 _ui32Args, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateExpressionStatement (LSUINT32 _ui32Index, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateDeclarationStatement (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndDecl, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateSemantic (const LSCHAR *_pcText, LSUINT32 _ui32Type, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateTypeSpecifier (LSUINT64 _ui64Qualifiers, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateFullySpecifiedType (LSUINT64 _ui64Qualifiers, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndSpec, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateSingleDeclaration (LSUINT32 _ui32Name, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndTypeNode, LSUINT32 _ui32ConstNodeIndex, LSUINT32 _ui32SemanticNodeIndex, LSUINT32 _ui32InitializerNodeIndex, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateInitializerList (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateInitializerListWrap (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndList, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateStatementList (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateNewScopedStatement (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndStatement, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateBlankStatement (LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateStructDeclarator (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndName, LSUINT32 _ui32ArrayNodeIndex, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateStructDeclaratorList (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateStructDeclaration (LSUINT64 _ui64Qualifiers, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndType, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndDecl, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateStructDeclarationList (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateStruct (LSUINT32 _ui32IdentifierIndex, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndDecl, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateParameterDeclarator (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndType, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndName, LSUINT32 _ui32ArrayNodeIndex, LSUINT32 _ui32SemanticNodeIndex, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateParameterDeclaration (LSUINT64 _ui64TypeInfo, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndDecl, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateParameterDeclarationList (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateFunctionDeclaration (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndType, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndName, LSUINT32 _ui32Parms, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateFunctionDefinition (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndHeader, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBody, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateSelectionStatement (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndExp, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBody, LSUINT32 _ui32ElseBody, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateForInitDeclStatement (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndExp, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateWhileLoop (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndExp, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBody, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateDoWhileLoop (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndExp, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBody, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateForLoop (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndInitExp, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndExp, LSUINT32 _ui32ItIndex, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndBody, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateJump (LSG_NODE _nType, LSUINT32 _ui32NodeIndex, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSBOOL LSE_CALL	CreateExternalDeclarationList (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndLeft, const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndRight, LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSUINT32 LSE_CALL	FindIdentifier (const LSCHAR *_pcName) const
LSBOOL LSE_CALL	IsToken (const LSCHAR *_pcText) const
const LSG_SHADER_SYNTAX_NODES::LSG_NODE_DATA &LSE_CALL	GetNode (LSUINT32 _ui32Index) const
LSUINT32 LSE_CALL	TotalNodes () const
LSUINT32 LSE_CALL	TotalIdentifiers () const
const LSG_IDENTIFIER &LSE_CALL	GetIdentifier (LSUINT32 _ui32Index) const
LSUINT32 LSE_CALL	TotalStrings () const
const CString &LSE_CALL	GetString (LSUINT32 _ui32Index) const
LSG_NUM_CONSTANTS LSE_CALL	GetNodeValue (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode, LSG_SCALAR &_sValue) const
LSBOOL LSE_CALL	IsInteger (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT32 LSE_CALL	CountArgs (LSUINT32 _ui32ArgListIndex, LSUINT32 _ui32MaxArgs, LSUINT32 *_pui32Nodes) const
LSUINT32 LSE_CALL	CountParms (LSUINT32 _ui32ArgListIndex, CVectorPoD< LSUINT32, LSUINT32 > *_pvRet=NULL)
LSUINT32 LSE_CALL	CountStructMembers (LSUINT32 _ui32MemberListIndex, CVectorPoD< LSUINT32, LSUINT32 > *_pvRet=NULL)
LSBOOL LSE_CALL	GetStructDeclarators (LSUINT32 _ui32Index, CVectorPoD< LSG_STRUCT_DECLARATOR > &_vRet) const
LSUINT64 LSE_CALL	GetTypeQualifier (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT64 LSE_CALL	GetType (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
const CString &LSE_CALL	GetName (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT32 LSE_CALL	GetNameIndex (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT64 LSE_CALL	GetSemantic (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT64 LSE_CALL	GetTypeQualifiersOnParm (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT64 LSE_CALL	GetTypeOnParm (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
const CString &LSE_CALL	GetNameOfParm (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT32 LSE_CALL	GetNameIndexOfParm (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSUINT32 LSE_CALL	GetArrayIndexOfParm (const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &_ndNode) const
LSBOOL LSE_CALL	RegisterStructType (const LSCHAR *_pcText)
LSUINT32 LSE_CALL	GetStructTypeId (const LSCHAR *_pcText) const
CString LSE_CALL	GetStructById (LSUINT32 _ui32Id) const
LSUINT32 LSE_CALL	GetSize (LSUINT64 _ui64Type) const
Static Public Member Functions
static LSBOOL LSE_CALL	IsInteger (LSUINT64 _ui64Type)
static LSUINT32 LSE_CALL	GetArrayUnit (LSUINT64 _ui64Type, LSUINT32 _ui32Unit)
static LSUINT32 LSE_CALL	GetType (LSUINT64 _ui64Type)
static LSUINT64 LSE_CALL	CombineTypesAndArrays (LSUINT64 _ui64Type, LSUINT32 _ui32Array0, LSUINT32 _ui32Array1)
static LSG_NUM_CONSTANTS LSE_CALL	TypeToConstantType (LSUINT64 _ui64Type)
static LSUINT64 LSE_CALL	ConstantTypeToType (LSG_NUM_CONSTANTS _ncType)
static CString LSE_CALL	BasicTypeToString (LSUINT64 _ui64Type)
static LSG_SCALAR LSE_CALL	CastScalar (const LSG_SCALAR &_sScalar, LSUINT64 _ui64OriginalType, LSUINT64 _ui64NewType, LSBOOL &_bRes)
static LSG_NUM_CONSTANTS LSE_CALL	GetHighType (LSG_NUM_CONSTANTS _ncLeft, LSG_NUM_CONSTANTS _ncRight)
static LSBOOL LSE_CALL	IsEitherMatrix (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSBOOL LSE_CALL	BothAreMatrices (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSBOOL LSE_CALL	IsEitherVector (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSBOOL LSE_CALL	BothAreVectors (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSBOOL LSE_CALL	IsEitherScalar (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSBOOL LSE_CALL	BothAreScalars (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSBOOL LSE_CALL	IsEitherStruct (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSBOOL LSE_CALL	BothAreStructs (LSUINT64 _ui64Left, LSUINT64 _ui64Right)
static LSVOID LSE_CALL	GetMatrixSize (LSUINT64 _ui64Left, LSUINT64 _ui64Right, LSUINT32 &_ui32Columns, LSUINT32 &_ui32Rows)
static LSVOID LSE_CALL	GetVectorSize (LSUINT64 _ui64Left, LSUINT64 _ui64Right, LSUINT32 &_ui32Ret)
Protected Member Functions
LSBOOL LSE_CALL	AddNode (LSG_SHADER_SYNTAX_NODES::LSG_NODE_DATA &_ndNode)
LSUINT32 LSE_CALL	AddIdentifier (const LSCHAR *_pcText)
LSBOOL LSE_CALL	FindToken (const LSCHAR *_pcName, LSUINT32 &_ui32Index) const
Protected Attributes
CVector< CString, LSUINT32, 512UL >	m_vStringPool
CVectorPoD < LSG_SHADER_SYNTAX_NODES::LSG_NODE_DATA, LSUINT32, 512UL *10UL >	m_vNodes
CVectorPoD< LSG_IDENTIFIER, LSUINT32, 512UL >	m_vIdentifiers
CVectorPoD< LSUINT32, LSUINT32, 512UL >	m_vSortedTokens
CShaderScopeStack	m_sssScopes
LSG_SHADER_TYPES	m_stShaderType
CMap< CString, LSUINT32 >	m_mUserTypes
LSUINT32	m_ui32TypeId
LSG_STRUCT_ARRAY	m_saStructures
CShaderLexer *	m_plLexer

Detailed Description

Manages all information related to a parsed shader file.

Class CShaderLanguageParser Description: Handles the meat of parsing a shader file. Bison performs the actual parsing, but all nodes are sent to this class to be managed. This is the go-to class for any information needed on a parsed shader.

Member Typedef Documentation

typedef struct lsg::CShaderLanguageParser::LSG_ENGINE_MACRO * lsg::CShaderLanguageParser::LPLSG_ENGINE_MACRO

An engine-defined macro.

typedef struct lsg::CShaderLanguageParser::LSG_IDENTIFIER * lsg::CShaderLanguageParser::LPLSG_IDENTIFIER

Identifier data.

typedef union lsg::CShaderLanguageParser::LSG_SCALAR * lsg::CShaderLanguageParser::LPLSG_SCALAR

A scalar type.

typedef struct lsg::CShaderLanguageParser::LSG_STRUCT * lsg::CShaderLanguageParser::LPLSG_STRUCT

A structure.

typedef struct lsg::CShaderLanguageParser::LSG_STRUCT_DECLARATOR * lsg::CShaderLanguageParser::LPLSG_STRUCT_DECLARATOR

Structure declarator.

typedef struct lsg::CShaderLanguageParser::LSG_STRUCT_MEMBER * lsg::CShaderLanguageParser::LPLSG_STRUCT_MEMBER

A structure member.

typedef CMap<CString, LSG_STRUCT> lsg::CShaderLanguageParser::LSG_STRUCT_ARRAY

An array of structures.

Member Enumeration Documentation

enum lsg::CShaderLanguageParser::LSG_SHADER_TYPES

Shader types.

enum lsg::CShaderLanguageParser::LSG_STRUCT_BASE

Structure base ID.

Member Function Documentation

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::AddIdentifier ( const LSCHAR * _pcText ) [protected]

Add an identifier by name. Returns the index of the created identifier in the identifier stack. The type of the created identifier is undefined.

Parameters:

_pcText The string name of the identifier.

Returns:: Returns the index of the created identifier.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::AddNode ( LSG_SHADER_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) [protected]

Add a node to the stack. Set the node index too.

Parameters:

_ndNode The node to add to the stack.

Returns:: Returns true if the node was added.

static CString LSE_CALL lsg::CShaderLanguageParser::BasicTypeToString ( LSUINT64 _ui64Type ) [static]

Get the name of a basic type.

Parameters:

_ui64Type The type whose name is to be obtained.

Returns:: Returns the type in string form.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::BothAreMatrices	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Are both types matrices?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if both types are matrices.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::BothAreScalars	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Are both types scalars?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if both types are scalars.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::BothAreStructs	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Are both types structures?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if both types are structures.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::BothAreVectors	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Are both types vectors?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if both types are vectors.

static LSG_SCALAR LSE_CALL lsg::CShaderLanguageParser::CastScalar	(	const LSG_SCALAR &	_sScalar,
		LSUINT64	_ui64OriginalType,
		LSUINT64	_ui64NewType,
		LSBOOL &	_bRes
	)		`[static]`

Convert from one scalar type to another.

Parameters:

_sScalar	The value to cast.
_ui64OriginalType	The type of value in _sScalar.
_ui64NewType	The type to which to cast the given scalar value.
_bRes	If set to true, the function succeeded in converting the values.

Returns:: Returns the scalar cast to the given type.

static LSUINT64 LSE_CALL lsg::CShaderLanguageParser::CombineTypesAndArrays	(	LSUINT64	_ui64Type,
		LSUINT32	_ui32Array0,
		LSUINT32	_ui32Array1
	)		`[static]`

Combine a type specifier with array specifiers to create a value that contains both.

Parameters:

_ui64Type	Type specifier.
_ui32Array0	Array value 1.
_ui32Array1	Array value 2. Must be ~0UL if not used.

Returns:: Returns the value created by combining the input values into a single LSUINT64.

static LSUINT64 LSE_CALL lsg::CShaderLanguageParser::ConstantTypeToType ( LSG_NUM_CONSTANTS _ncType ) [static]

Convert a numeric-constant type to a full type that most closely matches the numeric-constant type.

Parameters:

_ncType The type to convert.

Returns:: Returns the full type form that matches most closely the given numeric-constant type.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::CountArgs	(	LSUINT32	_ui32ArgListIndex,
		LSUINT32	_ui32MaxArgs,
		LSUINT32 *	_pui32Nodes
	)		const

Count the number of arguments in the given argument list up to the maximum specified. Also stores the argument node indices in the given array in reverse order. If the number of arguments is less than or equal to the given max, the node count is returned and the nodes are stored in _pui32Nodes. Otherwise ~0UL is returned and the contents of _pui32Nodes are undefined. This is used by the engine for intrinsic functions only.

Parameters:

_ui32ArgListIndex	Index of the argument list whose nodes are to be counted.
_ui32MaxArgs	Maximum number of arguments that can be stored in _pui32Nodes.
_pui32Nodes	Filled with the arguments in reverse order upon return.

Returns:: Returns the number of arguments found or ~0UL if there are more than _ui32MaxArgs.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::CountParms	(	LSUINT32	_ui32ArgListIndex,
		CVectorPoD< LSUINT32, LSUINT32 > *	_pvRet = `NULL`
	)

Count the number of parameters in the given argument list. Optionally returns the argument node indices in the optionally supplied vector in reverse order.

Parameters:

_ui32ArgListIndex	Index of the argument list whose nodes are to be counted.
_pvRet	If not NULL, filled with the arguments in reverse order upon return.

Returns:: return Returns the number of arguments found or ~0UL if there is not enough memory to add the indices to the given vector.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::CountStructMembers	(	LSUINT32	_ui32MemberListIndex,
		CVectorPoD< LSUINT32, LSUINT32 > *	_pvRet = `NULL`
	)

Count the number of members on a structure. Optionally returns the member declarations in reverse order.

Parameters:

_ui32MemberListIndex	Index of the structure declaration list whose nodes are to be counted.
_pvRet	If not NULL, filled with the arguments in reverse order upon return.

Returns:: return Returns the number of members found or ~0UL if there is not enough memory to add the indices to the given vector.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateArgExpList	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Make an argument expression list.

Parameters:

_ndLeft	The left operand.
_ndRight	The right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateArrayAccess	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBase,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndIndex,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates an array-access node.

Parameters:

_ndBase	Base part of the expression.
_ndIndex	Array index part of the expression.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateAssignment	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSUINT32	_ui32Op,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates an assignment node.

Parameters:

_ndLeft	The left operand.
_ndRight	The right operand.
_ui32Op	The operator.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateBlankStatement ( LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode )

Creates an empty statement.

Parameters:

_ndNode Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateBool	(	LSBOOL	_bValue,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a node that represents either boolean true or boolean false.

Parameters:

_bValue	The boolean value of the node.
_ndNode	Node to create based off the string constant.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateCast	(	LSUINT64	_ui64Type,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBase,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a cast expression.

Parameters:

_ui64Type	The type to which to cast the expression.
_ndBase	The base expression.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateComma	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a comma sequence.

Parameters:

_ndLeft	The left operand.
_ndRight	The right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateConstructor	(	LSUINT64	_ui64Type,
		LSUINT32	_ui32Args,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Create a constructor node.

Parameters:

_ui64Type	The type ID, including implicit arrays.
_ui32Args	Index of the argument-list node if any.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateDecimal	(	const LSCHAR *	_pcText,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Accepts a string representation of a decimal constant and stores the result in the given node.

Parameters:

_pcText	String constant containing the numeric.
_ndNode	Node to create based off the string constant.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateDeclarationStatement	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndDecl,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates an declaration statement.

Parameters:

_ndDecl	The declaration node.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateDoWhileLoop	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndExp,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBody,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a do () while node.

Parameters:

_ndExp	The conditional expression.
_ndBody	The body of the iterator.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateExpressionStatement	(	LSUINT32	_ui32Index,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates an expression statement.

Parameters:

_ui32Index	Index of the expression or ~0UL
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateExternalDeclarationList	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a list of external declarations.

Parameters:

param	_ndLeft Left operand.
_ndRight	Right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateFieldSelect	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Create a field-select node.

Parameters:

_ndLeft	The left operand.
_ndRight	The right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateFloatingPoint	(	const LSCHAR *	_pcText,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Accepts a representation of a floating-point constant and stores the result in the given node.

Parameters:

_pcText	String constant containing the numeric.
_ndNode	Node to create based off the string constant.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateForInitDeclStatement	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndExp,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a for-initilializer node.

Parameters:

_ndExp	The initializer node.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateForLoop	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndInitExp,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndExp,
		LSUINT32	_ui32ItIndex,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBody,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a for () node.

Parameters:

_ndInitExp	The initializer expression.
_ndExp	The conditional expression.
_ui32ItIndex	The iteartion expression index, of any.
_ndBody	The body of the iterator.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateFullySpecifiedType	(	LSUINT64	_ui64Qualifiers,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndSpec,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a fully specified type. Such as "IN void" or "float".

Parameters:

_ui64Qualifiers	The type qualifiers.
_ndSpec	Type specifier.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateFunctionCall	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndFunction,
		LSUINT32	_ui32ArgList,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Create a function-call node.

Parameters:

_ndFunction	The left operand.
_ui32ArgList	The index of the optional argument list.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateFunctionDeclaration	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndType,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndName,
		LSUINT32	_ui32Parms,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a function-declaration node.

Parameters:

_ndType	Type information.
_ndName	Function name.
_ui32Parms	Optional parameters.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateFunctionDefinition	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndHeader,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBody,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a function definition node.

Parameters:

_ndHeader	Function header and parameters.
_ndBody	Function body.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateIdentifier	(	const LSCHAR *	_pcText,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a node pointing to an identifier (by index into the identifier stack).

Parameters:

_pcText	The string name of the identifier.
_ndNode	Node to create based off the string constant.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateInitializerList	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates an initializer list.

Parameters:

_ndLeft	Left operand.
_ndRight	Right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateInitializerListWrap	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndList,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates an initializer list, wrapped inside {}.

Parameters:

_ndList	The initialier list.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateIntrinsic	(	LSUINT32	_ui32Intrinsic,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndExp,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates an intrinsic function.

Parameters:

_ui32Intrinsic	The intrinsic to create.
_ndExp	The parameters for the intrinsic function.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateJump	(	LSG_NODE	_nType,
		LSUINT32	_ui32NodeIndex,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a jump node.

Parameters:

_nType	The jump node type.
_ui32NodeIndex	Index of the associated node, if there is one.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateMath	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSUINT32	_ui32Op,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a node referencing two other nodes with an operator between them. From X * Y to X && Y.

Parameters:

_ndLeft	The left operand.
_ndRight	The right operand.
_ui32Op	The operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateNewScopedStatement	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndStatement,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a statement with a raised scope.

Parameters:

_ndStatement	The statement with the increased scope.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateParameterDeclaration	(	LSUINT64	_ui64TypeInfo,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndDecl,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a parameter declaration node.

Parameters:

_ui64TypeInfo	Full type-qualifier information.
_ndDecl	Declaration node.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateParameterDeclarationList	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a parameter declaration list.

Parameters:

_ndLeft	Left operand.
_ndRight	Right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateParameterDeclarator	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndType,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndName,
		LSUINT32	_ui32ArrayNodeIndex,
		LSUINT32	_ui32SemanticNodeIndex,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a parameter declarator node.

Parameters:

_ndType	The type information.
_ndName	Parameter name.
_ui32ArrayNodeIndex	Index of the node associated with the array part of the declarator if any.
_ui32SemanticNodeIndex	Index of the node associated with the semantic part of the declarator if any.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreatePostfixOrPrefixIncOrDec	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndOp,
		LSG_NODE	_nType,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a postfix or prefix ++ or -- node.

Parameters:

_ndOp	The left operand.
_nType	Type of operation.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateSelectionStatement	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndExp,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBody,
		LSUINT32	_ui32ElseBody,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a selection (if/else) statement node.

Parameters:

_ndExp	The expression to evaluate.
_ndBody	The statement body.
_ui32ElseBody	The index of the else body statement if any.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateSemantic	(	const LSCHAR *	_pcText,
		LSUINT32	_ui32Type,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a semantic.

Parameters:

_pcText	The semantic text.
_ui32Type	The semantic type.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateSingleDeclaration	(	LSUINT32	_ui32Name,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndTypeNode,
		LSUINT32	_ui32ConstNodeIndex,
		LSUINT32	_ui32SemanticNodeIndex,
		LSUINT32	_ui32InitializerNodeIndex,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a single declaration. Such as "flat vector g_vUp = { 0.0f, 1.0f, 0.0 }".

Parameters:

_ui32Name	Name of the variable to create.
_ndTypeNode	Fully specified type data.
_ui32ConstNodeIndex	Index of the constant-expression node or ~0UL if there is none.
_ui32SemanticNodeIndex	Index of the semantic node or ~0UL if there is none.
_ui32InitializerNodeIndex	Index of the initializer node or ~0UL if there is none.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateStatementList	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a statement list.

Parameters:

_ndLeft	Left operand.
_ndRight	Right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::CreateString	(	const LSCHAR *	_pcText,
		LSBOOL	_bHasQuotes = `true`
	)

Accepts a string from code in a shader, converts it to binary (for example, is converted to character 0x0D), and returns the index of the string where it was stored in the pool of strings.

Parameters:

_pcText	The string from the code to convert and store.
_bHasQuotes	If true, the first and last characters are assumed to be quotation marks and not part of the string itself.

Returns:: Returns the index of the stored string or ~0UL on error.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateStruct	(	LSUINT32	_ui32IdentifierIndex,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndDecl,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a structure node.

Parameters:

_ui32IdentifierIndex	Index of the node representing the name of the structure, if any. ~0UL if the structure is nameless.
_ndDecl	The structure members.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateStructDeclaration	(	LSUINT64	_ui64Qualifiers,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndType,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndDecl,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a structure declarator. A full member or list of members with the same type specifiers and qualifiers.

Parameters:

_ui64Qualifiers	The qualifiers.
_ndType	The type data.
_ndDecl	The declarator node, always of type LSG_N_STRUCTDECLARATORLIST.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateStructDeclarationList	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a structure declaration list node.

Parameters:

_ndLeft	The left operand.
_ndRight	The right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateStructDeclarator	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndName,
		LSUINT32	_ui32ArrayNodeIndex,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a structure-declarator node. This is the declaration of a single member of a structure excluding type qualifiers.

Parameters:

_ndName	Identifier node representing the name of the member.
_ui32ArrayNodeIndex	Index of the node representing the array constant or ~0UL.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateStructDeclaratorList	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a structure-declarator list node.

Parameters:

_ndLeft	Left operand.
_ndRight	Right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateTertiary	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndCond,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndLeft,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndRight,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a tertiary ?: expression.

Parameters:

_ndCond	The conditional operand.
_ndLeft	The left operand.
_ndRight	The right operand.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateTypeSpecifier	(	LSUINT64	_ui64Qualifiers,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a type-specifier node without a precision qualifier. Precision qualifiers do not currently exist but may in the future.

Parameters:

_ui64Qualifiers	The type qualifiers.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateUnaryOp	(	LSUINT32	_ui32Op,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBase,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a unary !, ~, -, or + node.

Parameters:

_ui32Op	The operator.
_ndBase	The base expression modified by the operator.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::CreateWhileLoop	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndExp,
		const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndBody,
		LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode
	)

Creates a while () node.

Parameters:

_ndExp	The conditional expression.
_ndBody	The body of the iterator.
_ndNode	Node to create.

Returns:: Returns true if the node was added.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::FindIdentifier ( const LSCHAR * _pcName ) const

Find an identifier by name.

Parameters:

_pcName Name of the identifier to find.

Returns:: Returns the index of the identifier with the given name in the stack of identifiers or ~0UL on error.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::FindToken	(	const LSCHAR *	_pcName,
		LSUINT32 &	_ui32Index
	)		const `[protected]`

Get the index of a token or the index where the token should be added if it is not in the list of tokens.

Parameters:

_pcName	Name of the token to find.
_ui32Index	Holds the returned index.

Returns:: Returns true if the token is in the list, false otherwise.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::GetArrayIndexOfParm ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the array index of a parameter declaration (LSG_N_PARMDECLARATION) node.

Parameters:

_ndNode Node to search.

Returns:: Returns the array index of the given node.

static LSUINT32 LSE_CALL lsg::CShaderLanguageParser::GetArrayUnit	(	LSUINT64	_ui64Type,
		LSUINT32	_ui32Unit
	)		`[static]`

Gets the length of an array unit of a type.

Parameters:

_ui64Type	The type whose array unit is to be obtained.
_ui32Unit	The array unit to be obtained.

Returns:: Returns the array unit of a given type.

static LSG_NUM_CONSTANTS LSE_CALL lsg::CShaderLanguageParser::GetHighType	(	LSG_NUM_CONSTANTS	_ncLeft,
		LSG_NUM_CONSTANTS	_ncRight
	)		`[static]`

Get the best type between the two given types. In order: bool, int, uint, float.

Parameters:

_ncLeft	The left type.
_ncRight	The right type.

Returns:: Returns the highest precision type between the two given types.

const LSG_IDENTIFIER& LSE_CALL lsg::CShaderLanguageParser::GetIdentifier ( LSUINT32 _ui32Index ) const

Get an identifier by index.

Parameters:

_ui32Index Index of the identifier to get.

Returns:: Returns a constant reference to the requested identifier.

static LSVOID LSE_CALL lsg::CShaderLanguageParser::GetMatrixSize	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right,
		LSUINT32 &	_ui32Columns,
		LSUINT32 &	_ui32Rows
	)		`[static]`

Get the matrix dimensions from the type that is a matrix. Exactly one of the types must be a matrix.

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.
_ui32Columns	Number of columns.
_ui32Rows	Number of rows.

const CString& LSE_CALL lsg::CShaderLanguageParser::GetName ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get a name from an identifier node.

Parameters:

_ndNode The node from which to extract the name.

Returns:: Returns the name of the given node.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::GetNameIndex ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the index of a name from an identifier node.

Parameters:

_ndNode The node from which to extract the name index.

Returns:: Returns the index of the name of the given node.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::GetNameIndexOfParm ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the name index of a parameter declaration (LSG_N_PARMDECLARATION) node.

Parameters:

_ndNode Node to search.

Returns:: Returns the name index of the given node.

const CString& LSE_CALL lsg::CShaderLanguageParser::GetNameOfParm ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the name of a parameter declaration (LSG_N_PARMDECLARATION) node.

Parameters:

_ndNode Node to search.

Returns:: Returns the name of the given node.

const LSG_SHADER_SYNTAX_NODES::LSG_NODE_DATA& LSE_CALL lsg::CShaderLanguageParser::GetNode ( LSUINT32 _ui32Index ) const

Get a node for read-only.

Parameters:

_ui32Index Index of the node to get.

Returns:: Returns a constant reference to the requested node.

LSG_NUM_CONSTANTS LSE_CALL lsg::CShaderLanguageParser::GetNodeValue	(	const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA &	_ndNode,
		LSG_SCALAR &	_sValue
	)		const

Get the type and value of a node. The node must represent a constant numeric type.

Parameters:

_ndNode	The node to test.
_sValue	The value of the node, which should be reinterpreted based on the type of the node.

Returns:: Returns the type of the node.

LSUINT64 LSE_CALL lsg::CShaderLanguageParser::GetSemantic ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the semantics node from a parameter declaration (LSG_N_PARMDECLARATION) node.

Parameters:

_ndNode Node to search.

Returns:: Returns the semantic type and the semantic numeric, with the numeric being stored in the upper 32 bits of the return value. If there is no semantic, ~0ULL is returned.

LSG_SHADER_TYPES LSE_CALL lsg::CShaderLanguageParser::GetShaderType ( ) const

Get the shader type.

Returns:: Returns the shader type.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::GetSize ( LSUINT64 _ui64Type ) const

Get the size of a type. For structures, elements are always packed on 16-byte boundaries, and the size returned will be rounded up to the next 16-byte boundary.

Parameters:

_ui64Type The type whose size is to be obtained.

Returns:: Returns the size of the given type or ~0UL if the type is not defined.

const CString& LSE_CALL lsg::CShaderLanguageParser::GetString ( LSUINT32 _ui32Index ) const

Get a string by index.

Parameters:

_ui32Index Index of the string to get.

Returns:: Returns a constant reference to the requested string.

CString LSE_CALL lsg::CShaderLanguageParser::GetStructById ( LSUINT32 _ui32Id ) const

Get a structure name by its type ID.

Parameters:

_ui32Id ID of the user-defined structure to get.

Returns:: Returns the name of the structure if found, or an empty string if not.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::GetStructDeclarators	(	LSUINT32	_ui32Index,
		CVectorPoD< LSG_STRUCT_DECLARATOR > &	_vRet
	)		const

Get the declarators on a structure declaration.

Parameters:

_ui32Index	Index of the structure declaration.
_vRet	Returned array of structure declarators.

Returns:: Returns true if there was enough memory to perform the operation.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::GetStructTypeId ( const LSCHAR * _pcText ) const

Get the type ID for a given user-defined type. Returns 0 if no such type exists.

Parameters:

_pcText The type name.

Returns:: Returns the type ID if the given type name exists or 0 if it does not.

static LSUINT32 LSE_CALL lsg::CShaderLanguageParser::GetType ( LSUINT64 _ui64Type ) [static]

Get the type part of a type + array-unit combination.

Parameters:

_ui64Type The type whose type data is to be obtained.

Returns:: Returns the type part of the combination.

LSUINT64 LSE_CALL lsg::CShaderLanguageParser::GetType ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the type from a fully specified type node.

Parameters:

_ndNode The node from which to extract the type.

Returns:: Returns the type from the given node.

LSUINT64 LSE_CALL lsg::CShaderLanguageParser::GetTypeOnParm ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the type from a parameter declaration (LSG_N_PARMDECLARATION) node.

Parameters:

_ndNode Node to search.

Returns:: Returns the type on the given node.

LSUINT64 LSE_CALL lsg::CShaderLanguageParser::GetTypeQualifier ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the type qualifiers from a fully specified type node.

Parameters:

_ndNode The node from which to extract the type qualifiers.

Returns:: Returns the type qualifiers from the given node.

LSUINT64 LSE_CALL lsg::CShaderLanguageParser::GetTypeQualifiersOnParm ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Get the type qualifiers from a parameter declaration (LSG_N_PARMDECLARATION) node.

Parameters:

_ndNode Node to search.

Returns:: Returns the type qualifiers on the given node.

static LSVOID LSE_CALL lsg::CShaderLanguageParser::GetVectorSize	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right,
		LSUINT32 &	_ui32Ret
	)		`[static]`

Get the vector dimension from the type that is a vector. Exactly one of the types must be a vector.

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.
_ui32Ret	Number of scalars in the vector type.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::IsEitherMatrix	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Is one type or the other a matrix?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if either type is a matrix type.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::IsEitherScalar	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Is one type or the other a scalar?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if either type is a scalar type.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::IsEitherStruct	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Is one type or the other a structure?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if either type is a structure type.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::IsEitherVector	(	LSUINT64	_ui64Left,
		LSUINT64	_ui64Right
	)		`[static]`

Is one type or the other a vector?

Parameters:

_ui64Left	Left type.
_ui64Right	Right type.

Returns:: Returns true if either type is a vector type.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::IsInteger ( const LSG_PREPROC_SYNTAX_NODES::LSG_NODE_DATA & _ndNode ) const

Determine if a given expression resolves to an integer value.

Parameters:

_ndNode The node to check.

Returns:: Returns true if the expression resolves to an integer value.

static LSBOOL LSE_CALL lsg::CShaderLanguageParser::IsInteger ( LSUINT64 _ui64Type ) [static]

Is the given type an integral type?

Parameters:

_ui64Type The type to check for being an integer.

Returns:: Returns true if the given type is an integral type that is not an array.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::IsToken ( const LSCHAR * _pcText ) const

Is the given string a registered token?

Parameters:

_pcText Name to check for being a token as apposed to an identifier.

Returns:: Returns true if the given string is a token name.

LSBOOL LSE_CALL lsg::CShaderLanguageParser::RegisterStructType ( const LSCHAR * _pcText )

Register a user type. This is always a structure.

Parameters:

_pcText The type name.

Returns:: Returns true if there is enough memory to perform the operation.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::TotalIdentifiers ( ) const

Get the total identifiers.

Returns:: Returns the total number of identifiers.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::TotalNodes ( ) const

Get the total number of nodes.

Returns:: Returns the total number of nodes in the syntax tree.

LSUINT32 LSE_CALL lsg::CShaderLanguageParser::TotalStrings ( ) const

Get the total strings.

Returns:: Returns the total number of strings.

static LSG_NUM_CONSTANTS LSE_CALL lsg::CShaderLanguageParser::TypeToConstantType ( LSUINT64 _ui64Type ) [static]

Convert a type to a numeric-constant type. Returns LSG_NC_INVALID if the type is not a basic type (arrays).

Parameters:

_ui64Type The type to convert.

Returns:: Returns the LSG_NUM_CONSTANTS type of the given type.

Member Data Documentation

CMap<CString, LSUINT32> lsg::CShaderLanguageParser::m_mUserTypes [protected]

Mapping between user types and their ID's. Because a user type may only be declared once, there is no need to support multiple ID's for a type name.

CShaderLexer* lsg::CShaderLanguageParser::m_plLexer [protected]

The lexer, needed for the line number.

LSG_STRUCT_ARRAY lsg::CShaderLanguageParser::m_saStructures [protected]

Map of structures sorted by name.

CShaderScopeStack lsg::CShaderLanguageParser::m_sssScopes [protected]

Stack of scopes. We maintain at least one scope always (the global scope) during parsing of the data. After the data has been parsed, the scope stack is cleared.

LSG_SHADER_TYPES lsg::CShaderLanguageParser::m_stShaderType [protected]

The type of shader being compiled.

LSUINT32 lsg::CShaderLanguageParser::m_ui32TypeId [protected]

Unique-type counter.

CVectorPoD<LSG_IDENTIFIER, LSUINT32, 512UL> lsg::CShaderLanguageParser::m_vIdentifiers [protected]

Stack of identifiers.

CVectorPoD<LSG_SHADER_SYNTAX_NODES::LSG_NODE_DATA, LSUINT32, 512UL * 10UL> lsg::CShaderLanguageParser::m_vNodes [protected]

The stack of nodes.

CVectorPoD<LSUINT32, LSUINT32, 512UL> lsg::CShaderLanguageParser::m_vSortedTokens [protected]

Sorted list of tokens. Sorted for fast searching.

CVector<CString, LSUINT32, 512UL> lsg::CShaderLanguageParser::m_vStringPool [protected]

A pool of strings. Strings are binary and not necessarily terminated with a NULL.

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

F:/My Projects/LSEngine/Modules/LSGraphicsLib/Src/ShaderLanguage/LSGShaderLanguageParser.h

lsg::CShaderLanguageParser Class Reference

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation