Convenience function to return the value of an on / off XML attribute.
Signed-off-by: Tim Wiederhake <twiederh@xxxxxxxxxx>
Reviewed-by: Peter Krempa <pkrempa@xxxxxxxxxx>
---
src/libvirt_private.syms | 1 +
src/util/virxml.c | 44 ++++++++++++++++++++++++++++++++++++++++
src/util/virxml.h | 6 ++++++
3 files changed, 51 insertions(+)
diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms
index 331cbb57d5..ba70e8b4ca 100644
--- a/src/libvirt_private.syms
+++ b/src/libvirt_private.syms
@@ -3551,6 +3551,7 @@ virXMLPickShellSafeComment;
virXMLPropString;
virXMLPropStringLimit;
virXMLPropTristateBool;
+virXMLPropTristateSwitch;
virXMLSaveFile;
virXMLValidateAgainstSchema;
virXMLValidatorFree;
diff --git a/src/util/virxml.c b/src/util/virxml.c
index 6b197e0fff..1b1c3878e6 100644
--- a/src/util/virxml.c
+++ b/src/util/virxml.c
@@ -602,6 +602,50 @@ virXMLPropTristateBool(xmlNodePtr node,
}
+/**
+ * virXMLPropTristateSwitch:
+ * @node: XML dom node pointer
+ * @name: Name of the property (attribute) to get
+ * @flags: Bitwise or of virXMLPropFlags
+ * @result: The returned value
+ *
+ * Convenience function to return value of an on / off 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
+virXMLPropTristateSwitch(xmlNodePtr node,
+ const char* name,
+ virXMLPropFlags flags,
+ virTristateSwitch *result)
+{
+ g_autofree char *tmp = NULL;
+ int val;
+
+ if (!(tmp = virXMLPropString(node, name))) {
+ if (!(flags & VIR_XML_PROP_REQUIRED))
+ return 0;
+
+ virReportError(VIR_ERR_XML_ERROR,
+ _("Missing required attribute '%s' in element '%s'"),
+ name, node->name);
+ return -1;
+ }
+
+ if ((val = virTristateSwitchTypeFromString(tmp)) <= 0) {
+ virReportError(VIR_ERR_XML_ERROR,
+ _("Invalid value for attribute '%s' in element '%s': '%s'. Expected 'on' or 'off'"),
+ name, node->name, tmp);
+ return -1;
+ }
+
+ *result = val;
+ return 1;
+}
+
+
/**
* virXPathBoolean:
* @xpath: the XPath string to evaluate
diff --git a/src/util/virxml.h b/src/util/virxml.h
index bd246153f5..4c9497ba17 100644
--- a/src/util/virxml.h
+++ b/src/util/virxml.h
@@ -90,6 +90,12 @@ int virXMLPropTristateBool(xmlNodePtr node,
virTristateBool *result)
ATTRIBUTE_NONNULL(0) ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3);
+int virXMLPropTristateSwitch(xmlNodePtr node,
+ const char *name,
+ virXMLPropFlags flags,
+ virTristateSwitch *result)
+ ATTRIBUTE_NONNULL(0) ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3);
+
/* Internal function; prefer the macros below. */
xmlDocPtr virXMLParseHelper(int domcode,
const char *filename,
--
2.26.2
