ui_node_text2.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_internal.h"
#include "../ui_font.h"
#include "../ui_actions.h"
#include "../ui_parse.h"
#include "../ui_render.h"
#include "ui_node_text2.h"
#include "ui_node_abstractnode.h"

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

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

static void UI_TextUpdateCache(uiNode_t *node);

static void UI_TextNodeGenerateLineSplit (uiNode_t *node)
{
    const char *data;
    int bufferSize = 1024;
    char *buffer = (char *)Mem_Alloc(bufferSize);

    LIST_Delete(&EXTRADATA(node).lineSplit);

    if (node->text != NULL)
        data = UI_GetReferenceString(node, node->text);
    else if (EXTRADATA(node).super.dataID != TEXT_NULL) {
        const uiSharedData_t *shared;
        shared = &ui_global.sharedData[EXTRADATA(node).super.dataID];
        switch (shared->type) {
        case UI_SHARED_TEXT:
            data = UI_GetText(EXTRADATA(node).super.dataID);
            break;
        case UI_SHARED_LINKEDLISTTEXT:
            return;
        default:
            return;
        }
    } else
        return;

    if (data[0] == '_')
        data = _(data + 1);

    while (data[0] != '\0') {
        const char *next = strchr(data, '\n');
        int lineSize;
        if (next == NULL)
            lineSize = strlen(data);
        else
            lineSize = next - data;

        if (lineSize + 1 > bufferSize) {
            bufferSize = lineSize + 1;
            Mem_Free(buffer);
            buffer = (char *)Mem_Alloc(bufferSize);
        }

        Q_strncpyz(buffer, data, lineSize + 1);
        LIST_AddString(&EXTRADATA(node).lineSplit, buffer);

        if (next == NULL)
            break;
        data = next + 1;
    }

    Mem_Free(buffer);
}

static void UI_TextValidateCache (uiNode_t *node)
{
    int v;
    if (EXTRADATA(node).super.dataID == TEXT_NULL || node->text != NULL)
        return;

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

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

    lineHeight = EXTRADATACONST(node).super.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.super.scrollY.viewPos;

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

    return line;
}

static void UI_TextNodeMouseMove (uiNode_t *node, int x, int y)
{
    EXTRADATA(node).super.lineUnderMouse = UI_TextNodeGetLine(node, x, y);
}

static void UI_TextNodeDrawText (uiNode_t* node, const linkedList_t* list, qboolean noDraw)
{
    char newFont[MAX_VAR];
    const char* oldFont = NULL;
    vec4_t colorHover;
    vec4_t colorSelectedHover;
    int fullSizeY;
    int x1; /* variable x position */
    const char *font = UI_GetFontFromNode(node);
    vec2_t pos;
    int x, y, width;
    int viewSizeY;

    UI_GetNodeAbsPos(node, pos);

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

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

    /* 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->textalign % 3) {
    case 0: /* left */
        break;
    case 1: /* middle */
        x += width / 2;
        break;
    case 2: /* right */
        x += width;
        break;
    }

    R_Color(node->color);

    fullSizeY = 0;
    while (list) {
        const char *cur = (const char*)list->data;

        /* new line starts from node x position */
        x1 = x;
        if (oldFont) {
            font = oldFont;
            oldFont = NULL;
        }

        /* 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;
            }
        }

        /* is it a white line? */
        if (!cur) {
            fullSizeY++;
        } else {
            if (noDraw) {
                int lines = 0;
                R_FontTextSize (font, cur, width, EXTRADATA(node).super.longlines, NULL, NULL, &lines, NULL);
                fullSizeY += lines;
            } else
                UI_DrawString(font, node->textalign, x1, y, x, width, EXTRADATA(node).super.lineHeight, cur, viewSizeY, EXTRADATA(node).super.super.scrollY.viewPos, &fullSizeY, qtrue, EXTRADATA(node).super.longlines);
        }

        list = list->next;
    }

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

    R_Color(NULL);
}

