contrib/jwrapper: reorganize and document the different names of a JavaType
[nit.git] / contrib / jwrapper / src / code_generator.nit
index dcaba43..dfa5cab 100644 (file)
@@ -58,33 +58,68 @@ class CodeGenerator
 
                # All importations
                var imports = new HashSet[String]
-               imports.add "import mnit_android\n"
-               for jclass in model.classes do
+               imports.add "import java\n"
+               for key, jclass in model.classes do
                        for import_ in jclass.imports do imports.add "import android::{import_}\n"
                end
                file_out.write imports.join("\n")
+               file_out.write "\n"
 
-               for jclass in model.classes do
+               for key, jclass in model.classes do
 
-                       file_out.write gen_class_header(jclass.class_type)
+                       generate_class_header(jclass.class_type)
 
                        for id, signatures in jclass.methods do
-                               var c = 0
-                               for signature in signatures do
-                                       var nid = id
-                                       if c > 0 then nid += c.to_s
-                                       c += 1
-
-                                       file_out.write gen_method(jclass, id, nid, signature.return_type, signature.params)
+                               for signature in signatures do if not signature.is_static then
+                                       generate_method(jclass, id, id, signature.return_type, signature.params)
                                        file_out.write "\n"
                                end
                        end
+
+                       # Constructors
+                       for constructor in jclass.constructors do
+                               var complex = jclass.constructors.length != 1 and constructor.params.not_empty
+                               var base_name = if complex then "from" else ""
+                               var name = jclass.nit_name_for(base_name, constructor.params, complex)
+
+                               generate_constructor(jclass, constructor, name)
+                       end
+
+                       # Attributes
+                       for id, attribute in jclass.attributes do if not attribute.is_static then
+                               generate_getter_setter(jclass, id, attribute)
+                       end
+
+                       # JNI services
+                       generate_jni_services jclass.class_type
+
+                       # Close the class
                        file_out.write "end\n\n"
+
+                       # Static functions as top-level methods
+                       var static_functions_prefix = jclass.class_type.extern_name.to_snake_case
+                       for id, signatures in jclass.methods do
+                               for signature in signatures do if signature.is_static then
+                                       var nit_id = static_functions_prefix + "_" + id
+                                       generate_method(jclass, id, nit_id, signature.return_type, signature.params, is_static=true)
+                                       file_out.write "\n"
+                               end
+                       end
+
+                       # Static attributes as top-level getters and setters
+                       for id, attribute in jclass.attributes do if attribute.is_static then
+                               generate_getter_setter(jclass, id, attribute)
+                       end
+
+                       # Primitive arrays
+                       for d in [1..opt_arrays.value] do
+                               generate_primitive_array(jclass, d)
+                       end
                end
 
                if stub_for_unknown_types then
-                       for jtype in model.unknown_types do
-                               file_out.write gen_unknown_class_header(jtype)
+                       for jtype, nit_type in model.unknown_types do
+                               generate_unknown_class_header(jtype)
                                file_out.write "\n"
                        end
                end
