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 };
  46
  47 dbus_bool_t _dbus_string_init           (DBusString *str,
  48                                          int         max_length);
  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 void        _dbus_string_free           (DBusString *str);
  55 void        _dbus_string_lock           (DBusString *str);
  56
  57 void        _dbus_string_get_data           (DBusString        *str,
  58                                              char             **data_return);
  59 void        _dbus_string_get_const_data     (const DBusString  *str,
  60                                              const char       **data_return);
  61 void        _dbus_string_get_data_len       (DBusString        *str,
  62                                              char             **data_return,
  63                                              int                start,
  64                                              int                len);
  65 void        _dbus_string_get_const_data_len (const DBusString  *str,
  66                                              const char       **data_return,
  67                                              int                start,
  68                                              int                len);
  69 void        _dbus_string_set_byte           (DBusString        *str,
  70                                              int                i,
  71                                              unsigned char      byte);
  72 unsigned char _dbus_string_get_byte         (const DBusString  *str,
  73                                              int                start);
  74 dbus_bool_t _dbus_string_insert_byte        (DBusString        *str,
  75                                              int                i,
  76                                              unsigned char      byte);
  77 dbus_bool_t _dbus_string_steal_data         (DBusString        *str,
  78                                              char             **data_return);
  79 dbus_bool_t _dbus_string_steal_data_len     (DBusString        *str,
  80                                              char             **data_return,
  81                                              int                start,
  82                                              int                len);
  83
  84 int  _dbus_string_get_length         (const DBusString  *str);
  85
  86 dbus_bool_t _dbus_string_lengthen     (DBusString *str,
  87                                        int         additional_length);
  88 void        _dbus_string_shorten      (DBusString *str,
  89                                        int         length_to_remove);
  90 dbus_bool_t _dbus_string_set_length   (DBusString *str,
  91                                        int         length);
  92 dbus_bool_t _dbus_string_align_length (DBusString *str,
  93                                        int         alignment);
  94
  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
 111
 112 void        _dbus_string_delete     (DBusString       *str,
 113                                      int               start,
 114                                      int               len);
 115 dbus_bool_t _dbus_string_move       (DBusString       *source,
 116                                      int               start,
 117                                      DBusString       *dest,
 118                                      int               insert_at);
 119 dbus_bool_t _dbus_string_copy       (const DBusString *source,
 120                                      int               start,
 121                                      DBusString       *dest,
 122                                      int               insert_at);
 123 dbus_bool_t _dbus_string_move_len   (DBusString       *source,
 124                                      int               start,
 125                                      int               len,
 126                                      DBusString       *dest,
 127                                      int               insert_at);
 128 dbus_bool_t _dbus_string_copy_len   (const DBusString *source,
 129                                      int               start,
 130                                      int               len,
 131                                      DBusString       *dest,
 132                                      int               insert_at);
 133
 134 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
 135                                       int               start,
 136                                       int               len,
 137                                       DBusString       *dest,
 138                                       int               replace_at,
 139                                       int               replace_len);
 140
 141 void       _dbus_string_get_unichar (const DBusString *str,
 142                                      int               start,
 143                                      dbus_unichar_t   *ch_return,
 144                                      int              *end_return);
 145
 146 dbus_bool_t _dbus_string_parse_int    (const DBusString *str,
 147                                        int               start,
 148                                        long             *value_return,
 149                                        int              *end_return);
 150 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
 151                                        int               start,
 152                                        double           *value,
 153                                        int              *end_return);
 154
 155 dbus_bool_t _dbus_string_find         (const DBusString *str,
 156                                        int               start,
 157                                        const char       *substr,
 158                                        int              *found);
 159
 160 dbus_bool_t _dbus_string_find_to      (const DBusString *str,
 161                                        int               start,
 162                                        int               end,
 163                                        const char       *substr,
 164                                        int              *found);
 165 dbus_bool_t _dbus_string_find_blank   (const DBusString *str,
 166                                        int               start,
 167                                        int              *found);
 168
 169 void        _dbus_string_skip_blank   (const DBusString *str,
 170                                        int               start,
 171                                        int              *end);
 172
 173 dbus_bool_t _dbus_string_equal        (const DBusString *a,
 174                                        const DBusString *b);
 175
 176 dbus_bool_t _dbus_string_equal_c_str  (const DBusString *a,
 177                                        const char       *c_str);
 178
 179 dbus_bool_t _dbus_string_equal_len    (const DBusString *a,
 180                                        const DBusString *b,
 181                                        int               len);
 182
 183 dbus_bool_t _dbus_string_starts_with_c_str  (const DBusString *a,
 184                                              const char       *c_str);
 185 dbus_bool_t _dbus_string_ends_with_c_str    (const DBusString *a,
 186                                              const char       *c_str);
 187
 188 dbus_bool_t _dbus_string_pop_line              (DBusString *source,
 189                                                 DBusString *dest);
 190 void        _dbus_string_delete_first_word     (DBusString *str);
 191 void        _dbus_string_delete_leading_blanks (DBusString *str);
 192
 193
 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
 203 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
 204                                          int               start,
 205                                          int               len);
 206
 207 dbus_bool_t _dbus_string_validate_utf8  (const DBusString *str,
 208                                          int               start,
 209                                          int               len);
 210
 211 dbus_bool_t _dbus_string_validate_nul   (const DBusString *str,
 212                                          int               start,
 213                                          int               len);
 214
 215 DBUS_END_DECLS;
 216
 217 #endif /* DBUS_STRING_H */