ui_node_text.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_internal.h"
#include "../ui_font.h"
#include "../ui_actions.h"
#include "../ui_parse.h"
#include "../ui_behaviour.h"
#include "../ui_render.h"
#include "../ui_lua.h"

#include "ui_node_text.h"
#include "ui_node_abstractnode.h"

#include "../../client.h"
#include "../../cl_language.h"
#include "../../../shared/parse.h"

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

#define EXTRADATA_TYPE textExtraData_t
#define EXTRADATA(node) UI_EXTRADATA(node, EXTRADATA_TYPE)
#define EXTRADATACONST(node) UI_EXTRADATACONST(node, EXTRADATA_TYPE)

/* Used for drag&drop-like scrolling */
static int mouseScrollX;
static int mouseScrollY;

void uiTextNode::validateCache (uiNode_t* node)
{
    int v;
    if (EXTRADATA(node).dataID == TEXT_NULL || node->text != nullptr)
        return;

    v = UI_GetDataVersion(EXTRADATA(node).dataID);
    if (v != EXTRADATA(node).versionId) {
        updateCache(node);
    }
}

const char* UI_TextNodeGetSelectedText (uiNode_t* node, int num)
{
    const char* text = UI_GetTextFromList(EXTRADATA(node).dataID, num);
    if (text == nullptr)
        return "";
    return text;
}

void UI_TextNodeSelectLine (uiNode_t* node, int num)
{
    if (EXTRADATA(node).textLineSelected == num)
        return;
    EXTRADATA(node).textLineSelected = num;
    EXTRADATA(node).textSelected = UI_TextNodeGetSelectedText(node, num);
    if (node->onChange) {
        UI_ExecuteEventActions(node, node->onChange);
    }
    if (node->lua_onChange != LUA_NOREF) {
        UI_ExecuteLuaEventScript(node, node->lua_onChange);
    }
}

void UI_TextScrollEnd (const char* nodePath)
{
    uiNode_t* node = UI_GetNodeByPath(nodePath);
    if (!node) {
        Com_DPrintf(DEBUG_CLIENT, "UI_TextScrollEnd: Node '%s' could not be found\n", nodePath);
        return;
    }

    if (!UI_NodeInstanceOf(node, "text")) {
        Com_Printf("UI_TextScrollEnd: '%s' node is no instance of 'text'.\n", Cmd_Argv(1));
        return;
    }

    uiTextNode* b = dynamic_cast<uiTextNode*>(node->behaviour->manager.get());
    b->validateCache(node);

    if (EXTRADATA(node).super.scrollY.fullSize > EXTRADATA(node).super.scrollY.viewSize) {
        EXTRADATA(node).super.scrollY.viewPos = EXTRADATA(node).super.scrollY.fullSize - EXTRADATA(node).super.scrollY.viewSize;
        if (EXTRADATA(node).super.onViewChange) {
            UI_ExecuteEventActions(node, EXTRADATA(node).super.onViewChange);
        }
        else if (EXTRADATA(node).super.lua_onViewChange != LUA_NOREF) {
            UI_ExecuteLuaEventScript (node, EXTRADATA(node).super.lua_onViewChange);
        }
    }
}

static int UI_TextNodeGetLine (const uiNode_t* node, int x, int y)
{
    int lineHeight;
    int line;
    assert(UI_NodeInstanceOf(node, "text"));

    lineHeight = EXTRADATACONST(node).lineHeight;
    if (lineHeight == 0) {
        const char* font = UI_GetFontFromNode(node);
        lineHeight = UI_FontGetHeight(font);
    }

    UI_NodeAbsoluteToRelativePos(node, &x, &y);
    y -= node->padding;

    /* skip position over the first line */
    if (y < 0)
         return -1;
    line = (int) (y / lineHeight) + EXTRADATACONST(node).super.scrollY.viewPos;

    /* skip position under the last line */
    if (line >= EXTRADATACONST(node).super.scrollY.fullSize)
        return -1;

    return line;
}

