ui_node_textentry.cpp

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 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_nodes.h"
#include "../ui_font.h"
#include "../ui_parse.h"
#include "../ui_behaviour.h"
#include "../ui_input.h"
#include "../ui_render.h"
#include "../ui_sprite.h"
#include "../ui_lua.h"

#include "ui_node_textentry.h"
#include "ui_node_abstractnode.h"
#include "ui_node_panel.h"

#include "../../client.h"
#include "../../../shared/utf8.h"

#include "../../../common/scripts_lua.h"

#if SDL_VERSION_ATLEAST(2,0,0)
#include <SDL.h>
#else
#ifdef ANDROID
#include <SDL/SDL_screenkeyboard.h>
#endif
#endif

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

static const char CURSOR_ON = '|';      
static const char CURSOR_OFF = ' ';     
static const char HIDECHAR = '*';   
/* limit the input for cvar editing (base name, save slots and so on) */
#define MAX_CVAR_EDITING_LENGTH 256 /* MAXCMDLINE */

/* global data */
static char cvarValueBackup[MAX_CVAR_EDITING_LENGTH];
static cvar_t* editedCvar = nullptr;
static bool isAborted = false;

void UI_TextEntry_SetBackgroundByName (uiNode_t* node, const char* name) {
    uiSprite_t* sprite = UI_GetSpriteByName(name);
    UI_EXTRADATA(node, textEntryExtraData_s).background = sprite;
}

static void UI_TextEntryNodeValidateEdition (uiNode_t* node)
{
    /* invalidate cache */
    editedCvar = nullptr;
    cvarValueBackup[0] = '\0';

    /* fire change event */
    if (node->onChange) {
        UI_ExecuteEventActions(node, node->onChange);
    }
    if (node->lua_onChange != LUA_NOREF) {
        UI_ExecuteLuaEventScript(node, node->lua_onChange);
    }
}

static void UI_TextEntryNodeAbortEdition (uiNode_t* node)
{
    assert(editedCvar);

    /* set the old cvar value */
    Cvar_ForceSet(editedCvar->name, cvarValueBackup);

    /* invalidate cache */
    editedCvar = nullptr;
    cvarValueBackup[0] = '\0';

    /* fire abort event */
    if (EXTRADATA(node).onAbort) {
        UI_ExecuteEventActions(node, EXTRADATA(node).onAbort);
    }
}

void UI_TextEntryNodeFocus (uiNode_t* node, const uiCallContext_t* context)
{
    /* remove the focus to show changes */
    if (!UI_HasFocus(node)) {
        UI_RequestFocus(node);
    }
}

void UI_TextEntryNodeUnFocus (uiNode_t* node, const uiCallContext_t* context)
{
    /* remove the focus to show changes */
    if (UI_HasFocus(node)) {
        UI_RemoveFocus();
    }
}

void uiTextEntryNode::onLeftClick (uiNode_t* node, int x, int y)
{
    if (node->disabled)
        return;

    /* no cvar */
    if (!node->text)
        return;
    if (!Q_strstart(node->text, "*cvar:"))
        return;

    if (!UI_HasFocus(node)) {
        if (node->onClick) {
            UI_ExecuteEventActions(node, node->onClick);
        }
        if (node->lua_onClick != LUA_NOREF) {
            UI_ExecuteLuaEventScript_XY(node, node->lua_onClick, x, y);
        }
        UI_RequestFocus(node);
    }
}

void uiTextEntryNode::onFocusGained (uiNode_t* node)
{
    assert(editedCvar == nullptr);
    /* skip '*cvar ' */
    const char* cvarRef = "*cvar:";
    editedCvar = Cvar_Get(&((const char*)node->text)[strlen(cvarRef)]);
    assert(editedCvar);
    Q_strncpyz(cvarValueBackup, editedCvar->string, sizeof(cvarValueBackup));
    isAborted = false;
    EXTRADATA(node).cursorPosition = UTF8_strlen(editedCvar->string);

#if SDL_VERSION_ATLEAST(2,0,0)
    SDL_StartTextInput();
    vec2_t pos;
    UI_GetNodeAbsPos(node, pos);
    SDL_Rect r = {static_cast<int>(pos[0]), static_cast<int>(pos[1]), static_cast<int>(node->box.size[0]), static_cast<int>(node->box.size[1])};
    SDL_SetTextInputRect(&r);
#else
#ifdef ANDROID
    char buf[MAX_CVAR_EDITING_LENGTH];
    Q_strncpyz(buf, editedCvar->string, sizeof(buf));
    SDL_ANDROID_GetScreenKeyboardTextInput(buf, sizeof(buf));
    Cvar_ForceSet(editedCvar->name, buf);
    UI_TextEntryNodeValidateEdition(node);
    UI_RemoveFocus();
#endif
#endif
}

