config.h

This graph shows which files directly or indirectly include config.h:

InputHandler config.h.

Author

Douglas Quigg (dstroy0 dquigg123@gmail.com)

Version

1.0

Date

2023-02-13

Copyright

Copyright (c) 2023

Defines

IH_MAX_COMMANDS_PER_TREE

default is 32, total number of commands allowed per tree, including the root command

IH_MAX_ARGS_PER_COMMAND

default is 32, maximum number of arguments permitted per command

IH_MAX_TREE_DEPTH_PER_COMMAND

default is 32, process-wide tree depth cap

IH_MAX_NUM_CHILD_COMMANDS_PER_ROOT

default is 32, command-wide child command (including indirect subcommands) cap

IH_MAX_CMD_STR_LEN

default is 32, process-wide commandString cap

IH_MAX_NUM_PROC_DELIM_SEQ

default is 5, process-wide number of ih::DelimiterSequences cap

IH_MAX_NUM_START_STOP_SEQ

default is 5, process-wide number of ih::StartStopSequences cap

IH_MAX_PROC_INPUT_LEN

default is 128, maximum input length (in char)

IH_MAX_PER_ROOT_MEMCMP_RANGES

default is 5, per root command memcmp range array member cap

IH_INPUT_TYPE_STRINGS_PGM_LEN

default is 10, ihc::type_strings input type strings array max len

IH_EOL_SEQ_PGM_LEN

default is 5, process-wide end of line char sequence length cap

IH_DELIM_SEQ_PGM_LEN

default is 5, process-wide delimiter sequence length cap

IH_START_STOP_SEQ_PGM_LEN

default is 5, process-wide start-stop sequence length cap

IH_PROCESS_NAME_PGM_LEN

default is 12, process-wide ProcessName length cap

IH_INPUT_CONTROL_CHAR_SEQ_PGM_LEN

default is 3, process-wide input a control char sequence cap (2 char + null)

IH_WCC_SEQ_PGM_LEN

default is 2, process-wide WildcardChar length cap

IH_ECHO_ONLY

default is false, Enable this option to change the library’s output to echo only. It will only echo what was entered and indicate where the input error is.

Enable this option to change the library’s output to echo only. It will only echo what was entered and indicate where the input error is.

IH_VERBOSE

default is true, Enable this option to change the library’s output to verbose. Puts additional command information in the output buffer.

Enable this option to change the library’s output to verbose. Puts additional command information in the output buffer.

DEBUG_GETCOMMANDFROMSTREAM

default is false, Enable this option to debug ih::Input::getCommandFromStream()

Enable this option to debug Input::getCommandFromStream

DEBUG_READCOMMANDFROMBUFFER

default is false, Enable this option to debug ih::Input::readCommandFromBuffer()

Enable this option to debug Input::readCommandFromBuffer

DEBUG_GET_TOKEN

default is false, Enable this option to debug ih::Input::getToken()

Enable this option to debug Input::getToken

DEBUG_SUBCOMMAND_SEARCH

default is false, Enable this option to debug Input::launchLogic subcommand search; subcommand search is recursive, uses no local variables and passes a ih::Input::_rcfbprm object by reference to itself.

Enable this option to debug Input::launchLogic subcommand search; subcommand search is recursive, uses no local variables and passes a Input::_rcfbprm object by reference to itself.

DEBUG_ADDCOMMAND

default is false, Enable this option to debug ih::Input::addCommand()

Enable this option to debug Input::addCommand

DEBUG_LAUNCH_LOGIC

default is false, Enable this option to debug ih::Input::_launchLogic()

Enable this option to debug Input::launchLogic

DEBUG_LAUNCH_FUNCTION

default is false, Enable this option to debug ih::Input::_launchFunction()

Enable this option to debug Input::launchFunction

DEBUG_INCLUDE_FREERAM

default is false, Enable to debug src/utility/freeRam.h; only applicable if you are using freeRam.

Enable to debug src/utility/freeRam.h; only applicable if you are using freeRam.

DISABLE_listSettings

default is false, Enable this option to disable ih::Input::listSettings()

Enable this option to disable Input::listSettings()

DISABLE_listCommands

default is false, Enable this option to disable ih::Input::listCommands()

Enable this option to disable Input::listCommands

DISABLE_getCommandFromStream

default is false, Enable this option to disable ih::Input::getCommandFromStream()

Enable this option to disable Input::getCommandFromStream

DISABLE_nextArgument

default is false, Enable this option to disable ih::Input::nextArgument(), either this method or ih::Input::getArgument()) are required to retrieve arguments.

Enable this option to disable Input::nextArgument, either this or Input::getArgument are required to retrieve arguments.

DISABLE_getArgument

default is false, Enable this option to disable ih::Input::getArgument(), either this method or ih::Input::nextArgument() need to be enabled to retrieve arguments.

Enable this option to disable Input::getArgument method, either this or Input::nextArgument need to be enabled to retrieve arguments.

DISABLE_outputIsAvailable

default is false, Enable this option to disable ih::Input::outputIsAvailable().

Enable this option to disable the output available flag.

DISABLE_outputIsEnabled

default is false, Enable this option to disable ih::Input::outputIsEnabled()

Enable this option to disable Input::outputIsEnabled

DISABLE_outputToStream

default is false, Enable this option to reduce codesize if you are only using ih::Input::readCommandFromBuffer().

Enable this option to reduce codesize if you are only using Input::readCommandFromBuffer. Default is false.

DISABLE_clearOutputBuffer

default is false, Only disable this method if you have already disabled output. Enable this option to disable Input::clearOutputBuffer()

Only disable this method if you have already disabled output. Enable this option to disable Input::clearOutputBuffer() Default is false.

DISABLE_readCommandFromBufferErrorOutput

default is false, Enable this option to disable the library’s error output.

Enable this option to disable the library’s error output. Default is false.

DISABLE_ihout

default is false, Enable this option to completely remove output functionality at buildtime from the library.

Enable this option to completely remove output functionality at buildtime from the library. Default is false.