static void UI_AbstractNodeCallCreateChild (uiNode_t* node, const uiCallContext_t* context)
{
uiNode_t* child;
uiNode_t* component;
const char* name;
const char* type;
if (UI_GetParamNumber(context) != 2) {
Com_Printf("UI_AbstractNodeCallCreateChild: Invalid number of parameters\n");
return;
}
name = UI_GetParam(context, 1);
type = UI_GetParam(context, 2);
uiNode_t* existingNode = UI_GetNode(node, name);
if (existingNode != nullptr) {
Com_Printf("UI_AbstractNodeCallCreateChild: Node with name '%s' already exists\n", name);
}
component = UI_GetComponent(type);
if (component) {
child = UI_CloneNode(component, node->root, true, name, true);
} else {
child = UI_AllocNode(name, type, true);
}
if (child == nullptr) {
Com_Printf("UI_AbstractNodeCallCreateChild: Impossible to create the node\n");
return;
}
UI_AppendNode(node, child);
}
/**
* @brief Clone a node
* @param[in] node Node to clone
* @param[in] recursive True if we also must clone subnodes
* @param[in] newWindow Window where the nodes must be add (this function only link node into window, not window into the new node)
* @param[in] newName New node name, else nullptr to use the source name
* @param[in] isDynamic Allocate a node in static or dynamic memory
* @todo exclude rect is not safe cloned.
* @todo actions are not cloned. It is be a problem if we use add/remove listener into a cloned node.
*/
uiNode_t* UI_CloneNode (const uiNode_t* node, uiNode_t* newWindow, bool recursive, const char* newName, bool isDynamic)
{
uiNode_t* newNode = UI_AllocNodeWithoutNew(nullptr, UI_Node_GetWidgetName(node), isDynamic);
/* clone all data */
memcpy(newNode, node, UI_Node_GetMemorySize(node));
newNode->dynamic = isDynamic;
/* custom name */
if (newName != nullptr) {
Q_strncpyz(newNode->name, newName, sizeof(newNode->name));
if (strlen(newNode->name) != strlen(newName))
Com_Printf("UI_CloneNode: Node name \"%s\" truncated. New name is \"%s\"\n", newName, newNode->name);
}
/* clean up node navigation */
if (node->root == node && newWindow == nullptr)
newWindow = newNode;
newNode->root = newWindow;
newNode->parent = nullptr;
newNode->firstChild = nullptr;
newNode->lastChild = nullptr;
newNode->next = nullptr;
newNode->super = node;
/* clone node methods */
if (node->nodeMethods) {
newNode->nodeMethods = HASH_CloneTable(node->nodeMethods);
}
/* allocate memories */
if (newNode->dynamic) {
UI_Node_InitNodeDynamic(newNode);
}
/* typically, cloning makes a copy of all the internals of a source node; override the ::clone(node) method
to alter this behaviour */
UI_Node_Clone(node, newNode);
/* clone child */
if (recursive) {
for (uiNode_t* childNode = node->firstChild; childNode; childNode = childNode->next) {
uiNode_t* newChildNode = UI_CloneNode(childNode, newWindow, recursive, nullptr, isDynamic);
UI_AppendNode(newNode, newChildNode);
}
}
return newNode;
}
/**
* @brief Clone a node
* @param[in] node Node to clone
* @param[in] recursive True if we also must clone subnodes
* @param[in] newWindow Window where the nodes must be add (this function only link node into window, not window into the new node)
* @param[in] newName New node name, else NULL to use the source name
* @param[in] isDynamic Allocate a node in static or dynamic memory
* @todo exclude rect is not safe cloned.
* @todo actions are not cloned. It is be a problem if we use add/remove listener into a cloned node.
*/
uiNode_t* UI_CloneNode (const uiNode_t* node, uiNode_t *newWindow, qboolean recursive, const char *newName, qboolean isDynamic)
{
uiNode_t* newNode = UI_AllocNodeWithoutNew(NULL, node->behaviour->name, isDynamic);
/* clone all data */
memcpy(newNode, node, sizeof(*node) + node->behaviour->extraDataSize);
newNode->dynamic = isDynamic;
/* custom name */
if (newName != NULL) {
Q_strncpyz(newNode->name, newName, sizeof(newNode->name));
if (strlen(newNode->name) != strlen(newName))
Com_Printf("UI_CloneNode: Node name \"%s\" truncated. New name is \"%s\"\n", newName, newNode->name);
}
/* clean up node navigation */
if (node->root == node && newWindow == NULL)
newWindow = newNode;
newNode->root = newWindow;
newNode->parent = NULL;
newNode->firstChild = NULL;
newNode->lastChild = NULL;
newNode->next = NULL;
newNode->super = *(uiNode_t**) ((void*)&node);
/* clone child */
if (recursive) {
uiNode_t* childNode;
for (childNode = node->firstChild; childNode; childNode = childNode->next) {
uiNode_t* newChildNode = UI_CloneNode(childNode, newWindow, recursive, NULL, isDynamic);
UI_AppendNode(newNode, newChildNode);
}
}
/* allocate memories */
if (newNode->dynamic && newNode->behaviour->newNode)
newNode->behaviour->newNode(newNode);
newNode->behaviour->clone(node, newNode);
return newNode;
}
/**
* @brief Clone a node
* @param[in] node Node to clone
* @param[in] recursive True if we also must clone subnodes
* @param[in] newWindow Window where the nodes must be add (this function only link node into window, not window into the new node)
* @param[in] newName New node name, else nullptr to use the source name
* @param[in] isDynamic Allocate a node in static or dynamic memory
* @todo exclude rect is not safe cloned.
* @todo actions are not cloned. It is be a problem if we use add/remove listener into a cloned node.
*/
uiNode_t* UI_CloneNode (const uiNode_t* node, uiNode_t *newWindow, bool recursive, const char *newName, bool isDynamic)
{
uiNode_t* newNode = UI_AllocNodeWithoutNew(nullptr, UI_Node_GetWidgetName(node), isDynamic);
/* clone all data */
memcpy(newNode, node, UI_Node_GetMemorySize(node));
newNode->dynamic = isDynamic;
/* custom name */
if (newName != nullptr) {
Q_strncpyz(newNode->name, newName, sizeof(newNode->name));
if (strlen(newNode->name) != strlen(newName))
Com_Printf("UI_CloneNode: Node name \"%s\" truncated. New name is \"%s\"\n", newName, newNode->name);
}
/* clean up node navigation */
if (node->root == node && newWindow == nullptr)
newWindow = newNode;
newNode->root = newWindow;
newNode->parent = nullptr;
newNode->firstChild = nullptr;
newNode->lastChild = nullptr;
newNode->next = nullptr;
newNode->super = node;
/* clone child */
if (recursive) {
uiNode_t* childNode;
for (childNode = node->firstChild; childNode; childNode = childNode->next) {
uiNode_t* newChildNode = UI_CloneNode(childNode, newWindow, recursive, nullptr, isDynamic);
UI_AppendNode(newNode, newChildNode);
}
}
/* allocate memories */
if (newNode->dynamic)
UI_Node_NewNode(newNode);
UI_Node_Clone(node, newNode);
return newNode;
}
/**
* @brief Parse a window
* @sa CL_ParseClientData
* @code
* window windowName {
* }
* @endcode
*/
bool UI_ParseWindow (const char* type, const char* name, const char** text)
{
const char* errhead = "UI_ParseWindow: unexpected end of file (window";
uiNode_t* window;
const char* token;
int i;
if (!Q_streq(type, "window")) {
Com_Error(ERR_FATAL, "UI_ParseWindow: '%s %s' is not a window node\n", type, name);
return false; /* never reached */
}
if (!UI_TokenIsName(name, Com_GetType(text) == TT_QUOTED_WORD)) {
Com_Printf("UI_ParseWindow: \"%s\" is not a well formed node name ([a-zA-Z_][a-zA-Z0-9_]*)\n", name);
return false;
}
if (UI_TokenIsReserved(name)) {
Com_Printf("UI_ParseWindow: \"%s\" is a reserved token, we can't call a node with it (node \"%s\")\n", name, name);
return false;
}
/* search for windows with same name */
for (i = 0; i < ui_global.numWindows; i++)
if (!strncmp(name, ui_global.windows[i]->name, sizeof(ui_global.windows[i]->name)))
break;
if (i < ui_global.numWindows) {
Com_Printf("UI_ParseWindow: %s \"%s\" with same name found, second ignored\n", type, name);
}
if (ui_global.numWindows >= UI_MAX_WINDOWS) {
Com_Error(ERR_FATAL, "UI_ParseWindow: max windows exceeded (%i) - ignore '%s'\n", UI_MAX_WINDOWS, name);
return false; /* never reached */
}
/* get window body */
token = Com_Parse(text);
/* does this window inherit data from another window? */
if (Q_streq(token, "extends")) {
uiNode_t* superWindow;
token = Com_Parse(text);
superWindow = UI_GetWindow(token);
if (superWindow == nullptr)
Sys_Error("Could not get the super window \"%s\"", token);
window = UI_CloneNode(superWindow, nullptr, true, name, false);
token = Com_Parse(text);
} else {
window = UI_AllocNode(name, type, false);
window->root = window;
}
UI_InsertWindow(window);
/* parse it's body */
bool result = UI_ParseNodeBody(window, text, &token, errhead);
if (!result) {
Com_Error(ERR_FATAL, "UI_ParseWindow: window \"%s\" has a bad body\n", window->name);
}
UI_Node_Loaded(window);
return true;
}
/**
* @brief Parse a component
* @sa CL_ParseClientData
* @code
* component panel componentName {
* }
* @endcode
*/
bool UI_ParseComponent (const char* type, const char* name, const char** text)
{
const char* errhead = "UI_ParseComponent: unexpected end of file (component";
const char* token;
if (!Q_streq(type, "component")) {
Com_Error(ERR_FATAL, "UI_ParseComponent: \"component\" expected but \"%s\" found.\n", type);
return false; /* never reached */
}
/* check the name */
if (!UI_TokenIsName(name, false)) {
Com_Printf("UI_ParseNode: \"%s\" is not a well formed node name ([a-zA-Z_][a-zA-Z0-9_]*)\n", name);
return false;
}
if (UI_TokenIsReserved(name)) {
Com_Printf("UI_ParseNode: \"%s\" is a reserved token, we can't call a node with it\n", name);
return false;
}
token = Com_EParse(text, errhead, "");
if (text == nullptr)
return false;
/* get keyword */
if (!Q_streq(token, "extends")) {
Com_Printf("UI_ParseComponent: \"extends\" expected but \"%s\" found (component %s)\n", token, name);
return false;
}
token = Com_EParse(text, errhead, "");
if (text == nullptr)
return false;
/* initialize component */
uiNode_t* component = nullptr;
const uiBehaviour_t* behaviour = UI_GetNodeBehaviour(token);
if (behaviour) {
/* initialize a new node from behaviour */
component = UI_AllocNode(name, behaviour->name, false);
} else {
const uiNode_t* inheritedComponent = UI_GetComponent(token);
if (inheritedComponent) {
/* initialize from a component */
component = UI_CloneNode(inheritedComponent, nullptr, true, name, false);
} else {
Com_Printf("UI_ParseComponent: node behaviour/component '%s' doesn't exists (component %s)\n", token, name);
return false;
}
}
/* get body */
token = Com_EParse(text, errhead, "");
if (!*text)
return false;
bool result = UI_ParseNodeBody(component, text, &token, errhead);
if (!result)
return false;
/* validate properties */
UI_Node_Loaded(component);
UI_InsertComponent(component);
return true;
}
/**
* @brief parse a node
* @sa UI_ParseNodeProperties
* @todo we can think about merging UI_ParseNodeProperties here
* @note first token already read
* @note dont read more than the need token (last right token is '}' of end of node)
*/
static uiNode_t* UI_ParseNode (uiNode_t* parent, const char** text, const char** token, const char* errhead)
{
uiNode_t* node = nullptr;
uiBehaviour_t* behaviour;
uiNode_t* component = nullptr;
/* get the behaviour */
behaviour = UI_GetNodeBehaviour(*token);
if (!behaviour) {
component = UI_GetComponent(*token);
}
if (behaviour == nullptr && component == nullptr) {
Com_Printf("UI_ParseNode: node behaviour/component '%s' doesn't exist (%s)\n", *token, UI_GetPath(parent));
return nullptr;
}
/* get the name */
*token = Com_EParse(text, errhead, "");
if (!*text)
return nullptr;
if (!UI_TokenIsName(*token, Com_GetType(text) == TT_QUOTED_WORD)) {
Com_Printf("UI_ParseNode: \"%s\" is not a well formed node name ([a-zA-Z_][a-zA-Z0-9_]*)\n", *token);
return nullptr;
}
if (UI_TokenIsReserved(*token)) {
Com_Printf("UI_ParseNode: \"%s\" is a reserved token, we can't call a node with it\n", *token);
return nullptr;
}
/* test if node already exists */
/* Already existing node should only come from inherited node, we should not have 2 definitions of the same node into the same window. */
if (parent)
node = UI_GetNode(parent, *token);
/* reuse a node */
if (node) {
const uiBehaviour_t* test = (behaviour != nullptr) ? behaviour : (component != nullptr) ? component->behaviour : nullptr;
if (node->behaviour != test) {
Com_Printf("UI_ParseNode: we can't change node type (node \"%s\")\n", UI_GetPath(node));
return nullptr;
}
Com_DPrintf(DEBUG_CLIENT, "... over-riding node %s\n", UI_GetPath(node));
/* else initialize a component */
} else if (component) {
node = UI_CloneNode(component, nullptr, true, *token, false);
if (parent) {
if (parent->root)
UI_UpdateRoot(node, parent->root);
UI_AppendNode(parent, node);
}
/* else initialize a new node */
} else {
node = UI_AllocNode(*token, behaviour->name, false);
node->parent = parent;
if (parent)
node->root = parent->root;
/** @todo move it into caller */
if (parent)
UI_AppendNode(parent, node);
}
/* get body */
const bool result = UI_ParseNodeBody(node, text, token, errhead);
if (!result)
return nullptr;
/* validate properties */
UI_Node_Loaded(node);
return node;
}
