5 headers functions
forgejo docs edited this page 2026-11-17 14:47:00 +00:00

Header functions

This file contains the definitions and documentation of the functions

Go back to homepage
Skip to files index

Defined in this file

The following 51 functions are referenced here

function arg_value

Go back to top

char * arg_value(int __arg_no_1, char * __arg_no_2[], char * __arg_no_3);

Defined in src/parsers/args.h:21

Return type

char *

Arguments

  1. __arg_no_1 : int
  2. __arg_no_2 : char * []
  3. __arg_no_3 : char *

function cleanup

Go back to top

void cleanup(gen_config_t __arg_no_1);

Defined in src/core/core.h:46

Return type

void

Arguments

  1. __arg_no_1 : gen_config_t

function create_config

Go back to top

int create_config(const char * src, const char * dst, const char * work, const char * rebase_prefix, gen_config_t __arg_no_5);

Defined in src/core/core.h:43

Return type

int

Arguments

  1. src : const char * - constant
  2. dst : const char * - constant
  3. work : const char * - constant
  4. rebase_prefix : const char * - constant
  5. __arg_no_5 : gen_config_t

function dump_source_code

Go back to top

int dump_source_code(const source_code_t __arg_no_1, int fd);

Defined in src/reader/reader.h:235

Return type

int

Arguments

  1. __arg_no_1 : const source_code_t - constant
  2. fd : int

function display_args

Go back to top

void display_args(int args_count, struct arg_input args);

Defined in src/parsers/args.h:28

Return type

void

Arguments

  1. args_count : int
  2. args : struct arg_input

function free_source_code

Go back to top

void free_source_code(source_code_t __arg_no_1);

Defined in src/reader/reader.h:234

Return type

void

Arguments

  1. __arg_no_1 : source_code_t

function find_all

Go back to top

int find_all(int argc, char * __arg_no_2[], struct arg_input __arg_no_3, int size);

Defined in src/parsers/args.h:24

Return type

int

Arguments

  1. argc : int
  2. __arg_no_2 : char * []
  3. __arg_no_3 : struct arg_input
  4. size : int

function get_int

Go back to top

int get_int(int __arg_no_1, char * __arg_no_2[], char * __arg_no_3, int * __arg_no_4);

Defined in src/parsers/args.h:22

Return type

int

Arguments

  1. __arg_no_1 : int
  2. __arg_no_2 : char * []
  3. __arg_no_3 : char *
  4. __arg_no_4 : int *

function hash_string

Go back to top

string_hash hash_string(char * input, size_t max);

Defined in src/render/rendering.h:8

Return type

string_hash

Arguments

  1. input : char *
  2. max : size_t

function init_source_code

Go back to top

void init_source_code(source_code_t __arg_no_1);

Defined in src/reader/reader.h:233

Return type

void

Arguments

  1. __arg_no_1 : source_code_t

function in_args

Go back to top

int in_args(int __arg_no_1, char * __arg_no_2[], char * __arg_no_3);

Defined in src/parsers/args.h:20

Return type

int

Arguments

  1. __arg_no_1 : int
  2. __arg_no_2 : char * []
  3. __arg_no_3 : char *

function join

Go back to top

char * join(char * __arg_no_1, char * __arg_no_2);

Defined in src/parsers/stringlib.h:5

Return type

char *

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : char *

function linkage

Go back to top

int linkage(source_code_t code, callback_args args);

Defined in src/core/core.h:136

Return type

int

Arguments

  1. code : source_code_t
  2. args : callback_args

function mkdirp

Go back to top

int mkdirp(const char * path);

Defined in src/core/core.h:44

Return type

int

Arguments

  1. path : const char * - constant

function normalize_type_string

Go back to top

int normalize_type_string(const char * type, char * typebuf, int with_normalize_newline);

Defined in src/core/core.h:123

Return type

int

Arguments

  1. type : const char * - constant
  2. typebuf : char *
  3. with_normalize_newline : int

function parse_ulint

Go back to top

