Table of contents
- Header functions
- Defined in this file
- function arg_value
- function cleanup
- function create_config
- function dump_source_code
- function display_args
- function free_source_code
- function find_all
- function get_int
- function hash_string
- function init_source_code
- function in_args
- function join
- function linkage
- function mkdirp
- function normalize_type_string
- function parse_ulint
- function parse_ullint
- function parse_llint
- function parse_sint
- function parse_float
- function parse_usint
- function parse_int
- function parse_lint
- function parse_uint
- function prelinkage
- function recursion_callback
- function recursion
- function register_function
- function register_structure
- function register_enum
- function render
- function remove_comments_callback
- function rebase_path
- function register_docstring_callback
- function rmdirrf
- function summarise_linking
- function summarise_parsing
- function streq_with_crumb
- function starts_with
- function streq
- function try_extract_function
- function try_extract_enum
- function try_extract_function_multiline
- function try_extract_enum_multiline
- function try_extract_typedef_multiline
- function try_extract_typedef
- function try_extract_variable
- function try_extract_macro_multiline
- function try_extract_macro
- function try_extract_struct_multiline
- function try_extract_struct
- Indexed files
Header functions
This file contains the definitions and documentation of the functions
Defined in this file
The following 51 functions are referenced here
- arg_value
- cleanup
- create_config
- dump_source_code
- display_args
- free_source_code
- find_all
- get_int
- hash_string
- init_source_code
- in_args
- join
- linkage
- mkdirp
- normalize_type_string
- parse_ulint
- parse_ullint
- parse_llint
- parse_sint
- parse_float
- parse_usint
- parse_int
- parse_lint
- parse_uint
- prelinkage
- recursion_callback
- recursion
- register_function
- register_structure
- register_enum
- render
- remove_comments_callback
- rebase_path
- register_docstring_callback
- rmdirrf
- summarise_linking
- summarise_parsing
- streq_with_crumb
- starts_with
- streq
- try_extract_function
- try_extract_enum
- try_extract_function_multiline
- try_extract_enum_multiline
- try_extract_typedef_multiline
- try_extract_typedef
- try_extract_variable
- try_extract_macro_multiline
- try_extract_macro
- try_extract_struct_multiline
- try_extract_struct
function arg_value
char * arg_value(int __arg_no_1, char * __arg_no_2[], char * __arg_no_3);
Defined in src/parsers/args.h:21
Return type
Arguments
function cleanup
void cleanup(gen_config_t __arg_no_1);
Defined in src/core/core.h:46
Return type
Arguments
- __arg_no_1 :
gen_config_t
function create_config
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
Arguments
- src :
const char *- constant - dst :
const char *- constant - work :
const char *- constant - rebase_prefix :
const char *- constant - __arg_no_5 :
gen_config_t
function dump_source_code
int dump_source_code(const source_code_t __arg_no_1, int fd);
Defined in src/reader/reader.h:235
Return type
Arguments
- __arg_no_1 :
const source_code_t- constant - fd :
int
function display_args
void display_args(int args_count, struct arg_input args);
Defined in src/parsers/args.h:28
Return type
Arguments
- args_count :
int - args :
struct arg_input
function free_source_code
void free_source_code(source_code_t __arg_no_1);
Defined in src/reader/reader.h:234
Return type
Arguments
- __arg_no_1 :
source_code_t
function find_all
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
Arguments
- argc :
int - __arg_no_2 :
char * [] - __arg_no_3 :
struct arg_input - size :
int
function get_int
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
Arguments
function hash_string
string_hash hash_string(char * input, size_t max);
Defined in src/render/rendering.h:8
Return type
Arguments
function init_source_code
void init_source_code(source_code_t __arg_no_1);
Defined in src/reader/reader.h:233
Return type
Arguments
- __arg_no_1 :
source_code_t
function in_args
int in_args(int __arg_no_1, char * __arg_no_2[], char * __arg_no_3);
Defined in src/parsers/args.h:20
Return type
Arguments
function join
char * join(char * __arg_no_1, char * __arg_no_2);
Defined in src/parsers/stringlib.h:5
Return type
Arguments
function linkage
int linkage(source_code_t code, callback_args args);
Defined in src/core/core.h:136
Return type
Arguments
- code :
source_code_t - args :
callback_args
function mkdirp
int mkdirp(const char * path);
Defined in src/core/core.h:44
Return type
Arguments
- path :
const char *- constant
function normalize_type_string
int normalize_type_string(const char * type, char * typebuf, int with_normalize_newline);
Defined in src/core/core.h:123
Return type
Arguments
- type :
const char *- constant - typebuf :
char * - with_normalize_newline :
int
function parse_ulint
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
Arguments
function parse_ullint
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
Arguments
function parse_llint
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
Arguments
function parse_sint
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
Arguments
function parse_float
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
Arguments
function parse_usint
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
Arguments
function parse_int
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
Arguments
function parse_lint
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
Arguments
function parse_uint
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
Arguments
function prelinkage
int prelinkage(source_code_t code, callback_args args);
Defined in src/core/core.h:137
Return type
Arguments
- code :
source_code_t - args :
callback_args
function recursion_callback
void recursion_callback(const char * src, callback_args params);
Defined in src/core/core.h:35
Return type
Arguments
- src :
const char *- constant - params :
callback_args
function recursion
recursion_return_t recursion(const char * src, callback_args params, recursion_callback_t callback);
Defined in src/core/core.h:34
Return type
Arguments
- src :
const char *- constant - params :
callback_args - callback :
recursion_callback_t
function register_function
void register_function(const char * path, callback_args params, struct status_s * status);
Defined in src/core/core.h:140
Return type
Arguments
- path :
const char *- constant - params :
callback_args - status :
struct status_s *
function register_structure
int register_structure(const char * filename, callback_args params, struct status_s * status);
Defined in src/core/core.h:142
Return type
Arguments
- filename :
const char *- constant - params :
callback_args - status :
struct status_s *
function register_enum
void register_enum(const char * path, callback_args args, struct status_s * status);
Defined in src/core/core.h:141
Return type
Arguments
- path :
const char *- constant - args :
callback_args - status :
struct status_s *
function render
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
Arguments
- __arg_no_1 :
source_code_t - __arg_no_2 :
gen_config_t - __arg_no_3 :
struct result *
function remove_comments_callback
void remove_comments_callback(const char * src, callback_args params);
Defined in src/core/core.h:36
Return type
Arguments
- src :
const char *- constant - params :
callback_args
function rebase_path
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
Arguments
- path :
const char *- constant - replace :
const char *- constant - by :
const char *- constant - buffer :
char * - max :
size_t
function register_docstring_callback
void register_docstring_callback(const char * src, callback_args params);
Defined in src/core/core.h:37
Return type
Arguments
- src :
const char *- constant - params :
callback_args
function rmdirrf
int rmdirrf(const char * path);
Defined in src/core/core.h:45
Return type
Arguments
- path :
const char *- constant
function summarise_linking
void summarise_linking(const callback_args __arg_no_1);
Defined in src/reader/reader.h:237
Return type
Arguments
- __arg_no_1 :
const callback_args- constant
function summarise_parsing
void summarise_parsing(source_code_t __arg_no_1);
Defined in src/reader/reader.h:236
Return type
Arguments
- __arg_no_1 :
source_code_t
function streq_with_crumb
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
Arguments
- str :
const char *- constant - cmp :
const char *- constant - crumb :
const char- constant
function starts_with
int starts_with(const char * input, const char * with);
Defined in src/parsers/stringlib.h:6
Return type
Arguments
- input :
const char *- constant - with :
const char *- constant
function streq
int streq(char * __arg_no_1, char * __arg_no_2);
Defined in src/parsers/stringlib.h:4
Return type
Arguments
function try_extract_function
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_enum
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
Arguments
- buffer :
char * - path :
const char *- constant - __arg_no_3 :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_function_multiline
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_enum_multiline
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_typedef_multiline
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_typedef
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
Arguments
- buffer :
char * - path :
const char *- constant - __arg_no_3 :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_variable
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_macro_multiline
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
Arguments
- buffer :
char * - path :
const char *- constant - __arg_no_3 :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_macro
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_struct_multiline
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *
function try_extract_struct
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
Arguments
- buffer :
char * - path :
const char *- constant - args :
callback_args - __arg_no_4 :
struct status_s *