Remove unused _dbus_string_append_4_aligned, _dbus_string_append_8_aligned
[platform/upstream/dbus.git] / dbus / dbus-string.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-string.h String utility class (internal to D-Bus implementation)
3  * 
4  * Copyright (C) 2002, 2003 Red Hat, Inc.
5  * Copyright (C) 2006 Ralf Habacker <ralf.habacker@freenet.de>
6  *
7  * Licensed under the Academic Free License version 2.1
8  * 
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.
13  *
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.
18  * 
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
22  *
23  */
24
25 #ifndef DBUS_STRING_H
26 #define DBUS_STRING_H
27
28 #include <dbus/dbus-macros.h>
29 #include <dbus/dbus-types.h>
30 #include <dbus/dbus-memory.h>
31
32 #include <stdarg.h>
33
34 DBUS_BEGIN_DECLS
35
36 /**
37  * DBusString object
38  */
39
40 typedef struct DBusString DBusString;
41
42 struct DBusString
43 {
44 #if defined(DBUS_WIN) && defined(_DEBUG)
45   const char *dummy1; /**< placeholder */
46 #else
47   const void *dummy1; /**< placeholder */
48 #endif
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 */
55 };
56
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)
61  */
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))
68 #endif
69
70 dbus_bool_t   _dbus_string_init                  (DBusString        *str);
71 void          _dbus_string_init_const            (DBusString        *str,
72                                                   const char        *value);
73 void          _dbus_string_init_const_len        (DBusString        *str,
74                                                   const char        *value,
75                                                   int                len);
76 dbus_bool_t   _dbus_string_init_preallocated     (DBusString        *str,
77                                                   int                allocate_size);
78 void          _dbus_string_free                  (DBusString        *str);
79 void          _dbus_string_lock                  (DBusString        *str);
80 dbus_bool_t   _dbus_string_compact               (DBusString        *str,
81                                                   int                max_waste);
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,
89                                                   int                start,
90                                                   int                len);
91 #ifndef _dbus_string_get_const_data_len
92 const char*   _dbus_string_get_const_data_len    (const DBusString  *str,
93                                                   int                start,
94                                                   int                len);
95 #endif
96 #ifndef _dbus_string_set_byte
97 void          _dbus_string_set_byte              (DBusString        *str,
98                                                   int                i,
99                                                   unsigned char      byte);
100 #endif
101 #ifndef _dbus_string_get_byte
102 unsigned char _dbus_string_get_byte              (const DBusString  *str,
103                                                   int                start);
104 #endif /* _dbus_string_get_byte */
105 dbus_bool_t   _dbus_string_insert_bytes          (DBusString        *str,
106                                                   int                i,
107                                                   int                n_bytes,
108                                                   unsigned char      byte);
109 dbus_bool_t   _dbus_string_insert_byte           (DBusString        *str,
110                                                   int                i,
111                                                   unsigned char      byte);
112 dbus_bool_t   _dbus_string_steal_data            (DBusString        *str,
113                                                   char             **data_return);
114 dbus_bool_t   _dbus_string_steal_data_len        (DBusString        *str,
115                                                   char             **data_return,
116                                                   int                start,
117                                                   int                len);
118 dbus_bool_t   _dbus_string_copy_data             (const DBusString  *str,
119                                                   char             **data_return);
120 dbus_bool_t   _dbus_string_copy_data_len         (const DBusString  *str,
121                                                   char             **data_return,
122                                                   int                start,
123                                                   int                len);
124 void          _dbus_string_copy_to_buffer        (const DBusString  *str,
125                                                   char              *buffer,
126                                                   int                len);
127 void          _dbus_string_copy_to_buffer_with_nul (const DBusString  *str,
128                                                     char              *buffer,
129                                                     int                avail_len);
130 #ifndef _dbus_string_get_length
131 int           _dbus_string_get_length            (const DBusString  *str);
132 #endif /* !_dbus_string_get_length */
133
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,
139                                                   int                length);
140 dbus_bool_t   _dbus_string_align_length          (DBusString        *str,
141                                                   int                alignment);
142 dbus_bool_t   _dbus_string_alloc_space           (DBusString        *str,
143                                                   int                extra_bytes);
144 dbus_bool_t   _dbus_string_append                (DBusString        *str,
145                                                   const char        *buffer);
146 dbus_bool_t   _dbus_string_append_len            (DBusString        *str,
147                                                   const char        *buffer,
148                                                   int                len);
149 dbus_bool_t   _dbus_string_append_int            (DBusString        *str,
150                                                   long               value);
151 dbus_bool_t   _dbus_string_append_uint           (DBusString        *str,
152                                                   unsigned long      value);
153 dbus_bool_t   _dbus_string_append_double         (DBusString        *str,
154                                                   double             value);
155 dbus_bool_t   _dbus_string_append_byte           (DBusString        *str,
156                                                   unsigned char      byte);
157 dbus_bool_t   _dbus_string_append_unichar        (DBusString        *str,
158                                                   dbus_unichar_t     ch);
159 dbus_bool_t   _dbus_string_append_printf         (DBusString        *str,
160                                                   const char        *format,
161                                                   ...) _DBUS_GNUC_PRINTF (2, 3);
162 dbus_bool_t   _dbus_string_append_printf_valist  (DBusString        *str,
163                                                   const char        *format,
164                                                   va_list            args);
165 dbus_bool_t   _dbus_string_insert_2_aligned      (DBusString        *str,
166                                                   int                insert_at,
167                                                   const unsigned char octets[2]);
168 dbus_bool_t   _dbus_string_insert_4_aligned      (DBusString        *str,
169                                                   int                insert_at,
170                                                   const unsigned char octets[4]);
171 dbus_bool_t   _dbus_string_insert_8_aligned      (DBusString        *str,
172                                                   int                insert_at,
173                                                   const unsigned char octets[8]);
174 dbus_bool_t   _dbus_string_insert_alignment      (DBusString        *str,
175                                                   int               *insert_at,
176                                                   int                alignment);
177 void          _dbus_string_delete                (DBusString        *str,
178                                                   int                start,
179                                                   int                len);
180 dbus_bool_t   _dbus_string_move                  (DBusString        *source,
181                                                   int                start,
182                                                   DBusString        *dest,
183                                                   int                insert_at);
184 dbus_bool_t   _dbus_string_copy                  (const DBusString  *source,
185                                                   int                start,
186                                                   DBusString        *dest,
187                                                   int                insert_at);
188 dbus_bool_t   _dbus_string_move_len              (DBusString        *source,
189                                                   int                start,
190                                                   int                len,
191                                                   DBusString        *dest,
192                                                   int                insert_at);
193 dbus_bool_t   _dbus_string_copy_len              (const DBusString  *source,
194                                                   int                start,
195                                                   int                len,
196                                                   DBusString        *dest,
197                                                   int                insert_at);
198 dbus_bool_t   _dbus_string_replace_len           (const DBusString  *source,
199                                                   int                start,
200                                                   int                len,
201                                                   DBusString        *dest,
202                                                   int                replace_at,
203                                                   int                replace_len);
204 dbus_bool_t   _dbus_string_split_on_byte         (DBusString        *source,
205                                                   unsigned char      byte,
206                                                   DBusString        *tail);
207 void          _dbus_string_get_unichar           (const DBusString  *str,
208                                                   int                start,
209                                                   dbus_unichar_t    *ch_return,
210                                                   int               *end_return);
211 dbus_bool_t   _dbus_string_parse_int             (const DBusString  *str,
212                                                   int                start,
213                                                   long              *value_return,
214                                                   int               *end_return);
215 dbus_bool_t   _dbus_string_parse_uint            (const DBusString  *str,
216                                                   int                start,
217                                                   unsigned long     *value_return,
218                                                   int               *end_return);
219 dbus_bool_t   _dbus_string_parse_double          (const DBusString  *str,
220                                                   int                start,
221                                                   double            *value,
222                                                   int               *end_return);
223 dbus_bool_t   _dbus_string_find                  (const DBusString  *str,
224                                                   int                start,
225                                                   const char        *substr,
226                                                   int               *found);
227 dbus_bool_t   _dbus_string_find_eol               (const DBusString *str,
228                                                   int               start,
229                                                   int               *found,
230                                                   int               *found_len);
231 dbus_bool_t   _dbus_string_find_to               (const DBusString  *str,
232                                                   int                start,
233                                                   int                end,
234                                                   const char        *substr,
235                                                   int               *found);
236 dbus_bool_t   _dbus_string_find_byte_backward    (const DBusString  *str,
237                                                   int                start,
238                                                   unsigned char      byte,
239                                                   int               *found);
240 dbus_bool_t   _dbus_string_find_blank            (const DBusString  *str,
241                                                   int                start,
242                                                   int               *found);
243 void          _dbus_string_skip_blank            (const DBusString  *str,
244                                                   int                start,
245                                                   int               *end);
246 void          _dbus_string_skip_white            (const DBusString  *str,
247                                                   int                start,
248                                                   int               *end);
249 void          _dbus_string_skip_white_reverse    (const DBusString  *str,
250                                                   int                end,
251                                                   int               *start);
252 dbus_bool_t   _dbus_string_equal                 (const DBusString  *a,
253                                                   const DBusString  *b);
254 dbus_bool_t   _dbus_string_equal_c_str           (const DBusString  *a,
255                                                   const char        *c_str);
256 dbus_bool_t   _dbus_string_equal_len             (const DBusString  *a,
257                                                   const DBusString  *b,
258                                                   int                len);
259 dbus_bool_t   _dbus_string_equal_substring       (const DBusString  *a,
260                                                   int                a_start,
261                                                   int                a_len,
262                                                   const DBusString  *b,
263                                                   int                b_start);
264 dbus_bool_t   _dbus_string_starts_with_c_str     (const DBusString  *a,
265                                                   const char        *c_str);
266 dbus_bool_t   _dbus_string_ends_with_c_str       (const DBusString  *a,
267                                                   const char        *c_str);
268 dbus_bool_t   _dbus_string_pop_line              (DBusString        *source,
269                                                   DBusString        *dest);
270 void          _dbus_string_delete_first_word     (DBusString        *str);
271 void          _dbus_string_delete_leading_blanks (DBusString        *str);
272 void          _dbus_string_chop_white            (DBusString        *str); 
273 dbus_bool_t   _dbus_string_append_byte_as_hex    (DBusString        *str,
274                                                   int                byte);
275 dbus_bool_t   _dbus_string_hex_encode            (const DBusString  *source,
276                                                   int                start,
277                                                   DBusString        *dest,
278                                                   int                insert_at);
279 dbus_bool_t   _dbus_string_hex_decode            (const DBusString  *source,
280                                                   int                start,
281                                                   int               *end_return,
282                                                   DBusString        *dest,
283                                                   int                insert_at);
284 void          _dbus_string_tolower_ascii         (const DBusString  *str,
285                                                   int                start,
286                                                   int                len);
287 void          _dbus_string_toupper_ascii         (const DBusString  *str,
288                                                   int                start,
289                                                   int                len);
290 dbus_bool_t   _dbus_string_validate_ascii        (const DBusString  *str,
291                                                   int                start,
292                                                   int                len);
293 dbus_bool_t   _dbus_string_validate_utf8         (const DBusString  *str,
294                                                   int                start,
295                                                   int                len);
296 dbus_bool_t   _dbus_string_validate_nul          (const DBusString  *str,
297                                                   int                start,
298                                                   int                len);
299 void          _dbus_string_zero                  (DBusString        *str);
300
301
302 /**
303  * We allocate 1 byte for nul termination, plus 7 bytes for possible
304  * align_offset, so we always need 8 bytes on top of the string's
305  * length to be in the allocated block.
306  */
307 #define _DBUS_STRING_ALLOCATION_PADDING 8
308
309 /**
310  * Defines a static const variable with type #DBusString called "name"
311  * containing the given string literal.
312  *
313  * @param name the name of the variable
314  * @param str the string value
315  */
316 #define _DBUS_STRING_DEFINE_STATIC(name, str)                           \
317   static const char _dbus_static_string_##name[] = str;                 \
318   static const DBusString name = { _dbus_static_string_##name,          \
319                                    sizeof(_dbus_static_string_##name),  \
320                                    sizeof(_dbus_static_string_##name) + \
321                                    _DBUS_STRING_ALLOCATION_PADDING,     \
322                                    TRUE, TRUE, FALSE, 0 }
323
324 DBUS_END_DECLS
325
326 #endif /* DBUS_STRING_H */