void uiTextEntryNode::onFocusLost (uiNode_t* node)
{
    /* already aborted/changed with the keyboard */
    if (editedCvar == nullptr)
        return;

    /* release the keyboard */
    if (isAborted || EXTRADATA(node).clickOutAbort) {
        UI_TextEntryNodeAbortEdition(node);
    } else {
        UI_TextEntryNodeValidateEdition(node);
    }
#if SDL_VERSION_ATLEAST(2,0,0)
    SDL_StopTextInput();
#endif
}

static void UI_TextEntryNodeEdit (uiNode_t* node, unsigned int unicode)
{
    char buffer[MAX_CVAR_EDITING_LENGTH];

    /* copy the cvar */
    Q_strncpyz(buffer, editedCvar->string, sizeof(buffer));

    /* compute result */
    if (unicode == K_BACKSPACE) {
        if (EXTRADATA(node).cursorPosition > 0){
            UTF8_delete_char_at(buffer, EXTRADATA(node).cursorPosition - 1);
            EXTRADATA(node).cursorPosition--;
        }
    } else if (unicode == K_DEL) {
        if (EXTRADATA(node).cursorPosition < UTF8_strlen(editedCvar->string)){
            UTF8_delete_char_at(buffer, EXTRADATA(node).cursorPosition);
        }
    } else {
        int length = strlen(buffer);
        int charLength = UTF8_encoded_len(unicode);

        /* is buffer full? */
        if (length + charLength >= sizeof(buffer))
            return;

        int insertedLength = UTF8_insert_char_at(buffer, sizeof(buffer), EXTRADATA(node).cursorPosition, unicode);
        if (insertedLength > 0)
            EXTRADATA(node).cursorPosition++;
    }

    /* update the cvar */
    Cvar_ForceSet(editedCvar->name, buffer);
}

bool uiTextEntryNode::onKeyPressed (uiNode_t* node, unsigned int key, unsigned short unicode)
{
    switch (key) {
    /* remove the last char. */
    case K_BACKSPACE:
        UI_TextEntryNodeEdit(node, K_BACKSPACE);
        return true;
    /* cancel the edition */
    case K_ESCAPE:
        isAborted = true;
        UI_RemoveFocus();
        return true;
    /* validate the edition */
    case K_ENTER:
    case K_KP_ENTER:
        UI_TextEntryNodeValidateEdition(node);
        UI_RemoveFocus();
        return true;
    case K_LEFTARROW:
    case K_KP_LEFTARROW:
        if (EXTRADATA(node).cursorPosition > 0)
            EXTRADATA(node).cursorPosition--;
        return true;
    case K_RIGHTARROW:
    case K_KP_RIGHTARROW:
        if (EXTRADATA(node).cursorPosition < UTF8_strlen(editedCvar->string))
            EXTRADATA(node).cursorPosition++;
        return true;
    case K_HOME:
    case K_KP_HOME:
        EXTRADATA(node).cursorPosition = 0;
        return true;
    case K_END:
    case K_KP_END:
        EXTRADATA(node).cursorPosition = UTF8_strlen(editedCvar->string);
        return true;
    case K_DEL:
    case K_KP_DEL:
        UI_TextEntryNodeEdit(node, K_DEL);
        return true;
    }

    /* non printable */
    if (unicode < 32 || (unicode >= 127 && unicode < 192))
        return false;

    /* add a char. */
    UI_TextEntryNodeEdit(node, unicode);
    return true;
}

