Index hover (#92)

Author: 16bit-ykiko

include/Feature/Hover.h

@@ -1,95 +1,89 @@
 #pragma once
 
-#include "Basic/Document.h"
 #include "AST/SymbolKind.h"
+#include "Basic/SourceCode.h"
+#include "Index/Shared.h"
 
 namespace clice {
 
 class ASTInfo;
 
-namespace proto {
-
-// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#hoverParams
-struct HoverParams {
-    // The text document.
-    URI textDocument;
-
-    // The position inside the text document.
-    Position position;
-};
-
-}  // namespace proto
-
 namespace config {
 
-/// For a full memory layout infomation, the render kind decides how to display the value. By
-/// default, show both decimal and hexadecimal. e.g:
-///         size = 4 (0x4), align = 4 (0x4), offset: 0 (0x0)
-/// while show decimal only:
-///         size = 4, align = 4, offset: 0
-/// while show hexadecimal only:
-///         size = 0x4, align = 0x4, offset: 0x0
-///
-/// And bit field is always displayed in decimal.
-///         size = 1 bit (+5 bits padding), align = 1 byte, offset: 4 byte + 2 bit
-enum class MemoryLayoutRenderKind : uint8_t {
-    Both = 0,
-    Decimal,
-    Hexadecimal,
-};
+struct HoverOptions {};
 
-struct HoverOption {
-    /// The maximum number of fields to show in the hover of a class/struct/enum. 0 means show all.
-    uint16_t maxFieldsCount = 0;
+}  // namespace config
 
-    /// TODO:
-    /// The maximum number of derived classes to show in the hover of a pure virtual class.
-    // uint16_t maxDerivedClassNum;
+namespace feature {
+
+struct HoverItem {
+    enum class HoverKind : uint8_t {
+        /// The typename of a variable or a type alias.
+        Type,
+        /// Size of type or variable.
+        Size,
+        /// Align of type or variable.
+        Align,
+        /// Offset of field in a class/struct.
+        Offset,
+        /// Bit width of a bit field.
+        BitWidth,
+        /// The index of a field in a class/struct.
+        FieldIndex,
+        /// The value of an enum item.
+        EnumValue,
+    };
+
+    using enum HoverKind;
+
+    HoverKind kind;
+
+    std::string value;
+};
 
-    /// Decide how to render the memory layout.
-    MemoryLayoutRenderKind memoryLayoutRenderKind = MemoryLayoutRenderKind::Both;
+/// Hover information for a symbol.
+struct Hover {
+    /// Title
+    SymbolKind kind;
+    std::string name;
 
-    /// Show associated document.
-    bool documentation : 1 = true;
+    /// Extra information.
+    std::vector<HoverItem> items;
 
-    /// TODO:
-    /// Show overloaded virtual method for class/struct.
-    bool overloadVirtualMethod : 1 = true;
+    /// Raw document in the source code.
+    std::string document;
 
-    /// Show documentation link for key words, this will link to corresponding page of
-    /// `https://en.cppreference.com/w/cpp/keyword/`.
-    bool keywords : 1 = true;
+    /// The full qualified name of the declaration.
+    std::string qualifier;
 
-    /// TODO:
-    /// Show links instead of codeblock in hover information for mentioned symbols.
-    bool useLink : 1 = true;
+    /// The source code of the declaration.
+    std::string source;
 };
 
-}  // namespace config
+/// Hover information for all symbols in the file.
+struct Hovers {
+    struct Occurrence {
+        LocalSourceRange range;
+        uint32_t index;
+    };
 
-namespace feature::hover {
+    /// Hover information for all symbols in the file.
+    std::vector<Hover> hovers;
 
-/// TODO:
-/// Implement the action for hovering over elements.
-// struct HoverAction {
-//     // Goto type
-//     // Find reference
-// };
-
-struct Result {
-    std::string markdown;
+    /// A map between the file offset and the index of the hover.
+    std::vector<Occurrence> occurrences;
 };
 
-/// Get the hover information of a declaration with given option.
-Result hover(const clang::Decl* decl, const config::HoverOption& option);
+/// Generate the hover information for the given declaration(for test).
+Hover hover(ASTInfo& AST, const clang::NamedDecl* decl);
 
-/// Compute inlay hints for MainfileID in given param and config.
-std::optional<Result> hover(const proto::HoverParams& param,
-                            ASTInfo& AST,
-                            const config::HoverOption& option);
+/// Generate the hover information for the symbol at the given offset.
+Hover hover(ASTInfo& AST, uint32_t offset);
 
-proto::MarkupContent toLspType(Result hover);
+/// Generate the hover information for all files in the given AST.
+index::Shared<Hovers> indexHover(ASTInfo& AST);
 
-}  // namespace feature::hover
+}  // namespace feature
 
 }  // namespace clice
+

include/Server/LSPConverter.h

@@ -17,6 +17,8 @@ class LSPConverter {
 
     Result convert(llvm::StringRef path, llvm::ArrayRef<feature::SemanticToken> tokens);
 
+    Result convert(const feature::Hover& hover);
+
 private:
     proto::PositionEncodingKind kind;
 };