summaryrefslogtreecommitdiff
path: root/codegen/valagdbusservertransformer.vala
blob: 19d7cb73f32e7e1ed267bb9586e1135e11ae6c03 (plain)
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/* valagdbusservertransformer.vala
 *
 * Copyright (C) 2011  Luca Bruno
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.

 * This library 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
 * Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
 *
 * Author:
 * 	Luca Bruno <lucabru@src.gnome.org>
 */

/**
 * Code visitor for transforming the code tree related to DBus server.
 */
public class Vala.GDBusServerTransformer : GDBusClientTransformer {
	public override void visit_class (Class cl) {
		visit_object_type_symbol (cl);

		base.visit_class (cl);
	}

	public override void visit_interface (Interface iface) {
		visit_object_type_symbol (iface);

		base.visit_interface (iface);
	}

	string generate_dbus_method_wrapper (Method m, ObjectTypeSymbol sym) {
		Method wrapper;
		wrapper_method (new VoidType (), "gdbus_server " + m.get_full_name (), out wrapper);
		var object_type = SemanticAnalyzer.get_data_type_for_symbol (sym);
		wrapper.add_parameter (new Parameter ("object", object_type));
		wrapper.add_parameter (new Parameter ("arguments", data_type ("GLib.Variant", false)));
		wrapper.add_parameter (new Parameter ("invocation", data_type ("GLib.DBusMethodInvocation", false)));
		push_builder (new CodeBuilder.for_subroutine (wrapper));

		var iter = b.add_temp_declaration (null, expression ("arguments.iterator ()"));

		MethodCall call;
		MethodCall finish_call;
		Method ready = null;
		CodeBuilder ready_builder = null;
		if (m.coroutine) {
			call = (MethodCall) expression (@"object.$(m.name).begin ()");
			wrapper_method (new VoidType (), "gdbus_server_async_ready " + m.get_full_name (), out ready);
			ready.add_parameter (new Parameter ("source_object", data_type ("GLib.Object", false)));
			ready.add_parameter (new Parameter ("res", data_type ("GLib.AsyncResult", false)));
			ready.add_parameter (new Parameter ("invocation", data_type ("GLib.DBusMethodInvocation", false)));
			ready_builder = new CodeBuilder.for_subroutine (ready);

			finish_call = (MethodCall) expression (@"(($object_type) source_object).$(m.name).end (res)");
		} else {
			call = finish_call = (MethodCall) expression (@"object.$(m.name) ()");
		}

		b.open_try ();

		var out_args = new string[0];
		var out_params = new Parameter[0];
		var out_types = new DataType[0];
		string fd_list = null;
		string fd_index = null;
		foreach (var param in m.get_parameters ()) {
			string? type_name = null;
			if (param.variable_type is ObjectType) {
				type_name = param.variable_type.data_type.get_full_name ();
			}

			if (type_name == "GLib.Cancellable") {
				call.add_argument (expression ("null"));
				continue;
			}
			if (type_name == "GLib.BusName") {
				call.add_argument (expression ("(GLib.BusName) invocation.get_sender ()"));
				continue;
			}

			if (param.direction == ParameterDirection.IN) {
				var arg = b.add_temp_declaration (copy_type (param.variable_type, true));
				b.add_assignment (expression (arg), read_dbus_value (param.variable_type, get_dbus_signature (param) != null, iter, "invocation.get_message ()", ref fd_list, ref fd_index));
				call.add_argument (expression (arg));
			} else if (param.direction == ParameterDirection.OUT) {
				if (m.coroutine) {
					// declare the out argument in the ready callback
					push_builder (ready_builder);
				}
				var arg = b.add_temp_declaration (copy_type (param.variable_type, true));
				out_args += arg;
				out_params += param;
				out_types += param.variable_type.copy ();
				finish_call.add_argument (new UnaryExpression (UnaryOperator.OUT, expression (arg), m.source_reference));
				if (m.coroutine) {
					pop_builder ();
				}
			}
		}

		b.add_catch_all ("_invocation_gerror_");
		statements ("invocation.return_gerror (_invocation_gerror_); return;");
		b.close ();

		if (m.coroutine) {
			call.add_argument (expression (@"(s, r) => $(ready.name) (s, r, invocation)"));
			b.add_expression (call);
			push_builder (ready_builder);
		}

		b.open_try ();
		string result = null;
		if (m.has_result) {
			result = b.add_temp_declaration (copy_type (m.return_type));
			b.add_assignment (expression (result), finish_call);
		} else {
			b.add_expression (finish_call);
		}
		b.add_catch_all ("_invocation_gerror_");
		statements ("invocation.return_gerror (_invocation_gerror_); return;");
		b.close ();

		fd_list = null;
		var reply = b.add_temp_declaration (null, expression ("new GLib.DBusMessage.method_reply (invocation.get_message ())"));
		var builder = b.add_temp_declaration (null, expression ("new GLib.VariantBuilder (GLib.VariantType.TUPLE)"));
		for (int i = 0; i < out_args.length; i++) {
			write_dbus_value (out_types[i], get_dbus_signature (out_params[i]) != null, builder, out_args[i], ref fd_list);
		}
		if (result != null) {
			write_dbus_value (m.return_type.copy (), get_dbus_signature (m) != null, builder, result, ref fd_list);
		}
		statements (@"$reply.set_body ($builder.end ());");
		if (fd_list != null) {
			statements (@"$reply.set_unix_fd_list ($fd_list);");
		}
		b.open_try ();
		statements (@"invocation.get_connection ().send_message ($reply, GLib.DBusSendMessageFlags.NONE, null);");
		b.add_catch_uncaught_error ();
		b.close ();

		if (m.coroutine) {
			pop_builder ();
			check (ready);
		}

		pop_builder ();
		check (wrapper);
		return wrapper.name;
	}

