cl_tutorials.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 "cl_tutorials.h"
#include "ui/ui_main.h"
#include "../shared/parse.h"

typedef struct tutorial_s {
    char name[MAX_VAR];
    char sequence[MAX_VAR];
} tutorial_t;

#define MAX_TUTORIALS 16
static tutorial_t tutorials[MAX_TUTORIALS];
static int numTutorials;

static void TUT_GetTutorials_f (void)
{
    int i;
    linkedList_t *tutorialList = NULL;

    for (i = 0; i < numTutorials; i++) {
        const tutorial_t *t = &tutorials[i];
        LIST_AddString(&tutorialList, va("%s", _(t->name)));
    }
    UI_RegisterLinkedListText(TEXT_LIST, tutorialList);
}

static void TUT_List_f (void)
{
    int i;

    Com_Printf("Tutorials: %i\n", numTutorials);
    for (i = 0; i < numTutorials; i++) {
        Com_Printf("tutorial: %s\n", tutorials[i].name);
        Com_Printf("..sequence: %s\n", tutorials[i].sequence);
    }
}

static void TUT_ListClick_f (void)
{
    int num;

    if (Cmd_Argc() < 2) {
        Com_Printf("Usage: %s <num>\n", Cmd_Argv(0));
        return;
    }

    num = atoi(Cmd_Argv(1));
    if (num < 0 || num >= numTutorials)
        return;

    Cmd_ExecuteString(va("seq_start %s", tutorials[num].sequence));
}

void TUT_InitStartup (void)
{
    /* tutorial stuff */
    Cmd_AddCommand("listtutorials", TUT_List_f, "Show all tutorials");
    Cmd_AddCommand("gettutorials", TUT_GetTutorials_f, NULL);
    Cmd_AddCommand("tutoriallist_click", TUT_ListClick_f, NULL);
}


static const value_t tutValues[] = {
    {"name", V_TRANSLATION_STRING, offsetof(tutorial_t, name), 0},
    {"sequence", V_STRING, offsetof(tutorial_t, sequence), 0},
    {NULL, 0, 0, 0}
};

void TUT_ParseTutorials (const char *name, const char **text)
{
    tutorial_t *t;
    const char *errhead = "TUT_ParseTutorials: unexpected end of file (tutorial ";
    const char *token;
    const value_t *v;

    /* get name list body body */
    token = Com_Parse(text);

    if (!*text || *token != '{') {
        Com_Printf("TUT_ParseTutorials: tutorial \"%s\" without body ignored\n", name);
        return;
    }

    /* parse tutorials */
    if (numTutorials >= MAX_TUTORIALS) {
        Com_Printf("Too many tutorials, '%s' ignored.\n", name);
        numTutorials = MAX_TUTORIALS;
        return;
    }

    t = &tutorials[numTutorials++];
    memset(t, 0, sizeof(*t));
    do {
        /* get the name type */
        token = Com_EParse(text, errhead, name);
        if (!*text)
            break;
        if (*token == '}')
            break;
        for (v = tutValues; v->string; v++)
            if (!strncmp(token, v->string, sizeof(v->string))) {
                /* found a definition */
                token = Com_EParse(text, errhead, name);
                if (!*text)
                    return;

                Com_EParseValue(t, token, v->type, v->ofs, v->size);
                break;
            }
        if (!v->string)
            Com_Printf("TUT_ParseTutorials: unknown token \"%s\" ignored (tutorial %s)\n", token, name);
    } while (*text);
}