godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-18 14:21:41 +00:00
Code Releases Wiki Activity

C# generated classes ignore warning CS1591 and cleanup

Browse Source
This commit is contained in:
Ignacio Etcheverry
2018-08-27 20:39:51 +02:00
parent eb25cd0737
commit aa2bcf3dfc
2 changed files with 23 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
modules/mono/editor/bindings_generator.cpp
View File

@@ -533,7 +533,6 @@ Error BindingsGenerator::generate_cs_core_project(const String &p_output_dir, bo
cs_icalls_content.push_back("using System;\n" cs_icalls_content.push_back("using System;\n"
"using System.Runtime.CompilerServices;\n" "using System.Runtime.CompilerServices;\n"
"using " BINDINGS_NAMESPACE_COLLECTIONS ";\n"
"\n"); "\n");
cs_icalls_content.push_back("namespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK); cs_icalls_content.push_back("namespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK);
cs_icalls_content.push_back(INDENT1 "internal static class " BINDINGS_CLASS_NATIVECALLS "\n" INDENT1 OPEN_BLOCK); cs_icalls_content.push_back(INDENT1 "internal static class " BINDINGS_CLASS_NATIVECALLS "\n" INDENT1 OPEN_BLOCK);
@@ -638,7 +637,6 @@ Error BindingsGenerator::generate_cs_editor_project(const String &p_output_dir,
cs_icalls_content.push_back("using System;\n" cs_icalls_content.push_back("using System;\n"
"using System.Runtime.CompilerServices;\n" "using System.Runtime.CompilerServices;\n"
"using " BINDINGS_NAMESPACE_COLLECTIONS ";\n"
"\n"); "\n");
cs_icalls_content.push_back("namespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK); cs_icalls_content.push_back("namespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK);
cs_icalls_content.push_back(INDENT1 "internal static class " BINDINGS_CLASS_NATIVECALLS_EDITOR "\n" INDENT1 OPEN_BLOCK); cs_icalls_content.push_back(INDENT1 "internal static class " BINDINGS_CLASS_NATIVECALLS_EDITOR "\n" INDENT1 OPEN_BLOCK);
@@ -711,10 +709,8 @@ Error BindingsGenerator::_generate_cs_type(const TypeInterface &itype, const Str
List<String> output; List<String> output;
output.push_back("using System;\n"); // IntPtr output.push_back("using System;\n"); // IntPtr
output.push_back("\n#pragma warning disable CS1591 // Disable warning: "
if (itype.requires_collections) "'Missing XML comment for publicly visible type or member'\n");
output.push_back("using " BINDINGS_NAMESPACE_COLLECTIONS ";\n"); // Dictionary
output.push_back("\nnamespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK); output.push_back("\nnamespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK);
const DocData::ClassDoc *class_doc = itype.class_doc; const DocData::ClassDoc *class_doc = itype.class_doc;
@@ -737,8 +733,15 @@ Error BindingsGenerator::_generate_cs_type(const TypeInterface &itype, const Str
} }
output.push_back(INDENT1 "public "); output.push_back(INDENT1 "public ");
bool is_abstract = itype.is_object_type && !ClassDB::can_instance(itype.name) && ClassDB::is_class_enabled(itype.name); // can_instance returns true if there's a constructor and the class is not 'disabled' if (itype.is_object_type) {
output.push_back(itype.is_singleton ? "static partial class " : (is_abstract ? "abstract partial class " : "partial class ")); if (itype.is_singleton) {
output.push_back("static partial class ");
} else {
output.push_back(itype.is_instantiable ? "partial class " : "abstract partial class ");
}
} else {
output.push_back("partial class ");
}
output.push_back(itype.proxy_name); output.push_back(itype.proxy_name);
if (itype.is_singleton) { if (itype.is_singleton) {
@@ -1034,7 +1037,10 @@ Error BindingsGenerator::_generate_cs_type(const TypeInterface &itype, const Str
custom_icalls.push_back(ctor_icall); custom_icalls.push_back(ctor_icall);
} }
output.push_back(INDENT1 CLOSE_BLOCK CLOSE_BLOCK); output.push_back(INDENT1 CLOSE_BLOCK /* class */
CLOSE_BLOCK /* namespace */);
output.push_back("\n#pragma warning restore CS1591\n");
return _save_file(p_output_file, output); return _save_file(p_output_file, output);
} }
@@ -1922,9 +1928,6 @@ void BindingsGenerator::_populate_object_type_interfaces() {
imethod.return_type.cname = Variant::get_type_name(return_info.type); imethod.return_type.cname = Variant::get_type_name(return_info.type);
} }
if (!itype.requires_collections && imethod.return_type.cname == name_cache.type_Dictionary || imethod.return_type.cname == name_cache.type_Array)
itype.requires_collections = true;
for (int i = 0; i < argc; i++) { for (int i = 0; i < argc; i++) {
PropertyInfo arginfo = method_info.arguments[i]; PropertyInfo arginfo = method_info.arguments[i];
@@ -1946,9 +1949,6 @@ void BindingsGenerator::_populate_object_type_interfaces() {
iarg.name = escape_csharp_keyword(snake_to_camel_case(iarg.name)); iarg.name = escape_csharp_keyword(snake_to_camel_case(iarg.name));
if (!itype.requires_collections && iarg.type.cname == name_cache.type_Dictionary || imethod.return_type.cname == name_cache.type_Array)
itype.requires_collections = true;
if (m && m->has_default_argument(i)) { if (m && m->has_default_argument(i)) {
_default_argument_from_variant(m->get_default_argument(i), iarg); _default_argument_from_variant(m->get_default_argument(i), iarg);
} }
@@ -2371,14 +2371,14 @@ void BindingsGenerator::_populate_builtin_type_interfaces() {
itype = TypeInterface(); itype = TypeInterface();
itype.name = "Array"; itype.name = "Array";
itype.cname = itype.name; itype.cname = itype.name;
itype.proxy_name = "Collections.Array"; itype.proxy_name = itype.name;
itype.c_out = "\treturn memnew(Array(%1));\n"; itype.c_out = "\treturn memnew(Array(%1));\n";
itype.c_type = itype.name; itype.c_type = itype.name;
itype.c_type_in = itype.c_type + "*"; itype.c_type_in = itype.c_type + "*";
itype.c_type_out = itype.c_type + "*"; itype.c_type_out = itype.c_type + "*";
itype.cs_type = itype.proxy_name; itype.cs_type = BINDINGS_NAMESPACE_COLLECTIONS "." + itype.proxy_name;
itype.cs_in = "%0." CS_SMETHOD_GETINSTANCE "()"; itype.cs_in = "%0." CS_SMETHOD_GETINSTANCE "()";
itype.cs_out = "return new Collections.Array(%0);"; itype.cs_out = "return new " + itype.cs_type + "(%0);";
itype.im_type_in = "IntPtr"; itype.im_type_in = "IntPtr";
itype.im_type_out = "IntPtr"; itype.im_type_out = "IntPtr";
builtin_types.insert(itype.cname, itype); builtin_types.insert(itype.cname, itype);
@@ -2387,14 +2387,14 @@ void BindingsGenerator::_populate_builtin_type_interfaces() {
itype = TypeInterface(); itype = TypeInterface();
itype.name = "Dictionary"; itype.name = "Dictionary";
itype.cname = itype.name; itype.cname = itype.name;
itype.proxy_name = "Collections.Dictionary"; itype.proxy_name = itype.name;
itype.c_out = "\treturn memnew(Dictionary(%1));\n"; itype.c_out = "\treturn memnew(Dictionary(%1));\n";
itype.c_type = itype.name; itype.c_type = itype.name;
itype.c_type_in = itype.c_type + "*"; itype.c_type_in = itype.c_type + "*";
itype.c_type_out = itype.c_type + "*"; itype.c_type_out = itype.c_type + "*";
itype.cs_type = itype.proxy_name; itype.cs_type = BINDINGS_NAMESPACE_COLLECTIONS "." + itype.proxy_name;
itype.cs_in = "%0." CS_SMETHOD_GETINSTANCE "()"; itype.cs_in = "%0." CS_SMETHOD_GETINSTANCE "()";
itype.cs_out = "return new Collections.Dictionary(%0);"; itype.cs_out = "return new " + itype.cs_type + "(%0);";
itype.im_type_in = "IntPtr"; itype.im_type_in = "IntPtr";
itype.im_type_out = "IntPtr"; itype.im_type_out = "IntPtr";
builtin_types.insert(itype.cname, itype); builtin_types.insert(itype.cname, itype);
@@ -2441,9 +2441,6 @@ void BindingsGenerator::_populate_builtin_type(TypeInterface &r_itype, Variant::
else else
iarg.type.cname = Variant::get_type_name(pi.type); iarg.type.cname = Variant::get_type_name(pi.type);
if (!r_itype.requires_collections && iarg.type.cname == name_cache.type_Dictionary || imethod.return_type.cname == name_cache.type_Array)
r_itype.requires_collections = true;
if ((mi.default_arguments.size() - mi.arguments.size() + i) >= 0) if ((mi.default_arguments.size() - mi.arguments.size() + i) >= 0)
_default_argument_from_variant(Variant::construct(pi.type, NULL, 0, cerror), iarg); _default_argument_from_variant(Variant::construct(pi.type, NULL, 0, cerror), iarg);
@@ -2457,9 +2454,6 @@ void BindingsGenerator::_populate_builtin_type(TypeInterface &r_itype, Variant::
imethod.return_type.cname = Variant::get_type_name(mi.return_val.type); imethod.return_type.cname = Variant::get_type_name(mi.return_val.type);
} }
if (!r_itype.requires_collections && imethod.return_type.cname == name_cache.type_Dictionary || imethod.return_type.cname == name_cache.type_Array)
r_itype.requires_collections = true;
if (r_itype.class_doc) { if (r_itype.class_doc) {
for (int i = 0; i < r_itype.class_doc->methods.size(); i++) { for (int i = 0; i < r_itype.class_doc->methods.size(); i++) {
if (r_itype.class_doc->methods[i].name == imethod.name) { if (r_itype.class_doc->methods[i].name == imethod.name) {

11
modules/mono/editor/bindings_generator.h
View File

@@ -192,7 +192,7 @@ class BindingsGenerator {
/** /**
* Used only by Object-derived types. * Used only by Object-derived types.
* Determines if this type is not virtual (incomplete). * Determines if this type is not abstract (incomplete).
* e.g.: CanvasItem cannot be instantiated. * e.g.: CanvasItem cannot be instantiated.
*/ */
bool is_instantiable; bool is_instantiable;
@@ -204,12 +204,6 @@ class BindingsGenerator {
*/ */
bool memory_own; bool memory_own;
/**
* Determines if the file must have a using directive for System.Collections.Generic
* e.g.: When the generated class makes use of Dictionary
*/
bool requires_collections;
// !! The comments of the following fields make reference to other fields via square brackets, e.g.: [field_name] // !! The comments of the following fields make reference to other fields via square brackets, e.g.: [field_name]
// !! When renaming those fields, make sure to rename their references in the comments // !! When renaming those fields, make sure to rename their references in the comments
@@ -295,7 +289,7 @@ class BindingsGenerator {
/** /**
* Type used for method signatures, both for parameters and the return type. * Type used for method signatures, both for parameters and the return type.
* Same as [proxy_name] except for variable arguments (VarArg). * Same as [proxy_name] except for variable arguments (VarArg) and collections (which include the namespace).
*/ */
String cs_type; String cs_type;
@@ -414,7 +408,6 @@ class BindingsGenerator {
is_instantiable = false; is_instantiable = false;
memory_own = false; memory_own = false;
requires_collections = false;
c_arg_in = "%s"; c_arg_in = "%s";