Cinder

  • Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List
  • File Members

include/cinder/Url.h

Go to the documentation of this file.
00001 /*
00002  Copyright (c) 2010, The Barbarian Group
00003  All rights reserved.
00004 
00005  Redistribution and use in source and binary forms, with or without modification, are permitted provided that
00006  the following conditions are met:
00007 
00008     * Redistributions of source code must retain the above copyright notice, this list of conditions and
00009     the following disclaimer.
00010     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
00011     the following disclaimer in the documentation and/or other materials provided with the distribution.
00012 
00013  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
00014  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00015  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00016  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00017  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00018  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00019  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00020  POSSIBILITY OF SUCH DAMAGE.
00021 */
00022 
00023 #pragma once
00024 
00025 #include "cinder/Cinder.h"
00026 #include "cinder/Stream.h"
00027 
00028 namespace cinder {
00029 
00030 class Url {
00031  public:
00032     Url() {}
00033     explicit Url( const std::string &urlString );
00034     
00035     std::string str() const { return mStr; }
00036     const char* c_str() const { return mStr.c_str(); }
00037         
00038  private:
00039     std::string     mStr;
00040 };
00041 
00043 // This is an abstract base class for implementing IStreamUrl
00044 class IStreamUrlImpl {
00045   protected:
00046     IStreamUrlImpl( const std::string &user, const std::string &password )
00047         : mUser( user ), mPassword( password ) {}
00048 
00049   public:
00050     virtual ~IStreamUrlImpl() {}
00051   
00052     std::string         getUser() const { return mUser; }
00053     std::string         getPassword() const { return mPassword; }
00054 
00055     virtual size_t      readDataAvailable( void *dest, size_t maxSize ) = 0;
00056     virtual void        seekAbsolute( off_t absoluteOffset ) = 0;
00057     virtual void        seekRelative( off_t relativeOffset ) = 0;
00058     virtual off_t       tell() const = 0;
00059     virtual off_t       size() const = 0;
00060     
00061     virtual bool        isEof() const = 0;
00062     virtual void        IORead( void *t, size_t size ) = 0;
00063     
00064   protected:
00065     const std::string       mUser, mPassword;
00066 };
00068 
00070 typedef shared_ptr<class IStreamUrl>    IStreamUrlRef;
00071 
00073 class IStreamUrl : public IStream {
00074   public:
00076     static IStreamUrlRef    createRef( const std::string &url, const std::string &user = "", const std::string &password = "" );
00077 
00078     virtual size_t      readDataAvailable( void *dest, size_t maxSize ) { return mImpl->readDataAvailable( dest, maxSize ); }
00079     virtual void        seekAbsolute( off_t absoluteOffset ) { return seekAbsolute( absoluteOffset ); }
00080     virtual void        seekRelative( off_t relativeOffset ) { return seekRelative( relativeOffset ); }
00081     virtual off_t       tell() const { return mImpl->tell(); }
00082     virtual off_t       size() const { return mImpl->size(); }
00083     
00084     virtual bool        isEof() const { return mImpl->isEof(); }
00085 
00086     std::string         getUser() const { return mImpl->getUser(); }
00087     std::string         getPassword() const { return mImpl->getPassword(); }
00088 
00089   protected:
00090     IStreamUrl( const std::string &url, const std::string &user, const std::string &password );
00091 
00092     virtual void        IORead( void *t, size_t size ) { mImpl->IORead( t, size ); }
00094     virtual void        IOWrite( const void *t, size_t size ) { throw std::exception(); }
00095     
00096     shared_ptr<IStreamUrlImpl>  mImpl;
00097 };
00098 
00099 IStreamUrlRef       loadUrlStream( const Url &url );
00100 IStreamUrlRef       loadUrlStream( const std::string &url, const std::string &user = "", const std::string &password = "" );
00101 
00102 } // namespace cinder