CLI  2.9
preprocessing.h File Reference

Pre-processing constants listing. More...

Go to the source code of this file.

Macros

#define CLI_NO_NAMESPACE   <set to disable namespaces>
 Namespace disabling. More...
 
#define _DEBUG   <set to enable debug utilities>
 Debug preprocessing constant. More...
 
#define CLI_ASSERT(a)   <set to override default implementation>
 CLI assertion macro. More...
 
#define CLI_NO_STL   <use inner instead of STL for tk objects>
 STL implementation disabling. More...
 
#define CLI_NO_REGEX   <set to disable regular expressions>
 Regular expressions disabling. More...
 
#define CLI_TELNET_INPUT_BUFFER_SIZE   <set to adjust telnet input buffer>
 Size of telnet input buffer. More...
 
#define CLI_WIN_NETWORK   <set to enable Windows networking>
 Windows networking enabling. More...
 
#define CLI_MAX_CLI_REGISTRY_COUNT   <adjust constraint>
 Maximum number of Cli objects in registry. More...
 
#define CLI_MAX_MENU_PER_CLI   <adjust constraint>
 Maximum number of menus per Cli object. More...
 
#define CLI_MAX_CMD_LINE_LENGTH   <adjust constraint>
 Maximum length of command lines. More...
 
#define CLI_MAX_CMD_LINE_WORD_COUNT   <adjust constraint>
 Maximum number of words per command line. More...
 
#define CLI_MAX_WORD_LENGTH   <adjust constraint>
 Maximum length of each word. More...
 
#define CLI_MAX_DEVICE_NAME_LENGTH   <adjust constraint>
 Maximum device name length. More...
 
#define CLI_MAX_FILE_PATH_LENGTH   <adjust constraint>
 Maximum file path length. More...
 
#define CLI_MAX_IO_MUX_INPUTS   <adjust constraint>
 Maximum input devices per IO Multiplexer device. More...
 
#define CLI_MAX_WORDS_PER_NODE   <adjust constraint>
 Maximum number of words per syntax node. More...
 
#define CLI_MAX_RESOURCE_LENGTH   <adjust constraint>
 Maximum resource string length. More...
 
#define CLI_MAX_TRACE_CLASS_COUNT   <adjust constraint>
 Maximum number of trace classes managed by the trace system. More...
 
#define CLI_MAX_TRACE_CLASS_NAME_LENGTH   <adjust constraint>
 Maximum length of trace class names. More...
 

Detailed Description

Pre-processing constants listing.

Author
Alexis Royer
Warning
This file is not supposed to be included.

This file is not supposed to be included. It just intends to list all configuration preprocessing constants for doxygen documentation.

Definition in file preprocessing.h.

Macro Definition Documentation

◆ _DEBUG

#define _DEBUG   <set to enable debug utilities>

Debug preprocessing constant.

Set this constant to activate debug utilities.

Definition at line 52 of file preprocessing.h.

◆ CLI_ASSERT

#define CLI_ASSERT (   a)    <set to override default implementation>

CLI assertion macro.

Definition at line 55 of file preprocessing.h.

◆ CLI_MAX_CLI_REGISTRY_COUNT

#define CLI_MAX_CLI_REGISTRY_COUNT   <adjust constraint>

Maximum number of Cli objects in registry.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 81 of file preprocessing.h.

◆ CLI_MAX_CMD_LINE_LENGTH

#define CLI_MAX_CMD_LINE_LENGTH   <adjust constraint>

Maximum length of command lines.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 91 of file preprocessing.h.

◆ CLI_MAX_CMD_LINE_WORD_COUNT

#define CLI_MAX_CMD_LINE_WORD_COUNT   <adjust constraint>

Maximum number of words per command line.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 96 of file preprocessing.h.

◆ CLI_MAX_DEVICE_NAME_LENGTH

#define CLI_MAX_DEVICE_NAME_LENGTH   <adjust constraint>

Maximum device name length.

Note
Useless with STL implementation.
Useless in release mode.
See also
constraints.h

Definition at line 107 of file preprocessing.h.

◆ CLI_MAX_FILE_PATH_LENGTH

#define CLI_MAX_FILE_PATH_LENGTH   <adjust constraint>

Maximum file path length.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 112 of file preprocessing.h.

◆ CLI_MAX_IO_MUX_INPUTS

#define CLI_MAX_IO_MUX_INPUTS   <adjust constraint>

Maximum input devices per IO Multiplexer device.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 117 of file preprocessing.h.

◆ CLI_MAX_MENU_PER_CLI

#define CLI_MAX_MENU_PER_CLI   <adjust constraint>

Maximum number of menus per Cli object.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 86 of file preprocessing.h.

◆ CLI_MAX_RESOURCE_LENGTH

#define CLI_MAX_RESOURCE_LENGTH   <adjust constraint>

Maximum resource string length.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 127 of file preprocessing.h.

◆ CLI_MAX_TRACE_CLASS_COUNT

#define CLI_MAX_TRACE_CLASS_COUNT   <adjust constraint>

Maximum number of trace classes managed by the trace system.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 132 of file preprocessing.h.

◆ CLI_MAX_TRACE_CLASS_NAME_LENGTH

#define CLI_MAX_TRACE_CLASS_NAME_LENGTH   <adjust constraint>

Maximum length of trace class names.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 137 of file preprocessing.h.

◆ CLI_MAX_WORD_LENGTH

#define CLI_MAX_WORD_LENGTH   <adjust constraint>

Maximum length of each word.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 101 of file preprocessing.h.

◆ CLI_MAX_WORDS_PER_NODE

#define CLI_MAX_WORDS_PER_NODE   <adjust constraint>

Maximum number of words per syntax node.

Note
Useless with STL implementation.
See also
constraints.h

Definition at line 122 of file preprocessing.h.

◆ CLI_NO_NAMESPACE

#define CLI_NO_NAMESPACE   <set to disable namespaces>

Namespace disabling.

Set this constant to disable cli and cli::tk namespaces.

Define this constant if your compiler does not support namespaces. Classes will be used instead.

Definition at line 47 of file preprocessing.h.

◆ CLI_NO_REGEX

#define CLI_NO_REGEX   <set to disable regular expressions>

Regular expressions disabling.

Defining this constant will disable regular expressions.

Definition at line 65 of file preprocessing.h.

◆ CLI_NO_STL

#define CLI_NO_STL   <use inner instead of STL for tk objects>

STL implementation disabling.

Define this constant if you wish to use inner rather than the STL TK implementation.

Definition at line 60 of file preprocessing.h.

◆ CLI_TELNET_INPUT_BUFFER_SIZE

#define CLI_TELNET_INPUT_BUFFER_SIZE   <set to adjust telnet input buffer>

Size of telnet input buffer.

Note
Useless when STL toolkit implementation is used.

Definition at line 69 of file preprocessing.h.

◆ CLI_WIN_NETWORK

#define CLI_WIN_NETWORK   <set to enable Windows networking>

Windows networking enabling.

Define this constant if you wish to use Windows Socket API. BSD socket API otherwise.

Definition at line 75 of file preprocessing.h.