1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2013 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 #include "bus-introspect.h"
24 #include "bus-signature.h"
25 #include "bus-internal.h"
26 #include "bus-protocol.h"
28 int introspect_begin(struct introspect *i, bool trusted) {
34 i->f = open_memstream(&i->introspection, &i->size);
38 fputs(BUS_INTROSPECT_DOCTYPE
44 int introspect_write_default_interfaces(struct introspect *i, bool object_manager) {
47 fputs(BUS_INTROSPECT_INTERFACE_PEER
48 BUS_INTROSPECT_INTERFACE_INTROSPECTABLE
49 BUS_INTROSPECT_INTERFACE_PROPERTIES, i->f);
52 fputs(BUS_INTROSPECT_INTERFACE_OBJECT_MANAGER, i->f);
57 int introspect_write_child_nodes(struct introspect *i, Set *s, const char *prefix) {
63 while ((node = set_steal_first(s))) {
66 e = object_path_startswith(node, prefix);
68 fprintf(i->f, " <node name=\"%s\"/>\n", e);
76 static void introspect_write_flags(struct introspect *i, int type, int flags) {
77 if (flags & SD_BUS_VTABLE_DEPRECATED)
78 fputs(" <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n", i->f);
80 if (type == _SD_BUS_VTABLE_METHOD && (flags & SD_BUS_VTABLE_METHOD_NO_REPLY))
81 fputs(" <annotation name=\"org.freedesktop.DBus.Method.NoReply\" value=\"true\"/>\n", i->f);
83 if (type == _SD_BUS_VTABLE_PROPERTY || type == _SD_BUS_VTABLE_WRITABLE_PROPERTY) {
84 if (flags & SD_BUS_VTABLE_PROPERTY_EXPLICIT)
85 fputs(" <annotation name=\"org.freedesktop.systemd1.Explicit\" value=\"true\"/>\n", i->f);
87 if (flags & SD_BUS_VTABLE_PROPERTY_CONST)
88 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"const\"/>\n", i->f);
89 else if (flags & SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION)
90 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"invalidates\"/>\n", i->f);
91 else if (!(flags & SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE))
92 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"false\"/>\n", i->f);
96 (type == _SD_BUS_VTABLE_METHOD || type == _SD_BUS_VTABLE_WRITABLE_PROPERTY) &&
97 !(flags & SD_BUS_VTABLE_UNPRIVILEGED))
98 fputs(" <annotation name=\"org.freedesktop.systemd1.Privileged\" value=\"true\"/>\n", i->f);
101 static int introspect_write_arguments(struct introspect *i, const char *signature, const char *direction) {
110 r = signature_element_length(signature, &l);
114 fprintf(i->f, " <arg type=\"%.*s\"", (int) l, signature);
117 fprintf(i->f, " direction=\"%s\"/>\n", direction);
125 int introspect_write_interface(struct introspect *i, const sd_bus_vtable *v) {
129 for (; v->type != _SD_BUS_VTABLE_END; v++) {
131 /* Ignore methods, signals and properties that are
132 * marked "hidden", but do show the interface
135 if (v->type != _SD_BUS_VTABLE_START && (v->flags & SD_BUS_VTABLE_HIDDEN))
140 case _SD_BUS_VTABLE_START:
141 if (v->flags & SD_BUS_VTABLE_DEPRECATED)
142 fputs(" <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n", i->f);
145 case _SD_BUS_VTABLE_METHOD:
146 fprintf(i->f, " <method name=\"%s\">\n", v->x.method.member);
147 introspect_write_arguments(i, strempty(v->x.method.signature), "in");
148 introspect_write_arguments(i, strempty(v->x.method.result), "out");
149 introspect_write_flags(i, v->type, v->flags);
150 fputs(" </method>\n", i->f);
153 case _SD_BUS_VTABLE_PROPERTY:
154 case _SD_BUS_VTABLE_WRITABLE_PROPERTY:
155 fprintf(i->f, " <property name=\"%s\" type=\"%s\" access=\"%s\">\n",
156 v->x.property.member,
157 v->x.property.signature,
158 v->type == _SD_BUS_VTABLE_WRITABLE_PROPERTY ? "readwrite" : "read");
159 introspect_write_flags(i, v->type, v->flags);
160 fputs(" </property>\n", i->f);
163 case _SD_BUS_VTABLE_SIGNAL:
164 fprintf(i->f, " <signal name=\"%s\">\n", v->x.signal.member);
165 introspect_write_arguments(i, strempty(v->x.signal.signature), NULL);
166 introspect_write_flags(i, v->type, v->flags);
167 fputs(" </signal>\n", i->f);
176 int introspect_finish(struct introspect *i, sd_bus *bus, sd_bus_message *m, sd_bus_message **reply) {
184 fputs("</node>\n", i->f);
186 r = fflush_and_check(i->f);
190 r = sd_bus_message_new_method_return(m, &q);
194 r = sd_bus_message_append(q, "s", i->introspection);
196 sd_bus_message_unref(q);
204 void introspect_free(struct introspect *i) {
210 free(i->introspection);