cli.h

Go to the documentation of this file.

 
#ifndef das2_2_cli_H_
#define das2_2_cli_H_
 
#include <das2/das1.h>
 
#include <string.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define OP_BEG ".ge."
#define OP_END ".lt."
#define OP_EQ  ".eq."
#define OP_NE  ".ne."
#define OP_LT  ".lt."
#define OP_GT  ".gt."
#define OP_LE  ".le."
#define OP_GE  ".ge."
 
enum das_selfmt{bool_t, int_t, real_t, string_t, timept_t};
 
#define REQUIRED    0x00
#define OPTIONAL    0x01
#define ENUM        0x02
#define INTERVAL    0x04
#define XLATE_GE_LT 0x08  /* Use .beg. and .end. synonyms for .ge. and .lt. 
                           when providing user text for this selector. */
                                 
#define SHOW_DEFAULT 0x10  /* Show the default values in the help text */
 
typedef struct das_selector_t{
   
   const char* sKey;
   
   enum das_selfmt  nFmt;
   
   unsigned int nFlags;
      
   const char** psBounds;
   
   /* A major design oversight:  Should be allowed to place the default
      values here.  Since we can't do that the user ends up re-specifing
      them all over the place in their programs which invites bugs! */
   /* const char** psDefaults; */
   
   const char* sSummary;
   
   char** psValues;
   
}DasSelector;
 
 
const char* das_get_selstr(const DasSelector* pSels, const char* sKey, 
                       const char* sOp, const char* sDefault);
 
const char* das_selstr(const DasSelector* pSel, const char* sOp, 
                    const char* sDefault);
 
int das_get_selint(const DasSelector* pSels, const char* sKey,
               const char* sOp, int nDefault);
 
int das_selint(const DasSelector* pSel, const char* sOp, int nDefault);
 
 
bool das_get_selbool(const DasSelector* pSels, const char* sKey, bool bDefault);
 
bool das_selbool(const DasSelector* pSel, bool bDefault);
 
 
double das_get_selreal(const DasSelector* pSels, const char* sKey, 
                   const char* sOp, double rDefault);
 
double das_selreal(const DasSelector* pSel, const char* sOp, double rDefault);
 
 
void das_get_seltime(const DasSelector* pSels, const char* sKey, const char* sOp,
        int* yr, int* mon, int* dom, int* doy, int* hr, int* min, double* sec);
 
void das_seltime(const DasSelector* pSel, const char* sOp, int* yr, int* mon,
              int* dom, int* doy, int* hr, int* min, double* sec);
 
void das_get_seldastime(
   const DasSelector* pSels, const char* sKey, const char* sOp, das_time* pDt
);
 
void das_seldastime(const DasSelector* pSel, const char* sOp, das_time* pDt);
 
 
const char* das_get_selenum(const DasSelector* pSels, const char* sKey, 
                            const char* sDefault);
 
const char* das_selenum(const DasSelector* pSel, const char* sDefault);
 
 
#define DAS_OUT_DISABLE  0x0200 
 
typedef struct das_output_t{
   
   const char* sKey;
   
   const char* sUnits;
   
   unsigned int nOpts;
   
   const char** psDepends;
 
   const char* sSummary;
      
   char* sInterval;
   
}DasOutput;
 
 
bool das_get_outenabled(const DasOutput* pOuts, const char* sKey);
 
bool das_outenabled(const DasOutput* pOut);
 
double das_get_outinterval(const DasOutput* pOuts, const char* sKey, 
                          double rDefault);
 
double das_outinterval(const DasOutput* pOut, double rDefault);
 
const char* das_get_outunit(const DasOutput* pOut);
 
 
void das_parsecmdline(int nArgs, char** sArgs, DasSelector* pSels, 
                      DasOutput* pOuts, const char* sDesc, const char* sFooter);
 
 
const char* das_progname();
 
#define DAS_LL_CRIT   100  /* same as java.util.logging.Level.SEVERE */
#define DAS_LL_ERROR   80  
#define DAS_LL_WARN    60  /* same as java.util.logging.Level.WARNING */
#define DAS_LL_INFO    40  /* same as java.util.logging.Level.INFO & CONFIG */
#define DAS_LL_DEBUG   20  /* same as java.util.logging.Level.FINE */
#define DAS_LL_TRACE    0  /* same as java.util.logging.Level.FINER & FINEST */
 
int das_loglevel();
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* das2_2_cli_H_ */