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_PRIVATE_EXPORT
  71 dbus_bool_t   _dbus_string_init                  (DBusString        *str);
  72 DBUS_PRIVATE_EXPORT
  73 void          _dbus_string_init_const            (DBusString        *str,
  74                                                   const char        *value);
  75 DBUS_PRIVATE_EXPORT
  76 void          _dbus_string_init_const_len        (DBusString        *str,
  77                                                   const char        *value,
  78                                                   int                len);
  79 dbus_bool_t   _dbus_string_init_preallocated     (DBusString        *str,
  80                                                   int                allocate_size);
  81
  82 DBUS_PRIVATE_EXPORT
  83 dbus_bool_t _dbus_string_init_from_string        (DBusString        *str,
  84                                                   const DBusString  *from);
  85 DBUS_PRIVATE_EXPORT
  86 void          _dbus_string_free                  (DBusString        *str);
  87 void          _dbus_string_lock                  (DBusString        *str);
  88 DBUS_PRIVATE_EXPORT
  89 dbus_bool_t   _dbus_string_compact               (DBusString        *str,
  90                                                   int                max_waste);
  91 #ifndef _dbus_string_get_data
  92 DBUS_PRIVATE_EXPORT
  93 char*         _dbus_string_get_data              (DBusString        *str);
  94 #endif /* _dbus_string_get_data */
  95 #ifndef _dbus_string_get_const_data
  96 DBUS_PRIVATE_EXPORT
  97 const char*   _dbus_string_get_const_data        (const DBusString  *str);
  98 #endif /* _dbus_string_get_const_data */
  99 char*         _dbus_string_get_data_len          (DBusString        *str,
 100                                                   int                start,
 101                                                   int                len);
 102 #ifndef _dbus_string_get_const_data_len
 103 DBUS_PRIVATE_EXPORT
 104 const char*   _dbus_string_get_const_data_len    (const DBusString  *str,
 105                                                   int                start,
 106                                                   int                len);
 107 #endif
 108 #ifndef _dbus_string_set_byte
 109 DBUS_PRIVATE_EXPORT
 110 void          _dbus_string_set_byte              (DBusString        *str,
 111                                                   int                i,
 112                                                   unsigned char      byte);
 113 #endif
 114 #ifndef _dbus_string_get_byte
 115 DBUS_PRIVATE_EXPORT
 116 unsigned char _dbus_string_get_byte              (const DBusString  *str,
 117                                                   int                start);
 118 #endif /* _dbus_string_get_byte */
 119 DBUS_PRIVATE_EXPORT
 120 dbus_bool_t   _dbus_string_insert_bytes          (DBusString        *str,
 121                                                   int                i,
 122                                                   int                n_bytes,
 123                                                   unsigned char      byte);
 124 DBUS_PRIVATE_EXPORT
 125 dbus_bool_t   _dbus_string_insert_byte           (DBusString        *str,
 126                                                   int                i,
 127                                                   unsigned char      byte);
 128 DBUS_PRIVATE_EXPORT
 129 dbus_bool_t   _dbus_string_steal_data            (DBusString        *str,
 130                                                   char             **data_return);
 131 dbus_bool_t   _dbus_string_steal_data_len        (DBusString        *str,
 132                                                   char             **data_return,
 133                                                   int                start,
 134                                                   int                len);
 135 DBUS_PRIVATE_EXPORT
 136 dbus_bool_t   _dbus_string_copy_data             (const DBusString  *str,
 137                                                   char             **data_return);
 138 dbus_bool_t   _dbus_string_copy_data_len         (const DBusString  *str,
 139                                                   char             **data_return,
 140                                                   int                start,
 141                                                   int                len);
 142 void          _dbus_string_copy_to_buffer        (const DBusString  *str,
 143                                                   char              *buffer,
 144                                                   int                len);
 145 DBUS_PRIVATE_EXPORT
 146 void          _dbus_string_copy_to_buffer_with_nul (const DBusString  *str,
 147                                                     char              *buffer,
 148                                                     int                avail_len);
 149 #ifndef _dbus_string_get_length
 150 DBUS_PRIVATE_EXPORT
 151 int           _dbus_string_get_length            (const DBusString  *str);
 152 #endif /* !_dbus_string_get_length */
 153
 154 /**
 155  * Get the string's length as an unsigned integer, for comparison with
 156  * size_t and similar unsigned types that does not trigger compiler
 157  * warnings about potential value changes during conversion.
 158  *
 159  * DBusString lengths are signed for historical reasons, but we know that
 160  * the length is always >= 0 (and DBUS_GENERIC_STRING_PREAMBLE asserts
 161  * that this is the case) so we know that this cast does not change the
 162  * value.
 163  */
 164 static inline unsigned int
 165 _dbus_string_get_length_uint (const DBusString *str)
 166 {
 167   return (unsigned int) _dbus_string_get_length (str);
 168 }
 169
 170 DBUS_PRIVATE_EXPORT
 171 dbus_bool_t   _dbus_string_lengthen              (DBusString        *str,
 172                                                   int                additional_length);
 173 DBUS_PRIVATE_EXPORT
 174 void          _dbus_string_shorten               (DBusString        *str,
 175                                                   int                length_to_remove);
 176 DBUS_PRIVATE_EXPORT
 177 dbus_bool_t   _dbus_string_set_length            (DBusString        *str,
 178                                                   int                length);
 179 dbus_bool_t   _dbus_string_align_length          (DBusString        *str,
 180                                                   int                alignment);
 181 dbus_bool_t   _dbus_string_alloc_space           (DBusString        *str,
 182                                                   int                extra_bytes);
 183 DBUS_PRIVATE_EXPORT
 184 dbus_bool_t   _dbus_string_append                (DBusString        *str,
 185                                                   const char        *buffer);
 186 DBUS_PRIVATE_EXPORT
 187 dbus_bool_t   _dbus_string_append_len            (DBusString        *str,
 188                                                   const char        *buffer,
 189                                                   int                len);
 190 DBUS_PRIVATE_EXPORT
 191 dbus_bool_t   _dbus_string_append_int            (DBusString        *str,
 192                                                   long               value);
 193 DBUS_PRIVATE_EXPORT
 194 dbus_bool_t   _dbus_string_append_uint           (DBusString        *str,
 195                                                   unsigned long      value);
 196 DBUS_PRIVATE_EXPORT
 197 dbus_bool_t   _dbus_string_append_byte           (DBusString        *str,
 198                                                   unsigned char      byte);
 199 DBUS_PRIVATE_EXPORT
 200 dbus_bool_t   _dbus_string_append_printf         (DBusString        *str,
 201                                                   const char        *format,
 202                                                   ...) _DBUS_GNUC_PRINTF (2, 3);
 203 DBUS_PRIVATE_EXPORT
 204 dbus_bool_t   _dbus_string_append_printf_valist  (DBusString        *str,
 205                                                   const char        *format,
 206                                                   va_list            args) _DBUS_GNUC_PRINTF (2, 0);
 207 dbus_bool_t   _dbus_string_insert_2_aligned      (DBusString        *str,
 208                                                   int                insert_at,
 209                                                   const unsigned char octets[2]);
 210 dbus_bool_t   _dbus_string_insert_4_aligned      (DBusString        *str,
 211                                                   int                insert_at,
 212                                                   const unsigned char octets[4]);
 213 dbus_bool_t   _dbus_string_insert_8_aligned      (DBusString        *str,
 214                                                   int                insert_at,
 215                                                   const unsigned char octets[8]);
 216 dbus_bool_t   _dbus_string_insert_alignment      (DBusString        *str,
 217                                                   int               *insert_at,
 218                                                   int                alignment);
 219 DBUS_PRIVATE_EXPORT
 220 void          _dbus_string_delete                (DBusString        *str,
 221                                                   int                start,
 222                                                   int                len);
 223 DBUS_PRIVATE_EXPORT
 224 dbus_bool_t   _dbus_string_move                  (DBusString        *source,
 225                                                   int                start,
 226                                                   DBusString        *dest,
 227                                                   int                insert_at);
 228 DBUS_PRIVATE_EXPORT
 229 dbus_bool_t   _dbus_string_copy                  (const DBusString  *source,
 230                                                   int                start,
 231                                                   DBusString        *dest,
 232                                                   int                insert_at);
 233 dbus_bool_t   _dbus_string_move_len              (DBusString        *source,
 234                                                   int                start,
 235                                                   int                len,
 236                                                   DBusString        *dest,
 237                                                   int                insert_at);
 238 DBUS_PRIVATE_EXPORT
 239 dbus_bool_t   _dbus_string_copy_len              (const DBusString  *source,
 240                                                   int                start,
 241                                                   int                len,
 242                                                   DBusString        *dest,
 243                                                   int                insert_at);
 244 DBUS_PRIVATE_EXPORT
 245 dbus_bool_t   _dbus_string_replace_len           (const DBusString  *source,
 246                                                   int                start,
 247                                                   int                len,
 248                                                   DBusString        *dest,
 249                                                   int                replace_at,
 250                                                   int                replace_len);
 251 DBUS_PRIVATE_EXPORT
 252 dbus_bool_t   _dbus_string_split_on_byte         (DBusString        *source,
 253                                                   unsigned char      byte,
 254                                                   DBusString        *tail);
 255 DBUS_PRIVATE_EXPORT
 256 dbus_bool_t   _dbus_string_parse_int             (const DBusString  *str,
 257                                                   int                start,
 258                                                   long              *value_return,
 259                                                   int               *end_return);
 260 DBUS_PRIVATE_EXPORT
 261 dbus_bool_t   _dbus_string_parse_uint            (const DBusString  *str,
 262                                                   int                start,
 263                                                   unsigned long     *value_return,
 264                                                   int               *end_return);
 265 DBUS_PRIVATE_EXPORT
 266 dbus_bool_t   _dbus_string_find                  (const DBusString  *str,
 267                                                   int                start,
 268                                                   const char        *substr,
 269                                                   int               *found);
 270 DBUS_PRIVATE_EXPORT
 271 dbus_bool_t   _dbus_string_find_eol               (const DBusString *str,
 272                                                   int               start,
 273                                                   int               *found,
 274                                                   int               *found_len);
 275 DBUS_PRIVATE_EXPORT
 276 dbus_bool_t   _dbus_string_find_to               (const DBusString  *str,
 277                                                   int                start,
 278                                                   int                end,
 279                                                   const char        *substr,
 280                                                   int               *found);
 281 dbus_bool_t   _dbus_string_find_byte_backward    (const DBusString  *str,
 282                                                   int                start,
 283                                                   unsigned char      byte,
 284                                                   int               *found);
 285 DBUS_PRIVATE_EXPORT
 286 dbus_bool_t   _dbus_string_find_blank            (const DBusString  *str,
 287                                                   int                start,
 288                                                   int               *found);
 289 DBUS_PRIVATE_EXPORT
 290 void          _dbus_string_skip_blank            (const DBusString  *str,
 291                                                   int                start,
 292                                                   int               *end);
 293 DBUS_PRIVATE_EXPORT
 294 void          _dbus_string_skip_white            (const DBusString  *str,
 295                                                   int                start,
 296                                                   int               *end);
 297 void          _dbus_string_skip_white_reverse    (const DBusString  *str,
 298                                                   int                end,
 299                                                   int               *start);
 300 DBUS_PRIVATE_EXPORT
 301 dbus_bool_t   _dbus_string_equal                 (const DBusString  *a,
 302                                                   const DBusString  *b);
 303 DBUS_PRIVATE_EXPORT
 304 dbus_bool_t   _dbus_string_equal_c_str           (const DBusString  *a,
 305                                                   const char        *c_str);
 306 DBUS_PRIVATE_EXPORT
 307 dbus_bool_t   _dbus_string_equal_len             (const DBusString  *a,
 308                                                   const DBusString  *b,
 309                                                   int                len);
 310 DBUS_PRIVATE_EXPORT
 311 dbus_bool_t   _dbus_string_equal_substring       (const DBusString  *a,
 312                                                   int                a_start,
 313                                                   int                a_len,
 314                                                   const DBusString  *b,
 315                                                   int                b_start);
 316 DBUS_PRIVATE_EXPORT
 317 dbus_bool_t   _dbus_string_starts_with_c_str     (const DBusString  *a,
 318                                                   const char        *c_str);
 319 dbus_bool_t   _dbus_string_ends_with_c_str       (const DBusString  *a,
 320                                                   const char        *c_str);
 321 DBUS_PRIVATE_EXPORT
 322 dbus_bool_t   _dbus_string_starts_with_words_c_str (const DBusString  *a,
 323                                                     const char        *c_str,
 324                                                     char               word_separator);
 325 DBUS_PRIVATE_EXPORT
 326 dbus_bool_t   _dbus_string_pop_line              (DBusString        *source,
 327                                                   DBusString        *dest);
 328 DBUS_PRIVATE_EXPORT
 329 void          _dbus_string_delete_first_word     (DBusString        *str);
 330 DBUS_PRIVATE_EXPORT
 331 void          _dbus_string_delete_leading_blanks (DBusString        *str);
 332 DBUS_PRIVATE_EXPORT
 333 void          _dbus_string_chop_white            (DBusString        *str);
 334 dbus_bool_t   _dbus_string_append_byte_as_hex    (DBusString        *str,
 335                                                   unsigned char      byte);
 336 DBUS_PRIVATE_EXPORT
 337 dbus_bool_t   _dbus_string_hex_encode            (const DBusString  *source,
 338                                                   int                start,
 339                                                   DBusString        *dest,
 340                                                   int                insert_at);
 341 DBUS_PRIVATE_EXPORT
 342 dbus_bool_t   _dbus_string_hex_decode            (const DBusString  *source,
 343                                                   int                start,
 344                                                   int               *end_return,
 345                                                   DBusString        *dest,
 346                                                   int                insert_at);
 347 DBUS_PRIVATE_EXPORT
 348 void          _dbus_string_tolower_ascii         (const DBusString  *str,
 349                                                   int                start,
 350                                                   int                len);
 351 DBUS_PRIVATE_EXPORT
 352 void          _dbus_string_toupper_ascii         (const DBusString  *str,
 353                                                   int                start,
 354                                                   int                len);
 355 dbus_bool_t   _dbus_string_validate_ascii        (const DBusString  *str,
 356                                                   int                start,
 357                                                   int                len);
 358 DBUS_PRIVATE_EXPORT
 359 dbus_bool_t   _dbus_string_validate_utf8         (const DBusString  *str,
 360                                                   int                start,
 361                                                   int                len);
 362 DBUS_PRIVATE_EXPORT
 363 dbus_bool_t   _dbus_string_validate_nul          (const DBusString  *str,
 364                                                   int                start,
 365                                                   int                len);
 366 void          _dbus_string_zero                  (DBusString        *str);
 367
 368 static inline unsigned char *
 369 _dbus_string_get_udata (DBusString *str)
 370 {
 371   return (unsigned char *) _dbus_string_get_data (str);
 372 }
 373
 374 static inline unsigned char *
 375 _dbus_string_get_udata_len (DBusString *str, int start, int len)
 376 {
 377   return (unsigned char *) _dbus_string_get_data_len (str, start, len);
 378 }
 379
 380 static inline const unsigned char *
 381 _dbus_string_get_const_udata (const DBusString *str)
 382 {
 383   return (const unsigned char *) _dbus_string_get_const_data (str);
 384 }
 385
 386 static inline const unsigned char *
 387 _dbus_string_get_const_udata_len (const DBusString *str, int start, int len)
 388 {
 389   return (const unsigned char *) _dbus_string_get_const_data_len (str, start, len);
 390 }
 391
 392 /**
 393  * We allocate 1 byte for nul termination, plus 7 bytes for possible
 394  * align_offset, so we always need 8 bytes on top of the string's
 395  * length to be in the allocated block.
 396  */
 397 #define _DBUS_STRING_ALLOCATION_PADDING 8
 398
 399 /**
 400  * Defines a static const variable with type #DBusString called "name"
 401  * containing the given string literal.
 402  *
 403  * @param name the name of the variable
 404  * @param str the string value
 405  */
 406 #define _DBUS_STRING_DEFINE_STATIC(name, str)                           \
 407   static const char _dbus_static_string_##name[] = str;                 \
 408   static const DBusString name = { _dbus_static_string_##name,          \
 409                                    sizeof(_dbus_static_string_##name),  \
 410                                    sizeof(_dbus_static_string_##name) + \
 411                                    _DBUS_STRING_ALLOCATION_PADDING,     \
 412                                    TRUE, TRUE, FALSE, 0 }
 413
 414 DBUS_END_DECLS
 415
 416 #endif /* DBUS_STRING_H */