D-Bus  1.6.12
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 
35 
40 typedef struct DBusString DBusString;
41 
42 struct DBusString
43 {
44 #if defined(DBUS_WIN) && defined(_DEBUG)
45  const char *dummy1;
46 #else
47  const void *dummy1;
48 #endif
49  int dummy2;
50  int dummy3;
51  unsigned int dummy_bit1 : 1;
52  unsigned int dummy_bit2 : 1;
53  unsigned int dummy_bit3 : 1;
54  unsigned int dummy_bits : 3;
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 
72  const char *value);
74  const char *value,
75  int len);
77  int allocate_size);
78 void _dbus_string_free (DBusString *str);
79 void _dbus_string_lock (DBusString *str);
81  int max_waste);
82 #ifndef _dbus_string_get_data
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 */
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
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 */
106  int i,
107  int n_bytes,
108  unsigned char byte);
110  int i,
111  unsigned char byte);
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);
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);
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 
135  int additional_length);
137  int length_to_remove);
139  int length);
141  int alignment);
143  int extra_bytes);
145  const char *buffer);
147  const char *buffer,
148  int len);
150  long value);
152  unsigned long value);
154  unsigned char byte);
156  const char *format,
157  ...) _DBUS_GNUC_PRINTF (2, 3);
159  const char *format,
160  va_list args);
162  int insert_at,
163  const unsigned char octets[2]);
165  int insert_at,
166  const unsigned char octets[4]);
168  int insert_at,
169  const unsigned char octets[8]);
171  int *insert_at,
172  int alignment);
174  int start,
175  int len);
177  int start,
178  DBusString *dest,
179  int insert_at);
181  int start,
182  DBusString *dest,
183  int insert_at);
185  int start,
186  int len,
187  DBusString *dest,
188  int insert_at);
190  int start,
191  int len,
192  DBusString *dest,
193  int insert_at);
195  int start,
196  int len,
197  DBusString *dest,
198  int replace_at,
199  int replace_len);
201  unsigned char byte,
202  DBusString *tail);
204  int start,
205  long *value_return,
206  int *end_return);
208  int start,
209  unsigned long *value_return,
210  int *end_return);
212  int start,
213  const char *substr,
214  int *found);
216  int start,
217  int *found,
218  int *found_len);
220  int start,
221  int end,
222  const char *substr,
223  int *found);
225  int start,
226  unsigned char byte,
227  int *found);
229  int start,
230  int *found);
231 void _dbus_string_skip_blank (const DBusString *str,
232  int start,
233  int *end);
234 void _dbus_string_skip_white (const DBusString *str,
235  int start,
236  int *end);
238  int end,
239  int *start);
241  const DBusString *b);
243  const char *c_str);
245  const DBusString *b,
246  int len);
248  int a_start,
249  int a_len,
250  const DBusString *b,
251  int b_start);
253  const char *c_str);
255  const char *c_str);
257  DBusString *dest);
258 void _dbus_string_delete_first_word (DBusString *str);
259 void _dbus_string_delete_leading_blanks (DBusString *str);
262  int byte);
264  int start,
265  DBusString *dest,
266  int insert_at);
268  int start,
269  int *end_return,
270  DBusString *dest,
271  int insert_at);
272 void _dbus_string_tolower_ascii (const DBusString *str,
273  int start,
274  int len);
275 void _dbus_string_toupper_ascii (const DBusString *str,
276  int start,
277  int len);
279  int start,
280  int len);
282  int start,
283  int len);
285  int start,
286  int len);
287 void _dbus_string_zero (DBusString *str);
288 
289 
295 #define _DBUS_STRING_ALLOCATION_PADDING 8
296 
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 }
311 
313 
314 #endif /* DBUS_STRING_H */
dbus_bool_t _dbus_string_insert_bytes(DBusString *str, int i, int n_bytes, unsigned char byte)
Inserts a number of bytes of a given value at the given position.
Definition: dbus-string.c:562
dbus_bool_t _dbus_string_append(DBusString *str, const char *buffer)
Appends a nul-terminated C-style string to a DBusString.
Definition: dbus-string.c:913
dbus_bool_t _dbus_string_parse_int(const DBusString *str, int start, long *value_return, int *end_return)
Parses an integer contained in a DBusString.
Definition: dbus-sysdeps.c:433
void _dbus_string_copy_to_buffer(const DBusString *str, char *buffer, int avail_len)
Copies the contents of a DBusString into a different buffer.
Definition: dbus-string.c:675
const void * dummy1
placeholder
Definition: dbus-string.h:47
dbus_bool_t _dbus_string_append_uint(DBusString *str, unsigned long value)
Appends an unsigned integer to a DBusString.
Definition: dbus-sysdeps.c:390
dbus_bool_t _dbus_string_equal(const DBusString *a, const DBusString *b)
Tests two DBusString for equality.
Definition: dbus-string.c:2010
dbus_bool_t _dbus_string_find_eol(const DBusString *str, int start, int *found, int *found_len)
Finds end of line (&quot;\r\n&quot; or &quot;\n&quot;) in the string, returning TRUE and filling in the byte index where ...
Definition: dbus-string.c:1624
dbus_bool_t _dbus_string_lengthen(DBusString *str, int additional_length)
Makes a string longer by the given number of bytes.
Definition: dbus-string.c:738
unsigned int dummy_bits
placeholder
Definition: dbus-string.h:54
dbus_bool_t _dbus_string_append_byte_as_hex(DBusString *str, int byte)
Appends a two-character hex digit to a string, where the hex digit has the value of the given byte...
Definition: dbus-string.c:2222
void _dbus_string_copy_to_buffer_with_nul(const DBusString *str, char *buffer, int avail_len)
Copies the contents of a DBusString into a different buffer.
Definition: dbus-string.c:697
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
dbus_bool_t _dbus_string_hex_encode(const DBusString *source, int start, DBusString *dest, int insert_at)
Encodes a string in hex, the way MD5 and SHA-1 are usually encoded.
Definition: dbus-string.c:2256
dbus_bool_t _dbus_string_append_int(DBusString *str, long value)
Appends an integer to a DBusString.
Definition: dbus-sysdeps.c:352
dbus_bool_t _dbus_string_starts_with_c_str(const DBusString *a, const char *c_str)
Checks whether a string starts with the given C string.
Definition: dbus-string.c:2185
void _dbus_string_chop_white(DBusString *str)
Deletes leading and trailing whitespace.
Definition: dbus-string.c:1986
dbus_bool_t _dbus_string_insert_8_aligned(DBusString *str, int insert_at, const unsigned char octets[8])
Inserts 8 bytes aligned on an 8 byte boundary with any alignment padding initialized to 0...
Definition: dbus-string.c:1018
void _dbus_string_tolower_ascii(const DBusString *str, int start, int len)
Converts the given range of the string to lower case.
Definition: dbus-string.c:2482
int dummy3
placeholder
Definition: dbus-string.h:50
unsigned int dummy_bit1
placeholder
Definition: dbus-string.h:51
unsigned int dummy_bit2
placeholder
Definition: dbus-string.h:52
unsigned char _dbus_string_get_byte(const DBusString *str, int start)
Gets the byte at the given position.
Definition: dbus-string.c:540
char * _dbus_string_get_data_len(DBusString *str, int start, int len)
Gets a sub-portion of the raw character buffer from the string.
Definition: dbus-string.c:468
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:175
dbus_bool_t _dbus_string_append_printf_valist(DBusString *str, const char *format, va_list args)
Appends a printf-style formatted string to the DBusString.
Definition: dbus-string.c:1070
void _dbus_string_shorten(DBusString *str, int length_to_remove)
Makes a string shorter by the given number of bytes.
Definition: dbus-string.c:758
dbus_bool_t _dbus_string_copy(const DBusString *source, int start, DBusString *dest, int insert_at)
Like _dbus_string_move(), but does not delete the section of the source string that&#39;s copied to the d...
Definition: dbus-string.c:1280
dbus_bool_t _dbus_string_ends_with_c_str(const DBusString *a, const char *c_str)
Returns whether a string ends with the given suffix.
dbus_bool_t _dbus_string_find(const DBusString *str, int start, const char *substr, int *found)
Finds the given substring in the string, returning TRUE and filling in the byte index where the subst...
Definition: dbus-string.c:1601
void _dbus_string_skip_white(const DBusString *str, int start, int *end)
Skips whitespace from start, storing the first non-whitespace in *end.
Definition: dbus-string.c:1834
dbus_bool_t _dbus_string_move(DBusString *source, int start, DBusString *dest, int insert_at)
Moves the end of one string into another string.
Definition: dbus-string.c:1256
dbus_bool_t _dbus_string_equal_c_str(const DBusString *a, const char *c_str)
Checks whether a string is equal to a C string.
Definition: dbus-string.c:2149
dbus_bool_t _dbus_string_compact(DBusString *str, int max_waste)
Compacts the string to avoid wasted memory.
Definition: dbus-string.c:367
dbus_bool_t _dbus_string_copy_data(const DBusString *str, char **data_return)
Copies the data from the string into a char*.
Definition: dbus-string.c:650
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
void _dbus_string_init_const(DBusString *str, const char *value)
Initializes a constant string.
Definition: dbus-string.c:190
char * _dbus_string_get_data(DBusString *str)
Gets the raw character buffer from the string.
Definition: dbus-string.c:429
dbus_bool_t _dbus_string_replace_len(const DBusString *source, int start, int len, DBusString *dest, int replace_at, int replace_len)
Replaces a segment of dest string with a segment of source string.
Definition: dbus-string.c:1401
void _dbus_string_skip_blank(const DBusString *str, int start, int *end)
Skips blanks from start, storing the first non-blank in *end (blank is space or tab).
Definition: dbus-string.c:1800
dbus_bool_t _dbus_string_pop_line(DBusString *source, DBusString *dest)
Assigns a newline-terminated or \r\n-terminated line from the front of the string to the given dest s...
Definition: dbus-string.c:1906
void _dbus_string_delete(DBusString *str, int start, int len)
Deletes a segment of a DBusString with length len starting at start.
Definition: dbus-string.c:1190
dbus_bool_t _dbus_string_init_preallocated(DBusString *str, int allocate_size)
Initializes a string that can be up to the given allocation size before it has to realloc...
Definition: dbus-string.c:132
dbus_bool_t _dbus_string_append_printf(DBusString *str, const char *format,...)
Appends a printf-style formatted string to the DBusString.
Definition: dbus-string.c:1111
int _dbus_string_get_length(const DBusString *str)
Gets the length of a string (not including nul termination).
Definition: dbus-string.c:717
void _dbus_string_zero(DBusString *str)
Clears all allocated bytes in the string to zero.
Definition: dbus-string.c:2682
dbus_bool_t _dbus_string_validate_utf8(const DBusString *str, int start, int len)
Checks that the given range of the string is valid UTF-8.
Definition: dbus-string.c:2552
dbus_bool_t _dbus_string_align_length(DBusString *str, int alignment)
Align the length of a string to a specific alignment (typically 4 or 8) by appending nul bytes to the...
Definition: dbus-string.c:861
dbus_bool_t _dbus_string_equal_substring(const DBusString *a, int a_start, int a_len, const DBusString *b, int b_start)
Tests two sub-parts of two DBusString for equality.
Definition: dbus-string.c:2101
dbus_bool_t _dbus_string_equal_len(const DBusString *a, const DBusString *b, int len)
Tests two DBusString for equality up to the given length.
Definition: dbus-string.c:2053
dbus_bool_t _dbus_string_insert_byte(DBusString *str, int i, unsigned char byte)
Inserts a single byte at the given position.
Definition: dbus-string.c:592
dbus_bool_t _dbus_string_append_byte(DBusString *str, unsigned char byte)
Appends a single byte to the string, returning FALSE if not enough memory.
Definition: dbus-string.c:1154
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init().
Definition: dbus-string.c:242
unsigned int dummy_bit3
placeholder
Definition: dbus-string.h:53
dbus_bool_t _dbus_string_find_byte_backward(const DBusString *str, int start, unsigned char byte, int *found)
Find the given byte scanning backward from the given start.
dbus_bool_t _dbus_string_find_blank(const DBusString *str, int start, int *found)
Finds a blank (space or tab) in the string.
Definition: dbus-string.c:1762
void _dbus_string_set_byte(DBusString *str, int i, unsigned char byte)
Sets the value of the byte at the given position.
Definition: dbus-string.c:516
dbus_bool_t _dbus_string_alloc_space(DBusString *str, int extra_bytes)
Preallocate extra_bytes such that a future lengthening of the string by extra_bytes is guaranteed to ...
Definition: dbus-string.c:877
dbus_bool_t _dbus_string_hex_decode(const DBusString *source, int start, int *end_return, DBusString *dest, int insert_at)
Decodes a string from hex encoding.
Definition: dbus-string.c:2306
const char * _dbus_string_get_const_data_len(const DBusString *str, int start, int len)
const version of _dbus_string_get_data_len().
Definition: dbus-string.c:492
dbus_bool_t _dbus_string_parse_uint(const DBusString *str, int start, unsigned long *value_return, int *end_return)
Parses an unsigned integer contained in a DBusString.
Definition: dbus-sysdeps.c:472
dbus_bool_t _dbus_string_append_len(DBusString *str, const char *buffer, int len)
Appends block of bytes with the given length to a DBusString.
Definition: dbus-string.c:1134
dbus_bool_t _dbus_string_find_to(const DBusString *str, int start, int end, const char *substr, int *found)
Finds the given substring in the string, up to a certain position, returning TRUE and filling in the ...
Definition: dbus-string.c:1694
dbus_bool_t _dbus_string_validate_nul(const DBusString *str, int start, int len)
Checks that the given range of the string is all nul bytes.
Definition: dbus-string.c:2650
dbus_bool_t _dbus_string_insert_4_aligned(DBusString *str, int insert_at, const unsigned char octets[4])
Inserts 4 bytes aligned on a 4 byte boundary with any alignment padding initialized to 0...
Definition: dbus-string.c:994
void _dbus_string_skip_white_reverse(const DBusString *str, int end, int *start)
Skips whitespace from end, storing the start index of the trailing whitespace in *start.
Definition: dbus-string.c:1867
int dummy2
placeholder
Definition: dbus-string.h:49
dbus_bool_t _dbus_string_set_length(DBusString *str, int length)
Sets the length of a string.
Definition: dbus-string.c:780
dbus_bool_t _dbus_string_copy_len(const DBusString *source, int start, int len, DBusString *dest, int insert_at)
Like _dbus_string_copy(), but can copy a segment from the middle of the source string.
Definition: dbus-string.c:1372
dbus_bool_t _dbus_string_steal_data(DBusString *str, char **data_return)
Like _dbus_string_get_data(), but removes the gotten data from the original string.
Definition: dbus-string.c:619
void _dbus_string_toupper_ascii(const DBusString *str, int start, int len)
Converts the given range of the string to upper case.
Definition: dbus-string.c:2513
dbus_bool_t _dbus_string_insert_2_aligned(DBusString *str, int insert_at, const unsigned char octets[4])
Inserts 2 bytes aligned on a 2 byte boundary with any alignment padding initialized to 0...
Definition: dbus-string.c:970
dbus_bool_t _dbus_string_insert_alignment(DBusString *str, int *insert_at, int alignment)
Inserts padding at *insert_at such to align it to the given boundary.
Definition: dbus-string.c:1046
const char * _dbus_string_get_const_data(const DBusString *str)
Gets the raw character buffer from a const string.
Definition: dbus-string.c:446
dbus_bool_t _dbus_string_validate_ascii(const DBusString *str, int start, int len)
Checks that the given range of the string is valid ASCII with no nul bytes.
Definition: dbus-string.c:2447
void _dbus_string_init_const_len(DBusString *str, const char *value, int len)
Initializes a constant string with a length.
Definition: dbus-string.c:210
dbus_bool_t _dbus_string_move_len(DBusString *source, int start, int len, DBusString *dest, int insert_at)
Like _dbus_string_move(), but can move a segment from the middle of the source string.
Definition: dbus-string.c:1305
dbus_bool_t _dbus_string_split_on_byte(DBusString *source, unsigned char byte, DBusString *tail)
Looks for the first occurance of a byte, deletes that byte, and moves everything after the byte to th...
Definition: dbus-string.c:1464
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.