ui_parse.h File Reference

#include "../../common/scripts.h"

Include dependency graph for ui_parse.h:

Go to the source code of this file.

Macros
#define	V_UI_MASK   0x8F00
#define	V_UI   0x8000
#define	V_NOT_UI   0
#define	V_UI_ACTION   (V_UI + 0)
#define	V_UI_EXCLUDERECT   (V_UI + 1)
#define	V_UI_SPRITEREF   (V_UI + 3)
#define	V_UI_IF   (V_UI + 4)
#define	V_UI_DATAID   (V_UI + 5)
#define	V_UI_CVAR   (V_UI + 0x0100)
#define	V_UI_REF   (V_UI + 0x0200)
#define	V_UI_NODEMETHOD   (V_UI + 0x0400)
#define	V_UI_NODEMETHOD_LUA   (V_UI + 0x0800)
#define	V_UI_ALIGN   V_INT
#define	V_CVAR_OR_FLOAT   (V_UI_CVAR + V_FLOAT)
#define	V_CVAR_OR_STRING   (V_UI_CVAR + V_STRING)
#define	V_CVAR_OR_LONGSTRING   (V_UI_CVAR + V_LONGSTRING)
#define	V_REF_OF_STRING   (V_UI_REF + V_STRING)

Functions
bool	UI_ParseWindow (const char *type, const char *name, const char **text)
	Parse a window.
bool	UI_ParseComponent (const char *type, const char *name, const char **text)
	Parse a component.
bool	UI_ParseSprite (const char *name, const char **text)
bool	UI_ParseUIModel (const char *name, const char **text)
	parses the models.ufo and all files where UI models (menu_model) are defined
float	UI_GetReferenceFloat (uiNode_t const *node, const void *ref)
	Returns the value of the reference variable.
const char *	UI_GetReferenceString (uiNode_t const *node, const char *ref) __attribute__((warn_unused_result))
const value_t *	UI_FindPropertyByName (const value_t *propertyList, const char *name) __attribute__((warn_unused_result))
	Find a value_t by name into a array of value_t.
char *	UI_AllocStaticString (const char *string, int size) __attribute__((warn_unused_result))
	Allocate a string into the UI static memory.
float *	UI_AllocStaticFloat (int count) __attribute__((warn_unused_result))
	Allocate a float into the UI static memory.
vec4_t *	UI_AllocStaticColor (int count) __attribute__((warn_unused_result))
	Allocate a color into the UI static memory.
struct uiAction_s *	UI_AllocStaticAction (void) __attribute__((warn_unused_result))
	Allocate an action.
bool	UI_InitRawActionValue (struct uiAction_s *action, uiNode_t *node, const struct value_s *property, const char *string)
bool	UI_TokenIsReserved (const char *name)
bool	UI_TokenIsName (const char *name, bool isQuoted)

Macro Definition Documentation

V_CVAR_OR_FLOAT

#define V_CVAR_OR_FLOAT   (V_UI_CVAR + V_FLOAT)

Definition at line 68 of file ui_parse.h.

Referenced by UI_GetFloatFromNodeProperty(), UI_GetStringFromNodeProperty(), UI_NodeSetProperty(), and UI_RegisterAbstractValueNode().

V_CVAR_OR_LONGSTRING

#define V_CVAR_OR_LONGSTRING   (V_UI_CVAR + V_LONGSTRING)

Definition at line 70 of file ui_parse.h.

Referenced by UI_GetStringFromNodeProperty(), UI_NodeSetProperty(), UI_RegisterAbstractNode(), and UI_RegisterNodePropertyPosSize_().

V_CVAR_OR_STRING

#define V_CVAR_OR_STRING   (V_UI_CVAR + V_STRING)

Definition at line 69 of file ui_parse.h.

Referenced by UI_GetFloatFromNodeProperty(), UI_GetStringFromNodeProperty(), UI_NodeSetProperty(), UI_RegisterAbstractNode(), UI_RegisterImageNode(), UI_RegisterModelNode(), UI_RegisterNodePropertyPosSize_(), UI_RegisterRadioButtonNode(), UI_RegisterSequenceNode(), UI_RegisterTBarNode(), UI_RegisterTextNode(), UI_RegisterTextureNode(), UI_RegisterVideoNode(), and UI_RegisterVScrollbarNode().

V_NOT_UI

#define V_NOT_UI   0

Definition at line 53 of file ui_parse.h.

Referenced by UI_GetStringFromNodeProperty(), UI_NodeSetProperty(), UI_NodeSetPropertyFromRAW(), and UI_ParseProperty().

