dbus-string.h revision f81e8702a6c09e1394c28ac110fa602050c5f74a
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 <config.h> 29 30#include <dbus/dbus-macros.h> 31#include <dbus/dbus-types.h> 32#include <dbus/dbus-memory.h> 33 34#include <stdarg.h> 35 36DBUS_BEGIN_DECLS 37 38/** 39 * DBusString object 40 */ 41 42typedef struct DBusString DBusString; 43 44struct DBusString 45{ 46 const void *dummy1; /**< placeholder */ 47 int dummy2; /**< placeholder */ 48 int dummy3; /**< placeholder */ 49 int dummy4; /**< placeholder */ 50 unsigned int dummy5 : 1; /**< placeholder */ 51 unsigned int dummy6 : 1; /**< placeholder */ 52 unsigned int dummy7 : 1; /**< placeholder */ 53 unsigned int dummy8 : 3; /**< placeholder */ 54}; 55 56#ifdef DBUS_DISABLE_ASSERT 57/* Some simple inlining hacks; the current linker is not smart enough 58 * to inline non-exported symbols across files in the library. 59 * Note that these break type safety (due to the casts) 60 */ 61#define _dbus_string_get_data(s) ((char*)(((DBusString*)(s))->dummy1)) 62#define _dbus_string_get_length(s) (((DBusString*)(s))->dummy2) 63#define _dbus_string_set_byte(s, i, b) ((((unsigned char*)(((DBusString*)(s))->dummy1))[(i)]) = (unsigned char) (b)) 64#define _dbus_string_get_byte(s, i) (((const unsigned char*)(((DBusString*)(s))->dummy1))[(i)]) 65#define _dbus_string_get_const_data(s) ((const char*)(((DBusString*)(s))->dummy1)) 66#define _dbus_string_get_const_data_len(s,start,len) (((const char*)(((DBusString*)(s))->dummy1)) + (start)) 67#endif 68 69dbus_bool_t _dbus_string_init (DBusString *str); 70void _dbus_string_init_const (DBusString *str, 71 const char *value); 72void _dbus_string_init_const_len (DBusString *str, 73 const char *value, 74 int len); 75dbus_bool_t _dbus_string_init_preallocated (DBusString *str, 76 int allocate_size); 77void _dbus_string_free (DBusString *str); 78void _dbus_string_lock (DBusString *str); 79dbus_bool_t _dbus_string_compact (DBusString *str, 80 int max_waste); 81#ifndef _dbus_string_get_data 82char* _dbus_string_get_data (DBusString *str); 83#endif /* _dbus_string_get_data */ 84#ifndef _dbus_string_get_const_data 85const char* _dbus_string_get_const_data (const DBusString *str); 86#endif /* _dbus_string_get_const_data */ 87char* _dbus_string_get_data_len (DBusString *str, 88 int start, 89 int len); 90#ifndef _dbus_string_get_const_data_len 91const char* _dbus_string_get_const_data_len (const DBusString *str, 92 int start, 93 int len); 94#endif 95#ifndef _dbus_string_set_byte 96void _dbus_string_set_byte (DBusString *str, 97 int i, 98 unsigned char byte); 99#endif 100#ifndef _dbus_string_get_byte 101unsigned char _dbus_string_get_byte (const DBusString *str, 102 int start); 103#endif /* _dbus_string_get_byte */ 104dbus_bool_t _dbus_string_insert_bytes (DBusString *str, 105 int i, 106 int n_bytes, 107 unsigned char byte); 108dbus_bool_t _dbus_string_insert_byte (DBusString *str, 109 int i, 110 unsigned char byte); 111dbus_bool_t _dbus_string_steal_data (DBusString *str, 112 char **data_return); 113dbus_bool_t _dbus_string_steal_data_len (DBusString *str, 114 char **data_return, 115 int start, 116 int len); 117dbus_bool_t _dbus_string_copy_data (const DBusString *str, 118 char **data_return); 119dbus_bool_t _dbus_string_copy_data_len (const DBusString *str, 120 char **data_return, 121 int start, 122 int len); 123void _dbus_string_copy_to_buffer (const DBusString *str, 124 char *buffer, 125 int len); 126void _dbus_string_copy_to_buffer_with_nul (const DBusString *str, 127 char *buffer, 128 int avail_len); 129#ifndef _dbus_string_get_length 130int _dbus_string_get_length (const DBusString *str); 131#endif /* !_dbus_string_get_length */ 132 133dbus_bool_t _dbus_string_lengthen (DBusString *str, 134 int additional_length); 135void _dbus_string_shorten (DBusString *str, 136 int length_to_remove); 137dbus_bool_t _dbus_string_set_length (DBusString *str, 138 int length); 139dbus_bool_t _dbus_string_align_length (DBusString *str, 140 int alignment); 141dbus_bool_t _dbus_string_alloc_space (DBusString *str, 142 int extra_bytes); 143dbus_bool_t _dbus_string_append (DBusString *str, 144 const char *buffer); 145dbus_bool_t _dbus_string_append_len (DBusString *str, 146 const char *buffer, 147 int len); 148dbus_bool_t _dbus_string_append_int (DBusString *str, 149 long value); 150dbus_bool_t _dbus_string_append_uint (DBusString *str, 151 unsigned long value); 152dbus_bool_t _dbus_string_append_double (DBusString *str, 153 double value); 154dbus_bool_t _dbus_string_append_byte (DBusString *str, 155 unsigned char byte); 156dbus_bool_t _dbus_string_append_unichar (DBusString *str, 157 dbus_unichar_t ch); 158dbus_bool_t _dbus_string_append_4_aligned (DBusString *str, 159 const unsigned char octets[4]); 160dbus_bool_t _dbus_string_append_8_aligned (DBusString *str, 161 const unsigned char octets[8]); 162dbus_bool_t _dbus_string_append_printf (DBusString *str, 163 const char *format, 164 ...) _DBUS_GNUC_PRINTF (2, 3); 165dbus_bool_t _dbus_string_append_printf_valist (DBusString *str, 166 const char *format, 167 va_list args); 168dbus_bool_t _dbus_string_insert_2_aligned (DBusString *str, 169 int insert_at, 170 const unsigned char octets[2]); 171dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str, 172 int insert_at, 173 const unsigned char octets[4]); 174dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str, 175 int insert_at, 176 const unsigned char octets[8]); 177dbus_bool_t _dbus_string_insert_alignment (DBusString *str, 178 int *insert_at, 179 int alignment); 180void _dbus_string_delete (DBusString *str, 181 int start, 182 int len); 183dbus_bool_t _dbus_string_move (DBusString *source, 184 int start, 185 DBusString *dest, 186 int insert_at); 187dbus_bool_t _dbus_string_copy (const DBusString *source, 188 int start, 189 DBusString *dest, 190 int insert_at); 191dbus_bool_t _dbus_string_move_len (DBusString *source, 192 int start, 193 int len, 194 DBusString *dest, 195 int insert_at); 196dbus_bool_t _dbus_string_copy_len (const DBusString *source, 197 int start, 198 int len, 199 DBusString *dest, 200 int insert_at); 201dbus_bool_t _dbus_string_replace_len (const DBusString *source, 202 int start, 203 int len, 204 DBusString *dest, 205 int replace_at, 206 int replace_len); 207dbus_bool_t _dbus_string_split_on_byte (DBusString *source, 208 unsigned char byte, 209 DBusString *tail); 210void _dbus_string_get_unichar (const DBusString *str, 211 int start, 212 dbus_unichar_t *ch_return, 213 int *end_return); 214dbus_bool_t _dbus_string_parse_int (const DBusString *str, 215 int start, 216 long *value_return, 217 int *end_return); 218dbus_bool_t _dbus_string_parse_uint (const DBusString *str, 219 int start, 220 unsigned long *value_return, 221 int *end_return); 222dbus_bool_t _dbus_string_parse_double (const DBusString *str, 223 int start, 224 double *value, 225 int *end_return); 226dbus_bool_t _dbus_string_find (const DBusString *str, 227 int start, 228 const char *substr, 229 int *found); 230dbus_bool_t _dbus_string_find_eol (const DBusString *str, 231 int start, 232 int *found, 233 int *found_len); 234dbus_bool_t _dbus_string_find_to (const DBusString *str, 235 int start, 236 int end, 237 const char *substr, 238 int *found); 239dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str, 240 int start, 241 unsigned char byte, 242 int *found); 243dbus_bool_t _dbus_string_find_blank (const DBusString *str, 244 int start, 245 int *found); 246void _dbus_string_skip_blank (const DBusString *str, 247 int start, 248 int *end); 249void _dbus_string_skip_white (const DBusString *str, 250 int start, 251 int *end); 252void _dbus_string_skip_white_reverse (const DBusString *str, 253 int end, 254 int *start); 255dbus_bool_t _dbus_string_equal (const DBusString *a, 256 const DBusString *b); 257dbus_bool_t _dbus_string_equal_c_str (const DBusString *a, 258 const char *c_str); 259dbus_bool_t _dbus_string_equal_len (const DBusString *a, 260 const DBusString *b, 261 int len); 262dbus_bool_t _dbus_string_equal_substring (const DBusString *a, 263 int a_start, 264 int a_len, 265 const DBusString *b, 266 int b_start); 267dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a, 268 const char *c_str); 269dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a, 270 const char *c_str); 271dbus_bool_t _dbus_string_pop_line (DBusString *source, 272 DBusString *dest); 273void _dbus_string_delete_first_word (DBusString *str); 274void _dbus_string_delete_leading_blanks (DBusString *str); 275void _dbus_string_chop_white (DBusString *str); 276dbus_bool_t _dbus_string_append_byte_as_hex (DBusString *str, 277 int byte); 278dbus_bool_t _dbus_string_hex_encode (const DBusString *source, 279 int start, 280 DBusString *dest, 281 int insert_at); 282dbus_bool_t _dbus_string_hex_decode (const DBusString *source, 283 int start, 284 int *end_return, 285 DBusString *dest, 286 int insert_at); 287dbus_bool_t _dbus_string_validate_ascii (const DBusString *str, 288 int start, 289 int len); 290dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str, 291 int start, 292 int len); 293dbus_bool_t _dbus_string_validate_nul (const DBusString *str, 294 int start, 295 int len); 296void _dbus_string_zero (DBusString *str); 297 298 299/** 300 * We allocate 1 byte for nul termination, plus 7 bytes for possible 301 * align_offset, so we always need 8 bytes on top of the string's 302 * length to be in the allocated block. 303 */ 304#define _DBUS_STRING_ALLOCATION_PADDING 8 305 306/** 307 * Defines a static const variable with type #DBusString called "name" 308 * containing the given string literal. 309 * 310 * @param name the name of the variable 311 * @param str the string value 312 */ 313#define _DBUS_STRING_DEFINE_STATIC(name, str) \ 314 static const char _dbus_static_string_##name[] = str; \ 315 static const DBusString name = { _dbus_static_string_##name, \ 316 sizeof(_dbus_static_string_##name), \ 317 sizeof(_dbus_static_string_##name) + \ 318 _DBUS_STRING_ALLOCATION_PADDING, \ 319 sizeof(_dbus_static_string_##name), \ 320 TRUE, TRUE, FALSE, 0 } 321 322DBUS_END_DECLS 323 324#endif /* DBUS_STRING_H */ 325