Introduce virTypedParamsCheck internal API

This API is useful for checking whether only a specific subset of
supported typed parameters were passed.

diff --git a/docs/apibuild.py b/docs/apibuild.py
index 686a23496ca8e9a4c5e6352d0faa95717bcac7a1..c816197dc98a4afacf6d8e81545e2ce4e761d703 100755 (executable)
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -67,6 +67,7 @@ ignored_functions = {
   "virTypedParamsValidate": "internal function in virtypedparam.c",
   "virTypedParameterAssign": "internal function in virtypedparam.c",
   "virTypedParameterAssignFromStr": "internal function in virtypedparam.c",
+  "virTypedParamsCheck": "internal function in virtypedparam.c",
 }
 
 ignored_macros = {

diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms
index 912a1774270dc5a0bc4b315125dd9d22538d5a62..af32b3e36fb85294a44829c14892fb3f5929dd3e 100644 (file)
--- a/src/libvirt_private.syms
+++ b/src/libvirt_private.syms
@@ -1943,6 +1943,7 @@ virTPMCreateCancelPath;
 # util/virtypedparam.h
 virTypedParameterAssign;
 virTypedParameterAssignFromStr;
+virTypedParamsCheck;
 virTypedParamsValidate;
 
 

diff --git a/src/util/virtypedparam.c b/src/util/virtypedparam.c
index eef9e305ca3b4e56a8f111e198a02c744ceb9504..825148b00c233bb938726e997859e96d7e691089 100644 (file)
--- a/src/util/virtypedparam.c
+++ b/src/util/virtypedparam.c
@@ -109,6 +109,32 @@ cleanup:
 
 }
 
+/* Check if params contains only specified parameter names. Return true if
+ * only specified names are present in params, false if params contains any
+ * unspecified parameter name. */
+bool
+virTypedParamsCheck(virTypedParameterPtr params,
+                    int nparams,
+                    const char **names,
+                    int nnames)
+{
+    int i, j;
+
+    for (i = 0; i < nparams; i++) {
+        bool found = false;
+        for (j = 0; j < nnames; j++) {
+            if (STREQ(params[i].field, names[j])) {
+                found = true;
+                break;
+            }
+        }
+        if (!found)
+            return false;
+    }
+
+    return true;
+}
+
 /* Assign name, type, and the appropriately typed arg to param; in the
  * case of a string, the caller is assumed to have malloc'd a string,
  * or can pass NULL to have this function malloc an empty string.

diff --git a/src/util/virtypedparam.h b/src/util/virtypedparam.h
index 8f6bd1b83734634f0d7fe3570053fd1fce23c45c..b0f852202bc34b7797d65bca383600e0320490d0 100644 (file)
--- a/src/util/virtypedparam.h
+++ b/src/util/virtypedparam.h
@@ -29,6 +29,11 @@ int virTypedParamsValidate(virTypedParameterPtr params, int nparams,
                            /* const char *name, int type ... */ ...)
     ATTRIBUTE_SENTINEL ATTRIBUTE_RETURN_CHECK;
 
+bool virTypedParamsCheck(virTypedParameterPtr params,
+                         int nparams,
+                         const char **names,
+                         int nnames);
+
 int virTypedParameterAssign(virTypedParameterPtr param, const char *name,
                             int type, /* TYPE arg */ ...)
     ATTRIBUTE_RETURN_CHECK;