]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
util: xml: Introduce virXMLPropEnumDefault
authorPeter Krempa <pkrempa@redhat.com>
Thu, 6 May 2021 15:09:45 +0000 (17:09 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Fri, 7 May 2021 08:06:18 +0000 (10:06 +0200)
The helper is almost identical to virXMLPropEnum but it allows to pass a
default value to initialize the result to.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
src/libvirt_private.syms
src/util/virxml.c
src/util/virxml.h

index 9f761c2c00c86e1c628b9bbb8b9de203dbafb6da..1b12c490183265d1af9aebbd337d8d68f9db08ad 100644 (file)
@@ -3550,6 +3550,7 @@ virXMLNodeToString;
 virXMLParseHelper;
 virXMLPickShellSafeComment;
 virXMLPropEnum;
+virXMLPropEnumDefault;
 virXMLPropInt;
 virXMLPropString;
 virXMLPropStringLimit;
index 8e28629e9ad674eb63d673f5750610e776467ffa..3ad596b3e2c7298e40e750a894a1b9f2c51844e4 100644 (file)
@@ -827,6 +827,36 @@ virXMLPropULongLong(xmlNodePtr node,
 }
 
 
+/**
+ * virXMLPropEnumDefault:
+ * @node: XML dom node pointer
+ * @name: Name of the property (attribute) to get
+ * @strToInt: Conversion function to turn enum name to value. Expected to
+ *            return negative value on failure.
+ * @flags: Bitwise or of virXMLPropFlags
+ * @result: The returned value
+ * @defaultResult: default value set to @result in case the property is missing
+ *
+ * Convenience function to return value of an enum attribute.
+ *
+ * Returns 1 in case of success in which case @result is set,
+ *         or 0 if the attribute is not present,
+ *         or -1 and reports an error on failure.
+ */
+int
+virXMLPropEnumDefault(xmlNodePtr node,
+                      const char* name,
+                      int (*strToInt)(const char*),
+                      virXMLPropFlags flags,
+                      unsigned int *result,
+                      unsigned int defaultResult)
+{
+    *result = defaultResult;
+
+    return virXMLPropEnumInternal(node, name, strToInt, flags, result);
+}
+
+
 /**
  * virXMLPropEnum:
  * @node: XML dom node pointer
index 939d2482cbbf4e3f4d616944222d2630fedf3784..ed02abd2e98d4ff90fa5048b3d982d2fae9cd49c 100644 (file)
@@ -152,6 +152,17 @@ virXMLPropEnum(xmlNodePtr node,
     ATTRIBUTE_NONNULL(0) ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
     ATTRIBUTE_NONNULL(4);
 
+int
+virXMLPropEnumDefault(xmlNodePtr node,
+                      const char* name,
+                      int (*strToInt)(const char*),
+                      virXMLPropFlags flags,
+                      unsigned int *result,
+                      unsigned int defaultResult)
+    ATTRIBUTE_NONNULL(0) ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
+    ATTRIBUTE_NONNULL(4);
+
+
 /* Internal function; prefer the macros below.  */
 xmlDocPtr
 virXMLParseHelper(int domcode,