manpage.h

Go to the documentation of this file.

 
#pragma once
 
#include "builder.h"
#include "../common.h"
#include <stdio.h>
#include <stdbool.h>
#include <stddef.h>
 
typedef enum {
  SECTION_TYPE_AUTO,    
  SECTION_TYPE_MANUAL,  
  SECTION_TYPE_MERGE,   
  SECTION_TYPE_UNMARKED 
} section_type_t;
 
typedef struct {
  char *section_name;  
  section_type_t type; 
  char *content;       
  size_t content_len;  
  size_t start_line;   
  size_t end_line;     
  bool has_markers;    
} parsed_section_t;
 
asciichat_error_t options_config_generate_manpage_template(const options_config_t *config, const char *program_name,
                                                           const char *mode_name, const char *output_path,
                                                           const char *brief_description);
 
asciichat_error_t options_builder_generate_manpage_template(options_builder_t *builder, const char *program_name,
                                                            const char *mode_name, const char *output_path,
                                                            const char *brief_description);
 
asciichat_error_t options_config_generate_manpage_merged(const options_config_t *config, const char *program_name,
                                                         const char *mode_name, const char *output_path,
                                                         const char *brief_description);
 
parsed_section_t *parse_manpage_sections(const char *filepath, size_t *num_sections);
 
void free_parsed_sections(parsed_section_t *sections, size_t num_sections);
 
const parsed_section_t *find_section(const parsed_section_t *sections, size_t num_sections, const char *section_name);
 
#ifndef NDEBUG
asciichat_error_t options_config_generate_final_manpage(const char *template_path, const char *output_path,
                                                        const char *version_string, const char *content_file_path);
#endif
 
const char *escape_groff_special(const char *str);
 
const char *format_mode_names(option_mode_bitmask_t bitmask);