static void UI_TextUpdateCache (uiNode_t *node)
{
    const uiSharedData_t *shared;

    UI_TextNodeGenerateLineSplit(node);

    if (EXTRADATA(node).super.dataID == TEXT_NULL && node->text != NULL) {
        UI_TextNodeDrawText(node, EXTRADATA(node).lineSplit, qtrue);
        return;
    }

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

    if (shared->type == UI_SHARED_LINKEDLISTTEXT) {
        UI_TextNodeDrawText(node, shared->data.linkedListText, qtrue);
    } else {
        UI_TextNodeDrawText(node, EXTRADATA(node).lineSplit, qtrue);
    }

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

static void UI_TextNodeDraw (uiNode_t *node)
{
    const uiSharedData_t *shared;

    UI_TextValidateCache(node);

    if (EXTRADATA(node).super.dataID == TEXT_NULL && node->text != NULL) {
        UI_TextNodeDrawText(node, EXTRADATA(node).lineSplit, qfalse);
        return;
    }

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

    switch (shared->type) {
    case UI_SHARED_TEXT:
        UI_TextNodeDrawText(node, EXTRADATA(node).lineSplit, qfalse);
        break;
    case UI_SHARED_LINKEDLISTTEXT:
        UI_TextNodeDrawText(node, shared->data.linkedListText, qfalse);
        break;
    default:
        break;
    }

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

static void UI_TextNodeClick (uiNode_t * node, int x, int y)
{
    int line = UI_TextNodeGetLine(node, x, y);

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

    UI_TextNodeSelectLine(node, line);

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

static void UI_TextNodeRightClick (uiNode_t * node, int x, int y)
{
    int line = UI_TextNodeGetLine(node, x, y);

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

    UI_TextNodeSelectLine(node, line);

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

static void UI_TextNodeMouseWheel (uiNode_t *node, qboolean down, int x, int y)
{
    UI_AbstractScrollableNodeScrollY(node, (down ? 1 : -1));
    if (node->onWheelUp && !down)
        UI_ExecuteEventActions(node, node->onWheelUp);
    if (node->onWheelDown && down)
        UI_ExecuteEventActions(node, node->onWheelDown);
    if (node->onWheel)
        UI_ExecuteEventActions(node, node->onWheel);
}

static void UI_TextNodeLoading (uiNode_t *node)
{
    EXTRADATA(node).super.textLineSelected = -1; 
    Vector4Set(node->selectedColor, 1.0, 1.0, 1.0, 1.0);
    Vector4Set(node->color, 1.0, 1.0, 1.0, 1.0);
}

static void UI_TextNodeLoaded (uiNode_t *node)
{
    int lineheight = EXTRADATA(node).super.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.super.scrollY.viewSize == 0) {
        if (node->size[1] != 0 && lineheight != 0) {
            EXTRADATA(node).super.super.scrollY.viewSize = node->size[1] / lineheight;
        } else {
            EXTRADATA(node).super.super.scrollY.viewSize = 1;
            Com_Printf("UI_TextNodeLoaded: node '%s' has no rows value\n", UI_GetPath(node));
        }
    }

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

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

#ifdef DEBUG
    if (EXTRADATA(node).super.super.scrollY.viewSize != (int)(node->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.super.scrollY.viewSize, UI_GetPath(node), node->size[1], lineheight);
    }
#endif

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

static const value_t properties[] = {
    {NULL, V_NULL, 0, 0}
};

void UI_RegisterText2Node (uiBehaviour_t *behaviour)
{
    behaviour->name = "text2";
    behaviour->extends = "text";
    behaviour->draw = UI_TextNodeDraw;
    behaviour->leftClick = UI_TextNodeClick;
    behaviour->rightClick = UI_TextNodeRightClick;
    behaviour->mouseWheel = UI_TextNodeMouseWheel;
    behaviour->mouseMove = UI_TextNodeMouseMove;
    behaviour->loading = UI_TextNodeLoading;
    behaviour->loaded = UI_TextNodeLoaded;
    behaviour->properties = properties;
    behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
}