hover: union function 优化

Author: xuhuanzy

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

@@ -483,7 +483,7 @@ fn is_function(typ: &LuaType) -> bool {
             LuaType::Union(union) => union
                 .get_types()
                 .iter()
-                .all(|t| matches!(t, LuaType::DocFunction(_))),
+                .all(|t| matches!(t, LuaType::DocFunction(_) | LuaType::Signature(_))),
             _ => false,
         }
 }

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

@@ -41,51 +41,81 @@ pub fn hover_function_type(
             function_member,
             func_name,
         )),
-        LuaType::Signature(signature_id) => hover_signature_type(
+        LuaType::Signature(signature_id) => {
+            let type_description = hover_signature_type(
+                builder,
+                db,
+                signature_id.clone(),
+                function_member,
+                func_name,
+                is_local,
+            )
+            .unwrap_or_else(|| {
+                builder.signature_overload = None;
+                format!("function {}", func_name)
+            });
+            builder.set_type_description(type_description);
+        },
+        LuaType::Union(union) => {
+            hover_union_function_type(builder, db, union, function_member, func_name)
+        }
+        _ => builder.set_type_description(format!("function {}", func_name)),
+    }
+}
+
+fn hover_union_function_type(
+    builder: &mut HoverBuilder,
+    db: &DbIndex,
+    union: &LuaUnionType,
+    function_member: Option<&LuaMember>,
+    func_name: &str,
+) {
+    // 泛型处理
+    if let Some(call) = builder.get_call_signature() {
+        builder.set_type_description(hover_doc_function_type(
             builder,
             db,
-            signature_id.clone(),
+            &call,
             function_member,
             func_name,
-            is_local,
-        )
-        .unwrap_or_else(|| {
-            builder.set_type_description(format!("function {}", func_name));
-            builder.signature_overload = None;
-        }),
-        LuaType::Union(union) => {
-            // 泛型处理
-            if let Some(call) = builder.get_call_signature() {
-                builder.set_type_description(hover_doc_function_type(
+        ));
+        return;
+    }
+    let mut overloads = Vec::new();
+
+    let types = union.get_types();
+    for typ in types {
+        match typ {
+            LuaType::DocFunction(lua_func) => {
+                overloads.push(hover_doc_function_type(
                     builder,
                     db,
-                    &call,
+                    &lua_func,
                     function_member,
                     func_name,
-                ))
-            } else {
-                // 将最后一个作为 type_description
-                let mut overloads = Vec::new();
-                for typ in union.get_types() {
-                    if let LuaType::DocFunction(lua_func) = typ {
-                        overloads.push(hover_doc_function_type(
-                            builder,
-                            db,
-                            &lua_func,
-                            function_member,
-                            func_name,
-                        ));
-                    }
-                }
-                if let Some(signature) = overloads.pop() {
-                    builder.set_type_description(signature);
-                    for overload in overloads {
-                        builder.add_signature_overload(overload);
-                    }
+                ));
+            }
+            LuaType::Signature(signature_id) => {
+                if let Some(type_description) = hover_signature_type(
+                    builder,
+                    db,
+                    signature_id.clone(),
+                    function_member,
+                    func_name,
+                    false,
+                ) {
+                    overloads.push(type_description);
                 }
             }
+            _ => {}
+        }
+    }
+    // 将最后一个作为 type_description
+    if let Some(type_description) = overloads.pop() {
+        builder.set_type_description(type_description);
+        for overload in overloads {
+            builder.add_signature_overload(overload);
         }
-        _ => builder.set_type_description(format!("function {}", func_name)),
     }
 }
 
@@ -172,7 +202,7 @@ fn hover_signature_type(
     owner_member: Option<&LuaMember>,
     func_name: &str,
     is_local: bool,
-) -> Option<()> {
+) -> Option<String> {
     let signature = db.get_signature_index().get(&signature_id)?;
     let call_signature = builder.get_call_signature();
 
@@ -240,9 +270,8 @@ fn hover_signature_type(
         if let Some(call_signature) = &call_signature {
             if call_signature.get_params() == signature.get_type_params() {
                 // 如果具有完全匹配的签名, 那么将其设置为当前签名, 且不显示重载
-                builder.set_type_description(result);
                 builder.signature_overload = None;
-                return Some(());
+                return Some(result);
             }
         }
         result
@@ -278,21 +307,21 @@ fn hover_signature_type(
             if let Some(call_signature) = &call_signature {
                 if *call_signature == **overload {
                     // 如果具有完全匹配的签名, 那么将其设置为当前签名, 且不显示重载
-                    builder.set_type_description(result);
                     builder.signature_overload = None;
-                    return Some(());
+                    return Some(result);
                 }
             };
             overloads.push(result);
         }
         overloads
     };
 
-    builder.set_type_description(signature_info);
+    // 设置重载信息
     for overload in overloads {
         builder.add_signature_overload(overload);
     }
-    Some(())
+
+    Some(signature_info)
 }
 
 fn build_signature_rets(

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

@@ -125,4 +125,42 @@ mod tests {
             },
         ));
     }
+
+    #[test]
+    fn test_union_function() {
+        let mut ws = HoverVirtualWorkspace::new();
+        assert!(ws.check_hover(
+            r#"
+                ---@diagnostic disable: missing-return
+                ---@class Trigger
+                ---@class EventTypeA
+
+                ---@class (partial) GameA
+                local M
+
+                -- 注册引擎事件
+                ---@param event_type EventTypeA
+                ---@param ... any
+                ---@return Trigger
+                function M:<??>event(event_type, ...)
+                end
+
+                ---@class (partial) GameA
+                ---@field event fun(self: self, event: "游戏-初始化"): Trigger
+                ---@field event fun(self: self, event: "游戏-追帧完成"): Trigger
+                ---@field event fun(self: self, event: "游戏-逻辑不同步"): Trigger
+                ---@field event fun(self: self, event: "游戏-地形预设加载完成"): Trigger
+                ---@field event fun(self: self, event: "游戏-结束"): Trigger
+                ---@field event fun(self: self, event: "游戏-暂停"): Trigger
+                ---@field event fun(self: self, event: "游戏-恢复"): Trigger
+                ---@field event fun(self: self, event: "游戏-昼夜变化"): Trigger
+                ---@field event fun(self: self, event: "区域-进入"): Trigger
+                ---@field event fun(self: self, event: "区域-离开"): Trigger
+                ---@field event fun(self: self, event: "游戏-http返回"): Trigger
+            "#,
+            VirtualHoverResult {
+                value: "\n```lua\n(method) GameA:event(event_type: EventTypeA, ...: any)\n  -> Trigger\n\n```\n\n---\n\n---\n\n```lua\n(method) GameA:event(event: \"游戏-初始化\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-追帧完成\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-逻辑不同步\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-地形预设加载完成\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-结束\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-暂停\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-恢复\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-昼夜变化\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"区域-进入\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"区域-离开\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-http返回\") -> Trigger\n```\n".to_string(),
+            },
+        ));
+    }
 }