👍 Improve decoration module (#161)

* 💪 Fix text property name on Vim

* 🌿 Add unittests for `decorate`

* 🚀 Use `prop_add_list` to enhance performance

* 👍 Add `undecorate` function

Close #151

Author: lambdalisue

denops_std/buffer/README.md

@@ -68,7 +68,7 @@ import { open, reload } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   // ...
   // Reload the content of the `bufnr` buffer.
   await reload(denops, bufnr);
@@ -90,7 +90,7 @@ import { decode, open, replace } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   const data = await Deno.readFile("README.md");
   const { content } = await decode(denops, bufnr, data);
   await replace(denops, bufnr, content);
@@ -111,7 +111,7 @@ import { append, open } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   // Append the content under the cursor position of the `bufnr` buffer
   await append(denops, bufnr, ["Hello", "World"]);
 }
@@ -131,7 +131,7 @@ import { open, replace } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   // Set the content of the `bufnr` buffer
   await replace(denops, bufnr, ["Hello", "World"]);
 }
@@ -153,7 +153,7 @@ import { assign, open } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   const content = await Deno.readFile("README.md");
   await assign(denops, bufnr, content);
 }
@@ -171,7 +171,7 @@ import { assign, open } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   const content = await Deno.readFile("README.md");
   // A preprocessor that replace all non words to "-"
   const preprocessor = (repl: string[]): string[] => {
@@ -194,7 +194,7 @@ import { concrete, open, replace } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   await fn.setbufvar(denops, bufnr, "&buftype", "nofile");
   await replace(denops, bufnr, ["Hello", "World"]);
   await concrete(denops, bufnr);
@@ -215,7 +215,7 @@ import { ensure, open } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   // ...
   await ensure(denops, bufnr, async () => {
     await option.buftype.set(denops, "nofile");
@@ -239,7 +239,7 @@ import { modifiable, open } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   // ...
   await modifiable(denops, bufnr, async () => {
     await fn.setline(denops, 1, ["Hello", "World"]);
@@ -258,7 +258,7 @@ import { decorate, open } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
   await open(denops, "README.md");
-  const bufnr = await fn.bufnr(denops) as number;
+  const bufnr = (await fn.bufnr(denops)) as number;
   // ...
   await decorate(denops, bufnr, [
     {
@@ -277,5 +277,43 @@ export async function main(denops: Denops): Promise<void> {
 }
 ```
 
+It uses `prop_add_list` in Vim and `nvim_buf_add_highlight` in Neovim to
+decorate the buffer.
+
+### undecorate
+
+Use `undecorate()` to undecorate the `bufnr` buffer decorated with `decorate`
+like:
+
+```typescript
+import { Denops } from "../mod.ts";
+import * as fn from "../function/mod.ts";
+import { decorate, open, undecorate } from "../buffer/mod.ts";
+
+export async function main(denops: Denops): Promise<void> {
+  await open(denops, "README.md");
+  const bufnr = (await fn.bufnr(denops)) as number;
+  // ...
+  await decorate(denops, bufnr, [
+    {
+      line: 1,
+      column: 1,
+      length: 10,
+      highlight: "Special",
+    },
+    {
+      line: 2,
+      column: 2,
+      length: 3,
+      highlight: "Comment",
+    },
+  ]);
+
+  // Do something
+
+  await undecorate(denops, bufnr);
+}
+```
+
 It uses `prop_add` in Vim and `nvim_buf_add_highlight` in Neovim to decorate the
 buffer.

denops_std/buffer/decoration.ts

@@ -36,6 +36,23 @@ export function decorate(
   }
 }
 
+/**
+ * Undecorate the specified buffer
+ */
+export function undecorate(
+  denops: Denops,
+  bufnr: number,
+): Promise<void> {
+  switch (denops.meta.host) {
+    case "vim":
+      return vimUndecorate(denops, bufnr);
+    case "nvim":
+      return nvimUndecorate(denops, bufnr);
+    default:
+      unreachable(denops.meta.host);
+  }
+}
+
 function uniq<T>(array: T[]): T[] {
   return [...new Set(array)];
 }
@@ -45,12 +62,20 @@ async function vimDecorate(
   bufnr: number,
   decorations: Decoration[],
 ): Promise<void> {
-  const toPropType = (n: string) => `denps_std:buffer:decoration:decorate:${n}`;
+  const toPropType = (n: string) =>
+    `denops_std:buffer:decoration:decorate:${n}`;
   const rs = (denops.context[cacheKey] ?? new Set()) as Set<string>;
   denops.context[cacheKey] = rs;
   const hs = uniq(decorations.map((v) => v.highlight)).filter((v) =>
     !rs.has(v)
   );
+  const decoMap = new Map<string, Set<[number, number, number, number]>>();
+  for (const deco of decorations) {
+    const propType = toPropType(deco.highlight);
+    const props = decoMap.get(propType) ?? new Set();
+    props.add([deco.line, deco.column, deco.line, deco.column + deco.length]);
+    decoMap.set(propType, props);
+  }
   await batch.batch(denops, async (denops) => {
     for (const highlight of hs) {
       const propType = toPropType(highlight);
@@ -60,19 +85,30 @@ async function vimDecorate(
       });
       rs.add(highlight);
     }
+    for (const [type, props] of decoMap.entries()) {
+      await vimFn.prop_add_list(denops, { bufnr, type }, [...props]);
+    }
+  });
+}
+
+async function vimUndecorate(
+  denops: Denops,
+  bufnr: number,
+): Promise<void> {
+  const propList = await vimFn.prop_list(denops, 1, {
+    bufnr,
+    end_lnum: -1,
+  }) as { id: string; type: string }[];
+  const propIds = new Set(
+    propList.filter((p) =>
+      p.type.startsWith("denops_std:buffer:decoration:decorate:")
+    ).map((p) => p.id),
+  );
+  await batch.batch(denops, async (denops) => {
+    for (const propId of propIds) {
+      await vimFn.prop_remove(denops, { id: propId, bufnr, all: true });
+    }
   });
-  for (const chunk of itertools.chunked(decorations, 1000)) {
-    await batch.batch(denops, async (denops) => {
-      for (const deco of chunk) {
-        const propType = toPropType(deco.highlight);
-        await vimFn.prop_add(denops, deco.line, deco.column, {
-          bufnr,
-          length: deco.length,
-          type: propType,
-        });
-      }
-    });
-  }
 }
 
 async function nvimDecorate(
@@ -100,3 +136,14 @@ async function nvimDecorate(
     });
   }
 }
+
+async function nvimUndecorate(
+  denops: Denops,
+  bufnr: number,
+): Promise<void> {
+  const ns = await nvimFn.nvim_create_namespace(
+    denops,
+    "denops_std:buffer:decoration:decorate",
+  );
+  await nvimFn.nvim_buf_clear_namespace(denops, bufnr, ns, 0, -1);
+}

denops_std/buffer/decoration_test.ts

@@ -0,0 +1,100 @@
+import { assertEquals } from "https://deno.land/[email protected]/testing/asserts.ts";
+import { test } from "../test/mod.ts";
+import * as fn from "../function/mod.ts";
+import * as vimFn from "../function/vim/mod.ts";
+import * as nvimFn from "../function/nvim/mod.ts";
+import * as buffer from "./buffer.ts";
+import { decorate } from "./decoration.ts";
+
+test({
+  mode: "vim",
+  name: "decorate define highlights as text properties",
+  fn: async (denops) => {
+    const collect = async (bufnr: number) => {
+      const lines = await fn.getbufline(denops, bufnr, 1, "$");
+      const props = [];
+      for (let line = 1; line <= lines.length; line++) {
+        props.push(
+          ...(await vimFn.prop_list(denops, line, { bufnr }) as unknown[]),
+        );
+      }
+      return props;
+    };
+    const bufnr = await fn.bufnr(denops);
+    await buffer.append(denops, bufnr, [
+      "Hello",
+      "Darkness",
+      "My",
+      "Old friend",
+    ]);
+    await decorate(denops, bufnr, [
+      {
+        line: 1,
+        column: 1,
+        length: 5,
+        highlight: "Title",
+      },
+      {
+        line: 2,
+        column: 2,
+        length: 3,
+        highlight: "Search",
+      },
+    ]);
+    assertEquals(await collect(bufnr), [{
+      col: 1,
+      end: 1,
+      id: 0,
+      length: 1,
+      start: 1,
+      type: "denops_std:buffer:decoration:decorate:Title",
+      type_bufnr: 0,
+    }, {
+      col: 2,
+      end: 1,
+      id: 0,
+      length: 3,
+      start: 1,
+      type: "denops_std:buffer:decoration:decorate:Search",
+      type_bufnr: 0,
+    }]);
+  },
+});
+test({
+  mode: "nvim",
+  name: "decorate define highlights as extmarks",
+  fn: async (denops) => {
+    const bufnr = await fn.bufnr(denops);
+    await buffer.append(denops, bufnr, [
+      "Hello",
+      "Darkness",
+      "My",
+      "Old friend",
+    ]);
+    await decorate(denops, bufnr, [
+      {
+        line: 1,
+        column: 1,
+        length: 5,
+        highlight: "Title",
+      },
+      {
+        line: 2,
+        column: 2,
+        length: 3,
+        highlight: "Search",
+      },
+    ]);
+    const ns = await nvimFn.nvim_create_namespace(
+      denops,
+      "denops_std:buffer:decoration:decorate",
+    );
+    assertEquals(
+      await nvimFn.nvim_buf_get_extmarks(denops, bufnr, ns, 0, -1, {}),
+      [
+        [1, 0, 0],
+        [2, 1, 1],
+      ],
+    );
+  },
+});