File: interface.h

package info (click to toggle)
libnih 1.0.3-4.1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 10,544 kB
  • sloc: ansic: 188,634; sh: 11,217; makefile: 1,116; yacc: 291; xml: 239; sed: 16
file content (130 lines) | stat: -rw-r--r-- 4,278 bytes parent folder | download | duplicates (6)
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* nih-dbus-tool
 *
 * Copyright © 2009 Scott James Remnant <scott@netsplit.com>.
 * Copyright © 2009 Canonical Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2, as
 * published by the Free Software Foundation.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef NIH_DBUS_TOOL_INTERFACE_H
#define NIH_DBUS_TOOL_INTERFACE_H

#include <expat.h>

#include <nih/macros.h>
#include <nih/list.h>


/**
 * Interface:
 * @entry: list header,
 * @name: D-Bus name of interface,
 * @symbol: name used when constructing C name,
 * @deprecated: whether this interface is deprecated,
 * @methods: methods defined by the interface,
 * @signals: signals defined by the interface,
 * @properties: properties defined by the interface.
 *
 * D-Bus objects implement zero or more interfaces defining the @methods,
 * @signals and @properties available.  Interfaces are selected by @name
 * over the bus.
 *
 * When generating the C symbol names @symbol will be used.  If @symbol
 * is NULL, and the interface is not the first for the object, as many
 * final components of @name required to ensure uniqueness will be used.
 **/
typedef struct interface {
	NihList entry;
	char *  name;
	char *  symbol;
	int     deprecated;
	NihList methods;
	NihList signals;
	NihList properties;
} Interface;


NIH_BEGIN_EXTERN

int        interface_name_valid                    (const char *name);

Interface *interface_new                           (const void *parent,
						    const char *name)
	__attribute__ ((warn_unused_result, malloc));

int        interface_start_tag                     (XML_Parser xmlp,
						    const char *tag,
						    char * const *attr)
	__attribute__ ((warn_unused_result));
int        interface_end_tag                       (XML_Parser xmlp,
						    const char *tag)
	__attribute__ ((warn_unused_result));

int        interface_annotation                    (Interface *interface,
						    const char *name,
						    const char *value)
	__attribute__ ((warn_unused_result));

char *     interface_methods_array                 (const void *parent,
						    const char *prefix,
						    Interface *interface,
						    int with_handlers,
						    NihList *prototypes)
	__attribute__ ((warn_unused_result, malloc));
char *     interface_signals_array                 (const void *parent,
						    const char *prefix,
						    Interface *interface,
						    int with_filters,
						    NihList *prototypes)
	__attribute__ ((warn_unused_result, malloc));
char *     interface_properties_array              (const void *parent,
						    const char *prefix,
						    Interface *interface,
						    int with_handlers,
						    NihList *prototypes)
	__attribute__ ((warn_unused_result, malloc));

char *     interface_struct                        (const void *parent,
						    const char *prefix,
						    Interface *interface,
						    int object,
						    NihList *prototypes)
	__attribute__ ((warn_unused_result, malloc));


char *     interface_proxy_get_all_function        (const void *parent,
						    const char *prefix,
						    Interface *interface,
						    NihList *prototypes,
						    NihList *structs)
	__attribute__ ((warn_unused_result, malloc));

char *     interface_proxy_get_all_notify_function (const void *parent,
						    const char *prefix,
						    Interface *interface,
						    NihList *prototypes,
						    NihList *typedefs,
						    NihList *structs)
	__attribute__ ((warn_unused_result, malloc));

char *     interface_proxy_get_all_sync_function   (const void *parent,
						    const char *prefix,
						    Interface *interface,
						    NihList *prototypes,
						    NihList *structs)
	__attribute__ ((warn_unused_result, malloc));

NIH_END_EXTERN

#endif /* NIH_DBUS_TOOL_INTERFACE_H */