[Refacto] removing group description

Author: lucocozz

benchmarks/benchmark_release_mode.c

@@ -12,20 +12,20 @@ ARGUS_OPTIONS(
     HELP_OPTION(),
     VERSION_OPTION(),
 
-    GROUP_START("Input Options", GROUP_DESC("Options related to input")),
+    GROUP_START("Input Options"),
         OPTION_FLAG('v', "verbose", HELP("Enable verbose output")),
         OPTION_STRING('i', "input", HELP("Input file"), DEFAULT("input.txt")),
         OPTION_ARRAY_STRING('I', "include", HELP("Include files"), FLAGS(FLAG_SORTED | FLAG_UNIQUE)),
     GROUP_END(),
 
-    GROUP_START("Output Options", GROUP_DESC("Options related to output")),
+    GROUP_START("Output Options"),
         OPTION_STRING('o', "output", HELP("Output file"), DEFAULT("output.txt")),
         OPTION_STRING('f', "format", HELP("Output format"),
             VALIDATOR(V_CHOICE_STR("text", "json", "xml", "binary"))),
         OPTION_FLAG('s', "silent", HELP("Suppress output"), CONFLICT("verbose")),
     GROUP_END(),
 
-    GROUP_START("Processing Options", GROUP_DESC("Options controlling processing")),
+    GROUP_START("Processing Options"),
         OPTION_INT('l', "level", HELP("Processing level"),
             VALIDATOR(V_RANGE(1, 10)), DEFAULT(5)),
         OPTION_INT('j', "jobs", HELP("Number of parallel jobs"),
@@ -35,7 +35,7 @@ ARGUS_OPTIONS(
         OPTION_MAP_STRING('D', "define", HELP("Define variables"), FLAGS(FLAG_SORTED_KEY)),
     GROUP_END(),
 
-    GROUP_START("Advanced Options", GROUP_DESC("Advanced configuration")),
+    GROUP_START("Advanced Options"),
         OPTION_FLAG('d', "debug", HELP("Enable debug mode")),
         OPTION_STRING('c', "config", HELP("Configuration file")),
         OPTION_ARRAY_INT('p', "ports", HELP("Port numbers"), FLAGS(FLAG_SORTED | FLAG_UNIQUE)),

docs/docs/appendices/cheat-sheet.md

@@ -260,12 +260,12 @@ endpoint_t *ep = (endpoint_t*)argus_get(&argus, "endpoint").as_ptr;
 ## // Groups
 
 ```c
-GROUP_START("Connection", GROUP_DESC("Network options")),
+GROUP_START("Connection"),
     OPTION_STRING('h', "host", HELP("Hostname")),
     OPTION_INT('p', "port", HELP("Port")),
 GROUP_END(),
 
-GROUP_START("Output", GROUP_DESC("Output options")),
+GROUP_START("Output"),
     OPTION_STRING('o', "output", HELP("Output file")),
     OPTION_STRING('f', "format", HELP("Format")),
 GROUP_END(),

docs/docs/fundamentals/help-and-errors.md

@@ -207,13 +207,13 @@ ARGUS_OPTIONS(
     options,
     HELP_OPTION(),
 
-    GROUP_START("Connection", GROUP_DESC("Network connection options")),
+    GROUP_START("Connection"),
         OPTION_STRING('H', "host", HELP("Server hostname"), DEFAULT("localhost")),
         OPTION_INT('p', "port", HELP("Server port"), DEFAULT(8080)),
         OPTION_FLAG('s', "secure", HELP("Use HTTPS")),
     GROUP_END(),
 
-    GROUP_START("Output", GROUP_DESC("Output formatting options")),
+    GROUP_START("Output"),
         OPTION_STRING('f', "format", HELP("Output format"), DEFAULT("json")),
         OPTION_FLAG('v', "verbose", HELP("Verbose output")),
     GROUP_END(),
@@ -538,14 +538,14 @@ ARGUS_OPTIONS(
     HELP_OPTION(),
 
     // Input/Output options
-    GROUP_START("Input/Output", GROUP_DESC("File and data handling options")),
+    GROUP_START("Input/Output"),
         OPTION_STRING('i', "input", HELP("Input file or directory")),
         OPTION_STRING('o', "output", HELP("Output destination")),
         OPTION_STRING('f', "format", HELP("Output format")),
     GROUP_END(),
 
     // Processing options  
-    GROUP_START("Processing", GROUP_DESC("Algorithm and performance options")),
+    GROUP_START("Processing"),
         OPTION_INT('t', "threads", HELP("Worker threads")),
         OPTION_FLOAT('q', "quality", HELP("Processing quality")),
         OPTION_FLAG('F', "fast", HELP("Use fast mode (lower quality)")),

examples/advanced_options.c

@@ -18,8 +18,7 @@ ARGUS_OPTIONS(
     OPTION_STRING('i', "input", HELP("Input file"), FLAGS(FLAG_REQUIRED)),
 
     // Compression options in an exclusive group (only one can be selected)
-    GROUP_START("Compression", GROUP_DESC("Compression options"), 
-                FLAGS(FLAG_EXCLUSIVE)),
+    GROUP_START("Compression", FLAGS(FLAG_EXCLUSIVE)),
         OPTION_FLAG('z', "gzip", HELP("Use gzip compression")),
         OPTION_FLAG('j', "bzip2", HELP("Use bzip2 compression")),
         OPTION_FLAG('Z', "lzma", HELP("Use lzma compression")),

includes/argus/internal/help.h

@@ -31,7 +31,6 @@ typedef struct option_entry_s
 typedef struct group_info_s
 {
     const char          *name;
-    const char          *description;
     option_entry_t      *options;
     struct group_info_s *next;
 } group_info_t;
@@ -68,10 +67,9 @@ void add_option_to_list(option_entry_t **list, const argus_option_t *option);
  *
  * @param data         Help data structure
  * @param name         Group name
- * @param description  Group description
  * @return             Group info structure or NULL on failure
  */
-group_info_t *find_or_create_group(help_data_t *data, const char *name, const char *description);
+group_info_t *find_or_create_group(help_data_t *data, const char *name);
 
 /**
  * Organize options into categories for display

includes/argus/options.h

@@ -67,9 +67,9 @@ ARGUS_API char *format_choices_validator(validator_data_t data);
  * Optional option fields macros
  */
 #ifdef ARGUS_DEBUG
-# define ARGUS_DEBUG_INFO()            .line = __LINE__, .file = __FILE__
+# define ARGUS_DEBUG_INFO        .line = __LINE__, .file = __FILE__
 #else
-# define ARGUS_DEBUG_INFO()            .line = 0, .file = NULL
+# define ARGUS_DEBUG_INFO        .line = 0, .file = NULL
 #endif /* ARGUS_DEBUG */
 #define DEFINE_NAME(lname, sname) ((lname) ? (lname) : CHAR_TO_STRING(sname))
 #define DEFAULT(val)            .value = (argus_value_t){ .raw = (uintptr_t)(val) },         \
@@ -82,7 +82,6 @@ ARGUS_API char *format_choices_validator(validator_data_t data);
 #define HINT(_hint)             .hint = _hint
 #define REQUIRE(...)            .require = (const char*[]){__VA_ARGS__, NULL}
 #define CONFLICT(...)           .conflict = (const char*[]){__VA_ARGS__, NULL}
-#define GROUP_DESC(desc)        .help = desc
 #define HELP(desc)              .help = desc
 #define FLAGS(_flags)           .flags = _flags
 #define ENV_VAR(name)           .env_name = name
@@ -143,30 +142,30 @@ ARGUS_API char *format_choices_validator(validator_data_t data);
     .type = TYPE_NONE, \
     .name = NULL, \
     .value_type = VALUE_TYPE_NONE, \
-    ARGUS_DEBUG_INFO() \
+    ARGUS_DEBUG_INFO \
 }
 
 #define OPTION_BASE(_short, _long, _value_type, ...)                                          \
     (argus_option_t) {                                                                        \
         .type = TYPE_OPTION, .name = DEFINE_NAME(_long, _short),                              \
         .sname = _short, .lname = _long, .value_type = _value_type,                           \
-        .free_handler = default_free, ARGUS_DEBUG_INFO(), ##__VA_ARGS__                       \
+        .free_handler = default_free, ARGUS_DEBUG_INFO, ##__VA_ARGS__                       \
     }
 
 #define POSITIONAL_BASE(_name, _value_type, ...)                                               \
     (argus_option_t) {                                                                         \
         .type = TYPE_POSITIONAL, .name = _name, .value_type = _value_type,                     \
-        .free_handler = default_free, .flags = FLAG_REQUIRED, ARGUS_DEBUG_INFO(), ##__VA_ARGS__     \
+        .free_handler = default_free, .flags = FLAG_REQUIRED, ARGUS_DEBUG_INFO, ##__VA_ARGS__     \
     }
 
 #define GROUP_BASE(_name, ...)                                                                 \
     (argus_option_t) {                                                                         \
-        .type = TYPE_GROUP, .name = _name, ARGUS_DEBUG_INFO(), ##__VA_ARGS__                        \
+        .type = TYPE_GROUP, .name = _name, ARGUS_DEBUG_INFO, ##__VA_ARGS__                        \
     }
 
 #define SUBCOMMAND_BASE(_name, sub_opts, ...)                                                  \
     (argus_option_t) {                                                                         \
-        .type = TYPE_SUBCOMMAND, .name = _name, .sub_options = sub_opts, ARGUS_DEBUG_INFO(), ##__VA_ARGS__  \
+        .type = TYPE_SUBCOMMAND, .name = _name, .sub_options = sub_opts, ARGUS_DEBUG_INFO, ##__VA_ARGS__  \
     }
 
 // clang-format on

source/display/help/help_organizer.c

@@ -43,7 +43,7 @@ void add_option_to_list(option_entry_t **list, const argus_option_t *option)
     }
 }
 
-group_info_t *find_or_create_group(help_data_t *data, const char *name, const char *description)
+group_info_t *find_or_create_group(help_data_t *data, const char *name)
 {
     group_info_t *group = data->groups;
     while (group != NULL) {
@@ -57,7 +57,6 @@ group_info_t *find_or_create_group(help_data_t *data, const char *name, const ch
         return NULL;
 
     group->name        = name;
-    group->description = description;
     group->options     = NULL;
     group->next        = NULL;
 
@@ -76,7 +75,6 @@ group_info_t *find_or_create_group(help_data_t *data, const char *name, const ch
 void organize_options(const argus_option_t *options, help_data_t *data)
 {
     const char   *current_group      = NULL;
-    const char   *current_group_desc = NULL;
     group_info_t *group              = NULL;
 
     for (int i = 0; options[i].type != TYPE_NONE; ++i) {
@@ -85,7 +83,6 @@ void organize_options(const argus_option_t *options, help_data_t *data)
         switch (option->type) {
             case TYPE_GROUP:
                 current_group      = option->name;
-                current_group_desc = option->help;
                 group              = NULL;
                 break;
 
@@ -95,7 +92,7 @@ void organize_options(const argus_option_t *options, help_data_t *data)
 
                 if (current_group != NULL) {
                     if (group == NULL)
-                        group = find_or_create_group(data, current_group, current_group_desc);
+                        group = find_or_create_group(data, current_group);
                     add_option_to_list(&group->options, option);
                 } else
                     add_option_to_list(&data->ungrouped, option);

source/display/help/help_renderer.c

@@ -116,7 +116,7 @@ void print_help_sections(argus_t *argus, help_data_t *data)
         group_info_t *group = data->groups;
         while (group != NULL) {
             if (group->options != NULL) {
-                printf("\n%s:\n", group->description ? group->description : group->name);
+                printf("\n%s:\n", group->name);
                 print_option_list(argus, group->options, argus->helper.config.option_indent);
             }
             group = group->next;

tests/integration/test_post_validation.c

@@ -20,7 +20,7 @@ ARGUS_OPTIONS(
 ARGUS_OPTIONS(
     group_options,
     HELP_OPTION(),
-    GROUP_START("Compression", GROUP_DESC("Compression options"), FLAGS(FLAG_EXCLUSIVE)),
+    GROUP_START("Compression", FLAGS(FLAG_EXCLUSIVE)),
         OPTION_FLAG('z', "gzip", HELP("Use gzip compression")),
         OPTION_FLAG('j', "bzip2", HELP("Use bzip2 compression")),
     GROUP_END(),