Series comparison

From: Radoslaw Smigielski <rsmigiel@redhat.com>

This series adds missing virsh TAB completion callbacks for six
command options:

- dump --file
  - blockcopy --dest
  - detach-interface --type
  - domdisplay --type
  - domxml-from-native --format
  - save --file

This is a small step towards closing the missing completers tracked in:
https://gitlab.com/libvirt/libvirt/-/work_items/9

As of now there are 29 missing bash completers, the one fixed in this
patch is first batch.

As some of the patches change only one line, I would apprecate your
feedback if these small one should be combined into a single patch?

Radoslaw Smigielski (6):
  virsh: Add completer for '--file' option of 'dump' subcommand
  virsh: Add completer for '--dest' option of 'blockcopy' command
  virsh: Add completer for '--type' option of 'detach-interface' command
  virsh: Add completer for '--type' option of 'domdisplay' command
  virsh: Add completer for '--format' option of 'domxml-from-native' command
  virsh: Add completer for '--file' option of 'save' command

tools/virsh-completer-domain.c | 49 ++++++++++++++++++++++++++++++++++
 tools/virsh-completer-domain.h | 10 +++++++
 tools/virsh-domain.c           |  6 +++++
 3 files changed, 65 insertions(+)

-- 
2.54.0

From: Radoslaw Smigielski <rsmigiel@redhat.com>

The '--type' option of 'domdisplay' command selects a particular
graphical display scheme (vnc, spice, rdp, or dbus).

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9
Signed-off-by: Radoslaw Smigielski <rsmigiel@redhat.com>
---
 tools/virsh-completer-domain.c | 13 +++++++++++++
 tools/virsh-completer-domain.h |  5 +++++
 tools/virsh-domain.c           |  1 +
 3 files changed, 19 insertions(+)

From: Radoslaw Smigielski <rsmigiel@redhat.com>

The '--format' option of 'domxml-from-native' command specifies the
native guest configuration format to import.

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9
Signed-off-by: Radoslaw Smigielski <rsmigiel@redhat.com>
---
 tools/virsh-completer-domain.c | 36 ++++++++++++++++++++++++++++++++++
 tools/virsh-completer-domain.h |  5 +++++
 tools/virsh-domain.c           |  1 +
 3 files changed, 42 insertions(+)

From: Radoslaw Smigielski <rsmigiel@redhat.com>

These changes add missing virsh TAB completion callbacks for several commands.
Fixed or added completers covers command grouped by similar options:

output paths:
  - dump --file
  - save --file
  - blockcopy --dest
  - screenshot --file (fixes pre-existing wrong annotation)

display / native format:
  - domdisplay --type
  - domxml-from-native --format
  - domxml-to-native --format

storage volume formats:
  - vol-create-as --format
  - vol-create-as --backing-vol-format

attach-disk:
  - targetbus, type, cache, io, mode, sourcetype, subdriver
  - source-host-socket

In patch 1/5 added vshCompletePathLocalCreate, a new noop completer
for local file paths used as command output where the target file may
not exist yet. This is the counterpart to vshCompletePathLocalExisting,
which is for existing files used as input.

In patch 2/5 adds a completer for domdisplay --type using
virDomainGraphicsTypeToString and VIR_DOMAIN_GRAPHICS_TYPE_LAST
so the options stays in sync with libvirt graphics types.
Replaced the static list from first patch set.

In patch 3/5 adds virshDomainXMLNativeFormatCompleter for domxml-from-native
--format (hypervisor-dependent native config format list).
In virshDomainXMLNativeFormatCompleter() added 4 new "static const char[]"
variables, follow the same pattern appears in the same file. Even though
these variables could be a non-static local arrays.

In patch 4/5 reuses existing completers for domxml-to-native --format and
vol-create-as --format / --backing-vol-format.

In 5/5 adds few enum and static-list completers for attach-disk options
targetbus, type, cache, io, mode, and sourcetype, and reuses the storage
file format completer for subdriver.
In virshDomainAttachDiskSourceTypeCompleter, I added a static list of element
types, I did not find any existing variable with the same list content.

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9

