parser.c

Go to the documentation of this file.

#include "parser.h"

#include "cfg/cfg_parser.h"

#include <kern/kfile.h>
#include <struct/hashtable.h>

#include <stdlib.h> // atol(), NULL
#include <string.h> // strchr(), strcmp()

//TODO:
#define CONFIG_INTERNAL_COMMANDS  0

#define ARG_SEP_S " "
#define ARG_SEP_C ' '

#define MAX_COMMANDS_NUMBER  128  // 64

static const void* get_key_from_command(const void* cmd, uint8_t* length);

DECLARE_HASHTABLE_STATIC(commands, MAX_COMMANDS_NUMBER, get_key_from_command);


static bool get_word(const char **begin, const char **end)
{
    const char *cur = *end;

    while ((*cur == ' ' || *cur == '\t') && *cur)
        ++cur;

    *begin = cur;

    while ((*cur != ' ' && *cur != '\t') && *cur)
        ++cur;

    *end = cur;

    return (*end != *begin);
}


static bool parseArgs(const char *fmt, const char *input, parms argv[])
{
    const char *begin = input, *end = input;

    while (*fmt)
    {
        // Extract the argument
        if (!get_word(&begin, &end))
            return false;

        switch (*fmt)
        {
            case 'd':
                (*argv++).l = atol(begin);
                break;

            case 's':
                (*argv++).s = begin;
                break;

            default:
                ASSERT2(0, "Unknown format for argument");
                return false;
        }

        ++fmt;
    }

    /* check if there are remaining args */
    if (get_word(&begin, &end))
        return false;

    return true;
}


#ifdef UNUSED_CODE

static int printResult(KFile *ch, const char *fmt, parms result[])
{
    long n;
    char repeat_cnt = 0;

    while (*fmt)
    {
        if (*fmt >= '0' && *fmt <= '9')
        {
            /* Collect repeat count digit (left to right order) */
            repeat_cnt = (repeat_cnt * 10) + (*fmt - '0');
        }
        else
        {
            /* Set default repeat cnt of 1 when not specified */
            if (repeat_cnt == 0)
                repeat_cnt = 1;

            /* Loop repeat_cnt times */
            do
            {
                switch (*fmt)
                {
                    case 'd':
                        kfile_printf(ch, ARG_SEP_S "%ld", (*result).l);
                        result++;
                        break;
                    case 'c':
                        kfile_print(ch, ARG_SEP_S);
                        kfile_print(ch, (*result).s);
                        result++;
                        break;
                    case 's':
                        kfile_printf(ch, ARG_SEP_S "%s", (*result).s);
                        result++;
                        break;
                    case 'n':
                        n = (*result++).l;
                        kfile_printf(ch, ARG_SEP_S "%ld", n);
                        while (n--) {
                            kfile_printf(ch, ARG_SEP_S "%ld", (*result).l);
                            result++;
                        }
                        break;
                    default:
                        break;
                }
            }
            while (--repeat_cnt);
        }

        /* Skip to next format char */
        ++fmt;

    } /* while (*fmt) */


    kfile_print(ch, "\r\n");
    return 0;
}
#endif /* UNUSED_CODE */

const char* parser_rl_match(UNUSED_ARG(void *,dummy), const char *word, int word_len)
{
    HashIterator cur;
    HashIterator end = ht_iter_end(&commands);
    const char *found = NULL;

    for (cur = ht_iter_begin(&commands);
         !ht_iter_cmp(cur, end);
         cur = ht_iter_next(cur))
    {
        const struct CmdTemplate* cmdp = (const struct CmdTemplate*)ht_iter_get(cur);
        if (strncmp(cmdp->name, word, word_len) == 0)
        {
            // If there was another matching word, it means that we have a multiple
            //  match: then return NULL.
            if (found)
                return NULL;

            found = cmdp->name;
        }
    }

    return found;
}

bool parser_get_cmd_id(const char* line, unsigned long* ID)
{
    const char *begin = line, *end = line;
    char *end2;

    // The first word is the ID
    if (!get_word(&begin, &end))
        return false;

    *ID = strtoul(begin, &end2, 10);
    if (end2 != end)
        return false;

    return true;
}

const struct CmdTemplate* parser_get_cmd_template(const char *input)
{
//  const struct CmdTemplate *cmdp;
//  int cmdlen;
    const char *begin = input, *end = input;

    // Skip the ID, and get the command
    if (!get_word(&begin, &end))
        return NULL;
    if (!get_word(&begin, &end))
        return NULL;

    return (const struct CmdTemplate*)ht_find(&commands, begin, end-begin);
}

static const char *skip_to_params(const char *input, const struct CmdTemplate *cmdp)
{
    const char *begin = input, *end = input;

    // Skip the ID, and get the command
    if (!get_word(&begin, &end))
        return NULL;
    if (!get_word(&begin, &end))
        return NULL;

    ASSERT2(strlen(cmdp->name) == (size_t)(end-begin), "Invalid command template specified");
    ASSERT2(!strncmp(begin, cmdp->name, end-begin), "Invalid command template specified");

    return end;
}

bool parser_get_cmd_arguments(const char* input, const struct CmdTemplate* cmdp, parms args[PARSER_MAX_ARGS])
{
    input = skip_to_params(input, cmdp);
    if (!input)
        return false;

    args[0].s = cmdp->name;
    if (!parseArgs(cmdp->arg_fmt, input, args + 1))
        return false;

    return true;
}

static const void* get_key_from_command(const void* cmd, uint8_t* length)
{
    const struct CmdTemplate* c = cmd;
    *length = strlen(c->name);
    return c->name;
}

bool parser_process_line(const char* input)
{
    const struct CmdTemplate *cmdp;
    parms args[PARSER_MAX_ARGS];

    cmdp = parser_get_cmd_template(input);
    if (!cmdp)
        return false;

    if (!parser_get_cmd_arguments(input, cmdp, args))
        return false;

    if (!parser_execute_cmd(cmdp, args))
        return false;

    return true;
}

void parser_register_cmd(const struct CmdTemplate* cmd)
{
    ht_insert(&commands, cmd);
}

#if CONFIG_INTERNAL_COMMANDS
#warning FIXME:This code use boost lib, if you compile with internal command you must fix it.
static ResultCode cmd_help(void)
{
#ifdef _DEBUG

    // FIXME: There is no way at the moment to access the serial port. Dump
    //  this through JTAG for now
    for (HashIterator iter = ht_iter_begin(&commands);
        !ht_iter_cmp(iter, ht_iter_end(&commands));
        iter = ht_iter_next(iter))
    {
        struct CmdTemplate* cmd = (struct CmdTemplate*)ht_iter_get(iter);
        kprintf("%-20s", cmd->name);
        for (unsigned j = 0; cmd->arg_fmt[j]; ++j)
            kprintf("%c ", 'a' + j);
        kprintf("\r\n");
    }
#endif

    return RC_OK;
}

#include "cmd_hunk.h"
DECLARE_CMD_HUNK(help, (NIL), (NIL));

#endif // CONFIG_INTERNAL_COMMANDS


void parser_init(void)
{
    // Initialize the hashtable used to store the command description
    ht_init(&commands);

#if CONFIG_INTERNAL_COMMANDS
    parser_register_cmd(&CMD_HUNK_TEMPLATE(help));
#endif
}