void uiTextEntryNode::draw (uiNode_t* node)
{
    const float* textColor;
    vec2_t pos;
    const char* font = UI_GetFontFromNode(node);
    uiSpriteStatus_t iconStatus = SPRITE_STATUS_NORMAL;

    if (node->disabled) {
        textColor = node->disabledColor;
        iconStatus = SPRITE_STATUS_DISABLED;
    } else if (node->state) {
        textColor = node->color;
        iconStatus = SPRITE_STATUS_HOVER;
    } else {
        textColor = node->color;
    }
    if (UI_HasFocus(node)) {
        textColor = node->selectedColor;
    }

    UI_GetNodeAbsPos(node, pos);

    if (EXTRADATA(node).background) {
        UI_DrawSpriteInBox(false, EXTRADATA(node).background, iconStatus, pos[0], pos[1], node->box.size[0], node->box.size[1]);
    }

    if (char const* const text = UI_GetReferenceString(node, node->text)) {
        char  buf[MAX_VAR];
        if (EXTRADATA(node).isPassword) {
            size_t size = UTF8_strlen(text);

            if (size > MAX_VAR - 2)
                size = MAX_VAR - 2;

            memset(buf, HIDECHAR, size);
            buf[size] = '\0';
        } else {
            /* leave one byte empty for the text-based cursor */
            UTF8_strncpyz(buf, text, sizeof(buf) - 1);
        }

        if (UI_HasFocus(node)) {
            if (CL_Milliseconds() % 1000 < 500) {
                UTF8_insert_char_at(buf, sizeof(buf), EXTRADATA(node).cursorPosition, (int)CURSOR_ON);
            } else {
                UTF8_insert_char_at(buf, sizeof(buf), EXTRADATA(node).cursorPosition, (int)CURSOR_OFF);
            }
        }

        if (*buf != '\0') {
            R_Color(textColor);
            UI_DrawStringInBox(font, (align_t)node->contentAlign,
                pos[0] + node->padding, pos[1] + node->padding,
                node->box.size[0] - node->padding - node->padding, node->box.size[1] - node->padding - node->padding,
                buf);
            R_Color(nullptr);
        }
    }
}

void uiTextEntryNode::onLoading (uiNode_t* node)
{
    node->padding = 8;
    node->contentAlign = ALIGN_CL;
    Vector4Set(node->color, 1, 1, 1, 1);
    Vector4Set(node->selectedColor, 1, 1, 1, 1);
    Vector4Set(node->disabledColor, 0.5, 0.5, 0.5, 1.0);
}

void UI_RegisterTextEntryNode (uiBehaviour_t* behaviour)
{
    behaviour->name = "textentry";
    behaviour->manager = UINodePtr(new uiTextEntryNode());
    behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
    behaviour->lua_SWIG_typeinfo = UI_SWIG_TypeQuery("uiTextEntryNode_t *");

    /* Call back event called when we click on the node. If the click select the node,
     * it called before we start the cvar edition.
     */
    UI_RegisterOveridedNodeProperty(behaviour, "onClick");

    /* Call back event (like click...) fired when the text is changed, after
     * validation. An abort of the edition dont fire this event.
     */
    UI_RegisterOveridedNodeProperty(behaviour, "onChange");

    /* Custom the draw behaviour by hiding each character of the text with a star (''*''). */
    UI_RegisterExtradataNodeProperty(behaviour, "isPassword", V_BOOL, textEntryExtraData_t, isPassword);
    /* ustom the mouse event behaviour. When we are editing the text, if we click out of the node, the edition is aborted. Changes on
     * the text are canceled, and no change event are fired.
     */
    UI_RegisterExtradataNodeProperty(behaviour, "clickOutAbort", V_BOOL, textEntryExtraData_t, clickOutAbort);
    /* Cursor position (offset of next UTF-8 char to the right) */
    UI_RegisterExtradataNodeProperty(behaviour, "cursorPosition", V_INT, textEntryExtraData_t, cursorPosition);
    /* Call it when we abort the edition */
    UI_RegisterExtradataNodeProperty(behaviour, "onAbort", V_UI_ACTION, textEntryExtraData_t, onAbort);
    /* Call it to force node edition */
    UI_RegisterNodeMethod(behaviour, "edit", UI_TextEntryNodeFocus);
    /* Sprite used to display the background */
    UI_RegisterExtradataNodeProperty(behaviour, "background", V_UI_SPRITEREF, EXTRADATA_TYPE, background);
    /* Call it to force exit of node edition */
    UI_RegisterNodeMethod(behaviour, "exit", UI_TextEntryNodeUnFocus);
}