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
|
/*--------------------------------------------------------------------
* Copyright © 2016 James Hunt <jamesodhunt@ubuntu.com>.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*--------------------------------------------------------------------
*/
#ifndef _PROCENV_OUTPUT_H
#define _PROCENV_OUTPUT_H
#include "types.h"
#include "pstring.h"
#define show(...) _show ("", get_indent_amount (), __VA_ARGS__)
/**
* showi:
*
* @_indent: additional indent amount,
* @fmt: printf-style format and optional arguments.
*
* Write indented message to appropriate output location.
**/
#define showi(_indent, ...) \
_show ("", get_indent_amount() + _indent, __VA_ARGS__)
/**
* _message:
* @prefix: Fixed message prefix,
* @fmt: printf-style format and optional arguments.
*
* Write unindented message to appropriate output location.
**/
#define _message(prefix, ...) _show (prefix, 0, __VA_ARGS__)
#define warn(...) \
{ \
_message ("WARNING", __VA_ARGS__); \
}
#ifdef DEBUG
/* for when running under GDB */
#define die_finalise() raise (SIGUSR1)
#else
#define die_finalise() exit (EXIT_FAILURE)
#endif
#define bug(...) \
{ \
_show ("BUG", 0, __VA_ARGS__); \
exit (EXIT_FAILURE); \
}
#define POINTER_SIZE (sizeof (void *))
#define die(...) \
{ \
output = OUTPUT_STDERR; \
_message ("ERROR", __VA_ARGS__); \
cleanup (); \
die_finalise (); \
}
#define common_assert() \
assert (doc); \
assert (get_indent_amount() >= 0)
#define assert_not_reached() \
do { \
die ("%s:%d: Not reached assertion failed in %s", \
__FILE__, __LINE__, __func__); \
} while (0)
typedef enum procenv_output {
OUTPUT_FILE,
OUTPUT_STDERR,
OUTPUT_STDOUT,
OUTPUT_SYSLOG,
OUTPUT_TERM
} Output;
typedef enum {
OUTPUT_FORMAT_TEXT,
OUTPUT_FORMAT_CRUMB,
OUTPUT_FORMAT_JSON,
OUTPUT_FORMAT_XML
} OutputFormat;
typedef enum element_type {
ELEMENT_TYPE_ENTRY,
ELEMENT_TYPE_SECTION_OPEN,
ELEMENT_TYPE_SECTION_CLOSE,
ELEMENT_TYPE_CONTAINER_OPEN,
ELEMENT_TYPE_CONTAINER_CLOSE,
ELEMENT_TYPE_OBJECT_OPEN,
ELEMENT_TYPE_OBJECT_CLOSE,
ELEMENT_TYPE_NONE = -1
} ElementType;
/********************************************************************/
extern Output output;
extern OutputFormat output_format;
extern wchar_t wide_indent_char;
void cleanup (void);
/********************************************************************/
void output_init (void);
void output_finalise (void);
void header (const char *name);
void footer (void);
void master_header (pstring **doc);
void master_footer (pstring **doc);
void object_open (int retain);
void object_close (int retain);
void section_open (const char *name);
void section_close (void);
void container_open (const char *name);
void container_close (void);
void entry (const char *name, const char *fmt, ...);
void _show (const char *prefix, int indent, const char *fmt, ...);
void _show_output (const char *str);
void _show_output_pstring (const pstring *pstr);
void inc_indent (void);
void dec_indent (void);
void reset_indent (void);
void add_indent (pstring **doc);
void set_indent_amount (int amount);
int get_indent_amount (void);
const char *get_indent_char (void);
void set_indent_char (const char *c);
void handle_indent_char (void);
void add_breadcrumb (const char *name);
void remove_breadcrumb (void);
void set_crumb_separator (const char *c);
const char *get_crumb_separator (void);
void set_output_file (const char *f);
void set_output_file_append (void);
void change_element (ElementType new);
void format_element (void);
void format_text_element (void);
void format_json_element (void);
void format_xml_element (void);
void set_output_value (const char *name);
void set_output_value_raw (Output o);
void set_output_format (const char *name);
const char *get_output_format_name (void);
const char *get_text_separator (void);
void set_text_separator (const char *s);
#endif /* _PROCENV_OUTPUT_H */
|
