ui_node_keybinding.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 "../ui_main.h"
#include "../ui_draw.h"
#include "../ui_nodes.h"
#include "../ui_font.h"
#include "../ui_parse.h"
#include "../ui_input.h"
#include "../ui_actions.h"
#include "../ui_render.h"
#include "ui_node_keybinding.h"
#include "ui_node_abstractnode.h"
#include "ui_node_panel.h"

#include "../../client.h"

#define TILE_SIZE 64
#define CORNER_SIZE 17
#define MID_SIZE 1
#define MARGE 3

#define EXTRADATA_TYPE keyBindingExtraData_t
#define EXTRADATA(node) UI_EXTRADATA(node, EXTRADATA_TYPE)

static void UI_KeyBindingNodeClick (uiNode_t *node, int x, int y)
{
    if (node->disabled)
        return;

    /* no binding given */
    if (!node->text)
        return;

    if (strncmp(node->text, "*binding", 8))
        return;

    if (!UI_HasFocus(node)) {
        if (node->onClick)
            UI_ExecuteEventActions(node, node->onClick);
        UI_RequestFocus(node);
    }
}

static qboolean UI_KeyBindingNodeKeyPressed (uiNode_t *node, unsigned int key, unsigned short unicode)
{
    const char *command;
    const char *binding;

    UI_RemoveFocus();

    if (strncmp(node->text, "*binding:", 9))
        return qfalse;

    command = node->text + 9;

    binding = Key_GetBinding(command, EXTRADATA(node).keySpace);
    if (binding[0] != '\0') {
        /* if it's the same command, do not change anything, otherwise
         * show the reason why nothing was changed */
        if (strcmp(binding, command)) {
            const char *keyStr = Key_KeynumToString(key);
            UI_DisplayNotice(va(_("Key %s already bound"), keyStr), 2000, NULL);
        }
        return qfalse;
    }

    /* fire change event */
    if (node->onChange)
        UI_ExecuteEventActions(node, node->onChange);

    Key_SetBinding(key, command, EXTRADATA(node).keySpace);

    return qtrue;
}

static void UI_KeyBindingNodeDraw (uiNode_t *node)
{
    static const int panelTemplate[] = {
        CORNER_SIZE, MID_SIZE, CORNER_SIZE,
        CORNER_SIZE, MID_SIZE, CORNER_SIZE,
        MARGE
    };
    const char *binding, *description, *command;
    int texX, texY;
    const float *textColor;
    const char *image;
    vec2_t pos;
    const char *font = UI_GetFontFromNode(node);
    const int bindingWidth = EXTRADATA(node).bindingWidth;
    const int descriptionWidth = node->size[0] - bindingWidth;
    vec2_t descriptionPos, descriptionSize;
    vec2_t bindingPos, bindingSize;

    if (node->state) {
        textColor = node->color;
        texX = TILE_SIZE;
        texY = 0;
    } else {
        textColor = node->color;
        texX = 0;
        texY = 0;
    }
    if (UI_HasFocus(node))
        textColor = node->selectedColor;

    UI_GetNodeAbsPos(node, pos);

    Vector2Set(descriptionSize, descriptionWidth, node->size[1]);
    Vector2Set(bindingSize, bindingWidth, node->size[1]);
    Vector2Set(descriptionPos, pos[0], pos[1]);
    Vector2Set(bindingPos, pos[0] + descriptionWidth + node->padding, pos[1]);

    image = UI_GetReferenceString(node, node->image);
    if (image) {
        UI_DrawPanel(descriptionPos, descriptionSize, image, texX, texY, panelTemplate);
        UI_DrawPanel(bindingPos, bindingSize, image, texX, texY, panelTemplate);
    }

    binding = UI_GetReferenceString(node, node->text);
    if (binding == NULL || binding[0] == '\0')
        binding = _("NONE");

    command = node->text + 9;
    description = Cmd_GetCommandDesc(command);
    if (description[0] == '\0')
        description = command;

    R_Color(textColor);

    UI_DrawStringInBox(font, node->textalign,
        descriptionPos[0] + node->padding, descriptionPos[1] + node->padding,
        descriptionSize[0] - node->padding - node->padding, descriptionSize[1] - node->padding - node->padding,
        description, LONGLINES_PRETTYCHOP);

    UI_DrawStringInBox(font, node->textalign,
        bindingPos[0] + node->padding, bindingPos[1] + node->padding,
        bindingSize[0] - node->padding - node->padding, bindingSize[1] - node->padding - node->padding,
        binding, LONGLINES_PRETTYCHOP);

    R_Color(NULL);
}

static void UI_KeyBindingNodeLoading (uiNode_t *node)
{
    node->padding = 8;
    node->textalign = ALIGN_CL;
    EXTRADATA(node).bindingWidth = 50;
    Vector4Set(node->color, 1, 1, 1, 1);
    Vector4Set(node->selectedColor, 1, 1, 1, 0.5);
}

static const value_t properties[] = {
    {"keyspace", V_INT, UI_EXTRADATA_OFFSETOF(keyBindingExtraData_t, keySpace), MEMBER_SIZEOF(keyBindingExtraData_t, keySpace)},
    {"bindingwidth", V_INT, UI_EXTRADATA_OFFSETOF(keyBindingExtraData_t, bindingWidth), MEMBER_SIZEOF(keyBindingExtraData_t, bindingWidth)},

    {NULL, V_NULL, 0, 0}
};

void UI_RegisterKeyBindingNode (uiBehaviour_t *behaviour)
{
    behaviour->name = "keybinding";
    behaviour->leftClick = UI_KeyBindingNodeClick;
    behaviour->keyPressed = UI_KeyBindingNodeKeyPressed;
    behaviour->draw = UI_KeyBindingNodeDraw;
    behaviour->loading = UI_KeyBindingNodeLoading;
    behaviour->properties = properties;
    behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
}