LanguageServers: Add function to collect TODO entries in a document

guerinoni · linusg · commit 26a7356e90a1 · 2021-06-23T19:00:11.000+01:00
diff --git a/Userland/DevTools/HackStudio/CMakeLists.txt b/Userland/DevTools/HackStudio/CMakeLists.txt
@@ -43,6 +43,7 @@ set(SOURCES
     ProjectFile.cpp
     ProjectTemplate.cpp
     TerminalWrapper.cpp
+    ToDoEntries.cpp
     main.cpp
 )
 
diff --git a/Userland/DevTools/HackStudio/LanguageClient.cpp b/Userland/DevTools/HackStudio/LanguageClient.cpp
@@ -7,6 +7,7 @@
 #include "LanguageClient.h"
 #include "HackStudio.h"
 #include "ProjectDeclarations.h"
+#include "ToDoEntries.h"
 #include <AK/String.h>
 #include <AK/Vector.h>
 #include <DevTools/HackStudio/LanguageServers/LanguageServerEndpoint.h>
@@ -98,6 +99,11 @@ void ServerConnection::declarations_in_document(const String& filename, const Ve
     ProjectDeclarations::the().set_declared_symbols(filename, declarations);
 }
 
+void ServerConnection::todo_entries_in_document(const String& filename, const Vector<String>& todo_entries)
+{
+    ToDoEntries::the().set_entries(filename, move(todo_entries));
+}
+
 void LanguageClient::search_declaration(const String& path, size_t line, size_t column)
 {
     if (!m_connection_wrapper.connection())
diff --git a/Userland/DevTools/HackStudio/LanguageClient.h b/Userland/DevTools/HackStudio/LanguageClient.h
@@ -46,6 +46,7 @@ class ServerConnection
     virtual void auto_complete_suggestions(Vector<GUI::AutocompleteProvider::Entry> const&) override;
     virtual void declaration_location(GUI::AutocompleteProvider::ProjectLocation const&) override;
     virtual void declarations_in_document(String const&, Vector<GUI::AutocompleteProvider::Declaration> const&) override;
+    virtual void todo_entries_in_document(String const&, Vector<String> const&) override;
     void set_wrapper(ServerConnectionWrapper& wrapper) { m_wrapper = &wrapper; }
 
     String m_project_path;
diff --git a/Userland/DevTools/HackStudio/LanguageServers/CodeComprehensionEngine.cpp b/Userland/DevTools/HackStudio/LanguageServers/CodeComprehensionEngine.cpp
@@ -31,4 +31,11 @@ void CodeComprehensionEngine::set_declarations_of_document(const String& filenam
         m_all_declarations.set(filename, declarations);
     set_declarations_of_document_callback(filename, move(declarations));
 }
+
+void CodeComprehensionEngine::set_todo_entries_of_document(const String& filename, Vector<String>&& todo_entries)
+{
+    VERIFY(set_todo_entries_of_document_callback);
+    set_todo_entries_of_document_callback(filename, move(todo_entries));
+}
+
 }
diff --git a/Userland/DevTools/HackStudio/LanguageServers/CodeComprehensionEngine.h b/Userland/DevTools/HackStudio/LanguageServers/CodeComprehensionEngine.h
@@ -30,10 +30,12 @@ class CodeComprehensionEngine {
 
 public:
     Function<void(const String&, Vector<GUI::AutocompleteProvider::Declaration>&&)> set_declarations_of_document_callback;
+    Function<void(const String&, Vector<String>&&)> set_todo_entries_of_document_callback;
 
 protected:
     const FileDB& filedb() const { return m_filedb; }
     void set_declarations_of_document(const String&, Vector<GUI::AutocompleteProvider::Declaration>&&);
+    void set_todo_entries_of_document(const String&, Vector<String>&&);
     const HashMap<String, Vector<GUI::AutocompleteProvider::Declaration>>& all_declarations() const { return m_all_declarations; }
 
 private:
diff --git a/Userland/DevTools/HackStudio/LanguageServers/Cpp/ClientConnection.h b/Userland/DevTools/HackStudio/LanguageServers/Cpp/ClientConnection.h
@@ -22,6 +22,9 @@ class ClientConnection final : public LanguageServers::ClientConnection {
         m_autocomplete_engine->set_declarations_of_document_callback = [this](const String& filename, Vector<GUI::AutocompleteProvider::Declaration>&& declarations) {
             async_declarations_in_document(filename, move(declarations));
         };
+        m_autocomplete_engine->set_todo_entries_of_document_callback = [this](const String& filename, Vector<String>&& todo_entries) {
+            async_todo_entries_in_document(filename, move(todo_entries));
+        };
     }
 
     virtual ~ClientConnection() override = default;
diff --git a/Userland/DevTools/HackStudio/LanguageServers/Cpp/CppComprehensionEngine.cpp b/Userland/DevTools/HackStudio/LanguageServers/Cpp/CppComprehensionEngine.cpp
@@ -520,6 +520,11 @@ void CppComprehensionEngine::update_declared_symbols(DocumentData& document)
     set_declarations_of_document(document.filename(), move(declarations));
 }
 
