D-Bus  1.12.16
dbus-string.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-string.h String utility class (internal to D-Bus implementation)
3  *
4  * Copyright (C) 2002, 2003 Red Hat, Inc.
5  * Copyright (C) 2006 Ralf Habacker <ralf.habacker@freenet.de>
6  *
7  * Licensed under the Academic Free License version 2.1
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 #ifndef DBUS_STRING_H
26 #define DBUS_STRING_H
27 
28 #include <dbus/dbus-macros.h>
29 #include <dbus/dbus-types.h>
30 #include <dbus/dbus-memory.h>
31 
32 #include <stdarg.h>
33 
35 
40 typedef struct DBusString DBusString;
41 
42 struct DBusString
43 {
44 #if defined(DBUS_WIN) && defined(_DEBUG)
45  const char *dummy1;
46 #else
47  const void *dummy1;
48 #endif
49  int dummy2;
50  int dummy3;
51  unsigned int dummy_bit1 : 1;
52  unsigned int dummy_bit2 : 1;
53  unsigned int dummy_bit3 : 1;
54  unsigned int dummy_bits : 3;
55 };
56 
57 #ifdef DBUS_DISABLE_ASSERT
58 /* Some simple inlining hacks; the current linker is not smart enough
59  * to inline non-exported symbols across files in the library.
60  * Note that these break type safety (due to the casts)
61  */
62 #define _dbus_string_get_data(s) ((char*)(((DBusString*)(s))->dummy1))
63 #define _dbus_string_get_length(s) (((DBusString*)(s))->dummy2)
64 #define _dbus_string_set_byte(s, i, b) ((((unsigned char*)(((DBusString*)(s))->dummy1))[(i)]) = (unsigned char) (b))
65 #define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)])
66 #define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1))
67 #define _dbus_string_get_const_data_len(s,start,len) (((const char*)(((DBusString*)(s))->dummy1)) + (start))
68 #endif
69 
70 DBUS_PRIVATE_EXPORT
72 DBUS_PRIVATE_EXPORT
74  const char *value);
75 DBUS_PRIVATE_EXPORT
77  const char *value,
78  int len);
80  int allocate_size);
81 
82 DBUS_PRIVATE_EXPORT
84  const DBusString *from);
85 DBUS_PRIVATE_EXPORT
86 void _dbus_string_free (DBusString *str);
87 void _dbus_string_lock (DBusString *str);
88 DBUS_PRIVATE_EXPORT
90  int max_waste);
91 #ifndef _dbus_string_get_data
92 DBUS_PRIVATE_EXPORT
94 #endif /* _dbus_string_get_data */
95 #ifndef _dbus_string_get_const_data
96 DBUS_PRIVATE_EXPORT
97 const char* _dbus_string_get_const_data (const DBusString *str);
98 #endif /* _dbus_string_get_const_data */
100  int start,
101  int len);
102 #ifndef _dbus_string_get_const_data_len
103 DBUS_PRIVATE_EXPORT
104 const char* _dbus_string_get_const_data_len (const DBusString *str,
105  int start,
106  int len);
107 #endif
108 #ifndef _dbus_string_set_byte
109 DBUS_PRIVATE_EXPORT
111  int i,
112  unsigned char byte);
113 #endif
114 #ifndef _dbus_string_get_byte
115 DBUS_PRIVATE_EXPORT
116 unsigned char _dbus_string_get_byte (const DBusString *str,
117  int start);
118 #endif /* _dbus_string_get_byte */
119 DBUS_PRIVATE_EXPORT
121  int i,
122  int n_bytes,
123  unsigned char byte);
124 DBUS_PRIVATE_EXPORT
126  int i,
127  unsigned char byte);
128 DBUS_PRIVATE_EXPORT
130  char **data_return);
131 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
132  char **data_return,
133  int start,
134  int len);
135 DBUS_PRIVATE_EXPORT
137  char **data_return);
138 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
139  char **data_return,
140  int start,
141  int len);
142 void _dbus_string_copy_to_buffer (const DBusString *str,
143  char *buffer,
144  int len);
145 DBUS_PRIVATE_EXPORT
147  char *buffer,
148  int avail_len);
149 #ifndef _dbus_string_get_length
150 DBUS_PRIVATE_EXPORT
151 int _dbus_string_get_length (const DBusString *str);
152 #endif /* !_dbus_string_get_length */
153 
164 static inline unsigned int
165 _dbus_string_get_length_uint (const DBusString *str)
166 {
167  return (unsigned int) _dbus_string_get_length (str);
168 }
169 
170 DBUS_PRIVATE_EXPORT
172  int additional_length);
173 DBUS_PRIVATE_EXPORT
175  int length_to_remove);
176 DBUS_PRIVATE_EXPORT
178  int length);
180  int alignment);
182  int extra_bytes);
183 DBUS_PRIVATE_EXPORT
185  const char *buffer);
186 DBUS_PRIVATE_EXPORT
188  const char *buffer,
189  int len);
190 DBUS_PRIVATE_EXPORT
192  long value);
193 DBUS_PRIVATE_EXPORT
195  unsigned long value);
196 DBUS_PRIVATE_EXPORT
198  unsigned char byte);
199 DBUS_PRIVATE_EXPORT
201  const char *format,
202  ...) _DBUS_GNUC_PRINTF (2, 3);
203 DBUS_PRIVATE_EXPORT
205  const char *format,
206  va_list args) _DBUS_GNUC_PRINTF (2, 0);
208  int insert_at,
209  const unsigned char octets[2]);
211  int insert_at,
212  const unsigned char octets[4]);
214  int insert_at,
215  const unsigned char octets[8]);
217  int *insert_at,
218  int alignment);
219 DBUS_PRIVATE_EXPORT
221  int start,
222  int len);
223 DBUS_PRIVATE_EXPORT
225  int start,
226  DBusString *dest,
227  int insert_at);
228 DBUS_PRIVATE_EXPORT
230  int start,
231  DBusString *dest,
232  int insert_at);
234  int start,
235  int len,
236  DBusString *dest,
237  int insert_at);
238 DBUS_PRIVATE_EXPORT
240  int start,
241  int len,
242  DBusString *dest,
243  int insert_at);
244 DBUS_PRIVATE_EXPORT
246  int start,
247  int len,
248  DBusString *dest,
249  int replace_at,
250  int replace_len);
251 DBUS_PRIVATE_EXPORT
253  unsigned char byte,
254  DBusString *tail);
255 DBUS_PRIVATE_EXPORT
257  int start,
258  long *value_return,
259  int *end_return);
260 DBUS_PRIVATE_EXPORT
262  int start,
263  unsigned long *value_return,
264  int *end_return);
265 DBUS_PRIVATE_EXPORT
267  int start,
268  const char *substr,
269  int *found);
270 DBUS_PRIVATE_EXPORT
272  int start,
273  int *found,
274  int *found_len);
275 DBUS_PRIVATE_EXPORT
277  int start,
278  int end,
279  const char *substr,
280  int *found);
282  int start,
283  unsigned char byte,
284  int *found);
285 DBUS_PRIVATE_EXPORT
287  int start,
288  int *found);
289 DBUS_PRIVATE_EXPORT
290 void _dbus_string_skip_blank (const DBusString *str,
291  int start,
292  int *end);
293 DBUS_PRIVATE_EXPORT
294 void _dbus_string_skip_white (const DBusString *str,
295  int start,
296  int *end);
298  int end,
299  int *start);
300 DBUS_PRIVATE_EXPORT
302  const DBusString *b);
303 DBUS_PRIVATE_EXPORT
305  const char *c_str);
306 DBUS_PRIVATE_EXPORT
308  const DBusString *b,
309  int len);
310 DBUS_PRIVATE_EXPORT
312  int a_start,
313  int a_len,
314  const DBusString *b,
315  int b_start);
316 DBUS_PRIVATE_EXPORT
318  const char *c_str);
320  const char *c_str);
321 DBUS_PRIVATE_EXPORT
323  DBusString *dest);
324 DBUS_PRIVATE_EXPORT
325 void _dbus_string_delete_first_word (DBusString *str);
326 DBUS_PRIVATE_EXPORT
327 void _dbus_string_delete_leading_blanks (DBusString *str);
328 DBUS_PRIVATE_EXPORT
331  unsigned char byte);
332 DBUS_PRIVATE_EXPORT
334  int start,
335  DBusString *dest,
336  int insert_at);
337 DBUS_PRIVATE_EXPORT
339  int start,
340  int *end_return,
341  DBusString *dest,
342  int insert_at);
343 DBUS_PRIVATE_EXPORT
344 void _dbus_string_tolower_ascii (const DBusString *str,
345  int start,
346  int len);
347 DBUS_PRIVATE_EXPORT
348 void _dbus_string_toupper_ascii (const DBusString *str,
349  int start,
350  int len);
352  int start,
353  int len);
354 DBUS_PRIVATE_EXPORT
356  int start,
357  int len);
358 DBUS_PRIVATE_EXPORT
360  int start,
361  int len);
362 void _dbus_string_zero (DBusString *str);
363 
364 static inline unsigned char *
365 _dbus_string_get_udata (DBusString *str)
366 {
367  return (unsigned char *) _dbus_string_get_data (str);
368 }
369 
370 static inline unsigned char *
371 _dbus_string_get_udata_len (DBusString *str, int start, int len)
372 {
373  return (unsigned char *) _dbus_string_get_data_len (str, start, len);
374 }
375 
376 static inline const unsigned char *
377 _dbus_string_get_const_udata (const DBusString *str)
378 {
379  return (const unsigned char *) _dbus_string_get_const_data (str);
380 }
381 
382 static inline const unsigned char *
383 _dbus_string_get_const_udata_len (const DBusString *str, int start, int len)
384 {
385  return (const unsigned char *) _dbus_string_get_const_data_len (str, start, len);
386 }
387 
393 #define _DBUS_STRING_ALLOCATION_PADDING 8
394 
402 #define _DBUS_STRING_DEFINE_STATIC(name, str) \
403  static const char _dbus_static_string_##name[] = str; \
404  static const DBusString name = { _dbus_static_string_##name, \
405  sizeof(_dbus_static_string_##name), \
406  sizeof(_dbus_static_string_##name) + \
407  _DBUS_STRING_ALLOCATION_PADDING, \
408  TRUE, TRUE, FALSE, 0 }
409 
411 
412 #endif /* DBUS_STRING_H */