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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <dbus/dbus-memory.h>
31 #include <dbus/dbus-types.h>
32 #include <dbus/dbus-sysdeps.h>
43 const void *dummy1; /**< placeholder */
44 int dummy2; /**< placeholder */
45 int dummy3; /**< placeholder */
46 int dummy4; /**< placeholder */
47 unsigned int dummy5 : 1; /**< placeholder */
48 unsigned int dummy6 : 1; /**< placeholder */
49 unsigned int dummy7 : 1; /**< placeholder */
50 unsigned int dummy8 : 3; /**< placeholder */
53 #ifdef DBUS_DISABLE_ASSERT
54 /* Some simple inlining hacks; the current linker is not smart enough
55 * to inline non-exported symbols across files in the library.
56 * Note that these break type safety (due to the casts)
58 #define _dbus_string_get_data(s) ((char*)(((DBusString*)(s))->dummy1))
59 #define _dbus_string_get_length(s) (((DBusString*)(s))->dummy2)
60 #define _dbus_string_set_byte(s, i, b) ((((unsigned char*)(((DBusString*)(s))->dummy1))[(i)]) = (unsigned char) (b))
61 #define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)])
62 #define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1))
63 #define _dbus_string_get_const_data_len(s,start,len) (((const char*)(((DBusString*)(s))->dummy1)) + (start))
66 dbus_bool_t _dbus_string_init (DBusString *str);
67 void _dbus_string_init_const (DBusString *str,
69 void _dbus_string_init_const_len (DBusString *str,
72 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
74 void _dbus_string_free (DBusString *str);
75 void _dbus_string_lock (DBusString *str);
76 dbus_bool_t _dbus_string_compact (DBusString *str,
78 #ifndef _dbus_string_get_data
79 char* _dbus_string_get_data (DBusString *str);
80 #endif /* _dbus_string_get_data */
81 #ifndef _dbus_string_get_const_data
82 const char* _dbus_string_get_const_data (const DBusString *str);
83 #endif /* _dbus_string_get_const_data */
84 char* _dbus_string_get_data_len (DBusString *str,
87 #ifndef _dbus_string_get_const_data_len
88 const char* _dbus_string_get_const_data_len (const DBusString *str,
92 #ifndef _dbus_string_set_byte
93 void _dbus_string_set_byte (DBusString *str,
97 #ifndef _dbus_string_get_byte
98 unsigned char _dbus_string_get_byte (const DBusString *str,
100 #endif /* _dbus_string_get_byte */
101 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
105 dbus_bool_t _dbus_string_insert_byte (DBusString *str,
108 dbus_bool_t _dbus_string_steal_data (DBusString *str,
110 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
114 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
116 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
120 void _dbus_string_copy_to_buffer (const DBusString *str,
123 void _dbus_string_copy_to_buffer_with_nul (const DBusString *str,
126 #ifndef _dbus_string_get_length
127 int _dbus_string_get_length (const DBusString *str);
128 #endif /* !_dbus_string_get_length */
130 dbus_bool_t _dbus_string_lengthen (DBusString *str,
131 int additional_length);
132 void _dbus_string_shorten (DBusString *str,
133 int length_to_remove);
134 dbus_bool_t _dbus_string_set_length (DBusString *str,
136 dbus_bool_t _dbus_string_align_length (DBusString *str,
138 dbus_bool_t _dbus_string_alloc_space (DBusString *str,
140 dbus_bool_t _dbus_string_append (DBusString *str,
142 dbus_bool_t _dbus_string_append_len (DBusString *str,
145 dbus_bool_t _dbus_string_append_int (DBusString *str,
147 dbus_bool_t _dbus_string_append_uint (DBusString *str,
148 unsigned long value);
149 dbus_bool_t _dbus_string_append_double (DBusString *str,
151 dbus_bool_t _dbus_string_append_byte (DBusString *str,
153 dbus_bool_t _dbus_string_append_unichar (DBusString *str,
155 dbus_bool_t _dbus_string_append_4_aligned (DBusString *str,
156 const unsigned char octets[4]);
157 dbus_bool_t _dbus_string_append_8_aligned (DBusString *str,
158 const unsigned char octets[8]);
159 dbus_bool_t _dbus_string_append_printf (DBusString *str,
161 ...) _DBUS_GNUC_PRINTF (2, 3);
162 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
165 dbus_bool_t _dbus_string_insert_2_aligned (DBusString *str,
167 const unsigned char octets[2]);
168 dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str,
170 const unsigned char octets[4]);
171 dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str,
173 const unsigned char octets[8]);
174 dbus_bool_t _dbus_string_insert_alignment (DBusString *str,
177 void _dbus_string_delete (DBusString *str,
180 dbus_bool_t _dbus_string_move (DBusString *source,
184 dbus_bool_t _dbus_string_copy (const DBusString *source,
188 dbus_bool_t _dbus_string_move_len (DBusString *source,
193 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
198 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
204 dbus_bool_t _dbus_string_split_on_byte (DBusString *source,
207 void _dbus_string_get_unichar (const DBusString *str,
209 dbus_unichar_t *ch_return,
211 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
215 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
217 unsigned long *value_return,
219 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
223 dbus_bool_t _dbus_string_find (const DBusString *str,
227 dbus_bool_t _dbus_string_find_eol (const DBusString *str,
231 dbus_bool_t _dbus_string_find_to (const DBusString *str,
236 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
240 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
243 void _dbus_string_skip_blank (const DBusString *str,
246 void _dbus_string_skip_white (const DBusString *str,
249 void _dbus_string_skip_white_reverse (const DBusString *str,
252 dbus_bool_t _dbus_string_equal (const DBusString *a,
253 const DBusString *b);
254 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
256 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
259 dbus_bool_t _dbus_string_equal_substring (const DBusString *a,
264 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
266 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
268 dbus_bool_t _dbus_string_pop_line (DBusString *source,
270 void _dbus_string_delete_first_word (DBusString *str);
271 void _dbus_string_delete_leading_blanks (DBusString *str);
272 void _dbus_string_chop_white (DBusString *str);
273 dbus_bool_t _dbus_string_append_byte_as_hex (DBusString *str,
275 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
279 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
284 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
287 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
290 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
293 void _dbus_string_zero (DBusString *str);
297 * We allocate 1 byte for nul termination, plus 7 bytes for possible
298 * align_offset, so we always need 8 bytes on top of the string's
299 * length to be in the allocated block.
301 #define _DBUS_STRING_ALLOCATION_PADDING 8
304 * Defines a static const variable with type #DBusString called "name"
305 * containing the given string literal.
307 * @param name the name of the variable
308 * @param str the string value
310 #define _DBUS_STRING_DEFINE_STATIC(name, str) \
311 static const char _dbus_static_string_##name[] = str; \
312 static const DBusString name = { _dbus_static_string_##name, \
313 sizeof(_dbus_static_string_##name), \
314 sizeof(_dbus_static_string_##name) + \
315 _DBUS_STRING_ALLOCATION_PADDING, \
316 sizeof(_dbus_static_string_##name), \
317 TRUE, TRUE, FALSE, 0 }
321 #endif /* DBUS_STRING_H */