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 char        _dbus_string_get_byte           (const DBusString  *str,
  70                                              int                start);
  71 dbus_bool_t _dbus_string_steal_data         (DBusString        *str,
  72                                              char             **data_return);
  73 dbus_bool_t _dbus_string_steal_data_len     (DBusString        *str,
  74                                              char             **data_return,
  75                                              int                start,
  76                                              int                len);
  77
  78 int  _dbus_string_get_length         (const DBusString  *str);
  79
  80 dbus_bool_t _dbus_string_lengthen     (DBusString *str,
  81                                        int         additional_length);
  82 void        _dbus_string_shorten      (DBusString *str,
  83                                        int         length_to_remove);
  84 dbus_bool_t _dbus_string_set_length   (DBusString *str,
  85                                        int         length);
  86 dbus_bool_t _dbus_string_align_length (DBusString *str,
  87                                        int         alignment);
  88
  89 dbus_bool_t _dbus_string_append         (DBusString    *str,
  90                                          const char    *buffer);
  91 dbus_bool_t _dbus_string_append_len     (DBusString    *str,
  92                                          const char    *buffer,
  93                                          int            len);
  94 dbus_bool_t _dbus_string_append_int     (DBusString    *str,
  95                                          long           value);
  96 dbus_bool_t _dbus_string_append_double  (DBusString    *str,
  97                                          double         value);
  98 dbus_bool_t _dbus_string_append_byte    (DBusString    *str,
  99                                          unsigned char  byte);
 100 dbus_bool_t _dbus_string_append_unichar (DBusString    *str,
 101                                          dbus_unichar_t ch);
 102
 103
 104 void        _dbus_string_delete     (DBusString       *str,
 105                                      int               start,
 106                                      int               len);
 107 dbus_bool_t _dbus_string_move       (DBusString       *source,
 108                                      int               start,
 109                                      DBusString       *dest,
 110                                      int               insert_at);
 111 dbus_bool_t _dbus_string_copy       (const DBusString *source,
 112                                      int               start,
 113                                      DBusString       *dest,
 114                                      int               insert_at);
 115 dbus_bool_t _dbus_string_move_len   (DBusString       *source,
 116                                      int               start,
 117                                      int               len,
 118                                      DBusString       *dest,
 119                                      int               insert_at);
 120 dbus_bool_t _dbus_string_copy_len   (const DBusString *source,
 121                                      int               start,
 122                                      int               len,
 123                                      DBusString       *dest,
 124                                      int               insert_at);
 125
 126 dbus_bool_t _dbus_string_replace_len (const DBusString *source,
 127                                       int               start,
 128                                       int               len,
 129                                       DBusString       *dest,
 130                                       int               replace_at,
 131                                       int               replace_len);
 132
 133 void       _dbus_string_get_unichar (const DBusString *str,
 134                                      int               start,
 135                                      dbus_unichar_t   *ch_return,
 136                                      int              *end_return);
 137
 138 dbus_bool_t _dbus_string_parse_int    (const DBusString *str,
 139                                        int               start,
 140                                        long             *value_return,
 141                                        int              *end_return);
 142 dbus_bool_t _dbus_string_parse_double (const DBusString *str,
 143                                        int               start,
 144                                        double           *value,
 145                                        int              *end_return);
 146
 147 dbus_bool_t _dbus_string_find         (const DBusString *str,
 148                                        int               start,
 149                                        const char       *substr,
 150                                        int              *found);
 151
 152 dbus_bool_t _dbus_string_find_to      (const DBusString *str,
 153                                        int               start,
 154                                        int               end,
 155                                        const char       *substr,
 156                                        int              *found);
 157 dbus_bool_t _dbus_string_find_blank   (const DBusString *str,
 158                                        int               start,
 159                                        int              *found);
 160
 161 void        _dbus_string_skip_blank   (const DBusString *str,
 162                                        int               start,
 163                                        int              *end);
 164
 165 dbus_bool_t _dbus_string_equal        (const DBusString *a,
 166                                        const DBusString *b);
 167
 168 dbus_bool_t _dbus_string_equal_c_str  (const DBusString *a,
 169                                        const char       *c_str);
 170
 171 dbus_bool_t _dbus_string_starts_with_c_str  (const DBusString *a,
 172                                              const char       *c_str);
 173 dbus_bool_t _dbus_string_ends_with_c_str    (const DBusString *a,
 174                                              const char       *c_str);
 175
 176 dbus_bool_t _dbus_string_base64_encode (const DBusString *source,
 177                                         int               start,
 178                                         DBusString       *dest,
 179                                         int               insert_at);
 180 dbus_bool_t _dbus_string_base64_decode (const DBusString *source,
 181                                         int               start,
 182                                         DBusString       *dest,
 183                                         int               insert_at);
 184
 185 dbus_bool_t _dbus_string_validate_ascii (const DBusString *str,
 186                                          int               start,
 187                                          int               len);
 188
 189 dbus_bool_t _dbus_string_validate_utf8  (const DBusString *str,
 190                                          int               start,
 191                                          int               len);
 192
 193 dbus_bool_t _dbus_string_validate_nul   (const DBusString *str,
 194                                          int               start,
 195                                          int               len);
 196
 197 DBUS_END_DECLS;
 198
 199 #endif /* DBUS_STRING_H */