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 "sd-bus-protocol.h"
24 #include "bus-introspect.h"
25 #include "bus-signature.h"
26 #include "bus-internal.h"
27 #include "bus-protocol.h"
29 int introspect_begin(struct introspect *i, bool trusted) {
35 i->f = open_memstream(&i->introspection, &i->size);
39 fputs(BUS_INTROSPECT_DOCTYPE
45 int introspect_write_default_interfaces(struct introspect *i, bool object_manager) {
48 fputs(BUS_INTROSPECT_INTERFACE_PEER
49 BUS_INTROSPECT_INTERFACE_INTROSPECTABLE
50 BUS_INTROSPECT_INTERFACE_PROPERTIES, i->f);
53 fputs(BUS_INTROSPECT_INTERFACE_OBJECT_MANAGER, i->f);
58 int introspect_write_child_nodes(struct introspect *i, Set *s, const char *prefix) {
64 while ((node = set_steal_first(s))) {
67 e = object_path_startswith(node, prefix);
69 fprintf(i->f, " <node name=\"%s\"/>\n", e);
77 static void introspect_write_flags(struct introspect *i, int type, int flags) {
78 if (flags & SD_BUS_VTABLE_DEPRECATED)
79 fputs(" <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n", i->f);
81 if (type == _SD_BUS_VTABLE_METHOD && (flags & SD_BUS_VTABLE_METHOD_NO_REPLY))
82 fputs(" <annotation name=\"org.freedesktop.DBus.Method.NoReply\" value=\"true\"/>\n", i->f);
84 if (type == _SD_BUS_VTABLE_PROPERTY || type == _SD_BUS_VTABLE_WRITABLE_PROPERTY) {
85 if (flags & SD_BUS_VTABLE_PROPERTY_CONST)
86 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"const\"/>\n", i->f);
87 else if (flags & SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION)
88 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"invalidates\"/>\n", i->f);
89 else if (!(flags & SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE))
90 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"false\"/>\n", i->f);
94 (type == _SD_BUS_VTABLE_METHOD || type == _SD_BUS_VTABLE_WRITABLE_PROPERTY) &&
95 !(flags & SD_BUS_VTABLE_UNPRIVILEGED))
96 fputs(" <annotation name=\"org.freedesktop.systemd1.Privileged\" value=\"true\"/>\n", i->f);
99 static int introspect_write_arguments(struct introspect *i, const char *signature, const char *direction) {
108 r = signature_element_length(signature, &l);
112 fprintf(i->f, " <arg type=\"%.*s\"", (int) l, signature);
115 fprintf(i->f, " direction=\"%s\"/>\n", direction);
123 int introspect_write_interface(struct introspect *i, const sd_bus_vtable *v) {
127 for (; v->type != _SD_BUS_VTABLE_END; v++) {
129 /* Ignore methods, signals and properties that are
130 * marked "hidden", but do show the interface
133 if (v->type != _SD_BUS_VTABLE_START && (v->flags & SD_BUS_VTABLE_HIDDEN))
138 case _SD_BUS_VTABLE_START:
139 if (v->flags & SD_BUS_VTABLE_DEPRECATED)
140 fputs(" <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n", i->f);
143 case _SD_BUS_VTABLE_METHOD:
144 fprintf(i->f, " <method name=\"%s\">\n", v->x.method.member);
145 introspect_write_arguments(i, strempty(v->x.method.signature), "in");
146 introspect_write_arguments(i, strempty(v->x.method.result), "out");
147 introspect_write_flags(i, v->type, v->flags);
148 fputs(" </method>\n", i->f);
151 case _SD_BUS_VTABLE_PROPERTY:
152 case _SD_BUS_VTABLE_WRITABLE_PROPERTY:
153 fprintf(i->f, " <property name=\"%s\" type=\"%s\" access=\"%s\">\n",
154 v->x.property.member,
155 v->x.property.signature,
156 v->type == _SD_BUS_VTABLE_WRITABLE_PROPERTY ? "readwrite" : "read");
157 introspect_write_flags(i, v->type, v->flags);
158 fputs(" </property>\n", i->f);
161 case _SD_BUS_VTABLE_SIGNAL:
162 fprintf(i->f, " <signal name=\"%s\">\n", v->x.signal.member);
163 introspect_write_arguments(i, strempty(v->x.signal.signature), NULL);
164 introspect_write_flags(i, v->type, v->flags);
165 fputs(" </signal>\n", i->f);
174 int introspect_finish(struct introspect *i, sd_bus *bus, sd_bus_message *m, sd_bus_message **reply) {
182 fputs("</node>\n", i->f);
188 r = sd_bus_message_new_method_return(m, &q);
192 r = sd_bus_message_append(q, "s", i->introspection);
194 sd_bus_message_unref(q);
202 void introspect_free(struct introspect *i) {
208 if (i->introspection)
209 free(i->introspection);