ui_node_special.c

Go to the documentation of this file.

/*
Copyright (C) 2002-2010 UFO: Alien Invasion.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#include "../../client.h"
#include "../ui_nodes.h"
#include "../ui_parse.h"
#include "../ui_actions.h"
#include "ui_node_window.h"
#include "ui_node_special.h"
#include "ui_node_abstractnode.h"

static void UI_FuncNodeLoaded (uiNode_t *node)
{
    const value_t *prop = UI_GetPropertyFromBehaviour(node->parent->behaviour, node->name);
    if (prop && prop->type == V_UI_ACTION) {
        void **value = (void**) ((uintptr_t)node->parent + prop->ofs);
        if (*value == NULL)
            *value = (void*) node->onClick;
        else
            Com_Printf("UI_FuncNodeLoaded: '%s' already defined. Second function ignored (\"%s\")\n", prop->string, UI_GetPath(node));
    }
}

void UI_RegisterSpecialNode (uiBehaviour_t *behaviour)
{
    behaviour->name = "special";
    behaviour->isVirtual = qtrue;
}

void UI_RegisterFuncNode (uiBehaviour_t *behaviour)
{
    behaviour->name = "func";
    behaviour->extends = "special";
    behaviour->isVirtual = qtrue;
    behaviour->isFunction = qtrue;
    behaviour->loaded = UI_FuncNodeLoaded;
}

void UI_RegisterNullNode (uiBehaviour_t *behaviour)
{
    behaviour->name = "";
    behaviour->extends = "special";
    behaviour->isVirtual = qtrue;
}

static void UI_ConfuncCommand_f (void)
{
    uiNode_t *node = (uiNode_t *) Cmd_Userdata();
    assert(node);
    assert(UI_NodeInstanceOf(node, "confunc"));
    UI_ExecuteConFuncActions(node, node->onClick);
}

static qboolean UI_ConFuncIsVirtual (const uiNode_t *const node)
{
    /* magic way to know if it is a dummy node (used for inherited confunc) */
    const uiNode_t *dummy = (const uiNode_t*) Cmd_GetUserdata(node->name);
    assert(node);
    assert(UI_NodeInstanceOf(node, "confunc"));
    return (dummy != NULL && dummy->parent == NULL);
}

static void UI_ConFuncNodeLoaded (uiNode_t *node)
{
    /* register confunc non inherited */
    if (node->super == NULL) {
        /* don't add a callback twice */
        if (!Cmd_Exists(node->name)) {
            Cmd_AddCommand(node->name, UI_ConfuncCommand_f, "Confunc callback");
            Cmd_AddUserdata(node->name, node);
        } else {
            Com_Printf("UI_ParseNodeBody: Command name for confunc '%s' already registered\n", UI_GetPath(node));
        }
    } else {
        uiNode_t *dummy;

        /* convert a confunc to an "inherited" confunc if it is possible */
        if (Cmd_Exists(node->name)) {
            if (UI_ConFuncIsVirtual(node))
                return;
        }

        dummy = UI_AllocNode(node->name, "confunc", qfalse);
        Cmd_AddCommand(node->name, UI_ConfuncCommand_f, "Inherited confunc callback");
        Cmd_AddUserdata(dummy->name, dummy);
    }
}

static void UI_ConFuncNodeClone (const uiNode_t *source, uiNode_t *clone)
{
    UI_ConFuncNodeLoaded(clone);
}

static void UI_ConFuncNodeInit (uiNode_t *node)
{
    if (UI_ConFuncIsVirtual(node)) {
        const value_t *property = UI_GetPropertyFromBehaviour(node->behaviour, "onClick");
        uiNode_t *userData = (uiNode_t*) Cmd_GetUserdata(node->name);
        UI_AddListener(userData, property, node);
    }
}

static void UI_ConFuncNodeClose (uiNode_t *node)
{
    if (UI_ConFuncIsVirtual(node)) {
        const value_t *property = UI_GetPropertyFromBehaviour(node->behaviour, "onClick");
        uiNode_t *userData = (uiNode_t*) Cmd_GetUserdata(node->name);
        UI_RemoveListener(userData, property, node);
    }
}

void UI_RegisterConFuncNode (uiBehaviour_t *behaviour)
{
    behaviour->name = "confunc";
    behaviour->extends = "special";
    behaviour->isVirtual = qtrue;
    behaviour->isFunction = qtrue;
    behaviour->loaded = UI_ConFuncNodeLoaded;
    behaviour->init = UI_ConFuncNodeInit;
    behaviour->close = UI_ConFuncNodeClose;
    behaviour->clone = UI_ConFuncNodeClone;
}

void UI_RegisterCvarFuncNode (uiBehaviour_t *behaviour)
{
    behaviour->name = "cvarfunc";
    behaviour->extends = "special";
    behaviour->isVirtual = qtrue;
    behaviour->isFunction = qtrue;
}