ui_data.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_main.h"
#include "ui_internal.h"
#include "ui_nodes.h"
#include "node/ui_node_linechart.h"
#include "node/ui_node_option.h"

static const char *const ui_sharedDataIDNames[] = {
    "", 
    "TEXT_STANDARD",
    "TEXT_LIST",
    "TEXT_LIST2",
    "TEXT_UFOPEDIA",
    "TEXT_UFOPEDIA_REQUIREMENT",
    "TEXT_BUILDINGS",
    "TEXT_BUILDING_INFO",
    "TEXT_RESEARCH",
    "TEXT_POPUP",
    "TEXT_POPUP_INFO",
    "TEXT_AIRCRAFT_LIST",
    "TEXT_AIRCRAFT_INFO",
    "TEXT_CAMPAIGN_LIST",
    "TEXT_MULTISELECTION",
    "TEXT_PRODUCTION_LIST",
    "TEXT_PRODUCTION_AMOUNT",
    "TEXT_PRODUCTION_INFO",
    "TEXT_EMPLOYEE",
    "TEXT_MOUSECURSOR_RIGHT",
    "TEXT_PRODUCTION_QUEUED",
    "TEXT_STATS_BASESUMMARY",
    "TEXT_STATS_MISSION",
    "TEXT_STATS_BASES",
    "TEXT_STATS_NATIONS",
    "TEXT_STATS_EMPLOYEES",
    "TEXT_STATS_COSTS",
    "TEXT_STATS_INSTALLATIONS",
    "TEXT_STATS_7",
    "TEXT_BASE_LIST",
    "TEXT_BASE_INFO",
    "TEXT_TRANSFER_LIST",
    "TEXT_TRANSFER_LIST_AMOUNT",
    "TEXT_TRANSFER_LIST_TRANSFERED",
    "TEXT_MOUSECURSOR_PLAYERNAMES",
    "TEXT_CARGO_LIST",
    "TEXT_CARGO_LIST_AMOUNT",
    "TEXT_UFOPEDIA_MAILHEADER",
    "TEXT_UFOPEDIA_MAIL",
    "TEXT_MARKET_NAMES",
    "TEXT_MARKET_STORAGE",
    "TEXT_MARKET_MARKET",
    "TEXT_MARKET_PRICES",
    "TEXT_CHAT_WINDOW",
    "TEXT_AIREQUIP_1",
    "TEXT_AIREQUIP_2",
    "TEXT_BASEDEFENCE_LIST",
    "TEXT_TIPOFTHEDAY",
    "TEXT_GENERIC",
    "TEXT_XVI",
    "TEXT_MOUSECURSOR_TOP",
    "TEXT_MOUSECURSOR_BOTTOM",
    "TEXT_MOUSECURSOR_LEFT",
    "TEXT_MESSAGEOPTIONS",
    "TEXT_UFORECOVERY_NATIONS",
    "TEXT_UFORECOVERY_UFOYARDS",
    "TEXT_UFORECOVERY_CAPACITIES",
    "TEXT_MATERIAL_STAGES",
    "TEXT_IRCCONTENT",
    "TEXT_IRCUSERS",
    "TEXT_MULTIPLAYER_USERLIST",
    "TEXT_MULTIPLAYER_USERTEAM",
    "TEXT_ITEMDESCRIPTION",

    "OPTION_LANGUAGES",
    "OPTION_JOYSTICKS",
    "OPTION_VIDEO_RESOLUTIONS",
    "OPTION_SINGLEPLAYER_SKINS",
    "OPTION_MULTIPLAYER_SKINS",
    "OPTION_UFOPEDIA",
    "OPTION_UFOS",
    "OPTION_DROPSHIPS",
    "OPTION_BASELIST",
    "OPTION_TEAMDEFS",

    "LINESTRIP_FUNDING",
    "LINESTRIP_COLOR"
};
CASSERT(lengthof(ui_sharedDataIDNames) == UI_MAX_DATAID);

int UI_GetDataIDByName (const char* name)
{
    int num;
    for (num = 0; num < UI_MAX_DATAID; num++)
        if (!strcmp(name, ui_sharedDataIDNames[num]))
            return num;

    return -1;
}

void UI_RegisterText (int dataId, const char *text)
{
    UI_ResetData(dataId);

    if (!text)
        return;

    ui_global.sharedData[dataId].type = UI_SHARED_TEXT;
    ui_global.sharedData[dataId].data.text = text;
    ui_global.sharedData[dataId].versionId++;
}