	public static bool is_dbus_visible (CodeNode node) {
		var dbus_attribute = node.get_attribute ("DBus");
		if (dbus_attribute != null
		    && dbus_attribute.has_argument ("visible")
		    && !dbus_attribute.get_bool ("visible")) {
			return false;
		}

		return true;
	}

	void generate_interface_method_call (ObjectTypeSymbol sym) {
		if (sym.scope.lookup ("dbus_interface_method_call") != null) {
			return;
		}

		var im = new Method ("dbus_interface_method_call", new VoidType (), sym.source_reference);
		im.access = SymbolAccessibility.PRIVATE;
		im.binding = MemberBinding.STATIC;
		im.add_parameter (new Parameter ("connection", data_type ("GLib.DBusConnection", false)));
		im.add_parameter (new Parameter ("sender", data_type ("string", false)));
		im.add_parameter (new Parameter ("object_path", data_type ("string", false)));
		im.add_parameter (new Parameter ("interface_name", data_type ("string", false)));
		im.add_parameter (new Parameter ("method_name", data_type ("string", false)));
		im.add_parameter (new Parameter ("_parameters_", data_type ("GLib.Variant", false)));
		im.add_parameter (new Parameter ("invocation", data_type ("GLib.DBusMethodInvocation", false)));
		im.add_parameter (new Parameter ("user_data", new PointerType (new VoidType ())));
		sym.add_method (im);

		push_builder (new CodeBuilder.for_subroutine (im));
		var object_type = SemanticAnalyzer.get_data_type_for_symbol (sym);
		var object = b.add_temp_declaration (data_type (@"$object_type", false), expression (@"($object_type) (((GLib.Object[]) user_data)[0])"));
		b.open_switch (expression ("method_name"), null);
		b.add_return ();
		foreach (var m in sym.get_methods ()) {
			if (m is CreationMethod || m.binding != MemberBinding.INSTANCE
			    || m.overrides || m.access != SymbolAccessibility.PUBLIC
				|| !is_dbus_visible (m)) {
				continue;
			}
			b.add_section (expression (@"\"$(get_dbus_name_for_member (m))\""));
			var wrapper = generate_dbus_method_wrapper (m, sym);
			statements (@"$wrapper ($object, _parameters_, invocation);");
			b.add_break ();
		}
		b.close ();
		pop_builder ();
		check (im);
	}

	void generate_interface_get_property (ObjectTypeSymbol sym) {
		if (sym.scope.lookup ("dbus_interface_get_property") != null) {
			return;
		}

		var m = new Method ("dbus_interface_get_property", data_type ("GLib.Variant", true, true), sym.source_reference);
		m.access = SymbolAccessibility.PRIVATE;
		m.binding = MemberBinding.STATIC;
		m.add_parameter (new Parameter ("connection", data_type ("GLib.DBusConnection", false)));
		m.add_parameter (new Parameter ("sender", data_type ("string", false)));
		m.add_parameter (new Parameter ("object_path", data_type ("string", false)));
		m.add_parameter (new Parameter ("interface_name", data_type ("string", false)));
		m.add_parameter (new Parameter ("property_name", data_type ("string", false)));
		m.add_parameter (new Parameter ("error", new PointerType (new ErrorType (null, null))));
		m.add_parameter (new Parameter ("user_data", new PointerType (new VoidType ())));
		sym.add_method (m);

		push_builder (new CodeBuilder.for_subroutine (m));
		var object_type = SemanticAnalyzer.get_data_type_for_symbol (sym);
		var object = b.add_temp_declaration (data_type (@"$object_type", false), expression (@"($object_type) (((GLib.Object[]) user_data)[0])"));
		b.open_switch (expression ("property_name"), null);
		statements ("return null;");
		foreach (var prop in sym.get_properties ()) {
			if (prop.binding != MemberBinding.INSTANCE
			    || prop.overrides || prop.access != SymbolAccessibility.PUBLIC
				|| !is_dbus_visible (prop)
				|| prop.get_accessor == null) {
				continue;
			}
			b.add_section (expression (@"\"$(get_dbus_name_for_member (prop))\""));
			statements (@"return $object.$(prop.name);");
		}
		pop_builder ();
		check (m);
	}

