Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough

EditorHelp: Improve enum ref resolving and add constant ref support

2 files changed, 104 insertions, 2 deletions

diff --git a/modules/mono/editor/bindings_generator.cpp b/modules/mono/editor/bindings_generator.cpp
index 35a89956a8..c0504bec64 100644
--- a/modules/mono/editor/bindings_generator.cpp
+++ b/modules/mono/editor/bindings_generator.cpp
@@ -277,7 +277,7 @@ String BindingsGenerator::bbcode_to_xml(const String &p_bbcode, const TypeInterf
 		} else if (code_tag) {
 			xml_output.append("[");
 			pos = brk_pos + 1;
-		} else if (tag.begins_with("method ") || tag.begins_with("member ") || tag.begins_with("signal ") || tag.begins_with("enum ")) {
+		} else if (tag.begins_with("method ") || tag.begins_with("member ") || tag.begins_with("signal ") || tag.begins_with("enum ") || tag.begins_with("constant ")) {
 			String link_target = tag.substr(tag.find(" ") + 1, tag.length());
 			String link_tag = tag.substr(0, tag.find(" "));
 
@@ -386,6 +386,97 @@ String BindingsGenerator::bbcode_to_xml(const String &p_bbcode, const TypeInterf
 					xml_output.append(link_target);
 					xml_output.append("</c>");
 				}
+			} else if (link_tag == "const") {
+				if (!target_itype || !target_itype->is_object_type) {
+					if (OS::get_singleton()->is_stdout_verbose()) {
+						if (target_itype) {
+							OS::get_singleton()->print("Cannot resolve constant reference for non-Godot.Object type in documentation: %s\n", link_target.utf8().get_data());
+						} else {
+							OS::get_singleton()->print("Cannot resolve type from constant reference in documentation: %s\n", link_target.utf8().get_data());
+						}
+					}
+
+					// TODO Map what we can
+					xml_output.append("<c>");
+					xml_output.append(link_target);
+					xml_output.append("</c>");
+				} else if (!target_itype && target_cname == name_cache.type_at_GlobalScope) {
+					String target_name = (String)target_cname;
+
+					// Try to find as a global constant
+					const ConstantInterface *target_iconst = find_constant_by_name(target_name, global_constants);
+
+					if (target_iconst) {
+						// Found global constant
+						xml_output.append("<see cref=\"" BINDINGS_NAMESPACE "." BINDINGS_GLOBAL_SCOPE_CLASS ".");
+						xml_output.append(target_iconst->proxy_name);
+						xml_output.append("\"/>");
+					} else {
+						// Try to find as global enum constant
+						const EnumInterface *target_ienum = NULL;
+
+						for (const List<EnumInterface>::Element *E = global_enums.front(); E; E = E->next()) {
+							target_ienum = &E->get();
+							target_iconst = find_constant_by_name(target_name, target_ienum->constants);
+							if (target_iconst)
+								break;
+						}
+
+						if (target_iconst) {
+							xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
+							xml_output.append(target_ienum->cname);
+							xml_output.append(".");
+							xml_output.append(target_iconst->proxy_name);
+							xml_output.append("\"/>");
+						} else {
+							ERR_PRINTS("Cannot resolve global constant reference in documentation: " + link_target);
+
+							xml_output.append("<c>");
+							xml_output.append(link_target);
+							xml_output.append("</c>");
+						}
+					}
+				} else {
+					String target_name = (String)target_cname;
+
+					// Try to find the constant in the current class
+					const ConstantInterface *target_iconst = find_constant_by_name(target_name, target_itype->constants);
+
+					if (target_iconst) {
+						// Found constant in current class
+						xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
+						xml_output.append(target_itype->proxy_name);
+						xml_output.append(".");
+						xml_output.append(target_iconst->proxy_name);
+						xml_output.append("\"/>");
+					} else {
+						// Try to find as enum constant in the current class
+						const EnumInterface *target_ienum = NULL;
+
+						for (const List<EnumInterface>::Element *E = target_itype->enums.front(); E; E = E->next()) {
+							target_ienum = &E->get();
+							target_iconst = find_constant_by_name(target_name, target_ienum->constants);
+							if (target_iconst)
+								break;
+						}
+
+						if (target_iconst) {
+							xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
+							xml_output.append(target_itype->proxy_name);
+							xml_output.append(".");
+							xml_output.append(target_ienum->cname);
+							xml_output.append(".");
+							xml_output.append(target_iconst->proxy_name);
+							xml_output.append("\"/>");
+						} else {
+							ERR_PRINTS("Cannot resolve constant reference in documentation: " + link_target);
+
+							xml_output.append("<c>");
+							xml_output.append(link_target);
+							xml_output.append("</c>");
+						}
+					}
+				}
 			}
 
 			pos = brk_end + 1;
@@ -414,7 +505,7 @@ String BindingsGenerator::bbcode_to_xml(const String &p_bbcode, const TypeInterf
 			} else if (tag == "Nil") {
 				xml_output.append("<see langword=\"null\"/>");
 			} else if (tag.begins_with("@")) {
-				// @Global Scope, @GDScript, etc
+				// @GlobalScope, @GDScript, etc
 				xml_output.append("<c>");
 				xml_output.append(tag);
 				xml_output.append("</c>");
diff --git a/modules/mono/editor/bindings_generator.h b/modules/mono/editor/bindings_generator.h
index 7eaebeabbd..42071f9c0d 100644
--- a/modules/mono/editor/bindings_generator.h
+++ b/modules/mono/editor/bindings_generator.h
@@ -497,6 +497,7 @@ class BindingsGenerator {
 		StringName type_Object;
 		StringName type_Reference;
 		StringName type_String;
+		StringName type_at_GlobalScope;
 		StringName enum_Error;
 
 		NameCache() {
@@ -509,6 +510,7 @@ class BindingsGenerator {
 			type_Object = StaticCString::create("Object");
 			type_Reference = StaticCString::create("Reference");
 			type_String = StaticCString::create("String");
+			type_at_GlobalScope = StaticCString::create("@GlobalScope");
 			enum_Error = StaticCString::create("Error");
 		}
 
@@ -527,6 +529,15 @@ class BindingsGenerator {
 		return NULL;
 	}
 
+	const ConstantInterface *find_constant_by_name(const String &p_name, const List<ConstantInterface> &p_constants) const {
+		for (const List<ConstantInterface>::Element *E = p_constants.front(); E; E = E->next()) {
+			if (E->get().name == p_name)
+				return &E->get();
+		}
+
+		return NULL;
+	}
+
 	inline String get_unique_sig(const TypeInterface &p_type) {
 		if (p_type.is_reference)
 			return "Ref";