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   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 /* Unless we want to run all the assertions in the function,
  53  * inline this thing, it shows up high in the profile
  54  */
  55 #ifdef DBUS_DISABLE_ASSERT
  56 #define _dbus_string_get_length(s) ((s)->dummy2)
  57 #endif
  58
  59 dbus_bool_t   _dbus_string_init                  (DBusString        *str);
  60 void          _dbus_string_init_const            (DBusString        *str,
  61                                                   const char        *value);
  62 void          _dbus_string_init_const_len        (DBusString        *str,
  63                                                   const char        *value,
  64                                                   int                len);
  65 dbus_bool_t   _dbus_string_init_preallocated     (DBusString        *str,
  66                                                   int                allocate_size);
  67 void          _dbus_string_free                  (DBusString        *str);
  68 void          _dbus_string_lock                  (DBusString        *str);
  69 char*         _dbus_string_get_data              (DBusString        *str);
  70 const char*   _dbus_string_get_const_data        (const DBusString  *str);
  71 char*         _dbus_string_get_data_len          (DBusString        *str,
  72                                                   int                start,
  73                                                   int                len);
  74 const char*   _dbus_string_get_const_data_len    (const DBusString  *str,
  75                                                   int                start,
  76                                                   int                len);
  77 void          _dbus_string_set_byte              (DBusString        *str,
  78                                                   int                i,
  79                                                   unsigned char      byte);
  80 unsigned char _dbus_string_get_byte              (const DBusString  *str,
  81                                                   int                start);
  82 dbus_bool_t   _dbus_string_insert_bytes          (DBusString        *str,
  83                                                   int                i,
  84                                                   int                n_bytes,
  85                                                   unsigned char      byte);
  86 dbus_bool_t   _dbus_string_steal_data            (DBusString        *str,
  87                                                   char             **data_return);
  88 dbus_bool_t   _dbus_string_steal_data_len        (DBusString        *str,
  89                                                   char             **data_return,
  90                                                   int                start,
  91                                                   int                len);
  92 dbus_bool_t   _dbus_string_copy_data             (const DBusString  *str,
  93                                                   char             **data_return);
  94 dbus_bool_t   _dbus_string_copy_data_len         (const DBusString  *str,
  95                                                   char             **data_return,
  96                                                   int                start,
  97                                                   int                len);
  98 void          _dbus_string_copy_to_buffer        (const DBusString  *str,
  99                                                   char              *buffer,
 100                                                   int                len);
 101 #ifndef _dbus_string_get_length
 102 int           _dbus_string_get_length            (const DBusString  *str);
 103 #endif /* !_dbus_string_get_length */
 104
 105 dbus_bool_t   _dbus_string_lengthen              (DBusString        *str,
 106                                                   int                additional_length);
 107 void          _dbus_string_shorten               (DBusString        *str,
 108                                                   int                length_to_remove);
 109 dbus_bool_t   _dbus_string_set_length            (DBusString        *str,
 110                                                   int                length);
 111 dbus_bool_t   _dbus_string_align_length          (DBusString        *str,
 112                                                   int                alignment);
 113 dbus_bool_t   _dbus_string_append                (DBusString        *str,
 114                                                   const char        *buffer);
 115 dbus_bool_t   _dbus_string_append_len            (DBusString        *str,
 116                                                   const char        *buffer,
 117                                                   int                len);
 118 dbus_bool_t   _dbus_string_append_int            (DBusString        *str,
 119                                                   long               value);
 120 dbus_bool_t   _dbus_string_append_uint           (DBusString        *str,
 121                                                   unsigned long      value);
 122 dbus_bool_t   _dbus_string_append_double         (DBusString        *str,
 123                                                   double             value);
 124 dbus_bool_t   _dbus_string_append_byte           (DBusString        *str,
 125                                                   unsigned char      byte);
 126 dbus_bool_t   _dbus_string_append_unichar        (DBusString        *str,
 127                                                   dbus_unichar_t     ch);
 128 dbus_bool_t   _dbus_string_append_4_aligned      (DBusString        *str,
 129                                                   const unsigned char octets[4]);
 130 dbus_bool_t   _dbus_string_append_8_aligned      (DBusString        *str,
 131                                                   const unsigned char octets[8]);
 132 dbus_bool_t   _dbus_string_append_printf         (DBusString        *str,
 133                                                   const char        *format,
 134                                                   ...) _DBUS_GNUC_PRINTF (2, 3);
 135 dbus_bool_t   _dbus_string_append_printf_valist  (DBusString        *str,
 136                                                   const char        *format,
 137                                                   va_list            args);
 138 void          _dbus_string_delete                (DBusString        *str,
 139                                                   int                start,
 140                                                   int                len);
 141 dbus_bool_t   _dbus_string_move                  (DBusString        *source,
 142                                                   int                start,
 143                                                   DBusString        *dest,
 144                                                   int                insert_at);
 145 dbus_bool_t   _dbus_string_copy                  (const DBusString  *source,
 146                                                   int                start,
 147                                                   DBusString        *dest,
 148                                                   int                insert_at);
 149 dbus_bool_t   _dbus_string_move_len              (DBusString        *source,
 150                                                   int                start,
 151                                                   int                len,
 152                                                   DBusString        *dest,
 153                                                   int                insert_at);
 154 dbus_bool_t   _dbus_string_copy_len              (const DBusString  *source,
 155                                                   int                start,
 156                                                   int                len,
 157                                                   DBusString        *dest,
 158                                                   int                insert_at);
 159 dbus_bool_t   _dbus_string_replace_len           (const DBusString  *source,
 160                                                   int                start,
 161                                                   int                len,
 162                                                   DBusString        *dest,
 163                                                   int                replace_at,
 164                                                   int                replace_len);
 165 void          _dbus_string_get_unichar           (const DBusString  *str,
 166                                                   int                start,
 167                                                   dbus_unichar_t    *ch_return,
 168                                                   int               *end_return);
 169 dbus_bool_t   _dbus_string_parse_int             (const DBusString  *str,
 170                                                   int                start,
 171                                                   long              *value_return,
 172                                                   int               *end_return);
 173 dbus_bool_t   _dbus_string_parse_uint            (const DBusString  *str,
 174                                                   int                start,
 175                                                   unsigned long     *value_return,
 176                                                   int               *end_return);
 177 dbus_bool_t   _dbus_string_parse_double          (const DBusString  *str,
 178                                                   int                start,
 179                                                   double            *value,
 180                                                   int               *end_return);
 181 dbus_bool_t   _dbus_string_parse_basic_type      (const DBusString  *str,
 182                                                   char               type,
 183                                                   int                start,
 184                                                   void              *value,
 185                                                   int               *end_return);
 186 dbus_bool_t   _dbus_string_find                  (const DBusString  *str,
 187                                                   int                start,
 188                                                   const char        *substr,
 189                                                   int               *found);
 190 dbus_bool_t   _dbus_string_find_to               (const DBusString  *str,
 191                                                   int                start,
 192                                                   int                end,
 193                                                   const char        *substr,
 194                                                   int               *found);
 195 dbus_bool_t   _dbus_string_find_byte_backward    (const DBusString  *str,
 196                                                   int                start,
 197                                                   unsigned char      byte,
 198                                                   int               *found);
 199 dbus_bool_t   _dbus_string_find_blank            (const DBusString  *str,
 200                                                   int                start,
 201                                                   int               *found);
 202 void          _dbus_string_skip_blank            (const DBusString  *str,
 203                                                   int                start,
 204                                                   int               *end);
 205 void          _dbus_string_skip_white            (const DBusString  *str,
 206                                                   int                start,
 207                                                   int               *end);
 208 dbus_bool_t   _dbus_string_equal                 (const DBusString  *a,
 209                                                   const DBusString  *b);
 210 dbus_bool_t   _dbus_string_equal_c_str           (const DBusString  *a,
 211                                                   const char        *c_str);
 212 dbus_bool_t   _dbus_string_equal_len             (const DBusString  *a,
 213                                                   const DBusString  *b,
 214                                                   int                len);
 215 dbus_bool_t   _dbus_string_starts_with_c_str     (const DBusString  *a,
 216                                                   const char        *c_str);
 217 dbus_bool_t   _dbus_string_ends_with_c_str       (const DBusString  *a,
 218                                                   const char        *c_str);
 219 dbus_bool_t   _dbus_string_pop_line              (DBusString        *source,
 220                                                   DBusString        *dest);
 221 void          _dbus_string_delete_first_word     (DBusString        *str);
 222 void          _dbus_string_delete_leading_blanks (DBusString        *str);
 223 dbus_bool_t   _dbus_string_hex_encode            (const DBusString  *source,
 224                                                   int                start,
 225                                                   DBusString        *dest,
 226                                                   int                insert_at);
 227 dbus_bool_t   _dbus_string_hex_decode            (const DBusString  *source,
 228                                                   int                start,
 229                                                   int               *end_return,
 230                                                   DBusString        *dest,
 231                                                   int                insert_at);
 232 dbus_bool_t   _dbus_string_validate_ascii        (const DBusString  *str,
 233                                                   int                start,
 234                                                   int                len);
 235 dbus_bool_t   _dbus_string_validate_utf8         (const DBusString  *str,
 236                                                   int                start,
 237                                                   int                len);
 238 dbus_bool_t   _dbus_string_validate_nul          (const DBusString  *str,
 239                                                   int                start,
 240                                                   int                len);
 241 dbus_bool_t   _dbus_string_validate_path         (const DBusString  *str,
 242                                                   int                start,
 243                                                   int                len);
 244 dbus_bool_t   _dbus_string_validate_interface    (const DBusString  *str,
 245                                                   int                start,
 246                                                   int                len);
 247 dbus_bool_t   _dbus_string_validate_member       (const DBusString  *str,
 248                                                   int                start,
 249                                                   int                len);
 250 dbus_bool_t   _dbus_string_validate_error_name   (const DBusString  *str,
 251                                                   int                start,
 252                                                   int                len);
 253 dbus_bool_t   _dbus_string_validate_service      (const DBusString  *str,
 254                                                   int                start,
 255                                                   int                len);
 256 void          _dbus_string_zero                  (DBusString        *str);
 257
 258
 259 DBUS_END_DECLS
 260
 261 #endif /* DBUS_STRING_H */