parser.h

Go to the documentation of this file.

#ifndef MWARE_PARSER_H
#define MWARE_PARSER_H

#include "cfg/cfg_parser.h"

#include <cpu/types.h>
#include <cfg/debug.h>

typedef enum
{
    RC_ERROR  = -1, 
    RC_OK     = 0,  
    RC_REPLY  = 1,  
    RC_SKIP   = 2   
} ResultCode;

typedef union { long l; const char *s; } parms;
typedef ResultCode (*CmdFuncPtr)(parms args_results[]);

struct CmdTemplate
{
    const char *name;          
    const char *arg_fmt;       
    const char *result_fmt;    
    CmdFuncPtr func;           
    uint16_t   flags;          
};

#define REGISTER_FUNCTION parser_register_cmd

#define REGISTER_CMD(NAME) \
    do { \
        if (!REGISTER_FUNCTION(&cmd_ ## NAME ## _template)) \
            ASSERT2(0, "Error in registering command, no space left"); \
    } while (0)

#define MAKE_TEMPLATE(NAME, ARGS, RES, FLAGS)          \
const struct CmdTemplate cmd_ ## NAME ## _template =   \
{                                                      \
    #NAME, ARGS, RES, cmd_ ## NAME, FLAGS          \
};

#define MAKE_CMD(NAME, ARGS, RES, BODY, FLAGS)  \
static ResultCode cmd_ ## NAME (parms *args)    \
{                                               \
    return (ResultCode)BODY;                \
}                                               \
MAKE_TEMPLATE(NAME, ARGS, RES, FLAGS)

void parser_init(void);

bool parser_register_cmd(const struct CmdTemplate* cmd);


const char* parser_rl_match(void* dummy, const char* word, int word_len);

bool parser_process_line(const char* line);

INLINE bool parser_execute_cmd(const struct CmdTemplate* templ, parms args[CONFIG_PARSER_MAX_ARGS])
{
    return (templ->func(args) == 0);
}

const struct CmdTemplate* parser_get_cmd_template(const char* line);

bool parser_get_cmd_arguments(const char* line, const struct CmdTemplate* templ, parms args[CONFIG_PARSER_MAX_ARGS]);

#if CONFIG_ENABLE_COMPAT_BEHAVIOUR

bool parser_get_cmd_id(const char* line, unsigned long* ID);
#endif

 // defgroup parser
#endif /* MWARE_PARSER_H */