iLLD_TC27xD  1.0
Collaboration diagram for Console:

Macros

#define CONSOLE   Ifx_g_console
 Alias Ifx_g_console object (by value) More...
 

Functions

IFX_INLINE IfxStdIf_DPipeIfx_Console_getIo (void)
 Return pointer to the default console object. More...
 
IFX_EXTERN void Ifx_Console_init (IfxStdIf_DPipe *standardIo)
 Initialize the Ifx_g_console object. More...
 
IFX_EXTERN boolean Ifx_Console_print (pchar format,...)
 Print formatted string into Ifx_g_console. More...
 
IFX_EXTERN boolean Ifx_Console_printAlign (pchar format,...)
 Print formatted string into Ifx_g_console. Indented with a number of spaces. More...
 
IFX_INLINE void Ifx_Console_decrAlign (sint16 value)
 Decrement the alignment/indentation using the given value. More...
 
IFX_INLINE void Ifx_Console_incrAlign (sint16 value)
 Increment the alignment/indentation using the given value. More...
 

Detailed Description

This module implements "Main Console" functions

Macro Definition Documentation

#define CONSOLE   Ifx_g_console

Alias Ifx_g_console object (by value)

Definition at line 54 of file Ifx_Console.h.

Function Documentation

IFX_INLINE void Ifx_Console_decrAlign ( sint16  value)

Decrement the alignment/indentation using the given value.

Parameters
valuethe increment. If value == 0, IFX_CFG_CONSOLE_INDENT_SIZE will be used.

Definition at line 76 of file Ifx_Console.h.

IFX_INLINE IfxStdIf_DPipe* Ifx_Console_getIo ( void  )

Return pointer to the default console object.

User can override this function by defining new CONSOLE macro and this function externally, e.g. inside Ifx_Cfg.h file.

Definition at line 60 of file Ifx_Console.h.

IFX_INLINE void Ifx_Console_incrAlign ( sint16  value)

Increment the alignment/indentation using the given value.

Parameters
valuethe increment. If value == 0, IFX_CFG_CONSOLE_INDENT_SIZE will be used.

Definition at line 87 of file Ifx_Console.h.

IFX_EXTERN void Ifx_Console_init ( IfxStdIf_DPipe standardIo)

Initialize the Ifx_g_console object.

Parameters
standardIoPointer to the IfxStdIf_DPipe object used by the Ifx_g_console.

Definition at line 39 of file Ifx_Console.c.

IFX_EXTERN boolean Ifx_Console_print ( pchar  format,
  ... 
)

Print formatted string into Ifx_g_console.

Parameters
formatprintf-compatible formatted string.
Return values
TRUEif the string is printed successfully
FALSEif the function failed.

Definition at line 52 of file Ifx_Console.c.

IFX_EXTERN boolean Ifx_Console_printAlign ( pchar  format,
  ... 
)

Print formatted string into Ifx_g_console. Indented with a number of spaces.

Parameters
formatprintf-compatible formatted string.
Return values
TRUEif the string is printed successfully
FALSEif the function failed.

Definition at line 81 of file Ifx_Console.c.