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  Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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
  32 DBUS_BEGIN_DECLS;
  33
  34 typedef struct DBusString DBusString;
  35
  36 struct DBusString
  37 {
  38   void *dummy1; /**< placeholder */
  39   int   dummy2; /**< placeholder */
  40   int   dummy3; /**< placeholder */
  41   int   dummy4; /**< placeholder */
  42   unsigned int dummy5 : 1; /**< placeholder */
  43   unsigned int dummy6 : 1; /**< placeholder */
  44   unsigned int dummy7 : 1; /**< placeholder */
  45   unsigned int dummy8 : 3; /**< placeholder */
  46 };
  47
  48 dbus_bool_t   _dbus_string_init                  (DBusString        *str);
  49 void          _dbus_string_init_const            (DBusString        *str,
  50                                                   const char        *value);
  51 void          _dbus_string_init_const_len        (DBusString        *str,
  52                                                   const char        *value,
  53                                                   int                len);
  54 dbus_bool_t   _dbus_string_init_preallocated     (DBusString        *str,
  55                                                   int                allocate_size);
  56 void          _dbus_string_free                  (DBusString        *str);
  57 void          _dbus_string_lock                  (DBusString        *str);
  58 char*         _dbus_string_get_data              (DBusString        *str);
  59 const char*   _dbus_string_get_const_data        (const DBusString  *str);
  60 char*         _dbus_string_get_data_len          (DBusString        *str,
  61                                                   int                start,
  62                                                   int                len);
  63 const char*   _dbus_string_get_const_data_len    (const DBusString  *str,
  64                                                   int                start,
  65                                                   int                len);
  66 void          _dbus_string_set_byte              (DBusString        *str,
  67                                                   int                i,
  68                                                   unsigned char      byte);
  69 unsigned char _dbus_string_get_byte              (const DBusString  *str,
  70                                                   int                start);
  71 dbus_bool_t   _dbus_string_insert_byte           (DBusString        *str,
  72                                                   int                i,
  73                                                   unsigned char      byte);
  74 dbus_bool_t   _dbus_string_steal_data            (DBusString        *str,
  75                                                   char             **data_return);
  76 dbus_bool_t   _dbus_string_steal_data_len        (DBusString        *str,
  77                                                   char             **data_return,
  78                                                   int                start,
  79                                                   int                len);
  80 dbus_bool_t   _dbus_string_copy_data             (const DBusString  *str,
  81                                                   char             **data_return);
  82 dbus_bool_t   _dbus_string_copy_data_len         (const DBusString  *str,
  83                                                   char             **data_return,
  84                                                   int                start,
  85                                                   int                len);
  86 int           _dbus_string_get_length            (const DBusString  *str);
  87 dbus_bool_t   _dbus_string_lengthen              (DBusString        *str,
  88                                                   int                additional_length);
  89 void          _dbus_string_shorten               (DBusString        *str,
  90                                                   int                length_to_remove);
  91 dbus_bool_t   _dbus_string_set_length            (DBusString        *str,
  92                                                   int                length);
  93 dbus_bool_t   _dbus_string_align_length          (DBusString        *str,
  94                                                   int                alignment);
  95 dbus_bool_t   _dbus_string_append                (DBusString        *str,
  96                                                   const char        *buffer);
  97 dbus_bool_t   _dbus_string_append_len            (DBusString        *str,
  98                                                   const char        *buffer,
  99                                                   int                len);
 100 dbus_bool_t   _dbus_string_append_int            (DBusString        *str,
 101                                                   long               value);
 102 dbus_bool_t   _dbus_string_append_uint           (DBusString        *str,
 103                                                   unsigned long      value);
 104 dbus_bool_t   _dbus_string_append_double         (DBusString        *str,
 105                                                   double             value);
 106 dbus_bool_t   _dbus_string_append_byte           (DBusString        *str,
 107                                                   unsigned char      byte);
 108 dbus_bool_t   _dbus_string_append_unichar        (DBusString        *str,
 109                                                   dbus_unichar_t     ch);
 110 dbus_bool_t   _dbus_string_append_4_aligned      (DBusString        *str,
 111                                                   const unsigned char octets[4]);
 112 dbus_bool_t   _dbus_string_append_8_aligned      (DBusString        *str,
 113                                                   const unsigned char octets[8]);
 114 void          _dbus_string_delete                (DBusString        *str,
 115                                                   int                start,
 116                                                   int                len);
 117 dbus_bool_t   _dbus_string_move                  (DBusString        *source,
 118                                                   int                start,
 119                                                   DBusString        *dest,
 120                                                   int                insert_at);
 121 dbus_bool_t   _dbus_string_copy                  (const DBusString  *source,
 122                                                   int                start,
 123                                                   DBusString        *dest,
 124                                                   int                insert_at);
 125 dbus_bool_t   _dbus_string_move_len              (DBusString        *source,
 126                                                   int                start,
 127                                                   int                len,
 128                                                   DBusString        *dest,
 129                                                   int                insert_at);
 130 dbus_bool_t   _dbus_string_copy_len              (const DBusString  *source,
 131                                                   int                start,
 132                                                   int                len,
 133                                                   DBusString        *dest,
 134                                                   int                insert_at);
 135 dbus_bool_t   _dbus_string_replace_len           (const DBusString  *source,
 136                                                   int                start,
 137                                                   int                len,
 138                                                   DBusString        *dest,
 139                                                   int                replace_at,
 140                                                   int                replace_len);
 141 void          _dbus_string_get_unichar           (const DBusString  *str,
 142                                                   int                start,
 143                                                   dbus_unichar_t    *ch_return,
 144                                                   int               *end_return);
 145 dbus_bool_t   _dbus_string_parse_int             (const DBusString  *str,
 146                                                   int                start,
 147                                                   long              *value_return,
 148                                                   int               *end_return);
 149 dbus_bool_t   _dbus_string_parse_uint            (const DBusString  *str,
 150                                                   int                start,
 151                                                   unsigned long     *value_return,
 152                                                   int               *end_return);
 153 dbus_bool_t   _dbus_string_parse_double          (const DBusString  *str,
 154                                                   int                start,
 155                                                   double            *value,
 156                                                   int               *end_return);
 157 dbus_bool_t   _dbus_string_find                  (const DBusString  *str,
 158                                                   int                start,
 159                                                   const char        *substr,
 160                                                   int               *found);
 161 dbus_bool_t   _dbus_string_find_to               (const DBusString  *str,
 162                                                   int                start,
 163                                                   int                end,
 164                                                   const char        *substr,
 165                                                   int               *found);
 166 dbus_bool_t   _dbus_string_find_byte_backward    (const DBusString  *str,
 167                                                   int                start,
 168                                                   unsigned char      byte,
 169                                                   int               *found);
 170 dbus_bool_t   _dbus_string_find_blank            (const DBusString  *str,
 171                                                   int                start,
 172                                                   int               *found);
 173 void          _dbus_string_skip_blank            (const DBusString  *str,
 174                                                   int                start,
 175                                                   int               *end);
 176 void          _dbus_string_skip_white            (const DBusString  *str,
 177                                                   int                start,
 178                                                   int               *end);
 179 dbus_bool_t   _dbus_string_equal                 (const DBusString  *a,
 180                                                   const DBusString  *b);
 181 dbus_bool_t   _dbus_string_equal_c_str           (const DBusString  *a,
 182                                                   const char        *c_str);
 183 dbus_bool_t   _dbus_string_equal_len             (const DBusString  *a,
 184                                                   const DBusString  *b,
 185                                                   int                len);
 186 dbus_bool_t   _dbus_string_starts_with_c_str     (const DBusString  *a,
 187                                                   const char        *c_str);
 188 dbus_bool_t   _dbus_string_ends_with_c_str       (const DBusString  *a,
 189                                                   const char        *c_str);
 190 dbus_bool_t   _dbus_string_pop_line              (DBusString        *source,
 191                                                   DBusString        *dest);
 192 void          _dbus_string_delete_first_word     (DBusString        *str);
 193 void          _dbus_string_delete_leading_blanks (DBusString        *str);
 194 dbus_bool_t   _dbus_string_base64_encode         (const DBusString  *source,
 195                                                   int                start,
 196                                                   DBusString        *dest,
 197                                                   int                insert_at);
 198 dbus_bool_t   _dbus_string_base64_decode         (const DBusString  *source,
 199                                                   int                start,
 200                                                   DBusString        *dest,
 201                                                   int                insert_at);
 202 dbus_bool_t   _dbus_string_hex_encode            (const DBusString  *source,
 203                                                   int                start,
 204                                                   DBusString        *dest,
 205                                                   int                insert_at);
 206 dbus_bool_t   _dbus_string_hex_decode            (const DBusString  *source,
 207                                                   int                start,
 208                                                   DBusString        *dest,
 209                                                   int                insert_at);
 210 dbus_bool_t   _dbus_string_validate_ascii        (const DBusString  *str,
 211                                                   int                start,
 212                                                   int                len);
 213 dbus_bool_t   _dbus_string_validate_utf8         (const DBusString  *str,
 214                                                   int                start,
 215                                                   int                len);
 216 dbus_bool_t   _dbus_string_validate_nul          (const DBusString  *str,
 217                                                   int                start,
 218                                                   int                len);
 219 dbus_bool_t   _dbus_string_validate_name         (const DBusString  *str,
 220                                                   int                start,
 221                                                   int                len);
 222 dbus_bool_t   _dbus_string_validate_service      (const DBusString  *str,
 223                                                   int                start,
 224                                                   int                len);
 225 void          _dbus_string_zero                  (DBusString        *str);
 226
 227
 228 DBUS_END_DECLS;
 229
 230 #endif /* DBUS_STRING_H */