StreamFile.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCORESTREAMFILE_H
00029 #define ROCKETCORESTREAMFILE_H
00030 
00031 #include <Rocket/Core/Stream.h>
00032 #include <Rocket/Core/Types.h>
00033 
00034 namespace Rocket {
00035 namespace Core {
00036 
00041 class StreamFile : public Stream
00042 {
00043 public:
00044         StreamFile();
00045         virtual ~StreamFile();
00046 
00048         bool Open(const String& path);
00050         virtual void Close();
00051 
00053         virtual size_t Length() const;
00054 
00056         virtual size_t Tell() const;
00058         virtual bool Seek(long offset, int origin) const;
00059 
00061         virtual size_t Read(void* buffer, size_t bytes) const;
00062         using Stream::Read;
00063 
00065         virtual size_t Write(const void* buffer, size_t bytes);
00066         using Stream::Write;
00067 
00069         virtual size_t Truncate(size_t bytes);
00070 
00072         virtual bool IsReadReady();
00074         virtual bool IsWriteReady();
00075 
00076 private:
00077         // Determines the length of the stream.
00078         void GetLength();
00079 
00080         FileHandle file_handle;
00081         size_t length;
00082 };
00083 
00084 }
00085 }
00086 
00087 #endif