Cinder

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

include/cinder/DataTarget.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/Url.h"
00027 #include "cinder/Stream.h"
00028 
00029 #include <string>
00030 
00031 namespace cinder {
00032 
00033 typedef std::shared_ptr<class DataTarget>   DataTargetRef;
00034 
00035 class DataTarget { 
00036   public:
00037     virtual bool    providesFilePath() = 0;
00038     virtual bool    providesUrl() = 0;
00039     
00040     const fs::path&         getFilePath() const;
00041     const Url&              getUrl() const;
00042     const std::string&      getFilePathHint() const;
00043 
00044     virtual OStreamRef      getStream() = 0;
00045 
00046   protected:
00047     DataTarget( const fs::path &aFilePath, const Url &aUrl )
00048         : mFilePath( aFilePath ), mUrl( aUrl ) 
00049     {}
00050     virtual ~DataTarget() {}
00051     
00052     void    setFilePathHint( const std::string &aFilePathHint );
00053     
00054     Buffer              mBuffer;
00055     fs::path            mFilePath;
00056     std::string         mFilePathHint;
00057     Url                 mUrl;
00058 };
00059 
00060 
00061 typedef std::shared_ptr<class DataTargetPath>   DataTargetPathRef;
00062 
00063 class DataTargetPath : public DataTarget {
00064   public:
00065     static DataTargetPathRef    createRef( const fs::path &path );
00066     
00067     virtual bool    providesFilePath() { return true; }
00068     virtual bool    providesUrl() { return false; }
00069     
00070     virtual OStreamRef      getStream();
00071     
00072   protected:
00073     explicit DataTargetPath( const fs::path &path );
00074   
00075     OStreamFileRef  mStream;  
00076 };
00077 
00078 
00079 typedef std::shared_ptr<class DataTargetStream> DataTargetStreamRef;
00080 
00081 class DataTargetStream : public DataTarget {
00082   public:
00083     static DataTargetStreamRef  createRef( OStreamRef stream );
00084 
00085     virtual bool    providesFilePath() { return false; }
00086     virtual bool    providesUrl() { return false; }
00087     
00088     virtual OStreamRef      getStream() { return mStream; }
00089     
00090   protected:
00091     DataTargetStream( OStreamRef stream );
00092   
00093     OStreamRef  mStream;    
00094 };
00095 
00097 DataTargetPathRef writeFile( const fs::path &path, bool createParents = true );
00098 
00099 } // namespace cinder