1/*
2 * Copyright (c) 2001-2003
3 *	Fraunhofer Institute for Open Communication Systems (FhG Fokus).
4 * 	All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 * Author: Hartmut Brandt <harti@freebsd.org>
28 *
29 * $Begemot: libunimsg/netnatm/msg/uniprint.h,v 1.4 2004/07/08 08:22:08 brandt Exp $
30 *
31 * Print utility functions. These are only needed if you want to hook to
32 * the format of the uni printing routines.
33 */
34#ifndef _NETNATM_MSG_UNIPRINT_H_
35#define _NETNATM_MSG_UNIPRINT_H_
36
37#include <netnatm/msg/uni_config.h>
38
39/*
40 * This structure is used to define value->string mappings.
41 * It must be terminated by a { NULL, 0 } entry.
42 */
43struct uni_print_tbl {
44	const char *name;
45	u_int val;
46};
47void uni_print_tbl(const char *_entry, u_int _val,
48    const struct uni_print_tbl *_tbl, struct unicx *_cx);
49
50/* initialize printing. This must be called at the start from each external
51 * callable printing function. */
52void uni_print_init(char *_buf, size_t _bufsiz, struct unicx *_cx);
53
54/* End the current (semantical) line. This takes care of indendation and
55 * actually print the newline in the appropriate modes. */
56void uni_print_eol(struct unicx *_cx);
57
58/* Push or pop a prefix. This takes care of indendation. */
59void uni_print_push_prefix(const char *_prefix, struct unicx *_cx);
60void uni_print_pop_prefix(struct unicx *_cx);
61
62/* Print a flag taking care of the right prefixing */
63void uni_print_flag(const char *_flag, struct unicx *_cx);
64
65/* Print an entry taking care of the right prefixing */
66void uni_print_entry(struct unicx *_cx, const char *_entry,
67    const char *_fmt, ...) __printflike(3, 4);
68
69/* Generic printf */
70void uni_printf(struct unicx *_cx, const char *_fmt, ...) __printflike(2, 3);
71
72#endif
73