Merge pull request #48 from lucocozz/43-argus-debug

[Refacto] Change `ARGUS_RELEASE` into `ARGUS_DEBUG`

Author: lucocozz

CHANGELOG.md

@@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Printing subcommand list on command execution that cannot be executed directly.
 
+### Changed
+- Change `ARGUS_RELEASE` into `ARGUS_DEBUG`
+
 ### Fixed
 - Defining `argus_init()` as a `static inline` function.
 

docs/docs/getting-started/quickstart.md

@@ -66,16 +66,13 @@ int main(int argc, char **argv)
 
 ```bash
 # Development build (recommended during development)
-gcc my_tool.c -o my_tool -largus
+gcc -DARGUS_DEBUG my_tool.c -o my_tool -largus
 ./my_tool --help    # See auto-generated help
 ./my_tool input.txt # Run your tool
-
-# Production build (skip validation for better performance)
-gcc -DARGUS_RELEASE my_tool.c -o my_tool-prod -largus
 ```
 
-:::tip Production Note
-Use `ARGUS_RELEASE` only in production after thorough testing. It disables option structure validation for faster startup time.
+:::tip Development Note
+Use `ARGUS_DEBUG` to enable option structure validation and catch configuration errors early.
 :::
 
 ## // What You Get For Free

includes/argus/api.h

@@ -27,21 +27,18 @@ ARGUS_API argus_t _argus_init_validate(argus_option_t *options, const char *prog
  * @return Initialized argus_t context
  *
  * @note
- * Define `ARGUS_RELEASE` when compiling your application to skip
- * options structure validation and improve performance.
+ * Define `ARGUS_DEBUG` when compiling your application to enable
+ * options structure validation.
  *
- * Example: `gcc -DARGUS_RELEASE my_program.c -o my_program -largus`
- *
- * Note: Only use this in production. During development, leave validation
- * enabled to catch configuration errors early.
+ * Example: `gcc -DARGUS_DEBUG my_program.c -o my_program -largus`
  */
 static inline argus_t argus_init(argus_option_t *options, const char *program_name,
                                  const char *version)
 {
-#ifdef ARGUS_RELEASE
-    return _argus_init_validate(options, program_name, version, false);
-#else
+#ifdef ARGUS_DEBUG
     return _argus_init_validate(options, program_name, version, true);
+#else
+    return _argus_init_validate(options, program_name, version, false);
 #endif
 }
 

includes/argus/options.h

@@ -61,7 +61,11 @@ ARGUS_API char *format_choices_validator(validator_data_t data);
 /*
  * Optional option fields macros
  */
-#define DEBUG_INFO()            .line = __LINE__, .file = __FILE__
+#ifdef ARGUS_DEBUG
+# define ARGUS_DEBUG_INFO()            .line = 0, .file = NULL
+#else
+# define ARGUS_DEBUG_INFO()            .line = __LINE__, .file = __FILE__
+#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) },         \
                                 .default_value = (argus_value_t){ .raw = (uintptr_t)(val) }, \
@@ -134,30 +138,30 @@ ARGUS_API char *format_choices_validator(validator_data_t data);
     .type = TYPE_NONE, \
     .name = NULL, \
     .value_type = VALUE_TYPE_NONE, \
-    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, 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, 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, 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, DEBUG_INFO(), ##__VA_ARGS__  \
+        .type = TYPE_SUBCOMMAND, .name = _name, .sub_options = sub_opts, ARGUS_DEBUG_INFO(), ##__VA_ARGS__  \
     }
 
 // clang-format on

tests/unit/meson.build

@@ -26,36 +26,36 @@ foreach test : unit_tests
   )
 endforeach
 
-release_mode_test_sources = files('test_core/test_release_mode.c')
+debug_mode_test_sources = files('test_core/test_debug_mode.c')
 
-# Build and run the test in normal mode (validation enabled)
-test_release_mode_do_validation = executable(
-  'test_release_mode_do_validation',
-  release_mode_test_sources,
+# Build and run the test in debug mode (validation enabled)
+test_debug_mode_do_validation = executable(
+  'test_debug_mode_do_validation',
+  debug_mode_test_sources,
   dependencies: [criterion_dep, argus_dep],
   include_directories: test_includes,
   c_args: test_args
 )
 
 test(
-  'unit_release_mode_do_validation',
-  test_release_mode_do_validation,
+  'unit_debug_mode_do_validation',
+  test_debug_mode_do_validation,
   env: test_env,
   timeout: 30
 )
 
-# Build and run the test in release mode (validation disabled)
-test_release_skip_validation = executable(
-  'test_release_mode_skip_validation',
-  release_mode_test_sources,
+# Build and run the test in standard mode (validation disabled)
+test_debug_skip_validation = executable(
+  'test_debug_mode_skip_validation',
+  debug_mode_test_sources,
   dependencies: [criterion_dep, argus_dep],
   include_directories: test_includes,
-  c_args: test_args + ['-DARGUS_RELEASE'],
+  c_args: test_args + ['-DARGUS_DEBUG'],
 )
 
 test(
-  'unit_release_mode_skip_validation',
-  test_release_skip_validation,
+  'unit_debug_mode_skip_validation',
+  test_debug_skip_validation,
   env: test_env,
   timeout: 30
 )

tests/unit/test_core/test_release_mode.c tests/unit/test_core/test_debug_mode.ctests/unit/test_core/test_release_mode.c renamed to tests/unit/test_core/test_debug_mode.c

@@ -16,28 +16,28 @@ ARGUS_OPTIONS(
     POSITIONAL_STRING("input"),
 )
 
-#ifndef ARGUS_RELEASE
+#ifdef ARGUS_DEBUG
 
-Test(release_mode, perform_validation, .exit_code = 1, .init = cr_redirect_stderr)
+Test(debug_mode, perform_validation, .exit_code = 1, .init = cr_redirect_stderr)
 {
     argus_t argus = argus_init(invalid_options, "test_program", "1.0.0");
 
-    // In release mode, the library should not validate options
+    // In debug mode, the library should validate options
     cr_assert_gt(argus.error_code, 0,
-                 "Errors should be reported in release mode");
+                 "Errors should be reported in debug mode");
 
     argus_free(&argus);
 }
 
 #else
 
-Test(release_mode, skip_validation)
+Test(debug_mode, skip_validation)
 {
     argus_t argus = argus_init(invalid_options, "test_program", "1.0.0");
 
-    // In debug mode, the library should validate options
-    cr_assert_eq(argus.error_code, 0, 
-                 "Errors should be reported in debug mode");
+    // In standard mode, the library should not validate options
+    cr_assert_eq(argus.error_code, 0,
+                 "Errors should not be reported in standard mode");
 
     argus_free(&argus);
 }