/usr/include/yuma/ncx/ncx_appinfo.h is in libyuma-dev 2.10-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_ncx_appinfo
#define _H_ncx_appinfo
/* FILE: ncx_appinfo.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NCX Module Library Extension (Application Info) Utility Functions
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
17-feb-10 abb Begun; split out from ncx.c
*/
#include <xmlstring.h>
#ifndef _H_dlq
#include "dlq.h"
#endif
#ifndef _H_ext
#include "ext.h"
#endif
#ifndef _H_ncx
#include "ncx.h"
#endif
#ifndef _H_ncx_appinfo
#include "ncx_appinfo.h"
#endif
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
#ifndef _H_tk
#include "tk.h"
#endif
#ifndef _H_typ
#include "typ.h"
#endif
#ifndef _H_val
#include "val.h"
#endif
#ifndef _H_xmlns
#include "xmlns.h"
#endif
#ifndef _H_yang
#include "yang.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION ncx_new_appinfo
*
* Create an appinfo entry
*
* INPOUTS:
* isclone == TRUE if this is for a cloned object
*
* RETURNS:
* malloced appinfo entry or NULL if malloc error
*********************************************************************/
extern ncx_appinfo_t *
ncx_new_appinfo (boolean isclone);
/********************************************************************
* FUNCTION ncx_free_appinfo
*
* Free an appinfo entry
*
* INPUTS:
* appinfo == ncx_appinfo_t data structure to free
*********************************************************************/
extern void
ncx_free_appinfo (ncx_appinfo_t *appinfo);
/********************************************************************
* FUNCTION ncx_find_appinfo
*
* Find an appinfo entry by name (First match is returned)
* The entry returned is not removed from the Q
*
* INPUTS:
* appinfoQ == pointer to Q of ncx_appinfo_t data structure to check
* prefix == module prefix that defines the extension
* == NULL to pick the first match (not expecting
* appinfo name collisions)
* varname == name string of the appinfo variable to find
*
* RETURNS:
* pointer to the ncx_appinfo_t struct for the entry if found
* NULL if the entry is not found
*********************************************************************/
extern ncx_appinfo_t *
ncx_find_appinfo (dlq_hdr_t *appinfoQ,
const xmlChar *prefix,
const xmlChar *varname);
/********************************************************************
* FUNCTION ncx_find_const_appinfo
*
* Find an appinfo entry by name (First match is returned)
* The entry returned is not removed from the Q
*
* INPUTS:
* appinfoQ == pointer to Q of ncx_appinfo_t data structure to check
* prefix == module prefix that defines the extension
* == NULL to pick the first match (not expecting
* appinfo name collisions)
* varname == name string of the appinfo variable to find
*
* RETURNS:
* pointer to the ncx_appinfo_t struct for the entry if found
* NULL if the entry is not found
*********************************************************************/
extern const ncx_appinfo_t *
ncx_find_const_appinfo (const dlq_hdr_t *appinfoQ,
const xmlChar *prefix,
const xmlChar *varname);
/********************************************************************
* FUNCTION ncx_find_next_appinfo
*
* Find the next instance of an appinfo entry by name
* (First match is returned)
* The entry returned is not removed from the Q
*
* INPUTS:
* current == pointer to current ncx_appinfo_t data structure to check
* prefix == module prefix that defines the extension
* == NULL to pick the first match (not expecting
* appinfo name collisions)
* varname == name string of the appinfo variable to find
*
* RETURNS:
* pointer to the ncx_appinfo_t struct for the entry if found
* NULL if the entry is not found
*********************************************************************/
extern const ncx_appinfo_t *
ncx_find_next_appinfo (const ncx_appinfo_t *current,
const xmlChar *prefix,
const xmlChar *varname);
/********************************************************************
* FUNCTION ncx_find_next_appinfo2
*
* Find the next instance of an appinfo entry by name
* (First match is returned)
* The entry returned is not removed from the Q
*
* INPUTS:
* current == pointer to current ncx_appinfo_t data structure to check
* prefix == module prefix that defines the extension
* == NULL to pick the first match (not expecting
* appinfo name collisions)
* varname == name string of the appinfo variable to find
*
* RETURNS:
* pointer to the ncx_appinfo_t struct for the entry if found
* NULL if the entry is not found
*********************************************************************/
extern ncx_appinfo_t *
ncx_find_next_appinfo2 (ncx_appinfo_t *current,
const xmlChar *prefix,
const xmlChar *varname);
/********************************************************************
* FUNCTION ncx_clone_appinfo
*
* Clone an appinfo value
*
* INPUTS:
* appinfo == ncx_appinfo_t data structure to clone
*
* RETURNS:
* pointer to the malloced ncx_appinfo_t struct clone of appinfo
* NULL if a malloc error
*********************************************************************/
extern ncx_appinfo_t *
ncx_clone_appinfo (ncx_appinfo_t *appinfo);
/********************************************************************
* FUNCTION ncx_clean_appinfoQ
*
* Check an initialized appinfoQ for any entries
* Remove them from the queue and delete them
*
* INPUTS:
* appinfoQ == Q of ncx_appinfo_t data structures to free
*********************************************************************/
extern void
ncx_clean_appinfoQ (dlq_hdr_t *appinfoQ);
/********************************************************************
* FUNCTION ncx_consume_appinfo
*
* Check if an appinfo clause is present
*
* Save in appinfoQ if non-NULL
*
* Error messages are printed by this function!!
* Do not duplicate error messages upon error return
*
* INPUTS:
* tkc == token chain
* mod == ncx_module_t in progress (NULL if none)
* appinfoQ == queue to use for any found entries (may be NULL)
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_consume_appinfo (tk_chain_t *tkc,
ncx_module_t *mod,
dlq_hdr_t *appinfoQ);
/********************************************************************
* FUNCTION ncx_consume_appinfo2
*
* Check if an appinfo clause is present
* Do not backup the current token
* The TK_TT_MSTRING token has not been seen yet
* Called from yang_consume_semiapp
*
* Save in appinfoQ if non-NULL
*
* Error messages are printed by this function!!
* Do not duplicate error messages upon error return
*
* INPUTS:
* tkc == token chain
* mod == ncx_module_t in progress (NULL if none)
* appinfoQ == queue to use for any found entries (may be NULL)
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_consume_appinfo2 (tk_chain_t *tkc,
ncx_module_t *mod,
dlq_hdr_t *appinfoQ);
/********************************************************************
* FUNCTION ncx_resolve_appinfoQ
*
* Validate all the appinfo clauses present in the specified Q
*
* Error messages are printed by this function!!
* Do not duplicate error messages upon error return
*
* INPUTS:
* pcb == parser control block to use
* tkc == token chain
* mod == ncx_module_t in progress
* appinfoQ == queue to check
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_resolve_appinfoQ (yang_pcb_t *pcb,
tk_chain_t *tkc,
ncx_module_t *mod,
dlq_hdr_t *appinfoQ);
/********************************************************************
* FUNCTION ncx_get_appinfo_value
*
* Get the value string from an appinfo struct
*
* INPUTS:
* appinfo == ncx_appinfo_t data structure to use
*
* RETURNS:
* pointer to the string value if name
* NULL if no value
*********************************************************************/
extern const xmlChar *
ncx_get_appinfo_value (const ncx_appinfo_t *appinfo);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_ncx_appinfo */
|