V_REF_OF_STRING

#define V_REF_OF_STRING   (V_UI_REF + V_STRING)

Definition at line 71 of file ui_parse.h.

V_UI

#define V_UI   0x8000

bit identity an UI type

Definition at line 52 of file ui_parse.h.

Referenced by UI_NodeSetProperty(), and UI_ParseProperty().

V_UI_ACTION

#define V_UI_ACTION   (V_UI + 0)

Identify an action type into the value_t structure

Definition at line 54 of file ui_parse.h.

Referenced by uiFuncNode::onLoaded(), UI_AddListener_f(), UI_ExecuteCallAction(), UI_NodeSetPropertyFromRAW(), UI_ParseProperty(), UI_ParseSetAction(), UI_RegisterAbstractNode(), UI_RegisterAbstractOptionNode(), UI_RegisterAbstractScrollableNode(), UI_RegisterBaseInventoryNode(), UI_RegisterContainerNode(), UI_RegisterSequenceNode(), UI_RegisterTextEntryNode(), UI_RegisterTimerNode(), UI_RegisterVideoNode(), UI_RegisterWindowNode(), and UI_RemoveListener_f().

V_UI_ALIGN

#define V_UI_ALIGN   V_INT

Definition at line 65 of file ui_parse.h.

Referenced by UI_RegisterAbstractNode().

V_UI_CVAR

#define V_UI_CVAR   (V_UI + 0x0100)

Property is a CVAR string (mix this flag with base type, see bellow)

Definition at line 59 of file ui_parse.h.

Referenced by UI_DeleteNode(), UI_GetFloatFromNodeProperty(), UI_GetStringFromNodeProperty(), UI_InitRawActionValue(), UI_NodeSetProperty(), UI_NodeSetPropertyFromActionValue(), UI_NodeSetPropertyFromRAW(), UI_ParseProperty(), UI_RegisterAbstractOptionNode(), and UI_RegisterRadioButtonNode().

V_UI_DATAID

#define V_UI_DATAID   (V_UI + 5)

Definition at line 58 of file ui_parse.h.

Referenced by UI_ParseProperty(), UI_RegisterAbstractOptionNode(), and UI_RegisterTextNode().

V_UI_EXCLUDERECT

#define V_UI_EXCLUDERECT   (V_UI + 1)

Identify a special attribute, use special parse function

Definition at line 55 of file ui_parse.h.

Referenced by UI_ParseProperty(), and UI_RegisterAbstractNode().

V_UI_IF

#define V_UI_IF   (V_UI + 4)

Identify a special attribute, use special parse function

Definition at line 57 of file ui_parse.h.

Referenced by UI_ParseProperty(), and UI_RegisterAbstractNode().

V_UI_MASK

#define V_UI_MASK   0x8F00

Todo

we should split/flag parse type (type need only 1 lex; and other)

Mask for all UI bits

Definition at line 51 of file ui_parse.h.

Referenced by UI_DeleteNode(), UI_GetFloatFromNodeProperty(), UI_GetStringFromNodeProperty(), UI_InitRawActionValue(), UI_NodeSetProperty(), UI_NodeSetPropertyFromActionValue(), UI_NodeSetPropertyFromRAW(), and UI_ParseProperty().

V_UI_NODEMETHOD

#define V_UI_NODEMETHOD   (V_UI + 0x0400)

Property is a function

Definition at line 61 of file ui_parse.h.

Referenced by UI_ExecuteCallAction(), UI_InitializeNodeBehaviour(), UI_KeyPressedInWindow(), UI_RegisterNodeMethod(), and UI_SetKeyBindingEx().

V_UI_NODEMETHOD_LUA

#define V_UI_NODEMETHOD_LUA   (V_UI + 0x0800)

Properti is a lua based function

Definition at line 62 of file ui_parse.h.

Referenced by UI_ExecuteCallAction(), and UI_GetPropertyOrLuaMethod().

V_UI_REF

#define V_UI_REF   (V_UI + 0x0200)

Property is a ref into a value (mix this flag with base type, see bellow)

Definition at line 60 of file ui_parse.h.

Referenced by UI_ParseProperty().

V_UI_SPRITEREF

#define V_UI_SPRITEREF   (V_UI + 3)

Identify a special attribute, use special parse function

Definition at line 56 of file ui_parse.h.

