resources.h File Reference

Resource management for man page generation. More...

Go to the source code of this file.

Data Structures
struct	manpage_resources_t
	Man page resource container. More...

Functions
asciichat_error_t	manpage_resources_load (manpage_resources_t *resources)
	Load man page resources from embedded or filesystem sources.
void	manpage_resources_destroy (manpage_resources_t *resources)
	Cleanup allocated man page resources.
bool	manpage_resources_is_valid (const manpage_resources_t *resources)
	Check if resources are available.

Detailed Description

Resource management for man page generation.

This module abstracts loading man page resources from either embedded (production) or filesystem (development) sources. Provides a clean interface for accessing template and content sections.

Definition in file resources.h.

Function Documentation

manpage_resources_destroy()

void manpage_resources_destroy

(

manpage_resources_t *

resources

)

Cleanup allocated man page resources.

Frees any dynamically allocated resources. Safe to call even if manpage_resources_load() failed or resources were from embedded binary.

Parameters

[in]

resources

Resources to cleanup (can be NULL)

Definition at line 147 of file resources.c.

                                                               {
  if (!resources) {
    return;
  }
 
  // Only free content if it was allocated (i.e., loaded from filesystem in debug builds)
  if (resources->allocated) {
#ifndef NDEBUG
    // In debug builds, template and content were allocated by load_single_resource
    if (resources->template_content) {
      char *template_ptr = (char *)resources->template_content;
      SAFE_FREE(template_ptr);
    }
    if (resources->content_sections) {
      char *content_ptr = (char *)resources->content_sections;
      SAFE_FREE(content_ptr);
    }
#endif
  }
 
  // Clear the structure
  resources->template_content = NULL;
  resources->template_len = 0;
  resources->content_sections = NULL;
  resources->content_len = 0;
  resources->is_embedded = false;
  resources->allocated = false;
}

References manpage_resources_t::allocated, manpage_resources_t::content_len, manpage_resources_t::content_sections, manpage_resources_t::is_embedded, SAFE_FREE, manpage_resources_t::template_content, and manpage_resources_t::template_len.

Referenced by options_config_generate_manpage_merged().

manpage_resources_is_valid()

bool manpage_resources_is_valid

(

const manpage_resources_t *

resources

)

Check if resources are available.

Returns true only if both template and content resources are loaded.

Parameters

[in]

resources

Resources to check (can be NULL)

Returns

true if resources are complete and valid

Definition at line 176 of file resources.c.

                                                                      {
  if (!resources) {
    return false;
  }
 
  // Resources are valid if template is loaded (content is now optional/merged into template)
  return resources->template_content != NULL && resources->template_len > 0;
}

References manpage_resources_t::template_content, and manpage_resources_t::template_len.

Referenced by options_config_generate_manpage_merged().

manpage_resources_load()

asciichat_error_t manpage_resources_load

(

manpage_resources_t *

resources

)

Load man page resources from embedded or filesystem sources.

Automatically selects resource source based on build type:

• Debug builds: Load from filesystem (share/man/man1/)
• Release builds: Load from embedded resources in binary

The caller should call manpage_resources_destroy() when done.

Parameters

[out]

resources

Populated with loaded resource pointers

Returns

ASCIICHAT_OK on success

ERROR_CONFIG if resources cannot be loaded

ERROR_INVALID_PARAM if resources is NULL

Note

On success, caller must call manpage_resources_destroy()

For embedded resources, no cleanup needed (pointers to static data)

For filesystem resources, content is allocated and must be freed

Definition at line 103 of file resources.c.

                                                                         {
  if (!resources) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "resources pointer cannot be NULL");
  }
 
  // Initialize to safe state
  resources->template_content = NULL;
  resources->template_len = 0;
  resources->content_sections = NULL;
  resources->content_len = 0;
  resources->is_embedded = false;
  resources->allocated = false;
 
  // Load template resource
  asciichat_error_t err = load_single_resource(&resources->template_content, &resources->template_len,
                                               get_manpage_template, "man page template");
  if (err != ASCIICHAT_OK) {
    return err;
  }
 
  // Content is now merged into template - no separate content file needed
  // Set to NULL so cleanup doesn't try to free a string literal
  resources->content_sections = NULL;
  resources->content_len = 0;
 
  // Determine if resources came from embedded binary
  // In production (NDEBUG), both would be embedded; in development, both would be files
#ifdef NDEBUG
  resources->is_embedded = true;
#else
  resources->is_embedded = false;
#endif
 
  // Mark that we may have allocated memory (only in debug builds for filesystem reads)
#ifdef NDEBUG
  resources->allocated = false;
#else
  resources->allocated = true;
#endif
 
  log_debug("Resources loaded successfully (embedded=%d, allocated=%d)", resources->is_embedded, resources->allocated);
  return ASCIICHAT_OK;
}

References manpage_resources_t::allocated, ASCIICHAT_OK, manpage_resources_t::content_len, manpage_resources_t::content_sections, ERROR_INVALID_PARAM, get_manpage_template(), manpage_resources_t::is_embedded, log_debug, SET_ERRNO, manpage_resources_t::template_content, and manpage_resources_t::template_len.

Referenced by options_config_generate_manpage_merged().