1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-marshal-recursive.h Marshalling routines for recursive types
4 * Copyright (C) 2004 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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
24 #ifndef DBUS_MARSHAL_RECURSIVE_H
25 #define DBUS_MARSHAL_RECURSIVE_H
28 #include <dbus/dbus-marshal-basic.h>
31 #error "config.h not included here"
34 /* Notes on my plan to implement this:
35 * - also have DBusTypeWriter (heh)
36 * - TypeReader has accessors for:
38 * . array of basic type (efficiency hack)
39 * . another type reader
40 * - a dict will appear to be a list of string, whatever, string, whatever
41 * - a variant will contain another TypeReader
42 * - a struct will be a list of whatever, whatever, whatever
44 * So the basic API usage is to go next, next, next; if the
45 * item is a basic type or basic array then read the item;
46 * if it's another type reader then process it; if it's
47 * a container type (struct, array, variant, dict) then
55 const DBusString *type_str;
57 const DBusString *value_str;
60 /* Hmm - it might be cleaner to do TypeReaderClass *vtable for container type */
76 dbus_uint32_t finished : 1;
81 typedef struct DBusTypeReader DBusTypeReader;
88 DBusString *value_str;
91 dbus_uint32_t inside_array : 1;
97 int start_pos; /* first element */
99 int element_type_pos; /* position in type_str of array element type */
100 int element_type_len;
110 typedef struct DBusTypeWriter DBusTypeWriter;
112 void _dbus_type_reader_init (DBusTypeReader *reader,
114 const DBusString *type_str,
116 const DBusString *value_str,
118 int _dbus_type_reader_get_current_type (DBusTypeReader *reader);
119 dbus_bool_t _dbus_type_reader_array_is_empty (DBusTypeReader *reader);
120 void _dbus_type_reader_read_basic (DBusTypeReader *reader,
122 dbus_bool_t _dbus_type_reader_read_array_of_basic (DBusTypeReader *reader,
126 void _dbus_type_reader_recurse (DBusTypeReader *reader,
127 DBusTypeReader *subreader);
128 dbus_bool_t _dbus_type_reader_next (DBusTypeReader *reader);
130 void _dbus_type_writer_init (DBusTypeWriter *writer,
132 DBusString *type_str,
134 DBusString *value_str,
136 dbus_bool_t _dbus_type_writer_write_basic (DBusTypeWriter *writer,
139 dbus_bool_t _dbus_type_writer_write_array (DBusTypeWriter *writer,
143 dbus_bool_t _dbus_type_writer_recurse (DBusTypeWriter *writer,
145 DBusTypeWriter *sub);
146 dbus_bool_t _dbus_type_writer_recurse_array (DBusTypeWriter *writer,
147 const char *element_type,
148 DBusTypeWriter *sub);
149 dbus_bool_t _dbus_type_writer_unrecurse (DBusTypeWriter *writer,
150 DBusTypeWriter *sub);
153 #endif /* DBUS_MARSHAL_RECURSIVE_H */