environment.h File Reference

ENVIRONMENT section generator for man pages. More...

Go to the source code of this file.

Functions
char *	manpage_content_generate_environment (const options_config_t *config)
	Generate ENVIRONMENT VARIABLES section content.
char *	manpage_content_generate_environment_with_manual (const options_config_t *config, const char **manual_vars, size_t manual_count, const char **manual_descs)
	Generate ENVIRONMENT section with manual and auto variables.
void	manpage_content_free_environment (char *content)
	Free generated environment content.

Detailed Description

ENVIRONMENT section generator for man pages.

Generates the ENVIRONMENT section from environment variable metadata in option descriptors.

Definition in file environment.h.

Function Documentation

manpage_content_free_environment()

void manpage_content_free_environment

(

char *

content

)

Free generated environment content.

Parameters

[in]

content

Content to free (can be NULL)

Definition at line 152 of file environment.c.

                                                     {
  if (content) {
    SAFE_FREE(content);
  }
}

References SAFE_FREE.

Referenced by options_config_generate_manpage_template().

manpage_content_generate_environment()

char * manpage_content_generate_environment

(

const options_config_t *

config

)

Generate ENVIRONMENT VARIABLES section content.

Extracts environment variables from option descriptors and generates formatted ENVIRONMENT section with sorted variable names.

Parameters

[in]

config

Options configuration with descriptors

Returns

Newly allocated content string (caller must free)

Definition at line 14 of file environment.c.

                                                                           {
  if (!config || config->num_descriptors == 0) {
    char *buffer = SAFE_MALLOC(1, char *);
    buffer[0] = '\0';
    return buffer;
  }
 
  // Generate only ASCII_CHAT_* environment variables from config
  // Manual variables are preserved from the template
  size_t buffer_capacity = 32768;
  char *buffer = SAFE_MALLOC(buffer_capacity, char *);
  size_t offset = 0;
 
  // Iterate through all option descriptors
  for (size_t i = 0; i < config->num_descriptors; i++) {
    const option_descriptor_t *desc = &config->descriptors[i];
 
    // Only include descriptors that have environment variable names
    if (!desc->env_var_name) {
      continue;
    }
 
    // Ensure buffer is large enough
    if (offset + 512 >= buffer_capacity) {
      buffer_capacity *= 2;
      buffer = SAFE_REALLOC(buffer, buffer_capacity, char *);
    }
 
    log_debug("[ENVIRONMENT] env=%s, desc=%s", desc->env_var_name ? desc->env_var_name : "NULL",
              desc->help_text ? desc->help_text : "NULL");
 
    // Generate .TP tagged paragraph for this environment variable
    offset += safe_snprintf(buffer + offset, buffer_capacity - offset, ".TP\n");
    offset += safe_snprintf(buffer + offset, buffer_capacity - offset, ".B %s\n", desc->env_var_name);
 
    if (desc->help_text) {
      offset += safe_snprintf(buffer + offset, buffer_capacity - offset, "%s\n", desc->help_text);
    }
  }
 
  log_debug("Generated ENVIRONMENT ASCII_CHAT_* section (%zu bytes)", offset);
  return buffer;
}

References buffer_capacity(), options_config_t::descriptors, option_descriptor_t::env_var_name, option_descriptor_t::help_text, log_debug, options_config_t::num_descriptors, SAFE_MALLOC, SAFE_REALLOC, and safe_snprintf().

Referenced by options_config_generate_manpage_template().

manpage_content_generate_environment_with_manual()

char * manpage_content_generate_environment_with_manual	(	const options_config_t *	config,
		const char **	manual_vars,
		size_t	manual_count,
		const char **	manual_descs )

Generate ENVIRONMENT section with manual and auto variables.

Combines manual environment variables (from template) with ASCII_CHAT_* variables from config, sorts them all alphabetically, and generates formatted ENVIRONMENT section content.

Parameters

[in]	config	Options configuration with descriptors
[in]	manual_vars	Array of manual variable names (can be NULL)
[in]	manual_count	Number of manual variables
[in]	manual_descs	Array of manual variable descriptions (can be NULL)

Returns

Newly allocated content string (caller must free)

Definition at line 75 of file environment.c.

                                                                                                       {
 
  if (!config) {
    char *buffer = SAFE_MALLOC(1, char *);
    buffer[0] = '\0';
    return buffer;
  }
 
  // Count how many ASCII_CHAT_* variables we have
  size_t num_auto_vars = 0;
  for (size_t i = 0; i < config->num_descriptors; i++) {
    if (config->descriptors[i].env_var_name) {
      num_auto_vars++;
    }
  }
 
  // Allocate array for all variables
  size_t total_vars = num_auto_vars + manual_count;
  env_var_entry_t *all_vars = SAFE_MALLOC(total_vars * sizeof(env_var_entry_t), env_var_entry_t *);
  size_t var_idx = 0;
 
  // Copy auto-generated variables from config
  for (size_t i = 0; i < config->num_descriptors; i++) {
    const option_descriptor_t *desc = &config->descriptors[i];
    if (desc->env_var_name) {
      all_vars[var_idx].name = desc->env_var_name;
      all_vars[var_idx].description = desc->help_text ? desc->help_text : "";
      all_vars[var_idx].option_long_name = desc->long_name; // Store for reference
      var_idx++;
    }
  }
 
  // Add manual variables
  for (size_t i = 0; i < manual_count && var_idx < total_vars; i++) {
    all_vars[var_idx].name = manual_vars[i];
    all_vars[var_idx].description = (manual_descs && manual_descs[i]) ? manual_descs[i] : "";
    all_vars[var_idx].option_long_name = NULL; // Manual variables have no option reference
    var_idx++;
  }
 
  // Sort all variables alphabetically
  qsort(all_vars, total_vars, sizeof(env_var_entry_t), env_var_compare);
 
  // Generate output buffer with all environment variables
  size_t buffer_capacity = 32768;
  char *buffer = SAFE_MALLOC(buffer_capacity, char *);
  size_t offset = 0;
 
  // Write all environment variables in sorted order
  for (size_t i = 0; i < total_vars; i++) {
    if (offset + 512 >= buffer_capacity) {
      buffer_capacity *= 2;
      buffer = SAFE_REALLOC(buffer, buffer_capacity, char *);
    }
 
    offset += safe_snprintf(buffer + offset, buffer_capacity - offset, ".TP\n");
    offset += safe_snprintf(buffer + offset, buffer_capacity - offset, ".B %s\n", all_vars[i].name);
    if (*all_vars[i].description) {
      if (all_vars[i].option_long_name) {
        // For auto-generated variables, just reference the flag
        offset += safe_snprintf(buffer + offset, buffer_capacity - offset, "See: \\fB\\-\\-%s\\fR\n",
                                all_vars[i].option_long_name);
      } else {
        // For manual variables, show full description
        offset += safe_snprintf(buffer + offset, buffer_capacity - offset, "%s\n", all_vars[i].description);
      }
    }
  }
 
  SAFE_FREE(all_vars);
 
  log_debug("Generated ENVIRONMENT section (%zu manual + %zu auto = %zu total, %zu bytes)", manual_count, num_auto_vars,
            total_vars, offset);
  return buffer;
}

References buffer_capacity(), env_var_entry_t::description, options_config_t::descriptors, option_descriptor_t::env_var_name, option_descriptor_t::help_text, log_debug, option_descriptor_t::long_name, env_var_entry_t::name, options_config_t::num_descriptors, env_var_entry_t::option_long_name, SAFE_FREE, SAFE_MALLOC, SAFE_REALLOC, and safe_snprintf().