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
96
97
98
99
100
101
102
103
104
|
/*
* Copyright (c) 2011-2014, Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "XmlDocSource.h"
#include <string>
/**
* Source class that read a file to get an xml document.
* Its base class will validate the document.
*/
class CXmlFileDocSource : public CXmlDocSource
{
public:
/**
* Constructor
*
* @param[in] strXmlInstanceFile a string containing the path to the xml file
* @param[in] strXmlSchemaFile a string containing the path to the schema file
* @param[in] strRootElementType a string containing the root element type
* @param[in] strRootElementName a string containing the root element name
* @param[in] strNameAttributeName a string containing the name of the root name attribute
* @param[in] bValidateWithSchema a boolean that toggles schema validation
*/
CXmlFileDocSource(const std::string& strXmlInstanceFile,
const std::string& strXmlSchemaFile,
const std::string& strRootElementType,
const std::string& strRootElementName,
const std::string& strNameAttrituteName,
bool bValidateWithSchema);
/**
* Constructor
*
* @param[in] strXmlInstanceFile a string containing the path to the xml file
* @param[in] strXmlSchemaFile a string containing the path to the schema file
* @param[in] strRootElementType a string containing the root element type
* @param[in] bValidateWithSchema a boolean that toggles schema validation
*/
CXmlFileDocSource(const std::string& strXmlInstanceFile, const std::string& strXmlSchemaFile, const std::string& strRootElementType,
bool bValidateWithSchema);
/**
* CXmlDocSource method implementation.
*
* @param[out] serializingContext is used as error output
*
* @return false if any error occurs
*/
virtual bool populate(CXmlSerializingContext& serializingContext);
/**
* Method that checks that the file exists and is readable.
*
* @param[out] serializingContext is used as error output
*
* @return false if any error occurs during the parsing
*/
virtual bool isParsable(CXmlSerializingContext& serializingContext) const;
private:
/**
* Read xml file
*
* This function reads an xml file and processes eventual included files
* WARNING: to compile this function, libxml2 has to be compiled with LIBXML_XINCLUDE_ENABLED
*
* @param[in] strFileName the file name
*
* @return a pointer to generated xml document object
*/
static _xmlDoc* readFile(const std::string& strFileName);
/**
* Instance file
*/
std::string _strXmlInstanceFile;
};
|
