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
30 #include <dbus/dbus-macros.h>
31 #include <dbus/dbus-types.h>
32 #include <dbus/dbus-memory.h>
42 typedef struct DBusString DBusString;
46 const void *dummy1; /**< placeholder */
47 int dummy2; /**< placeholder */
48 int dummy3; /**< placeholder */
49 int dummy4; /**< placeholder */
50 unsigned int dummy5 : 1; /**< placeholder */
51 unsigned int dummy6 : 1; /**< placeholder */
52 unsigned int dummy7 : 1; /**< placeholder */
53 unsigned int dummy8 : 3; /**< placeholder */
56 #ifdef DBUS_DISABLE_ASSERT
57 /* Some simple inlining hacks; the current linker is not smart enough
58 * to inline non-exported symbols across files in the library.
59 * Note that these break type safety (due to the casts)
61 #define _dbus_string_get_data(s) ((char*)(((DBusString*)(s))->dummy1))
62 #define _dbus_string_get_length(s) (((DBusString*)(s))->dummy2)
63 #define _dbus_string_set_byte(s, i, b) ((((unsigned char*)(((DBusString*)(s))->dummy1))[(i)]) = (unsigned char) (b))
64 #define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)])
65 #define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1))
66 #define _dbus_string_get_const_data_len(s,start,len) (((const char*)(((DBusString*)(s))->dummy1)) + (start))
69 dbus_bool_t _dbus_string_init (DBusString *str);
70 void _dbus_string_init_const (DBusString *str,
72 void _dbus_string_init_const_len (DBusString *str,
75 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
77 void _dbus_string_free (DBusString *str);
78 void _dbus_string_lock (DBusString *str);
79 dbus_bool_t _dbus_string_compact (DBusString *str,
81 #ifndef _dbus_string_get_data
82 char* _dbus_string_get_data (DBusString *str);
83 #endif /* _dbus_string_get_data */
84 #ifndef _dbus_string_get_const_data
85 const char* _dbus_string_get_const_data (const DBusString *str);
86 #endif /* _dbus_string_get_const_data */
87 char* _dbus_string_get_data_len (DBusString *str,
90 #ifndef _dbus_string_get_const_data_len
91 const char* _dbus_string_get_const_data_len (const DBusString *str,
95 #ifndef _dbus_string_set_byte
96 void _dbus_string_set_byte (DBusString *str,
100 #ifndef _dbus_string_get_byte
101 unsigned char _dbus_string_get_byte (const DBusString *str,
103 #endif /* _dbus_string_get_byte */
104 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
108 dbus_bool_t _dbus_string_insert_byte (DBusString *str,
111 dbus_bool_t _dbus_string_steal_data (DBusString *str,
113 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
117 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
119 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
123 void _dbus_string_copy_to_buffer (const DBusString *str,
126 void _dbus_string_copy_to_buffer_with_nul (const DBusString *str,
129 #ifndef _dbus_string_get_length
130 int _dbus_string_get_length (const DBusString *str);
131 #endif /* !_dbus_string_get_length */
133 dbus_bool_t _dbus_string_lengthen (DBusString *str,
134 int additional_length);
135 void _dbus_string_shorten (DBusString *str,
136 int length_to_remove);
137 dbus_bool_t _dbus_string_set_length (DBusString *str,
139 dbus_bool_t _dbus_string_align_length (DBusString *str,
141 dbus_bool_t _dbus_string_alloc_space (DBusString *str,
143 dbus_bool_t _dbus_string_append (DBusString *str,
145 dbus_bool_t _dbus_string_append_len (DBusString *str,
148 dbus_bool_t _dbus_string_append_int (DBusString *str,
150 dbus_bool_t _dbus_string_append_uint (DBusString *str,
151 unsigned long value);
152 dbus_bool_t _dbus_string_append_double (DBusString *str,
154 dbus_bool_t _dbus_string_append_byte (DBusString *str,
156 dbus_bool_t _dbus_string_append_unichar (DBusString *str,
158 dbus_bool_t _dbus_string_append_4_aligned (DBusString *str,
159 const unsigned char octets[4]);
160 dbus_bool_t _dbus_string_append_8_aligned (DBusString *str,
161 const unsigned char octets[8]);
162 dbus_bool_t _dbus_string_append_printf (DBusString *str,
164 ...) _DBUS_GNUC_PRINTF (2, 3);
165 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
168 dbus_bool_t _dbus_string_insert_2_aligned (DBusString *str,
170 const unsigned char octets[2]);
171 dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str,
173 const unsigned char octets[4]);
174 dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str,
176 const unsigned char octets[8]);
177 dbus_bool_t _dbus_string_insert_alignment (DBusString *str,
180 void _dbus_string_delete (DBusString *str,
183 dbus_bool_t _dbus_string_move (DBusString *source,
187 dbus_bool_t _dbus_string_copy (const DBusString *source,
191 dbus_bool_t _dbus_string_move_len (DBusString *source,
196 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
201 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
207 dbus_bool_t _dbus_string_split_on_byte (DBusString *source,
210 void _dbus_string_get_unichar (const DBusString *str,
212 dbus_unichar_t *ch_return,
214 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
218 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
220 unsigned long *value_return,
222 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
226 dbus_bool_t _dbus_string_find (const DBusString *str,
230 dbus_bool_t _dbus_string_find_eol (const DBusString *str,
234 dbus_bool_t _dbus_string_find_to (const DBusString *str,
239 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
243 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
246 void _dbus_string_skip_blank (const DBusString *str,
249 void _dbus_string_skip_white (const DBusString *str,
252 void _dbus_string_skip_white_reverse (const DBusString *str,
255 dbus_bool_t _dbus_string_equal (const DBusString *a,
256 const DBusString *b);
257 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
259 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
262 dbus_bool_t _dbus_string_equal_substring (const DBusString *a,
267 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
269 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
271 dbus_bool_t _dbus_string_pop_line (DBusString *source,
273 void _dbus_string_delete_first_word (DBusString *str);
274 void _dbus_string_delete_leading_blanks (DBusString *str);
275 void _dbus_string_chop_white (DBusString *str);
276 dbus_bool_t _dbus_string_append_byte_as_hex (DBusString *str,
278 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
282 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
287 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
290 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
293 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
296 void _dbus_string_zero (DBusString *str);
300 * We allocate 1 byte for nul termination, plus 7 bytes for possible
301 * align_offset, so we always need 8 bytes on top of the string's
302 * length to be in the allocated block.
304 #define _DBUS_STRING_ALLOCATION_PADDING 8
307 * Defines a static const variable with type #DBusString called "name"
308 * containing the given string literal.
310 * @param name the name of the variable
311 * @param str the string value
313 #define _DBUS_STRING_DEFINE_STATIC(name, str) \
314 static const char _dbus_static_string_##name[] = str; \
315 static const DBusString name = { _dbus_static_string_##name, \
316 sizeof(_dbus_static_string_##name), \
317 sizeof(_dbus_static_string_##name) + \
318 _DBUS_STRING_ALLOCATION_PADDING, \
319 sizeof(_dbus_static_string_##name), \
320 TRUE, TRUE, FALSE, 0 }
324 #endif /* DBUS_STRING_H */