File: property.h

package info (click to toggle)
libnih 1.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 10,384 kB
  • ctags: 4,453
  • sloc: ansic: 185,873; sh: 11,213; makefile: 1,116; yacc: 291; xml: 227; sed: 16
file content (150 lines) | stat: -rw-r--r-- 4,954 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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/* 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_PROPERTY_H
#define NIH_DBUS_TOOL_PROPERTY_H

#include <expat.h>

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

#include <nih-dbus/dbus_object.h>

#include "interface.h"


/**
 * Property:
 * @entry: list header,
 * @name: D-Bus name of property,
 * @symbol: name used when constructing C name,
 * @type: type signature of property,
 * @access: access of property,
 * @deprecated: whether this property is deprecated.
 *
 * D-Bus interfaces specify zero or more properties, which are identified by
 * @name over the bus and have the type signature @type.  Properties may be
 * read-only, write-only or read/write depending on @access.
 *
 * When generating the C symbol names @symbol will be used.  If @symbol
 * is NULL, @name will be converted into the usual C lowercase and underscore
 * style and used instead.
 **/
typedef struct property {
	NihList       entry;
	char *        name;
	char *        symbol;
	char *        type;
	NihDBusAccess access;
	int           deprecated;
} Property;


NIH_BEGIN_EXTERN

int       property_name_valid                (const char *name);

Property *property_new                       (const void *parent,
					      const char *name,
					      const char *type,
					      NihDBusAccess access)
	__attribute__ ((warn_unused_result, malloc));

int       property_start_tag                 (XML_Parser xmlp, const char *tag,
					      char * const *attr)
	__attribute__ ((warn_unused_result));
int       property_end_tag                   (XML_Parser xmlp, const char *tag)
	__attribute__ ((warn_unused_result));

int       property_annotation                (Property *property,
					      const char *name,
					      const char *value)
	__attribute__ ((warn_unused_result));

Property *property_lookup                    (Interface *interface,
					      const char *symbol);

char *    property_object_get_function       (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *handlers,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));
char *    property_object_set_function       (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *handlers,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));

char *    property_proxy_get_function        (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));
char *    property_proxy_get_notify_function (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *typedefs,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));

char *    property_proxy_set_function        (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));
char *    property_proxy_set_notify_function (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *typedefs,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));

char *    property_proxy_get_sync_function   (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));
char *    property_proxy_set_sync_function   (const void *parent,
					      const char *prefix,
					      Interface *interface,
					      Property *property,
					      NihList *prototypes,
					      NihList *structs)
	__attribute__ ((warn_unused_result, malloc));

NIH_END_EXTERN

#endif /* NIH_DBUS_TOOL_PROPERTY_H */