add FileStream class

* minimize memory consumption by using FileStream for loading sprites

src/framework/core/declarations.h

@@ -26,12 +26,15 @@
 #include <framework/global.h>
 
 class ModuleManager;
+class ResourceManager;
 class Module;
 class Event;
 class ScheduledEvent;
+class FileStream;
 
 typedef std::shared_ptr<Module> ModulePtr;
 typedef std::shared_ptr<Event> EventPtr;
 typedef std::shared_ptr<ScheduledEvent> ScheduledEventPtr;
+typedef std::shared_ptr<FileStream> FileStreamPtr;
 
 #endif

src/framework/core/filestream.cpp

@@ -0,0 +1,131 @@
+/*
+ * Copyright (c) 2010-2012 OTClient <https://github.com/edubart/otclient>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "filestream.h"
+
+#include <physfs.h>
+
+FileStream::FileStream(const std::string& name, PHYSFS_File *fileHandle)
+{
+    m_name = name;
+    m_fileHandle = fileHandle;
+}
+
+FileStream::~FileStream()
+{
+    close();
+}
+
+void FileStream::close()
+{
+    if(m_fileHandle) {
+        if(PHYSFS_isInit() && PHYSFS_close(m_fileHandle) == 0)
+            logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+
+        m_fileHandle = nullptr;
+    }
+}
+
+void FileStream::flush()
+{
+    if(PHYSFS_flush(m_fileHandle) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}
+
+void FileStream::read(void *buffer, uint count)
+{
+    if(PHYSFS_read(m_fileHandle, buffer, 1, count) != count)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}
+
+void FileStream::write(void *buffer, uint count)
+{
+    if(PHYSFS_write(m_fileHandle, buffer, 1, count) != count)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}
+
+void FileStream::seek(uint pos)
+{
+    if(PHYSFS_seek(m_fileHandle, pos) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}
+
+int FileStream::size()
+{
+    return PHYSFS_fileLength(m_fileHandle);
+}
+
+uint8 FileStream::getU8()
+{
+    uint8 v = 0;
+    if(PHYSFS_read(m_fileHandle, &v, 1, 1) != 1)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+    return v;
+}
+
+uint16 FileStream::getU16()
+{
+    uint16 v = 0;
+    if(PHYSFS_readULE16(m_fileHandle, &v) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+    return v;
+}
+
+uint32 FileStream::getU32()
+{
+    uint32 v = 0;
+    if(PHYSFS_readULE32(m_fileHandle, &v) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+    return v;
+}
+
+uint64 FileStream::getU64()
+{
+    uint64 v = 0;
+    if(PHYSFS_readULE64(m_fileHandle, (PHYSFS_uint64*)&v) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+    return v;
+}
+
+void FileStream::addU8(uint8 v)
+{
+    if(PHYSFS_write(m_fileHandle, &v, 1, 1) != 1)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}
+
+void FileStream::addU16(uint8 v)
+{
+    if(PHYSFS_writeULE16(m_fileHandle, v) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}
+
+void FileStream::addU32(uint8 v)
+{
+    if(PHYSFS_writeULE32(m_fileHandle, v) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}
+
+void FileStream::addU64(uint8 v)
+{
+    if(PHYSFS_writeULE64(m_fileHandle, v) == 0)
+        logTraceError("operation failed on '", m_name, "': ", PHYSFS_getLastError());
+}

src/framework/core/filestream.h

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2010-2012 OTClient <https://github.com/edubart/otclient>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef FILESTREAM_H
+#define FILESTREAM_H
+
+#include "declarations.h"
+
+struct PHYSFS_File;
+
+class FileStream
+{
+protected:
+    FileStream(const std::string& name, PHYSFS_File *fileHandle);
+
+    friend class ResourceManager;
+
+public:
+    ~FileStream();
+
+    void close();
+    void flush();
+    void write(void *buffer, uint count);
+    void read(void *buffer, uint count);
+    void seek(uint pos);
+    int size();
+    std::string name() { return m_name; }
+
+    std::string readAll();
+
+    uint8 getU8();
+    uint16 getU16();
+    uint32 getU32();
+    uint64 getU64();
+    void addU8(uint8 v);
+    void addU16(uint8 v);
+    void addU32(uint8 v);
+    void addU64(uint8 v);
+
+private:
+    std::string m_name;
+    PHYSFS_File *m_fileHandle;
+};
+
+#endif

src/framework/core/resourcemanager.cpp

@@ -21,6 +21,7 @@
  */
 
 #include "resourcemanager.h"
+#include "filestream.h"
 
 #include <framework/application.h>
 #include <framework/luascript/luainterface.h>
@@ -114,7 +115,7 @@ std::string ResourceManager::loadFile(const std::string& fileName)
 
 bool ResourceManager::saveFile(const std::string& fileName, const uchar* data, uint size)
 {
-    PHYSFS_file* file = PHYSFS_openWrite(checkPath(fileName).c_str());
+    PHYSFS_file* file = PHYSFS_openWrite(fileName.c_str());
     if(!file)
         return false;
 
@@ -141,6 +142,37 @@ bool ResourceManager::saveFile(const std::string& fileName, const std::string& d
     return saveFile(fileName, (const uchar*)data.c_str(), data.size());
 }
 
+FileStreamPtr ResourceManager::openFile(const std::string& fileName)
+{
+    std::string fullPath = checkPath(fileName);
+    PHYSFS_File* file = PHYSFS_openRead(fullPath.c_str());
+    if(!file) {
+        logTraceError("unable to open file '", fullPath, "': ", PHYSFS_getLastError());
+        return nullptr;
+    }
+    return FileStreamPtr(new FileStream(fullPath, file));
+}
+
+FileStreamPtr ResourceManager::appendFile(const std::string& fileName)
+{
+    PHYSFS_File* file = PHYSFS_openAppend(fileName.c_str());
+    if(!file) {
+        logTraceError("failed to append file '", fileName, "': ", PHYSFS_getLastError());
+        return nullptr;
+    }
+    return FileStreamPtr(new FileStream(fileName, file));
+}
+
+FileStreamPtr ResourceManager::createFile(const std::string& fileName)
+{
+    PHYSFS_File* file = PHYSFS_openWrite(fileName.c_str());
+    if(!file) {
+        logTraceError("failed to create file '", fileName, "': ", PHYSFS_getLastError());
+        return nullptr;
+    }
+    return FileStreamPtr(new FileStream(fileName, file));
+}
+
 bool ResourceManager::deleteFile(const std::string& fileName)
 {
     return PHYSFS_delete(checkPath(fileName).c_str()) != 0;

src/framework/core/resourcemanager.h

@@ -41,11 +41,13 @@ public:
 
     void loadFile(const std::string& fileName, std::iostream& out);
     std::string loadFile(const std::string& fileName);
-
     bool saveFile(const std::string& fileName, const uchar* data, uint size);
     bool saveFile(const std::string& fileName, const std::string& data);
     bool saveFile(const std::string& fileName, std::iostream& in);
 
+    FileStreamPtr openFile(const std::string& fileName);
+    FileStreamPtr appendFile(const std::string& fileName);
+    FileStreamPtr createFile(const std::string& fileName);
     bool deleteFile(const std::string& fileName);
 
     std::list<std::string> listDirectoryFiles(const std::string& directoryPath = "");