cli_registry.h File Reference

Detailed Description

Command-line interface commands registry.

Date

Nov 15, 2012

Author

Andrey Belomutskiy, (c) 2012-2020

Definition in file cli_registry.h.

Data Structures
struct	TokenCallback

Typedefs
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 *)

Enumerations
enum	action_type_e {   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 }

Functions
int	tokenLength (const char *msgp)
int	findEndOfToken (const char *line)
char *	unquote (char *line)
void	resetConsoleActions (void)
void	helpCommand (void)
	This function prints out a list of all available commands.
void	initConsoleLogic ()
void	handleConsoleLine (char *line)
	This function takes care of one command line once we have it.
void	addConsoleAction (const char *token, Void callback)
	Register console action without parameters.
void	addConsoleActionP (const char *token, VoidPtr callback, void *param)
void	addConsoleActionI (const char *token, VoidInt callback)
	Register a console command with one Integer parameter.
void	addConsoleActionIP (const char *token, VoidIntVoidPtr callback, void *param)
void	addConsoleActionIF (const char *token, VoidIntFloat callback)
void	addConsoleActionII (const char *token, VoidIntInt callback)
	Register a console command with two Integer parameters.
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 ()

Typedef Documentation

Void

typedef void(* Void) (void)

Definition at line 52 of file cli_registry.h.

VoidCharPtr

typedef void(* VoidCharPtr) (const char *)

Definition at line 65 of file cli_registry.h.

VoidCharPtrCharPtr

typedef void(* VoidCharPtrCharPtr) (const char *, const char *)

Definition at line 68 of file cli_registry.h.

VoidCharPtrCharPtrCharPtr

typedef void(* VoidCharPtrCharPtrCharPtr) (const char *, const char *, const char *)

Definition at line 71 of file cli_registry.h.

VoidCharPtrCharPtrCharPtrCharPtrCharPtr

typedef void(* VoidCharPtrCharPtrCharPtrCharPtrCharPtr) (const char *, const char *, const char *, const char *, const char *)

Definition at line 72 of file cli_registry.h.

VoidCharPtrCharPtrVoidPtr

typedef void(* VoidCharPtrCharPtrVoidPtr) (const char *, const char *, void *)

Definition at line 69 of file cli_registry.h.

VoidCharPtrVoidPtr

typedef void(* VoidCharPtrVoidPtr) (const char *, void *)

Definition at line 66 of file cli_registry.h.

VoidFloat

typedef void(* VoidFloat) (float)

Definition at line 56 of file cli_registry.h.

VoidFloatFloat

typedef void(* VoidFloatFloat) (float, float)

Definition at line 57 of file cli_registry.h.

VoidFloatFloatFloat

typedef void(* VoidFloatFloatFloat) (float, float, float)

Definition at line 58 of file cli_registry.h.

VoidFloatFloatFloatFloat

typedef void(* VoidFloatFloatFloatFloat) (float, float, float, float)

Definition at line 59 of file cli_registry.h.

VoidFloatFloatVoidPtr

typedef void(* VoidFloatFloatVoidPtr) (float, float, void *)

Definition at line 60 of file cli_registry.h.

VoidInt

typedef void(* VoidInt) (int)

Definition at line 54 of file cli_registry.h.

VoidIntFloat

typedef void(* VoidIntFloat) (int, float)

Definition at line 63 of file cli_registry.h.

VoidIntInt

typedef void(* VoidIntInt) (int, int)

Definition at line 61 of file cli_registry.h.

VoidIntIntVoidPtr

typedef void(* VoidIntIntVoidPtr) (int, int, void *)

Definition at line 62 of file cli_registry.h.

VoidIntVoidPtr

typedef void(* VoidIntVoidPtr) (int, void *)

Definition at line 55 of file cli_registry.h.

VoidPtr

typedef void(* VoidPtr) (void *)

Definition at line 53 of file cli_registry.h.

Enumeration Type Documentation

action_type_e

enum action_type_e

Enumerator
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

