// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// 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 Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_XMLINPUTSOURCE_H
#define TEUCHOS_XMLINPUTSOURCE_H

/*! \file Teuchos_XMLInputSource.hpp
    \brief A base class for defining a source of XML input.
*/

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_XMLObject.hpp"
#include "Teuchos_XMLInputStream.hpp"

namespace Teuchos
{
  /**
   * \brief XMLInputSource represents a source of XML input that can be parsed
   * to produce an XMLObject.
   *
   * \note
   *	<ul>
   *	<li>The source might be a file, a socket, a
   * std::string. The XMLObject is created with a call to the getObject() method.
   *
   *    <li> The source gets its data from a XMLInputStream object that is
   * created (internally) to work with this source.
   *
   *    <li> getObject() is implemented with EXPAT if Teuchos is configured with
   * <tt>--enable-expat</tt>.
   *	</ul>
   */
  class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT XMLInputSource
    {
    public:
      /** \brief Empty constructor */
      XMLInputSource(){;}

      /** \brief Destructor */
      virtual ~XMLInputSource(){;}

      /** \brief Virtual input source interface */
      virtual RCP<XMLInputStream> stream() const = 0 ;

      /** \brief Get an object by invoking the TreeBuildingXMLHandler on the
       * input data */
      XMLObject getObject() const ;

    };

}
#endif

