summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-marshal-recursive.h
blob: 19960ec86c8400392ae153a1f164bd05190db279 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-marshal-recursive.h  Marshalling routines for recursive types
 *
 * Copyright (C) 2004 Red Hat, Inc.
 *
 * Licensed under the Academic Free License version 2.1
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef DBUS_MARSHAL_RECURSIVE_H
#define DBUS_MARSHAL_RECURSIVE_H

#include <config.h>
#include <dbus/dbus-marshal-basic.h>

#ifndef PACKAGE
#error "config.h not included here"
#endif

/* Notes on my plan to implement this:
 * - also have DBusTypeWriter (heh)
 * - TypeReader has accessors for:
 *    . basic type
 *    . array of basic type (efficiency hack)
 *    . another type reader
 * - a dict will appear to be a list of string, whatever, string, whatever
 * - a variant will contain another TypeReader
 * - a struct will be a list of whatever, whatever, whatever
 *
 * So the basic API usage is to go next, next, next; if the
 * item is a basic type or basic array then read the item;
 * if it's another type reader then process it; if it's
 * a container type (struct, array, variant, dict) then
 * recurse.
 * 
 */

struct DBusTypeReader
{
  int byte_order;
  const DBusString *type_str;
  int type_pos;
  const DBusString *value_str;
  int value_pos;
};

typedef struct DBusTypeReader DBusTypeReader;

struct DBusTypeWriter
{
  int byte_order;
  DBusString *type_str;
  int type_pos;
  DBusString *value_str;
  int value_pos;
};

typedef struct DBusTypeWriter DBusTypeWriter;

void        _dbus_type_reader_init             (DBusTypeReader    *reader,
                                                int                byte_order,
                                                const DBusString  *type_str,
                                                int                type_pos,
                                                const DBusString  *value_str,
                                                int                value_pos);
int         _dbus_type_reader_get_value_end    (DBusTypeReader    *reader);
int         _dbus_type_reader_get_type_end     (DBusTypeReader    *reader);
int         _dbus_type_reader_get_current_type (DBusTypeReader    *reader);
int         _dbus_type_reader_get_array_type   (DBusTypeReader    *reader);
void        _dbus_type_reader_read_basic       (DBusTypeReader    *reader,
                                                void              *value);
dbus_bool_t _dbus_type_reader_read_array       (DBusTypeReader    *reader,
                                                int                type,
                                                void             **array,
                                                int               *array_len);
void        _dbus_type_reader_recurse          (DBusTypeReader    *reader);
void        _dbus_type_reader_unrecurse        (DBusTypeReader    *reader);
dbus_bool_t _dbus_type_reader_next             (DBusTypeReader    *reader);


void        _dbus_type_writer_init        (DBusTypeWriter *writer,
                                           int             byte_order,
                                           DBusString     *type_str,
                                           int             type_pos,
                                           DBusString     *value_str,
                                           int             value_pos);
dbus_bool_t _dbus_type_writer_write_basic (DBusTypeWriter *writer,
                                           int             type,
                                           const void     *value);
dbus_bool_t _dbus_type_writer_write_array (DBusTypeWriter *writer,
                                           int             type,
                                           const void     *array,
                                           int             array_len);
dbus_bool_t _dbus_type_writer_recurse     (DBusTypeWriter *writer,
                                           int             container_type);
dbus_bool_t _dbus_type_writer_unrecurse   (DBusTypeWriter *writer);

#endif /* DBUS_MARSHAL_RECURSIVE_H */