LanguageServer.hpp

浏览该文件的文档.

#pragma once
 
#include "common/Export.h"
#include "common/ScriptCompiler.h"
#include "devtools/LanguageIndex.h"
#include "devtools/LanguageText.h"
 
#include <cstdint>
#include <iosfwd>
#include <memory>
#include <optional>
#include <ostream>
#include <string>
#include <string_view>
#include <vector>
 
namespace eve::dev {
 
enum class LspDispatch : uint8_t { Continue = 0, Exit };
 
inline std::ostream& operator<<(std::ostream& os, LspDispatch value) {
    switch (value) {
        case LspDispatch::Continue:
            return os << "Continue";
        case LspDispatch::Exit:
            return os << "Exit";
    }
    return os << "LspDispatch(" << static_cast<int>(value) << ")";
}
 
struct LanguageSignatureParameter {
    std::string label;
    std::string documentation;
};
 
struct LanguageSignatureHelp {
    std::string                              label;
    std::string                              documentation;
    std::vector<LanguageSignatureParameter>  parameters;
    int                                      activeParameter = 0;
};
 
class EVENGINE_API_FOUNDATION LanguageServer {
public:
    explicit LanguageServer(std::string projectRoot);
    ~LanguageServer();
 
    LanguageServer(const LanguageServer&)            = delete;
    LanguageServer& operator=(const LanguageServer&) = delete;
 
    const std::string& projectRoot() const noexcept;
 
    static std::string fileUriFromPath(std::string_view path);
 
    void openDocument(std::string uri, std::string text);
    void changeDocument(std::string uri, std::string text);
    void changeDocument(std::string uri, lsp::Range range, std::string text);
    void closeDocument(std::string uri);
 
    std::vector<script::ScriptDiagnostic> diagnosticsFor(std::string_view uri) const;
    std::vector<script::ScriptCompletion> complete(std::string_view uri, lsp::Position position) const;
    std::optional<script::ScriptHover>    hover(std::string_view uri, lsp::Position position) const;
    std::optional<lsp::Location>          definition(std::string_view uri, lsp::Position position) const;
    std::vector<lsp::Location>            references(std::string_view uri, lsp::Position position,
                                                     bool includeDeclaration) const;
    std::optional<std::vector<lsp::TextEdit>> rename(std::string_view uri, lsp::Position position,
                                                     std::string_view newName) const;
    std::vector<script::ScriptSymbolMetadata> documentSymbols(std::string_view uri) const;
    std::optional<LanguageSignatureHelp>      signatureHelp(std::string_view uri, lsp::Position position) const;
    std::vector<lsp::TextEdit> formatDocument(std::string_view uri, lsp::FormatOptions options = {},
                                              const lsp::Range* range = nullptr) const;
    std::vector<lsp::FoldingRange> foldingRanges(std::string_view uri) const;
    std::vector<lsp::SemanticToken> semanticTokens(std::string_view uri) const;
 
    [[nodiscard]] LspDispatch handleMessage(std::string_view jsonBody, std::ostream& output);
 
    int runStdio(std::istream& input, std::ostream& output);
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace eve::dev