From 0fac024958d66ff4b844ae1b0c97d9b409d05d3b Mon Sep 17 00:00:00 2001
From: Peter Krempa <pkrempa@redhat.com>
Date: Tue, 18 Apr 2023 15:45:31 +0200
Subject: [PATCH] util: virtypedparam: Introduce 'virTypedParamListFetch'
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Introduce a helper that fetches the typed parameters from the list while
still preserving ownership of the pointer by the list.

In the future this will be also able to report errors stored in the
list.

Signed-off-by: Peter Krempa <pkrempa@redhat.com
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---
 src/libvirt_private.syms |  1 +
 src/util/virtypedparam.c | 26 ++++++++++++++++++++++++++
 src/util/virtypedparam.h |  6 ++++++
 3 files changed, 33 insertions(+)

diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms
index 0f42c2de0b..f1999d0e99 100644
--- a/src/libvirt_private.syms
+++ b/src/libvirt_private.syms
@@ -3556,6 +3556,7 @@ virTypedParamListAddString;
 virTypedParamListAddUInt;
 virTypedParamListAddULLong;
 virTypedParamListConcat;
+virTypedParamListFetch;
 virTypedParamListFree;
 virTypedParamListFromParams;
 virTypedParamListNew;
diff --git a/src/util/virtypedparam.c b/src/util/virtypedparam.c
index 6ac9a4e2f3..05dea25165 100644
--- a/src/util/virtypedparam.c
+++ b/src/util/virtypedparam.c
@@ -746,6 +746,32 @@ virTypedParamListFree(virTypedParamList *list)
 }
 
 
+/**
+ * virTypedParamListFetch:
+ *
+ * @list: virTypedParamList object
+ * @par: if not NULL filled with the typed parameters stored in @list
+ * @npar: if not NULL filled with the number of typed parameters stored in @list
+ *
+ * Checks that @list has no errors stored and optionally fills @par and @npar
+ * with a valid list of typed parameters. The typed parameters still belong to
+ * @list and will be freed together.
+ */
+int
+virTypedParamListFetch(virTypedParamList *list,
+                       virTypedParameterPtr *par,
+                       size_t *npar)
+{
+    if (par)
+        *par = list->par;
+
+    if (npar)
+        *npar = list->npar;
+
+    return 0;
+}
+
+
 size_t
 virTypedParamListStealParams(virTypedParamList *list,
                              virTypedParameterPtr *params)
diff --git a/src/util/virtypedparam.h b/src/util/virtypedparam.h
index 45422c2673..628c951432 100644
--- a/src/util/virtypedparam.h
+++ b/src/util/virtypedparam.h
@@ -152,6 +152,12 @@ size_t
 virTypedParamListStealParams(virTypedParamList *list,
                              virTypedParameterPtr *params);
 
+int
+virTypedParamListFetch(virTypedParamList *list,
+                           virTypedParameterPtr *par,
+                           size_t *npar)
+    G_GNUC_WARN_UNUSED_RESULT;
+
 virTypedParamList *
 virTypedParamListFromParams(virTypedParameterPtr *params,
                             size_t nparams);
-- 
2.39.5