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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* dbus-string.h String utility class (internal to D-Bus implementation)
*
* Copyright (C) 2002, 2003 Red Hat, Inc.
* Copyright (C) 2006 Ralf Habacker <ralf.habacker@freenet.de>
*
* Licensed under the Academic Free License version 2.1
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef DBUS_STRING_H
#define DBUS_STRING_H
#include <dbus/dbus-macros.h>
#include <dbus/dbus-types.h>
#include <dbus/dbus-memory.h>
#include <stdarg.h>
DBUS_BEGIN_DECLS
/**
* DBusString object
*/
typedef struct DBusString DBusString;
struct DBusString
{
#if defined(DBUS_WIN) && defined(_DEBUG)
const char *dummy1; /**< placeholder */
#else
const void *dummy1; /**< placeholder */
#endif
int dummy2; /**< placeholder */
int dummy3; /**< placeholder */
unsigned int dummy_bit1 : 1; /**< placeholder */
unsigned int dummy_bit2 : 1; /**< placeholder */
unsigned int dummy_bit3 : 1; /**< placeholder */
unsigned int dummy_bits : 3; /**< placeholder */
};
#ifdef DBUS_DISABLE_ASSERT
/* Some simple inlining hacks; the current linker is not smart enough
* to inline non-exported symbols across files in the library.
* Note that these break type safety (due to the casts)
*/
#define _dbus_string_get_data(s) ((char*)(((DBusString*)(s))->dummy1))
#define _dbus_string_get_length(s) (((DBusString*)(s))->dummy2)
#define _dbus_string_get_allocated(s) (((DBusString*)(s))->dummy3 - _DBUS_STRING_ALLOCATION_PADDING)
#define _dbus_string_set_byte(s, i, b) ((((unsigned char*)(((DBusString*)(s))->dummy1))[(i)]) = (unsigned char) (b))
#define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)])
#define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1))
#define _dbus_string_get_const_data_len(s,start,len) (((const char*)(((DBusString*)(s))->dummy1)) + (start))
#endif
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_init (DBusString *str);
DBUS_PRIVATE_EXPORT
void _dbus_string_init_const (DBusString *str,
const char *value);
DBUS_PRIVATE_EXPORT
void _dbus_string_init_const_len (DBusString *str,
const char *value,
int len);
dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
int allocate_size);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_init_from_string (DBusString *str,
const DBusString *from);
DBUS_PRIVATE_EXPORT
void _dbus_string_free (DBusString *str);
void _dbus_string_lock (DBusString *str);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_compact (DBusString *str,
int max_waste);
#ifndef _dbus_string_get_data
DBUS_PRIVATE_EXPORT
char* _dbus_string_get_data (DBusString *str);
#endif /* _dbus_string_get_data */
#ifndef _dbus_string_get_const_data
DBUS_PRIVATE_EXPORT
const char* _dbus_string_get_const_data (const DBusString *str);
#endif /* _dbus_string_get_const_data */
char* _dbus_string_get_data_len (DBusString *str,
int start,
int len);
#ifndef _dbus_string_get_const_data_len
DBUS_PRIVATE_EXPORT
const char* _dbus_string_get_const_data_len (const DBusString *str,
int start,
int len);
#endif
#ifndef _dbus_string_set_byte
DBUS_PRIVATE_EXPORT
void _dbus_string_set_byte (DBusString *str,
int i,
unsigned char byte);
#endif
#ifndef _dbus_string_get_byte
DBUS_PRIVATE_EXPORT
unsigned char _dbus_string_get_byte (const DBusString *str,
int start);
#endif /* _dbus_string_get_byte */
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
int i,
int n_bytes,
unsigned char byte);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_insert_byte (DBusString *str,
int i,
unsigned char byte);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_steal_data (DBusString *str,
char **data_return);
dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
char **data_return,
int start,
int len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_copy_data (const DBusString *str,
char **data_return);
dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
char **data_return,
int start,
int len);
void _dbus_string_copy_to_buffer (const DBusString *str,
char *buffer,
int len);
DBUS_PRIVATE_EXPORT
void _dbus_string_copy_to_buffer_with_nul (const DBusString *str,
char *buffer,
int avail_len);
#ifndef _dbus_string_get_length
DBUS_PRIVATE_EXPORT
int _dbus_string_get_length (const DBusString *str);
#endif /* !_dbus_string_get_length */
#ifndef _dbus_string_get_allocated
int _dbus_string_get_allocated (const DBusString *str);
#endif /* !_dbus_string_get_allocated */
/**
* Get the string's length as an unsigned integer, for comparison with
* size_t and similar unsigned types that does not trigger compiler
* warnings about potential value changes during conversion.
*
* DBusString lengths are signed for historical reasons, but we know that
* the length is always >= 0 (and DBUS_GENERIC_STRING_PREAMBLE asserts
* that this is the case) so we know that this cast does not change the
* value.
*/
static inline unsigned int
_dbus_string_get_length_uint (const DBusString *str)
{
return (unsigned int) _dbus_string_get_length (str);
}
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_lengthen (DBusString *str,
int additional_length);
DBUS_PRIVATE_EXPORT
void _dbus_string_shorten (DBusString *str,
int length_to_remove);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_set_length (DBusString *str,
int length);
dbus_bool_t _dbus_string_align_length (DBusString *str,
int alignment);
dbus_bool_t _dbus_string_alloc_space (DBusString *str,
int extra_bytes);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_append (DBusString *str,
const char *buffer);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_append_len (DBusString *str,
const char *buffer,
int len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_append_int (DBusString *str,
long value);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_append_uint (DBusString *str,
unsigned long value);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_append_byte (DBusString *str,
unsigned char byte);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_append_printf (DBusString *str,
const char *format,
...) _DBUS_GNUC_PRINTF (2, 3);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
const char *format,
va_list args);
dbus_bool_t _dbus_string_insert_2_aligned (DBusString *str,
int insert_at,
const unsigned char octets[2]);
dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str,
int insert_at,
const unsigned char octets[4]);
dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str,
int insert_at,
const unsigned char octets[8]);
dbus_bool_t _dbus_string_insert_alignment (DBusString *str,
int *insert_at,
int alignment);
DBUS_PRIVATE_EXPORT
void _dbus_string_delete (DBusString *str,
int start,
int len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_move (DBusString *source,
int start,
DBusString *dest,
int insert_at);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_copy (const DBusString *source,
int start,
DBusString *dest,
int insert_at);
dbus_bool_t _dbus_string_move_len (DBusString *source,
int start,
int len,
DBusString *dest,
int insert_at);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_copy_len (const DBusString *source,
int start,
int len,
DBusString *dest,
int insert_at);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_replace_len (const DBusString *source,
int start,
int len,
DBusString *dest,
int replace_at,
int replace_len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_split_on_byte (DBusString *source,
unsigned char byte,
DBusString *tail);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_parse_int (const DBusString *str,
int start,
long *value_return,
int *end_return);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
int start,
unsigned long *value_return,
int *end_return);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_find (const DBusString *str,
int start,
const char *substr,
int *found);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_find_eol (const DBusString *str,
int start,
int *found,
int *found_len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_find_to (const DBusString *str,
int start,
int end,
const char *substr,
int *found);
dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
int start,
unsigned char byte,
int *found);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_find_blank (const DBusString *str,
int start,
int *found);
DBUS_PRIVATE_EXPORT
void _dbus_string_skip_blank (const DBusString *str,
int start,
int *end);
DBUS_PRIVATE_EXPORT
void _dbus_string_skip_white (const DBusString *str,
int start,
int *end);
void _dbus_string_skip_white_reverse (const DBusString *str,
int end,
int *start);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_equal (const DBusString *a,
const DBusString *b);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
const char *c_str);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_equal_len (const DBusString *a,
const DBusString *b,
int len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_equal_substring (const DBusString *a,
int a_start,
int a_len,
const DBusString *b,
int b_start);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
const char *c_str);
dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
const char *c_str);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_pop_line (DBusString *source,
DBusString *dest);
DBUS_PRIVATE_EXPORT
void _dbus_string_delete_first_word (DBusString *str);
DBUS_PRIVATE_EXPORT
void _dbus_string_delete_leading_blanks (DBusString *str);
DBUS_PRIVATE_EXPORT
void _dbus_string_chop_white (DBusString *str);
dbus_bool_t _dbus_string_append_byte_as_hex (DBusString *str,
unsigned char byte);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
int start,
DBusString *dest,
int insert_at);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
int start,
int *end_return,
DBusString *dest,
int insert_at);
DBUS_PRIVATE_EXPORT
void _dbus_string_tolower_ascii (const DBusString *str,
int start,
int len);
DBUS_PRIVATE_EXPORT
void _dbus_string_toupper_ascii (const DBusString *str,
int start,
int len);
dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
int start,
int len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
int start,
int len);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
int start,
int len);
void _dbus_string_zero (DBusString *str);
/**
* We allocate 1 byte for nul termination, plus 7 bytes for possible
* align_offset, so we always need 8 bytes on top of the string's
* length to be in the allocated block.
*/
#define _DBUS_STRING_ALLOCATION_PADDING 8
/**
* Defines a static const variable with type #DBusString called "name"
* containing the given string literal.
*
* @param name the name of the variable
* @param str the string value
*/
#define _DBUS_STRING_DEFINE_STATIC(name, str) \
static const char _dbus_static_string_##name[] = str; \
static const DBusString name = { _dbus_static_string_##name, \
sizeof(_dbus_static_string_##name), \
sizeof(_dbus_static_string_##name) + \
_DBUS_STRING_ALLOCATION_PADDING, \
TRUE, TRUE, FALSE, 0 }
DBUS_END_DECLS
#endif /* DBUS_STRING_H */
|
