optimize hover and add test

Author: xuhuanzy

crates/emmylua_ls/src/handlers/hover/build_hover.rs

@@ -110,39 +110,39 @@ fn build_decl_hover(
 ) -> Option<()> {
     let decl = db.get_decl_index().get_decl(&decl_id)?;
 
-    let mut owner_member = None;
-    let mut owner_decl = None;
+    let mut origin_member = None;
+    let mut origin_decl = None;
 
     // 处理类型签名
-    if typ.is_function() {
-        let property_owner = get_decl_owner(builder.semantic_model, decl_id.clone());
-        match property_owner {
+    if is_function(&typ) {
+        let origin_decl_id = get_function_decl_owner(builder.semantic_model, decl_id.clone());
+        match origin_decl_id {
             Some(LuaSemanticDeclId::Member(member_id)) => {
-                owner_member = Some(db.get_member_index().get_member(&member_id).unwrap());
+                origin_member = Some(db.get_member_index().get_member(&member_id).unwrap());
             }
             Some(LuaSemanticDeclId::LuaDecl(decl_id)) => {
-                owner_decl = Some(db.get_decl_index().get_decl(&decl_id).unwrap());
+                origin_decl = Some(db.get_decl_index().get_decl(&decl_id).unwrap());
             }
             _ => {}
         }
         hover_function_type(
             builder,
             db,
             &typ,
-            owner_member,
-            if let Some(owner_decl) = owner_decl {
+            origin_member,
+            if let Some(owner_decl) = origin_decl {
                 owner_decl.get_name()
             } else {
                 decl.get_name()
             },
-            if let Some(owner_decl) = owner_decl {
+            if let Some(owner_decl) = origin_decl {
                 owner_decl.is_local()
             } else {
                 decl.is_local()
             },
         );
 
-        builder.set_location_path(owner_member);
+        builder.set_location_path(origin_member);
     } else if typ.is_const() {
         let const_value = hover_const_type(db, &typ);
         let prefix = if decl.is_local() {
@@ -174,12 +174,13 @@ fn build_decl_hover(
     builder
         .add_description(LuaSemanticDeclId::LuaDecl(decl_id))
         .or_else(|| {
-            owner_member.and_then(|m: &LuaMember| {
+            origin_member.and_then(|m: &LuaMember| {
                 builder.add_description(LuaSemanticDeclId::Member(m.get_id()))
             })
         })
         .or_else(|| {
-            owner_decl.and_then(|d| builder.add_description(LuaSemanticDeclId::LuaDecl(d.get_id())))
+            origin_decl
+                .and_then(|d| builder.add_description(LuaSemanticDeclId::LuaDecl(d.get_id())))
         });
 
     builder.add_signature_params_rets_description(typ);
@@ -199,54 +200,44 @@ fn build_member_hover(
         _ => return None,
     };
 
-    let mut function_member = None;
-    let mut owner_decl = None;
-    if typ.is_function()
-        || match &typ {
-            LuaType::Union(union) => {
-                union.get_types().len() > 1
-                    && union
-                        .get_types()
-                        .iter()
-                        .all(|t| matches!(t, LuaType::DocFunction(_)))
-            }
-            _ => false,
-        }
-    {
-        let property_owner = get_member_owner(&builder.semantic_model, member_id);
-        match property_owner {
+    let mut origin_function_member = None;
+    let mut origin_decl = None;
+    if is_function(&typ) {
+        let origin_decl_id = get_function_member_owner(&builder.semantic_model, member_id);
+        match origin_decl_id {
             Some(LuaSemanticDeclId::Member(member_id)) => {
-                function_member = Some(db.get_member_index().get_member(&member_id).unwrap());
+                origin_function_member =
+                    Some(db.get_member_index().get_member(&member_id).unwrap());
             }
             Some(LuaSemanticDeclId::LuaDecl(decl_id)) => {
-                owner_decl = Some(db.get_decl_index().get_decl(&decl_id).unwrap());
+                origin_decl = Some(db.get_decl_index().get_decl(&decl_id).unwrap());
             }
             _ => {}
         }
         hover_function_type(
             builder,
             db,
             &typ,
-            function_member.or_else(|| {
-                if owner_decl.is_none() {
+            origin_function_member.or_else(|| {
+                if origin_decl.is_none() {
                     Some(&member)
                 } else {
                     None
                 }
             }),
-            if let Some(owner_decl) = owner_decl {
+            if let Some(owner_decl) = origin_decl {
                 owner_decl.get_name()
             } else {
                 &member_name
             },
-            if let Some(owner_decl) = owner_decl {
+            if let Some(owner_decl) = origin_decl {
                 owner_decl.is_local()
             } else {
                 false
             },
         );
 
-        builder.set_location_path(Some(&function_member.as_ref().unwrap_or(&member)));
+        builder.set_location_path(Some(&origin_function_member.as_ref().unwrap_or(&member)));
     } else if typ.is_const() {
         let const_value = hover_const_type(db, &typ);
         builder.set_type_description(format!("(field) {}: {}", member_name, const_value));
@@ -265,7 +256,7 @@ fn build_member_hover(
     builder
         .add_description(LuaSemanticDeclId::Member(member_id))
         .or_else(|| {
-            function_member
+            origin_function_member
                 .and_then(|m| builder.add_description(LuaSemanticDeclId::Member(m.get_id())))
         });
 
@@ -355,7 +346,10 @@ pub fn add_signature_ret_description(
 }
 
 // 获取`decl`可能的来源
-fn get_decl_owner(semantic_model: &SemanticModel, decl_id: LuaDeclId) -> Option<LuaSemanticDeclId> {
+fn get_function_decl_owner(
+    semantic_model: &SemanticModel,
+    decl_id: LuaDeclId,
+) -> Option<LuaSemanticDeclId> {
     let root = semantic_model
         .get_db()
         .get_vfs()
@@ -368,18 +362,17 @@ fn get_decl_owner(semantic_model: &SemanticModel, decl_id: LuaDeclId) -> Option<
         .get_value_syntax_id()?
         .to_node_from_root(&root)?;
     let semantic_decl = semantic_model.find_decl(node.into(), SemanticDeclLevel::default());
-    // 似乎在`get_property_owner_id`推断时就已递归处理了, 但还是再处理一次
     match semantic_decl {
         Some(LuaSemanticDeclId::Member(member_id)) => {
-            get_member_owner(semantic_model, member_id).or(semantic_decl)
+            get_function_member_owner(semantic_model, member_id).or(semantic_decl)
         }
         Some(LuaSemanticDeclId::LuaDecl(_)) => semantic_decl,
         _ => None,
     }
 }
 
 // 获取`member_id`可能的来源
-fn get_member_owner(
+fn get_function_member_owner(
     semantic_model: &SemanticModel,
     member_id: LuaMemberId,
 ) -> Option<LuaSemanticDeclId> {
@@ -480,3 +473,14 @@ pub fn get_hover_type(builder: &HoverBuilder, semantic_model: &SemanticModel) ->
 
     None
 }
+
+fn is_function(typ: &LuaType) -> bool {
+    typ.is_function()
+        || match &typ {
+            LuaType::Union(union) => union
+                .get_types()
+                .iter()
+                .all(|t| matches!(t, LuaType::DocFunction(_))),
+            _ => false,
+        }
+}

crates/emmylua_ls/src/handlers/hover/test/hover_function_test.rs

@@ -0,0 +1,128 @@
+#[cfg(test)]
+mod tests {
+
+    use crate::handlers::hover::test::{HoverVirtualWorkspace, VirtualHoverResult};
+
+    #[test]
+    fn test_1() {
+        let mut ws = HoverVirtualWorkspace::new();
+        assert!(ws.check_hover(
+            r#"
+                ---@param a number 参数a
+                ---@return number a 返回值a
+                local function delete(a)
+                end
+
+                local delete2 = delete
+                local delete3 = delete2
+                local <??>delete4 = delete3
+            "#,
+            VirtualHoverResult {
+                value: "\n```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a\n\n\n".to_string(),
+            },
+        ));
+
+        assert!(ws.check_hover(
+            r#"
+                ---@param a number 参数a
+                ---@return number a 返回值a
+                local function delete(a)
+                end
+
+                local delete2 = delete
+                local delete3 = delete2
+                local delete4 = delete3
+                local deleteObj = {
+                    <??>aaa = delete4
+                }
+            "#,
+            VirtualHoverResult {
+                value: "\n```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a\n\n\n".to_string(),
+            },
+        ));
+
+        assert!(ws.check_hover(
+            r#"
+                ---@param a number 参数a
+                ---@return number a 返回值a
+                local function delete(a)
+                end
+
+                local delete2 = delete
+                local delete3 = delete2
+                local delete4 = delete3
+                local deleteObj = {
+                    aa = delete4
+                }
+
+                local deleteObj2 = {
+                    <??>aa = deleteObj.aa
+                }
+            "#,
+            VirtualHoverResult {
+                value: "\n```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a\n\n\n".to_string(),
+            },
+        ));
+    }
+
+    #[test]
+    fn test_2() {
+        let mut ws = HoverVirtualWorkspace::new();
+        ws.def(
+            r#"
+            ---@class Game
+            ---@field event fun(self: self, owner: "abc"): any 测试1
+            ---@field event fun(self: self, owner: "def"): any 测试2
+            local Game = {}
+
+            ---说明
+            ---@param key string 参数key
+            ---@param value string 参数value
+            ---@return number ret @返回值
+            function Game:add(key, value)
+                self.aaa = 1
+            end
+            "#,
+        );
+
+        assert!(ws.check_hover(
+            r#"
+
+
+            ---@type Game
+            local game
+
+            local local_a = game.add
+            local <??>local_b = local_a
+            "#,
+            VirtualHoverResult {
+                value: "\n```lua\n(method) Game:add(key: string, value: string)\n  -> ret: number\n\n```\n\n---\n\n说明\n\n@*param* `key` — 参数key\n\n@*param* `value` — 参数value\n\n\n\n@*return* `ret`  — 返回值\n\n\n" .to_string(),
+            },
+        ));
+    }
+
+    #[test]
+    fn test_3() {
+        let mut ws = HoverVirtualWorkspace::new();
+        ws.def(
+            r#"
+            ---@class Hover.Test3<T>
+            ---@field event fun(self: self, event: "A", key: T)
+            ---@field event fun(self: self, event: "B", key: T)
+            local Test3 = {}
+            "#,
+        );
+
+        assert!(ws.check_hover(
+            r#"
+                ---@type Hover.Test3<string>
+                local test3
+
+                local <??>event = test3.event
+            "#,
+            VirtualHoverResult {
+                value: "\n```lua\n(method) Test3:event(event: \"B\", key: string)\n```\n\n&nbsp;&nbsp;in class `Hover.Test3`\n\n---\n\n---\n\n```lua\n(method) Test3:event(event: \"A\", key: string)\n```\n".to_string(),
+            },
+        ));
+    }
+}

crates/emmylua_ls/src/handlers/hover/test/mod.rs

@@ -1,6 +1,7 @@
 use emmylua_code_analysis::{EmmyLuaAnalysis, FileId, VirtualUrlGenerator};
 use lsp_types::{Hover, HoverContents, MarkupContent, Position};
 
+mod hover_function_test;
 mod hover_test;
 use super::hover;
 
@@ -62,30 +63,29 @@ impl HoverVirtualWorkspace {
 
     /// 处理文件内容
     fn handle_file_content(content: &str) -> Option<(String, Position)> {
-        let mut content = content.to_string();
-        let cursor_pos = content.find("<??>");
-        if let Some(cursor_pos) = cursor_pos {
-            // 确保只有一个 <??> 标记
-            if content.matches("<??>").count() > 1 {
-                return None;
-            }
-
-            let mut line = 0;
-            let mut column = 0;
-            for (i, c) in content.chars().take(cursor_pos).enumerate() {
-                if c == '\n' {
-                    line += 1;
-                    column = 0;
-                } else {
-                    column += 1;
-                }
-            }
+        let content = content.to_string();
+        let cursor_byte_pos = content.find("<??>")?;
+        if content.matches("<??>").count() > 1 {
+            return None;
+        }
 
-            content = content.replace("<??>", "");
+        let mut line = 0;
+        let mut column = 0;
 
-            return Some((content, Position::new(line as u32, column as u32)));
+        for (byte_pos, c) in content.char_indices() {
+            if byte_pos >= cursor_byte_pos {
+                break;
+            }
+            if c == '\n' {
+                line += 1;
+                column = 0;
+            } else {
+                column += 1;
+            }
         }
-        None
+
+        let new_content = content.replace("<??>", "");
+        Some((new_content, Position::new(line as u32, column as u32)))
     }
 
     pub fn check_hover(&mut self, block_str: &str, expect: VirtualHoverResult) -> bool {