---

GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> CLI / V0-1-1 > TV / linux-gcc

---

         

---

CLI_pubdefs.h File Reference

Standard public include file for the CLI package. More...

#include <time.h>
#include "CLI/CLI_msgs.h"

Defines
#define	CLI_L_TIMESTAMP   20
#define	CLI_O_NEGATE   0x0001
#define	CLI_O_VALUE   0x0002
#define	CLI_O_NOVALUE   0x0004
#define	CLI_O_REQUIRED   0x0008
#define	CLI_T_LIST   0x0100
#define	CLI_T_INTEGER   0x0200
#define	CLI_T_FLOAT   0x0400
#define	CLI_T_KEYWORD   0x0800
#define	CLI_T_RESTOFLINE   0x1000
#define	CLI_T_NEWSNTX   0x2000
#define	CLI_T_TIMESTAMP   0x4000
Typedefs
typedef enum _CLI_Timezone	CLI_Timezone
	Typedef for enum _CLI_Timezone.
typedef struct _CLI_KeyDef	CLI_KeyDef
	Typedef for struct _CLI_KeyDef.
typedef struct _CLI_KeyList	CLI_KeyList
	Typedef for struct _CLI_KeyList.
typedef struct _CLI_ParmDef	CLI_ParmDef
	Typedef for struct _CLI_ParmDef.
typedef struct _CLI_QualDef	CLI_QualDef
	Typedef for struct _CLI_QualDef.
typedef struct _CLI_VerbDef	CLI_VerbDef
	Typedef for struct _CLI_VerbDef.
typedef struct _CLI_Syntax	CLI_Syntax
	Typedef for struct _CLI_Syntax.
typedef struct _CLI_Control	CLI_Control
	Typedef for struct _CLI_Control.
typedef unsigned int	CLI_CB_Func (CLI_Control *, void *)
	Typedef for a CLI verb callback routine.
Enumerations
enum	_CLI_Timezone {   CLI_K_TIMEZONE_LOCAL = 0,   CLI_K_TIMEZONE_UTC = 1 }
	Enumeration of enumeration tables FMX recognizes (!). More...
Functions
CLI_KeyDef *	CLI_addKey (const CLI_KeyList *list, const char *name)
CLI_ParmDef *	CLI_addParm (CLI_VerbDef *verb, unsigned short opts, unsigned short type, void *sork)
CLI_QualDef *	CLI_addQual (CLI_VerbDef *verb, const char *text, unsigned short opts, unsigned short type, CLI_KeyList *list)
CLI_VerbDef *	CLI_addVerb (const CLI_Syntax *sntx, const char *name, const char *call, CLI_CB_Func *func)
CLI_Syntax *	CLI_createSyntax (const char *name)
unsigned int	CLI_command (const char *ilin, const char *prompt, const CLI_Syntax *syntax, void *user)
CLI_KeyList *	CLI_createKeyList (const char *name)
unsigned int	CLI_getValue (const CLI_Control *ctl, const char *text, const char **valu)
time_t	CLI_timeString2Unix (const char *text, CLI_Timezone zone)
void	CLI_timeUnix2String (time_t time, char *text, CLI_Timezone zone)
unsigned int	CLI_present (CLI_Control *ctl, const char *text)
void	CLI_stitchCommandFree (char *line)
char *	CLI_stitchCommandLine (int argc, char *argv[])

---

Detailed Description

Standard public include file for the CLI package.

CVS $Id: CLI_pubdefs.h,v 1.5 2009/08/12 00:25:45 apw Exp $

Author:

A.P.Waite - apw@slac.stanford.edu

The standard CLI user interface is available through this file. It provides the function prototypes for the callable routines as well as a set of macros needed to access them sensibly.

The other public interface file CLI_dmpdefs.h should only be included in cases where access to the debugging/dumping routines is also required (in which case the shareable clidmp.so must be added to the calling program's link step ... see "TV" for an example of how to do this).

---

Typedef Documentation

unsigned int CLI_CB_Func

Typedef for a CLI verb callback routine.

This defines the signature of a CLI callback function. The first argument is an opaque pointer to a CLI control structure. It should be passed through unaltered as the first argument to the CLI_getValue() and CLI_present() routines. The second argument is simply the user argument which was given in the call to CLI_command(). It's provided for the user to pass context through to the callback routines.

---

Enumeration Type Documentation

enum _CLI_Timezone

Enumeration of enumeration tables FMX recognizes (!).

Enumerator:

CLI_K_TIMEZONE_LOCAL	Convert in date in local timezone
CLI_K_TIMEZONE_UTC	Convert as date in UTC

---