Home | History | Annotate | Download | only in xmlserializer
      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 "XmlDocSink.h"
     33 #include "XmlSink.h"
     34 
     35 /**
     36   * Sink class used to parse an xml document and instanciate parameter-framework structures.
     37   */
     38 class CXmlMemoryDocSink : public CXmlDocSink
     39 {
     40 public:
     41     /**
     42       * Constructor
     43       *
     44       * @param[out] pXmlSink a pointer to a parameter-framework structure that can parse an xml
     45       * description to instanciate itself
     46       */
     47     CXmlMemoryDocSink(IXmlSink *pXmlSink);
     48 
     49 private:
     50     /**
     51       * Implementation of CXmlDocSink::doProcess()
     52       * Parse the Xml document contained in xmlDocSource to instanciate the parameter-framework
     53       * structures.
     54       *
     55       * @param[in] xmlDocSource is the source containing the Xml document
     56       * @param[out] serializingContext is used as error output
     57       *
     58       * @return false if any error occurs
     59       */
     60     virtual bool doProcess(CXmlDocSource &xmlDocSource, CXmlSerializingContext &serializingContext);
     61 
     62     // Xml Sink
     63     IXmlSink *_pXmlSink;
     64 };
     65