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
|
/* Some string handling -- header
* Copyright (C) 2009 Chris Hall (GMCH), Highwayman
*
* This file is part of GNU Zebra.
*
* GNU Zebra 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 2, or (at your
* option) any later version.
*
* GNU Zebra 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 GNU Zebra; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef _ZEBRA_QFSTRING_H
#define _ZEBRA_QFSTRING_H
#include "misc.h"
#include "vargs.h"
/*==============================================================================
* These "qfstrings" address the issues of dealing with *fixed* length
* strings, particularly where the string handling must be async-signal-safe.
*
* Are also used to support snprintf() style printing, but to one or more
* fixed length buffers.
*/
/* When initialised a qf_string is set:
*
* str = start of string -- and this is never changed
* ptr = start of string -- this is moved as stuff is appended
* end = end of string -- and this is never changed
* offset = number of characters left to omit -- used to collect a long
* string in more than one section
* overflow = number of characters that had to leave out, because string
* was too short.
*
* When filling the string, will work right up to the byte just before the
* end. Does not terminate the string -- that must be done explicitly.
*/
struct qf_str
{
char* str ; /* start of string */
char* ptr ; /* current position */
char* end ; /* end of string */
uint offset ; /* number of chars to omit */
uint overflow ; /* number of excess chars */
} ;
typedef struct qf_str qf_str_t[1] ;
typedef struct qf_str* qf_str ;
/*------------------------------------------------------------------------------
* Print format flags for number printing
*/
enum pf_flags
{
pf_none = 0,
/* The following correspond to the "flags" */
pf_commas = BIT( 0), /* "'" seen */
pf_plus = BIT( 1), /* "+" seen */
pf_space = BIT( 2), /* " " seen */
pf_zeros = BIT( 3), /* "0" seen */
pf_alt = BIT( 4), /* "#" seen */
pf_precision = BIT( 7), /* '.' seen */
/* The following signal how to render the value */
pf_hex = BIT( 8), /* hex */
pf_uc = BIT( 9), /* upper-case */
/* The following signal the type of value */
pf_ptr = BIT(14), /* is a pointer */
pf_unsigned = BIT(15), /* unsigned value */
/* Common combination */
pf_hex_x = pf_unsigned | pf_hex,
pf_hex_X = pf_unsigned | pf_hex | pf_uc,
pf_void_p = pf_ptr | pf_hex_x,
} ;
/*==============================================================================
* Functions
*/
extern void qfs_init(qf_str qfs, char* str, uint size) ;
extern void qfs_init_offset(qf_str qfs, char* str, uint size, uint offset) ;
extern void qfs_reset_offset(qf_str qfs, uint offset) ;
extern void qfs_init_as_is(qf_str qfs, char* str, uint size) ;
Inline uint qfs_overflow(qf_str qfs) ;
Inline uint qfs_term(qf_str qfs) ;
extern void qfs_term_string(qf_str qfs, const char* src, uint n) ;
Inline uint qfs_len(qf_str qfs) ;
Inline void* qfs_ptr(qf_str qfs) ;
Inline uint qfs_left(qf_str qfs) ;
extern void qfs_append(qf_str qfs, const char* src) ;
extern void qfs_append_n(qf_str qfs, const char* src, uint n) ;
extern void qfs_append_ch_x_n(qf_str qfs, char ch, uint n) ;
extern void qfs_append_justified(qf_str qfs, const char* src, int width) ;
extern void qfs_append_justified_n(qf_str qfs, const char* src,
uint n, int width) ;
extern void qfs_signed(qf_str qfs, intmax_t s_val, enum pf_flags flags,
int width, int precision) ;
extern void qfs_unsigned(qf_str qfs, uintmax_t u_val, enum pf_flags flags,
int width, int precision) ;
extern void qfs_pointer(qf_str qfs, void* p_val, enum pf_flags flags,
int width, int precision) ;
extern uint qfs_printf(qf_str qfs, const char* format, ...)
PRINTF_ATTRIBUTE(2, 3) ;
extern uint qfs_vprintf(qf_str qfs, const char *format, va_list args) ;
Inline uint qfs_strlen(const char* str) ;
/*==============================================================================
* The Inline functions.
*/
/*------------------------------------------------------------------------------
* Current length of qf_str.
*/
Inline uint
qfs_len(qf_str qfs)
{
return qfs->ptr - qfs->str ;
} ;
/*------------------------------------------------------------------------------
* Address for next byte -- assuming zero offset -- may be the end.
*/
Inline void*
qfs_ptr(qf_str qfs)
{
return qfs->ptr ;
} ;
/*------------------------------------------------------------------------------
* Current space left in the qstr -- assuming zero offset.
*/
Inline uint
qfs_left(qf_str qfs)
{
return qfs->end - qfs->ptr ;
} ;
/*------------------------------------------------------------------------------
* Did everything we put in the qfs, fit ?.
*
* Returns: number of chars that did *not* fit.
*/
Inline uint
qfs_overflow(qf_str qfs)
{
return qfs->overflow ;
} ;
/*------------------------------------------------------------------------------
* Insert '\0' terminator -- overwrites the last byte, if required.
*
* Assumes the qfs is not zero length !
*
* Returns: number of chars that did *not* fit (after using one for '\0').
*
* NB: does not advance pointer -- so length does not include the '\0'
*/
Inline uint
qfs_term(qf_str qfs)
{
if (qfs->ptr >= qfs->end)
{
assert((qfs->ptr == qfs->end) && (qfs->ptr > qfs->str)) ;
--qfs->ptr ;
++qfs->overflow ;
} ;
*qfs->ptr = '\0' ;
return qfs->overflow ;
} ;
/*------------------------------------------------------------------------------
* async-signal-safe strlen
*/
Inline uint
qfs_strlen(const char* str)
{
const char* s ;
s = str ;
if (s != NULL)
while (*s != '\0')
++s ;
return s - str ;
}
#endif /* _ZEBRA_QSTRING_H */
|
