uiAction_s Struct Reference

Atomic element to store UI scripts The parser use this atom to translate script action into many trees of actions. One function is one tree, and when we call this function, the tree is executed. More...

#include <ui_actions.h>

Data Fields
short	type
	Define the type of the element, it can be a command, an operator, or a value. More...
short	subType
	Some operators/commands/values can use it to store info about the content. More...
union {
struct {
struct uiAction_s *   left
struct uiAction_s *   right
}   nonTerminal
	Stores a none terminal action (a command or an operator) More...
struct {
uiTerminalActionData_t   d1
uiTerminalActionData_t   d2
}   terminal
	Stores a terminal action (a value, which must be a leaf in the tree) More...
}	d
	Stores data about the action. More...
struct uiAction_s *	next
	Next element in the action list. More...

Detailed Description

Atomic element to store UI scripts The parser use this atom to translate script action into many trees of actions. One function is one tree, and when we call this function, the tree is executed.

An atom can be a command, an operator, or a value:

• Each command (EA_ACTION like EA_CALL, EA_CMD...) uses its own action structure. It can sometimes use child actions, or can be a leaf.
• Operators (EA_OPERATOR_*) use binary tree structure (left and right operands), else are unary.
• A value (EA_VALUE_*) is a terminal action (a leaf).

Todo:

FIXME Merge terminal and nonTerminal, this way is finally stupid. Left can be terminal and right can be non terminal, then the structure make non sens and can create hidden bugs.

Definition at line 144 of file ui_actions.h.

Field Documentation

union { ... } uiAction_s::d

Stores data about the action.

Referenced by UI_AddListener(), UI_AllocStaticCommandAction(), UI_ExecuteAction(), UI_ExecuteCallAction(), UI_ExecuteSetAction(), UI_GetBooleanFromExpression(), UI_GetFloatFromExpression(), UI_GetNodeFromExpression(), UI_GetStringFromExpression(), UI_InitRawActionValue(), UI_NodeSetPropertyFromActionValue(), UI_ParseActionList(), UI_ParseCallAction(), UI_ParseExpression(), UI_ParseSetAction(), UI_ParseValueExpression(), UI_PopupList(), UI_RemoveListener(), and UI_SetOneButton().

uiTerminalActionData_t uiAction_s::d1

Definition at line 175 of file ui_actions.h.

uiTerminalActionData_t uiAction_s::d2

Definition at line 176 of file ui_actions.h.

struct uiAction_s* uiAction_s::left

Definition at line 165 of file ui_actions.h.

struct uiAction_s* uiAction_s::next

Next element in the action list.

Definition at line 183 of file ui_actions.h.

Referenced by UI_AddListener(), UI_ExecuteAction(), UI_ExecuteCallAction(), UI_ParseActionList(), UI_ParseCallAction(), UI_ParseEventProperty(), and UI_RemoveListener().

struct { ... } uiAction_s::nonTerminal

Stores a none terminal action (a command or an operator)

Note

The action type must be a command or an operator

Referenced by UI_AddListener(), UI_ExecuteAction(), UI_ExecuteCallAction(), UI_ExecuteSetAction(), UI_GetBooleanFromExpression(), UI_GetFloatFromExpression(), UI_GetNodeFromExpression(), UI_ParseActionList(), UI_ParseCallAction(), UI_ParseExpression(), UI_ParseSetAction(), and UI_RemoveListener().

struct uiAction_s* uiAction_s::right

Definition at line 166 of file ui_actions.h.

short uiAction_s::subType

Some operators/commands/values can use it to store info about the content.

Definition at line 154 of file ui_actions.h.

struct { ... } uiAction_s::terminal

Stores a terminal action (a value, which must be a leaf in the tree)

Note

The action type must be value (or sometimes a command)

Todo:

Define the "sometimes"

Referenced by UI_AddListener(), UI_AllocStaticCommandAction(), UI_ExecuteAction(), UI_ExecuteCallAction(), UI_ExecuteSetAction(), UI_GetBooleanFromExpression(), UI_GetFloatFromExpression(), UI_GetNodeFromExpression(), UI_GetStringFromExpression(), UI_InitRawActionValue(), UI_NodeSetPropertyFromActionValue(), UI_ParseActionList(), UI_ParseSetAction(), UI_ParseValueExpression(), UI_PopupList(), UI_RemoveListener(), and UI_SetOneButton().

short uiAction_s::type

Define the type of the element, it can be a command, an operator, or a value.

See also

ea_t

Definition at line 149 of file ui_actions.h.

Referenced by UI_AddListener(), UI_AllocStaticCommandAction(), UI_ExecuteAction(), UI_ExecuteCallAction(), UI_ExecuteSetAction(), UI_GetBooleanFromExpression(), UI_GetFloatFromExpression(), UI_GetNodeFromExpression(), UI_GetStringFromExpression(), UI_InitRawActionValue(), UI_NodeSetPropertyFromActionValue(), UI_ParseActionList(), UI_ParseCallAction(), UI_ParseExpression(), UI_ParseSetAction(), and UI_ParseValueExpression().

---

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

• src/client/ui/ui_actions.h