	void generate_interface_set_property (ObjectTypeSymbol sym) {
		if (sym.scope.lookup ("dbus_interface_set_property") != null) {
			return;
		}

		var m = new Method ("dbus_interface_set_property", data_type ("bool"), sym.source_reference);
		m.access = SymbolAccessibility.PRIVATE;
		m.binding = MemberBinding.STATIC;
		m.add_parameter (new Parameter ("connection", data_type ("GLib.DBusConnection", false)));
		m.add_parameter (new Parameter ("sender", data_type ("string", false)));
		m.add_parameter (new Parameter ("object_path", data_type ("string", false)));
		m.add_parameter (new Parameter ("interface_name", data_type ("string", false)));
		m.add_parameter (new Parameter ("property_name", data_type ("string", false)));
		m.add_parameter (new Parameter ("value", data_type ("GLib.Variant", false)));
		m.add_parameter (new Parameter ("error", new PointerType (new ErrorType (null, null))));
		m.add_parameter (new Parameter ("user_data", new PointerType (new VoidType ())));
		sym.add_method (m);

		push_builder (new CodeBuilder.for_subroutine (m));
		var object_type = SemanticAnalyzer.get_data_type_for_symbol (sym);
		var object = b.add_temp_declaration (data_type (@"$object_type", false), expression (@"($object_type) (((GLib.Object[]) user_data)[0])"));
		b.open_switch (expression ("property_name"), null);
		statements ("return false;");
		foreach (var prop in sym.get_properties ()) {
			if (prop.binding != MemberBinding.INSTANCE
			    || prop.overrides || prop.access != SymbolAccessibility.PUBLIC
				|| !is_dbus_visible (prop)
				|| prop.set_accessor == null) {
				continue;
			}
			b.add_section (expression (@"\"$(get_dbus_name_for_member (prop))\""));
			statements (@"$object.$(prop.name) = ($(prop.property_type)) value;
						return true;");
		}
		pop_builder ();
		check (m);
	}

	void generate_interface_signal_emitter (Signal sig, ObjectTypeSymbol sym, string dbus_iface_name) {
		var wrapper_name = "_dbus_%s_%s".printf (get_ccode_lower_case_name (sym), get_ccode_lower_case_name (sig));
		if (context.root.scope.lookup (wrapper_name) != null) {
			return;
		}

		var m = new Method (wrapper_name, new VoidType (), sym.source_reference);
		context.root.add_method (m);
		m.access = SymbolAccessibility.PRIVATE;
		m.binding = MemberBinding.STATIC;
		m.add_parameter (new Parameter ("_sender", data_type ("GLib.Object", false)));
		foreach (var param in sig.get_parameters ()) {
			m.add_parameter (param.copy ());
		}
		m.add_parameter (new Parameter ("_data", new PointerType (new PointerType (new VoidType ()))));
		push_builder (new CodeBuilder.for_subroutine (m));

		var builder = b.add_temp_declaration (null, expression ("new GLib.VariantBuilder (GLib.VariantType.TUPLE)"));
		foreach (var param in sig.get_parameters ()) {
			if (get_dbus_signature (param) != null) {
				statements (@"$builder.add_value ($(param.name));");
			} else if (is_gvariant_type (param.variable_type)) {
				statements (@"$builder.add (\"v\", $(param.name));");
			} else {
				statements (@"$builder.add_value ($(param.name));");
			}
		}
		statements (@"((GLib.DBusConnection) _data[1]).emit_signal (null, (string) _data[2], \"$dbus_iface_name\", \"$(get_dbus_name_for_member (sig))\", $builder.end ());");
		pop_builder ();
		check (m);
	}

	void visit_object_type_symbol (ObjectTypeSymbol sym) {
		string dbus_iface_name = get_dbus_name (sym);
		if (dbus_iface_name == null) {
			return;
		}

		if (!context.has_package ("gio-2.0")) {
			if (!sym.error) {
				Report.error (sym.source_reference, "gio-2.0 package required for dbus type symbols");
				sym.error = true;
			}
			return;
		}

		generate_interface_method_call (sym);
		generate_interface_get_property (sym);
		generate_interface_set_property (sym);

		foreach (var sig in sym.get_signals ()) {
			if (sig.access != SymbolAccessibility.PUBLIC || !is_dbus_visible (sig)) {
				continue;
			}
			generate_interface_signal_emitter (sig, sym, dbus_iface_name);
		}
	}
}