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) {
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_EMITS_CHANGE))
85 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"false\"/>\n", i->f);
86 else if (flags & SD_BUS_VTABLE_PROPERTY_INVALIDATE_ONLY)
87 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"invalidates\"/>\n", i->f);
90 if ((type == _SD_BUS_VTABLE_METHOD || type == _SD_BUS_VTABLE_WRITABLE_PROPERTY) && (flags & SD_BUS_VTABLE_UNPRIVILEGED))
91 fputs(" <annotation name=\"org.freedesktop.systemd1.Unprivileged\" value=\"true\"/>\n", i->f);
94 static int introspect_write_arguments(struct introspect *i, const char *signature, const char *direction) {
103 r = signature_element_length(signature, &l);
107 fprintf(i->f, " <arg type=\"%.*s\"", (int) l, signature);
110 fprintf(i->f, " direction=\"%s\"/>\n", direction);
118 int introspect_write_interface(struct introspect *i, const sd_bus_vtable *v) {
122 for (; v->type != _SD_BUS_VTABLE_END; v++) {
124 if (v->type != _SD_BUS_VTABLE_START && (v->flags & SD_BUS_VTABLE_HIDDEN))
129 case _SD_BUS_VTABLE_START:
130 if (v->flags & SD_BUS_VTABLE_DEPRECATED)
131 fputs(" <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n", i->f);
134 case _SD_BUS_VTABLE_METHOD:
135 fprintf(i->f, " <method name=\"%s\">\n", v->x.method.member);
136 introspect_write_arguments(i, strempty(v->x.method.signature), "in");
137 introspect_write_arguments(i, strempty(v->x.method.result), "out");
138 introspect_write_flags(i, v->type, v->flags);
139 fputs(" </method>\n", i->f);
142 case _SD_BUS_VTABLE_PROPERTY:
143 case _SD_BUS_VTABLE_WRITABLE_PROPERTY:
144 fprintf(i->f, " <property name=\"%s\" type=\"%s\" access=\"%s\">\n",
145 v->x.property.member,
146 v->x.property.signature,
147 v->type == _SD_BUS_VTABLE_WRITABLE_PROPERTY ? "readwrite" : "read");
148 introspect_write_flags(i, v->type, v->flags);
149 fputs(" </property>\n", i->f);
152 case _SD_BUS_VTABLE_SIGNAL:
153 fprintf(i->f, " <signal name=\"%s\">\n", v->x.signal.member);
154 introspect_write_arguments(i, strempty(v->x.signal.signature), NULL);
155 introspect_write_flags(i, v->type, v->flags);
156 fputs(" </signal>\n", i->f);
165 int introspect_finish(struct introspect *i, sd_bus *bus, sd_bus_message *m, sd_bus_message **reply) {
173 fputs("</node>\n", i->f);
179 r = sd_bus_message_new_method_return(m, &q);
183 r = sd_bus_message_append(q, "s", i->introspection);
185 sd_bus_message_unref(q);
193 void introspect_free(struct introspect *i) {
199 if (i->introspection)
200 free(i->introspection);