1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-string.h String utility class (internal to D-Bus implementation)
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
5 * Copyright (C) 2006 Ralf Habacker <ralf.habacker@freenet.de>
7 * Licensed under the Academic Free License version 2.1
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.
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.
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
28 #include <dbus/dbus-macros.h>
29 #include <dbus/dbus-types.h>
30 #include <dbus/dbus-memory.h>
40 typedef struct DBusString DBusString;
44 #if defined(DBUS_WIN) && defined(_DEBUG)
45 const char *dummy1; /**< placeholder */
47 const void *dummy1; /**< placeholder */
49 int dummy2; /**< placeholder */
50 int dummy3; /**< placeholder */
51 unsigned int dummy_bit1 : 1; /**< placeholder */
52 unsigned int dummy_bit2 : 1; /**< placeholder */
53 unsigned int dummy_bit3 : 1; /**< placeholder */
54 unsigned int dummy_bits : 3; /**< placeholder */
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)
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))
71 dbus_bool_t _dbus_string_init (DBusString *str);
73 void _dbus_string_init_const (DBusString *str,
76 void _dbus_string_init_const_len (DBusString *str,
79 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
83 dbus_bool_t _dbus_string_init_from_string (DBusString *str,
84 const DBusString *from);
86 void _dbus_string_free (DBusString *str);
87 void _dbus_string_lock (DBusString *str);
89 dbus_bool_t _dbus_string_compact (DBusString *str,
91 #ifndef _dbus_string_get_data
93 char* _dbus_string_get_data (DBusString *str);
94 #endif /* _dbus_string_get_data */
95 #ifndef _dbus_string_get_const_data
97 const char* _dbus_string_get_const_data (const DBusString *str);
98 #endif /* _dbus_string_get_const_data */
99 char* _dbus_string_get_data_len (DBusString *str,
102 #ifndef _dbus_string_get_const_data_len
104 const char* _dbus_string_get_const_data_len (const DBusString *str,
108 #ifndef _dbus_string_set_byte
110 void _dbus_string_set_byte (DBusString *str,
114 #ifndef _dbus_string_get_byte
116 unsigned char _dbus_string_get_byte (const DBusString *str,
118 #endif /* _dbus_string_get_byte */
120 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
125 dbus_bool_t _dbus_string_insert_byte (DBusString *str,
129 dbus_bool_t _dbus_string_steal_data (DBusString *str,
131 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
136 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
138 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
142 void _dbus_string_copy_to_buffer (const DBusString *str,
146 void _dbus_string_copy_to_buffer_with_nul (const DBusString *str,
149 #ifndef _dbus_string_get_length
151 int _dbus_string_get_length (const DBusString *str);
152 #endif /* !_dbus_string_get_length */
155 * Get the string's length as an unsigned integer, for comparison with
156 * size_t and similar unsigned types that does not trigger compiler
157 * warnings about potential value changes during conversion.
159 * DBusString lengths are signed for historical reasons, but we know that
160 * the length is always >= 0 (and DBUS_GENERIC_STRING_PREAMBLE asserts
161 * that this is the case) so we know that this cast does not change the
164 static inline unsigned int
165 _dbus_string_get_length_uint (const DBusString *str)
167 return (unsigned int) _dbus_string_get_length (str);
171 dbus_bool_t _dbus_string_lengthen (DBusString *str,
172 int additional_length);
174 void _dbus_string_shorten (DBusString *str,
175 int length_to_remove);
177 dbus_bool_t _dbus_string_set_length (DBusString *str,
179 dbus_bool_t _dbus_string_align_length (DBusString *str,
181 dbus_bool_t _dbus_string_alloc_space (DBusString *str,
184 dbus_bool_t _dbus_string_append (DBusString *str,
187 dbus_bool_t _dbus_string_append_len (DBusString *str,
191 dbus_bool_t _dbus_string_append_int (DBusString *str,
194 dbus_bool_t _dbus_string_append_uint (DBusString *str,
195 unsigned long value);
197 dbus_bool_t _dbus_string_append_byte (DBusString *str,
200 dbus_bool_t _dbus_string_append_printf (DBusString *str,
202 ...) _DBUS_GNUC_PRINTF (2, 3);
204 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
206 va_list args) _DBUS_GNUC_PRINTF (2, 0);
207 dbus_bool_t _dbus_string_insert_2_aligned (DBusString *str,
209 const unsigned char octets[2]);
210 dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str,
212 const unsigned char octets[4]);
213 dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str,
215 const unsigned char octets[8]);
216 dbus_bool_t _dbus_string_insert_alignment (DBusString *str,
220 void _dbus_string_delete (DBusString *str,
224 dbus_bool_t _dbus_string_move (DBusString *source,
229 dbus_bool_t _dbus_string_copy (const DBusString *source,
233 dbus_bool_t _dbus_string_move_len (DBusString *source,
239 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
245 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
252 dbus_bool_t _dbus_string_split_on_byte (DBusString *source,
256 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
261 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
263 unsigned long *value_return,
266 dbus_bool_t _dbus_string_find (const DBusString *str,
271 dbus_bool_t _dbus_string_find_eol (const DBusString *str,
276 dbus_bool_t _dbus_string_find_to (const DBusString *str,
281 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
286 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
290 void _dbus_string_skip_blank (const DBusString *str,
294 void _dbus_string_skip_white (const DBusString *str,
297 void _dbus_string_skip_white_reverse (const DBusString *str,
301 dbus_bool_t _dbus_string_equal (const DBusString *a,
302 const DBusString *b);
304 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
307 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
311 dbus_bool_t _dbus_string_equal_substring (const DBusString *a,
317 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
319 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
322 dbus_bool_t _dbus_string_pop_line (DBusString *source,
325 void _dbus_string_delete_first_word (DBusString *str);
327 void _dbus_string_delete_leading_blanks (DBusString *str);
329 void _dbus_string_chop_white (DBusString *str);
330 dbus_bool_t _dbus_string_append_byte_as_hex (DBusString *str,
333 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
338 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
344 void _dbus_string_tolower_ascii (const DBusString *str,
348 void _dbus_string_toupper_ascii (const DBusString *str,
351 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
355 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
359 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
362 void _dbus_string_zero (DBusString *str);
364 static inline unsigned char *
365 _dbus_string_get_udata (DBusString *str)
367 return (unsigned char *) _dbus_string_get_data (str);
370 static inline unsigned char *
371 _dbus_string_get_udata_len (DBusString *str, int start, int len)
373 return (unsigned char *) _dbus_string_get_data_len (str, start, len);
376 static inline const unsigned char *
377 _dbus_string_get_const_udata (const DBusString *str)
379 return (const unsigned char *) _dbus_string_get_const_data (str);
382 static inline const unsigned char *
383 _dbus_string_get_const_udata_len (const DBusString *str, int start, int len)
385 return (const unsigned char *) _dbus_string_get_const_data_len (str, start, len);
389 * We allocate 1 byte for nul termination, plus 7 bytes for possible
390 * align_offset, so we always need 8 bytes on top of the string's
391 * length to be in the allocated block.
393 #define _DBUS_STRING_ALLOCATION_PADDING 8
396 * Defines a static const variable with type #DBusString called "name"
397 * containing the given string literal.
399 * @param name the name of the variable
400 * @param str the string value
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 }
412 #endif /* DBUS_STRING_H */