microrl.h

Go to the documentation of this file.

#ifndef _MICRORL_H_
#define _MICRORL_H_
 
#include "microrlConfig.h"
 
#define true  1
#define false 0
 
 /* define the Key codes */
#define KEY_NUL 0 
#define KEY_SOH 1 
#define KEY_STX 2 
#define KEY_ETX 3 
#define KEY_EOT 4 
#define KEY_ENQ 5 
#define KEY_ACK 6 
#define KEY_BEL 7 
#define KEY_BS  8 
#define KEY_HT  9 
#define KEY_LF  10  
#define KEY_VT  11  
#define KEY_FF  12  
#define KEY_CR  13  
#define KEY_SO  14  
#define KEY_SI  15  
#define KEY_DLE 16  
#define KEY_DC1 17  
#define KEY_DC2 18  
#define KEY_DC3 19  
#define KEY_DC4 20  
#define KEY_NAK 21  
#define KEY_SYN 22  
#define KEY_ETB 23  
#define KEY_CAN 24  
#define KEY_EM  25  
#define KEY_SUB 26  
#define KEY_ESC 27  
#define KEY_FS  28  
#define KEY_GS  29  
#define KEY_RS  30  
#define KEY_US  31  
#define KEY_DEL 127 
// direction of history navigation
#define _HIST_UP   0
#define _HIST_DOWN 1
// esc seq internal codes
#define _ESC_BRACKET  1
#define _ESC_HOME     2
#define _ESC_END      3
 
#ifdef _USE_HISTORY
// history struct, contain internal variable
// history store in static ring buffer for memory saving
typedef struct {
  char ring_buf [_RING_HISTORY_LEN];
  int begin;
  int end;
  int cur;
} ring_history_t;
#endif
 
// microrl struct, contain internal library data
typedef struct {
#ifdef _USE_HISTORY
  ring_history_t ring_hist;          // history object
#endif
  char * prompt_str;                 // pointer to prompt string
  char cmdline [_COMMAND_LINE_LEN];  // cmdline buffer
  int cmdlen;                        // last position in command line
  int cursor;                        // input cursor
  char const * tkn_arr [_COMMAND_TOKEN_NMB];                        // array of token for call 'execute' callback
  void (*execute) (int argc, const char * const * argv );            // ptr to 'execute' callback
  const char ** (*get_completion) (int argc, const char * const * argv ); // ptr to 'completion' callback
  void (*print) (const char *);                                     // ptr to 'print' callback
#ifdef _USE_CTLR_C
  void (*sigint) (void);
#endif
} microrl_t;
 
// init internal data, calls once at start up
void microrl_init (microrl_t * pThis, void (*print)(const char*));
 
// set echo mode (true/false), using for disabling echo for password input
// echo mode will enabled after user press Enter.
void microrl_set_echo (int);
 
// set pointer to callback complition func, that called when user press 'Tab'
// callback func description:
//   param: argc - argument count, argv - pointer array to token string
//   must return NULL-terminated string, contain complite variant splitted by 'Whitespace'
//   If complite token found, it's must contain only one token to be complitted
//   Empty string if complite not found, and multiple string if there are some token
void microrl_set_complete_callback (microrl_t * pThis, 
            const char ** (*get_completion)(int, const char* const*));
 
// pointer to callback func, that called when user press 'Enter'
// execute func param: argc - argument count, argv - pointer array to token string
void microrl_set_execute_callback (microrl_t * pThis, void (*execute)(int, const char* const*));
 
// set callback for Ctrl+C terminal signal
#ifdef _USE_CTLR_C
void microrl_set_sigint_callback (microrl_t * pThis, void (*sigintf)(void));
#endif
 
// insert char to cmdline (for example call in usart RX interrupt)
void microrl_insert_char (microrl_t * pThis, int ch);
 
#endif