yumapro  23.10T-8
YumaPro SDK
Loading...
Searching...
No Matches
help.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
3 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
4 *
5 * Unless required by applicable law or agreed to in writing,
6 * software distributed under the License is distributed on an
7 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8 * KIND, either express or implied. See the License for the
9 * specific language governing permissions and limitations
10 * under the License.
11 */
12#ifndef _H_help
13#define _H_help
14
15/* FILE: help.h
16*********************************************************************
17* *
18* P U R P O S E *
19* *
20*********************************************************************/
21
29/*********************************************************************
30* *
31* C H A N G E H I S T O R Y *
32* *
33*********************************************************************
34
35date init comment
36----------------------------------------------------------------------
3705-oct-07 abb Begun
38
39*/
40
41#include <xmlstring.h>
42
43#ifndef _H_ncxconst
44#include "ncxconst.h"
45#endif
46
47#ifndef _H_obj
48#include "obj.h"
49#endif
50
51#ifndef _H_typ
52#include "typ.h"
53#endif
54
55#ifdef __cplusplus
56extern "C" {
57#endif
58
59/********************************************************************
60* *
61* C O N S T A N T S *
62* *
63*********************************************************************/
64
65#define HELP_MODE_BRIEF_MAX 60
66#define HELP_MODE_NORMAL_MAX 100
67
68
69/********************************************************************
70* *
71* T Y P E S *
72* *
73*********************************************************************/
74
84typedef enum help_mode_t_ {
90
91
92/********************************************************************
93* *
94* F U N C T I O N S *
95* *
96*********************************************************************/
97
98
109extern void
110 help_program_module (const xmlChar *modname,
111 const xmlChar *cliname,
112 help_mode_t mode);
113
114
123extern void
124 help_data_module (const ncx_module_t *mod,
125 help_mode_t mode);
126
127
134extern void
135 help_type (const typ_template_t *typ,
136 help_mode_t mode);
137
138
145extern void
147 help_mode_t mode);
148
149
160extern void
161 help_write_lines (const xmlChar *str,
162 uint32 indent,
163 boolean startnl);
164
165
177extern void
178 help_write_lines_max (const xmlChar *str,
179 uint32 indent,
180 boolean startnl,
181 uint32 maxlen);
182
183
190extern help_mode_t
191 help_cvt_str (const xmlChar *str);
192
193
200extern const xmlChar *
202
203
207#ifdef __cplusplus
208} /* end extern 'C' */
209#endif
210
211#endif /* _H_help */
void help_type(const typ_template_t *typ, help_mode_t mode)
Print the full help text for a YANG data type to STDOUT.
Definition: help.c:363
const xmlChar * help_cvt_enum(help_mode_t mode)
Convert a help_mode_t enum to a string.
Definition: help.c:553
void help_data_module(const ncx_module_t *mod, help_mode_t mode)
Print the full help text for an entire data module to STDOUT.
Definition: help.c:326
void help_write_lines_max(const xmlChar *str, uint32 indent, boolean startnl, uint32 maxlen)
write some indented output to STDOUT
Definition: help.c:470
help_mode_t
modes to match the keywords brief, normal, full
Definition: help.h:84
void help_program_module(const xmlChar *modname, const xmlChar *cliname, help_mode_t mode)
Print the full help text for an entire program module to STDOUT.
Definition: help.c:229
void help_write_lines(const xmlChar *str, uint32 indent, boolean startnl)
write some indented output to STDOUT
Definition: help.c:430
void help_object(obj_template_t *obj, help_mode_t mode)
Print the full help text for an object template to STDOUT.
Definition: help.c:405
help_mode_t help_cvt_str(const xmlChar *str)
Convert a string to a help_mode_t enum.
Definition: help.c:528
@ HELP_MODE_BRIEF
–brief mode selected
Definition: help.h:86
@ HELP_MODE_FULL
–full selected
Definition: help.h:88
@ HELP_MODE_NORMAL
–normal mode selected or default
Definition: help.h:87
@ HELP_MODE_NONE
value not set
Definition: help.h:85
Contains NCX constants.
Data Object Support.
representation of one module or submodule during and after parsing
Definition: ncxtypes.h:1134
One YANG data-def-stmt.
Definition: obj.h:1220
One YANG 'typedef' definition – top-level type template.
Definition: typ.h:477
Parameter Type Handler.