1
0

param.h 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /*
  2. * param.h
  3. */
  4. /**
  5. \ingroup clish
  6. \defgroup clish_param param
  7. @{
  8. \brief This class represents an instance of a parameter type.
  9. Parameter instances are assocated with a command line and used to validate the
  10. the arguments which a user is inputing for a command.
  11. */
  12. #ifndef _clish_param_h
  13. #define _clish_param_h
  14. typedef struct clish_paramv_s clish_paramv_t;
  15. typedef struct clish_param_s clish_param_t;
  16. #include "clish/types.h"
  17. #include "clish/ptype.h"
  18. #include "clish/pargv.h"
  19. /**
  20. * The means by which the param is interpreted.
  21. */
  22. typedef enum {
  23. /**
  24. * A common parameter.
  25. */
  26. CLISH_PARAM_COMMON,
  27. /**
  28. * A swich parameter.
  29. * Choose the only one of nested parameters.
  30. */
  31. CLISH_PARAM_SWITCH,
  32. /**
  33. * A subcomand.
  34. * Identified by it's name.
  35. */
  36. CLISH_PARAM_SUBCOMMAND
  37. } clish_param_mode_e;
  38. /*=====================================
  39. * PARAM INTERFACE
  40. *===================================== */
  41. /*-----------------
  42. * meta functions
  43. *----------------- */
  44. clish_param_t *clish_param_new(const char *name,
  45. const char *text, clish_ptype_t * ptype);
  46. /*-----------------
  47. * methods
  48. *----------------- */
  49. void clish_param_delete(clish_param_t * instance);
  50. void clish_param_help(const clish_param_t * instance, clish_help_t *help);
  51. void clish_param_help_arrow(const clish_param_t * instance, size_t offset);
  52. char *clish_param_validate(const clish_param_t * instance, const char *text);
  53. void clish_param_dump(const clish_param_t * instance);
  54. void clish_param_insert_param(clish_param_t * instance, clish_param_t * param);
  55. /*-----------------
  56. * attributes
  57. *----------------- */
  58. const char *clish_param__get_name(const clish_param_t * instance);
  59. const char *clish_param__get_text(const clish_param_t * instance);
  60. const char *clish_param__get_range(const clish_param_t * instance);
  61. const char *clish_param__get_default(const clish_param_t * instance);
  62. clish_ptype_t *clish_param__get_ptype(const clish_param_t * instance);
  63. void clish_param__set_default(clish_param_t * instance, const char *defval);
  64. void clish_param__set_mode(clish_param_t * instance, clish_param_mode_e mode);
  65. clish_param_mode_e clish_param__get_mode(const clish_param_t * instance);
  66. clish_param_t *clish_param__get_param(const clish_param_t * instance,
  67. unsigned index);
  68. const unsigned clish_param__get_param_count(const clish_param_t * instance);
  69. clish_paramv_t *clish_param__get_paramv(clish_param_t * instance);
  70. void clish_param__set_optional(clish_param_t * instance, bool_t optional);
  71. bool_t clish_param__get_optional(const clish_param_t * instance);
  72. void clish_param__set_value(clish_param_t * instance, const char * value);
  73. char *clish_param__get_value(const clish_param_t * instance);
  74. void clish_param__set_hidden(clish_param_t * instance, bool_t hidden);
  75. bool_t clish_param__get_hidden(const clish_param_t * instance);
  76. void clish_param__set_test(clish_param_t * instance, const char *test);
  77. char *clish_param__get_test(const clish_param_t * instance,
  78. const char * viewid, const clish_command_t * cmd,
  79. clish_pargv_t * pargv);
  80. /* paramv methods */
  81. clish_paramv_t *clish_paramv_new(void);
  82. void clish_paramv_delete(clish_paramv_t * instance);
  83. void clish_paramv_insert(clish_paramv_t * instance, clish_param_t * param);
  84. clish_param_t *clish_paramv__get_param(const clish_paramv_t * instance,
  85. unsigned index);
  86. const unsigned clish_paramv__get_count(const clish_paramv_t * instance);
  87. #endif /* _clish_param_h */
  88. /** @} clish_param */