1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-string.h String utility class (internal to D-BUS implementation)
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include <dbus/dbus-memory.h>
30 #include <dbus/dbus-types.h>
31 #include <dbus/dbus-sysdeps.h>
42 const void *dummy1; /**< placeholder */
43 int dummy2; /**< placeholder */
44 int dummy3; /**< placeholder */
45 int dummy4; /**< placeholder */
46 unsigned int dummy5 : 1; /**< placeholder */
47 unsigned int dummy6 : 1; /**< placeholder */
48 unsigned int dummy7 : 1; /**< placeholder */
49 unsigned int dummy8 : 3; /**< placeholder */
52 #ifdef DBUS_DISABLE_ASSERT
53 /* Some simple inlining hacks; the current linker is not smart enough
54 * to inline non-exported symbols across files in the library.
55 * Note that these break type safety (due to the casts)
57 #define _dbus_string_get_length(s) (((DBusString*)(s))->dummy2)
58 #define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)])
59 #define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1))
62 dbus_bool_t _dbus_string_init (DBusString *str);
63 void _dbus_string_init_const (DBusString *str,
65 void _dbus_string_init_const_len (DBusString *str,
68 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
70 void _dbus_string_free (DBusString *str);
71 void _dbus_string_lock (DBusString *str);
72 char* _dbus_string_get_data (DBusString *str);
73 #ifndef _dbus_string_get_const_data
74 const char* _dbus_string_get_const_data (const DBusString *str);
75 #endif /* _dbus_string_get_const_data */
76 char* _dbus_string_get_data_len (DBusString *str,
79 const char* _dbus_string_get_const_data_len (const DBusString *str,
82 void _dbus_string_set_byte (DBusString *str,
85 #ifndef _dbus_string_get_byte
86 unsigned char _dbus_string_get_byte (const DBusString *str,
88 #endif /* _dbus_string_get_byte */
89 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
93 dbus_bool_t _dbus_string_insert_byte (DBusString *str,
96 dbus_bool_t _dbus_string_steal_data (DBusString *str,
98 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
102 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
104 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
108 void _dbus_string_copy_to_buffer (const DBusString *str,
111 #ifndef _dbus_string_get_length
112 int _dbus_string_get_length (const DBusString *str);
113 #endif /* !_dbus_string_get_length */
115 dbus_bool_t _dbus_string_lengthen (DBusString *str,
116 int additional_length);
117 void _dbus_string_shorten (DBusString *str,
118 int length_to_remove);
119 dbus_bool_t _dbus_string_set_length (DBusString *str,
121 dbus_bool_t _dbus_string_align_length (DBusString *str,
123 dbus_bool_t _dbus_string_alloc_space (DBusString *str,
125 dbus_bool_t _dbus_string_append (DBusString *str,
127 dbus_bool_t _dbus_string_append_len (DBusString *str,
130 dbus_bool_t _dbus_string_append_int (DBusString *str,
132 dbus_bool_t _dbus_string_append_uint (DBusString *str,
133 unsigned long value);
134 dbus_bool_t _dbus_string_append_double (DBusString *str,
136 dbus_bool_t _dbus_string_append_byte (DBusString *str,
138 dbus_bool_t _dbus_string_append_unichar (DBusString *str,
140 dbus_bool_t _dbus_string_append_4_aligned (DBusString *str,
141 const unsigned char octets[4]);
142 dbus_bool_t _dbus_string_append_8_aligned (DBusString *str,
143 const unsigned char octets[8]);
144 dbus_bool_t _dbus_string_append_printf (DBusString *str,
146 ...) _DBUS_GNUC_PRINTF (2, 3);
147 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
150 dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str,
152 const unsigned char octets[4]);
153 dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str,
155 const unsigned char octets[8]);
156 dbus_bool_t _dbus_string_insert_alignment (DBusString *str,
159 void _dbus_string_delete (DBusString *str,
162 dbus_bool_t _dbus_string_move (DBusString *source,
166 dbus_bool_t _dbus_string_copy (const DBusString *source,
170 dbus_bool_t _dbus_string_move_len (DBusString *source,
175 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
180 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
186 void _dbus_string_get_unichar (const DBusString *str,
188 dbus_unichar_t *ch_return,
190 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
194 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
196 unsigned long *value_return,
198 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
202 dbus_bool_t _dbus_string_parse_basic_type (const DBusString *str,
207 dbus_bool_t _dbus_string_find (const DBusString *str,
211 dbus_bool_t _dbus_string_find_to (const DBusString *str,
216 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
220 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
223 void _dbus_string_skip_blank (const DBusString *str,
226 void _dbus_string_skip_white (const DBusString *str,
229 dbus_bool_t _dbus_string_equal (const DBusString *a,
230 const DBusString *b);
231 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
233 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
236 dbus_bool_t _dbus_string_equal_substring (const DBusString *a,
241 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
243 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
245 dbus_bool_t _dbus_string_pop_line (DBusString *source,
247 void _dbus_string_delete_first_word (DBusString *str);
248 void _dbus_string_delete_leading_blanks (DBusString *str);
249 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
253 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
258 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
261 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
264 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
267 void _dbus_string_zero (DBusString *str);
271 * We allocate 1 byte for nul termination, plus 7 bytes for possible
272 * align_offset, so we always need 8 bytes on top of the string's
273 * length to be in the allocated block.
275 #define _DBUS_STRING_ALLOCATION_PADDING 8
278 * Defines a static const variable with type #DBusString called "name"
279 * containing the given string literal.
281 * @param name the name of the variable
282 * @param str the string value
284 #define _DBUS_STRING_DEFINE_STATIC(name, str) \
285 static const char _dbus_static_string_##name[] = str; \
286 static const DBusString name = { _dbus_static_string_##name, \
287 sizeof(_dbus_static_string_##name), \
288 sizeof(_dbus_static_string_##name) + \
289 _DBUS_STRING_ALLOCATION_PADDING, \
290 sizeof(_dbus_static_string_##name), \
291 TRUE, TRUE, FALSE, 0 }
295 #endif /* DBUS_STRING_H */