From cbbc0b0135ece5bb91f4f89e437974266ce58ea1 Mon Sep 17 00:00:00 2001
From: Serhii Snitsaruk <limbonaut@pm.me>
Date: Sat, 13 Jan 2024 22:40:27 +0100
Subject: [PATCH] Link to online docs in the code

---
 editor/limbo_ai_editor_plugin.cpp | 26 +++++++++++++++++---------
 editor/limbo_ai_editor_plugin.h   |  4 +++-
 editor/task_palette.cpp           |  4 ++--
 util/limbo_string_names.cpp       |  1 +
 util/limbo_string_names.h         |  1 +
 util/limbo_utility.cpp            | 26 ++++++++++++++++++++++++++
 util/limbo_utility.h              |  6 ++++++
 7 files changed, 56 insertions(+), 12 deletions(-)

diff --git a/editor/limbo_ai_editor_plugin.cpp b/editor/limbo_ai_editor_plugin.cpp
index af3ed12..4095c21 100644
--- a/editor/limbo_ai_editor_plugin.cpp
+++ b/editor/limbo_ai_editor_plugin.cpp
@@ -373,7 +373,7 @@ void LimboAIEditor::_on_tree_rmb(const Vector2 &p_menu_pos) {
 	menu->add_icon_shortcut(theme_cache.rename_task_icon, LW_GET_SHORTCUT("limbo_ai/rename_task"), ACTION_RENAME);
 	menu->add_icon_item(theme_cache.change_type_icon, TTR("Change Type"), ACTION_CHANGE_TYPE);
 	menu->add_icon_item(theme_cache.edit_script_icon, TTR("Edit Script"), ACTION_EDIT_SCRIPT);
-	menu->add_icon_item(theme_cache.open_doc_icon, TTR("Open Documentation"), ACTION_OPEN_DOC);
+	menu->add_icon_item(theme_cache.doc_icon, TTR("Open Documentation"), ACTION_OPEN_DOC);
 	menu->set_item_disabled(menu->get_item_index(ACTION_EDIT_SCRIPT), task->get_script() == Variant());
 
 	menu->add_separator();
@@ -436,14 +436,17 @@ void LimboAIEditor::_action_selected(int p_id) {
 			Ref<BTTask> task = task_tree->get_selected();
 			ERR_FAIL_COND(task.is_null());
 			String help_class;
-			String res_path = task->get_path();
-			if (res_path.begins_with("res://")) {
-				help_class = "\"" + res_path.get_basename().to_pascal_case() + "\"";
-			} else {
+
+			Ref<Script> sc = GET_SCRIPT(task);
+			if (sc.is_valid() && sc->get_path().is_absolute_path()) {
+				help_class = sc->get_path();
+			}
+			if (help_class.is_empty()) {
 				// Assuming context task is core class.
 				help_class = task->get_class();
 			}
-			SHOW_DOC("class_name:" + help_class);
+
+			LimboUtility::get_singleton()->open_doc_class(help_class);
 		} break;
 		case ACTION_MOVE_UP: {
 			Ref<BTTask> sel = task_tree->get_selected();
@@ -590,7 +593,10 @@ void LimboAIEditor::_probability_popup_closed() {
 void LimboAIEditor::_misc_option_selected(int p_id) {
 	switch (p_id) {
 		case MISC_INTRODUCTION: {
-			SHOW_DOC("class_name:BehaviorTree");
+			LimboUtility::get_singleton()->open_doc_introduction();
+		} break;
+		case MISC_ONLINE_DOCUMENTATION: {
+			LimboUtility::get_singleton()->open_doc_online();
 		} break;
 		case MISC_OPEN_DEBUGGER: {
 			ERR_FAIL_COND(LimboDebuggerPlugin::get_singleton() == nullptr);
@@ -938,7 +944,8 @@ void LimboAIEditor::_update_misc_menu() {
 
 	misc_menu->clear();
 
-	misc_menu->add_icon_item(theme_cache.open_doc_icon, TTR("Introduction"), MISC_INTRODUCTION);
+	misc_menu->add_icon_item(theme_cache.introduction_icon, TTR("Introduction"), MISC_INTRODUCTION);
+	misc_menu->add_icon_item(theme_cache.doc_icon, TTR("Online Documentation"), MISC_ONLINE_DOCUMENTATION);
 
 	misc_menu->add_separator();
 #ifdef LIMBOAI_MODULE
@@ -994,7 +1001,8 @@ void LimboAIEditor::_do_update_theme_item_cache() {
 	theme_cache.move_task_down_icon = get_theme_icon(LW_NAME(MoveDown), LW_NAME(EditorIcons));
 	theme_cache.move_task_up_icon = get_theme_icon(LW_NAME(MoveUp), LW_NAME(EditorIcons));
 	theme_cache.open_debugger_icon = get_theme_icon(LW_NAME(Debug), LW_NAME(EditorIcons));
-	theme_cache.open_doc_icon = get_theme_icon(LW_NAME(Help), LW_NAME(EditorIcons));
+	theme_cache.doc_icon = get_theme_icon(LW_NAME(Help), LW_NAME(EditorIcons));
+	theme_cache.introduction_icon = get_theme_icon(LW_NAME(Info), LW_NAME(EditorIcons));
 	theme_cache.remove_task_icon = get_theme_icon(LW_NAME(Remove), LW_NAME(EditorIcons));
 	theme_cache.rename_task_icon = get_theme_icon(LW_NAME(Rename), LW_NAME(EditorIcons));
 	theme_cache.change_type_icon = get_theme_icon(LW_NAME(Reload), LW_NAME(EditorIcons));
diff --git a/editor/limbo_ai_editor_plugin.h b/editor/limbo_ai_editor_plugin.h
index 142dfa1..b6f6583 100644
--- a/editor/limbo_ai_editor_plugin.h
+++ b/editor/limbo_ai_editor_plugin.h
@@ -84,6 +84,7 @@ private:
 
 	enum MiscMenu {
 		MISC_INTRODUCTION,
+		MISC_ONLINE_DOCUMENTATION,
 		MISC_OPEN_DEBUGGER,
 		MISC_PROJECT_SETTINGS,
 		MISC_CREATE_SCRIPT_TEMPLATE,
@@ -96,7 +97,8 @@ private:
 		Ref<Texture2D> move_task_down_icon;
 		Ref<Texture2D> move_task_up_icon;
 		Ref<Texture2D> open_debugger_icon;
-		Ref<Texture2D> open_doc_icon;
+		Ref<Texture2D> doc_icon;
+		Ref<Texture2D> introduction_icon;
 		Ref<Texture2D> percent_icon;
 		Ref<Texture2D> remove_task_icon;
 		Ref<Texture2D> rename_task_icon;
diff --git a/editor/task_palette.cpp b/editor/task_palette.cpp
index fe6e4c2..ee8b104 100644
--- a/editor/task_palette.cpp
+++ b/editor/task_palette.cpp
@@ -190,12 +190,12 @@ void TaskPalette::_menu_action_selected(int p_id) {
 		case MENU_OPEN_DOC: {
 			String help_class;
 			if (context_task.begins_with("res://")) {
-				help_class = "\"" + context_task.get_basename().to_pascal_case() + "\"";
+				help_class = context_task;
 			} else {
 				// Assuming context task is core class.
 				help_class = context_task;
 			}
-			SHOW_DOC("class_name:" + help_class);
+			LimboUtility::get_singleton()->open_doc_class(help_class);
 		} break;
 		case MENU_EDIT_SCRIPT: {
 			ERR_FAIL_COND(!context_task.begins_with("res://"));
diff --git a/util/limbo_string_names.cpp b/util/limbo_string_names.cpp
index 97116db..4bcde51 100644
--- a/util/limbo_string_names.cpp
+++ b/util/limbo_string_names.cpp
@@ -79,6 +79,7 @@ LimboStringNames::LimboStringNames() {
 	Help = SN("Help");
 	icon_max_width = SN("icon_max_width");
 	id_pressed = SN("id_pressed");
+	Info = SN("Info");
 	item_collapsed = SN("item_collapsed");
 	item_selected = SN("item_selected");
 	LimboDeselectAll = SN("LimboDeselectAll");
diff --git a/util/limbo_string_names.h b/util/limbo_string_names.h
index 855ef66..3d16585 100644
--- a/util/limbo_string_names.h
+++ b/util/limbo_string_names.h
@@ -93,6 +93,7 @@ public:
 	StringName Help;
 	StringName icon_max_width;
 	StringName id_pressed;
+	StringName Info;
 	StringName item_collapsed;
 	StringName item_selected;
 	StringName LimboDeselectAll;
diff --git a/util/limbo_utility.cpp b/util/limbo_utility.cpp
index a96dbe8..76798ab 100644
--- a/util/limbo_utility.cpp
+++ b/util/limbo_utility.cpp
@@ -16,6 +16,7 @@
 #ifdef LIMBOAI_MODULE
 #include "core/error/error_macros.h"
 #include "core/object/script_language.h"
+#include "core/os/os.h"
 #include "core/variant/variant.h"
 #include "scene/resources/texture.h"
 
@@ -30,6 +31,7 @@
 #include "godot_cpp/classes/project_settings.hpp"
 #include "godot_cpp/variant/dictionary.hpp"
 #include "godot_cpp/variant/utility_functions.hpp"
+#include <godot_cpp/classes/os.hpp>
 #include <godot_cpp/classes/resource_loader.hpp>
 #include <godot_cpp/classes/script.hpp>
 #include <godot_cpp/classes/texture2d.hpp>
@@ -314,6 +316,30 @@ Ref<Shortcut> LimboUtility::get_shortcut(const String &p_path) const {
 	return nullptr;
 }
 
+void LimboUtility::open_doc_introduction() {
+	OS::get_singleton()->shell_open(vformat("https://limboai.readthedocs.io/en/%s/classes/class_behaviortree.html",
+			LIMBO_DOC_VERSION));
+}
+
+void LimboUtility::open_doc_online() {
+	OS::get_singleton()->shell_open(vformat("https://limboai.readthedocs.io/en/%s/index.html",
+			LIMBO_DOC_VERSION));
+}
+
+void LimboUtility::open_doc_class(const String &p_class_name) {
+	if (p_class_name.begins_with("res://")) {
+		SHOW_DOC(vformat("class_name:\"%s\"", p_class_name));
+		return;
+	}
+
+#ifdef LIMBOAI_MODULE
+	SHOW_DOC("class_name:" + p_class_name);
+#elif LIMBOAI_GDEXTENSION
+	OS::get_singleton()->shell_open(vformat("https://limboai.readthedocs.io/en/%s/classes/class_%s.html",
+			LIMBO_DOC_VERSION, p_class_name.to_lower()));
+#endif
+}
+
 void LimboUtility::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("decorate_var", "p_variable"), &LimboUtility::decorate_var);
 	ClassDB::bind_method(D_METHOD("get_status_name", "p_status"), &LimboUtility::get_status_name);
diff --git a/util/limbo_utility.h b/util/limbo_utility.h
index 2ab40be..84b4ad4 100644
--- a/util/limbo_utility.h
+++ b/util/limbo_utility.h
@@ -36,6 +36,8 @@ using namespace godot;
 
 #define LOGICAL_XOR(a, b) (a) ? !(b) : (b)
 
+#define LIMBO_DOC_VERSION "latest"
+
 class LimboUtility : public Object {
 	GDCLASS(LimboUtility, Object);
 
@@ -88,6 +90,10 @@ public:
 	bool is_shortcut(const String &p_path, const Ref<InputEvent> &p_event) const;
 	Ref<Shortcut> get_shortcut(const String &p_path) const;
 
+	void open_doc_introduction();
+	void open_doc_online();
+	void open_doc_class(const String &p_class_name);
+
 	LimboUtility();
 	~LimboUtility();
 };