xmlserializer/XmlDocSource.h

/*
 * 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: 2012-08-10
 */

#pragma once

#include "XmlElement.h"
#include "XmlSerializingContext.h"

struct _xmlDoc;
struct _xmlNode;

class CXmlDocSource
{
public:
    CXmlDocSource(_xmlDoc* pDoc, _xmlNode* pRootNode = NULL);
    virtual ~CXmlDocSource();

    // Method Called by the CXmlDocSink::process method
    virtual bool populate(CXmlSerializingContext& serializingContext) = 0;

    // Root element
    void getRootElement(CXmlElement& xmlRootElement) const;
    string getRootElementName() const;
    string getRootElementAttributeString(const string& strAttributeName) const;

    // Method that returns the xmlDoc contained in the Source. (Can be used in a Doc Sink)
    _xmlDoc* getDoc() const;


protected:

    // Doc
    _xmlDoc* _pDoc;

    // Root node
    _xmlNode* _pRootNode;

    // libxml2 library cleanup
    static bool _bLibXml2CleanupScheduled;
};