Radoslaw Smigielski (5):
  virsh: Add vshCompletePathLocalCreate completer for output paths
  virsh: Add completer for '--type' option of 'domdisplay' command
  virsh: Add completer for '--format' option of 'domxml-from-native' command
  virsh: Add missing TAB completers for several options
  virsh: Add missing TAB completers for 'attach-disk' command

-- 
2.54.0

From: Radoslaw Smigielski <rsmigiel@redhat.com>

Add a completer callback for local file paths used as command output,
where the target file may not exist yet.

Use it for 'dump', 'save', and 'blockcopy' commands, and fix
'screenshot' to use it instead of vshCompletePathLocalExisting.

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9
Signed-off-by: Radoslaw Smigielski <rsmigiel@redhat.com>
---
 tools/virsh-domain.c  |  5 ++++-
 tools/vsh-completer.c | 18 ++++++++++++++++++
 tools/vsh-completer.h |  5 +++++
 3 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index XXXXXXX..XXXXXXX 100644
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_blockcopy[] = {
     {.name = "dest",
      .type = VSH_OT_STRING,
      .unwanted_positional = true,
+     .completer = vshCompletePathLocalCreate,
      .help = N_("path of the copy to create")
     },
     {.name = "bandwidth",
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_save[] = {
      .type = VSH_OT_STRING,
      .positional = true,
      .required = true,
+     .completer = vshCompletePathLocalCreate,
      .help = N_("where to save the data")
     },
     {.name = "bypass-cache",
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_dump[] = {
      .type = VSH_OT_STRING,
      .positional = true,
      .required = true,
+     .completer = vshCompletePathLocalCreate,
      .help = N_("where to dump the core")
     },
     VIRSH_COMMON_OPT_LIVE(N_("perform a live core dump if supported")),
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_screenshot[] = {
     {.name = "file",
      .type = VSH_OT_STRING,
      .unwanted_positional = true,
-     .completer = vshCompletePathLocalExisting,
+     .completer = vshCompletePathLocalCreate,
      .help = N_("where to store the screenshot")
     },
     {.name = "screen",
diff --git a/tools/vsh-completer.c b/tools/vsh-completer.c
index XXXXXXX..XXXXXXX 100644
--- a/tools/vsh-completer.c
+++ b/tools/vsh-completer.c
@@ -XXX,XX +XXX,XX @@ vshCompletePathLocalExisting(vshControl *ctl G_GNUC_UNUSED,
 }
 
 
+/**
+ * vshCompletePathLocalCreate:
+ *
+ * Complete a path to local file used as output.
+ * The outout file may not exist yet.
+ *
+ * Note: For now this is a no-op. Readline does the correct thing
+ *       and completes local files list.
+ */
+char **
+vshCompletePathLocalCreate(vshControl *ctl G_GNUC_UNUSED,
+                           const vshCmd *cmd G_GNUC_UNUSED,
+                           unsigned int completerflags G_GNUC_UNUSED)
+{
+    return NULL;
+}
+
+
 /**
  * vshCompleteEmpty:
  *
diff --git a/tools/vsh-completer.h b/tools/vsh-completer.h
index XXXXXXX..XXXXXXX 100644
--- a/tools/vsh-completer.h
+++ b/tools/vsh-completer.h
@@ -XXX,XX +XXX,XX @@ vshCompletePathLocalExisting(vshControl *ctl,
                              const vshCmd *cmd,
                              unsigned int completerflags);
 
+char **
+vshCompletePathLocalCreate(vshControl *ctl,
+                           const vshCmd *cmd,
+                           unsigned int completerflags);
+
 char **
 vshCompleteEmpty(vshControl *ctl,
                  const vshCmd *cmd,
-- 
2.54.0

From: Radoslaw Smigielski <rsmigiel@redhat.com>

The '--type' option of 'domdisplay' command selects a particular
graphical display type.

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9
Signed-off-by: Radoslaw Smigielski <rsmigiel@redhat.com>
---
 tools/virsh-completer-domain.c | 12 ++++++++++++
 tools/virsh-completer-domain.h |  5 +++++
 tools/virsh-domain.c           |  1 +
 3 files changed, 18 insertions(+)

From: Radoslaw Smigielski <rsmigiel@redhat.com>

The '--format' option of 'domxml-from-native' command specifies the
native guest configuration format to import.

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9
Signed-off-by: Radoslaw Smigielski <rsmigiel@redhat.com>
---
 tools/virsh-completer-domain.c | 36 ++++++++++++++++++++++++++++++++++
 tools/virsh-completer-domain.h |  5 +++++
 tools/virsh-domain.c           |  1 +
 3 files changed, 42 insertions(+)

From: Radoslaw Smigielski <rsmigiel@redhat.com>

Wire existing completers for 'domxml-to-native --format',
'vol-create-as --format', 'vol-create-as --backing-vol-format', and
'attach-disk --source-host-socket'.

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9
Signed-off-by: Radoslaw Smigielski <rsmigiel@redhat.com>
---
 tools/virsh-domain.c | 2 ++
 tools/virsh-volume.c | 2 ++
 2 files changed, 4 insertions(+)

From: Radoslaw Smigielski <rsmigiel@redhat.com>

Add enum and static-list completers for 'attach-disk' options
targetbus, type, cache, io, mode, and sourcetype, and reuse the
existing storage file format completer for subdriver.

Partially-fixes: https://gitlab.com/libvirt/libvirt/-/work_items/9
Signed-off-by: Radoslaw Smigielski <rsmigiel@redhat.com>

---
 tools/virsh-completer-domain.c | 74 ++++++++++++++++++++++++++++++++++
 tools/virsh-completer-domain.h | 30 ++++++++++++++
 tools/virsh-domain.c           |  7 ++++
 3 files changed, 111 insertions(+)

diff --git a/tools/virsh-completer-domain.c b/tools/virsh-completer-domain.c
index XXXXXXX..XXXXXXX 100644
--- a/tools/virsh-completer-domain.c
+++ b/tools/virsh-completer-domain.c
@@ -XXX,XX +XXX,XX @@ virshDomainXMLNativeFormatCompleter(vshControl *ctl,
 
     return vshCommaStringListComplete(NULL, formats);
 }
+
+
+char **
+virshDomainDiskBusCompleter(vshControl *ctl G_GNUC_UNUSED,
+                            const vshCmd *cmd G_GNUC_UNUSED,
+                            unsigned int flags)
+{
+    virCheckFlags(0, NULL);
+
+    return vshEnumComplete(VIR_DOMAIN_DISK_BUS_LAST,
+                           virDomainDiskBusTypeToString);
+}
+
+
+char **
+virshDomainDiskDeviceTypeCompleter(vshControl *ctl G_GNUC_UNUSED,
+                                   const vshCmd *cmd G_GNUC_UNUSED,
+                                   unsigned int flags)
+{
+    virCheckFlags(0, NULL);
+
+    return vshEnumComplete(VIR_DOMAIN_DISK_DEVICE_LAST,
+                           virDomainDiskDeviceTypeToString);
+}
+
+
+char **
+virshDomainDiskCacheCompleter(vshControl *ctl G_GNUC_UNUSED,
+                              const vshCmd *cmd G_GNUC_UNUSED,
+                              unsigned int flags)
+{
+    virCheckFlags(0, NULL);
+
+    return vshEnumComplete(VIR_DOMAIN_DISK_CACHE_LAST,
+                           virDomainDiskCacheTypeToString);
+}
+
+
+char **
+virshDomainDiskIoCompleter(vshControl *ctl G_GNUC_UNUSED,
+                           const vshCmd *cmd G_GNUC_UNUSED,
+                           unsigned int flags)
+{
+    virCheckFlags(0, NULL);
+
+    return vshEnumComplete(VIR_DOMAIN_DISK_IO_LAST,
+                           virDomainDiskIoTypeToString);
+}
+
+
+char **
+virshDomainAttachDiskModeCompleter(vshControl *ctl G_GNUC_UNUSED,
+                                   const vshCmd *cmd G_GNUC_UNUSED,
+                                   unsigned int flags)
+{
+    static const char *modes[] = {"readonly", "shareable", NULL};
+
+    virCheckFlags(0, NULL);
+
+    return vshCommaStringListComplete(NULL, modes);
+}
+
+
+char **
+virshDomainAttachDiskSourceTypeCompleter(vshControl *ctl G_GNUC_UNUSED,
+                                         const vshCmd *cmd G_GNUC_UNUSED,
+                                         unsigned int flags)
+{
+    static const char *types[] = {"file", "block", "network", NULL};
+
+    virCheckFlags(0, NULL);
+
+    return vshCommaStringListComplete(NULL, types);
+}
diff --git a/tools/virsh-completer-domain.h b/tools/virsh-completer-domain.h
index XXXXXXX..XXXXXXX 100644
--- a/tools/virsh-completer-domain.h
+++ b/tools/virsh-completer-domain.h
@@ -XXX,XX +XXX,XX @@ char **
 virshDomainXMLNativeFormatCompleter(vshControl *ctl,
                                     const vshCmd *cmd,
                                     unsigned int flags);
+
+char **
+virshDomainDiskBusCompleter(vshControl *ctl,
+                            const vshCmd *cmd,
+                            unsigned int flags);
+
+char **
+virshDomainDiskDeviceTypeCompleter(vshControl *ctl,
+                                   const vshCmd *cmd,
+                                   unsigned int flags);
+
+char **
+virshDomainDiskCacheCompleter(vshControl *ctl,
+                              const vshCmd *cmd,
+                              unsigned int flags);
+
+char **
+virshDomainDiskIoCompleter(vshControl *ctl,
+                           const vshCmd *cmd,
+                           unsigned int flags);
+
+char **
+virshDomainAttachDiskModeCompleter(vshControl *ctl,
+                                   const vshCmd *cmd,
+                                   unsigned int flags);
+
+char **
+virshDomainAttachDiskSourceTypeCompleter(vshControl *ctl,
+                                         const vshCmd *cmd,
+                                         unsigned int flags);
diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index XXXXXXX..XXXXXXX 100644
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_attach_disk[] = {
     },
     {.name = "targetbus",
      .type = VSH_OT_STRING,
+     .completer = virshDomainDiskBusCompleter,
      .help = N_("target bus of disk device")
     },
     {.name = "driver",
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_attach_disk[] = {
     },
     {.name = "subdriver",
      .type = VSH_OT_STRING,
+     .completer = virshDomainStorageFileFormatCompleter,
      .help = N_("subdriver of disk device")
     },
     {.name = "iothread",
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_attach_disk[] = {
     },
     {.name = "cache",
      .type = VSH_OT_STRING,
+     .completer = virshDomainDiskCacheCompleter,
      .help = N_("cache mode of disk device")
     },
     {.name = "io",
      .type = VSH_OT_STRING,
+     .completer = virshDomainDiskIoCompleter,
      .help = N_("io policy of disk device")
     },
     {.name = "type",
      .type = VSH_OT_STRING,
+     .completer = virshDomainDiskDeviceTypeCompleter,
      .help = N_("target device type")
     },
     {.name = "shareable",
@@ -XXX,XX +XXX,XX @@ static const vshCmdOptDef opts_attach_disk[] = {
     },
     {.name = "mode",
      .type = VSH_OT_STRING,
+     .completer = virshDomainAttachDiskModeCompleter,
      .help = N_("mode of device reading and writing")
     },
     {.name = "sourcetype",
      .type = VSH_OT_STRING,
+     .completer = virshDomainAttachDiskSourceTypeCompleter,
      .help = N_("type of source (block|file|network)")
     },
     {.name = "serial",
-- 
2.54.0