void UI_RegisterLinkedListText (int dataId, linkedList_t *text)
{
    if (ui_global.sharedData[dataId].type == UI_SHARED_LINKEDLISTTEXT && ui_global.sharedData[dataId].data.linkedListText == text) {
        ui_global.sharedData[dataId].versionId++;
        return;
    }
    UI_ResetData(dataId);
    ui_global.sharedData[dataId].type = UI_SHARED_LINKEDLISTTEXT;
    ui_global.sharedData[dataId].data.linkedListText = text;
    ui_global.sharedData[dataId].versionId++;
}

const char *UI_GetText (int textId)
{
    if (ui_global.sharedData[textId].type != UI_SHARED_TEXT)
        return NULL;
    return ui_global.sharedData[textId].data.text;
}

int UI_GetDataVersion (int textId)
{
    return ui_global.sharedData[textId].versionId;
}

static void UI_InitOption (uiNode_t* option, const char* label, const char* value)
{
    assert(option);
    assert(option->behaviour == ui_optionBehaviour);
    Q_strncpyz(OPTIONEXTRADATA(option).label, label, sizeof(OPTIONEXTRADATA(option).label));
    Q_strncpyz(OPTIONEXTRADATA(option).value, value, sizeof(OPTIONEXTRADATA(option).value));
}

uiNode_t* UI_AddOption (uiNode_t** tree, const char* name, const char* label, const char* value)
{
    uiNode_t *last;
    uiNode_t *option;
    assert(tree != NULL);

    option = UI_AllocNode(name, "option", qtrue);
    UI_InitOption(option, label, value);

    /* append the option */
    last = *tree;
    if (last != NULL) {
        while (last->next)
            last = last->next;
    }

    if (last)
        last->next = option;
    else
        *tree = option;

    return option;
}

static void UI_DeleteOption (uiNode_t* tree)
{
    while (tree) {
        uiNode_t* del = tree;
        tree = tree->next;
        UI_DeleteNode(del);
    }
}

void UI_ResetData (int dataId)
{
    assert(dataId < UI_MAX_DATAID);
    assert(dataId >= 0);

    switch (ui_global.sharedData[dataId].type) {
    case UI_SHARED_LINKEDLISTTEXT:
        LIST_Delete(&ui_global.sharedData[dataId].data.linkedListText);
        break;
    case UI_SHARED_OPTION:
        if (_Mem_AllocatedInPool(com_genericPool, ui_global.sharedData[dataId].data.option)) {
            UI_DeleteOption(ui_global.sharedData[dataId].data.option);
        }
        break;
    default:
        break;
    }

    ui_global.sharedData[dataId].type = UI_SHARED_NONE;
    ui_global.sharedData[dataId].data.text = NULL;
    ui_global.sharedData[dataId].versionId++;
}

static uiNode_t *UI_OptionNodeRemoveHigherOption (uiNode_t **option)
{
    uiNode_t *prev = *option;
    uiNode_t *prevfind = NULL;
    uiNode_t *search = (*option)->next;
    const char *label = OPTIONEXTRADATA(*option).label;

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

    /* search the smaller element */
    while (search) {
        const char *searchlabel = OPTIONEXTRADATA(search).label;

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

        if (strcmp(label, searchlabel) < 0) {
            prevfind = prev;
            label = searchlabel;
        }
        prev = search;
        search = search->next;
    }

    /* remove the first element */
    if (prevfind == NULL) {
        uiNode_t *tmp = *option;
        *option = (*option)->next;
        return tmp;
    } else {
        uiNode_t *tmp = prevfind->next;
        prevfind->next = tmp->next;
        return tmp;
    }
}

void UI_SortOptions (uiNode_t **first)
{
    uiNode_t *option;

    /* unlink the unsorted list */
    option = *first;
    if (option == NULL)
        return;
    *first = NULL;

    /* construct a sorted list */
    while (option) {
        uiNode_t *element;
        element = UI_OptionNodeRemoveHigherOption(&option);
        element->next = *first;
        *first = element;
    }
}

void UI_UpdateInvisOptions (uiNode_t *option, const linkedList_t *stringList)
{
    if (option == NULL || stringList == NULL)
        return;

    while (option) {
        if (LIST_ContainsString(stringList, option->name))
            option->invis = qfalse;
        else
            option->invis = qtrue;
        option = option->next;
    }
}

