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_set_byte(s, i, b) ((((unsigned char*)(((DBusString*)(s))->dummy1))[(i)]) = (unsigned char) (b))
59 #define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)])
60 #define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1))
61 #define _dbus_string_get_const_data_len(s,start,len) (((const char*)(((DBusString*)(s))->dummy1)) + (start))
64 dbus_bool_t _dbus_string_init (DBusString *str);
65 void _dbus_string_init_const (DBusString *str,
67 void _dbus_string_init_const_len (DBusString *str,
70 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
72 void _dbus_string_free (DBusString *str);
73 void _dbus_string_lock (DBusString *str);
74 char* _dbus_string_get_data (DBusString *str);
75 #ifndef _dbus_string_get_const_data
76 const char* _dbus_string_get_const_data (const DBusString *str);
77 #endif /* _dbus_string_get_const_data */
78 char* _dbus_string_get_data_len (DBusString *str,
81 #ifndef _dbus_string_get_const_data_len
82 const char* _dbus_string_get_const_data_len (const DBusString *str,
86 #ifndef _dbus_string_set_byte
87 void _dbus_string_set_byte (DBusString *str,
91 #ifndef _dbus_string_get_byte
92 unsigned char _dbus_string_get_byte (const DBusString *str,
94 #endif /* _dbus_string_get_byte */
95 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
99 dbus_bool_t _dbus_string_insert_byte (DBusString *str,
102 dbus_bool_t _dbus_string_steal_data (DBusString *str,
104 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
108 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
110 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
114 void _dbus_string_copy_to_buffer (const DBusString *str,
117 #ifndef _dbus_string_get_length
118 int _dbus_string_get_length (const DBusString *str);
119 #endif /* !_dbus_string_get_length */
121 dbus_bool_t _dbus_string_lengthen (DBusString *str,
122 int additional_length);
123 void _dbus_string_shorten (DBusString *str,
124 int length_to_remove);
125 dbus_bool_t _dbus_string_set_length (DBusString *str,
127 dbus_bool_t _dbus_string_align_length (DBusString *str,
129 dbus_bool_t _dbus_string_alloc_space (DBusString *str,
131 dbus_bool_t _dbus_string_append (DBusString *str,
133 dbus_bool_t _dbus_string_append_len (DBusString *str,
136 dbus_bool_t _dbus_string_append_int (DBusString *str,
138 dbus_bool_t _dbus_string_append_uint (DBusString *str,
139 unsigned long value);
140 dbus_bool_t _dbus_string_append_double (DBusString *str,
142 dbus_bool_t _dbus_string_append_byte (DBusString *str,
144 dbus_bool_t _dbus_string_append_unichar (DBusString *str,
146 dbus_bool_t _dbus_string_append_4_aligned (DBusString *str,
147 const unsigned char octets[4]);
148 dbus_bool_t _dbus_string_append_8_aligned (DBusString *str,
149 const unsigned char octets[8]);
150 dbus_bool_t _dbus_string_append_printf (DBusString *str,
152 ...) _DBUS_GNUC_PRINTF (2, 3);
153 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
156 dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str,
158 const unsigned char octets[4]);
159 dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str,
161 const unsigned char octets[8]);
162 dbus_bool_t _dbus_string_insert_alignment (DBusString *str,
165 void _dbus_string_delete (DBusString *str,
168 dbus_bool_t _dbus_string_move (DBusString *source,
172 dbus_bool_t _dbus_string_copy (const DBusString *source,
176 dbus_bool_t _dbus_string_move_len (DBusString *source,
181 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
186 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
192 void _dbus_string_get_unichar (const DBusString *str,
194 dbus_unichar_t *ch_return,
196 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
200 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
202 unsigned long *value_return,
204 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
208 dbus_bool_t _dbus_string_parse_basic_type (const DBusString *str,
213 dbus_bool_t _dbus_string_find (const DBusString *str,
217 dbus_bool_t _dbus_string_find_to (const DBusString *str,
222 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
226 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
229 void _dbus_string_skip_blank (const DBusString *str,
232 void _dbus_string_skip_white (const DBusString *str,
235 dbus_bool_t _dbus_string_equal (const DBusString *a,
236 const DBusString *b);
237 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
239 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
242 dbus_bool_t _dbus_string_equal_substring (const DBusString *a,
247 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
249 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
251 dbus_bool_t _dbus_string_pop_line (DBusString *source,
253 void _dbus_string_delete_first_word (DBusString *str);
254 void _dbus_string_delete_leading_blanks (DBusString *str);
255 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
259 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
264 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
267 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
270 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
273 void _dbus_string_zero (DBusString *str);
277 * We allocate 1 byte for nul termination, plus 7 bytes for possible
278 * align_offset, so we always need 8 bytes on top of the string's
279 * length to be in the allocated block.
281 #define _DBUS_STRING_ALLOCATION_PADDING 8
284 * Defines a static const variable with type #DBusString called "name"
285 * containing the given string literal.
287 * @param name the name of the variable
288 * @param str the string value
290 #define _DBUS_STRING_DEFINE_STATIC(name, str) \
291 static const char _dbus_static_string_##name[] = str; \
292 static const DBusString name = { _dbus_static_string_##name, \
293 sizeof(_dbus_static_string_##name), \
294 sizeof(_dbus_static_string_##name) + \
295 _DBUS_STRING_ALLOCATION_PADDING, \
296 sizeof(_dbus_static_string_##name), \
297 TRUE, TRUE, FALSE, 0 }
301 #endif /* DBUS_STRING_H */