refactor completion dispatch

Author: CppCXY

crates/emmylua_ls/src/handlers/completion/completion_builder.rs

@@ -15,7 +15,6 @@ pub struct CompletionBuilder<'a> {
     pub env_duplicate_name: HashSet<String>,
     completion_items: Vec<CompletionItem>,
     cancel_token: CancellationToken,
-    stopped: bool,
     pub trigger_kind: CompletionTriggerKind,
     /// 是否为空格字符触发的补全(非主动触发)
     pub is_space_trigger_character: bool,
@@ -44,7 +43,6 @@ impl<'a> CompletionBuilder<'a> {
             env_duplicate_name: HashSet::new(),
             completion_items: Vec::new(),
             cancel_token,
-            stopped: false,
             trigger_kind,
             is_space_trigger_character,
             position_offset,
@@ -54,7 +52,7 @@ impl<'a> CompletionBuilder<'a> {
     }
 
     pub fn is_cancelled(&self) -> bool {
-        self.stopped || self.cancel_token.is_cancelled()
+        self.cancel_token.is_cancelled()
     }
 
     pub fn add_completion_item(&mut self, item: CompletionItem) -> Option<()> {
@@ -70,10 +68,6 @@ impl<'a> CompletionBuilder<'a> {
         &mut self.completion_items
     }
 
-    pub fn stop_here(&mut self) {
-        self.stopped = true;
-    }
-
     pub fn get_trigger_text(&self) -> String {
         self.trigger_token.text().trim_end().to_string()
     }

crates/emmylua_ls/src/handlers/completion/completion_context.rs

@@ -1,8 +1,8 @@
 use super::{
     completion_builder::CompletionBuilder,
     providers::{
-        desc_provider, doc_name_token_provider, doc_tag_provider, doc_type_provider,
-        file_path_provider, module_path_provider, table_field_provider,
+        CompletionProvider, DescProvider, DocNameTokenProvider, DocTagProvider, DocTypeProvider,
+        FilePathProvider, ModulePathProvider, TableFieldProvider,
     },
 };
 
@@ -20,31 +20,31 @@ pub enum CompletionContext {
 
 impl CompletionContext {
     pub fn analyze(builder: &CompletionBuilder) -> Self {
-        if doc_tag_provider::can_add_completion(builder) {
+        if DocTagProvider.supports(builder) {
             return Self::DocTag;
         }
 
-        if doc_name_token_provider::can_add_completion(builder) {
+        if DocNameTokenProvider.supports(builder) {
             return Self::DocName;
         }
 
-        if doc_type_provider::get_completion_type(builder).is_some() {
+        if DocTypeProvider.supports(builder) {
             return Self::DocType;
         }
 
-        if desc_provider::can_add_completion(builder) {
+        if DescProvider.supports(builder) {
             return Self::DocDescription;
         }
 
-        if module_path_provider::can_add_completion(builder) {
+        if ModulePathProvider.supports(builder) {
             return Self::ModulePath;
         }
 
-        if file_path_provider::can_add_completion(builder) {
+        if FilePathProvider.supports(builder) {
             return Self::FilePath;
         }
 
-        if table_field_provider::has_exclusive_completion(builder) {
+        if TableFieldProvider.supports(builder) {
             return Self::TableField;
         }
 

crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs

@@ -15,7 +15,34 @@ use crate::{
     util::{file_name_convert, module_name_convert},
 };
 
-pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
+use super::{CompletionProvider, ProviderDecision};
+
+pub struct AutoRequireProvider;
+
+impl CompletionProvider for AutoRequireProvider {
+    fn name(&self) -> &'static str {
+        "auto_require"
+    }
+
+    fn supports(&self, builder: &CompletionBuilder) -> bool {
+        builder.semantic_model.get_emmyrc().completion.auto_require
+            && builder
+                .trigger_token
+                .parent()
+                .and_then(LuaNameExpr::cast)
+                .is_some()
+    }
+
+    fn complete(&self, builder: &mut CompletionBuilder) -> ProviderDecision {
+        if complete_provider(builder).is_some() {
+            ProviderDecision::Continue
+        } else {
+            ProviderDecision::NoMatch
+        }
+    }
+}
+
+fn complete_provider(builder: &mut CompletionBuilder) -> Option<()> {
     if builder.is_cancelled() {
         return None;
     }

crates/emmylua_ls/src/handlers/completion/providers/desc_provider.rs

@@ -11,11 +11,33 @@ use emmylua_parser_desc::{LuaDescRefPathItem, parse_ref_target};
 use rowan::TextRange;
 use std::collections::HashSet;
 
-pub fn can_add_completion(builder: &CompletionBuilder) -> bool {
+use super::{CompletionProvider, ProviderDecision};
+
+pub struct DescProvider;
+
+impl CompletionProvider for DescProvider {
+    fn name(&self) -> &'static str {
+        "doc_description"
+    }
+
+    fn supports(&self, builder: &CompletionBuilder) -> bool {
+        supports_provider(builder)
+    }
+
+    fn complete(&self, builder: &mut CompletionBuilder) -> ProviderDecision {
+        if complete_provider(builder).is_some() {
+            ProviderDecision::Stop
+        } else {
+            ProviderDecision::NoMatch
+        }
+    }
+}
+
+fn supports_provider(builder: &CompletionBuilder) -> bool {
     detect_path(builder).is_some()
 }
 
-pub fn add_completions(builder: &mut CompletionBuilder) -> Option<()> {
+fn complete_provider(builder: &mut CompletionBuilder) -> Option<()> {
     if builder.is_cancelled() {
         return None;
     }
@@ -28,8 +50,6 @@ pub fn add_completions(builder: &mut CompletionBuilder) -> Option<()> {
         add_by_prefix(builder, &path);
     }
 
-    builder.stop_here();
-
     Some(())
 }
 

crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs

@@ -9,11 +9,33 @@ use lsp_types::CompletionItem;
 
 use crate::handlers::completion::completion_builder::CompletionBuilder;
 
-pub fn can_add_completion(builder: &CompletionBuilder) -> bool {
+use super::{CompletionProvider, ProviderDecision};
+
+pub struct DocNameTokenProvider;
+
+impl CompletionProvider for DocNameTokenProvider {
+    fn name(&self) -> &'static str {
+        "doc_name_token"
+    }
+
+    fn supports(&self, builder: &CompletionBuilder) -> bool {
+        supports_provider(builder)
+    }
+
+    fn complete(&self, builder: &mut CompletionBuilder) -> ProviderDecision {
+        if complete_provider(builder).is_some() {
+            ProviderDecision::Stop
+        } else {
+            ProviderDecision::NoMatch
+        }
+    }
+}
+
+fn supports_provider(builder: &CompletionBuilder) -> bool {
     get_doc_completion_expected(&builder.trigger_token).is_some()
 }
 
-pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
+fn complete_provider(builder: &mut CompletionBuilder) -> Option<()> {
     if builder.is_cancelled() {
         return None;
     }
@@ -46,8 +68,6 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
         }
     }
 
-    builder.stop_here();
-
     Some(())
 }
 

crates/emmylua_ls/src/handlers/completion/providers/doc_tag_provider.rs

@@ -5,20 +5,42 @@ use emmylua_parser::{
 };
 use lsp_types::{CompletionItem, MarkupContent};
 
-pub fn can_add_completion(builder: &CompletionBuilder) -> bool {
+use super::{CompletionProvider, ProviderDecision};
+
+pub struct DocTagProvider;
+
+impl CompletionProvider for DocTagProvider {
+    fn name(&self) -> &'static str {
+        "doc_tag"
+    }
+
+    fn supports(&self, builder: &CompletionBuilder) -> bool {
+        supports_provider(builder)
+    }
+
+    fn complete(&self, builder: &mut CompletionBuilder) -> ProviderDecision {
+        if complete_provider(builder).is_some() {
+            ProviderDecision::Stop
+        } else {
+            ProviderDecision::NoMatch
+        }
+    }
+}
+
+fn supports_provider(builder: &CompletionBuilder) -> bool {
     matches!(
         builder.trigger_token.kind().into(),
         LuaTokenKind::TkDocStart | LuaTokenKind::TkDocLongStart | LuaTokenKind::TkTagOther
     )
 }
 
-pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
+fn complete_provider(builder: &mut CompletionBuilder) -> Option<()> {
     if builder.is_cancelled() {
         return None;
     }
 
     let trigger_token_kind: LuaTokenKind = builder.trigger_token.kind().into();
-    if !can_add_completion(builder) {
+    if !supports_provider(builder) {
         return None;
     }
 
@@ -37,7 +59,6 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
         add_tag_param_return_completion(builder, last_index);
     }
 
-    builder.stop_here();
     Some(())
 }
 

crates/emmylua_ls/src/handlers/completion/providers/doc_type_provider.rs

@@ -7,12 +7,34 @@ use crate::handlers::completion::{
     completion_builder::CompletionBuilder, completion_data::CompletionData,
 };
 
-pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
+use super::{CompletionProvider, ProviderDecision};
+
+pub struct DocTypeProvider;
+
+impl CompletionProvider for DocTypeProvider {
+    fn name(&self) -> &'static str {
+        "doc_type"
+    }
+
+    fn supports(&self, builder: &CompletionBuilder) -> bool {
+        completion_type_for(builder).is_some()
+    }
+
+    fn complete(&self, builder: &mut CompletionBuilder) -> ProviderDecision {
+        if complete_provider(builder).is_some() {
+            ProviderDecision::Stop
+        } else {
+            ProviderDecision::NoMatch
+        }
+    }
+}
+
+fn complete_provider(builder: &mut CompletionBuilder) -> Option<()> {
     if builder.is_cancelled() {
         return None;
     }
 
-    let completion_type = get_completion_type(builder)?;
+    let completion_type = completion_type_for(builder)?;
 
     let prefix_content = builder.trigger_token.text().to_string();
     let prefix = if let Some(last_sep) = prefix_content.rfind('.') {
@@ -22,7 +44,6 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
         ""
     };
     complete_types_by_prefix(builder, prefix, None, Some(completion_type));
-    builder.stop_here();
     Some(())
 }
 
@@ -82,7 +103,7 @@ pub enum CompletionType {
     AttributeUse,
 }
 
-pub fn get_completion_type(builder: &CompletionBuilder) -> Option<CompletionType> {
+fn completion_type_for(builder: &CompletionBuilder) -> Option<CompletionType> {
     match builder.trigger_token.kind().into() {
         LuaTokenKind::TkName => {
             let parent = builder.trigger_token.parent()?;