yumapro  24.10-2
YumaPro SDK
Loading...
Searching...
No Matches
wr_util.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
3 * Copyright (c) 2012 - 2022, 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_wr_util
13#define _H_wr_util
14
15/* FILE: wr_util.h
16*********************************************************************
17* *
18* P U R P O S E *
19* *
20*********************************************************************/
21
27/*********************************************************************
28* *
29* C H A N G E H I S T O R Y *
30* *
31*********************************************************************
32
33date init comment
34----------------------------------------------------------------------
3509-apr-22 abb Begun; split out from xml_wr.c
36
37*/
38
39//#include <xmlstring.h>
40
41#ifndef _H_ncxtypes
42#include "ncxtypes.h"
43#endif
44
45#ifndef _H_ses
46#include "ses.h"
47#endif
48
49#ifndef _H_status_enum
50#include "status_enum.h"
51#endif
52
53#ifndef _H_val
54#include "val.h"
55#endif
56
57#ifndef _H_xml_msg
58#include "xml_msg.h"
59#endif
60
61#ifdef __cplusplus
62extern "C" {
63#endif
64
65
66
67
77/********************************************************************
78* *
79* C O N S T A N T S *
80* *
81*********************************************************************/
82
83
84
85/********************************************************************
86* *
87* T Y P E S *
88* *
89*********************************************************************/
90
91/********************************************************************
92* *
93* F U N C T I O N S *
94* *
95*********************************************************************/
96
97
107extern boolean
108 wr_util_check_start_depth (xml_msg_hdr_t *msg,
109 obj_template_t *obj);
110
111
120extern boolean
121 wr_util_fit_on_line (ses_cb_t *scb,
122 const val_value_t *val);
123
130extern boolean
131 wr_util_need_default_attr (xml_msg_hdr_t *msg);
132
133
140extern boolean
141 wr_util_need_origin_attr (xml_msg_hdr_t *msg);
142
143
156extern boolean
157 wr_util_need_skip_any (val_value_t *out);
158
162#ifdef __cplusplus
163} /* end extern 'C' */
164#endif
165
166#endif /* _H_wr_util */
wr_util_check_start_depth
boolean wr_util_check_start_depth(xml_msg_hdr_t *msg, obj_template_t *obj)
Check if the current val value for All in One mode is the value that we should start the write for.
Definition: wr_util.c:81
wr_util_need_default_attr
boolean wr_util_need_default_attr(xml_msg_hdr_t *msg)
Check if the default attr is needed.
Definition: wr_util.c:188
wr_util_need_skip_any
boolean wr_util_need_skip_any(val_value_t *out)
Check if the output data is really an anyxml or anydata or a generic container.
Definition: wr_util.c:235
wr_util_need_origin_attr
boolean wr_util_need_origin_attr(xml_msg_hdr_t *msg)
Check if the origin attr is needed.
Definition: wr_util.c:208
wr_util_fit_on_line
boolean wr_util_fit_on_line(ses_cb_t *scb, const val_value_t *val)
Check if the specified value will fit on the current line or if a newline is needed first.
Definition: wr_util.c:151
ncxtypes.h
YANG module data structures Many internal representations of YANG module constructs.
ses.h
NETCONF Session Common definitions module.
status_enum.h
global error status code enumerations
obj_template_t
One YANG data-def-stmt.
Definition: obj.h:1229
ses_cb_t
Session Control Block.
Definition: ses.h:573
val_value_t
one value to match one type
Definition: val.h:912
xml_msg_hdr_t
Common Encoding Message Header No longer XML specific!! Used by JSON and CBOR parsing as well!...
Definition: xml_msg.h:404
val.h
Value Node Basic Support.
xml_msg.h
XML and JSON Message send and receive support.