CLISH  0.7.3
param.h
1 /*
2  * param.h
3  */
15 #ifndef _clish_param_h
16 #define _clish_param_h
17 
18 typedef struct clish_param_s clish_param_t;
19 
20 #include "clish/ptype.h"
21 
22 /*=====================================
23  * PARAM INTERFACE
24  *===================================== */
25 /*-----------------
26  * meta functions
27  *----------------- */
28 clish_param_t *
29  clish_param_new(const char *name,
30  const char *text,
31  clish_ptype_t *ptype);
32 /*-----------------
33  * methods
34  *----------------- */
35 void
36  clish_param_delete(clish_param_t *instance);
37 void
38  clish_param_help(const clish_param_t *instance,
39  size_t offset);
40 char *
41  clish_param_validate(const clish_param_t *instance,
42  const char *text);
43 void
44  clish_param_dump(const clish_param_t *instance);
45 /*-----------------
46  * attributes
47  *----------------- */
48 const char *
49  clish_param__get_name(const clish_param_t *instance);
50 const char *
51  clish_param__get_text(const clish_param_t *instance);
52 const char *
53  clish_param__get_range(const clish_param_t *instance);
54 const char *
55  clish_param__get_prefix(const clish_param_t *instance);
56 const char *
57  clish_param__get_default(const clish_param_t *instance);
58 clish_ptype_t *
59  clish_param__get_ptype(const clish_param_t *instance);
60 void
61  clish_param__set_prefix(clish_param_t *instance,
62  const char *prefix);
63 void
64  clish_param__set_default(clish_param_t *instance,
65  const char *defval);
66 
67 #endif /* _clish_param_h */
68