Referenced by UI_InitRawActionValue(), UI_NodeSetProperty(), UI_NodeSetPropertyFromRAW(), UI_ParseProperty(), UI_RegisterButtonNode(), UI_RegisterCheckBoxNode(), UI_RegisterOptionListNode(), UI_RegisterOptionNode(), UI_RegisterOptionTreeNode(), UI_RegisterPanelNode(), UI_RegisterRadioButtonNode(), UI_RegisterSpinnerNode(), UI_RegisterTextEntryNode(), and UI_RegisterWindowNode().

Function Documentation

UI_AllocStaticAction()

struct uiAction_s * UI_AllocStaticAction

(

void

)

Allocate an action.

Returns

An action

Definition at line 221 of file ui_parse.cpp.

References Com_Error(), ERR_FATAL, ui_global, and UI_MAX_ACTIONS.

Referenced by UI_AllocStaticCommandAction(), UI_ParseActionList(), UI_ParseExpression(), UI_ParseSetAction(), and UI_ParseValueExpression().

UI_AllocStaticColor()

vec4_t * UI_AllocStaticColor

(

int

count

)

Allocate a color into the UI static memory.

Note

Its not a dynamic memory allocation. Please only use it at the loading time

Parameters

[in]

count

number of element need to allocate

Todo

Assert out when we are not in parsing/loading stage

Definition at line 187 of file ui_parse.cpp.

References Com_Error(), count, ERR_FATAL, and UI_AllocHunkMemory().

UI_AllocStaticFloat()

float * UI_AllocStaticFloat

(

int

count

)

Allocate a float into the UI static memory.

Note

Its not a dynamic memory allocation. Please only use it at the loading time

Parameters

[in]

count

number of element need to allocate

Todo

Assert out when we are not in parsing/loading stage

Definition at line 171 of file ui_parse.cpp.

References Com_Error(), count, ERR_FATAL, and UI_AllocHunkMemory().

Referenced by UI_CloneCvarOrFloat(), and UI_InitCvarOrFloat().

UI_AllocStaticString()

char * UI_AllocStaticString	(	const char *	string,
		int	size )

Allocate a string into the UI static memory.

Note

Its not a dynamic memory allocation. Please only use it at the loading time

Parameters

[in]	string	Use to initialize the string
[in]	size	request a fixed memory size, if 0 the string size is used

Todo

Assert out when we are not in parsing/loading stage

Definition at line 204 of file ui_parse.cpp.

References Com_Error(), ERR_FATAL, Q_strncpyz(), and UI_AllocHunkMemory().

Referenced by uiModelNode::clone(), uiModelNode::doLayout(), UI_AutoGenerateSprite(), UI_InitRawActionValue(), UI_ParseActionList(), UI_ParseSetAction(), and UI_ParseValueExpression().

UI_FindPropertyByName()

const value_t * UI_FindPropertyByName	(	const value_t *	propertyList,
		const char *	name )

Find a value_t by name into a array of value_t.

Parameters

[in]	propertyList	Array of value_t, with null termination
[in]	name	Property name we search

Returns

A value_t with the requested name, else nullptr

Definition at line 154 of file ui_parse.cpp.

References name, Q_strcasecmp, and value_t::string.

Referenced by UI_MaterialEditorChangeValue_f(), UI_ParseSprite(), and UI_ParseUIModel().

UI_GetReferenceFloat()

float UI_GetReferenceFloat	(	const uiNode_t *const	node,
		const void *	ref )

Returns the value of the reference variable.

Note

A reference variable is either a pointer to a float or a pointer to a string. In case of a pointer to a string, a Cvar name is expected, starting with "*cvar".

See also

uiAbstractValueNode

Definition at line 1434 of file ui_parse.cpp.

References Cvar_GetValue(), and Q_strstart().

Referenced by uiAbstractValueNode::decValue(), uiAbstractValueNode::getDelta(), uiAbstractValueNode::getMax(), uiAbstractValueNode::getMin(), uiAbstractValueNode::getValue(), uiAbstractValueNode::incValue(), uiRadioButtonNode::onActivate(), uiAbstractValueNode::setDelta(), uiAbstractValueNode::setMax(), uiAbstractValueNode::setMin(), uiAbstractValueNode::setValue(), UI_GetStringFromNodeProperty(), and UI_RadioButtonNodeIsSelected().

UI_GetReferenceString()

const char * UI_GetReferenceString	(	const uiNode_t *const	node,
		const char *	ref )

See also

Com_MacroExpandString

Todo

we should review this code, '*' doesn't work very well for all the needed things

Definition at line 1406 of file ui_parse.cpp.

References CL_Translate(), Com_MacroExpandString(), and Sys_Error().

