OSDLEmbeddedFile.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL library 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 and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_EMBEDDED_FILE_H_
#define OSDL_EMBEDDED_FILE_H_



#include "Ceylan.h"  // for inheritance and FileSystemManagerException



#if ! defined(OSDL_USES_PHYSICSFS) || OSDL_USES_PHYSICSFS 

// No need to include PhysicsFS header here:
struct PHYSFS_File ;

#endif //  ! defined(OSDL_USES_PHYSICSFS) || OSDL_USES_PHYSICSFS 




namespace OSDL
{


        
    class OSDL_DLL EmbeddedFileException: public Ceylan::System::FileException
    { 
    
        public: 
       
            explicit EmbeddedFileException( const std::string & reason ) ;
           
            virtual ~EmbeddedFileException() throw() ; 
               
    } ;

    
    
    
    class OSDL_DLL EmbeddedFile: public Ceylan::System::File
    {
    
            
        public:



            virtual ~EmbeddedFile() throw() ;




            // Implementation of instance methods inherited from File.



            virtual bool isOpen() const ;



            virtual bool close() ;



            virtual void saveAs( const std::string & newName ) ;




            // Locking section.

             
             
            virtual void lockForReading() const ;



            virtual void unlockForReading() const ;



            virtual void lockForWriting() const ;



            virtual void unlockForWriting() const ;



            virtual bool isLocked() const ;



            // size method inherited from File.



            virtual time_t getLastChangeTime() const ;



            virtual Ceylan::System::Size read( Ceylan::Byte * buffer, 
                Ceylan::System::Size maxLength ) ;


            
            // readExactLength inherited.
                        
                            
            // hasAvailableData inherited.
            
            
            
            virtual Ceylan::System::Size write( const std::string & message ) ;



            virtual Ceylan::System::Size write( const Ceylan::Byte * buffer, 
                Ceylan::System::Size maxLength ) ;



            virtual Ceylan::System::Position tell() ;



            virtual void seek( Ceylan::System::Position targetPosition ) ;



            // open and remove inherited.



            // EmbeddedFile-specific methods.
            
            
                        
            virtual Ceylan::System::Size size() const ;
    
    
    
            virtual void serialize( PHYSFS_File & handle ) ;



            PHYSFS_File & getPhysicsFSHandle() const ;



            static void CypherBuffer( Ceylan::Byte * buffer, 
                Ceylan::System::Size size ) ;



            static void DecypherBuffer( Ceylan::Byte * buffer, 
                Ceylan::System::Size size ) ;




            // Interface implementation.



            virtual Ceylan::System::StreamID getStreamID() const ;



            // getInputStreamID inherited.
            
            
            // getOutputStreamID inherited.
            
            
            
            virtual const std::string toString( 
                Ceylan::VerbosityLevels level = Ceylan::high ) const ;

                            



            /*
             * Helper section.
             *
             * Factories still have to be public, to allow to create on
             * specific cases (ex: process redirection) specifically
             * embedded files, not only files.
             *
             */
            
    
    
            static EmbeddedFile & Create( const std::string & filename, 
                Ceylan::System::OpeningFlag createFlag 
                    = Ceylan::System::File::CreateToWriteBinary,
                Ceylan::System::PermissionFlag permissionFlag 
                    = Ceylan::System::File::OwnerReadWrite ) ;

            
            
            static EmbeddedFile & Open( const std::string & filename, 
                Ceylan::System::OpeningFlag openFlag 
                    = Ceylan::System::File::OpenToReadBinary ) ;
            
    
            
            
        protected:
    
    

            explicit EmbeddedFile( const std::string & name, 
                Ceylan::System::OpeningFlag openFlag 
                    = Ceylan::System::File::CreateToWriteBinary,
                Ceylan::System::PermissionFlag permissionFlag 
                    = Ceylan::System::File::OwnerReadWrite ) ;





            // Implementations of inherited methods.
            
            
            
            virtual Ceylan::System::FileSystemManager &
                getCorrespondingFileSystemManager() const ;



            virtual void reopen() ;

            
            
            virtual std::string interpretState() const ;




        private:



            PHYSFS_File * _physfsHandle ;           
             

            bool _cypher ;



            EmbeddedFile( const EmbeddedFile & source ) ;



            EmbeddedFile & operator = ( const EmbeddedFile & source ) ;



            static void FromHandletoHandle( PHYSFS_File & from, 
                PHYSFS_File & to, Ceylan::System::Size length ) ;


    } ;
    
    
}



#endif // OSDL_EMBEDDED_FILE_H_

---