Add dynamicFilters

Author: Shougo

denops/ddc/base/source.ts

@@ -123,6 +123,7 @@ export function defaultSourceOptions(): SourceOptions {
     cacheTimeout: 0,
     converters: [],
     dup: "ignore",
+    dynamicFilters: "",
     enabledIf: "",
     forceCompletionPattern: "",
     hideTimeout: 200,

denops/ddc/ext.ts

@@ -31,7 +31,7 @@ import { isDdcCallbackCancelError } from "./callback.ts";
 import { type BaseUi, defaultUiOptions } from "./base/ui.ts";
 import { type BaseSource, defaultSourceOptions } from "./base/source.ts";
 import { type BaseFilter, defaultFilterOptions } from "./base/filter.ts";
-import { printError } from "./utils.ts";
+import { callCallback, printError } from "./utils.ts";
 
 import type { Denops } from "@denops/std";
 
@@ -260,7 +260,42 @@ export async function filterItems(
     ));
   }
 
-  cdd = await callFilters(loader, sourceOptions.matchers);
+  type Filters = {
+    matchers: UserFilter[];
+    sorters: UserFilter[];
+    converters: UserFilter[];
+  };
+
+  const filters: Filters = {
+    matchers: sourceOptions.matchers,
+    sorters: sourceOptions.sorters,
+    converters: sourceOptions.converters,
+  };
+
+  const dynamicFilters = await callCallback(
+    denops,
+    sourceOptions.dynamicFilters,
+    {
+      context,
+      options,
+      sourceOptions,
+      completeStr,
+      items: cdd,
+    },
+  ) as Filters | null;
+  if (dynamicFilters) {
+    if (dynamicFilters.matchers) {
+      filters.matchers = dynamicFilters.matchers;
+    }
+    if (dynamicFilters.sorters) {
+      filters.sorters = dynamicFilters.sorters;
+    }
+    if (dynamicFilters.converters) {
+      filters.converters = dynamicFilters.converters;
+    }
+  }
+
+  cdd = await callFilters(loader, filters.matchers);
 
   if (sourceOptions.matcherKey !== "") {
     cdd = cdd.map((c) => (
@@ -272,12 +307,12 @@ export async function filterItems(
     ));
   }
 
-  cdd = await callFilters(loader, sourceOptions.sorters);
+  cdd = await callFilters(loader, filters.sorters);
 
   // Filter by maxItems
   cdd = cdd.slice(0, sourceOptions.maxItems);
 
-  cdd = await callFilters(loader, sourceOptions.converters);
+  cdd = await callFilters(loader, filters.converters);
 
   return cdd;
 }

denops/ddc/types.ts

@@ -95,6 +95,7 @@ export type SourceOptions = {
   cacheTimeout: number;
   converters: UserFilter[];
   dup: "keep" | "force" | "ignore";
+  dynamicFilters: Callback;
   enabledIf: string;
   forceCompletionPattern: string;
   hideTimeout: number;

doc/ddc.txt

@@ -142,6 +142,17 @@ cmdlineSources
 		    \ '=': ['input'],
 		    \ })
 <
+                                                   *ddc-option-dynamicFilters*
+dynamicFilters
+		It is the function which overwrites
+		|ddc-source-option-matchers| and |ddc-source-option-sorters|
+		and |ddc-source-option-converters| after gather items.
+		The function returns new |ddc-source-options| or |v:null|.
+		NOTE: {func} is evaluated after user input and it affects
+		completion performance.
+
+		Default: ""
+
                                                    *ddc-option-dynamicSources*
 dynamicSources
 		It is the function which overwrites |ddc-option-sources| after