LanguageServers: Rename AutoCompleteEngine => CodeComprehensionEngine

This feels like a better name since the "autocomplete engine" can, in addition to providing autocomplete suggestions, also find declarations of symbols and report back the symbols that are defined in a document. Also, Cpp/ParserAutoComplete has been renamed to CppComprehensionEngine and Shell/AutoComplete has been renamed to ShellComprehensionEngine.
2025-07-26 12:07:45 +00:00 · 2021-05-16 17:25:24 +03:00 · 2021-05-16 17:25:24 +03:00 · 400d3ddb08
commit 400d3ddb08
parent b1531b78f6
13 changed files with 82 additions and 82 deletions
--- a/Userland/DevTools/HackStudio/LanguageServers/Cpp/CppComprehensionEngine.h
+++ b/Userland/DevTools/HackStudio/LanguageServers/Cpp/CppComprehensionEngine.h
@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2021, Itamar S. <itamar8910@gmail.com>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/Function.h>
+#include <AK/String.h>
+#include <AK/Vector.h>
+#include <DevTools/HackStudio/AutoCompleteResponse.h>
+#include <DevTools/HackStudio/LanguageServers/CodeComprehensionEngine.h>
+#include <DevTools/HackStudio/LanguageServers/FileDB.h>
+#include <LibCpp/AST.h>
+#include <LibCpp/Parser.h>
+#include <LibCpp/Preprocessor.h>
+#include <LibGUI/TextPosition.h>
+
+namespace LanguageServers::Cpp {
+
+using namespace ::Cpp;
+
+class CppComprehensionEngine : public CodeComprehensionEngine {
+public:
+    CppComprehensionEngine(const FileDB& filedb);
+
+    virtual Vector<GUI::AutocompleteProvider::Entry> get_suggestions(const String& file, const GUI::TextPosition& autocomplete_position) override;
+    virtual void on_edit(const String& file) override;
+    virtual void file_opened([[maybe_unused]] const String& file) override;
+    virtual Optional<GUI::AutocompleteProvider::ProjectLocation> find_declaration_of(const String& filename, const GUI::TextPosition& identifier_position) override;
+
+private:
+    struct DocumentData {
+        const String& filename() const { return m_filename; }
+        const String& text() const { return m_text; }
+        const Preprocessor& preprocessor() const
+        {
+            VERIFY(m_preprocessor);
+            return *m_preprocessor;
+        }
+        Preprocessor& preprocessor()
+        {
+            VERIFY(m_preprocessor);
+            return *m_preprocessor;
+        }
+        const Parser& parser() const
+        {
+            VERIFY(m_parser);
+            return *m_parser;
+        }
+        Parser& parser()
+        {
+            VERIFY(m_parser);
+            return *m_parser;
+        }
+
+        String m_filename;
+        String m_text;
+        OwnPtr<Preprocessor> m_preprocessor;
+        OwnPtr<Parser> m_parser;
+
+        // FIXME: This HashTable must be re-computed if a declaration from a header file is modified
+        HashTable<NonnullRefPtr<Declaration>> m_declarations_from_headers;
+    };
+
+    Vector<GUI::AutocompleteProvider::Entry> autocomplete_property(const DocumentData&, const MemberExpression&, const String partial_text) const;
+    Vector<GUI::AutocompleteProvider::Entry> autocomplete_name(const DocumentData&, const ASTNode&, const String& partial_text) const;
+    String type_of(const DocumentData&, const Expression&) const;
+    String type_of_property(const DocumentData&, const Identifier&) const;
+    String type_of_variable(const Identifier&) const;
+    bool is_property(const ASTNode&) const;
+    bool is_empty_property(const DocumentData&, const ASTNode&, const Position& autocomplete_position) const;
+    RefPtr<Declaration> find_declaration_of(const DocumentData&, const ASTNode&) const;
+
+    enum class RecurseIntoScopes {
+        No,
+        Yes
+    };
+    NonnullRefPtrVector<Declaration> get_available_declarations(const DocumentData&, const ASTNode&, RecurseIntoScopes) const;
+
+    struct PropertyInfo {
+        StringView name;
+        RefPtr<Type> type;
+    };
+    Vector<PropertyInfo> properties_of_type(const DocumentData& document, const String& type) const;
+    NonnullRefPtrVector<Declaration> get_global_declarations_including_headers(const DocumentData&, RecurseIntoScopes) const;
+    NonnullRefPtrVector<Declaration> get_global_declarations(const DocumentData&, RecurseIntoScopes) const;
+    NonnullRefPtrVector<Declaration> get_declarations_recursive(const ASTNode&) const;
+
+    const DocumentData* get_document_data(const String& file) const;
+    const DocumentData* get_or_create_document_data(const String& file);
+    void set_document_data(const String& file, OwnPtr<DocumentData>&& data);
+
+    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&);
+    GUI::AutocompleteProvider::DeclarationType type_of_declaration(const Declaration&);
+    String scope_of_declaration(const Declaration&) const;
+    String scope_of_name_or_identifier(const ASTNode& node) const;
+    Optional<GUI::AutocompleteProvider::ProjectLocation> find_preprocessor_definition(const DocumentData&, const GUI::TextPosition&);
+
+    OwnPtr<DocumentData> create_document_data(String&& text, const String& filename);
+    Optional<Vector<GUI::AutocompleteProvider::Entry>> autocomplete_property(const DocumentData&, const ASTNode&, Optional<Token> containing_token) const;
+    Optional<Vector<GUI::AutocompleteProvider::Entry>> autocomplete_name(const DocumentData&, const ASTNode&, Optional<Token> containing_token) const;
+
+    HashMap<String, OwnPtr<DocumentData>> m_documents;
+};
+
+}