👍 Add config function to popup module

Author: lambdalisue

popup/mod.ts

@@ -25,6 +25,11 @@
  *     col: 1,
  *   });
  *
+ *   // Config a popup window
+ *   await popup.config(denops, popupWindow.winid, {
+ *     title: "Hello, world!",
+ *   });
+ *
  *   // Wiat 3 seconds
  *   await new Promise((resolve) => setTimeout(resolve, 3000));
  *
@@ -77,10 +82,12 @@ import * as fn from "../function/mod.ts";
 import type { OpenOptions, PopupWindow } from "./types.ts";
 import {
   closePopup as closePopupVim,
+  configPopup as configPopupVim,
   openPopup as openPopupVim,
 } from "./vim.ts";
 import {
   closePopup as closePopupNvim,
+  configPopup as configPopupNvim,
   openPopup as openPopupNvim,
 } from "./nvim.ts";
 
@@ -168,4 +175,42 @@ export async function open(
   };
 }
 
+/**
+ * Config a popup window in Vim/Neovim compatible way.
+ *
+ * ```typescript
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import * as popup from "https://deno.land/x/denops_std@$MODULE_VERSION/popup/mod.ts";
+ *
+ * export async function main(denops: Denops): Promise<void> {
+ *   // Open a popup window
+ *   await using popupWindow = await popup.open(denops, {
+ *     relative: "editor",
+ *     width: 20,
+ *     height: 20,
+ *     row: 1,
+ *     col: 1,
+ *   });
+ *
+ *   // Config a popup window
+ *   await popup.config(denops, popupWindow.winid, {
+ *     title: "Hello, world!",
+ *   });
+ * }
+ * ```
+ *
+ * Note that this function does NOT work in `batch.collect()`.
+ */
+export async function config(
+  denops: Denops,
+  winid: number,
+  options: Partial<Omit<OpenOptions, "bufnr">>,
+): Promise<void> {
+  const config = denops.meta.host === "vim" ? configPopupVim : configPopupNvim;
+  await config(denops, winid, options);
+  if (!options.noRedraw) {
+    await denops.redraw();
+  }
+}
+
 export type { OpenOptions, PopupWindow } from "./types.ts";

popup/nvim.ts

@@ -5,7 +5,7 @@ import { ulid } from "https://deno.land/[email protected]/ulid/mod.ts";
 
 import type { Border, OpenOptions } from "./types.ts";
 
-const cacheKey = "denops_std/popup/nvim.ts@1";
+const cacheKey = "denops_std/popup/nvim.ts@2";
 
 async function ensurePrerequisites(denops: Denops): Promise<string> {
   if (typeof denops.context[cacheKey] === "string") {
@@ -21,6 +21,12 @@ async function ensurePrerequisites(denops: Denops): Promise<string> {
     endif
     return winid
   endfunction
+  function! DenopsStdPopupNvimWinSetConfig_${suffix}(winid, config, winhighlight) abort
+    call nvim_win_set_config(a:winid, a:config)
+    if a:winhighlight isnot v:null
+      call nvim_win_set_option(winid, 'winhighlight', a:winhighlight)
+    endif
+  endfunction
   `;
   await execute(denops, script);
   return suffix;
@@ -42,12 +48,36 @@ export async function openPopup(
   ) as number;
 }
 
+export async function configPopup(
+  denops: Denops,
+  winid: number,
+  options: Partial<Omit<OpenOptions, "bufnr" | "noRedraw">>,
+): Promise<void> {
+  const suffix = await ensurePrerequisites(denops);
+  const nvimWinSetConfig = toNvimWinSetConfig(options);
+  const winhighlight = toNvimWinhighlight(options.highlight);
+  await denops.call(
+    `DenopsStdPopupNvimWinSetConfig_${suffix}`,
+    winid,
+    nvimWinSetConfig,
+    winhighlight,
+  );
+}
+
 export async function closePopup(denops: Denops, winid: number): Promise<void> {
   await nvimFn.nvim_win_close(denops, winid, true);
 }
 
-function toNvimOpenWinConfig(options: OpenOptions): nvimFn.NvimOpenWinConfig {
-  const v: nvimFn.NvimOpenWinConfig = {
+function toNvimOpenWinConfig(
+  options: Omit<OpenOptions, "bufnr" | "noRedraw">,
+): nvimFn.NvimOpenWinConfig {
+  return toNvimWinSetConfig(options) as nvimFn.NvimOpenWinConfig;
+}
+
+function toNvimWinSetConfig(
+  options: Partial<Omit<OpenOptions, "bufnr" | "noRedraw">>,
+): Partial<nvimFn.NvimOpenWinConfig> {
+  const v: Partial<nvimFn.NvimOpenWinConfig> = {
     relative: options.relative,
     anchor: options.anchor,
     width: options.width,
@@ -63,7 +93,7 @@ function toNvimOpenWinConfig(options: OpenOptions): nvimFn.NvimOpenWinConfig {
     Object
       .entries(v)
       .filter(([, v]) => v != undefined),
-  ) as nvimFn.NvimOpenWinConfig;
+  ) as Partial<nvimFn.NvimOpenWinConfig>;
 }
 
 function toNvimBorder(

popup/vim.ts

@@ -15,16 +15,35 @@ export function openPopup(
   >;
 }
 
+export function configPopup(
+  denops: Denops,
+  winid: number,
+  options: Partial<Omit<OpenOptions, "bufnr" | "noRedraw">>,
+): Promise<void> {
+  const popupSetOptionsOptions = toPopupSetOptionsOptions(options);
+  return vimFn.popup_setoptions(denops, winid, popupSetOptionsOptions);
+}
+
 export async function closePopup(denops: Denops, winid: number): Promise<void> {
   await vimFn.popup_close(denops, winid);
 }
 
-function toPopupCreateOptions(options: OpenOptions): vimFn.PopupCreateOptions {
+function toPopupCreateOptions(
+  options: Omit<OpenOptions, "bufnr" | "noRedraw">,
+): vimFn.PopupCreateOptions {
+  return {
+    ...toPopupSetOptionsOptions(options),
+    posinvert: false, // To keep consistent with the behavior of Neovim's floating window
+  };
+}
+
+function toPopupSetOptionsOptions(
+  options: Partial<Omit<OpenOptions, "bufnr" | "noRedraw">>,
+): vimFn.PopupSetOptionsOptions {
   const v: vimFn.PopupCreateOptions = {
     line: options.row,
     col: options.col,
     pos: options.anchor ? posFromAnchor(options.anchor) : undefined,
-    posinvert: false, // To keep consistent with the behavior of Neovim's floating window
     fixed: true, // To keep consistent with the behavior of Neovim's floating window
     flip: false, // To keep consistent with the behavior of Neovim's floating window
     maxheight: options.height,
@@ -48,7 +67,7 @@ function toPopupCreateOptions(options: OpenOptions): vimFn.PopupCreateOptions {
     Object
       .entries(v)
       .filter(([, v]) => v != undefined),
-  ) as vimFn.PopupCreateOptions;
+  ) as vimFn.PopupSetOptionsOptions;
 }
 
 function posFromAnchor(anchor: Anchor): vimFn.PopupCreateOptions["pos"] {