From: Michal Privoznik <mprivozn@redhat.com>
Date: Sat, 12 Mar 2022 04:37:50 +0000 (+0100)
Subject: virsh: Introduce virshEnumComplete()
X-Git-Tag: v8.2.0-rc1~98
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d2e8718f3a7335c45163a9989c4ce2fda89fab3f;p=thirdparty%2Flibvirt.git

virsh: Introduce virshEnumComplete()

We have plenty of completers which iterate over all values of
given enum and do nothing more than translate every member into
string (using corresponding virXXXTypeToString()).

Introduce a convenience function so that callers can pass just
VIR_XXX_LAST and virXXXTypeToString and the rest is taken care
of.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
---

diff --git a/tools/virsh-completer.c b/tools/virsh-completer.c
index 3d77be3121..e5610d0fe8 100644
--- a/tools/virsh-completer.c
+++ b/tools/virsh-completer.c
@@ -57,6 +57,33 @@
  */
 
 
+/**
+ * virshEnumComplete:
+ * @last: The number of element in enum (pass VIR_XXX_LAST)
+ * @intToStr: integer to string conversion (pass virXXXTypeToString)
+ *
+ * Convenient function to generate completions across all values
+ * of given enum. The enum, or values we want to generate, must
+ * start at 0 and be continuous until @last.
+ *
+ * Returns: string list of completions.
+ */
+char **
+virshEnumComplete(unsigned int last,
+                  const char *(*intToStr)(int))
+{
+    char **ret = NULL;
+    size_t i;
+
+    ret = g_new0(char *, last + 1);
+
+    for (i = 0; i < last; i++)
+        ret[i] = g_strdup(intToStr(i));
+
+    return ret;
+}
+
+
 /**
  * virshCommaStringListComplete:
  * @input: user input so far
diff --git a/tools/virsh-completer.h b/tools/virsh-completer.h
index 1d7affbb23..131678dfbc 100644
--- a/tools/virsh-completer.h
+++ b/tools/virsh-completer.h
@@ -32,6 +32,10 @@
 #include "virsh-completer-snapshot.h"
 #include "virsh-completer-volume.h"
 
+char **
+virshEnumComplete(unsigned int last,
+                  const char *(*intToStr)(int));
+
 char **
 virshCommaStringListComplete(const char *input,
                              const char **options);