void UI_RegisterOption (int dataId, uiNode_t *option)
{
    if (ui_global.sharedData[dataId].type == UI_SHARED_OPTION && ui_global.sharedData[dataId].data.option == option) {
        ui_global.sharedData[dataId].versionId++;
        return;
    }
    UI_ResetData(dataId);
    ui_global.sharedData[dataId].type = UI_SHARED_OPTION;
    ui_global.sharedData[dataId].data.option = option;
    ui_global.sharedData[dataId].versionId++;
}

void UI_RegisterLineStrip (int dataId, lineStrip_t *lineStrip)
{
    UI_ResetData(dataId);
    ui_global.sharedData[dataId].type = UI_SHARED_LINESTRIP;
    ui_global.sharedData[dataId].data.lineStrip = lineStrip;
    ui_global.sharedData[dataId].versionId++;
}

uiNode_t *UI_GetOption (int dataId)
{
    if (ui_global.sharedData[dataId].type == UI_SHARED_OPTION) {
        return ui_global.sharedData[dataId].data.option;
    }
    return NULL;
}

static uiNode_t* UI_FindOptionAtIndex (int index, uiNode_t* option, uiOptionIterator_t* iterator)
{
    while (option) {
        assert(option->behaviour == ui_optionBehaviour);
        if (option->invis) {
            option = option->next;
            continue;
        }

        /* we are on the right element */
        if (index == 0) {
            iterator->option = option;
            return option;
        }

        /* not the parent */
        index--;

        if (OPTIONEXTRADATA(option).collapsed) {
            option = option->next;
            continue;
        }

        /* its a child */
        if (index < OPTIONEXTRADATA(option).childCount) {
            if (iterator->depthPos >= MAX_DEPTH_OPTIONITERATORCACHE)
                assert(qfalse);
            iterator->depthCache[iterator->depthPos] = option;
            iterator->depthPos++;
            return UI_FindOptionAtIndex(index, option->firstChild, iterator);
        }
        index -= OPTIONEXTRADATA(option).childCount;
        option = option->next;
    }

    iterator->option = NULL;
    return NULL;
}

uiNode_t* UI_InitOptionIteratorAtIndex (int index, uiNode_t* option, uiOptionIterator_t* iterator)
{
    assert(option == NULL || option->behaviour == ui_optionBehaviour);
    memset(iterator, 0, sizeof(*iterator));
    iterator->skipCollapsed = qtrue;
    iterator->skipInvisible = qtrue;
    return UI_FindOptionAtIndex(index, option, iterator);
}

uiNode_t* UI_OptionIteratorNextOption (uiOptionIterator_t* iterator)
{
    uiNode_t* option;

    option = iterator->option;
    assert(iterator->depthPos < MAX_DEPTH_OPTIONITERATORCACHE);
    iterator->depthCache[iterator->depthPos] = option;
    iterator->depthPos++;

    if (OPTIONEXTRADATA(option).collapsed && iterator->skipCollapsed)
        option = NULL;
    else
        option = option->firstChild;

    while (qtrue) {
        while (option) {
            if (!option->invis || !iterator->skipInvisible) {
                iterator->option = option;
                return option;
            }
            option = option->next;
        }
        if (iterator->depthPos == 0)
            break;
        iterator->depthPos--;
        option = iterator->depthCache[iterator->depthPos]->next;
    }

    iterator->option = NULL;
    return NULL;
}

uiNode_t* UI_FindOptionByValue (uiOptionIterator_t* iterator, const char* value)
{
    while (iterator->option) {
        assert(iterator->option->behaviour == ui_optionBehaviour);
        if (!strcmp(OPTIONEXTRADATA(iterator->option).value, value))
            return iterator->option;
        UI_OptionIteratorNextOption(iterator);
    }
    return NULL;
}

int UI_FindOptionPosition (uiOptionIterator_t* iterator, const uiNode_t* option)
{
    int i = 0;
    while (iterator->option) {
        if (iterator->option == option)
            return i;
        i++;
        UI_OptionIteratorNextOption(iterator);
    }
    return -1;
}

static void UI_ResetData_f (void)
{
    if (Cmd_Argc() == 2) {
        const char *dataId = Cmd_Argv(1);
        const int id = UI_GetDataIDByName(dataId);
        if (id == -1)
            Com_Printf("%s: invalid data ID: %s\n", Cmd_Argv(0), dataId);
        else
            UI_ResetData(id);
    } else {
        int i;
        for (i = 0; i < UI_MAX_DATAID; i++)
            UI_ResetData(i);
    }
}

void UI_InitData (void)
{
    Cmd_AddCommand("mn_datareset", UI_ResetData_f, "Resets memory and data used by a UI data id");
}