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))
70 dbus_bool_t _dbus_string_init (DBusString *str);
71 void _dbus_string_init_const (DBusString *str,
73 void _dbus_string_init_const_len (DBusString *str,
76 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
78 void _dbus_string_free (DBusString *str);
79 void _dbus_string_lock (DBusString *str);
80 dbus_bool_t _dbus_string_compact (DBusString *str,
82 #ifndef _dbus_string_get_data
83 char* _dbus_string_get_data (DBusString *str);
84 #endif /* _dbus_string_get_data */
85 #ifndef _dbus_string_get_const_data
86 const char* _dbus_string_get_const_data (const DBusString *str);
87 #endif /* _dbus_string_get_const_data */
88 char* _dbus_string_get_data_len (DBusString *str,
91 #ifndef _dbus_string_get_const_data_len
92 const char* _dbus_string_get_const_data_len (const DBusString *str,
96 #ifndef _dbus_string_set_byte
97 void _dbus_string_set_byte (DBusString *str,
101 #ifndef _dbus_string_get_byte
102 unsigned char _dbus_string_get_byte (const DBusString *str,
104 #endif /* _dbus_string_get_byte */
105 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
109 dbus_bool_t _dbus_string_insert_byte (DBusString *str,
112 dbus_bool_t _dbus_string_steal_data (DBusString *str,
114 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
118 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
120 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
124 void _dbus_string_copy_to_buffer (const DBusString *str,
127 void _dbus_string_copy_to_buffer_with_nul (const DBusString *str,
130 #ifndef _dbus_string_get_length
131 int _dbus_string_get_length (const DBusString *str);
132 #endif /* !_dbus_string_get_length */
134 dbus_bool_t _dbus_string_lengthen (DBusString *str,
135 int additional_length);
136 void _dbus_string_shorten (DBusString *str,
137 int length_to_remove);
138 dbus_bool_t _dbus_string_set_length (DBusString *str,
140 dbus_bool_t _dbus_string_align_length (DBusString *str,
142 dbus_bool_t _dbus_string_alloc_space (DBusString *str,
144 dbus_bool_t _dbus_string_append (DBusString *str,
146 dbus_bool_t _dbus_string_append_len (DBusString *str,
149 dbus_bool_t _dbus_string_append_int (DBusString *str,
151 dbus_bool_t _dbus_string_append_uint (DBusString *str,
152 unsigned long value);
153 dbus_bool_t _dbus_string_append_byte (DBusString *str,
155 dbus_bool_t _dbus_string_append_printf (DBusString *str,
157 ...) _DBUS_GNUC_PRINTF (2, 3);
158 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
161 dbus_bool_t _dbus_string_insert_2_aligned (DBusString *str,
163 const unsigned char octets[2]);
164 dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str,
166 const unsigned char octets[4]);
167 dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str,
169 const unsigned char octets[8]);
170 dbus_bool_t _dbus_string_insert_alignment (DBusString *str,
173 void _dbus_string_delete (DBusString *str,
176 dbus_bool_t _dbus_string_move (DBusString *source,
180 dbus_bool_t _dbus_string_copy (const DBusString *source,
184 dbus_bool_t _dbus_string_move_len (DBusString *source,
189 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
194 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
200 dbus_bool_t _dbus_string_split_on_byte (DBusString *source,
203 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
207 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
209 unsigned long *value_return,
211 dbus_bool_t _dbus_string_find (const DBusString *str,
215 dbus_bool_t _dbus_string_find_eol (const DBusString *str,
219 dbus_bool_t _dbus_string_find_to (const DBusString *str,
224 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
228 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
231 void _dbus_string_skip_blank (const DBusString *str,
234 void _dbus_string_skip_white (const DBusString *str,
237 void _dbus_string_skip_white_reverse (const DBusString *str,
240 dbus_bool_t _dbus_string_equal (const DBusString *a,
241 const DBusString *b);
242 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
244 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
247 dbus_bool_t _dbus_string_equal_substring (const DBusString *a,
252 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
254 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
256 dbus_bool_t _dbus_string_pop_line (DBusString *source,
258 void _dbus_string_delete_first_word (DBusString *str);
259 void _dbus_string_delete_leading_blanks (DBusString *str);
260 void _dbus_string_chop_white (DBusString *str);
261 dbus_bool_t _dbus_string_append_byte_as_hex (DBusString *str,
263 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
267 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
272 void _dbus_string_tolower_ascii (const DBusString *str,
275 void _dbus_string_toupper_ascii (const DBusString *str,
278 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
281 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
284 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
287 void _dbus_string_zero (DBusString *str);
291 * We allocate 1 byte for nul termination, plus 7 bytes for possible
292 * align_offset, so we always need 8 bytes on top of the string's
293 * length to be in the allocated block.
295 #define _DBUS_STRING_ALLOCATION_PADDING 8
298 * Defines a static const variable with type #DBusString called "name"
299 * containing the given string literal.
301 * @param name the name of the variable
302 * @param str the string value
304 #define _DBUS_STRING_DEFINE_STATIC(name, str) \
305 static const char _dbus_static_string_##name[] = str; \
306 static const DBusString name = { _dbus_static_string_##name, \
307 sizeof(_dbus_static_string_##name), \
308 sizeof(_dbus_static_string_##name) + \
309 _DBUS_STRING_ALLOCATION_PADDING, \
310 TRUE, TRUE, FALSE, 0 }
314 #endif /* DBUS_STRING_H */