dbus/dbus-string.h

   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
  35 DBUS_BEGIN_DECLS
  36
  37 /**
  38  * DBusString object
  39  */
  40 struct DBusString
  41 {
  42   const 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
  62 dbus_bool_t   _dbus_string_init                  (DBusString        *str);
  63 void          _dbus_string_init_const            (DBusString        *str,
  64                                                   const char        *value);
  65 void          _dbus_string_init_const_len        (DBusString        *str,
  66                                                   const char        *value,
  67                                                   int                len);
  68 dbus_bool_t   _dbus_string_init_preallocated     (DBusString        *str,
  69                                                   int                allocate_size);
  70 void          _dbus_string_free                  (DBusString        *str);
  71 void          _dbus_string_lock                  (DBusString        *str);
  72 char*         _dbus_string_get_data              (DBusString        *str);
  73 #ifndef _dbus_string_get_const_data
  74 const char*   _dbus_string_get_const_data        (const DBusString  *str);
  75 #endif /* _dbus_string_get_const_data */
  76 char*         _dbus_string_get_data_len          (DBusString        *str,
  77                                                   int                start,
  78                                                   int                len);
  79 const char*   _dbus_string_get_const_data_len    (const DBusString  *str,
  80                                                   int                start,
  81                                                   int                len);
  82 void          _dbus_string_set_byte              (DBusString        *str,
  83                                                   int                i,
  84                                                   unsigned char      byte);
  85 #ifndef _dbus_string_get_byte
  86 unsigned char _dbus_string_get_byte              (const DBusString  *str,
  87                                                   int                start);
  88 #endif /* _dbus_string_get_byte */
  89 dbus_bool_t   _dbus_string_insert_bytes          (DBusString        *str,
  90                                                   int                i,
  91                                                   int                n_bytes,
  92                                                   unsigned char      byte);
  93 dbus_bool_t   _dbus_string_insert_byte           (DBusString        *str,
  94                                                   int                i,
  95                                                   unsigned char      byte);
  96 dbus_bool_t   _dbus_string_steal_data            (DBusString        *str,
  97                                                   char             **data_return);
  98 dbus_bool_t   _dbus_string_steal_data_len        (DBusString        *str,
  99                                                   char             **data_return,
 100                                                   int                start,
 101                                                   int                len);
 102 dbus_bool_t   _dbus_string_copy_data             (const DBusString  *str,
 103                                                   char             **data_return);
 104 dbus_bool_t   _dbus_string_copy_data_len         (const DBusString  *str,
 105                                                   char             **data_return,
 106                                                   int                start,
 107                                                   int                len);
 108 void          _dbus_string_copy_to_buffer        (const DBusString  *str,
 109                                                   char              *buffer,
 110                                                   int                len);
 111 #ifndef _dbus_string_get_length
 112 int           _dbus_string_get_length            (const DBusString  *str);
 113 #endif /* !_dbus_string_get_length */
 114
 115 dbus_bool_t   _dbus_string_lengthen              (DBusString        *str,
 116                                                   int                additional_length);
 117 void          _dbus_string_shorten               (DBusString        *str,
 118                                                   int                length_to_remove);
 119 dbus_bool_t   _dbus_string_set_length            (DBusString        *str,
 120                                                   int                length);
 121 dbus_bool_t   _dbus_string_align_length          (DBusString        *str,
 122                                                   int                alignment);
 123 dbus_bool_t   _dbus_string_alloc_space           (DBusString        *str,
 124                                                   int                extra_bytes);
 125 dbus_bool_t   _dbus_string_append                (DBusString        *str,
 126                                                   const char        *buffer);
 127 dbus_bool_t   _dbus_string_append_len            (DBusString        *str,
 128                                                   const char        *buffer,
 129                                                   int                len);
 130 dbus_bool_t   _dbus_string_append_int            (DBusString        *str,
 131                                                   long               value);
 132 dbus_bool_t   _dbus_string_append_uint           (DBusString        *str,
 133                                                   unsigned long      value);
 134 dbus_bool_t   _dbus_string_append_double         (DBusString        *str,
 135                                                   double             value);
 136 dbus_bool_t   _dbus_string_append_byte           (DBusString        *str,
 137                                                   unsigned char      byte);
 138 dbus_bool_t   _dbus_string_append_unichar        (DBusString        *str,
 139                                                   dbus_unichar_t     ch);
 140 dbus_bool_t   _dbus_string_append_4_aligned      (DBusString        *str,
 141                                                   const unsigned char octets[4]);
 142 dbus_bool_t   _dbus_string_append_8_aligned      (DBusString        *str,
 143                                                   const unsigned char octets[8]);
 144 dbus_bool_t   _dbus_string_append_printf         (DBusString        *str,
 145                                                   const char        *format,
 146                                                   ...) _DBUS_GNUC_PRINTF (2, 3);
 147 dbus_bool_t   _dbus_string_append_printf_valist  (DBusString        *str,
 148                                                   const char        *format,
 149                                                   va_list            args);
 150 dbus_bool_t   _dbus_string_insert_4_aligned      (DBusString        *str,
 151                                                   int                insert_at,
 152                                                   const unsigned char octets[4]);
 153 dbus_bool_t   _dbus_string_insert_8_aligned      (DBusString        *str,
 154                                                   int                insert_at,
 155                                                   const unsigned char octets[8]);
 156 dbus_bool_t   _dbus_string_insert_alignment      (DBusString        *str,
 157                                                   int               *insert_at,
 158                                                   int                alignment);
 159 void          _dbus_string_delete                (DBusString        *str,
 160                                                   int                start,
 161                                                   int                len);
 162 dbus_bool_t   _dbus_string_move                  (DBusString        *source,
 163                                                   int                start,
 164                                                   DBusString        *dest,
 165                                                   int                insert_at);
 166 dbus_bool_t   _dbus_string_copy                  (const DBusString  *source,
 167                                                   int                start,
 168                                                   DBusString        *dest,
 169                                                   int                insert_at);
 170 dbus_bool_t   _dbus_string_move_len              (DBusString        *source,
 171                                                   int                start,
 172                                                   int                len,
 173                                                   DBusString        *dest,
 174                                                   int                insert_at);
 175 dbus_bool_t   _dbus_string_copy_len              (const DBusString  *source,
 176                                                   int                start,
 177                                                   int                len,
 178                                                   DBusString        *dest,
 179                                                   int                insert_at);
 180 dbus_bool_t   _dbus_string_replace_len           (const DBusString  *source,
 181                                                   int                start,
 182                                                   int                len,
 183                                                   DBusString        *dest,
 184                                                   int                replace_at,
 185                                                   int                replace_len);
 186 void          _dbus_string_get_unichar           (const DBusString  *str,
 187                                                   int                start,
 188                                                   dbus_unichar_t    *ch_return,
 189                                                   int               *end_return);
 190 dbus_bool_t   _dbus_string_parse_int             (const DBusString  *str,
 191                                                   int                start,
 192                                                   long              *value_return,
 193                                                   int               *end_return);
 194 dbus_bool_t   _dbus_string_parse_uint            (const DBusString  *str,
 195                                                   int                start,
 196                                                   unsigned long     *value_return,
 197                                                   int               *end_return);
 198 dbus_bool_t   _dbus_string_parse_double          (const DBusString  *str,
 199                                                   int                start,
 200                                                   double            *value,
 201                                                   int               *end_return);
 202 dbus_bool_t   _dbus_string_parse_basic_type      (const DBusString  *str,
 203                                                   char               type,
 204                                                   int                start,
 205                                                   void              *value,
 206                                                   int               *end_return);
 207 dbus_bool_t   _dbus_string_find                  (const DBusString  *str,
 208                                                   int                start,
 209                                                   const char        *substr,
 210                                                   int               *found);
 211 dbus_bool_t   _dbus_string_find_to               (const DBusString  *str,
 212                                                   int                start,
 213                                                   int                end,
 214                                                   const char        *substr,
 215                                                   int               *found);
 216 dbus_bool_t   _dbus_string_find_byte_backward    (const DBusString  *str,
 217                                                   int                start,
 218                                                   unsigned char      byte,
 219                                                   int               *found);
 220 dbus_bool_t   _dbus_string_find_blank            (const DBusString  *str,
 221                                                   int                start,
 222                                                   int               *found);
 223 void          _dbus_string_skip_blank            (const DBusString  *str,
 224                                                   int                start,
 225                                                   int               *end);
 226 void          _dbus_string_skip_white            (const DBusString  *str,
 227                                                   int                start,
 228                                                   int               *end);
 229 dbus_bool_t   _dbus_string_equal                 (const DBusString  *a,
 230                                                   const DBusString  *b);
 231 dbus_bool_t   _dbus_string_equal_c_str           (const DBusString  *a,
 232                                                   const char        *c_str);
 233 dbus_bool_t   _dbus_string_equal_len             (const DBusString  *a,
 234                                                   const DBusString  *b,
 235                                                   int                len);
 236 dbus_bool_t   _dbus_string_equal_substring       (const DBusString  *a,
 237                                                   int                a_start,
 238                                                   int                a_len,
 239                                                   const DBusString  *b,
 240                                                   int                b_start);
 241 dbus_bool_t   _dbus_string_starts_with_c_str     (const DBusString  *a,
 242                                                   const char        *c_str);
 243 dbus_bool_t   _dbus_string_ends_with_c_str       (const DBusString  *a,
 244                                                   const char        *c_str);
 245 dbus_bool_t   _dbus_string_pop_line              (DBusString        *source,
 246                                                   DBusString        *dest);
 247 void          _dbus_string_delete_first_word     (DBusString        *str);
 248 void          _dbus_string_delete_leading_blanks (DBusString        *str);
 249 dbus_bool_t   _dbus_string_hex_encode            (const DBusString  *source,
 250                                                   int                start,
 251                                                   DBusString        *dest,
 252                                                   int                insert_at);
 253 dbus_bool_t   _dbus_string_hex_decode            (const DBusString  *source,
 254                                                   int                start,
 255                                                   int               *end_return,
 256                                                   DBusString        *dest,
 257                                                   int                insert_at);
 258 dbus_bool_t   _dbus_string_validate_ascii        (const DBusString  *str,
 259                                                   int                start,
 260                                                   int                len);
 261 dbus_bool_t   _dbus_string_validate_utf8         (const DBusString  *str,
 262                                                   int                start,
 263                                                   int                len);
 264 dbus_bool_t   _dbus_string_validate_nul          (const DBusString  *str,
 265                                                   int                start,
 266                                                   int                len);
 267 void          _dbus_string_zero                  (DBusString        *str);
 268
 269
 270 /**
 271  * We allocate 1 byte for nul termination, plus 7 bytes for possible
 272  * align_offset, so we always need 8 bytes on top of the string's
 273  * length to be in the allocated block.
 274  */
 275 #define _DBUS_STRING_ALLOCATION_PADDING 8
 276
 277 /**
 278  * Defines a static const variable with type #DBusString called "name"
 279  * containing the given string literal.
 280  *
 281  * @param name the name of the variable
 282  * @param str the string value
 283  */
 284 #define _DBUS_STRING_DEFINE_STATIC(name, str)                           \
 285   static const char _dbus_static_string_##name[] = str;                 \
 286   static const DBusString name = { _dbus_static_string_##name,          \
 287                                    sizeof(_dbus_static_string_##name),  \
 288                                    sizeof(_dbus_static_string_##name) + \
 289                                    _DBUS_STRING_ALLOCATION_PADDING,     \
 290                                    sizeof(_dbus_static_string_##name),  \
 291                                    TRUE, TRUE, FALSE, 0 }
 292
 293 DBUS_END_DECLS
 294
 295 #endif /* DBUS_STRING_H */