summaryrefslogtreecommitdiffstats
path: root/parameter/Element.cpp
blob: aa4f1b14b90e2f4831ab80ddb3a59835d543ad22 (plain)
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
/* 
 * INTEL CONFIDENTIAL
 * Copyright © 2011 Intel 
 * Corporation All Rights Reserved.
 * 
 * The source code contained or described herein and all documents related to
 * the source code ("Material") are owned by Intel Corporation or its suppliers
 * or licensors. Title to the Material remains with Intel Corporation or its
 * suppliers and licensors. The Material contains trade secrets and proprietary
 * and confidential information of Intel or its suppliers and licensors. The
 * Material is protected by worldwide copyright and trade secret laws and
 * treaty provisions. No part of the Material may be used, copied, reproduced,
 * modified, published, uploaded, posted, transmitted, distributed, or
 * disclosed in any way without Intel’s prior express written permission.
 * 
 * No license under any patent, copyright, trade secret or other intellectual
 * property right is granted to or conferred upon you by disclosure or delivery
 * of the Materials, either expressly, by implication, inducement, estoppel or
 * otherwise. Any license under such intellectual property rights must be
 * express and approved by Intel in writing.
 * 
 * CREATED: 2011-06-01
 * UPDATED: 2011-07-27
 */
#include "Element.h"
#include <assert.h>
#include <stdio.h>
#include <stdarg.h>
#include <sstream>
#include "XmlElementSerializingContext.h"
#include "ElementLibrary.h"
#include "ErrorContext.h"

CElement::CElement(const string& strName) : _strName(strName), _pParent(NULL)
{
}

CElement::~CElement()
{
    removeChildren();
}

// Logging
void CElement::log(const string& strMessage, ...) const
{
    char acBuffer[512];
    va_list listPointer;

    va_start(listPointer, strMessage);

    vsnprintf(acBuffer, sizeof(acBuffer), strMessage.c_str(), listPointer);

    va_end(listPointer);

    doLog(acBuffer);
}

void CElement::doLog(const string& strLog) const
{
    assert(_pParent);

    // Propagate till root
    _pParent->doLog(strLog);
}

void CElement::nestLog() const
{
    assert(_pParent);

    // Propagate till root
    _pParent->nestLog();
}

void CElement::unnestLog() const
{
    assert(_pParent);

    // Propagate till root
    _pParent->unnestLog();
}


void CElement::setDescription(const string& strDescription)
{
    _strDescription = strDescription;
}

const string& CElement::getDescription() const
{
    return _strDescription;
}

bool CElement::childrenAreDynamic() const
{
    // By default, children are searched and not created during xml parsing
    return false;
}

bool CElement::init(string& strError)
{
    uint32_t uiIndex;

    for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

        CElement* pElement = _childArray[uiIndex];;

        if (!pElement->init(strError)) {

            return false;
        }
    }

    return true;
}

void CElement::dumpContent(string& strContent, CErrorContext& errorContext, const uint32_t uiDepth) const
{
    string strIndent;

    // Level
    uint32_t uiNbIndents = uiDepth;

    while (uiNbIndents--) {

        strIndent += "    ";
    }
    // Type
    strContent += strIndent + "- " + getKind();

    // Name
    if (!_strName.empty()) {

        strContent += ": " + getName();
    }

    // Value
    string strValue;
    logValue(strValue, errorContext);

    if (!strValue.empty()) {

        strContent += " = " + strValue;
    }

    strContent += "\n";

    uint32_t uiIndex;

    for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

        _childArray[uiIndex]->dumpContent(strContent, errorContext, uiDepth + 1);
    }
}

// Element properties
void CElement::showProperties(string& strResult) const
{
    strResult = "\n";
    strResult += "Kind: " + getKind() + "\n";
}

// Conversion utilities
string CElement::toString(uint32_t uiValue)
{
    ostringstream ostr;

    ostr << uiValue;

    return ostr.str();
}

string CElement::toString(uint64_t uiValue)
{
    ostringstream ostr;

    ostr << uiValue;

    return ostr.str();
}

string CElement::toString(int32_t iValue)
{
    ostringstream ostr;

    ostr << iValue;

    return ostr.str();
}

string CElement::toString(double dValue)
{
    ostringstream ostr;

    ostr << dValue;

    return ostr.str();
}

// Content dumping
void CElement::logValue(string& strValue, CErrorContext& errorContext) const
{
    (void)strValue;
    (void)errorContext;
}

