mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-04-25 14:05:15 +00:00
b35293d945
This moves all code comprehension-related code to a new library, LibCodeComprehension. This also moves some types related to code comprehension tasks (such as autocomplete, find declaration) out of LibGUI and into LibCodeComprehension.
57 lines
2 KiB
C++
57 lines
2 KiB
C++
/*
|
|
* Copyright (c) 2021, Itamar S. <itamar8910@gmail.com>
|
|
* Copyright (c) 2022, the SerenityOS developers.
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "FileDB.h"
|
|
#include "Types.h"
|
|
#include <AK/Function.h>
|
|
#include <AK/HashMap.h>
|
|
#include <AK/Vector.h>
|
|
#include <LibGUI/TextPosition.h>
|
|
|
|
namespace CodeComprehension {
|
|
|
|
class CodeComprehensionEngine {
|
|
AK_MAKE_NONCOPYABLE(CodeComprehensionEngine);
|
|
AK_MAKE_NONMOVABLE(CodeComprehensionEngine);
|
|
|
|
public:
|
|
CodeComprehensionEngine(FileDB const& filedb, bool store_all_declarations = false);
|
|
virtual ~CodeComprehensionEngine() = default;
|
|
|
|
virtual Vector<AutocompleteResultEntry> get_suggestions(String const& file, GUI::TextPosition const& autocomplete_position) = 0;
|
|
|
|
// TODO: In the future we can pass the range that was edited and only re-parse what we have to.
|
|
virtual void on_edit([[maybe_unused]] String const& file) {};
|
|
virtual void file_opened([[maybe_unused]] String const& file) {};
|
|
|
|
virtual Optional<ProjectLocation> find_declaration_of(String const&, GUI::TextPosition const&) { return {}; }
|
|
|
|
struct FunctionParamsHint {
|
|
Vector<String> params;
|
|
size_t current_index { 0 };
|
|
};
|
|
virtual Optional<FunctionParamsHint> get_function_params_hint(String const&, GUI::TextPosition const&) { return {}; }
|
|
|
|
virtual Vector<TokenInfo> get_tokens_info(String const&) { return {}; }
|
|
|
|
Function<void(String const&, Vector<Declaration>&&)> set_declarations_of_document_callback;
|
|
Function<void(String const&, Vector<TodoEntry>&&)> set_todo_entries_of_document_callback;
|
|
|
|
protected:
|
|
FileDB const& filedb() const { return m_filedb; }
|
|
void set_declarations_of_document(String const&, Vector<Declaration>&&);
|
|
void set_todo_entries_of_document(String const&, Vector<TodoEntry>&&);
|
|
HashMap<String, Vector<Declaration>> const& all_declarations() const { return m_all_declarations; }
|
|
|
|
private:
|
|
HashMap<String, Vector<Declaration>> m_all_declarations;
|
|
FileDB const& m_filedb;
|
|
bool m_store_all_declarations { false };
|
|
};
|
|
}
|