Dialog System

[giselher]

Yes the dialog system is finished (and partly tested).

The documentation is still missing and it needs more testing, but I like to have it in staging so that people can look at it and find mistakes or stuff that could be done better. It is also very error prone and it may segfault on broken dlg.xml (my suffix suggestion for dialog files) files. But still have a look it and tell me what you think.

In the next few days I like to build a proper test suite and more dialog files. Also better handling of wrong name nodes in the xml files.

#include "dialog.h"

/* set_speaker, set_player_exp, render_text, render_choices, get_choice and others are all
 * made up functions for demonstration */
int main (void)
{
    int choice = 0;
    req_t *req = NULL;  /* dialog requirement type */
    dlg_content_t *con = NULL;
    dlg_t *dlg = dlg_parse_file("path/to/file.xml"); /* dialog root type pulse file parsing*/

    /* check dialog requirements */
    while ((req = dlg_requirement_next(dlg)) != NULL) {
        if (req->type == EVENT)
            check_requirement_event (req->action.event);
        /* and so on */
     }

    /* dlg_content_next will return NULL if the conversation has ended */

    while ((con = dlg_content_next(dlg, choice)) != NULL) {

        if (con->type == TEXT) {
            set_speaker(con->action.text.actor_id);
            render_text("%s\n", con->action.text.text);
        }
        if (con->type == SET_EXP)
            set_player_exp(con->action.exp);

        if (con->type == CHOICES) {
            /* descriptions is a GPtrArray from glib */
            set_speaker(con->action.choices.actor_id);
            render_choices(con->action.choices.decscriptions); 
            choice = get_choice(); 
        }
    }

    /* and so on, look at dialog.h for more dialog types */
    dlg_free (dlg);
    return 0;
}

I hope this code example does a good job on explaining how it works.
EDIT: You have all rights to hurt me if you saw my earlier usage of the switch statement in my commit history.
EDIT2: I forgot that It also features requirments for dialogs.
EDIT3: More usable example with new function

[giselher]

I also implemented the function dlg_requirement_next to be more consistent and you don't have to directly interact with glib2.

[MattWindsor91]

Yeah, I see no reason why not to merge this. Go!