Main Page   Modules   Data Structures   File List   Data Fields   Related Pages  

dbus-string.h

00001 /* -*- mode: C; c-file-style: "gnu" -*- */
00002 /* dbus-string.h String utility class (internal to D-BUS implementation)
00003  * 
00004  * Copyright (C) 2002  Red Hat, Inc.
00005  *
00006  * Licensed under the Academic Free License version 1.2
00007  * 
00008  * This program is free software; you can redistribute it and/or modify
00009  * it under the terms of the GNU General Public License as published by
00010  * the Free Software Foundation; either version 2 of the License, or
00011  * (at your option) any later version.
00012  *
00013  * This program is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  * GNU General Public License for more details.
00017  * 
00018  * You should have received a copy of the GNU General Public License
00019  * along with this program; if not, write to the Free Software
00020  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00021  *
00022  */
00023 
00024 #ifndef DBUS_STRING_H
00025 #define DBUS_STRING_H
00026 
00027 #include <config.h>
00028 
00029 #include <dbus/dbus-memory.h>
00030 #include <dbus/dbus-types.h>
00031 
00032 DBUS_BEGIN_DECLS;
00033 
00034 typedef struct DBusString DBusString;
00035 
00036 struct DBusString
00037 {
00038   void *dummy1; 
00039   int   dummy2; 
00040   int   dummy3; 
00041   int   dummy4; 
00042   unsigned int dummy5 : 1; 
00043   unsigned int dummy6 : 1; 
00044   unsigned int dummy7 : 1; 
00045   unsigned int dummy8 : 3; 
00046 };
00047 
00048 dbus_bool_t   _dbus_string_init                  (DBusString        *str);
00049 void          _dbus_string_init_const            (DBusString        *str,
00050                                                   const char        *value);
00051 void          _dbus_string_init_const_len        (DBusString        *str,
00052                                                   const char        *value,
00053                                                   int                len);
00054 dbus_bool_t   _dbus_string_init_preallocated     (DBusString        *str,
00055                                                   int                allocate_size);
00056 void          _dbus_string_free                  (DBusString        *str);
00057 void          _dbus_string_lock                  (DBusString        *str);
00058 char*         _dbus_string_get_data              (DBusString        *str);
00059 const char*   _dbus_string_get_const_data        (const DBusString  *str);
00060 char*         _dbus_string_get_data_len          (DBusString        *str,
00061                                                   int                start,
00062                                                   int                len);
00063 const char*   _dbus_string_get_const_data_len    (const DBusString  *str,
00064                                                   int                start,
00065                                                   int                len);
00066 void          _dbus_string_set_byte              (DBusString        *str,
00067                                                   int                i,
00068                                                   unsigned char      byte);
00069 unsigned char _dbus_string_get_byte              (const DBusString  *str,
00070                                                   int                start);
00071 dbus_bool_t   _dbus_string_insert_byte           (DBusString        *str,
00072                                                   int                i,
00073                                                   unsigned char      byte);
00074 dbus_bool_t   _dbus_string_steal_data            (DBusString        *str,
00075                                                   char             **data_return);
00076 dbus_bool_t   _dbus_string_steal_data_len        (DBusString        *str,
00077                                                   char             **data_return,
00078                                                   int                start,
00079                                                   int                len);
00080 dbus_bool_t   _dbus_string_copy_data             (const DBusString  *str,
00081                                                   char             **data_return);
00082 dbus_bool_t   _dbus_string_copy_data_len         (const DBusString  *str,
00083                                                   char             **data_return,
00084                                                   int                start,
00085                                                   int                len);
00086 int           _dbus_string_get_length            (const DBusString  *str);
00087 dbus_bool_t   _dbus_string_lengthen              (DBusString        *str,
00088                                                   int                additional_length);
00089 void          _dbus_string_shorten               (DBusString        *str,
00090                                                   int                length_to_remove);
00091 dbus_bool_t   _dbus_string_set_length            (DBusString        *str,
00092                                                   int                length);
00093 dbus_bool_t   _dbus_string_align_length          (DBusString        *str,
00094                                                   int                alignment);
00095 dbus_bool_t   _dbus_string_append                (DBusString        *str,
00096                                                   const char        *buffer);
00097 dbus_bool_t   _dbus_string_append_len            (DBusString        *str,
00098                                                   const char        *buffer,
00099                                                   int                len);
00100 dbus_bool_t   _dbus_string_append_int            (DBusString        *str,
00101                                                   long               value);
00102 dbus_bool_t   _dbus_string_append_uint           (DBusString        *str,
00103                                                   unsigned long      value);
00104 dbus_bool_t   _dbus_string_append_double         (DBusString        *str,
00105                                                   double             value);
00106 dbus_bool_t   _dbus_string_append_byte           (DBusString        *str,
00107                                                   unsigned char      byte);
00108 dbus_bool_t   _dbus_string_append_unichar        (DBusString        *str,
00109                                                   dbus_unichar_t     ch);
00110 dbus_bool_t   _dbus_string_append_4_aligned      (DBusString        *str,
00111                                                   const unsigned char octets[4]);
00112 dbus_bool_t   _dbus_string_append_8_aligned      (DBusString        *str,
00113                                                   const unsigned char octets[8]);
00114 void          _dbus_string_delete                (DBusString        *str,
00115                                                   int                start,
00116                                                   int                len);
00117 dbus_bool_t   _dbus_string_move                  (DBusString        *source,
00118                                                   int                start,
00119                                                   DBusString        *dest,
00120                                                   int                insert_at);
00121 dbus_bool_t   _dbus_string_copy                  (const DBusString  *source,
00122                                                   int                start,
00123                                                   DBusString        *dest,
00124                                                   int                insert_at);
00125 dbus_bool_t   _dbus_string_move_len              (DBusString        *source,
00126                                                   int                start,
00127                                                   int                len,
00128                                                   DBusString        *dest,
00129                                                   int                insert_at);
00130 dbus_bool_t   _dbus_string_copy_len              (const DBusString  *source,
00131                                                   int                start,
00132                                                   int                len,
00133                                                   DBusString        *dest,
00134                                                   int                insert_at);
00135 dbus_bool_t   _dbus_string_replace_len           (const DBusString  *source,
00136                                                   int                start,
00137                                                   int                len,
00138                                                   DBusString        *dest,
00139                                                   int                replace_at,
00140                                                   int                replace_len);
00141 void          _dbus_string_get_unichar           (const DBusString  *str,
00142                                                   int                start,
00143                                                   dbus_unichar_t    *ch_return,
00144                                                   int               *end_return);
00145 dbus_bool_t   _dbus_string_parse_int             (const DBusString  *str,
00146                                                   int                start,
00147                                                   long              *value_return,
00148                                                   int               *end_return);
00149 dbus_bool_t   _dbus_string_parse_uint            (const DBusString  *str,
00150                                                   int                start,
00151                                                   unsigned long     *value_return,
00152                                                   int               *end_return);
00153 dbus_bool_t   _dbus_string_parse_double          (const DBusString  *str,
00154                                                   int                start,
00155                                                   double            *value,
00156                                                   int               *end_return);
00157 dbus_bool_t   _dbus_string_find                  (const DBusString  *str,
00158                                                   int                start,
00159                                                   const char        *substr,
00160                                                   int               *found);
00161 dbus_bool_t   _dbus_string_find_to               (const DBusString  *str,
00162                                                   int                start,
00163                                                   int                end,
00164                                                   const char        *substr,
00165                                                   int               *found);
00166 dbus_bool_t   _dbus_string_find_byte_backward    (const DBusString  *str,
00167                                                   int                start,
00168                                                   unsigned char      byte,
00169                                                   int               *found);
00170 dbus_bool_t   _dbus_string_find_blank            (const DBusString  *str,
00171                                                   int                start,
00172                                                   int               *found);
00173 void          _dbus_string_skip_blank            (const DBusString  *str,
00174                                                   int                start,
00175                                                   int               *end);
00176 void          _dbus_string_skip_white            (const DBusString  *str,
00177                                                   int                start,
00178                                                   int               *end);
00179 dbus_bool_t   _dbus_string_equal                 (const DBusString  *a,
00180                                                   const DBusString  *b);
00181 dbus_bool_t   _dbus_string_equal_c_str           (const DBusString  *a,
00182                                                   const char        *c_str);
00183 dbus_bool_t   _dbus_string_equal_len             (const DBusString  *a,
00184                                                   const DBusString  *b,
00185                                                   int                len);
00186 dbus_bool_t   _dbus_string_starts_with_c_str     (const DBusString  *a,
00187                                                   const char        *c_str);
00188 dbus_bool_t   _dbus_string_ends_with_c_str       (const DBusString  *a,
00189                                                   const char        *c_str);
00190 dbus_bool_t   _dbus_string_pop_line              (DBusString        *source,
00191                                                   DBusString        *dest);
00192 void          _dbus_string_delete_first_word     (DBusString        *str);
00193 void          _dbus_string_delete_leading_blanks (DBusString        *str);
00194 dbus_bool_t   _dbus_string_base64_encode         (const DBusString  *source,
00195                                                   int                start,
00196                                                   DBusString        *dest,
00197                                                   int                insert_at);
00198 dbus_bool_t   _dbus_string_base64_decode         (const DBusString  *source,
00199                                                   int                start,
00200                                                   DBusString        *dest,
00201                                                   int                insert_at);
00202 dbus_bool_t   _dbus_string_hex_encode            (const DBusString  *source,
00203                                                   int                start,
00204                                                   DBusString        *dest,
00205                                                   int                insert_at);
00206 dbus_bool_t   _dbus_string_hex_decode            (const DBusString  *source,
00207                                                   int                start,
00208                                                   DBusString        *dest,
00209                                                   int                insert_at);
00210 dbus_bool_t   _dbus_string_validate_ascii        (const DBusString  *str,
00211                                                   int                start,
00212                                                   int                len);
00213 dbus_bool_t   _dbus_string_validate_utf8         (const DBusString  *str,
00214                                                   int                start,
00215                                                   int                len);
00216 dbus_bool_t   _dbus_string_validate_nul          (const DBusString  *str,
00217                                                   int                start,
00218                                                   int                len);
00219 dbus_bool_t   _dbus_string_validate_name         (const DBusString  *str,
00220                                                   int                start,
00221                                                   int                len);
00222 dbus_bool_t   _dbus_string_validate_service      (const DBusString  *str,
00223                                                   int                start,
00224                                                   int                len);
00225 void          _dbus_string_zero                  (DBusString        *str);
00226 
00227 
00228 DBUS_END_DECLS;
00229 
00230 #endif /* DBUS_STRING_H */

Generated on Wed Oct 22 14:05:04 2003 for D-BUS by doxygen1.3-rc3