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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* 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 <string>
#include <vector>
#include <stdint.h>
#include <list>
#include "XmlSink.h"
#include "XmlSource.h"
#include "PathNavigator.h"
class CXmlElementSerializingContext;
class CErrorContext;
class CElement : public IXmlSink, public IXmlSource
{
friend class CAutoLog;
public:
CElement(const std::string& strName = "");
virtual ~CElement();
// Logging
void log_info(const char* strMessage, ...) const;
void log_warning(const char* strMessage, ...) const;
void log_table(bool bIsWarning, const std::list<std::string> lstrMessage) const;
// Description
void setDescription(const std::string& strDescription);
const std::string& getDescription() const;
// Name / Path
const std::string& getName() const;
void setName(const std::string& strName);
bool rename(const std::string& strName, std::string& strError);
std::string getPath() const;
std::string getQualifiedPath() const;
// Creation / build
virtual bool init(std::string& strError);
virtual void clean();
// Children management
void addChild(CElement* pChild);
bool removeChild(CElement* pChild);
void listChildren(std::string& strChildList) const;
std::string listQualifiedPaths(bool bDive, uint32_t uiLevel = 0) const;
void listChildrenPaths(std::string& strChildPathList) const;
// Hierarchy query
size_t getNbChildren() const;
CElement* findChildOfKind(const std::string& strKind);
const CElement* findChildOfKind(const std::string& strKind) const;
const CElement* getParent() const;
/**
* Get a child element (const)
*
* Note: this method will assert if given a wrong child index (>= number of children)
*
* @param[in] uiIndex the index of the child element from 0 to number of children - 1
* @return the child element
*/
const CElement* getChild(size_t uiIndex) const;
/**
* Get a child element
*
* Note: this method will assert if given a wrong child index (>= number of children)
*
* @param[in] uiIndex the index of the child element from 0 to number of children - 1
* @return the child element
*/
CElement* getChild(size_t uiIndex);
const CElement* findChild(const std::string& strName) const;
CElement* findChild(const std::string& strName);
const CElement* findDescendant(CPathNavigator& pathNavigator) const;
CElement* findDescendant(CPathNavigator& pathNavigator);
bool isDescendantOf(const CElement* pCandidateAscendant) const;
// From IXmlSink
virtual bool fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
// From IXmlSource
virtual void toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const;
/**
* Serialize the children to XML
*
* This method is virtual, to be derived in case a special treatment is
* needed before doing so.
*
* @param[in,out] xmlElement the XML Element below which the children must
* be serialized (which may or may not be the CElement
* object upon which this method is called)
* @param[in,out] serializingContext information about the serialization
*/
virtual void childrenToXml(CXmlElement& xmlElement,
CXmlSerializingContext& serializingContext) const;
// Content structure dump
void dumpContent(std::string& strContent, CErrorContext& errorContext, const uint32_t uiDepth = 0) const;
// Element properties
virtual void showProperties(std::string& strResult) const;
// Checksum for integrity checks
uint8_t computeStructureChecksum() const;
// Class kind
virtual std::string getKind() const = 0;
/**
* Fill the Description field of the Xml Element during XML composing.
*
* @param[in,out] xmlElement to fill with the description
*/
void setXmlDescriptionAttribute(CXmlElement& xmlElement) const;
/**
* Extract the Description field from the Xml Element during XML decomposing.
*
* @param[in] xmlElement to extract the description from.
*
* @return description represented as a string, empty if not found
*/
std::string getXmlDescriptionAttribute(const CXmlElement &xmlElement) const;
/**
* Appends if found human readable description property.
*
* @param[out] strResult in which the description is wished to be appended.
*/
void showDescriptionProperty(std::string &strResult) const;
protected:
// Content dumping
virtual void logValue(std::string& strValue, CErrorContext& errorContext) const;
// Hierarchy
CElement* getParent();
/**
* Creates a child CElement from a child XML Element
*
* @param[in] childElement the XML element to create CElement from
* @param[in] elementSerializingContext the serializing context
*
* @return child a pointer on the CElement object that has been added to the tree
*/
CElement* createChild(const CXmlElement& childElement,
CXmlSerializingContext& elementSerializingContext);
private:
// Logging (done by root)
virtual void doLog(bool bIsWarning, const std::string& strLog) const;
virtual void nestLog() const;
virtual void unnestLog() const;
// Returns Name or Kind if no Name
std::string getPathName() const;
// Returns true if children dynamic creation is to be dealt with
virtual bool childrenAreDynamic() const;
// House keeping
void removeChildren();
// For logging
uint32_t getDepth() const;
// Fill XmlElement during XML composing
void setXmlNameAttribute(CXmlElement& xmlElement) const;
// Name
std::string _strName;
// Description
std::string _strDescription;
// Child iterators
typedef std::vector<CElement*>::iterator ChildArrayIterator;
typedef std::vector<CElement*>::reverse_iterator ChildArrayReverseIterator;
// Children
std::vector<CElement*> _childArray;
// Parent
CElement* _pParent;
static const std::string gDescriptionPropertyName;
};
|