Definition at line 11 of file cli_registry.h.

             {
    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;

Function Documentation

addConsoleAction()

void addConsoleAction	(	const char *	token,
		Void	callback
	)

Register console action without parameters.

Definition at line 91 of file cli_registry.cpp.

                                                        {
    doAddAction(token, NO_PARAMETER, callback, NULL);
}

Referenced by adcTriggerTurnOnInputPin(), commonInitEngineController(), errorHandlerInit(), f407_discovery_boardInitHardware(), initBenchTest(), initCan(), initCanGpioMsiobox(), initConsoleLogic(), initEarlyMmcCard(), initElectronicThrottle(), initFlash(), initFlexSensor(), initGps(), initializeConsole(), initKLine(), initMalfunctionIndicator(), initMapDecoder(), initMax3185x(), initPinRepository(), initPrimaryPins(), initSensorCli(), initSent(), initSettings(), initTimePerfActions(), initTriggerCentral(), initWaveAnalyzer(), initWaveChart(), runRusEfi(), startIdleThread(), startLua(), startTunerStudioConnectivity(), ButtonDebounce::stopConfiguration(), and tle9201_add().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionF()

void addConsoleActionF	(	const char *	token,
		VoidFloat	callback
	)

Definition at line 145 of file cli_registry.cpp.

                                                              {
    doAddAction(token, FLOAT_PARAMETER, (Void) callback, NULL);
}

Referenced by initBenchTest(), and initSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionFF()

void addConsoleActionFF	(	const char *	token,
		VoidFloatFloat	callback
	)

Definition at line 149 of file cli_registry.cpp.

                                                                    {
    doAddAction(token, FLOAT_FLOAT_PARAMETER, (Void) callback, NULL);
}

Here is the call graph for this function:

addConsoleActionFFF()

void addConsoleActionFFF	(	const char *	token,
		VoidFloatFloatFloat	callback
	)

Definition at line 153 of file cli_registry.cpp.

                                                                          {
    doAddAction(token, FLOAT_FLOAT_FLOAT_PARAMETER, (Void) callback, NULL);
}

Referenced by initBenchTest().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionFFFF()

void addConsoleActionFFFF	(	const char *	token,
		VoidFloatFloatFloatFloat	callback
	)

Definition at line 157 of file cli_registry.cpp.

                                                                                {
    doAddAction(token, FLOAT_FLOAT_FLOAT_FLOAT_PARAMETER, (Void) callback, NULL);
}

Referenced by initBenchTest().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionFFP()

void addConsoleActionFFP	(	const char *	token,
		VoidFloatFloatVoidPtr	callback,
		void *	param
	)

Definition at line 161 of file cli_registry.cpp.

                                                                                         {
    doAddAction(token, FLOAT_FLOAT_PARAMETER_P, (Void) callback, param);
}

Here is the call graph for this function:

addConsoleActionI()

void addConsoleActionI	(	const char *	token,
		VoidInt	callback
	)

Register a console command with one Integer parameter.

Definition at line 98 of file cli_registry.cpp.

                                                            {
    doAddAction(token, ONE_PARAMETER, (Void) callback, NULL);
}

Referenced by initAdcInputs(), initBenchTest(), initConfigActions(), initializeConsole(), initPotentiometers(), initQcBenchControls(), initSensorCli(), initSettings(), initTimePerfActions(), initTriggerEmulator(), initWaveChart(), setEepromTestConfiguration(), and startTunerStudioConnectivity().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionIF()

void addConsoleActionIF	(	const char *	token,
		VoidIntFloat	callback
	)

Definition at line 117 of file cli_registry.cpp.

                                                                  {
    doAddAction(token, INT_FLOAT_PARAMETER, (Void) callback, NULL);
}

Here is the call graph for this function:

addConsoleActionII()

void addConsoleActionII	(	const char *	token,
		VoidIntInt	callback
	)

Register a console command with two Integer parameters.

Definition at line 109 of file cli_registry.cpp.

                                                                {
    doAddAction(token, TWO_INTS_PARAMETER, (Void) callback, NULL);
}

Referenced by initBenchTest(), initConfigActions(), initKLine(), initPotentiometers(), initQcBenchControls(), and startLua().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionIIP()

void addConsoleActionIIP	(	const char *	token,
		VoidIntIntVoidPtr	callback,
		void *	param
	)

Definition at line 113 of file cli_registry.cpp.

                                                                                     {
    doAddAction(token, TWO_INTS_PARAMETER_P, (Void) callback, param);
}

Here is the call graph for this function:

addConsoleActionIP()

void addConsoleActionIP	(	const char *	token,
		VoidIntVoidPtr	callback,
		void *	param
	)

Definition at line 102 of file cli_registry.cpp.

                                                                                 {
    doAddAction(token, ONE_PARAMETER_P, (Void) callback, param);
}

Here is the call graph for this function:

addConsoleActionNANF()

void addConsoleActionNANF	(	const char *	token,
		VoidFloat	callback
	)

Definition at line 141 of file cli_registry.cpp.

                                                                 {
    doAddAction(token, FLOAT_PARAMETER_NAN_ALLOWED, (Void) callback, NULL);
}

Here is the call graph for this function:

addConsoleActionP()

void addConsoleActionP	(	const char *	token,
		VoidPtr	callback,
		void *	param
	)

Definition at line 80 of file cli_registry.cpp.

                                                                         {
    doAddAction(token, NO_PARAMETER_P, (Void) callback, param);
}

Here is the call graph for this function:

addConsoleActionS()

void addConsoleActionS	(	const char *	token,
		VoidCharPtr	callback
	)

Definition at line 121 of file cli_registry.cpp.

                                                                {
    doAddAction(token, STRING_PARAMETER, (Void) callback, NULL);
}

Referenced by initEarlyMmcCard(), initSettings(), and startLua().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionSP()

void addConsoleActionSP	(	const char *	token,
		VoidCharPtrVoidPtr	callback,
		void *	param
	)

Definition at line 125 of file cli_registry.cpp.

                                                                                     {
    doAddAction(token, STRING_PARAMETER_P, (Void) callback, param);
}

Here is the call graph for this function:

addConsoleActionSS()

void addConsoleActionSS	(	const char *	token,
		VoidCharPtrCharPtr	callback
	)

Definition at line 129 of file cli_registry.cpp.

                                                                        {
    doAddAction(token, STRING2_PARAMETER, (Void) callback, NULL);
}

Referenced by initConfigActions(), initSensorCli(), and initSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionSSP()

void addConsoleActionSSP	(	const char *	token,
		VoidCharPtrCharPtrVoidPtr	callback,
		void *	param
	)

Definition at line 84 of file cli_registry.cpp.

                                                                                             {
    doAddAction(token, STRING2_PARAMETER_P, (Void) callback, param);
}

Here is the call graph for this function:

addConsoleActionSSS()

void addConsoleActionSSS	(	const char *	token,
		VoidCharPtrCharPtrCharPtr	callback
	)

Definition at line 133 of file cli_registry.cpp.

                                                                                {
    doAddAction(token, STRING3_PARAMETER, (Void) callback, NULL);
}

Referenced by initConfigActions(), and startTunerStudioConnectivity().

Here is the call graph for this function:

Here is the caller graph for this function:

addConsoleActionSSSSS()

void addConsoleActionSSSSS	(	const char *	token,
		VoidCharPtrCharPtrCharPtrCharPtrCharPtr	callback
	)

Definition at line 137 of file cli_registry.cpp.

                                                                                                {
    doAddAction(token, STRING5_PARAMETER, (Void) callback, NULL);
}

Here is the call graph for this function:

findEndOfToken()

int findEndOfToken

(

const char *

line

)

Looks like this is a quoted token

Matching closing quote not found

Skipping first quote and the symbol after closing quote

Definition at line 207 of file cli_registry.cpp.

                                     {
    if (line[0] == '"') {
        /**
         * Looks like this is a quoted token
         */
        int v = indexOf(line + 1, '"');
        if (v == -1) {
            /**
             * Matching closing quote not found
             */
            return -1;
        }
        /**
         * Skipping first quote and the symbol after closing quote
         */
        return v + 2;
    }
    return indexOf(line, SPACE_CHAR);
}

handleConsoleLine()

void handleConsoleLine

(

char *

line

)

This function takes care of one command line once we have it.

Definition at line 510 of file cli_registry.cpp.

                                   {
    if (line == NULL)
        return; // error detected
 
    int lineLength = std::strlen(line);
    if (lineLength > MAX_CMD_LINE_LENGTH) {
        // todo: better reaction to excessive line
        efiPrintf("Long line?");
        return;
    }
 
    int ret = handleConsoleLineInternal(line);
 
    if (ret < 0) {
        efiPrintf("failed to handle command [%s]", line);
        return;
    }
 
    efiPrintf("confirmation_%s:%d", line, lineLength);
}

Referenced by checkStackAndHandleConsoleLine(), and initializeConsole().

Here is the call graph for this function:

Here is the caller graph for this function:

helpCommand()

void helpCommand

(

void

)

This function prints out a list of all available commands.

Definition at line 198 of file cli_registry.cpp.

                       {
    efiPrintf("%d actions available", consoleActionCount);
    for (int i = 0; i < consoleActionCount; i++) {
        TokenCallback *current = &consoleActions[i];
        efiPrintf("  %s: %d parameters", current->token, getParameterCount(current->parameterType));
    }
    efiPrintf("For more visit https://github.com/rusefi/rusefi/wiki/Dev-Console-Commands");
}

Referenced by initConsoleLogic().

Here is the call graph for this function:

Here is the caller graph for this function:

initConsoleLogic()

void initConsoleLogic

(

)

Definition at line 472 of file cli_registry.cpp.

                        {
    addConsoleAction("help", helpCommand);
}

Referenced by initializeConsole().

Here is the call graph for this function:

Here is the caller graph for this function:

onCliCaseError()

void onCliCaseError

(

const char *

token

)

Definition at line 232 of file eficonsole.cpp.

                                       {
    firmwareError(ObdCode::CUSTOM_ERR_COMMAND_LOWER_CASE_EXPECTED, "lowerCase expected [%s]", token);
}

Referenced by doAddAction().

Here is the call graph for this function:

Here is the caller graph for this function:

onCliDuplicateError()

void onCliDuplicateError

(

const char *

token

)

Definition at line 236 of file eficonsole.cpp.

                                            {
    firmwareError(ObdCode::CUSTOM_SAME_TWICE, "Same action twice [%s]", token);
}

Referenced by doAddAction().

Here is the call graph for this function:

Here is the caller graph for this function:

onCliOverflowError()

void onCliOverflowError

(

)

Definition at line 240 of file eficonsole.cpp.

                          {
    firmwareError(ObdCode::CUSTOM_CONSOLE_TOO_MANY, "Too many console actions");
}

Referenced by doAddAction().

Here is the call graph for this function:

Here is the caller graph for this function:

resetConsoleActions()

void resetConsoleActions

(

void

)

Definition at line 47 of file cli_registry.cpp.

                               {
    consoleActionCount = 0;
}

tokenLength()

int tokenLength

(

const char *

msgp

)

Returns

Number of space-separated tokens in the string

Definition at line 230 of file cli_registry.cpp.

                                  {
    int result = 0;
    while (*msgp) {
        char ch = *msgp++;
        if (ch == SPACE_CHAR) {
            break;
        }
        result++;
    }
    return result;
}

unquote()

char * unquote

(

char *

line

)

Definition at line 242 of file cli_registry.cpp.

                          {
    if (line[0] == '"') {
        int len = std::strlen(line);
        if (line[len - 1] == '"') {
            line[len - 1] = 0;
            return line + 1;
        }
    }
    return line;
}

Go to the source code of this file.