unsigned long int parse_ulint(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:37

Note


@brief Converts string to unsigned long int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

unsigned long int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_ullint

Go back to top

unsigned long long int parse_ullint(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:52

Note


@brief Converts string to unsigned long long int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

unsigned long long int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_llint

Go back to top

long long int parse_llint(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:45

Note


@brief Converts string to long int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

long long int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_sint

Go back to top

short int parse_sint(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:60

Note


@brief Converts string to short int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

short int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_float

Go back to top

float parse_float(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:75

Note


@brief Converts string to float

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

float

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_usint

Go back to top

unsigned short int parse_usint(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:67

Note


@brief Converts string to unsigned short int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

unsigned short int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_int

Go back to top

int parse_int(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:15

Note


@brief Converts string to int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_lint

Go back to top

long int parse_lint(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:30

Note


@brief Converts string to long int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

long int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function parse_uint

Go back to top

unsigned int parse_uint(char * __arg_no_1, int * __arg_no_2);

Defined in src/parsers/parsers.h:22

Note


@brief Converts string to unsigned int

@param char * - the input
@param int * - indicates an error. Set to 0 if everything went fine, set to the values of ParsersControls

Return type

unsigned int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : int *

function prelinkage

Go back to top

int prelinkage(source_code_t code, callback_args args);

Defined in src/core/core.h:137

Return type

int

Arguments

  1. code : source_code_t
  2. args : callback_args

function recursion_callback

Go back to top

void recursion_callback(const char * src, callback_args params);

Defined in src/core/core.h:35

Return type

void

Arguments

  1. src : const char * - constant
  2. params : callback_args

function recursion

Go back to top

recursion_return_t recursion(const char * src, callback_args params, recursion_callback_t callback);

Defined in src/core/core.h:34

Return type

recursion_return_t

Arguments

  1. src : const char * - constant
  2. params : callback_args
  3. callback : recursion_callback_t

function register_function

Go back to top

void register_function(const char * path, callback_args params, struct status_s * status);

Defined in src/core/core.h:140

Return type

void

Arguments

  1. path : const char * - constant
  2. params : callback_args
  3. status : struct status_s *

function register_structure

Go back to top

int register_structure(const char * filename, callback_args params, struct status_s * status);

Defined in src/core/core.h:142

Return type

int

Arguments

  1. filename : const char * - constant
  2. params : callback_args
  3. status : struct status_s *

function register_enum

Go back to top

void register_enum(const char * path, callback_args args, struct status_s * status);

Defined in src/core/core.h:141

Return type

void

Arguments

  1. path : const char * - constant
  2. args : callback_args
  3. status : struct status_s *

function render

Go back to top

int render(source_code_t __arg_no_1, gen_config_t __arg_no_2, struct result * __arg_no_3);

Defined in src/render/rendering.h:9

Return type

int

Arguments

  1. __arg_no_1 : source_code_t
  2. __arg_no_2 : gen_config_t
  3. __arg_no_3 : struct result *

function remove_comments_callback

Go back to top

void remove_comments_callback(const char * src, callback_args params);

Defined in src/core/core.h:36

Return type

void

Arguments

  1. src : const char * - constant
  2. params : callback_args

function rebase_path

Go back to top

void rebase_path(const char * path, const char * replace, const char * by, char * buffer, size_t max);

Defined in src/core/core.h:42

Note


This function replaces in `path` the source `replace` by the new path `by`.
It writes in buffer as the function goes by

Return type

void

Arguments

  1. path : const char * - constant
  2. replace : const char * - constant
  3. by : const char * - constant
  4. buffer : char *
  5. max : size_t

function register_docstring_callback

Go back to top

void register_docstring_callback(const char * src, callback_args params);

Defined in src/core/core.h:37

Return type

void

Arguments

  1. src : const char * - constant
  2. params : callback_args

function rmdirrf

Go back to top

int rmdirrf(const char * path);

Defined in src/core/core.h:45

Return type

int

Arguments

  1. path : const char * - constant

function summarise_linking

Go back to top

void summarise_linking(const callback_args __arg_no_1);

Defined in src/reader/reader.h:237

Return type

void

Arguments

  1. __arg_no_1 : const callback_args - constant

function summarise_parsing

Go back to top

void summarise_parsing(source_code_t __arg_no_1);

Defined in src/reader/reader.h:236

Return type

void

Arguments

  1. __arg_no_1 : source_code_t

function streq_with_crumb

Go back to top

int streq_with_crumb(const char * str, const char * cmp, const char crumb);

Defined in src/parsers/stringlib.h:11

Note


Compares `str` with `cmp`. If after comparison, there are remaining chars in `str`,
the comparison is called valid if they are only chars like crumb until the end

Return type

int

Arguments

  1. str : const char * - constant
  2. cmp : const char * - constant
  3. crumb : const char - constant

function starts_with

Go back to top

int starts_with(const char * input, const char * with);

Defined in src/parsers/stringlib.h:6

Return type

int

Arguments

  1. input : const char * - constant
  2. with : const char * - constant

function streq

Go back to top

int streq(char * __arg_no_1, char * __arg_no_2);

Defined in src/parsers/stringlib.h:4

Return type

int

Arguments

  1. __arg_no_1 : char *
  2. __arg_no_2 : char *

function try_extract_function

Go back to top

int try_extract_function(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:129

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_enum

Go back to top

int try_extract_enum(char * buffer, const char * path, callback_args __arg_no_3, struct status_s * __arg_no_4);

Defined in src/core/core.h:131

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. __arg_no_3 : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_function_multiline

Go back to top

int try_extract_function_multiline(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:130

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_enum_multiline

Go back to top

int try_extract_enum_multiline(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:132

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_typedef_multiline

Go back to top

int try_extract_typedef_multiline(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:134

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_typedef

Go back to top

int try_extract_typedef(char * buffer, const char * path, callback_args __arg_no_3, struct status_s * __arg_no_4);

Defined in src/core/core.h:133

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. __arg_no_3 : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_variable

Go back to top

int try_extract_variable(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:124

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_macro_multiline

Go back to top

int try_extract_macro_multiline(char * buffer, const char * path, callback_args __arg_no_3, struct status_s * __arg_no_4);

Defined in src/core/core.h:126

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. __arg_no_3 : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_macro

Go back to top

int try_extract_macro(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:125

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_struct_multiline

Go back to top

int try_extract_struct_multiline(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:128

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

function try_extract_struct

Go back to top

int try_extract_struct(char * buffer, const char * path, callback_args args, struct status_s * __arg_no_4);

Defined in src/core/core.h:127

Return type

int

Arguments

  1. buffer : char *
  2. path : const char * - constant
  3. args : callback_args
  4. __arg_no_4 : struct status_s *

Indexed files