cp_messageoptions_callbacks.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 "../../cl_shared.h"
/* UI_InitOptionIteratorAtIndex */
#include "../../ui/ui_main.h"
#include "../../ui/ui_data.h"
#include "cp_campaign.h"
#include "cp_messageoptions.h"
#include "cp_messageoptions_callbacks.h"

static msoMenuState_t msoMenuState = MSO_MSTATE_REINIT;
static int messageList_size = 0;    
static int messageList_scroll = 0;  
static int visibleMSOEntries = 0;   
messageSettings_t backupMessageSettings[NT_NUM_NOTIFYTYPE]; 
static void MSO_InitList (void)
{
    uiNode_t* messageSetting = nullptr;
    uiNode_t* lastCategory = nullptr;
    int idx;

    /* option already allocated, nothing to do */
    if (cgi->UI_GetOption(TEXT_MESSAGEOPTIONS) != nullptr)
        return;

    cgi->UI_ResetData(TEXT_MESSAGEOPTIONS);
    for (idx = 0; idx < ccs.numMsgCategoryEntries; idx++) {
        const msgCategoryEntry_t* entry = &ccs.msgCategoryEntries[idx];
        const char* id = va("%d", idx);

        if (entry->isCategory) {
            lastCategory = cgi->UI_AddOption(&messageSetting, id, va("_%s", entry->notifyType), id);
        } else {
            if (!lastCategory)
                Sys_Error("MSO_InitList: The first entry must be a category");
            cgi->UI_AddOption(&lastCategory->firstChild, id, va("_%s", entry->notifyType), id);
        }
    }
    cgi->UI_RegisterOption(TEXT_MESSAGEOPTIONS, messageSetting);
    MSO_SetMenuState(MSO_MSTATE_PREPARED, false, true);
}

static void MSO_UpdateVisibleButtons (void)
{
    int visible;/* current line */
    uiOptionIterator_t iterator;
    uiNode_t* messageSetting = cgi->UI_GetOption(TEXT_MESSAGEOPTIONS);

    cgi->UI_InitOptionIteratorAtIndex(messageList_scroll, messageSetting, &iterator);

    /* update visible button lines based on current displayed values */
    for (visible = 0; visible < messageList_size; visible++) {
        const uiNode_t* option = iterator.option;
        int idx;
        msgCategoryEntry_t* entry;

        if (!option)
            break;
        idx = atoi(OPTIONEXTRADATACONST(option).value);

        entry = &ccs.msgCategoryEntries[idx];
        if (!entry)
            break;
        if (entry->isCategory) {
            /* category is visible anyway*/
            cgi->UI_ExecuteConfunc("ms_disable %i", visible);

        } else {
            assert(entry->category);
            cgi->UI_ExecuteConfunc("ms_enable %i", visible);
            cgi->UI_ExecuteConfunc("ms_btnstate %i %i %i %i", visible, entry->settings->doPause,
                entry->settings->doNotify, entry->settings->doSound);
        }

        cgi->UI_OptionIteratorNextOption(&iterator);
    }

    for (; visible < messageList_size; visible++)
        cgi->UI_ExecuteConfunc("ms_disable %i", visible);
}

static void MSOCB_Init (void)
{
    if (msoMenuState < MSO_MSTATE_PREPARED) {
        MSO_InitList();
        msoMenuState = MSO_MSTATE_PREPARED;
    }

    if (msoMenuState < MSO_MSTATE_INITIALIZED) {
        MSO_UpdateVisibleButtons();
        msoMenuState = MSO_MSTATE_INITIALIZED;
    }
}

static void MSO_Init_f (void)
{
    if (cgi->Cmd_Argc() == 2) {
        messageList_size = atoi(cgi->Cmd_Argv(1));
    }

    MSOCB_Init();
}