// From IXmlSink
bool CElement::fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext)
{
    // Propagate through children
    CXmlElement::CChildIterator childIterator(xmlElement);

    // Context
    CXmlElementSerializingContext& elementSerializingContext = static_cast<CXmlElementSerializingContext&>(serializingContext);

    CXmlElement childElement;

    while (childIterator.next(childElement)) {

        CElement* pChild;

        if (!childrenAreDynamic()) {

            pChild = findChildOfKind(childElement.getType());

            if (!pChild) {

                elementSerializingContext.setError("Unable to handle XML element: " + childElement.getPath());

                return false;
            }

        } else {
            // Child needs creation
            pChild = elementSerializingContext.getElementLibrary()->createElement(childElement);

            if (pChild) {

                // Store created child!
                addChild(pChild);
            } else {

                elementSerializingContext.setError("Unable to create XML element " + childElement.getPath());

                return false;
            }
        }

        // Dig
        if (!pChild->fromXml(childElement, elementSerializingContext)) {

            return false;
        }
    }

    return true;
}

// From IXmlSource
void CElement::toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const
{
    // Browse children and propagate
    uint32_t uiNbChildren = getNbChildren();
    uint32_t uiChild;

    for (uiChild = 0; uiChild < uiNbChildren; uiChild++) {

        const CElement* pChild = _childArray[uiChild];

        // Create corresponding child element
        CXmlElement xmlChildElement;

        xmlElement.createChild(xmlChildElement, pChild->getKind());

        // Set attributes
        pChild->setXmlNameAttribute(xmlChildElement);


        // Propagate
        pChild->toXml(xmlChildElement, serializingContext);
    }
}

void CElement::setXmlNameAttribute(CXmlElement& xmlElement) const
{
    // By default, set Name attribute if any
    string strName = getName();

    if (!strName.empty()) {

        xmlElement.setNameAttribute(strName);
    }
}

// Name
void CElement::setName(const string& strName)
{
    _strName = strName;
}

const string& CElement::getName() const
{
    return _strName;
}

bool CElement::rename(const string& strName, string& strError)
{
    // Check for conflict with brotherhood if relevant
    if (_pParent && _pParent->childrenAreDynamic()) {

        uint32_t uiParentChild;
        uint32_t uiParentNbChildren = _pParent->getNbChildren();

        for (uiParentChild = 0; uiParentChild < uiParentNbChildren; uiParentChild++) {

            const CElement* pParentChild = _pParent->getChild(uiParentChild);

            if (pParentChild != this && pParentChild->getName() == strName) {

                // Conflict
                strError = "Name conflicts with brother element";

                return false;
            }
        }
    }
    // Change name
    setName(strName);

    return true;
}

string CElement::getPathName() const
{
    if (!_strName.empty()) {

        return _strName;
    } else {

        return getKind();
    }
}

// Hierarchy
void CElement::addChild(CElement* pChild)
{
    _childArray.push_back(pChild);

    pChild->_pParent = this;
}

CElement* CElement::getChild(uint32_t uiIndex)
{
    assert(uiIndex <= _childArray.size());

    return _childArray[uiIndex];
}

const CElement* CElement::getChild(uint32_t uiIndex) const
{
    assert(uiIndex <= _childArray.size());

    return _childArray[uiIndex];
}

CElement* CElement::getLastChild()
{
    uint32_t uiNbChildren = getNbChildren();

    assert(uiNbChildren);

    return _childArray[uiNbChildren - 1];
}

bool CElement::removeChild(CElement* pChild)
{
    ChildArrayIterator it;

    for (it = _childArray.begin(); it != _childArray.end(); ++it) {

        CElement* pElement = *it;

        if (pElement == pChild) {

            _childArray.erase(it);

            return true;
        }
    }
    return false;
}

void CElement::listChildren(string& strChildList) const
{
    strChildList = "\n";

    // Get list of children names
    uint32_t uiNbChildren = getNbChildren();
    uint32_t uiChild;

    for (uiChild = 0; uiChild < uiNbChildren; uiChild++) {

        const CElement* pChild = _childArray[uiChild];

        strChildList += pChild->getName() + "\n";
    }
}

string CElement::listQualifiedPaths(bool bDive, uint32_t uiLevel) const
{
    uint32_t uiNbChildren = getNbChildren();
    string strResult;

    // Dive Will cause only leaf nodes to be printed
    if (!bDive || !uiNbChildren) {

        strResult = getQualifiedPath() + "\n";
    }

    if (bDive || !uiLevel) {
        // Get list of children paths
        uint32_t uiChild;

        for (uiChild = 0; uiChild < uiNbChildren; uiChild++) {

            const CElement* pChild = _childArray[uiChild];

            strResult += pChild->listQualifiedPaths(bDive, uiLevel + 1);
        }
    }
    return strResult;
}

void CElement::listChildrenPaths(string& strChildList) const
{
    // Get list of children paths
    uint32_t uiNbChildren = getNbChildren();
    uint32_t uiChild;

    for (uiChild = 0; uiChild < uiNbChildren; uiChild++) {

        const CElement* pChild = _childArray[uiChild];

        strChildList += pChild->getPath() + "\n";
    }
}

