ngcppShell.h

Go to the documentation of this file.

#ifndef ngcppShell_h
#define ngcppShell_h
 
/*******************************************************************************
* E.S.O. - European Southern Observatory
*
*
* who       when        what
* --------  ----------  ----------------------------------------------
* jstegmei  2004-03-11  created
* jstegmei  2008-01-03  added remote register access function
* jstegmei  2011-04-12  added comments
* jstegmei  2011-04-14  added function documentation
* jstegmei  2014-05-12  const declarations
*/
 
/************************************************************************
 *
 *  ngcppShell.h - NGC pre-processor command shell
 *
 *----------------------------------------------------------------------
 */
 
#include <ngc/core/ngcbShell.h>
#include <ngc/core/ngcppInt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Pre-defined arguments
 */
#define ngcppARG_ON  "on"    
#define ngcppARG_OFF "off"   
  
/*
 * Command classification
 */
#define ngcppCMD_UNPROTECTED 0  
#define ngcppCMD_PROTECTED   1  

typedef struct {
  ngcpp_link_t link;   
  char srvName[256];   
  char active;         
  char connected;      
  char protectedMode;  
  char forceCommand;   
} ngcpp_shell_t;

typedef int (*ngcppCMD_HANDLER)(ngcpp_shell_t *, char *, FILE *, char *);

typedef struct {
  const char cmd[16];           
  const char syntax[32];        
  const char help[64];          
  int protectedFlag;            
  ngcppCMD_HANDLER cmdHandler;  
} ngcpp_shell_cmd;
 

int ngcppHandleAbort(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
             char *erms);

int ngcppHandleQuit(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleExit(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleTerm(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleHelp(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleStatus(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
              char *erms);

int ngcppHandleStart(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
             char *erms);

int ngcppHandleStop(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandlePause(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
             char *erms);

int ngcppHandleContinue(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
            char *erms);

int ngcppHandlePset(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandlePget(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandlePstat(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
             char *erms);

int ngcppHandlePsync(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
             char *erms);

int ngcppHandleConf(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleDynCmd(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
              char *erms);

int ngcppHandleRmode(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
             char *erms);

int ngcppHandleDataPath(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
            char *erms);

int ngcppHandleKill(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleConnect(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
               char *erms);

int ngcppHandleVerbose(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
               char *erms);

int ngcppHandleTime(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleSimTime(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
               char *erms);

int ngcppHandleSimDelay(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
            char *erms);

int ngcppHandleMemSet(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
              char *erms);

int ngcppHandleMemClose(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleMemSync(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
               char *erms);

int ngcppHandleFlush(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
             char *erms);

int ngcppHandleEnd(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
           char *erms);

int ngcppHandleRstCnt(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
              char *erms);

int ngcppHandleForceCmd(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleProtectCmd(ngcpp_shell_t *stat, char *cmdLine, FILE *rs, 
              char *erms);

int ngcppHandleFileBase(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleFilePath(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleUsrCmd(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
              char *erms);

int ngcppHandleChipOff(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
               char *erms);

int ngcppHandleChan(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
            char *erms);

int ngcppHandleTestF(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
             char *erms);

int ngcppHandleTimeout(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
               char *erms);

int ngcppHandleIoRead(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
              char *erms);

int ngcppHandleIoWrite(ngcpp_shell_t *stat, char *cmdLine, FILE *rs,
               char *erms);

int ngcppHelp(FILE *rs, char *cmd);

int ngcppShell(void *argp);
 
#ifdef __cplusplus
}
#endif
 
#endif