D-Bus  1.10.12
dbus-marshal-recursive.h
00001 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
00002 /* dbus-marshal-recursive.h  Marshalling routines for recursive types
00003  *
00004  * Copyright (C) 2004, 2005 Red Hat, Inc.
00005  *
00006  * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00021  *
00022  */
00023 
00024 #ifndef DBUS_MARSHAL_RECURSIVE_H
00025 #define DBUS_MARSHAL_RECURSIVE_H
00026 
00027 #include <dbus/dbus-protocol.h>
00028 #include <dbus/dbus-list.h>
00029 
00030 typedef struct DBusTypeReader      DBusTypeReader;
00031 typedef struct DBusTypeWriter      DBusTypeWriter;
00032 typedef struct DBusTypeReaderClass DBusTypeReaderClass;
00033 typedef struct DBusArrayLenFixup   DBusArrayLenFixup;
00034 
00039 struct DBusTypeReader
00040 {
00041   dbus_uint32_t byte_order : 8; 
00043   dbus_uint32_t finished : 1;   
00046   dbus_uint32_t array_len_offset : 3; 
00047   const DBusString *type_str;   
00048   int type_pos;                 
00049   const DBusString *value_str;  
00050   int value_pos;                
00052   const DBusTypeReaderClass *klass; 
00053   union
00054   {
00055     struct {
00056       int start_pos;                
00057     } array;
00058   } u; 
00059 };
00060 
00064 struct DBusTypeWriter
00065 {
00066   dbus_uint32_t byte_order : 8;            
00068   dbus_uint32_t container_type : 8;        
00070   dbus_uint32_t type_pos_is_expectation : 1; 
00072   dbus_uint32_t enabled : 1; 
00074   DBusString *type_str; 
00075   int type_pos;         
00076   DBusString *value_str; 
00077   int value_pos;         
00079   union
00080   {
00081     struct {
00082       int start_pos; 
00083       int len_pos;   
00084       int element_type_pos; 
00085     } array;
00086   } u; 
00087 };
00088 
00093 struct DBusArrayLenFixup
00094 {
00095   int len_pos_in_reader; 
00096   int new_len;           
00097 };
00098 
00099 DBUS_PRIVATE_EXPORT
00100 void        _dbus_type_reader_init                      (DBusTypeReader        *reader,
00101                                                          int                    byte_order,
00102                                                          const DBusString      *type_str,
00103                                                          int                    type_pos,
00104                                                          const DBusString      *value_str,
00105                                                          int                    value_pos);
00106 DBUS_PRIVATE_EXPORT
00107 void        _dbus_type_reader_init_types_only           (DBusTypeReader        *reader,
00108                                                          const DBusString      *type_str,
00109                                                          int                    type_pos);
00110 DBUS_PRIVATE_EXPORT
00111 int         _dbus_type_reader_get_current_type          (const DBusTypeReader  *reader);
00112 DBUS_PRIVATE_EXPORT
00113 int         _dbus_type_reader_get_element_type          (const DBusTypeReader  *reader);
00114 int         _dbus_type_reader_get_value_pos             (const DBusTypeReader  *reader);
00115 DBUS_PRIVATE_EXPORT
00116 void        _dbus_type_reader_read_basic                (const DBusTypeReader  *reader,
00117                                                          void                  *value);
00118 int         _dbus_type_reader_get_array_length          (const DBusTypeReader  *reader);
00119 DBUS_PRIVATE_EXPORT
00120 void        _dbus_type_reader_read_fixed_multi          (const DBusTypeReader  *reader,
00121                                                          void                  *value,
00122                                                          int                   *n_elements);
00123 void        _dbus_type_reader_read_raw                  (const DBusTypeReader  *reader,
00124                                                          const unsigned char  **value_location);
00125 DBUS_PRIVATE_EXPORT
00126 void        _dbus_type_reader_recurse                   (DBusTypeReader        *reader,
00127                                                          DBusTypeReader        *subreader);
00128 DBUS_PRIVATE_EXPORT
00129 dbus_bool_t _dbus_type_reader_next                      (DBusTypeReader        *reader);
00130 dbus_bool_t _dbus_type_reader_has_next                  (const DBusTypeReader  *reader);
00131 DBUS_PRIVATE_EXPORT
00132 void        _dbus_type_reader_get_signature             (const DBusTypeReader  *reader,
00133                                                          const DBusString     **str_p,
00134                                                          int                   *start_p,
00135                                                          int                   *len_p);
00136 DBUS_PRIVATE_EXPORT
00137 dbus_bool_t _dbus_type_reader_set_basic                 (DBusTypeReader        *reader,
00138                                                          const void            *value,
00139                                                          const DBusTypeReader  *realign_root);
00140 DBUS_PRIVATE_EXPORT
00141 dbus_bool_t _dbus_type_reader_delete                    (DBusTypeReader        *reader,
00142                                                          const DBusTypeReader  *realign_root);
00143 
00144 dbus_bool_t _dbus_type_reader_equal_values              (const DBusTypeReader *lhs,
00145                                                          const DBusTypeReader *rhs);
00146 
00147 void        _dbus_type_signature_next                   (const char            *signature,
00148                                                          int                   *type_pos);
00149 
00150 DBUS_PRIVATE_EXPORT
00151 void        _dbus_type_writer_init                 (DBusTypeWriter        *writer,
00152                                                     int                    byte_order,
00153                                                     DBusString            *type_str,
00154                                                     int                    type_pos,
00155                                                     DBusString            *value_str,
00156                                                     int                    value_pos);
00157 void        _dbus_type_writer_init_types_delayed   (DBusTypeWriter        *writer,
00158                                                     int                    byte_order,
00159                                                     DBusString            *value_str,
00160                                                     int                    value_pos);
00161 void        _dbus_type_writer_add_types            (DBusTypeWriter        *writer,
00162                                                     DBusString            *type_str,
00163                                                     int                    type_pos);
00164 void        _dbus_type_writer_remove_types         (DBusTypeWriter        *writer);
00165 DBUS_PRIVATE_EXPORT
00166 void        _dbus_type_writer_init_values_only     (DBusTypeWriter        *writer,
00167                                                     int                    byte_order,
00168                                                     const DBusString      *type_str,
00169                                                     int                    type_pos,
00170                                                     DBusString            *value_str,
00171                                                     int                    value_pos);
00172 DBUS_PRIVATE_EXPORT
00173 dbus_bool_t _dbus_type_writer_write_basic          (DBusTypeWriter        *writer,
00174                                                     int                    type,
00175                                                     const void            *value);
00176 DBUS_PRIVATE_EXPORT
00177 dbus_bool_t _dbus_type_writer_write_fixed_multi    (DBusTypeWriter        *writer,
00178                                                     int                    element_type,
00179                                                     const void            *value,
00180                                                     int                    n_elements);
00181 DBUS_PRIVATE_EXPORT
00182 dbus_bool_t _dbus_type_writer_recurse              (DBusTypeWriter        *writer,
00183                                                     int                    container_type,
00184                                                     const DBusString      *contained_type,
00185                                                     int                    contained_type_start,
00186                                                     DBusTypeWriter        *sub);
00187 DBUS_PRIVATE_EXPORT
00188 dbus_bool_t _dbus_type_writer_unrecurse            (DBusTypeWriter        *writer,
00189                                                     DBusTypeWriter        *sub);
00190 dbus_bool_t _dbus_type_writer_append_array         (DBusTypeWriter        *writer,
00191                                                     const DBusString      *contained_type,
00192                                                     int                    contained_type_start,
00193                                                     DBusTypeWriter        *sub);
00194 DBUS_PRIVATE_EXPORT
00195 dbus_bool_t _dbus_type_writer_write_reader         (DBusTypeWriter        *writer,
00196                                                     DBusTypeReader        *reader);
00197 
00198 
00199 #endif /* DBUS_MARSHAL_RECURSIVE_H */