/home/cube/sources/osgearth/src/osgEarth/URI

Go to the documentation of this file.

/* -*-c++-*- */
/* osgEarth - Dynamic map generation toolkit for OpenSceneGraph
 * Copyright 2008-2010 Pelican Mapping
 * http://osgearth.org
 *
 * osgEarth is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 */
#ifndef OSGEARTH_URI
#define OSGEARTH_URI

#include <osgEarth/Common>
#include <osgEarth/FileUtils>
#include <osg/Image>
#include <osg/Node>
#include <osgDB/ReaderWriter>
#include <iostream>
#include <sstream>

namespace osgEarth
{
    class Config;
    class URI;

    class OSGEARTH_EXPORT URIContext
    {
    public:
        URIContext() { }

        URIContext( const std::string& referrer ) : _referrer(referrer) { }

        URIContext( const URIContext& rhs ) : _referrer(rhs._referrer) { }

        void store( osgDB::Options* options );

        URIContext( const osgDB::Options* options );

        const std::string& referrer() const { return _referrer; }

        bool empty() const { return _referrer.empty(); }

        URIContext add( const URIContext& subContext ) const;

        URIContext add( const std::string& subPath ) const;

        std::string getOSGPath( const std::string& target ) const;

    private:
        friend class URI;
        std::string _referrer;
    };

    class OSGEARTH_EXPORT URIStream
    {
    public:
        URIStream( const URI& uri );

        virtual ~URIStream();

    public:
        // auto-cast to istream
        operator std::istream& ();

    protected:
        friend class URI;
        std::istream*     _fileStream;
        std::stringstream _bufStream;
    };

    class OSGEARTH_EXPORT URI
    {
    public:
        URI();

        URI( const std::string& location );
        
        URI( const std::string& location, const URIContext& context );

        URI( const char* location );

    public:

        const std::string& base() const { return _baseURI; }

        const std::string& full() const { return _fullURI; }

        const std::string& operator * () const { return _fullURI; }

        const URIContext& context() const { return _context; }

        bool empty() const { return _baseURI.empty(); }

        URI append( const std::string& suffix ) const;

    public:

        bool operator < ( const URI& rhs ) const { return _fullURI < rhs._fullURI; }

    public: // convenience reader methods

        enum ResultCode {
            RESULT_OK,
            RESULT_CANCELED,
            RESULT_NOT_FOUND,
            RESULT_SERVER_ERROR,
            RESULT_TIMEOUT,
            RESULT_NO_READER,
            RESULT_READER_ERROR,
            RESULT_UNKNOWN_ERROR
        };

        osg::Object* readObject(
            const osgDB::Options* options  =0L,
            ResultCode*           out_code =0L ) const;

        osg::Image* readImage(
            const osgDB::Options* options  =0L,
            ResultCode*           out_code =0L ) const;

        osg::Node* readNode(
            const osgDB::Options* options  =0L,
            ResultCode*           out_code =0L ) const;

        std::string readString(
            ResultCode* out_code =0L ) const;

    public:
        URI( const URI& rhs ) : _baseURI(rhs._baseURI), _fullURI(rhs._fullURI), _context(rhs._context) { }

    public:
        //TODO: methods to load data from the URI.

    protected:
        std::string _baseURI;
        std::string _fullURI;
        URIContext  _context;
    };
}

#endif // OSGEARTH_URI