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                                          int         max_length);
  50 void        _dbus_string_init_const     (DBusString *str,
  51                                          const char *value);
  52 void        _dbus_string_init_const_len (DBusString *str,
  53                                          const char *value,
  54                                          int         len);
  55 void        _dbus_string_free           (DBusString *str);
  56 void        _dbus_string_lock           (DBusString *str);
  57
  58 void        _dbus_string_get_data           (DBusString        *str,
  59                                              char             **data_return);
  60 void        _dbus_string_get_const_data     (const DBusString  *str,
  61                                              const char       **data_return);
  62 void        _dbus_string_get_data_len       (DBusString        *str,
  63                                              char             **data_return,
  64                                              int                start,
  65                                              int                len);
  66 void        _dbus_string_get_const_data_len (const DBusString  *str,
  67                                              const char       **data_return,
  68                                              int                start,
  69                                              int                len);
  70 void        _dbus_string_set_byte           (DBusString        *str,
  71                                              int                i,
  72                                              unsigned char      byte);
  73 unsigned char _dbus_string_get_byte         (const DBusString  *str,
  74                                              int                start);
  75 dbus_bool_t _dbus_string_insert_byte        (DBusString        *str,
  76                                              int                i,
  77                                              unsigned char      byte);
  78 dbus_bool_t _dbus_string_steal_data         (DBusString        *str,
  79                                              char             **data_return);
  80 dbus_bool_t _dbus_string_steal_data_len     (DBusString        *str,
  81                                              char             **data_return,
  82                                              int                start,
  83                                              int                len);
  84
  85 int  _dbus_string_get_length         (const DBusString  *str);
  86
  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
  96 dbus_bool_t _dbus_string_append         (DBusString    *str,
  97                                          const char    *buffer);
  98 dbus_bool_t _dbus_string_append_len     (DBusString    *str,
  99                                          const char    *buffer,
 100                                          int            len);
 101 dbus_bool_t _dbus_string_append_int     (DBusString    *str,
 102                                          long           value);
 103 dbus_bool_t _dbus_string_append_uint    (DBusString    *str,
 104                                          unsigned long  value);
 105 dbus_bool_t _dbus_string_append_double  (DBusString    *str,
 106                                          double         value);
 107 dbus_bool_t _dbus_string_append_byte    (DBusString    *str,
 108                                          unsigned char  byte);
 109 dbus_bool_t _dbus_string_append_unichar (DBusString    *str,
 110                                          dbus_unichar_t ch);
 111
 112
 113 void        _dbus_string_delete     (DBusString       *str,
 114                                      int               start,
 115                                      int               len);
 116 dbus_bool_t _dbus_string_move       (DBusString       *source,
 117                                      int               start,
 118                                      DBusString       *dest,
 119                                      int               insert_at);
 120 dbus_bool_t _dbus_string_copy       (const DBusString *source,
 121                                      int               start,
 122                                      DBusString       *dest,
 123                                      int               insert_at);
 124 dbus_bool_t _dbus_string_move_len   (DBusString       *source,
 125                                      int               start,
 126                                      int               len,
 127                                      DBusString       *dest,
 128                                      int               insert_at);
 129 dbus_bool_t _dbus_string_copy_len   (const DBusString *source,
 130                                      int               start,
 131                                      int               len,
 132                                      DBusString       *dest,
 133                                      int               insert_at);
 134
 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
 142 void       _dbus_string_get_unichar (const DBusString *str,
 143                                      int               start,
 144                                      dbus_unichar_t   *ch_return,
 145                                      int              *end_return);
 146
 147 dbus_bool_t _dbus_string_parse_int    (const DBusString *str,
 148                                        int               start,
 149                                        long             *value_return,
 150                                        int              *end_return);
 151 dbus_bool_t _dbus_string_parse_uint   (const DBusString *str,
 152                                        int               start,
 153                                        unsigned long    *value_return,
 154                                        int              *end_return);
 155 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
 156                                        int               start,
 157                                        double           *value,
 158                                        int              *end_return);
 159
 160 dbus_bool_t _dbus_string_find         (const DBusString *str,
 161                                        int               start,
 162                                        const char       *substr,
 163                                        int              *found);
 164
 165 dbus_bool_t _dbus_string_find_to      (const DBusString *str,
 166                                        int               start,
 167                                        int               end,
 168                                        const char       *substr,
 169                                        int              *found);
 170 dbus_bool_t _dbus_string_find_blank   (const DBusString *str,
 171                                        int               start,
 172                                        int              *found);
 173
 174 void        _dbus_string_skip_blank   (const DBusString *str,
 175                                        int               start,
 176                                        int              *end);
 177
 178 dbus_bool_t _dbus_string_equal        (const DBusString *a,
 179                                        const DBusString *b);
 180
 181 dbus_bool_t _dbus_string_equal_c_str  (const DBusString *a,
 182                                        const char       *c_str);
 183
 184 dbus_bool_t _dbus_string_equal_len    (const DBusString *a,
 185                                        const DBusString *b,
 186                                        int               len);
 187
 188 dbus_bool_t _dbus_string_starts_with_c_str  (const DBusString *a,
 189                                              const char       *c_str);
 190 dbus_bool_t _dbus_string_ends_with_c_str    (const DBusString *a,
 191                                              const char       *c_str);
 192
 193 dbus_bool_t _dbus_string_pop_line              (DBusString *source,
 194                                                 DBusString *dest);
 195 void        _dbus_string_delete_first_word     (DBusString *str);
 196 void        _dbus_string_delete_leading_blanks (DBusString *str);
 197
 198
 199 dbus_bool_t _dbus_string_base64_encode (const DBusString *source,
 200                                         int               start,
 201                                         DBusString       *dest,
 202                                         int               insert_at);
 203 dbus_bool_t _dbus_string_base64_decode (const DBusString *source,
 204                                         int               start,
 205                                         DBusString       *dest,
 206                                         int               insert_at);
 207 dbus_bool_t _dbus_string_hex_encode    (const DBusString *source,
 208                                         int               start,
 209                                         DBusString       *dest,
 210                                         int               insert_at);
 211 dbus_bool_t _dbus_string_hex_decode    (const DBusString *source,
 212                                         int               start,
 213                                         DBusString       *dest,
 214                                         int               insert_at);
 215
 216 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
 217                                          int               start,
 218                                          int               len);
 219
 220 dbus_bool_t _dbus_string_validate_utf8  (const DBusString *str,
 221                                          int               start,
 222                                          int               len);
 223
 224 dbus_bool_t _dbus_string_validate_nul   (const DBusString *str,
 225                                          int               start,
 226                                          int               len);
 227
 228 void _dbus_string_zero (DBusString *str);
 229
 230 DBUS_END_DECLS;
 231
 232 #endif /* DBUS_STRING_H */