ngcbShell.h

Go to the documentation of this file.

#ifndef ngcbShell_h
#define ngcbShell_h
 
 
#include <stdio.h>
#include <stdlib.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef USE
#define USE(x) do {(void)(x);} while (0)
#endif
 
/*
 * Command line editor
 */
#define ngcbSHELL_FUNCTION_KEY(x) ((x == 91) || (x == 79)) 
#define ngcbSHELL_ESC           27  
#define ngcbSHELL_F_CRSR_UP     65  
#define ngcbSHELL_F_CRSR_DOWN   66  
#define ngcbSHELL_F_CRSR_LEFT   68  
#define ngcbSHELL_F_CRSR_RIGHT  67  
#define ngcbSHELL_F_END         70  
#define ngcbSHELL_F_BEGIN       72  
#define ngcbSHELL_F_INSERT      50  
#define ngcbSHELL_COMMENT       '#' 
#define ngcbSHELL_MAX_FILES     32  
#define ngcbSHELL_MAX_CMDLEN   256  
#define ngcbSHELL_STACK_SIZE    20  
 
/*
 * Control keys
 */
#define ngcbSHELL_CR             13  
#define ngcbSHELL_BS              8  
#define ngcbSHELL_INSERT          9  
#define ngcbSHELL_END             5  
#define ngcbSHELL_BEGIN           1  
#define ngcbSHELL_LEFT            2  
#define ngcbSHELL_RIGHT           6  
#define ngcbSHELL_DEL             4  
#define ngcbSHELL_DELLINE        11  
 
/*
 * Protoypes
 */

FILE *ngcbShellOpenRepStream(const char *outDev, char *erms);

int ngcbShellTerminate(const char *inDev, char *erms);

int ngcbShellGetLine(const char *inDev, char *cmdLine, char *erms);

int ngcbShellReadStream(FILE *inputStream, char *cmdLine, char *erms);

int ngcbShellReadKeyboard(char *cmdLine, char *erms);

int ngcbShellGetKey(char *key, char *erms);

int ngcbShellPollKey(char *key, char *erms);

int ngcbShellTermTty(char *erms);
 
#ifdef __cplusplus
}
#endif
 
#endif