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 1.2
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 dbus_bool_t _dbus_string_init (DBusString *str);
53 void _dbus_string_init_const (DBusString *str,
55 void _dbus_string_init_const_len (DBusString *str,
58 dbus_bool_t _dbus_string_init_preallocated (DBusString *str,
60 void _dbus_string_free (DBusString *str);
61 void _dbus_string_lock (DBusString *str);
62 char* _dbus_string_get_data (DBusString *str);
63 const char* _dbus_string_get_const_data (const DBusString *str);
64 char* _dbus_string_get_data_len (DBusString *str,
67 const char* _dbus_string_get_const_data_len (const DBusString *str,
70 void _dbus_string_set_byte (DBusString *str,
73 unsigned char _dbus_string_get_byte (const DBusString *str,
75 dbus_bool_t _dbus_string_insert_bytes (DBusString *str,
79 dbus_bool_t _dbus_string_steal_data (DBusString *str,
81 dbus_bool_t _dbus_string_steal_data_len (DBusString *str,
85 dbus_bool_t _dbus_string_copy_data (const DBusString *str,
87 dbus_bool_t _dbus_string_copy_data_len (const DBusString *str,
91 int _dbus_string_get_length (const DBusString *str);
92 dbus_bool_t _dbus_string_lengthen (DBusString *str,
93 int additional_length);
94 void _dbus_string_shorten (DBusString *str,
95 int length_to_remove);
96 dbus_bool_t _dbus_string_set_length (DBusString *str,
98 dbus_bool_t _dbus_string_align_length (DBusString *str,
100 dbus_bool_t _dbus_string_append (DBusString *str,
102 dbus_bool_t _dbus_string_append_len (DBusString *str,
105 dbus_bool_t _dbus_string_append_int (DBusString *str,
107 dbus_bool_t _dbus_string_append_uint (DBusString *str,
108 unsigned long value);
109 dbus_bool_t _dbus_string_append_double (DBusString *str,
111 dbus_bool_t _dbus_string_append_byte (DBusString *str,
113 dbus_bool_t _dbus_string_append_unichar (DBusString *str,
115 dbus_bool_t _dbus_string_append_4_aligned (DBusString *str,
116 const unsigned char octets[4]);
117 dbus_bool_t _dbus_string_append_8_aligned (DBusString *str,
118 const unsigned char octets[8]);
119 dbus_bool_t _dbus_string_append_printf (DBusString *str,
121 ...) _DBUS_GNUC_PRINTF (2, 3);
122 dbus_bool_t _dbus_string_append_printf_valist (DBusString *str,
125 void _dbus_string_delete (DBusString *str,
128 dbus_bool_t _dbus_string_move (DBusString *source,
132 dbus_bool_t _dbus_string_copy (const DBusString *source,
136 dbus_bool_t _dbus_string_move_len (DBusString *source,
141 dbus_bool_t _dbus_string_copy_len (const DBusString *source,
146 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
152 void _dbus_string_get_unichar (const DBusString *str,
154 dbus_unichar_t *ch_return,
156 dbus_bool_t _dbus_string_parse_int (const DBusString *str,
160 dbus_bool_t _dbus_string_parse_uint (const DBusString *str,
162 unsigned long *value_return,
164 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
168 dbus_bool_t _dbus_string_find (const DBusString *str,
172 dbus_bool_t _dbus_string_find_to (const DBusString *str,
177 dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str,
181 dbus_bool_t _dbus_string_find_blank (const DBusString *str,
184 void _dbus_string_skip_blank (const DBusString *str,
187 void _dbus_string_skip_white (const DBusString *str,
190 dbus_bool_t _dbus_string_equal (const DBusString *a,
191 const DBusString *b);
192 dbus_bool_t _dbus_string_equal_c_str (const DBusString *a,
194 dbus_bool_t _dbus_string_equal_len (const DBusString *a,
197 dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a,
199 dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a,
201 dbus_bool_t _dbus_string_pop_line (DBusString *source,
203 void _dbus_string_delete_first_word (DBusString *str);
204 void _dbus_string_delete_leading_blanks (DBusString *str);
205 dbus_bool_t _dbus_string_base64_encode (const DBusString *source,
209 dbus_bool_t _dbus_string_base64_decode (const DBusString *source,
213 dbus_bool_t _dbus_string_hex_encode (const DBusString *source,
217 dbus_bool_t _dbus_string_hex_decode (const DBusString *source,
221 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
224 dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str,
227 dbus_bool_t _dbus_string_validate_nul (const DBusString *str,
230 dbus_bool_t _dbus_string_validate_path (const DBusString *str,
233 dbus_bool_t _dbus_string_validate_interface (const DBusString *str,
236 dbus_bool_t _dbus_string_validate_member (const DBusString *str,
239 dbus_bool_t _dbus_string_validate_error_name (const DBusString *str,
242 dbus_bool_t _dbus_string_validate_service (const DBusString *str,
245 void _dbus_string_zero (DBusString *str);
250 #endif /* DBUS_STRING_H */