void uiTextNode::onMouseMove (uiNode_t* node, int x, int y)
{
    EXTRADATA(node).lineUnderMouse = UI_TextNodeGetLine(node, x, y);
}

void uiTextNode::doLayout (uiNode_t* node) {
    uiLocatedNode::doLayout(node);

    int lineheight = EXTRADATA(node).lineHeight;
    /* auto compute lineheight */
    /* we don't overwrite EXTRADATA(node).lineHeight, because "0" is dynamically replaced by font height on draw function */
    if (lineheight == 0) {
        /* the font is used */
        const char* font = UI_GetFontFromNode(node);
        lineheight = UI_FontGetHeight(font);
    }

    /* auto compute rows (super.viewSizeY) */
    if (EXTRADATA(node).super.scrollY.viewSize == 0) {
        if (node->box.size[1] != 0 && lineheight != 0) {
            EXTRADATA(node).super.scrollY.viewSize = node->box.size[1] / lineheight;
        } else {
            EXTRADATA(node).super.scrollY.viewSize = 1;
            Com_Printf("UI_TextNodeLoaded: node '%s' has no rows value\n", UI_GetPath(node));
        }
    }

    /* auto compute height */
    if (node->box.size[1] == 0) {
        node->box.size[1] = EXTRADATA(node).super.scrollY.viewSize * lineheight;
    }

    /* is text slot exists */
    if (EXTRADATA(node).dataID >= UI_MAX_DATAID)
        Com_Error(ERR_DROP, "Error in node %s - max shared data id num exceeded (num: %i, max: %i)", UI_GetPath(node), EXTRADATA(node).dataID, UI_MAX_DATAID);

#ifdef DEBUG
    if (EXTRADATA(node).super.scrollY.viewSize != (int)(node->box.size[1] / lineheight)) {
        Com_Printf("UI_TextNodeLoaded: rows value (%i) of node '%s' differs from size (%.0f) and format (%i) values\n",
            EXTRADATA(node).super.scrollY.viewSize, UI_GetPath(node), node->box.size[1], lineheight);
    }
#endif

    if (node->text == nullptr && EXTRADATA(node).dataID == TEXT_NULL)
        Com_Printf("UI_TextNodeLoaded: 'textid' property of node '%s' is not set\n", UI_GetPath(node));
}

#define UI_TEXTNODE_BUFFERSIZE      32768

