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 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 /* Unless we want to run all the assertions in the function,
53 * inline this thing, it shows up high in the profile
55 #ifdef DBUS_DISABLE_ASSERT
56 #define _dbus_string_get_length(s) ((s)->dummy2)
59 dbus_bool_t _dbus_string_init (DBusString *str);
60 void _dbus_string_init_const (DBusString *str,
62 void _dbus_string_init_const_len (DBusString *str,
65 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
67 void _dbus_string_free (DBusString *str);
68 void _dbus_string_lock (DBusString *str);
69 char* _dbus_string_get_data (DBusString *str);
70 const char* _dbus_string_get_const_data (const DBusString *str);
71 char* _dbus_string_get_data_len (DBusString *str,
74 const char* _dbus_string_get_const_data_len (const DBusString *str,
77 void _dbus_string_set_byte (DBusString *str,
80 unsigned char _dbus_string_get_byte (const DBusString *str,
82 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
86 dbus_bool_t _dbus_string_steal_data (DBusString *str,
88 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
92 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
94 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
98 void _dbus_string_copy_to_buffer (const DBusString *str,
101 #ifndef _dbus_string_get_length
102 int _dbus_string_get_length (const DBusString *str);
103 #endif /* !_dbus_string_get_length */
105 dbus_bool_t _dbus_string_lengthen (DBusString *str,
106 int additional_length);
107 void _dbus_string_shorten (DBusString *str,
108 int length_to_remove);
109 dbus_bool_t _dbus_string_set_length (DBusString *str,
111 dbus_bool_t _dbus_string_align_length (DBusString *str,
113 dbus_bool_t _dbus_string_append (DBusString *str,
115 dbus_bool_t _dbus_string_append_len (DBusString *str,
118 dbus_bool_t _dbus_string_append_int (DBusString *str,
120 dbus_bool_t _dbus_string_append_uint (DBusString *str,
121 unsigned long value);
122 dbus_bool_t _dbus_string_append_double (DBusString *str,
124 dbus_bool_t _dbus_string_append_byte (DBusString *str,
126 dbus_bool_t _dbus_string_append_unichar (DBusString *str,
128 dbus_bool_t _dbus_string_append_4_aligned (DBusString *str,
129 const unsigned char octets[4]);
130 dbus_bool_t _dbus_string_append_8_aligned (DBusString *str,
131 const unsigned char octets[8]);
132 dbus_bool_t _dbus_string_append_printf (DBusString *str,
134 ...) _DBUS_GNUC_PRINTF (2, 3);
135 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
138 void _dbus_string_delete (DBusString *str,
141 dbus_bool_t _dbus_string_move (DBusString *source,
145 dbus_bool_t _dbus_string_copy (const DBusString *source,
149 dbus_bool_t _dbus_string_move_len (DBusString *source,
154 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
159 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
165 void _dbus_string_get_unichar (const DBusString *str,
167 dbus_unichar_t *ch_return,
169 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
173 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
175 unsigned long *value_return,
177 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
181 dbus_bool_t _dbus_string_parse_basic_type (const DBusString *str,
186 dbus_bool_t _dbus_string_find (const DBusString *str,
190 dbus_bool_t _dbus_string_find_to (const DBusString *str,
195 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
199 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
202 void _dbus_string_skip_blank (const DBusString *str,
205 void _dbus_string_skip_white (const DBusString *str,
208 dbus_bool_t _dbus_string_equal (const DBusString *a,
209 const DBusString *b);
210 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
212 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
215 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
217 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
219 dbus_bool_t _dbus_string_pop_line (DBusString *source,
221 void _dbus_string_delete_first_word (DBusString *str);
222 void _dbus_string_delete_leading_blanks (DBusString *str);
223 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
227 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
232 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
235 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
238 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
241 dbus_bool_t _dbus_string_validate_path (const DBusString *str,
244 dbus_bool_t _dbus_string_validate_interface (const DBusString *str,
247 dbus_bool_t _dbus_string_validate_member (const DBusString *str,
250 dbus_bool_t _dbus_string_validate_error_name (const DBusString *str,
253 dbus_bool_t _dbus_string_validate_service (const DBusString *str,
256 void _dbus_string_zero (DBusString *str);
261 #endif /* DBUS_STRING_H */