@@ -109,131 +144,208 @@ class CodeGenerator
 # This code has been generated using `jwrapper`
 """ is writable
 
-       fun gen_class_header(jtype: JavaType): String
+       private fun generate_class_header(jtype: JavaType)
        do
-               var temp = new Array[String]
-               var nit_type = jtype.to_nit_type
-               temp.add "# Java class: {jtype.to_package_name}\n"
-               temp.add "extern class {nit_type} in \"Java\" `\{ {jtype.to_package_name} `\}\n"
-               temp.add "\tsuper JavaObject\n\n"
-
-               return temp.join
+               var nit_type = model.java_to_nit_type(jtype)
+               file_out.write "# Java class: {jtype}\n"
+               file_out.write "extern class {nit_type} in \"Java\" `\{ {jtype.extern_equivalent} `\}\n"
+               file_out.write "\tsuper JavaObject\n\n"
        end
 
-       fun gen_unknown_class_header(jtype: JavaType): String
+       private fun generate_unknown_class_header(jtype: JavaType)
        do
-               var nit_type: NitType
-               if jtype.extern_name.has_generic_params then
-                       nit_type = jtype.extern_name.generic_params.first
-               else
-                       nit_type = jtype.extern_name
-               end
-
-               var temp = new Array[String]
-               temp.add("extern class {nit_type} in \"Java\" `\{ {jtype.to_package_name} `\}\n")
-               temp.add("\tsuper JavaObject\n\nend\n")
+               var nit_type = jtype.extern_name
 
-               return temp.join
+               file_out.write "extern class {nit_type} in \"Java\" `\{ {jtype.extern_equivalent} `\}\n"
+               file_out.write "\tsuper JavaObject\n\nend\n"
        end
 
-       fun gen_method(java_class: JavaClass, jmethod_id, nmethod_id: String, jreturn_type: JavaType, jparam_list: Array[JavaType]): String
+       private fun generate_method(java_class: JavaClass, java_method_id, method_id: String,
+               java_return_type: JavaType, java_params: Array[JavaType], is_static: nullable Bool)
        do
-               var java_params = ""
-               var nit_params  = ""
+               var java_args = new Array[String]
+               var nit_params = new Array[String]
                var nit_id = "arg"
                var nit_id_no = 0
-               var nit_types = new Array[NitType]
-               var comment = ""
+               var c = ""
 
                # Parameters
-               for i in [0..jparam_list.length[ do
-                       var jparam = jparam_list[i]
-                       var nit_type = jparam.to_nit_type
-
-                       if not nit_type.is_complete then
-                               if jparam.is_wrapped then
-                                       java_class.imports.add nit_type.mod.as(not null)
-                               else
-                                       model.unknown_types.add jparam
-                                       if comment_unknown_types then
-                                               comment = "#"
-                                       else
-                                               nit_type = jparam.extern_name
-                                       end
-                               end
-                       end
-
-                       var cast = ""
+               for jparam in java_params do
+                       var nit_type = model.java_to_nit_type(jparam)
 
-                       if not jparam.is_collection then cast = jparam.param_cast
+                       if not nit_type.is_known and comment_unknown_types then c = "#"
 
-                       nit_types.add(nit_type)
-                       nit_type.arg_id = "{nit_id}{nit_id_no}"
-
-                       if i == jparam_list.length - 1 then
-                               java_params += "{cast}{nit_id}{nit_id_no}"
-                               nit_params  += "{nit_id}{nit_id_no}: {nit_type}"
-                       else
-                               java_params += "{cast}{nit_id}{nit_id_no}" + ", "
-                               nit_params  += "{nit_id}{nit_id_no}: {nit_type}, "
-                       end
+                       java_args.add "{jparam.param_cast}{nit_id}{nit_id_no}"
+                       nit_params.add "{nit_id}{nit_id_no}: {nit_type}"
 
                        nit_id_no += 1
                end
 
-               # Method documentation
-               var doc = "\t# Java implementation: {java_class}.{jmethod_id}\n"
-
                # Method identifier
-               var method_id = nmethod_id.to_nit_method_name
+               method_id = method_id.to_nit_method_name
+               method_id = java_class.nit_name_for(method_id, java_params, java_class.methods[java_method_id].length > 1)
+
+               # Build the signature
                var nit_signature = new Array[String]
+               nit_signature.add "fun {method_id}"
+               if not java_params.is_empty then nit_signature.add "({nit_params.join(", ")})"
 
-               nit_signature.add "\tfun {method_id}"
+               # Return value
+               var return_type = null
+               if not java_return_type.is_void then
+                       return_type = model.java_to_nit_type(java_return_type)
+
+                       if not return_type.is_known and comment_unknown_types then c = "#"
 
-               if not jparam_list.is_empty then
-                       nit_signature.add "({nit_params})"
+                       nit_signature.add ": " + return_type.to_s
                end
 
-               var return_type = null
+               # Build the call in Java
+               var java_call
+               if is_static == true then
+                       java_call = java_class.class_type.package_name
+               else java_call = "self"
+               java_call += ".{java_method_id}({java_args.join(", ")})"
+
+               if return_type != null then java_call = "return {java_return_type.return_cast}" + java_call
+
+               # Tabulation
+               var t = "\t"
+               if is_static == true then t = ""
+               var ct = c+t
+
+               # Write
+               file_out.write """
+{{{t}}}# Java implementation: {{{java_return_type}}} {{{java_class}}}.{{{java_method_id}}}({{{java_params.join(", ")}}})
+{{{ct}}}{{{nit_signature.join}}} in "Java" `{
+{{{ct}}}       {{{java_call}}};
+{{{ct}}}`}
+"""
+       end
 
-               if not jreturn_type.is_void then
-                       return_type = jreturn_type.to_nit_type
-
-                       if not return_type.is_complete then
-                               if jreturn_type.is_wrapped then
-                                       java_class.imports.add return_type.mod.as(not null)
-                               else
-                                       model.unknown_types.add jreturn_type
-                                       if comment_unknown_types then
-                                               comment = "#"
-                                       else
-                                               return_type = jreturn_type.extern_name
-                                       end
-                               end
+       # Generate getter and setter to access an attribute, of field
+       private fun generate_getter_setter(java_class: JavaClass, java_id: String,
+               attribute: JavaAttribute)
+       do
+               var java_type = attribute.java_type
+               var nit_type = model.java_to_nit_type(java_type)
+
+               var nit_id = java_id
+               if attribute.is_static then nit_id = java_class.class_type.extern_name.to_snake_case + "_" + nit_id
+               nit_id = nit_id.to_nit_method_name
+               nit_id = java_class.nit_name_for(nit_id, [java_type], false)
+
+               var c = ""
+               if not nit_type.is_known and comment_unknown_types then c = "#"
+
+               var recv
+               if attribute.is_static then
+                       recv = java_class.class_type.package_name
+               else recv = "self"
+
+               # Tabulation
+               var t = "\t"
+               if attribute.is_static then t = ""
+               var ct = c+t
+
+               file_out.write """
+{{{t}}}# Java getter: {{{java_class}}}.{{{java_id}}}
+{{{ct}}}fun {{{nit_id}}}: {{{nit_type}}} in "Java" `{
+{{{ct}}}       return {{{recv}}}.{{{java_id}}};
+{{{ct}}}`}
+
+{{{t}}}# Java setter: {{{java_class}}}.{{{java_id}}}
+{{{ct}}}fun {{{nit_id}}}=(value: {{{nit_type}}}) in "Java" `{
+{{{ct}}}       {{{recv}}}.{{{java_id}}} = value;
+{{{ct}}}`}
+
+"""
+       end
+
+       # Generate getter and setter to access an attribute, of field
+       private fun generate_constructor(java_class: JavaClass, constructor: JavaConstructor, name: String)
+       do
+               var c = ""
+               var nit_params_s = ""
+               var java_params_s = ""
+
+               if constructor.params.not_empty then
+                       var nit_params = new Array[String]
+                       var java_params = new Array[String]
+                       var param_id = 'a'
+                       for java_type in constructor.params do
+
+                               java_params.add "{java_type.param_cast}{param_id}"
+
+                               var nit_type = model.java_to_nit_type(java_type)
+                               nit_params.add  "{param_id}: {nit_type}"
+                               param_id = param_id.successor(1)
+
+                               if not nit_type.is_known and comment_unknown_types then c = "#"
                        end
 
-                       nit_signature.add ": {return_type} "
+                       nit_params_s = "(" + nit_params.join(", ") + ")"
+                       java_params_s = java_params.join(", ")
                end
 
-               var temp = new Array[String]
-
-               temp.add doc
-               temp.add(comment + nit_signature.join)
-
-               if comment == "#" then
-                       temp.add(" in \"Java\" `\{\n{comment}\t\tself.{jmethod_id}({java_params});\n{comment}\t`\}\n")
-               # Methods with return type
-               else if return_type != null then
-                       temp.add(" in \"Java\" `\{\n{comment}\t\treturn {jreturn_type.return_cast}self.{jmethod_id}({java_params});\n{comment}\t`\}\n")
-               # Methods without return type
-               else if jreturn_type.is_void then
-                       temp.add(" in \"Java\" `\{\n{comment}\t\tself.{jmethod_id}({java_params});\n{comment}\t`\}\n")
-               # No copy
-               else
-                       temp.add(" in \"Java\" `\{\n{comment}\t\tself.{jmethod_id}({java_params});\n{comment}\t`\}\n")
-               end
+               file_out.write """
+       # Java constructor: {{{java_class}}}
+{{{c}}}        new {{{name}}}{{{nit_params_s}}} in "Java" `{
+{{{c}}}                return new {{{java_class}}}({{{java_params_s}}});
+{{{c}}}        `}
+
+"""
+       end
+
+       private fun generate_primitive_array(java_class: JavaClass, dimensions: Int)
+       do
+               var base_java_type = java_class.class_type
+               var java_type = base_java_type.clone
+               java_type.array_dimension = dimensions
+
+               var base_nit_type = model.java_to_nit_type(base_java_type)
+               var nit_type = model.java_to_nit_type(java_type)
+
+               file_out.write """
+# Java primitive array: {{{java_type}}}
+extern class {{{nit_type}}} in "Java" `{ {{{java_type.extern_equivalent}}} `}
+       super AbstractJavaArray[{{{base_nit_type}}}]
+
+       # Get a new array of the given `size`
+       new(size: Int) in "Java" `{ return new {{{base_java_type}}}[(int)size]; `}
+
+       redef fun [](i) in "Java" `{ return self[(int)i]; `}
+
+       redef fun []=(i, e) in "Java" `{ self[(int)i] = e; `}
+
+       redef fun length in "Java" `{ return self.length; `}
+
+"""
+               generate_jni_services(java_type)
+               file_out.write """
+end
+
+"""
+       end
 
-               return temp.join
+       # Generate JNI related services
+       #
+       # For now, mostly avoid issue #845, but more services could be generated as needed.
+       private fun generate_jni_services(java_type: JavaType)
+       do
+               var nit_type = model.java_to_nit_type(java_type)
+
+               file_out.write """
+       redef fun new_global_ref import sys, Sys.jni_env `{
+               Sys sys = {{{nit_type}}}_sys(self);
+               JNIEnv *env = Sys_jni_env(sys);
+               return (*env)->NewGlobalRef(env, self);
+       `}
+
+       redef fun pop_from_local_frame_with_env(jni_env) `{
+               return (*jni_env)->PopLocalFrame(jni_env, self);
+       `}
+"""
        end
 end
 
@@ -241,11 +353,17 @@ redef class Sys
        # List of Nit keywords
        #
        # These may also be keywords in Java, but there they would be used capitalized.
-       private var nit_keywords: Array[String] = ["abort", "abstract", "and", "assert",
-               "break", "class", "continue", "do", "else", "end", "enum", "extern", "implies",
-               "import", "init", "interface", "intrude", "if", "in", "is", "isa", "for", "label",
+       private var nit_keywords = new HashSet[String].from(["abort", "abstract", "and", "assert",
+               "break", "class", "continue", "do", "else", "end", "enum", "extern", "false", "implies",
+               "import", "init", "interface", "intrude", "if", "in", "is", "isa", "isset", "for", "label",
                "loop", "module", "new", "not", "null", "nullable", "or", "package", "private",
-               "protected", "public", "return", "self", "super", "then", "type", "var", "while"]
+               "protected", "public", "return", "self", "super", "then", "true", "type", "var", "while",
+
+       # Top-level methods
+               "class_name", "get_time", "hash", "is_same_type", "is_same_instance", "output",
+
+       # Pointer or JavaObject methods
+               "free"])
 end
 
 redef class String
@@ -258,13 +376,6 @@ redef class String
        fun to_nit_method_name: String
        do
                var name = self.to_snake_case
-               if name.has_prefix("get_") then
-                       name = name.substring_from(4)
-               else if name.has_prefix("set_") then
-                       name = name.substring_from(4)
-                       if nit_keywords.has(name) then name += "_"
-                       name += "="
-               end
 
                # Strip the '_' prefix
                while name.has_prefix("_") do name = name.substring(1, name.length-1)
@@ -280,3 +391,33 @@ redef class String
                return name
        end
 end
+
+redef class JavaClass
+       # Property names used in this class
+       private var used_name = new HashSet[String]
+
+       # Get an available property name for the Java property with `name` and parameters
+       #
+       # If `use_parameters_name` then expect that there will be conflicts,
+       # so use the types of `parameters` to build the name.
+       private fun nit_name_for(name: String, parameters: Array[JavaType], use_parameters_name: Bool): String
+       do
+               # Append the name of each parameter
+               if use_parameters_name then
+                       for param in parameters do
+                               name += "_" + param.id
+                       end
+               end
+
+               # As a last resort, append numbers to the name
+               var base_name = name
+               var count = 1
+               while used_name.has(name) do
+                       name = base_name + count.to_s
+                       count += 1
+               end
+
+               used_name.add name
+               return name
+       end
+end