void uiTextNode::drawText (uiNode_t* node, const char* text, const linkedList_t* list, bool noDraw)
{
    static char textCopy[UI_TEXTNODE_BUFFERSIZE];
    char newFont[MAX_VAR];
    const char* oldFont = nullptr;
    vec4_t colorHover;
    vec4_t colorSelectedHover;
    char* cur, *tab, *end;
    int fullSizeY;
    const char* font = UI_GetFontFromNode(node);
    vec2_t pos;
    int x, y, width;
    int viewSizeY;

    UI_GetNodeAbsPos(node, pos);

    if (isSizeChange(node)) {
        int lineHeight = EXTRADATA(node).lineHeight;
        if (lineHeight == 0) {
            const char* font = UI_GetFontFromNode(node);
            lineHeight = UI_FontGetHeight(font);
        }
        viewSizeY = node->box.size[1] / lineHeight;
    } else {
        viewSizeY = EXTRADATA(node).super.scrollY.viewSize;
    }

    /* text box */
    x = pos[0] + node->padding;
    y = pos[1] + node->padding;
    width = node->box.size[0] - node->padding - node->padding;

    if (text) {
        Q_strncpyz(textCopy, text, sizeof(textCopy));
    } else if (list) {
        Q_strncpyz(textCopy, CL_Translate((const char*)list->data), sizeof(textCopy));
    } else
        return; 
    cur = textCopy;

    /* Hover darkening effect for normal text lines. */
    VectorScale(node->color, 0.8, colorHover);
    colorHover[3] = node->color[3];

    /* Hover darkening effect for selected text lines. */
    VectorScale(node->selectedColor, 0.8, colorSelectedHover);
    colorSelectedHover[3] = node->selectedColor[3];

    /* fix position of the start of the draw according to the align */
    switch (node->contentAlign % 3) {
    case 0: /* left */
        break;
    case 1: /* middle */
        x += width / 2;
        break;
    case 2: /* right */
        x += width;
        break;
    }

    R_Color(node->color);

    fullSizeY = 0;
    do {
        bool haveTab;
        int x1; /* variable x position */
        /* new line starts from node x position */
        x1 = x;
        if (oldFont) {
            font = oldFont;
            oldFont = nullptr;
        }

        /* text styles and inline images */
        if (cur[0] == '^') {
            switch (toupper(cur[1])) {
            case 'B':
                Com_sprintf(newFont, sizeof(newFont), "%s_bold", font);
                oldFont = font;
                font = newFont;
                cur += 2; /* don't print the format string */
                break;
            }
        }

        /* get the position of the next newline - otherwise end will be null */
        end = strchr(cur, '\n');
        if (end)
            /* set the \n to \0 to draw only this part (before the \n) with our font renderer */
            /* let end point to the next char after the \n (or \0 now) */
            *end++ = '\0';

        /* highlighting */
        if (fullSizeY == EXTRADATA(node).textLineSelected && EXTRADATA(node).textLineSelected >= 0) {
            /* Draw current line in "selected" color (if the linenumber is stored). */
            R_Color(node->selectedColor);
        } else {
            R_Color(node->color);
        }

        if (node->state && EXTRADATA(node).mousefx && fullSizeY == EXTRADATA(node).lineUnderMouse) {
            /* Highlight line if mousefx is true. */
            if (fullSizeY == EXTRADATA(node).textLineSelected && EXTRADATA(node).textLineSelected >= 0) {
                R_Color(colorSelectedHover);
            } else {
                R_Color(colorHover);
            }
        }

        /* tabulation, we assume all the tabs fit on a single line */
        haveTab = strchr(cur, '\t') != nullptr;
        if (haveTab) {
            while (cur && *cur) {
                int tabwidth;

                tab = strchr(cur, '\t');

                /* use tab stop as given via property definition
                 * or use 1/3 of the node size (width) */
                if (!EXTRADATA(node).tabWidth)
                    tabwidth = width / 3;
                else
                    tabwidth = EXTRADATA(node).tabWidth;

                if (tab) {
                    int numtabs = strspn(tab, "\t");
                    tabwidth *= numtabs;
                    while (*tab == '\t')
                        *tab++ = '\0';
                } else {
                    /* maximize width for the last element */
                    tabwidth = width - (x1 - x);
                    if (tabwidth < 0)
                        tabwidth = 0;
                }

                /* minimize width for element outside node */
                if ((x1 - x) + tabwidth > width)
                    tabwidth = width - (x1 - x);

                /* make sure it is positive */
                if (tabwidth < 0)
                    tabwidth = 0;

                if (tabwidth != 0)
                    UI_DrawString(font, (align_t)node->contentAlign, x1, y, x1, tabwidth - 1, EXTRADATA(node).lineHeight, cur, viewSizeY, EXTRADATA(node).super.scrollY.viewPos, &fullSizeY, false, LONGLINES_PRETTYCHOP);

                /* next */
                x1 += tabwidth;
                cur = tab;
            }
            fullSizeY++;
        }

        /*Com_Printf("until newline - lines: %i\n", lines);*/
        /* the conditional expression at the end is a hack to draw "/n/n" as a blank line */
        /* prevent line from being drawn if there is nothing that should be drawn after it */
        if (cur && (cur[0] || end || list)) {
            /* is it a white line? */
            if (!cur) {
                fullSizeY++;
            } else {
                if (noDraw) {
                    int lines = 0;
                    R_FontTextSize(font, cur, width, (longlines_t)EXTRADATA(node).longlines, nullptr, nullptr, &lines, nullptr);
                    fullSizeY += lines;
                } else
                    UI_DrawString(font, (align_t)node->contentAlign, x1, y, x, width, EXTRADATA(node).lineHeight, cur, viewSizeY, EXTRADATA(node).super.scrollY.viewPos, &fullSizeY, true, (longlines_t)EXTRADATA(node).longlines);
            }
        }

        if (EXTRADATA(node).mousefx)
            R_Color(node->color); /* restore original color */

        /* now set cur to the next char after the \n (see above) */
        cur = end;
        if (!cur && list) {
            list = list->next;
            if (list) {
                Q_strncpyz(textCopy, CL_Translate((const char*)list->data), sizeof(textCopy));
                cur = textCopy;
            }
        }
    } while (cur);

    /* update scroll status */
    setScrollY(node, -1, viewSizeY, fullSizeY);

    R_Color(nullptr);
}

