// Aqsis
// Copyright (C) 2001, Paul C. Gregory and the other authors and contributors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * 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.
// * Neither the name of the software's owners nor the names of its
//   contributors may be used to endorse or promote products derived from this
//   software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR 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.
//
// (This is the New BSD license)

/// \file
///
/// \brief Aqsis RIB parser interface.
/// \author Chris Foster [chris42f (at) g mail (d0t) com]
///

#ifndef AQSIS_RIBPARSER_H_INCLUDED
#define AQSIS_RIBPARSER_H_INCLUDED

#include <aqsis/config.h>

#include <iosfwd>

namespace Aqsis
{

namespace Ri { class Renderer; class RendererServices; }

//------------------------------------------------------------------------------
/// Parser for standard RIB streams.
///
/// An instance of RibParser parses a RIB stream, sending all encountered
/// interface function calls to the supplied callback interface.
class AQSIS_RIUTIL_SHARE RibParser
{
    public:
        /// Create RIB parser instance
        ///
        /// The services parameter is used by the parser to look up standard
        /// bases from their names, parse string tokens, etc.
        static RibParser* create(Ri::RendererServices& services);

        /// Parse a RIB stream, sending requests to the callback interface
        ///
        /// \param ribStream - RIB stream to be parsed.  May be gzipped.
        /// \param streamName - name of the stream, present in error messages
        /// \param context - parsed interface function calls will be sent here
        virtual void parseStream(std::istream& ribStream,
                                 const std::string& streamName,
                                 Ri::Renderer& context) = 0;

        virtual ~RibParser() {}
};

} // namespace Aqsis

#endif // AQSIS_RIBPARSER_H_INCLUDED
// vi: set et:
