CLISH: clish/param.h Source File

00001 /*
00002  * param.h
00003  */
00015 #ifndef _clish_param_h
00016 #define _clish_param_h
00017 
00018 typedef struct clish_param_s clish_param_t;
00019 
00020 #include "clish/ptype.h"
00021 
00022 /*=====================================
00023  * PARAM INTERFACE
00024  *===================================== */
00025 /*-----------------
00026  * meta functions
00027  *----------------- */
00028 clish_param_t *
00029     clish_param_new(const char    *name,
00030                     const char    *text,
00031                     clish_ptype_t *ptype);
00032 /*-----------------
00033  * methods
00034  *----------------- */
00035 void
00036     clish_param_delete(clish_param_t *instance);
00037 void
00038     clish_param_help(const clish_param_t *instance,
00039                      size_t               offset);
00040 char * 
00041     clish_param_validate(const clish_param_t *instance,
00042                          const char          *text);
00043 void
00044     clish_param_dump(const clish_param_t *instance);
00045 /*-----------------
00046  * attributes
00047  *----------------- */
00048 const char *
00049     clish_param__get_name(const clish_param_t *instance);
00050 const char *
00051     clish_param__get_text(const clish_param_t *instance);
00052 const char *
00053     clish_param__get_range(const clish_param_t *instance);
00054 const char *
00055     clish_param__get_prefix(const clish_param_t *instance);
00056 const char *
00057     clish_param__get_default(const clish_param_t *instance);
00058 clish_ptype_t *
00059     clish_param__get_ptype(const clish_param_t *instance);
00060 void
00061     clish_param__set_prefix(clish_param_t *instance,
00062                             const char    *prefix);
00063 void
00064     clish_param__set_default(clish_param_t *instance,
00065                              const char    *defval);
00066 
00067 #endif /* _clish_param_h */
00068