Split DBusModule into DBusClientModule and DBusServerModule

2008-10-24  Jürg Billeter  <j@bitron.ch>

	* gobject/Makefile.am:
	* gobject/valaccodegenerator.vala:
	* gobject/valadbusclientmodule.vala:
	* gobject/valadbusservermodule.vala:

	Split DBusModule into DBusClientModule and DBusServerModule

svn path=/trunk/; revision=1909

1 files changed, 469 insertions, 0 deletions

diff --git a/gobject/valadbusclientmodule.vala b/gobject/valadbusclientmodule.vala
new file mode 100644
index 000000000..e3dace010
--- /dev/null
+++ b/gobject/valadbusclientmodule.vala
@@ -0,0 +1,469 @@
+/* valadbusclientmodule.vala
+ *
+ * Copyright (C) 2007-2008  Jürg Billeter
+*  Copyright (C) 2008  Philip Van Hoof
+ *
+ * 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:
+ * 	Jürg Billeter <j@bitron.ch>
+ * 	Philip Van Hoof <pvanhoof@gnome.org>
+ */
+
+using GLib;
+using Gee;
+
+/**
+ * The link between a dynamic method and generated code.
+ */
+public class Vala.DBusClientModule : CCodeModule {
+	public DBusClientModule (CCodeGenerator codegen, CCodeModule? next) {
+		base (codegen, next);
+	}
+
+	public override void generate_dynamic_method_wrapper (DynamicMethod method) {
+		var dynamic_method = (DynamicMethod) method;
+
+		var func = new CCodeFunction (method.get_cname (), method.return_type.get_cname ());
+
+		var cparam_map = new HashMap<int,CCodeFormalParameter> (direct_hash, direct_equal);
+
+		var instance_param = new CCodeFormalParameter ("obj", dynamic_method.dynamic_type.get_cname ());
+		cparam_map.set (codegen.get_param_pos (method.cinstance_parameter_position), instance_param);
+
+		generate_cparameters (method, method.return_type, false, cparam_map, func);
+
+		var block = new CCodeBlock ();
+		if (dynamic_method.dynamic_type.data_type == codegen.dbus_object_type) {
+			generate_dbus_method_wrapper (method, block);
+		} else {
+			Report.error (method.source_reference, "dynamic methods are not supported for `%s'".printf (dynamic_method.dynamic_type.to_string ()));
+		}
+
+		// append to C source file
+		codegen.source_type_member_declaration.append (func.copy ());
+
+		func.block = block;
+		codegen.source_type_member_definition.append (func);
+	}
+
+	void generate_dbus_method_wrapper (Method method, CCodeBlock block) {
+		var dynamic_method = (DynamicMethod) method;
+
+		var expr = dynamic_method.invocation;
+
+		var ccall = new CCodeFunctionCall (new CCodeIdentifier ("dbus_g_proxy_begin_call"));
+
+		ccall.add_argument (new CCodeIdentifier ("obj"));
+
+		bool found_out = false;
+		Expression callback = null;
+		int callback_index = -1;
+		int arg_index = 1;
+		foreach (Expression arg in expr.get_argument_list ()) {
+			if (arg.symbol_reference is Method) {
+				// callback
+				if (callback != null) {
+					Report.error (expr.source_reference, "only one reply callback may be specified in invocation of DBus method");
+					expr.error = true;
+					return;
+				} else if (found_out) {
+					Report.error (expr.source_reference, "out argument and reply callback conflict in invocation of DBus method");
+					expr.error = true;
+					return;
+				}
+				callback = arg;
+				callback_index = arg_index;
+			} else if (arg is UnaryExpression && ((UnaryExpression) arg).operator == UnaryOperator.OUT) {
+				// out arg
+				if (callback != null) {
+					Report.error (expr.source_reference, "out argument and reply callback conflict in invocation of DBus method");
+					expr.error = true;
+					return;
+				}
+				found_out = true;
+			} else {
+				// in arg
+				if (callback != null || found_out) {
+					Report.error (expr.source_reference, "in argument must not follow out argument or reply callback in invocation of DBus method");
+					expr.error = true;
+					return;
+				}
+			}
+			arg_index++;
+		}
+
+		ccall.add_argument (new CCodeConstant ("\"%s\"".printf (Symbol.lower_case_to_camel_case (method.name))));
+
+		if (callback != null) {
+			var reply_method = (Method) callback.symbol_reference;
+
+			var cb_fun = new CCodeFunction ("_%s_cb".printf (reply_method.get_cname ()), "void");
+			cb_fun.modifiers = CCodeModifiers.STATIC;
+			cb_fun.add_parameter (new CCodeFormalParameter ("proxy", "DBusGProxy*"));
+			cb_fun.add_parameter (new CCodeFormalParameter ("call", "DBusGProxyCall*"));
+			cb_fun.add_parameter (new CCodeFormalParameter ("user_data", "void*"));
+			cb_fun.block = new CCodeBlock ();
+			var cerrdecl = new CCodeDeclaration ("GError*");
+			cerrdecl.add_declarator (new CCodeVariableDeclarator.with_initializer ("error", new CCodeConstant ("NULL")));
+			cb_fun.block.add_statement (cerrdecl);
+			var cend_call = new CCodeFunctionCall (new CCodeIdentifier ("dbus_g_proxy_end_call"));
+			cend_call.add_argument (new CCodeIdentifier ("proxy"));
+			cend_call.add_argument (new CCodeIdentifier ("call"));
+			cend_call.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier ("error")));
+			var creply_call = new CCodeFunctionCall ((CCodeExpression) callback.ccodenode);
+			creply_call.add_argument (new CCodeIdentifier ("user_data"));
+			int param_count = reply_method.get_parameters ().size;
+			int i = 0;
+			foreach (FormalParameter param in reply_method.get_parameters ()) {
+				if ((++i) == param_count) {
+					// error parameter
+					break;
+				}
+				if (param.parameter_type is ArrayType && ((ArrayType) param.parameter_type).element_type.data_type != codegen.string_type.data_type) {
+					var array_type = (ArrayType) param.parameter_type;
+					CCodeDeclaration cdecl;
+					if (codegen.dbus_use_ptr_array (array_type)) {
+						cdecl = new CCodeDeclaration ("GPtrArray*");
+					} else {
+						cdecl = new CCodeDeclaration ("GArray*");
+					}
+					cdecl.add_declarator (new CCodeVariableDeclarator (param.name));
+					cb_fun.block.add_statement (cdecl);
+					cend_call.add_argument (get_dbus_g_type (array_type));
+					cend_call.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier (param.name)));
+					creply_call.add_argument (new CCodeMemberAccess.pointer (new CCodeIdentifier (param.name), codegen.dbus_use_ptr_array (array_type) ? "pdata" : "data"));
+					creply_call.add_argument (new CCodeMemberAccess.pointer (new CCodeIdentifier (param.name), "len"));
+				} else {
+					var cdecl = new CCodeDeclaration (param.parameter_type.get_cname ());
+					cdecl.add_declarator (new CCodeVariableDeclarator (param.name));
+					cb_fun.block.add_statement (cdecl);
+					if (param.parameter_type is ArrayType && ((ArrayType) param.parameter_type).element_type.data_type == codegen.string_type.data_type) {
+						// special case string array
+						cend_call.add_argument (new CCodeIdentifier ("G_TYPE_STRV"));
+					} else {
+						cend_call.add_argument (new CCodeIdentifier (param.parameter_type.data_type.get_type_id ()));
+					}
+					cend_call.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier (param.name)));
+					creply_call.add_argument (new CCodeIdentifier (param.name));
+
+					if (param.parameter_type is ArrayType && ((ArrayType) param.parameter_type).element_type.data_type == codegen.string_type.data_type) {
+						var cstrvlen = new CCodeFunctionCall (new CCodeIdentifier ("g_strv_length"));
+						cstrvlen.add_argument (new CCodeIdentifier (param.name));
+						creply_call.add_argument (cstrvlen);
+					}
+
+				}
+			}
+			cend_call.add_argument (new CCodeIdentifier ("G_TYPE_INVALID"));
+			cb_fun.block.add_statement (new CCodeExpressionStatement (cend_call));
+			creply_call.add_argument (new CCodeIdentifier ("error"));
+			cb_fun.block.add_statement (new CCodeExpressionStatement (creply_call));
+			codegen.source_type_member_definition.append (cb_fun);
+
+			ccall.add_argument (new CCodeIdentifier (cb_fun.name));
+			ccall.add_argument (new CCodeConstant ("param%d_target".printf (callback_index)));
+			ccall.add_argument (new CCodeConstant ("NULL"));
+		} else if (found_out || !(method.return_type is VoidType)) {
+			ccall.call = new CCodeIdentifier ("dbus_g_proxy_call");
+
+			ccall.add_argument (new CCodeIdentifier ("error"));
+		} else {
+			ccall.call = new CCodeIdentifier ("dbus_g_proxy_call_no_reply");
+		}
+
+		foreach (FormalParameter param in method.get_parameters ()) {
+			if (param.parameter_type is MethodType
+			    || param.parameter_type is DelegateType) {
+				// callback parameter
+				break;
+			}
+
+			if (param.direction != ParameterDirection.IN) {
+				continue;
+			}
+
+			var array_type = param.parameter_type as ArrayType;
+			if (array_type != null) {
+				// array parameter
+				if (array_type.element_type.data_type != codegen.string_type.data_type) {
+					// non-string arrays (use GArray)
+					ccall.add_argument (get_dbus_g_type (array_type));
+
+					var sizeof_call = new CCodeFunctionCall (new CCodeIdentifier ("sizeof"));
+					sizeof_call.add_argument (new CCodeIdentifier (array_type.element_type.get_cname ()));
+
+					CCodeDeclaration cdecl;
+					CCodeFunctionCall array_construct;
+					if (codegen.dbus_use_ptr_array (array_type)) {
+						cdecl = new CCodeDeclaration ("GPtrArray*");
+
+						array_construct = new CCodeFunctionCall (new CCodeIdentifier ("g_ptr_array_sized_new"));
+						array_construct.add_argument (new CCodeIdentifier (head.get_array_length_cname (param.name, 1)));
+					} else {
+						cdecl = new CCodeDeclaration ("GArray*");
+
+						array_construct = new CCodeFunctionCall (new CCodeIdentifier ("g_array_new"));
+						array_construct.add_argument (new CCodeConstant ("TRUE"));
+						array_construct.add_argument (new CCodeConstant ("TRUE"));
+						array_construct.add_argument (sizeof_call);
+					}
+
+					cdecl.add_declarator (new CCodeVariableDeclarator.with_initializer ("dbus_%s".printf (param.name), array_construct));
+					block.add_statement (cdecl);
+
+					if (codegen.dbus_use_ptr_array (array_type)) {
+						var memcpy_call = new CCodeFunctionCall (new CCodeIdentifier ("memcpy"));
+						memcpy_call.add_argument (new CCodeMemberAccess.pointer (new CCodeIdentifier ("dbus_%s".printf (param.name)), "pdata"));
+						memcpy_call.add_argument (new CCodeIdentifier (param.name));
+						memcpy_call.add_argument (new CCodeBinaryExpression (CCodeBinaryOperator.MUL, new CCodeIdentifier (head.get_array_length_cname (param.name, 1)), sizeof_call));
+						block.add_statement (new CCodeExpressionStatement (memcpy_call));
+
+						var len_assignment = new CCodeAssignment (new CCodeMemberAccess.pointer (new CCodeIdentifier ("dbus_%s".printf (param.name)), "len"), new CCodeIdentifier (head.get_array_length_cname (param.name, 1)));
+						block.add_statement (new CCodeExpressionStatement (len_assignment));
+					} else {
+						var cappend_call = new CCodeFunctionCall (new CCodeIdentifier ("g_array_append_vals"));
+						cappend_call.add_argument (new CCodeIdentifier ("dbus_%s".printf (param.name)));
+						cappend_call.add_argument (new CCodeIdentifier (param.name));
+						cappend_call.add_argument (new CCodeIdentifier (head.get_array_length_cname (param.name, 1)));
+						block.add_statement (new CCodeExpressionStatement (cappend_call));
+					}
+
+					ccall.add_argument (new CCodeIdentifier ("dbus_%s".printf (param.name)));
+				} else {
+					// string arrays
+					ccall.add_argument (new CCodeIdentifier ("G_TYPE_STRV"));
+					ccall.add_argument (new CCodeIdentifier (param.name));
+				}
+			} else if (param.parameter_type.get_type_signature ().has_prefix ("(")) {
+				// struct parameter
+				var st = (Struct) param.parameter_type.data_type;
+
+				var array_construct = new CCodeFunctionCall (new CCodeIdentifier ("g_value_array_new"));
+				array_construct.add_argument (new CCodeConstant ("0"));
+
+				var cdecl = new CCodeDeclaration ("GValueArray*");
+				cdecl.add_declarator (new CCodeVariableDeclarator.with_initializer ("dbus_%s".printf (param.name), array_construct));
+				block.add_statement (cdecl);
+
+				var type_call = new CCodeFunctionCall (new CCodeIdentifier ("dbus_g_type_get_struct"));
+				type_call.add_argument (new CCodeConstant ("\"GValueArray\""));
+
+				foreach (Field f in st.get_fields ()) {
+					if (f.binding != MemberBinding.INSTANCE) {
+						continue;
+					}
+
+					string val_name = "val_%s_%s".printf (param.name, f.name);
+
+					// 0-initialize struct with struct initializer { 0 }
+					var cvalinit = new CCodeInitializerList ();
+					cvalinit.append (new CCodeConstant ("0"));
+
+					var cval_decl = new CCodeDeclaration ("GValue");
+					cval_decl.add_declarator (new CCodeVariableDeclarator.with_initializer (val_name, cvalinit));
+					block.add_statement (cval_decl);
+
+					var val_ptr = new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier (val_name));
+
+					var cinit_call = new CCodeFunctionCall (new CCodeIdentifier ("g_value_init"));
+					cinit_call.add_argument (val_ptr);
+					cinit_call.add_argument (new CCodeIdentifier (f.field_type.data_type.get_type_id ()));
+					block.add_statement (new CCodeExpressionStatement (cinit_call));
+
+					var cset_call = new CCodeFunctionCall (new CCodeIdentifier (f.field_type.data_type.get_set_value_function ()));
+					cset_call.add_argument (val_ptr);
+					cset_call.add_argument (new CCodeMemberAccess.pointer (new CCodeIdentifier (param.name), f.name));
+					block.add_statement (new CCodeExpressionStatement (cset_call));
+
+					var cappend_call = new CCodeFunctionCall (new CCodeIdentifier ("g_value_array_append"));
+					cappend_call.add_argument (new CCodeIdentifier ("dbus_%s".printf (param.name)));
+					cappend_call.add_argument (val_ptr);
+					block.add_statement (new CCodeExpressionStatement (cappend_call));
+
+					type_call.add_argument (new CCodeIdentifier (f.field_type.data_type.get_type_id ()));
+				}
+
+				type_call.add_argument (new CCodeConstant ("G_TYPE_INVALID"));
+
+				ccall.add_argument (type_call);
+				ccall.add_argument (new CCodeIdentifier ("dbus_%s".printf (param.name)));
+			} else {
+				ccall.add_argument (new CCodeIdentifier (param.parameter_type.data_type.get_type_id ()));
+				ccall.add_argument (new CCodeIdentifier (param.name));
+			}
+		}
+
+		ccall.add_argument (new CCodeIdentifier ("G_TYPE_INVALID"));
+
+		var out_marshalling_fragment = new CCodeFragment ();
+
+		foreach (FormalParameter param in method.get_parameters ()) {
+			if (param.parameter_type is MethodType) {
+				// callback parameter
+				break;
+			}
+
+			if (param.direction != ParameterDirection.OUT) {
+				continue;
+			}
+
+			if (param.parameter_type.get_type_signature ().has_prefix ("(")) {
+				// struct output parameter
+				var st = (Struct) param.parameter_type.data_type;
+
+				var cdecl = new CCodeDeclaration ("GValueArray*");
+				cdecl.add_declarator (new CCodeVariableDeclarator ("dbus_%s".printf (param.name)));
+				block.add_statement (cdecl);
+
+				var type_call = new CCodeFunctionCall (new CCodeIdentifier ("dbus_g_type_get_struct"));
+				type_call.add_argument (new CCodeConstant ("\"GValueArray\""));
+
+				int i = 0;
+				foreach (Field f in st.get_fields ()) {
+					if (f.binding != MemberBinding.INSTANCE) {
+						continue;
+					}
+
+					var cget_call = new CCodeFunctionCall (new CCodeIdentifier (f.field_type.data_type.get_get_value_function ()));
+					cget_call.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeElementAccess (new CCodeMemberAccess.pointer (new CCodeIdentifier ("dbus_%s".printf (param.name)), "values"), new CCodeConstant (i.to_string ()))));
+					var assign = new CCodeAssignment (new CCodeMemberAccess.pointer (new CCodeIdentifier (param.name), f.name), cget_call);
+					out_marshalling_fragment.append (new CCodeExpressionStatement (assign));
+
+					type_call.add_argument (new CCodeIdentifier (f.field_type.data_type.get_type_id ()));
+					i++;
+				}
+
+				type_call.add_argument (new CCodeConstant ("G_TYPE_INVALID"));
+
+				ccall.add_argument (type_call);
+				ccall.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier ("dbus_%s".printf (param.name))));
+			} else {
+				ccall.add_argument (new CCodeIdentifier (param.parameter_type.data_type.get_type_id ()));
+				ccall.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier (param.name)));
+			}
+		}
+
+		if (!(method.return_type is VoidType)) {
+			// synchronous D-Bus method call with reply
+			var array_type = method.return_type as ArrayType;
+			if (array_type != null && array_type.element_type.data_type != codegen.string_type.data_type) {
+				// non-string arrays (use GArray)
+				ccall.add_argument (get_dbus_g_type (array_type));
+
+				CCodeDeclaration cdecl;
+				if (codegen.dbus_use_ptr_array (array_type)) {
+					cdecl = new CCodeDeclaration ("GPtrArray*");
+				} else {
+					cdecl = new CCodeDeclaration ("GArray*");
+				}
+				cdecl.add_declarator (new CCodeVariableDeclarator ("result"));
+				block.add_statement (cdecl);
+
+				ccall.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier ("result")));
+				ccall.add_argument (new CCodeIdentifier ("G_TYPE_INVALID"));
+
+				block.add_statement (new CCodeExpressionStatement (ccall));
+
+				// don't access result when error occured
+				var creturnblock = new CCodeBlock ();
+				creturnblock.add_statement (new CCodeReturnStatement (codegen.default_value_for_type (method.return_type, false)));
+				var cerrorif = new CCodeIfStatement (new CCodeUnaryExpression (CCodeUnaryOperator.POINTER_INDIRECTION, new CCodeIdentifier ("error")), creturnblock);
+				block.add_statement (cerrorif);
+
+				block.add_statement (out_marshalling_fragment);
+
+				// *result_length1 = result->len;
+				var garray_length = new CCodeMemberAccess.pointer (new CCodeIdentifier ("result"), "len");
+				var result_length = new CCodeUnaryExpression (CCodeUnaryOperator.POINTER_INDIRECTION, new CCodeIdentifier ("result_length1"));
+				var assign = new CCodeAssignment (result_length, garray_length);
+				block.add_statement (new CCodeExpressionStatement (assign));
+
+				// return result->data;
+				block.add_statement (new CCodeReturnStatement (new CCodeCastExpression (new CCodeMemberAccess.pointer (new CCodeIdentifier ("result"), codegen.dbus_use_ptr_array (array_type) ? "pdata" : "data"), method.return_type.get_cname ())));
+			} else {
+				// string arrays or other datatypes
+
+				if (method.return_type is ArrayType) {
+					// string arrays
+					ccall.add_argument (new CCodeIdentifier ("G_TYPE_STRV"));
+				} else {
+					// other types
+					ccall.add_argument (new CCodeIdentifier (method.return_type.data_type.get_type_id ()));
+				}
+
+				var cdecl = new CCodeDeclaration (method.return_type.get_cname ());
+				cdecl.add_declarator (new CCodeVariableDeclarator ("result"));
+				block.add_statement (cdecl);
+
+				ccall.add_argument (new CCodeUnaryExpression (CCodeUnaryOperator.ADDRESS_OF, new CCodeIdentifier ("result")));
+				ccall.add_argument (new CCodeIdentifier ("G_TYPE_INVALID"));
+
+				block.add_statement (new CCodeExpressionStatement (ccall));
+
+				// don't access result when error occured
+				var creturnblock = new CCodeBlock ();
+				creturnblock.add_statement (new CCodeReturnStatement (codegen.default_value_for_type (method.return_type, false)));
+				var cerrorif = new CCodeIfStatement (new CCodeUnaryExpression (CCodeUnaryOperator.POINTER_INDIRECTION, new CCodeIdentifier ("error")), creturnblock);
+				block.add_statement (cerrorif);
+
+				block.add_statement (out_marshalling_fragment);
+
+				if (array_type != null) {
+					// special case string array
+
+					// *result_length1 = g_strv_length (result);
+					var cstrvlen = new CCodeFunctionCall (new CCodeIdentifier ("g_strv_length"));
+					cstrvlen.add_argument (new CCodeIdentifier ("result"));
+					var result_length = new CCodeUnaryExpression (CCodeUnaryOperator.POINTER_INDIRECTION, new CCodeIdentifier ("result_length1"));
+					var assign = new CCodeAssignment (result_length, cstrvlen);
+					block.add_statement (new CCodeExpressionStatement (assign));
+				}
+
+				block.add_statement (new CCodeReturnStatement (new CCodeIdentifier ("result")));
+			}
+		} else {
+			block.add_statement (new CCodeExpressionStatement (ccall));
+
+			// don't access result when error occured
+			var creturnblock = new CCodeBlock ();
+			creturnblock.add_statement (new CCodeReturnStatement ());
+			var cerrorif = new CCodeIfStatement (new CCodeUnaryExpression (CCodeUnaryOperator.POINTER_INDIRECTION, new CCodeIdentifier ("error")), creturnblock);
+			block.add_statement (cerrorif);
+
+			block.add_statement (out_marshalling_fragment);
+		}
+	}
+
+	CCodeExpression get_dbus_g_type (DataType data_type) {
+		var array_type = data_type as ArrayType;
+		if (array_type != null) {
+			if (array_type.element_type.data_type == codegen.string_type.data_type) {
+				return new CCodeIdentifier ("G_TYPE_STRV");
+			}
+
+			var carray_type = new CCodeFunctionCall (new CCodeIdentifier ("dbus_g_type_get_collection"));
+			if (codegen.dbus_use_ptr_array (array_type)) {
+				carray_type.add_argument (new CCodeConstant ("\"GPtrArray\""));
+			} else {
+				carray_type.add_argument (new CCodeConstant ("\"GArray\""));
+			}
+			carray_type.add_argument (get_dbus_g_type (array_type.element_type));
+			return carray_type;
+		} else {
+			return new CCodeIdentifier (data_type.data_type.get_type_id ());
+		}
+	}
+}