1 /*
2  * Copyright (c) 2011-2014, Intel Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #pragma once
32 #include <string>
33 #include "XmlDocSource.h"
34 #include "XmlSource.h"
35 
36 /**
37   * Source class that uses parameter-framework's structures to create an xml document
38   */
39 class CXmlMemoryDocSource : public CXmlDocSource
40 {
41 public:
42     /**
43       * Constructor
44       *
45       * @param[in] pXmlSource a pointer to a parameter-framework structure that can generate
46       * an xml description of itself
47       * @param[in] strRootElementType a string containing the root element type
48       * @param[in] strProduct a string containing the product name
49       * @param[in] strVersion a string containing the version number
50       * @param[in] bValidateWithSchema a boolean that toggles schema validation
51       */
52     CXmlMemoryDocSource(const IXmlSource *pXmlSource, bool bValidateWithSchema,
53                         const std::string &strRootElementType, const std::string &strProduct = "",
54                         const std::string &strVersion = "");
55 
56     /**
57       * Implementation of CXmlDocSource::populate() method.
58       * Method that popuplates the Xml document using the IXmlSource given in the constructor.
59       *
60       * @param[out] serializingContext is used as error output
61       *
62       * @return false if any error occurs
63       */
64     virtual bool populate(CXmlSerializingContext &serializingContext);
65 
66 private:
67     /**
68       * Initialize root element
69       */
70     void init();
71 
72     /**
73       * Xml Source
74       */
75     const IXmlSource *_pXmlSource;
76 
77     /**
78       * Schema file
79       */
80     std::string _strXmlSchemaFile;
81 
82     // Product and version info
83     std::string _strProduct;
84     std::string _strVersion;
85 };
86