void uiTextNode::updateCache (uiNode_t* node)
{
    const uiSharedData_t* shared;

    if (EXTRADATA(node).dataID == TEXT_NULL && node->text != nullptr)
        return;

    shared = &ui_global.sharedData[EXTRADATA(node).dataID];

    switch (shared->type) {
    case UI_SHARED_TEXT:
        {
            const char* t = CL_Translate(shared->data.text);
            drawText(node, t, nullptr, true);
        }
        break;
    case UI_SHARED_LINKEDLISTTEXT:
        drawText(node, nullptr, shared->data.linkedListText, true);
        break;
    default:
        break;
    }

    EXTRADATA(node).versionId = shared->versionId;
}

void uiTextNode::draw (uiNode_t* node)
{
    const uiSharedData_t* shared;

    if (EXTRADATA(node).dataID == TEXT_NULL && node->text != nullptr) {
        const char* t = CL_Translate(UI_GetReferenceString(node, node->text));
        drawText(node, t, nullptr, false);
        return;
    }

    shared = &ui_global.sharedData[EXTRADATA(node).dataID];

    switch (shared->type) {
    case UI_SHARED_TEXT:
    {
        const char* t = CL_Translate(shared->data.text);
        drawText(node, t, nullptr, false);
        break;
    }
    case UI_SHARED_LINKEDLISTTEXT:
        drawText(node, nullptr, shared->data.linkedListText, false);
        break;
    default:
        break;
    }

    EXTRADATA(node).versionId = shared->versionId;
}

