contrib/libxo/libxo/xo.h

   1 /*
   2  * Copyright (c) 2014-2015, Juniper Networks, Inc.
   3  * All rights reserved.
   4  * This SOFTWARE is licensed under the LICENSE provided in the
   5  * ../Copyright file. By downloading, installing, copying, or otherwise
   6  * using the SOFTWARE, you agree to be bound by the terms of that
   7  * LICENSE.
   8  * Phil Shafer, July 2014
   9  */
  10
  11 /**
  12  * libxo provides a means of generating text, XML, JSON, and HTML output
  13  * using a single set of function calls, maximizing the value of output
  14  * while minimizing the cost/impact on the code.
  15  *
  16  * Full documentation is available in ./doc/libxo.txt or online at:
  17  *   http://juniper.github.io/libxo/libxo-manual.html
  18  */
  19
  20 #ifndef INCLUDE_XO_H
  21 #define INCLUDE_XO_H
  22
  23 #include <stdio.h>
  24 #include <sys/types.h>
  25 #include <stdarg.h>
  26 #include <limits.h>
  27 #include <stdlib.h>
  28 #include <errno.h>
  29
  30 #ifdef __dead2
  31 #define NORETURN __dead2
  32 #else
  33 #define NORETURN
  34 #endif /* __dead2 */
  35
  36 /*
  37  * Normally we'd use the HAVE_PRINTFLIKE define triggered by the
  38  * --enable-printflike option to configure, but we don't install
  39  * our internal "xoconfig.h", and I'd rather not.  Taking the
  40  * coward's path, we'll turn it on inside a #if that allows
  41  * others to turn it off where needed.  Not ideal, but functional.
  42  */
  43 #if !defined(NO_PRINTFLIKE)
  44 #if defined(__linux) && !defined(__printflike)
  45 #define __printflike(_x, _y) __attribute__((__format__ (__printf__, _x, _y)))
  46 #endif
  47 #define PRINTFLIKE(_x, _y) __printflike(_x, _y)
  48 #else
  49 #define PRINTFLIKE(_x, _y)
  50 #endif /* NO_PRINTFLIKE */
  51
  52 /** Formatting types */
  53 typedef unsigned short xo_style_t;
  54 #define XO_STYLE_TEXT   0       /** Generate text output */
  55 #define XO_STYLE_XML    1       /** Generate XML output */
  56 #define XO_STYLE_JSON   2       /** Generate JSON output */
  57 #define XO_STYLE_HTML   3       /** Generate HTML output */
  58 #define XO_STYLE_SDPARAMS 4     /* Generate syslog structured data params */
  59 #define XO_STYLE_ENCODER 5      /* Generate calls to external encoder */
  60
  61 /** Flags for libxo */
  62 typedef unsigned long long xo_xof_flags_t;
  63 #define XOF_BIT(_n) ((xo_xof_flags_t) 1 << (_n))
  64 #define XOF_CLOSE_FP    XOF_BIT(0) /** Close file pointer on xo_close() */
  65 #define XOF_PRETTY      XOF_BIT(1) /** Make 'pretty printed' output */
  66 #define XOF_LOG_SYSLOG  XOF_BIT(2) /** Log (on stderr) our syslog content */
  67 #define XOF_RESV3       XOF_BIT(3) /* Unused */
  68
  69 #define XOF_WARN        XOF_BIT(4) /** Generate warnings for broken calls */
  70 #define XOF_XPATH       XOF_BIT(5) /** Emit XPath attributes in HTML  */
  71 #define XOF_INFO        XOF_BIT(6) /** Emit additional info fields (HTML) */
  72 #define XOF_WARN_XML    XOF_BIT(7) /** Emit warnings in XML (on stdout) */
  73
  74 #define XOF_NO_ENV      XOF_BIT(8) /** Don't look at LIBXO_OPTIONS env var */
  75 #define XOF_NO_VA_ARG   XOF_BIT(9) /** Don't advance va_list w/ va_arg() */
  76 #define XOF_DTRT        XOF_BIT(10) /** Enable "do the right thing" mode */
  77 #define XOF_KEYS        XOF_BIT(11) /** Flag 'key' fields for xml and json */
  78
  79 #define XOF_IGNORE_CLOSE XOF_BIT(12) /** Ignore errors on close tags */
  80 #define XOF_NOT_FIRST   XOF_BIT(13) /* Not the first item (JSON)  */
  81 #define XOF_NO_LOCALE   XOF_BIT(14) /** Don't bother with locale */
  82 #define XOF_RESV15      XOF_BIT(15) /* Unused */
  83
  84 #define XOF_NO_TOP      XOF_BIT(16) /** Don't emit the top braces in JSON */
  85 #define XOF_RESV17      XOF_BIT(17) /* Unused  */
  86 #define XOF_UNITS       XOF_BIT(18) /** Encode units in XML */
  87 #define XOF_RESV19      XOF_BIT(19) /* Unused */
  88
  89 #define XOF_UNDERSCORES XOF_BIT(20) /** Replace dashes with underscores (JSON)*/
  90 #define XOF_COLUMNS     XOF_BIT(21) /** xo_emit should return a column count */
  91 #define XOF_FLUSH       XOF_BIT(22) /** Flush after each xo_emit call */
  92 #define XOF_FLUSH_LINE  XOF_BIT(23) /** Flush after each newline */
  93
  94 #define XOF_NO_CLOSE    XOF_BIT(24) /** xo_finish won't close open elements */
  95 #define XOF_COLOR_ALLOWED XOF_BIT(25) /** Allow color/effects to be enabled */
  96 #define XOF_COLOR       XOF_BIT(26) /** Enable color and effects */
  97 #define XOF_NO_HUMANIZE XOF_BIT(27) /** Block the {h:} modifier */
  98
  99 #define XOF_LOG_GETTEXT XOF_BIT(28) /** Log (stderr) gettext lookup strings */
 100 #define XOF_UTF8        XOF_BIT(29) /** Force text output to be UTF8 */
 101 #define XOF_RETAIN_ALL  XOF_BIT(30) /** Force use of XOEF_RETAIN */
 102 #define XOF_RETAIN_NONE XOF_BIT(31) /** Prevent use of XOEF_RETAIN */
 103
 104 #define XOF_COLOR_MAP   XOF_BIT(32) /** Color map has been initialized */
 105
 106 typedef unsigned xo_emit_flags_t; /* Flags to xo_emit() and friends */
 107 #define XOEF_RETAIN     (1<<0)    /* Retain parsed formatting information */
 108
 109 /*
 110  * The xo_info_t structure provides a mapping between names and
 111  * additional data emitted via HTML.
 112  */
 113 typedef struct xo_info_s {
 114     const char *xi_name;        /* Name of the element */
 115     const char *xi_type;        /* Type of field */
 116     const char *xi_help;        /* Description of field */
 117 } xo_info_t;
 118
 119 #define XO_INFO_NULL NULL, NULL, NULL /* Use '{ XO_INFO_NULL }' to end lists */
 120
 121 struct xo_handle_s;             /* Opaque structure forward */
 122 typedef struct xo_handle_s xo_handle_t; /* Handle for XO output */
 123
 124 /*
 125  * Early versions of the API used "int" instead of "size_t" for buffer
 126  * sizes.  We want to fix this but allow for backwards compatibility
 127  * where needed.
 128  */
 129 #ifdef USE_INT_RETURN_CODES
 130 typedef int xo_ssize_t;         /* Buffer size */
 131 #else /* USE_INT_RETURN_CODES */
 132 typedef ssize_t xo_ssize_t;     /* Buffer size */
 133 #endif /* USE_INT_RETURN_CODES */
 134
 135 typedef xo_ssize_t (*xo_write_func_t)(void *, const char *);
 136 typedef void (*xo_close_func_t)(void *);
 137 typedef int (*xo_flush_func_t)(void *);
 138 typedef void *(*xo_realloc_func_t)(void *, size_t);
 139 typedef void (*xo_free_func_t)(void *);
 140
 141 /*
 142  * The formatter function mirrors "vsnprintf", with an additional argument
 143  * of the xo handle.  The caller should return the number of bytes _needed_
 144  * to fit the data, even if this exceeds 'len'.
 145  */
 146 typedef xo_ssize_t (*xo_formatter_t)(xo_handle_t *, char *, xo_ssize_t,
 147                                 const char *, va_list);
 148 typedef void (*xo_checkpointer_t)(xo_handle_t *, va_list, int);
 149
 150 xo_handle_t *
 151 xo_create (xo_style_t style, xo_xof_flags_t flags);
 152
 153 xo_handle_t *
 154 xo_create_to_file (FILE *fp, xo_style_t style, xo_xof_flags_t flags);
 155
 156 void
 157 xo_destroy (xo_handle_t *xop);
 158
 159 void
 160 xo_set_writer (xo_handle_t *xop, void *opaque, xo_write_func_t write_func,
 161                xo_close_func_t close_func, xo_flush_func_t flush_func);
 162
 163 void
 164 xo_set_allocator (xo_realloc_func_t realloc_func, xo_free_func_t free_func);
 165
 166 void
 167 xo_set_style (xo_handle_t *xop, xo_style_t style);
 168
 169 xo_style_t
 170 xo_get_style (xo_handle_t *xop);
 171
 172 int
 173 xo_set_style_name (xo_handle_t *xop, const char *style);
 174
 175 int
 176 xo_set_options (xo_handle_t *xop, const char *input);
 177
 178 xo_xof_flags_t
 179 xo_get_flags (xo_handle_t *xop);
 180
 181 void
 182 xo_set_flags (xo_handle_t *xop, xo_xof_flags_t flags);
 183
 184 void
 185 xo_clear_flags (xo_handle_t *xop, xo_xof_flags_t flags);
 186
 187 int
 188 xo_set_file_h (xo_handle_t *xop, FILE *fp);
 189
 190 int
 191 xo_set_file (FILE *fp);
 192
 193 void
 194 xo_set_info (xo_handle_t *xop, xo_info_t *infop, int count);
 195
 196 void
 197 xo_set_formatter (xo_handle_t *xop, xo_formatter_t func, xo_checkpointer_t);
 198
 199 void
 200 xo_set_depth (xo_handle_t *xop, int depth);
 201
 202 xo_ssize_t
 203 xo_emit_hv (xo_handle_t *xop, const char *fmt, va_list vap);
 204
 205 xo_ssize_t
 206 xo_emit_h (xo_handle_t *xop, const char *fmt, ...);
 207
 208 xo_ssize_t
 209 xo_emit (const char *fmt, ...);
 210
 211 xo_ssize_t
 212 xo_emit_hvf (xo_handle_t *xop, xo_emit_flags_t flags,
 213              const char *fmt, va_list vap);
 214
 215 xo_ssize_t
 216 xo_emit_hf (xo_handle_t *xop, xo_emit_flags_t flags, const char *fmt, ...);
 217
 218 xo_ssize_t
 219 xo_emit_f (xo_emit_flags_t flags, const char *fmt, ...);
 220
 221 PRINTFLIKE(2, 0)
 222 static inline int
 223 xo_emit_hvp (xo_handle_t *xop, const char *fmt, va_list vap)
 224 {
 225     return xo_emit_hv(xop, fmt, vap);
 226 }
 227
 228 PRINTFLIKE(2, 3)
 229 static inline int
 230 xo_emit_hp (xo_handle_t *xop, const char *fmt, ...)
 231 {
 232     va_list vap;
 233     va_start(vap, fmt);
 234     int rc = xo_emit_hv(xop, fmt, vap);
 235     va_end(vap);
 236     return rc;
 237 }
 238
 239 PRINTFLIKE(1, 2)
 240 static inline int
 241 xo_emit_p (const char *fmt, ...)
 242 {
 243     va_list vap;
 244     va_start(vap, fmt);
 245     int rc = xo_emit_hv(NULL, fmt, vap);
 246     va_end(vap);
 247     return rc;
 248 }
 249
 250 PRINTFLIKE(3, 0)
 251 static inline int
 252 xo_emit_hvfp (xo_handle_t *xop, xo_emit_flags_t flags,
 253               const char *fmt, va_list vap)
 254 {
 255     return xo_emit_hvf(xop, flags, fmt, vap);
 256 }
 257
 258 PRINTFLIKE(3, 4)
 259 static inline int
 260 xo_emit_hfp (xo_handle_t *xop, xo_emit_flags_t flags, const char *fmt, ...)
 261 {
 262     va_list vap;
 263     va_start(vap, fmt);
 264     int rc = xo_emit_hvf(xop, flags, fmt, vap);
 265     va_end(vap);
 266     return rc;
 267 }
 268
 269 PRINTFLIKE(2, 3)
 270 static inline int
 271 xo_emit_fp (xo_emit_flags_t flags, const char *fmt, ...)
 272 {
 273     va_list vap;
 274     va_start(vap, fmt);
 275     int rc = xo_emit_hvf(NULL, flags, fmt, vap);
 276     va_end(vap);
 277     return rc;
 278 }
 279
 280 xo_ssize_t
 281 xo_open_container_h (xo_handle_t *xop, const char *name);
 282
 283 xo_ssize_t
 284 xo_open_container (const char *name);
 285
 286 xo_ssize_t
 287 xo_open_container_hd (xo_handle_t *xop, const char *name);
 288
 289 xo_ssize_t
 290 xo_open_container_d (const char *name);
 291
 292 xo_ssize_t
 293 xo_close_container_h (xo_handle_t *xop, const char *name);
 294
 295 xo_ssize_t
 296 xo_close_container (const char *name);
 297
 298 xo_ssize_t
 299 xo_close_container_hd (xo_handle_t *xop);
 300
 301 xo_ssize_t
 302 xo_close_container_d (void);
 303
 304 xo_ssize_t
 305 xo_open_list_h (xo_handle_t *xop, const char *name);
 306
 307 xo_ssize_t
 308 xo_open_list (const char *name);
 309
 310 xo_ssize_t
 311 xo_open_list_hd (xo_handle_t *xop, const char *name);
 312
 313 xo_ssize_t
 314 xo_open_list_d (const char *name);
 315
 316 xo_ssize_t
 317 xo_close_list_h (xo_handle_t *xop, const char *name);
 318
 319 xo_ssize_t
 320 xo_close_list (const char *name);
 321
 322 xo_ssize_t
 323 xo_close_list_hd (xo_handle_t *xop);
 324
 325 xo_ssize_t
 326 xo_close_list_d (void);
 327
 328 xo_ssize_t
 329 xo_open_instance_h (xo_handle_t *xop, const char *name);
 330
 331 xo_ssize_t
 332 xo_open_instance (const char *name);
 333
 334 xo_ssize_t
 335 xo_open_instance_hd (xo_handle_t *xop, const char *name);
 336
 337 xo_ssize_t
 338 xo_open_instance_d (const char *name);
 339
 340 xo_ssize_t
 341 xo_close_instance_h (xo_handle_t *xop, const char *name);
 342
 343 xo_ssize_t
 344 xo_close_instance (const char *name);
 345
 346 xo_ssize_t
 347 xo_close_instance_hd (xo_handle_t *xop);
 348
 349 xo_ssize_t
 350 xo_close_instance_d (void);
 351
 352 xo_ssize_t
 353 xo_open_marker_h (xo_handle_t *xop, const char *name);
 354
 355 xo_ssize_t
 356 xo_open_marker (const char *name);
 357
 358 xo_ssize_t
 359 xo_close_marker_h (xo_handle_t *xop, const char *name);
 360
 361 xo_ssize_t
 362 xo_close_marker (const char *name);
 363
 364 xo_ssize_t
 365 xo_attr_h (xo_handle_t *xop, const char *name, const char *fmt, ...);
 366
 367 xo_ssize_t
 368 xo_attr_hv (xo_handle_t *xop, const char *name, const char *fmt, va_list vap);
 369
 370 xo_ssize_t
 371 xo_attr (const char *name, const char *fmt, ...);
 372
 373 void
 374 xo_error_hv (xo_handle_t *xop, const char *fmt, va_list vap);
 375
 376 void
 377 xo_error_h (xo_handle_t *xop, const char *fmt, ...);
 378
 379 void
 380 xo_error (const char *fmt, ...);
 381
 382 xo_ssize_t
 383 xo_flush_h (xo_handle_t *xop);
 384
 385 xo_ssize_t
 386 xo_flush (void);
 387
 388 xo_ssize_t
 389 xo_finish_h (xo_handle_t *xop);
 390
 391 xo_ssize_t
 392 xo_finish (void);
 393
 394 void
 395 xo_finish_atexit (void);
 396
 397 void
 398 xo_set_leading_xpath (xo_handle_t *xop, const char *path);
 399
 400 void
 401 xo_warn_hc (xo_handle_t *xop, int code, const char *fmt, ...) PRINTFLIKE(3, 4);
 402
 403 void
 404 xo_warn_c (int code, const char *fmt, ...) PRINTFLIKE(2, 3);
 405
 406 void
 407 xo_warn (const char *fmt, ...) PRINTFLIKE(1, 2);
 408
 409 void
 410 xo_warnx (const char *fmt, ...) PRINTFLIKE(1, 2);
 411
 412 void
 413 xo_err (int eval, const char *fmt, ...) NORETURN PRINTFLIKE(2, 3);
 414
 415 void
 416 xo_errx (int eval, const char *fmt, ...) NORETURN PRINTFLIKE(2, 3);
 417
 418 void
 419 xo_errc (int eval, int code, const char *fmt, ...) NORETURN PRINTFLIKE(3, 4);
 420
 421 void
 422 xo_message_hcv (xo_handle_t *xop, int code, const char *fmt, va_list vap) PRINTFLIKE(3, 0);
 423
 424 void
 425 xo_message_hc (xo_handle_t *xop, int code, const char *fmt, ...) PRINTFLIKE(3, 4);
 426
 427 void
 428 xo_message_c (int code, const char *fmt, ...) PRINTFLIKE(2, 3);
 429
 430 void
 431 xo_message_e (const char *fmt, ...) PRINTFLIKE(1, 2);
 432
 433 void
 434 xo_message (const char *fmt, ...) PRINTFLIKE(1, 2);
 435
 436 void
 437 xo_emit_warn_hcv (xo_handle_t *xop, int as_warning, int code,
 438                   const char *fmt, va_list vap);
 439
 440 void
 441 xo_emit_warn_hc (xo_handle_t *xop, int code, const char *fmt, ...);
 442
 443 void
 444 xo_emit_warn_c (int code, const char *fmt, ...);
 445
 446 void
 447 xo_emit_warn (const char *fmt, ...);
 448
 449 void
 450 xo_emit_warnx (const char *fmt, ...);
 451
 452 void
 453 xo_emit_err (int eval, const char *fmt, ...) NORETURN;
 454
 455 void
 456 xo_emit_errx (int eval, const char *fmt, ...) NORETURN;
 457
 458 void
 459 xo_emit_errc (int eval, int code, const char *fmt, ...) NORETURN;
 460
 461 PRINTFLIKE(4, 0)
 462 static inline void
 463 xo_emit_warn_hcvp (xo_handle_t *xop, int as_warning, int code,
 464                   const char *fmt, va_list vap)
 465 {
 466     xo_emit_warn_hcv(xop, as_warning, code, fmt, vap);
 467 }
 468
 469 PRINTFLIKE(3, 4)
 470 static inline void
 471 xo_emit_warn_hcp (xo_handle_t *xop, int code, const char *fmt, ...)
 472 {
 473     va_list vap;
 474     va_start(vap, fmt);
 475     xo_emit_warn_hcv(xop, 1, code, fmt, vap);
 476     va_end(vap);
 477 }
 478
 479 PRINTFLIKE(2, 3)
 480 static inline void
 481 xo_emit_warn_cp (int code, const char *fmt, ...)
 482 {
 483     va_list vap;
 484     va_start(vap, fmt);
 485     xo_emit_warn_hcv(NULL, 1, code, fmt, vap);
 486     va_end(vap);
 487 }
 488
 489 PRINTFLIKE(1, 2)
 490 static inline void
 491 xo_emit_warn_p (const char *fmt, ...)
 492 {
 493     int code = errno;
 494     va_list vap;
 495     va_start(vap, fmt);
 496     xo_emit_warn_hcv(NULL, 1, code, fmt, vap);
 497     va_end(vap);
 498 }
 499
 500 PRINTFLIKE(1, 2)
 501 static inline void
 502 xo_emit_warnx_p (const char *fmt, ...)
 503 {
 504     va_list vap;
 505     va_start(vap, fmt);
 506     xo_emit_warn_hcv(NULL, 1, -1, fmt, vap);
 507     va_end(vap);
 508 }
 509
 510 NORETURN PRINTFLIKE(2, 3)
 511 static inline void
 512 xo_emit_err_p (int eval, const char *fmt, ...)
 513 {
 514     int code = errno;
 515     va_list vap;
 516     va_start(vap, fmt);
 517     xo_emit_warn_hcv(NULL, 0, code, fmt, vap);
 518     va_end(vap);
 519
 520     exit(eval);
 521 }
 522
 523 PRINTFLIKE(2, 3)
 524 static inline void
 525 xo_emit_errx_p (int eval, const char *fmt, ...)
 526 {
 527     va_list vap;
 528     va_start(vap, fmt);
 529     xo_emit_warn_hcv(NULL, 0, -1, fmt, vap);
 530     va_end(vap);
 531     exit(eval);
 532 }
 533
 534 PRINTFLIKE(3, 4)
 535 static inline void
 536 xo_emit_errc_p (int eval, int code, const char *fmt, ...)
 537 {
 538     va_list vap;
 539     va_start(vap, fmt);
 540     xo_emit_warn_hcv(NULL, 0, code, fmt, vap);
 541     va_end(vap);
 542     exit(eval);
 543 }
 544
 545 void
 546 xo_emit_err_v (int eval, int code, const char *fmt, va_list vap) NORETURN PRINTFLIKE(3, 0);
 547
 548 void
 549 xo_no_setlocale (void);
 550
 551 /**
 552  * @brief Lift libxo-specific arguments from a set of arguments
 553  *
 554  * libxo-enable programs typically use command line options to enable
 555  * all the nifty-cool libxo features.  xo_parse_args() makes this simple
 556  * by pre-processing the command line arguments given to main(), handling
 557  * and removing the libxo-specific ones, meaning anything starting with
 558  * "--libxo".  A full description of these arguments is in the base
 559  * documentation.
 560  * @param[in] argc Number of arguments (ala #main())
 561  * @param[in] argc Array of argument strings (ala #main())
 562  * @return New number of arguments, or -1 for failure.
 563  */
 564 int
 565 xo_parse_args (int argc, char **argv);
 566
 567 /**
 568  * This is the "magic" number returned by libxo-supporting commands
 569  * when passed the equally magic "--libxo-check" option.  If you
 570  * return this, we can (unsafely) assume that since you know the magic
 571  * handshake, you'll happily handle future --libxo options and not do
 572  * something violent like reboot the box or create another hole in the
 573  * ozone layer.
 574  */
 575 #define XO_HAS_LIBXO    121
 576
 577 /**
 578  * externs for libxo's version number strings
 579  */
 580 extern const char xo_version[];       /** Base version triple string */
 581 extern const char xo_version_extra[]; /** Extra version magic content */
 582
 583 /**
 584  * @brief Dump the internal stack of a libxo handle.
 585  *
 586  * This diagnostic function is something I will ask you to call from
 587  * your program when you write to tell me libxo has gone bat-stink
 588  * crazy and has discarded your list or container or content.  Output
 589  * content will be what we lovingly call "developer entertainment".
 590  * @param[in] xop A valid libxo handle, or NULL for the default handle
 591  */
 592 void
 593 xo_dump_stack (xo_handle_t *xop);
 594
 595 /**
 596  * @brief Recode the name of the program, suitable for error output.
 597  *
 598  * libxo will record the given name for use while generating error
 599  * messages.  The contents are not copied, so the value must continue
 600  * to point to a valid memory location.  This allows the caller to change
 601  * the value, but requires the caller to manage the memory.  Typically
 602  * this is called with argv[0] from main().
 603  * @param[in] name The name of the current application program
 604  */
 605 void
 606 xo_set_program (const char *name);
 607
 608 /**
 609  * @brief Add a version string to the output, where possible.
 610  *
 611  * Adds a version number to the output, suitable for tracking
 612  * changes in the content.  This is only important for the "encoding"
 613  * format styles (XML and JSON) and allows a user of the data to
 614  * discern which version of the data model is in use.
 615  * @param[in] version The version number, encoded as a string
 616  */
 617 void
 618 xo_set_version (const char *version);
 619
 620 /**
 621  * #xo_set_version with a handle.
 622  * @param[in] xop A valid libxo handle, or NULL for the default handle
 623  * @param[in] version The version number, encoded as a string
 624  */
 625 void
 626 xo_set_version_h (xo_handle_t *xop, const char *version);
 627
 628 void
 629 xo_open_log (const char *ident, int logopt, int facility);
 630
 631 void
 632 xo_close_log (void);
 633
 634 int
 635 xo_set_logmask (int maskpri);
 636
 637 void
 638 xo_set_unit_test_mode (int value);
 639
 640 void
 641 xo_syslog (int priority, const char *name, const char *message, ...);
 642
 643 void
 644 xo_vsyslog (int priority, const char *name, const char *message, va_list args);
 645
 646 typedef void (*xo_syslog_open_t)(void);
 647 typedef void (*xo_syslog_send_t)(const char *full_msg,
 648                                  const char *v0_hdr, const char *text_only);
 649 typedef void (*xo_syslog_close_t)(void);
 650
 651 void
 652 xo_set_syslog_handler (xo_syslog_open_t open_func, xo_syslog_send_t send_func,
 653                        xo_syslog_close_t close_func);
 654
 655 void
 656 xo_set_syslog_enterprise_id (unsigned short eid);
 657
 658 typedef void (*xo_simplify_field_func_t)(const char *, unsigned, int);
 659
 660 char *
 661 xo_simplify_format (xo_handle_t *xop, const char *fmt, int with_numbers,
 662                     xo_simplify_field_func_t field_cb);
 663
 664 xo_ssize_t
 665 xo_emit_field_hv (xo_handle_t *xop, const char *rolmod, const char *contents,
 666                   const char *fmt, const char *efmt,
 667                   va_list vap);
 668
 669 xo_ssize_t
 670 xo_emit_field_h (xo_handle_t *xop, const char *rolmod, const char *contents,
 671                  const char *fmt, const char *efmt, ...);
 672
 673 xo_ssize_t
 674 xo_emit_field (const char *rolmod, const char *contents,
 675                const char *fmt, const char *efmt, ...);
 676
 677 void
 678 xo_retain_clear_all (void);
 679
 680 void
 681 xo_retain_clear (const char *fmt);
 682
 683 #endif /* INCLUDE_XO_H */