Referenced by uiButtonNode::draw(), uiImageNode::draw(), uiItemNode::draw(), uiModelNode::draw(), uiRadioButtonNode::draw(), uiSelectBoxNode::draw(), uiStringNode::draw(), uiTBarNode::draw(), uiTextEntryNode::draw(), uiTextNode::draw(), uiTextureNode::draw(), uiVScrollbarNode::draw(), uiWindowNode::draw(), uiSelectBoxNode::drawOverWindow(), uiStringNode::drawTooltip(), UI_AbstractOption_GetCurrentValue(), UI_DrawModelNode(), UI_DrawModelNodeWithUIModel(), UI_GetFontFromNode(), UI_GetStringFromNodeProperty(), UI_RadioButtonNodeIsSelected(), UI_TextNodeGenerateLineSplit(), and UI_Tooltip().

UI_InitRawActionValue()

bool UI_InitRawActionValue	(	struct uiAction_s *	action,
		uiNode_t *	node,
		const struct value_s *	property,
		const char *	string )

References name.

UI_ParseComponent()

bool UI_ParseComponent	(	const char *	type,
		const char *	name,
		const char **	text )

Parse a component.

See also

CL_ParseClientData

component panel componentName {
}

Definition at line 1261 of file ui_parse.cpp.

References Com_EParse(), Com_Error(), Com_Printf(), ERR_FATAL, name, uiBehaviour_t::name, Q_streq, type, UI_AllocNode(), UI_CloneNode(), UI_GetComponent(), UI_GetNodeBehaviour(), UI_InsertComponent(), UI_Node_Loaded(), UI_ParseNodeBody(), UI_TokenIsName(), and UI_TokenIsReserved().

Referenced by CL_ParseClientData(), and UI_Restart_f().

UI_ParseSprite()

bool UI_ParseSprite	(	const char *	name,
		const char **	text )

Definition at line 1213 of file ui_parse.cpp.

References Com_Parse(), Com_Printf(), name, uiSprite_t::name, UI_AllocStaticSprite(), UI_FindPropertyByName(), UI_ParseProperty(), and ui_spriteProperties.

Referenced by CL_ParseClientData(), and UI_Restart_f().

UI_ParseUIModel()

bool UI_ParseUIModel	(	const char *	name,
		const char **	text )

parses the models.ufo and all files where UI models (menu_model) are defined

See also

CL_ParseClientData

Definition at line 1134 of file ui_parse.cpp.

References uiModel_t::color, Com_DPrintf(), Com_EParse(), Com_EParseValue(), Com_GetValue(), Com_Parse(), Com_Printf(), DEBUG_CLIENT, i, uiModel_t::id, Mem_PoolStrDup, Mem_PoolStrDupTo, name, uiModel_t::next, OBJZERO, Q_streq, Sys_Error(), UI_FindPropertyByName(), UI_GetUIModel(), ui_global, UI_MAX_MODELS, ui_sysPool, uiModelProperties, v, V_HUNK_STRING, V_NULL, and Vector4Set.

Referenced by CL_ParseClientData(), and UI_Restart_f().

UI_ParseWindow()

bool UI_ParseWindow	(	const char *	type,
		const char *	name,
		const char **	text )

Parse a window.

See also

CL_ParseClientData

window windowName {
}

Definition at line 1336 of file ui_parse.cpp.

References Com_Error(), Com_GetType(), Com_Parse(), Com_Printf(), ERR_FATAL, i, name, uiNode_t::name, Q_streq, uiNode_t::root, Sys_Error(), TT_QUOTED_WORD, type, UI_AllocNode(), UI_CloneNode(), UI_GetWindow(), ui_global, UI_InsertWindow(), UI_MAX_WINDOWS, UI_Node_Loaded(), UI_ParseNodeBody(), UI_TokenIsName(), and UI_TokenIsReserved().

Referenced by CL_ParseClientData(), and UI_Restart_f().

UI_TokenIsName()

bool UI_TokenIsName	(	const char *	name,
		bool	isQuoted )

Definition at line 126 of file ui_parse.cpp.

References name.

Referenced by UI_CreateComponent(), UI_CreateControl(), UI_CreateWindow(), UI_ParseComponent(), UI_ParseNode(), and UI_ParseWindow().

UI_TokenIsReserved()

bool UI_TokenIsReserved

(

const char *

name

)

Definition at line 82 of file ui_parse.cpp.

References name, Q_streq, and reservedTokens.

Referenced by UI_CreateComponent(), UI_CreateControl(), UI_CreateWindow(), UI_ParseComponent(), UI_ParseNode(), and UI_ParseWindow().