static void MSO_Toggle_f (void)
{
    if (cgi->Cmd_Argc() != 3)
        cgi->Com_Printf("Usage: %s <listId> <pause|notify|sound>\n", cgi->Cmd_Argv(0));
    else {
        uiOptionIterator_t iterator;
        const int listIndex = atoi(cgi->Cmd_Argv(1));
        int idx;
        const msgCategoryEntry_t* selectedEntry;
        int optionType;
        bool activate;
        int type;
        uiNode_t* messageSetting = cgi->UI_GetOption(TEXT_MESSAGEOPTIONS);

        cgi->UI_InitOptionIteratorAtIndex(messageList_scroll + listIndex, messageSetting, &iterator);
        if (!iterator.option)
            return;

        idx = atoi(OPTIONEXTRADATA(iterator.option).value);
        selectedEntry = &ccs.msgCategoryEntries[idx];
        if (!selectedEntry)
            return;
        if (selectedEntry->isCategory) {
            cgi->Com_Printf("Toggle command with selected category entry ignored.\n");
            return;
        }
        for (type = 0; type < NT_NUM_NOTIFYTYPE; type++) {
            if (Q_streq(nt_strings[type], selectedEntry->notifyType))
                break;
        }
        if (type == NT_NUM_NOTIFYTYPE) {
            cgi->Com_Printf("Unrecognized messagetype during toggle '%s' ignored\n", selectedEntry->notifyType);
            return;
        }

        if (Q_streq(cgi->Cmd_Argv(2), "pause")) {
            optionType = MSO_PAUSE;
            activate = !selectedEntry->settings->doPause;
        } else if (Q_streq(cgi->Cmd_Argv(2), "notify")) {
            optionType = MSO_NOTIFY;
            activate = !selectedEntry->settings->doNotify;
        } else {
            optionType = MSO_SOUND;
            activate = !selectedEntry->settings->doSound;
        }
        MSO_Set(listIndex, (notify_t)type, optionType, activate, true);
    }
}

static void MSO_Scroll_f (void)
{
    if (cgi->Cmd_Argc() < 2)
        return;

    /* no scrolling if visible entry count is less than max on page (due to folding) */
    messageList_scroll = atoi(cgi->Cmd_Argv(1));

    MSO_UpdateVisibleButtons();
}

static void MSO_BackupSettings_f (void)
{
    memcpy(backupMessageSettings, messageSettings, sizeof(backupMessageSettings));
}

static void MSO_RestoreSettings_f (void)
{
    memcpy(messageSettings, backupMessageSettings, sizeof(messageSettings));
    MSO_SetMenuState(MSO_MSTATE_REINIT, false, true);
}

void MSO_SetMenuState (const msoMenuState_t newState, const bool callInit, const bool preserveIndex)
{
    msoMenuState = newState;
    if (newState == MSO_MSTATE_REINIT && !preserveIndex) {
        visibleMSOEntries = 0;
        messageList_scroll = 0;
    }
    if (callInit)
        MSOCB_Init();
}

static const cmdList_t msgOptionsCallbacks[] = {
    {"msgoptions_toggle", MSO_Toggle_f, "Toggles pause, notification or sound setting for a message category"},
    {"msgoptions_scroll", MSO_Scroll_f, "Scroll callback function for message options menu text"},
    {"msgoptions_init", MSO_Init_f, "Initializes message options menu"},
    {"msgoptions_backup", MSO_BackupSettings_f, "Backup message settings"},
    {"msgoptions_restore",MSO_RestoreSettings_f, "Restore message settings from backup"},
    {nullptr, nullptr, nullptr}
};
void MSO_InitCallbacks (void)
{
    OBJSET(backupMessageSettings, 1);

    cgi->Cmd_TableAddList(msgOptionsCallbacks);
}

void MSO_ShutdownCallbacks (void)
{
    cgi->Cmd_TableRemoveList(msgOptionsCallbacks);

    cgi->UI_ResetData(TEXT_MESSAGEOPTIONS);
}