Merge pull request #135 from vim-denops/imp-buffer-open

👍 Improve `buffer.open()` functionality

Author: lambdalisue

denops_std/buffer/README.md

@@ -29,23 +29,33 @@ export async function main(denops: Denops): Promise<void> {
 }
 ```
 
-Use `split`, `vsplit`, `tabedit`, `pedit`, or whatever before if you'd like to
-open a buffer with non current window like:
+Use `split`, `vsplit`, `tabedit`, `pedit`, or whatever in `opener` attribute of
+the option like:
 
 ```typescript
 import { Denops } from "../mod.ts";
-import { batch } from "../batch/mod.ts";
 import { open } from "../buffer/mod.ts";
 
 export async function main(denops: Denops): Promise<void> {
-  await batch(denops, async (denops) => {
-    await denops.cmd("split");
-    await open(denops, "README.md");
-  });
+  await open(denops, "README.md", { opener: "split" });
 }
 ```
 
-See [`batch`](../batch/README.md) documentation for `batch()` part.
+Use a result value if you need window id, buffer number, window number, or
+tabpage number like:
+
+```typescript
+import { Denops } from "../mod.ts";
+import { open } from "../buffer/mod.ts";
+
+export async function main(denops: Denops): Promise<void> {
+  const info = await open(denops, "README.md");
+  console.log("winid:", info.winid);
+  console.log("bufnr:", info.bufnr);
+  console.log("winnr:", info.winnr);
+  console.log("tabpagenr:", info.tabpagenr);
+}
+```
 
 ### reload
 

denops_std/buffer/buffer.ts

@@ -23,6 +23,15 @@ async function ensurePrerequisites(denops: Denops): Promise<string> {
   }
   denops.context[cacheKey] = true;
   const script = `
+  function! DenopsStdBufferOpen_${suffix}(mods, opener, cmdarg, bufname) abort
+    execute printf('%s %s %s \`=a:bufname\`', a:mods, a:opener, a:cmdarg)
+    return {
+          \\ 'winid': win_getid(),
+          \\ 'bufnr': bufnr(),
+          \\ 'winnr': winnr(),
+          \\ 'tabpagenr': tabpagenr(),
+          \\}
+  endfunction
   function! DenopsStdBufferReload_${suffix}(bufnr) abort
     if bufnr('%') is# a:bufnr
       edit
@@ -91,6 +100,14 @@ async function ensurePrerequisites(denops: Denops): Promise<string> {
 export type OpenOptions = {
   mods?: string;
   cmdarg?: string;
+  opener?: string;
+};
+
+export type OpenResult = {
+  winid: number;
+  bufnr: number;
+  winnr: number;
+  tabpagenr: number;
 };
 
 /**
@@ -100,10 +117,18 @@ export async function open(
   denops: Denops,
   bufname: string,
   options: OpenOptions = {},
-): Promise<void> {
+): Promise<OpenResult> {
+  const suffix = await ensurePrerequisites(denops);
   const mods = options.mods ?? "";
   const cmdarg = options.cmdarg ?? "";
-  await denops.cmd(`${mods} edit ${cmdarg} \`=bufname\``, { bufname });
+  const opener = options.opener ?? "edit";
+  return await denops.call(
+    `DenopsStdBufferOpen_${suffix}`,
+    mods,
+    opener,
+    cmdarg,
+    bufname,
+  ) as OpenResult;
 }
 
 /**

denops_std/buffer/buffer_test.ts

@@ -15,28 +15,40 @@ test({
   mode: "all",
   name: "open opens a new buffer",
   fn: async (denops) => {
-    await open(denops, "Hello world");
+    const info = await open(denops, "Hello world");
     const bufname = await fn.bufname(denops);
     assertEquals("Hello world", bufname);
+    assertEquals(await fn.win_getid(denops), info.winid);
+    assertEquals(await fn.bufnr(denops), info.bufnr);
+    assertEquals(await fn.winnr(denops), info.winnr);
+    assertEquals(await fn.tabpagenr(denops), info.tabpagenr);
   },
 });
 test({
   mode: "all",
   name: "open opens a new buffer (remote buffer name)",
   fn: async (denops) => {
-    await open(denops, "gin://this-is-valid-remote-buffer-name");
+    const info = await open(denops, "gin://this-is-valid-remote-buffer-name");
     const bufname = await fn.bufname(denops);
     assertEquals("gin://this-is-valid-remote-buffer-name", bufname);
+    assertEquals(await fn.win_getid(denops), info.winid);
+    assertEquals(await fn.bufnr(denops), info.bufnr);
+    assertEquals(await fn.winnr(denops), info.winnr);
+    assertEquals(await fn.tabpagenr(denops), info.tabpagenr);
   },
 });
 test({
   mode: "all",
   name: "open opens a new buffer (symobls with percent-encoding)",
   fn: async (denops) => {
     const symbols = " !%22#$%&'()%2a+,-./:;%3c=%3e%3f@[\\]^`{%7c}~";
-    await open(denops, `test://${symbols}`);
+    const info = await open(denops, `test://${symbols}`);
     const bufname = await fn.bufname(denops);
     assertEquals(`test://${symbols}`, bufname);
+    assertEquals(await fn.win_getid(denops), info.winid);
+    assertEquals(await fn.bufnr(denops), info.bufnr);
+    assertEquals(await fn.winnr(denops), info.winnr);
+    assertEquals(await fn.tabpagenr(denops), info.tabpagenr);
   },
 });