cli_registry.h

Go to the documentation of this file.

/**
 * @file    cli_registry.h
 * @brief   Command-line interface commands registry
 *
 * @date Nov 15, 2012
 * @author Andrey Belomutskiy, (c) 2012-2020
 */
 
#pragma once
 
typedef enum {
    NO_PARAMETER,
    NO_PARAMETER_P,
    ONE_PARAMETER,
    ONE_PARAMETER_P,
    FLOAT_PARAMETER_NAN_ALLOWED,
    FLOAT_PARAMETER,
    FLOAT_PARAMETER_P,
    STRING_PARAMETER,
    STRING_PARAMETER_P,
    STRING2_PARAMETER,
    STRING2_PARAMETER_P,
    STRING3_PARAMETER,
    STRING5_PARAMETER,
    TWO_INTS_PARAMETER,
    TWO_INTS_PARAMETER_P,
    FLOAT_FLOAT_PARAMETER,
    FLOAT_FLOAT_FLOAT_PARAMETER,
    FLOAT_FLOAT_FLOAT_FLOAT_PARAMETER,
    FLOAT_FLOAT_PARAMETER_P,
    INT_FLOAT_PARAMETER,
} action_type_e;
 
typedef struct {
    const char *token;
    action_type_e parameterType;
    void (*callback)(void);
    void *param;
} TokenCallback;
 
 
int tokenLength(const char *msgp);
int findEndOfToken(const char *line);
char *unquote(char *line);
 
 
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
 
typedef void (*Void)(void);
typedef void (*VoidPtr)(void*);
typedef void (*VoidInt)(int);
typedef void (*VoidIntVoidPtr)(int, void*);
typedef void (*VoidFloat)(float);
typedef void (*VoidFloatFloat)(float, float);
typedef void (*VoidFloatFloatFloat)(float, float, float);
typedef void (*VoidFloatFloatFloatFloat)(float, float, float, float);
typedef void (*VoidFloatFloatVoidPtr)(float, float, void*);
typedef void (*VoidIntInt)(int, int);
typedef void (*VoidIntIntVoidPtr)(int, int, void*);
typedef void (*VoidIntFloat)(int, float);
 
typedef void (*VoidCharPtr)(const char *);
typedef void (*VoidCharPtrVoidPtr)(const char *, void*);
 
typedef void (*VoidCharPtrCharPtr)(const char *, const char *);
typedef void (*VoidCharPtrCharPtrVoidPtr)(const char *, const char *, void*);
 
typedef void (*VoidCharPtrCharPtrCharPtr)(const char *, const char *, const char *);
typedef void (*VoidCharPtrCharPtrCharPtrCharPtrCharPtr)(const char *, const char *, const char *, const char *, const char *);
 
void resetConsoleActions(void);
void helpCommand(void);
void initConsoleLogic();
void handleConsoleLine(char *line);
void addConsoleAction(const char *token, Void callback);
void addConsoleActionP(const char *token, VoidPtr callback, void *param);
 
void addConsoleActionI(const char *token, VoidInt callback);
void addConsoleActionIP(const char *token, VoidIntVoidPtr callback, void *param);
 
void addConsoleActionIF(const char* token, VoidIntFloat callback);
 
void addConsoleActionII(const char *token, VoidIntInt callback);
void addConsoleActionIIP(const char *token, VoidIntIntVoidPtr callback, void *param);
 
void addConsoleActionF(const char *token, VoidFloat callback);
void addConsoleActionNANF(const char *token, VoidFloat callback);
 
void addConsoleActionFF(const char *token, VoidFloatFloat callback);
void addConsoleActionFFF(const char *token, VoidFloatFloatFloat callback);
void addConsoleActionFFFF(const char *token, VoidFloatFloatFloatFloat callback);
void addConsoleActionFFP(const char *token, VoidFloatFloatVoidPtr callback, void *param);
 
void addConsoleActionS(const char *token, VoidCharPtr callback);
void addConsoleActionSP(const char *token, VoidCharPtrVoidPtr callback, void *param);
 
void addConsoleActionSS(const char *token, VoidCharPtrCharPtr callback);
void addConsoleActionSSP(const char *token, VoidCharPtrCharPtrVoidPtr callback, void *param);
 
void addConsoleActionSSS(const char *token, VoidCharPtrCharPtrCharPtr callback);
void addConsoleActionSSSSS(const char *token, VoidCharPtrCharPtrCharPtrCharPtrCharPtr callback);
 
void onCliCaseError(const char *token);
void onCliDuplicateError(const char *token);
void onCliOverflowError();
 
#ifdef __cplusplus
}
#endif /* __cplusplus */