1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "utils/XBMCTinyXML.h"
#include <stdint.h>
#include <string>
#include <vector>
class CDateTime;
class XMLUtils
{
public:
static bool HasChild(const TiXmlNode* pRootNode, const char* strTag);
static bool GetHex(const TiXmlNode* pRootNode, const char* strTag, uint32_t& dwHexValue);
static bool GetUInt(const TiXmlNode* pRootNode, const char* strTag, uint32_t& dwUIntValue);
static bool GetLong(const TiXmlNode* pRootNode, const char* strTag, long& lLongValue);
static bool GetFloat(const TiXmlNode* pRootNode, const char* strTag, float& value);
static bool GetDouble(const TiXmlNode* pRootNode, const char* strTag, double& value);
static bool GetInt(const TiXmlNode* pRootNode, const char* strTag, int& iIntValue);
static bool GetBoolean(const TiXmlNode* pRootNode, const char* strTag, bool& bBoolValue);
/*! \brief Get a string value from the xml tag
If the specified tag isn't found strStringvalue is not modified and will contain whatever
value it had before the method call.
\param[in] pRootNode the xml node that contains the tag
\param[in] strTag the xml tag to read from
\param[in,out] strStringValue where to store the read string
\return true on success, false if the tag isn't found
*/
static bool GetString(const TiXmlNode* pRootNode, const char* strTag, std::string& strStringValue);
/*! \brief Get a string value from the xml tag
\param[in] pRootNode the xml node that contains the tag
\param[in] strTag the tag to read from
\return the value in the specified tag or an empty string if the tag isn't found
*/
static std::string GetString(const TiXmlNode* pRootNode, const char* strTag);
/*! \brief Get multiple tags, concatenating the values together.
Transforms
<tag>value1</tag>
<tag clear="true">value2</tag>
...
<tag>valuen</tag>
into value2<sep>...<sep>valuen, appending it to the value string. Note that <value1> is overwritten by the clear="true" tag.
\param rootNode the parent containing the <tag>'s.
\param tag the <tag> in question.
\param separator the separator to use when concatenating values.
\param value [out] the resulting string. Remains untouched if no <tag> is available, else is appended (or cleared based on the clear parameter).
\param clear if true, clears the string prior to adding tags, if tags are available. Defaults to false.
*/
static bool GetAdditiveString(const TiXmlNode* rootNode, const char* tag, const std::string& separator, std::string& value, bool clear = false);
static bool GetStringArray(const TiXmlNode* rootNode, const char* tag, std::vector<std::string>& arrayValue, bool clear = false, const std::string& separator = "");
static bool GetPath(const TiXmlNode* pRootNode, const char* strTag, std::string& strStringValue);
static bool GetFloat(const TiXmlNode* pRootNode, const char* strTag, float& value, const float min, const float max);
static bool GetUInt(const TiXmlNode* pRootNode, const char* strTag, uint32_t& dwUIntValue, const uint32_t min, const uint32_t max);
static bool GetInt(const TiXmlNode* pRootNode, const char* strTag, int& iIntValue, const int min, const int max);
static bool GetDate(const TiXmlNode* pRootNode, const char* strTag, CDateTime& date);
static bool GetDateTime(const TiXmlNode* pRootNode, const char* strTag, CDateTime& dateTime);
/*! \brief Fetch a std::string copy of an attribute, if it exists. Cannot distinguish between empty and non-existent attributes.
\param element the element to query.
\param tag the name of the attribute.
\return the attribute, if it exists, else an empty string
*/
static std::string GetAttribute(const TiXmlElement *element, const char *tag);
static TiXmlNode* SetString(TiXmlNode* pRootNode, const char *strTag, const std::string& strValue);
static void SetAdditiveString(TiXmlNode* pRootNode, const char *strTag, const std::string& strSeparator, const std::string& strValue);
static void SetStringArray(TiXmlNode* pRootNode, const char *strTag, const std::vector<std::string>& arrayValue);
static TiXmlNode* SetInt(TiXmlNode* pRootNode, const char *strTag, int value);
static TiXmlNode* SetFloat(TiXmlNode* pRootNode, const char *strTag, float value);
static TiXmlNode* SetDouble(TiXmlNode* pRootNode, const char* strTag, double value);
static void SetBoolean(TiXmlNode* pRootNode, const char *strTag, bool value);
static void SetHex(TiXmlNode* pRootNode, const char *strTag, uint32_t value);
static void SetPath(TiXmlNode* pRootNode, const char *strTag, const std::string& strValue);
static void SetLong(TiXmlNode* pRootNode, const char *strTag, long iValue);
static void SetDate(TiXmlNode* pRootNode, const char *strTag, const CDateTime& date);
static void SetDateTime(TiXmlNode* pRootNode, const char *strTag, const CDateTime& dateTime);
static const int path_version = 1;
};
|