+void CppComprehensionEngine::update_todo_entries(DocumentData& document)
+{
+    set_todo_entries_of_document(document.filename(), document.parser().get_todo_entries());
+}
+
 GUI::AutocompleteProvider::DeclarationType CppComprehensionEngine::type_of_declaration(const Declaration& decl)
 {
     if (decl.is_struct())
@@ -574,6 +579,7 @@ OwnPtr<CppComprehensionEngine::DocumentData> CppComprehensionEngine::create_docu
         root->dump();
 
     update_declared_symbols(*document_data);
+    update_todo_entries(*document_data);
 
     return document_data;
 }
diff --git a/Userland/DevTools/HackStudio/LanguageServers/Cpp/CppComprehensionEngine.h b/Userland/DevTools/HackStudio/LanguageServers/Cpp/CppComprehensionEngine.h
@@ -121,6 +121,7 @@ class CppComprehensionEngine : public CodeComprehensionEngine {
     OwnPtr<DocumentData> create_document_data_for(const String& file);
     String document_path_from_include_path(const StringView& include_path) const;
     void update_declared_symbols(DocumentData&);
+    void update_todo_entries(DocumentData&);
     GUI::AutocompleteProvider::DeclarationType type_of_declaration(const Declaration&);
     Vector<StringView> scope_of_node(const ASTNode&) const;
     Vector<StringView> scope_of_reference_to_symbol(const ASTNode&) const;
diff --git a/Userland/DevTools/HackStudio/LanguageServers/LanguageClient.ipc b/Userland/DevTools/HackStudio/LanguageServers/LanguageClient.ipc
@@ -3,4 +3,5 @@ endpoint LanguageClient
     auto_complete_suggestions(Vector<GUI::AutocompleteProvider::Entry> suggestions) =|
     declaration_location(GUI::AutocompleteProvider::ProjectLocation location) =|
     declarations_in_document(String filename, Vector<GUI::AutocompleteProvider::Declaration> declarations) =|
+    todo_entries_in_document(String filename, Vector<String> todo_entries) =|
 }
diff --git a/Userland/DevTools/HackStudio/LanguageServers/Shell/ClientConnection.h b/Userland/DevTools/HackStudio/LanguageServers/Shell/ClientConnection.h
@@ -21,6 +21,9 @@ class ClientConnection final : public LanguageServers::ClientConnection {
         m_autocomplete_engine->set_declarations_of_document_callback = [this](const String& filename, Vector<GUI::AutocompleteProvider::Declaration>&& declarations) {
             async_declarations_in_document(filename, move(declarations));
         };
+        m_autocomplete_engine->set_todo_entries_of_document_callback = [this](const String& filename, Vector<String>&& todo_entries) {
+            async_todo_entries_in_document(filename, move(todo_entries));
+        };
     }
     virtual ~ClientConnection() override = default;
 };