void uiTextNode::onLeftClick (uiNode_t* node, int x, int y)
{
    int line = UI_TextNodeGetLine(node, x, y);

    if (line < 0 || line >= EXTRADATA(node).super.scrollY.fullSize)
        return;

    UI_TextNodeSelectLine(node, line);

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

void uiTextNode::onRightClick (uiNode_t* node, int x, int y)
{
    int line = UI_TextNodeGetLine(node, x, y);

    if (line < 0 || line >= EXTRADATA(node).super.scrollY.fullSize)
        return;

    UI_TextNodeSelectLine(node, line);

    if (node->onRightClick)
        UI_ExecuteEventActions(node, node->onRightClick);
}

bool uiTextNode::onScroll (uiNode_t* node, int deltaX, int deltaY)
{
    bool updated;
    bool down = deltaY > 0;
    if (deltaY == 0)
        return false;
    updated = scrollY(node, (down ? 1 : -1));

    /* @todo use super behaviour */
    if (node->onWheelUp && !down) {
        UI_ExecuteEventActions(node, node->onWheelUp);
        updated = true;
    }
    if (node->onWheelDown && down) {
        UI_ExecuteEventActions(node, node->onWheelDown);
        updated = true;
    }
    if (node->onWheel) {
        UI_ExecuteEventActions(node, node->onWheel);
        updated = true;
    }
    return updated;
}

void uiTextNode::onLoading (uiNode_t* node)
{
    EXTRADATA(node).textLineSelected = -1; 
    EXTRADATA(node).textSelected = "";
    Vector4Set(node->selectedColor, 1.0, 1.0, 1.0, 1.0);
    Vector4Set(node->color, 1.0, 1.0, 1.0, 1.0);
}

void uiTextNode::onLoaded (uiNode_t* node)
{
    /* code moved to doLayout since it was used to precompute layout */
}

void uiTextNode::onMouseDown (uiNode_t* node, int x, int y, int button)
{
    if (button == K_MOUSE1 && !UI_GetMouseCapture() &&
        EXTRADATA(node).super.scrollY.fullSize > EXTRADATA(node).super.scrollY.viewSize) {
        UI_SetMouseCapture(node);
        mouseScrollX = x;
        mouseScrollY = y;
    }
}

void uiTextNode::onMouseUp (uiNode_t* node, int x, int y, int button)
{
    if (UI_GetMouseCapture() == node)  /* More checks can never hurt */
        UI_MouseRelease();
}

void uiTextNode::onCapturedMouseMove (uiNode_t* node, int x, int y)
{
    const int lineHeight = getCellHeight(node);
    const int deltaY = (mouseScrollY - y) / lineHeight;
    /* We're doing only vertical scroll, that's enough for the most instances */
    if (abs(mouseScrollY - y) >= lineHeight) {
        scrollY(node, deltaY);
        /* @todo not accurate */
        mouseScrollX = x;
        mouseScrollY = y;
    }
    onMouseMove(node, x, y);
}

int uiTextNode::getCellHeight (uiNode_t* node)
{
    int lineHeight = EXTRADATA(node).lineHeight;
    if (lineHeight == 0)
        lineHeight = UI_FontGetHeight(UI_GetFontFromNode(node));
    return lineHeight;
}

void UI_RegisterTextNode (uiBehaviour_t* behaviour)
{
    behaviour->name = "text";
    behaviour->extends = "abstractscrollable";
    behaviour->manager = UINodePtr(new uiTextNode());
    behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
    behaviour->lua_SWIG_typeinfo = UI_SWIG_TypeQuery("uiTextNode_t *");

    /* Current selected line  */
    UI_RegisterExtradataNodeProperty(behaviour, "lineselected", V_INT, textExtraData_t, textLineSelected);

    /* Text of the current selected line */
    UI_RegisterExtradataNodeProperty(behaviour, "textselected", V_CVAR_OR_STRING, textExtraData_t, textSelected);

    /* One of the list TEXT_* @sa ui_data.h for an up-to-date list.
     * Display a shared content registered by the client code.
     */
    UI_RegisterExtradataNodeProperty(behaviour, "dataid", V_UI_DATAID, textExtraData_t, dataID);
    /* Size between two lines. Default value is 0, in this case it use a line height according to the font size. */
    UI_RegisterExtradataNodeProperty(behaviour, "lineheight", V_INT, textExtraData_t, lineHeight);
    /* Bigger size of the width replacing a tab character. */
    UI_RegisterExtradataNodeProperty(behaviour, "tabwidth", V_INT, textExtraData_t, tabWidth);
    /* What to do with text lines longer than node width. Default is to wordwrap them to make multiple lines.
     * It can be LONGLINES_WRAP, LONGLINES_CHOP, LONGLINES_PRETTYCHOP
     */
    UI_RegisterExtradataNodeProperty(behaviour, "longlines", V_INT, textExtraData_t, longlines);

    /* Number of visible line we can display into the node height.
     * Currently, it translate the scrollable property <code>viewSize</code>
     * @todo For a smooth scroll we should split that
     */
    UI_RegisterExtradataNodeProperty(behaviour, "rows", V_INT, textExtraData_t, super.scrollY.viewSize);
    /* Number of lines contained into the node.
     * Currently, it translate the scrollable property <code>fullSize</code>
     * @todo For a smooth scroll we should split that
     */
    UI_RegisterExtradataNodeProperty(behaviour, "lines", V_INT, textExtraData_t, super.scrollY.fullSize);

    UI_RegisterExtradataNodeProperty(behaviour, "mousefx", V_BOOL, textExtraData_t, mousefx);

    Com_RegisterConstInt("LONGLINES_WRAP", LONGLINES_WRAP);
    Com_RegisterConstInt("LONGLINES_CHOP", LONGLINES_CHOP);
    Com_RegisterConstInt("LONGLINES_PRETTYCHOP", LONGLINES_PRETTYCHOP);
}