👍 Add a workaround for getreginfo in Vim (#158)

* 👍 Add a workaround for `getreginfo` in Vim

Close #155

* Update denops_std/function/getreginfo.ts

Co-authored-by: Milly <[email protected]>

Co-authored-by: Milly <[email protected]>

Author: lambdalisue

denops_std/function/_generated.ts

@@ -2834,40 +2834,6 @@ export function getreg(denops: Denops, ...args: unknown[]): Promise<unknown> {
   return denops.call("getreg", ...args);
 }
 
-/**
- * Returns detailed information about register {regname} as a
- * Dictionary with the following entries:
- * 	regcontents	List of lines contained in register
- * 			{regname}, like
- * 			|getreg|({regname}, 1, 1).
- * 	regtype		the type of register {regname}, as in
- * 			|getregtype()|.
- * 	isunnamed	Boolean flag, v:true if this register
- * 			is currently pointed to by the unnamed
- * 			register.
- * 	points_to	for the unnamed register, gives the
- * 			single letter name of the register
- * 			currently pointed to (see |quotequote|).
- * 			For example, after deleting a line
- * 			with `dd`, this field will be "1",
- * 			which is the register that got the
- * 			deleted text.
- * The {regname} argument is a string.  If {regname} is invalid
- * or not set, an empty Dictionary will be returned.
- * If {regname} is not specified, |v:register| is used.
- * The returned Dictionary can be passed to |setreg()|.
- * In |Vim9-script| {regname} must be one character.
- * Can also be used as a |method|:
- * 	GetRegname()->getreginfo()
- */
-export function getreginfo(denops: Denops, regname?: unknown): Promise<unknown>;
-export function getreginfo(
-  denops: Denops,
-  ...args: unknown[]
-): Promise<unknown> {
-  return denops.call("getreginfo", ...args);
-}
-
 /**
  * The result is a String, which is type of register {regname}.
  * The value will be one of:

denops_std/function/_manual.ts

@@ -1,6 +1,7 @@
 export * from "./buffer.ts";
 export * from "./common.ts";
 export * from "./cursor.ts";
+export * from "./getreginfo.ts";
 export * from "./input.ts";
 export * from "./types.ts";
 export * from "./various.ts";

denops_std/function/getreginfo.ts

@@ -0,0 +1,75 @@
+import type { Denops } from "https://deno.land/x/[email protected]/mod.ts";
+import { lt } from "https://deno.land/[email protected]/semver/mod.ts";
+import { execute } from "../helper/mod.ts";
+import { generateUniqueString } from "../util.ts";
+
+const cacheKey = Symbol("denops_std/function/getreginfo.ts");
+const suffix = generateUniqueString();
+
+async function ensurePrerequisites(denops: Denops): Promise<string> {
+  if (cacheKey in denops.context) {
+    return suffix;
+  }
+  denops.context[cacheKey] = true;
+  const script = `
+  function! DenopsStdFunctionGetreginfo_${suffix}(...) abort
+    let l:result = call('getreginfo', a:000)
+    if !has_key(l:result, 'isunnamed')
+      return l:result
+    endif
+    return extend(l:result, {'isunnamed': l:result.isunnamed ? v:true : v:false})
+  endfunction
+  `;
+  await execute(denops, script);
+  return suffix;
+}
+
+export type GetreginfoResult = {
+  regcontents: string[];
+  regtype: string;
+  isunnamed?: boolean;
+  points_to?: string;
+} | Record<string, never>;
+
+/**
+ * Returns detailed information about register {regname} as a
+ * Dictionary with the following entries:
+ * 	regcontents	List of lines contained in register
+ * 			{regname}, like
+ * 			|getreg|({regname}, 1, 1).
+ * 	regtype		the type of register {regname}, as in
+ * 			|getregtype()|.
+ * 	isunnamed	Boolean flag, v:true if this register
+ * 			is currently pointed to by the unnamed
+ * 			register.
+ * 	points_to	for the unnamed register, gives the
+ * 			single letter name of the register
+ * 			currently pointed to (see |quotequote|).
+ * 			For example, after deleting a line
+ * 			with `dd`, this field will be "1",
+ * 			which is the register that got the
+ * 			deleted text.
+ * The {regname} argument is a string.  If {regname} is invalid
+ * or not set, an empty Dictionary will be returned.
+ * If {regname} is not specified, |v:register| is used.
+ * The returned Dictionary can be passed to |setreg()|.
+ * In |Vim9-script| {regname} must be one character.
+ * Can also be used as a |method|:
+ * 	GetRegname()->getreginfo()
+ */
+export function getreginfo(
+  denops: Denops,
+  regname?: string,
+): Promise<GetreginfoResult>;
+export async function getreginfo(
+  denops: Denops,
+  ...args: unknown[]
+): Promise<unknown> {
+  if (denops.meta.host === "vim" && lt(denops.meta.version, "9.0.936")) {
+    // Vim prior to 9.0.0936 need a workaround
+    // https://github.com/vim/vim/issues/11598
+    const suffix = await ensurePrerequisites(denops);
+    return denops.call(`DenopsStdFunctionGetreginfo_${suffix}`, ...args);
+  }
+  return denops.call("getreginfo", ...args);
+}