diff --git a/Userland/DevTools/HackStudio/ToDoEntries.cpp b/Userland/DevTools/HackStudio/ToDoEntries.cpp
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2021, Federico Guerinoni <guerinoni.federico@gmail.com>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include "ToDoEntries.h"
+
+namespace HackStudio {
+
+ToDoEntries& HackStudio::ToDoEntries::the()
+{
+    static ToDoEntries s_instance;
+    return s_instance;
+}
+
+void ToDoEntries::set_entries(const String& filename, const Vector<String>&& entries)
+{
+    m_document_to_entries.set(filename, move(entries));
+    if (on_update)
+        on_update();
+}
+
+Vector<ToDoEntryPair> ToDoEntries::get_entries()
+{
+    Vector<ToDoEntryPair> ret;
+    for (auto& it : m_document_to_entries)
+        for (auto& entry : it.value)
+            ret.append({ it.key, entry });
+
+    return ret;
+}
+
+}
diff --git a/Userland/DevTools/HackStudio/ToDoEntries.h b/Userland/DevTools/HackStudio/ToDoEntries.h
@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2021, Federico Guerinoni <guerinoni.federico@gmail.com>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/Function.h>
+#include <AK/HashMap.h>
+#include <AK/Noncopyable.h>
+#include <AK/String.h>
+
+namespace HackStudio {
+
+struct ToDoEntryPair {
+    String filename;
+    String comment;
+};
+
+class ToDoEntries {
+    AK_MAKE_NONCOPYABLE(ToDoEntries);
+
+public:
+    static ToDoEntries& the();
+
+    void set_entries(const String& filename, const Vector<String>&& entries);
+
+    Vector<ToDoEntryPair> get_entries();
+
+    Function<void()> on_update = nullptr;
+
+private:
+    ToDoEntries() = default;
+    HashMap<String, Vector<String>> m_document_to_entries;
+};
+
+}

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ set(SOURCES`
`43`	`43`	`ProjectFile.cpp`
`44`	`44`	`ProjectTemplate.cpp`
`45`	`45`	`TerminalWrapper.cpp`
	`46`	`+ ToDoEntries.cpp`
`46`	`47`	`main.cpp`
`47`	`48`	`)`
`48`	`49`
Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,11 @@ void CodeComprehensionEngine::set_declarations_of_document(const String& filenam`
`31`	`31`	`m_all_declarations.set(filename, declarations);`
`32`	`32`	`set_declarations_of_document_callback(filename, move(declarations));`
`33`	`33`	`}`
	`34`	`+`
	`35`	`+void CodeComprehensionEngine::set_todo_entries_of_document(const String& filename, Vector<String>&& todo_entries)`
	`36`	`+{`
	`37`	`+ VERIFY(set_todo_entries_of_document_callback);`
	`38`	`+ set_todo_entries_of_document_callback(filename, move(todo_entries));`
	`39`	`+}`
	`40`	`+`
`34`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ class ClientConnection final : public LanguageServers::ClientConnection {`
`22`	`22`	`m_autocomplete_engine->set_declarations_of_document_callback = [this](const String& filename, Vector<GUI::AutocompleteProvider::Declaration>&& declarations) {`
`23`	`23`	`async_declarations_in_document(filename, move(declarations));`
`24`	`24`	`};`
	`25`	`+ m_autocomplete_engine->set_todo_entries_of_document_callback = [this](const String& filename, Vector<String>&& todo_entries) {`
	`26`	`+ async_todo_entries_in_document(filename, move(todo_entries));`
	`27`	`+ };`
`25`	`28`	`}`
`26`	`29`
`27`	`30`	`virtual ~ClientConnection() override = default;`
Original file line number	Diff line number	Diff line change
`@@ -520,6 +520,11 @@ void CppComprehensionEngine::update_declared_symbols(DocumentData& document)`
`520`	`520`	`set_declarations_of_document(document.filename(), move(declarations));`
`521`	`521`	`}`
`522`	`522`
	`523`	`+void CppComprehensionEngine::update_todo_entries(DocumentData& document)`
	`524`	`+{`
	`525`	`+ set_todo_entries_of_document(document.filename(), document.parser().get_todo_entries());`
	`526`	`+}`
	`527`	`+`
`523`	`528`	`GUI::AutocompleteProvider::DeclarationType CppComprehensionEngine::type_of_declaration(const Declaration& decl)`
`524`	`529`	`{`
`525`	`530`	`if (decl.is_struct())`
`@@ -574,6 +579,7 @@ OwnPtr<CppComprehensionEngine::DocumentData> CppComprehensionEngine::create_docu`
`574`	`579`	`root->dump();`
`575`	`580`
`576`	`581`	`update_declared_symbols(*document_data);`
	`582`	`+ update_todo_entries(*document_data);`
`577`	`583`
`578`	`584`	`return document_data;`
`579`	`585`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,5 @@ endpoint LanguageClient`
`3`	`3`	`auto_complete_suggestions(Vector<GUI::AutocompleteProvider::Entry> suggestions) =\|`
`4`	`4`	`declaration_location(GUI::AutocompleteProvider::ProjectLocation location) =\|`
`5`	`5`	`declarations_in_document(String filename, Vector<GUI::AutocompleteProvider::Declaration> declarations) =\|`
	`6`	`+ todo_entries_in_document(String filename, Vector<String> todo_entries) =\|`
`6`	`7`	`}`