dbus-string.h revision c2a98e1103544277e8d36be53f8a24a32c2c6bea 
1/* -*- mode: C; c-file-style: "gnu" -*- */
2/* dbus-string.h String utility class (internal to D-BUS implementation)
3 *
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
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.
12 *
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.
17 *
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
21 *
22 */
23
24#ifndef DBUS_STRING_H
25#define DBUS_STRING_H
26
27#include <config.h>
28
29#include <dbus/dbus-memory.h>
30#include <dbus/dbus-types.h>
31#include <dbus/dbus-sysdeps.h>
32
33#include <stdarg.h>
34
35DBUS_BEGIN_DECLS
36
37/**
38 * DBusString object
39 */
40struct DBusString
41{
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 */
50};
51
52#ifdef DBUS_DISABLE_ASSERT
53/* Some simple inlining hacks; the current linker is not smart enough
54 * to inline non-exported symbols across files in the library.
55 * Note that these break type safety (due to the casts)
56 */
57#define _dbus_string_get_length(s) (((DBusString*)(s))->dummy2)
58#define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)])
59#define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1))
60#endif
61
62dbus_bool_t   _dbus_string_init                  (DBusString        *str);
63void          _dbus_string_init_const            (DBusString        *str,
64                                                  const char        *value);
65void          _dbus_string_init_const_len        (DBusString        *str,
66                                                  const char        *value,
67                                                  int                len);
68dbus_bool_t   _dbus_string_init_preallocated     (DBusString        *str,
69                                                  int                allocate_size);
70void          _dbus_string_free                  (DBusString        *str);
71void          _dbus_string_lock                  (DBusString        *str);
72char*         _dbus_string_get_data              (DBusString        *str);
73#ifndef _dbus_string_get_const_data
74const char*   _dbus_string_get_const_data        (const DBusString  *str);
75#endif /* _dbus_string_get_const_data */
76char*         _dbus_string_get_data_len          (DBusString        *str,
77                                                  int                start,
78                                                  int                len);
79const char*   _dbus_string_get_const_data_len    (const DBusString  *str,
80                                                  int                start,
81                                                  int                len);
82void          _dbus_string_set_byte              (DBusString        *str,
83                                                  int                i,
84                                                  unsigned char      byte);
85#ifndef _dbus_string_get_byte
86unsigned char _dbus_string_get_byte              (const DBusString  *str,
87                                                  int                start);
88#endif /* _dbus_string_get_byte */
89dbus_bool_t   _dbus_string_insert_bytes          (DBusString        *str,
90                                                  int                i,
91						  int                n_bytes,
92                                                  unsigned char      byte);
93dbus_bool_t   _dbus_string_insert_byte           (DBusString        *str,
94                                                  int                i,
95                                                  unsigned char      byte);
96dbus_bool_t   _dbus_string_steal_data            (DBusString        *str,
97                                                  char             **data_return);
98dbus_bool_t   _dbus_string_steal_data_len        (DBusString        *str,
99                                                  char             **data_return,
100                                                  int                start,
101                                                  int                len);
102dbus_bool_t   _dbus_string_copy_data             (const DBusString  *str,
103                                                  char             **data_return);
104dbus_bool_t   _dbus_string_copy_data_len         (const DBusString  *str,
105                                                  char             **data_return,
106                                                  int                start,
107                                                  int                len);
108void          _dbus_string_copy_to_buffer        (const DBusString  *str,
109                                                  char              *buffer,
110						  int                len);
111#ifndef _dbus_string_get_length
112int           _dbus_string_get_length            (const DBusString  *str);
113#endif /* !_dbus_string_get_length */
114
115dbus_bool_t   _dbus_string_lengthen              (DBusString        *str,
116                                                  int                additional_length);
117void          _dbus_string_shorten               (DBusString        *str,
118                                                  int                length_to_remove);
119dbus_bool_t   _dbus_string_set_length            (DBusString        *str,
120                                                  int                length);
121dbus_bool_t   _dbus_string_align_length          (DBusString        *str,
122                                                  int                alignment);
123dbus_bool_t   _dbus_string_alloc_space           (DBusString        *str,
124                                                  int                extra_bytes);
125dbus_bool_t   _dbus_string_append                (DBusString        *str,
126                                                  const char        *buffer);
127dbus_bool_t   _dbus_string_append_len            (DBusString        *str,
128                                                  const char        *buffer,
129                                                  int                len);
130dbus_bool_t   _dbus_string_append_int            (DBusString        *str,
131                                                  long               value);
132dbus_bool_t   _dbus_string_append_uint           (DBusString        *str,
133                                                  unsigned long      value);
134dbus_bool_t   _dbus_string_append_double         (DBusString        *str,
135                                                  double             value);
136dbus_bool_t   _dbus_string_append_byte           (DBusString        *str,
137                                                  unsigned char      byte);
138dbus_bool_t   _dbus_string_append_unichar        (DBusString        *str,
139                                                  dbus_unichar_t     ch);
140dbus_bool_t   _dbus_string_append_4_aligned      (DBusString        *str,
141                                                  const unsigned char octets[4]);
142dbus_bool_t   _dbus_string_append_8_aligned      (DBusString        *str,
143                                                  const unsigned char octets[8]);
144dbus_bool_t   _dbus_string_append_printf         (DBusString        *str,
145                                                  const char        *format,
146                                                  ...) _DBUS_GNUC_PRINTF (2, 3);
147dbus_bool_t   _dbus_string_append_printf_valist  (DBusString        *str,
148                                                  const char        *format,
149                                                  va_list            args);
150dbus_bool_t   _dbus_string_insert_4_aligned      (DBusString        *str,
151                                                  int                insert_at,
152                                                  const unsigned char octets[4]);
153dbus_bool_t   _dbus_string_insert_8_aligned      (DBusString        *str,
154                                                  int                insert_at,
155                                                  const unsigned char octets[8]);
156void          _dbus_string_delete                (DBusString        *str,
157                                                  int                start,
158                                                  int                len);
159dbus_bool_t   _dbus_string_move                  (DBusString        *source,
160                                                  int                start,
161                                                  DBusString        *dest,
162                                                  int                insert_at);
163dbus_bool_t   _dbus_string_copy                  (const DBusString  *source,
164                                                  int                start,
165                                                  DBusString        *dest,
166                                                  int                insert_at);
167dbus_bool_t   _dbus_string_move_len              (DBusString        *source,
168                                                  int                start,
169                                                  int                len,
170                                                  DBusString        *dest,
171                                                  int                insert_at);
172dbus_bool_t   _dbus_string_copy_len              (const DBusString  *source,
173                                                  int                start,
174                                                  int                len,
175                                                  DBusString        *dest,
176                                                  int                insert_at);
177dbus_bool_t   _dbus_string_replace_len           (const DBusString  *source,
178                                                  int                start,
179                                                  int                len,
180                                                  DBusString        *dest,
181                                                  int                replace_at,
182                                                  int                replace_len);
183void          _dbus_string_get_unichar           (const DBusString  *str,
184                                                  int                start,
185                                                  dbus_unichar_t    *ch_return,
186                                                  int               *end_return);
187dbus_bool_t   _dbus_string_parse_int             (const DBusString  *str,
188                                                  int                start,
189                                                  long              *value_return,
190                                                  int               *end_return);
191dbus_bool_t   _dbus_string_parse_uint            (const DBusString  *str,
192                                                  int                start,
193                                                  unsigned long     *value_return,
194                                                  int               *end_return);
195dbus_bool_t   _dbus_string_parse_double          (const DBusString  *str,
196                                                  int                start,
197                                                  double            *value,
198                                                  int               *end_return);
199dbus_bool_t   _dbus_string_parse_basic_type      (const DBusString  *str,
200						  char               type,
201                                                  int                start,
202                                                  void              *value,
203                                                  int               *end_return);
204dbus_bool_t   _dbus_string_find                  (const DBusString  *str,
205                                                  int                start,
206                                                  const char        *substr,
207                                                  int               *found);
208dbus_bool_t   _dbus_string_find_to               (const DBusString  *str,
209                                                  int                start,
210                                                  int                end,
211                                                  const char        *substr,
212                                                  int               *found);
213dbus_bool_t   _dbus_string_find_byte_backward    (const DBusString  *str,
214                                                  int                start,
215                                                  unsigned char      byte,
216                                                  int               *found);
217dbus_bool_t   _dbus_string_find_blank            (const DBusString  *str,
218                                                  int                start,
219                                                  int               *found);
220void          _dbus_string_skip_blank            (const DBusString  *str,
221                                                  int                start,
222                                                  int               *end);
223void          _dbus_string_skip_white            (const DBusString  *str,
224                                                  int                start,
225                                                  int               *end);
226dbus_bool_t   _dbus_string_equal                 (const DBusString  *a,
227                                                  const DBusString  *b);
228dbus_bool_t   _dbus_string_equal_c_str           (const DBusString  *a,
229                                                  const char        *c_str);
230dbus_bool_t   _dbus_string_equal_len             (const DBusString  *a,
231                                                  const DBusString  *b,
232                                                  int                len);
233dbus_bool_t   _dbus_string_equal_substring       (const DBusString  *a,
234                                                  int                a_start,
235                                                  int                a_len,
236                                                  const DBusString  *b,
237                                                  int                b_start);
238dbus_bool_t   _dbus_string_starts_with_c_str     (const DBusString  *a,
239                                                  const char        *c_str);
240dbus_bool_t   _dbus_string_ends_with_c_str       (const DBusString  *a,
241                                                  const char        *c_str);
242dbus_bool_t   _dbus_string_pop_line              (DBusString        *source,
243                                                  DBusString        *dest);
244void          _dbus_string_delete_first_word     (DBusString        *str);
245void          _dbus_string_delete_leading_blanks (DBusString        *str);
246dbus_bool_t   _dbus_string_hex_encode            (const DBusString  *source,
247                                                  int                start,
248                                                  DBusString        *dest,
249                                                  int                insert_at);
250dbus_bool_t   _dbus_string_hex_decode            (const DBusString  *source,
251                                                  int                start,
252						  int               *end_return,
253                                                  DBusString        *dest,
254                                                  int                insert_at);
255dbus_bool_t   _dbus_string_validate_ascii        (const DBusString  *str,
256                                                  int                start,
257                                                  int                len);
258dbus_bool_t   _dbus_string_validate_utf8         (const DBusString  *str,
259                                                  int                start,
260                                                  int                len);
261dbus_bool_t   _dbus_string_validate_nul          (const DBusString  *str,
262                                                  int                start,
263                                                  int                len);
264dbus_bool_t   _dbus_string_validate_path         (const DBusString  *str,
265                                                  int                start,
266                                                  int                len);
267dbus_bool_t   _dbus_string_validate_interface    (const DBusString  *str,
268                                                  int                start,
269                                                  int                len);
270dbus_bool_t   _dbus_string_validate_member       (const DBusString  *str,
271                                                  int                start,
272                                                  int                len);
273dbus_bool_t   _dbus_string_validate_error_name   (const DBusString  *str,
274                                                  int                start,
275                                                  int                len);
276dbus_bool_t   _dbus_string_validate_service      (const DBusString  *str,
277                                                  int                start,
278                                                  int                len);
279dbus_bool_t   _dbus_string_validate_signature    (const DBusString  *str,
280                                                  int                start,
281                                                  int                len);
282void          _dbus_string_zero                  (DBusString        *str);
283
284
285DBUS_END_DECLS
286
287#endif /* DBUS_STRING_H */
288