|
ocssw
V2022
|
argpar-json.c File Reference
#include "argpar.h"#include <ctype.h>#include <errno.h>#include <limits.h>#include <stdbool.h>#include <stdlib.h>#include <string.h>#include <jansson.h>
Include dependency graph for argpar-json.c:
Go to the source code of this file.
Classes | |
| struct | item_counts |
| struct | group_limits |
Enumerations | |
| enum | option_type { HEADER = 1, OPTION = 2, DOC = 3, HEADER = 1, OPTION = 2, DOC = 3 } |
| enum | child_type { MERGED = 0, NOT_MERGED = 1, MERGED = 0, NOT_MERGED = 1 } |
Functions | |
| int | argpar_usage_json (argpar_state *state) |
| int | argpar_usage_default_json (argpar *argpar) |
| int | argpar_help_json (argpar *argpar, FILE *stream, unsigned flags, char *name) |
Enumeration Type Documentation
◆ child_type
| enum child_type |
| Enumerator | |
|---|---|
| MERGED | |
| NOT_MERGED | |
| MERGED | |
| NOT_MERGED | |
Definition at line 51 of file argpar-json.c.
◆ option_type
| enum option_type |
| Enumerator | |
|---|---|
| HEADER | |
| OPTION | |
| DOC | |
| HEADER | |
| OPTION | |
| DOC | |
Definition at line 48 of file argpar-json.c.
Function Documentation
◆ argpar_help_json()
| int argpar_help_json | ( | argpar * | argpar, |
| FILE * | stream, | ||
| unsigned | flags, | ||
| char * | name | ||
| ) |
Print the default usage summary with all available sections, in a format more suitable for automated parsing.
- Parameters
-
[in] argpar argpar object from which to generate the usage summary. [in] stream Stream to which the help gets printed. [in] flags Flags controlling which sections to print. Currently unused. [in] name Program name to use.
- Returns
- 0 on success, non-0 on error.
Definition at line 420 of file argpar-json.c.
◆ argpar_usage_default_json()
| int argpar_usage_default_json | ( | argpar * | argpar | ) |
Print the default usage summary with all available sections, in a format more suitable for automated parsing.
- Parameters
-
[in] argpar argpar object from which to generate the usage summary.
- Returns
- 0 on success, non-0 on error.
Definition at line 417 of file argpar-json.c.
◆ argpar_usage_json()
| int argpar_usage_json | ( | argpar_state * | state | ) |
Print usage summary, called within a argpar_parser, in a format more suitable for automated parsing.
- Parameters
-
[in] state argpar_state from which to generate usage summary.
- Returns
- 0 on success, non-0 on error.
Definition at line 414 of file argpar-json.c.
