ketCube_terminal.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __KETCUBE_TERMINAL_H
#define __KETCUBE_TERMINAL_H
 
#include <stdarg.h>
#include <stdlib.h>
 
#include "ketCube_terminal_common.h"
#include "vcom.h"
 
#define KETCUBE_TERMINAL_DEBUG           FALSE  
#define KETCUBE_TERMINAL_MODDEBUG        TRUE   
#define KETCUBE_TERMINAL_ECHO            TRUE   
#define KETCUBE_TERMINAL_HISTORY_LEN     3      
#define KETCUBE_TERMINAL_CMD_MAX_LEN     128    
#define KETCUBE_TERMINAL_PRINTF(...)     ketCube_terminal_UsartPrint(__VA_ARGS__)    
#define KETCUBE_TERMINAL_PROMPT()        KETCUBE_TERMINAL_PRINTF(">> ")              
#define KETCUBE_TERMINAL_ENDL()          KETCUBE_TERMINAL_PRINTF("\n\r")             
#define KETCUBE_TERMINAL_CLR_LINE()      ketCube_terminal_ClearCmdLine()             
typedef struct {
    char buffer[KETCUBE_TERMINAL_CMD_MAX_LEN + 1];
    uint8_t ptr;
} ketCube_terminal_buffer_t;
 
extern void ketCube_terminal_Init(void);
extern void ketCube_terminal_ProcessCMD(void);
extern void ketCube_terminal_UpdateCmdLine(void);
extern void ketCube_terminal_ClearCmdLine(void);
 
extern void ketCube_terminal_cmd_about(void);
extern void ketCube_terminal_cmd_help(void);
 
void ketCube_terminal_UsartPrint(char *format, ...);
 
void ketCube_terminal_Print(char *format, ...);
void ketCube_terminal_Println(char *format, ...);
 
extern void ketCube_terminal_CoreSeverityPrintln(ketCube_severity_t
                                                 msgSeverity, char *format,
                                                 ...);
 
extern void ketCube_terminal_DriverSeverityPrintln(const char * drvName, ketCube_severity_t msgSeverity, char *format, ...);
 
extern void ketCube_terminal_ModSeverityPrintln(ketCube_severity_t
                                                msgSeverity,
                                                ketCube_cfg_moduleIDs_t
                                                modId, char *format,
                                                va_list args);
 
extern void ketCube_terminal_DebugPrint(char *format, ...);
extern void ketCube_terminal_DebugPrintln(char *format, ...);
 
 
 
static inline void ketCube_terminal_AlwaysPrintln(ketCube_cfg_moduleIDs_t
                                                  modId, char *format, ...)
{
    va_list args;
    va_start(args, format);
    ketCube_terminal_ModSeverityPrintln(KETCUBE_CFG_SEVERITY_NONE, modId,
                                        format, args);
    va_end(args);
}
 
static inline void ketCube_terminal_NewDebugPrintln(ketCube_cfg_moduleIDs_t
                                                    modId, char *format,
                                                    ...)
{
    va_list args;
    va_start(args, format);
    ketCube_terminal_ModSeverityPrintln(KETCUBE_CFG_SEVERITY_DEBUG, modId,
                                        format, args);
    va_end(args);
}
 
static inline void ketCube_terminal_ErrorPrintln(ketCube_cfg_moduleIDs_t
                                                 modId, char *format, ...)
{
    va_list args;
    va_start(args, format);
    ketCube_terminal_ModSeverityPrintln(KETCUBE_CFG_SEVERITY_ERROR, modId,
                                        format, args);
    va_end(args);
}
 
static inline void ketCube_terminal_InfoPrintln(ketCube_cfg_moduleIDs_t
                                                modId, char *format, ...)
{
    va_list args;
    va_start(args, format);
    ketCube_terminal_ModSeverityPrintln(KETCUBE_CFG_SEVERITY_INFO, modId,
                                        format, args);
    va_end(args);
}
 
#endif                          /* KETCUBE_TERMINAL_H */