parser.h File Reference

Man page template parsing and section extraction. More...

Go to the source code of this file.

Functions
asciichat_error_t	manpage_parser_parse_file (FILE *f, parsed_section_t **out_sections, size_t *out_count)
	Parse man page sections from a FILE handle.
asciichat_error_t	manpage_parser_parse_memory (const char *content, size_t content_len, parsed_section_t **out_sections, size_t *out_count)
	Parse man page sections from memory buffer.
void	manpage_parser_free_sections (parsed_section_t *sections, size_t count)
	Free parsed sections array.
const parsed_section_t *	manpage_parser_find_section (const parsed_section_t *sections, size_t count, const char *section_name)
	Find section by name.

Detailed Description

Man page template parsing and section extraction.

This module handles parsing man page templates to extract sections and metadata about their types (AUTO-generated, MANUAL, or MERGE sections).

Supports both FILE* and memory buffer parsing with automatic detection of platform capabilities.

Definition in file parser.h.

Function Documentation

manpage_parser_find_section()

const parsed_section_t * manpage_parser_find_section	(	const parsed_section_t *	sections,
		size_t	count,
		const char *	section_name
	)

Find section by name.

Searches the parsed sections array for a section with matching name. Comparison is case-sensitive.

Parameters

[in]	sections	Array of parsed sections
[in]	count	Number of sections
[in]	section_name	Section name to search for (case-sensitive)

Returns

Pointer to matching section, or NULL if not found

Definition at line 400 of file parser.c.

                                                                              {
  if (!sections || !section_name) {
    return NULL;
  }
 
  for (size_t i = 0; i < count; i++) {
    if (sections[i].section_name && strcmp(sections[i].section_name, section_name) == 0) {
      return &sections[i];
    }
  }
 
  return NULL;
}

Referenced by find_section().

manpage_parser_free_sections()

void manpage_parser_free_sections	(	parsed_section_t *	sections,
		size_t	count
	)

Free parsed sections array.

Frees all allocated memory for sections array including section names and content. Safe to call with NULL pointers.

Parameters

[in]	sections	Array of parsed sections (can be NULL)
[in]	count	Number of sections in array

Definition at line 383 of file parser.c.

                                                                            {
  if (!sections) {
    return;
  }
 
  for (size_t i = 0; i < count; i++) {
    if (sections[i].section_name) {
      SAFE_FREE(sections[i].section_name);
    }
    if (sections[i].content) {
      SAFE_FREE(sections[i].content);
    }
  }
 
  SAFE_FREE(sections);
}

References SAFE_FREE.

Referenced by free_parsed_sections().

manpage_parser_parse_file()

asciichat_error_t manpage_parser_parse_file	(	FILE *	f,
		parsed_section_t **	out_sections,
		size_t *	out_count
	)

Parse man page sections from a FILE handle.

Parses a man page template from an open FILE*, detecting:

• Section headers (.SH directive)
• Section markers (AUTO-START/END, MANUAL-START/END, MERGE-START/END)
• Section content and boundaries

Memory is allocated for each section. Caller must use manpage_parser_free_sections() to clean up.

Parameters

[in]	f	Open file handle to parse (cannot be NULL)
[out]	out_sections	Pointer to array of parsed_section_t (output)
[out]	out_count	Number of sections parsed (output)

Returns

ASCIICHAT_OK on success

ERROR_INVALID_PARAM if parameters are invalid

ERROR_CONFIG if parsing fails or memory allocation fails

Note

Caller must call manpage_parser_free_sections(out_sections, out_count)

The file position is not reset; caller may need to fseek if needed

Definition at line 339 of file parser.c.

                                                                                                         {
  if (!f || !out_sections || !out_count) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters for manpage_parser_parse_file");
  }
 
  return parse_sections_internal(f, out_sections, out_count);
}

References ERROR_INVALID_PARAM, and SET_ERRNO.

Referenced by parse_manpage_sections().

manpage_parser_parse_memory()

asciichat_error_t manpage_parser_parse_memory	(	const char *	content,
		size_t	content_len,
		parsed_section_t **	out_sections,
		size_t *	out_count
	)

Parse man page sections from memory buffer.

Parses man page content from a memory buffer, detecting sections and markers like parse_file() but from pre-loaded content.

Uses platform-specific optimizations:

• Unix/macOS: fmemopen() for zero-copy parsing (if available)
• Windows/fallback: Creates temporary file

Memory is allocated for each section. Caller must use manpage_parser_free_sections() to clean up.

Parameters

[in]	content	Pointer to memory buffer containing man page (cannot be NULL)
[in]	content_len	Length of buffer in bytes (must be > 0)
[out]	out_sections	Pointer to array of parsed_section_t (output)
[out]	out_count	Number of sections parsed (output)

Returns

ASCIICHAT_OK on success

ERROR_INVALID_PARAM if parameters are invalid

ERROR_CONFIG if parsing fails or memory allocation fails

Note

Caller must call manpage_parser_free_sections(out_sections, out_count)

Available in all builds (Debug, Dev, Release)

Definition at line 347 of file parser.c.

                                                                 {
  if (!content || content_len == 0 || !out_sections || !out_count) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters for manpage_parser_parse_memory");
  }
 
  // Create temporary file from memory
  FILE *tmp = platform_tmpfile();
  if (!tmp) {
    return SET_ERRNO_SYS(ERROR_CONFIG, "Failed to create temporary file for memory parsing");
  }
 
  // Write content to temporary file
  // Write content_len + 1 to include the null terminator.
  // The embedded string is content_len + 1 bytes (content_len chars + null terminator).
  // platform_getline() needs the null terminator to properly handle EOF.
  size_t bytes_to_write = content_len + 1;
  size_t written = fwrite(content, 1, bytes_to_write, tmp);
  if (written != bytes_to_write) {
    fclose(tmp);
    return SET_ERRNO_SYS(ERROR_CONFIG, "Failed to write complete content to temporary file");
  }
 
  // Rewind to beginning for reading
  if (fseek(tmp, 0, SEEK_SET) != 0) {
    fclose(tmp);
    return SET_ERRNO_SYS(ERROR_CONFIG, "Failed to rewind temporary file");
  }
 
  // Parse using common function
  asciichat_error_t err = parse_sections_internal(tmp, out_sections, out_count);
  fclose(tmp);
 
  return err;
}

References ERROR_CONFIG, ERROR_INVALID_PARAM, platform_tmpfile(), SET_ERRNO, and SET_ERRNO_SYS.