help_api.c

Go to the documentation of this file.

 
#include <ascii-chat/options/options.h>
#include <ascii-chat/options/registry/core.h>
#include <string.h>
 
const char *options_get_help_text(asciichat_mode_t mode, const char *option_name) {
  if (!option_name || !option_name[0]) {
    return NULL;
  }
 
  // Get the registry (initializes size if needed)
  registry_init_size();
 
  // Search through all registered options
  for (size_t i = 0; i < g_registry_size; i++) {
    const registry_entry_t *entry = &g_options_registry[i];
 
    // Skip empty entries or entries without a long name
    if (!entry->long_name || !entry->long_name[0]) {
      continue;
    }
 
    // Check if this is the option we're looking for
    if (strcmp(entry->long_name, option_name) != 0) {
      continue;
    }
 
    // Check if this option applies to the requested mode
    // Convert mode to bitmask for comparison
    // Validate mode is in valid range (0-4) to avoid undefined behavior in bit shift
    if (mode < 0 || mode >= MODE_INVALID) {
      continue; // Skip invalid mode
    }
    uint32_t mode_bitmask = (1 << mode) | OPTION_MODE_BINARY;
 
    if ((entry->mode_bitmask & mode_bitmask) == 0) {
      // Option doesn't apply to this mode
      return NULL;
    }
 
    // Return the help text (or empty string if not set)
    return entry->help_text ? entry->help_text : "";
  }
 
  // Option not found
  return NULL;
}