uint32_t CElement::getNbChildren() const
{
    return _childArray.size();
}

const CElement* CElement::getParent() const
{
    return _pParent;
}

CElement* CElement::getParent()
{
    return _pParent;
}

void CElement::clean()
{
    if (childrenAreDynamic()) {

        removeChildren();
    } else {
        // Just propagate
        uint32_t uiIndex;

        for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

            _childArray[uiIndex]->clean();
        }
    }
}

void CElement::removeChildren()
{
    // Delete in reverse order
    ChildArrayReverseIterator it;

    for (it = _childArray.rbegin(); it != _childArray.rend(); ++it) {

        delete *it;
    }
    _childArray.clear();
}

const CElement* CElement::findDescendant(CPathNavigator& pathNavigator) const
{
    string* pStrChildName = pathNavigator.next();

    if (!pStrChildName) {

        return this;
    }

    const CElement* pChild = findChild(*pStrChildName);

    if (!pChild) {

        return NULL;
    }

    return pChild->findDescendant(pathNavigator);
}

CElement* CElement::findDescendant(CPathNavigator& pathNavigator)
{
    string* pStrChildName = pathNavigator.next();

    if (!pStrChildName) {

        return this;
    }

    CElement* pChild = findChild(*pStrChildName);

    if (!pChild) {

        return NULL;
    }

    return pChild->findDescendant(pathNavigator);
}

bool CElement::isDescendantOf(const CElement* pCandidateAscendant) const
{
    if (!_pParent) {

        return false;
    }
    if (_pParent == pCandidateAscendant) {

        return true;
    }
    return _pParent->isDescendantOf(pCandidateAscendant);
}

CElement* CElement::findAscendantOfKind(const string& strKind)
{
    if (!_pParent) {

        return NULL;
    }

    if (_pParent->getKind() == strKind) {

        return _pParent;
    }
    return _pParent->findAscendantOfKind(strKind);
}

CElement* CElement::findChild(const string& strName)
{
    uint32_t uiIndex;

    for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

        CElement* pElement = _childArray[uiIndex];

        if (pElement->getPathName() == strName) {

            return pElement;
        }
    }

    return NULL;
}

const CElement* CElement::findChild(const string& strName) const
{
    uint32_t uiIndex;

    for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

        const CElement* pElement = _childArray[uiIndex];

        if (pElement->getPathName() == strName) {

            return pElement;
        }
    }

    return NULL;
}

CElement* CElement::findChildOfKind(const string& strKind)
{
    uint32_t uiIndex;

    for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

        CElement* pElement = _childArray[uiIndex];

        if (pElement->getKind() == strKind) {

            return pElement;
        }
    }

    return NULL;
}

const CElement* CElement::findChildOfKind(const string& strKind) const
{
    uint32_t uiIndex;

    for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

        const CElement* pElement = _childArray[uiIndex];;

        if (pElement->getKind() == strKind) {

            return pElement;
        }
    }

    return NULL;
}

CElement* CElement::getRoot()
{
    if (!_pParent) {

        return this;
    }
    return _pParent->getRoot();
}

const CElement* CElement::getRoot() const
{
    if (!_pParent) {

        return this;
    }
    return _pParent->getRoot();
}

string CElement::getPath() const
{
    // Take out root element from the path
    if (_pParent && _pParent->_pParent) {

        return _pParent->getPath() + "/" + getPathName();
    }
    return "/" + getPathName();
}

string CElement::getQualifiedPath() const
{
    return getPath() + " [" + getKind() + "]";
}

uint32_t CElement::getDepth() const
{
    if (_pParent) {

        return _pParent->getDepth() + 1;
    }

    return 0;
}

// Checksum for integrity checks
uint8_t CElement::computeStructureChecksum() const
{
    // Base checksum computation on element kind
    string strKind = getKind();

    // Get element kind
    const char* pcData = strKind.c_str();

    // Cumulate
    uint8_t uiChecksum = 0;

    while (*pcData) {

        uiChecksum += *pcData++;
    }

    // Propagate
    uint32_t uiIndex;
    for (uiIndex = 0; uiIndex < _childArray.size(); uiIndex++) {

        const CElement* pChild = _childArray[uiIndex];

        uiChecksum += pChild->computeStructureChecksum();
    }

    return uiChecksum;
}

// Utility to underline
void CElement::appendTitle(string& strTo, const string& strTitle)
{
    strTo += "\n" + strTitle + "\n";

    uint32_t uiLength = strTitle.size();

    while (uiLength--) {

        strTo += "=";
    }
    strTo += "\n";
}