Core: Add a new File class, obtainable from an Archive, and a stub implementation.

6 files changed, 205 insertions, 0 deletions

diff --git a/src/core/file_sys/archive.h b/src/core/file_sys/archive.h
index ac5630be..67440ef5 100644
--- a/src/core/file_sys/archive.h
+++ b/src/core/file_sys/archive.h
@@ -4,7 +4,12 @@
 
 #pragma once
 
+#include <memory>
+
 #include "common/common_types.h"
+#include "common/bit_field.h"
+
+#include "core/file_sys/file.h"
 
 #include "core/hle/kernel/kernel.h"
 
@@ -13,6 +18,13 @@
 
 namespace FileSys {
 
+union Mode {
+    u32 hex;
+    BitField<0, 1, u32> read_flag;
+    BitField<1, 1, u32> write_flag;
+    BitField<2, 1, u32> create_flag;
+};
+
 class Archive : NonCopyable {
 public:
     /// Supported archive types
@@ -36,6 +48,14 @@ public:
     virtual IdCode GetIdCode() const = 0;
 
     /**
+     * Open a file specified by its path, using the specified mode
+     * @param path Path relative to the archive
+     * @param mode Mode to open the file with
+     * @return Opened file, or nullptr
+     */
+    virtual std::unique_ptr<File> OpenFile(const std::string& path, const Mode mode) const = 0;
+
+    /**
      * Read data from the archive
      * @param offset Offset in bytes to start reading data from
      * @param length Length in bytes of data to read from archive
diff --git a/src/core/file_sys/archive_romfs.cpp b/src/core/file_sys/archive_romfs.cpp
index dc3fb180..99ded4d8 100644
--- a/src/core/file_sys/archive_romfs.cpp
+++ b/src/core/file_sys/archive_romfs.cpp
@@ -5,6 +5,7 @@
 #include "common/common_types.h"
 
 #include "core/file_sys/archive_romfs.h"
+#include "core/file_sys/file_romfs.h"
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 // FileSys namespace
@@ -22,6 +23,16 @@ Archive_RomFS::~Archive_RomFS() {
 }
 
 /**
+ * Open a file specified by its path, using the specified mode
+ * @param path Path relative to the archive
+ * @param mode Mode to open the file with
+ * @return Opened file, or nullptr
+ */
+std::unique_ptr<File> Archive_RomFS::OpenFile(const std::string& path, const Mode mode) const {
+    return std::unique_ptr<File>(new File_RomFS);
+}
+
+/**
  * Read data from the archive
  * @param offset Offset in bytes to start reading data from
  * @param length Length in bytes of data to read from archive
diff --git a/src/core/file_sys/archive_romfs.h b/src/core/file_sys/archive_romfs.h
index e9ed6f77..a7669dd7 100644
--- a/src/core/file_sys/archive_romfs.h
+++ b/src/core/file_sys/archive_romfs.h
@@ -29,6 +29,14 @@ public:
     IdCode GetIdCode() const override { return IdCode::RomFS; };
 
     /**
+     * Open a file specified by its path, using the specified mode
+     * @param path Path relative to the archive
+     * @param mode Mode to open the file with
+     * @return Opened file, or nullptr
+     */
+    std::unique_ptr<File> OpenFile(const std::string& path, const Mode mode) const override;
+
+    /**
      * Read data from the archive
      * @param offset Offset in bytes to start reading data from
      * @param length Length in bytes of data to read from archive
diff --git a/src/core/file_sys/file.h b/src/core/file_sys/file.h
new file mode 100644
index 00000000..f7b009f5
--- /dev/null
+++ b/src/core/file_sys/file.h
@@ -0,0 +1,53 @@
+// Copyright 2014 Citra Emulator Project
+// Licensed under GPLv2
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include "common/common_types.h"
+
+#include "core/hle/kernel/kernel.h"
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+// FileSys namespace
+
+namespace FileSys {
+
+class File : NonCopyable {
+public:
+    File() { }
+    virtual ~File() { }
+
+    /**
+     * Read data from the file
+     * @param offset Offset in bytes to start reading data from
+     * @param length Length in bytes of data to read from file
+     * @param buffer Buffer to read data into
+     * @return Number of bytes read
+     */
+    virtual size_t Read(const u64 offset, const u32 length, u8* buffer) const = 0;
+
+    /**
+     * Write data to the file
+     * @param offset Offset in bytes to start writing data to
+     * @param length Length in bytes of data to write to file
+     * @param buffer Buffer to write data from
+     * @param flush The flush parameters (0 == do not flush)
+     * @return Number of bytes written
+     */
+    virtual size_t Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const = 0;
+
+    /**
+     * Get the size of the file in bytes
+     * @return Size of the file in bytes
+     */
+    virtual size_t GetSize() const = 0;
+
+    /**
+     * Close the file
+     * @return true if the file closed correctly
+     */
+    virtual bool Close() const = 0;
+};
+
+} // namespace FileSys
diff --git a/src/core/file_sys/file_romfs.cpp b/src/core/file_sys/file_romfs.cpp
new file mode 100644
index 00000000..00f3c2ea
--- /dev/null
+++ b/src/core/file_sys/file_romfs.cpp
@@ -0,0 +1,59 @@
+// Copyright 2014 Citra Emulator Project
+// Licensed under GPLv2
+// Refer to the license.txt file included.
+
+#include "common/common_types.h"
+
+#include "core/file_sys/file_romfs.h"
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+// FileSys namespace
+
+namespace FileSys {
+
+File_RomFS::File_RomFS() {
+}
+
+File_RomFS::~File_RomFS() {
+}
+
+/**
+ * Read data from the file
+ * @param offset Offset in bytes to start reading data from
+ * @param length Length in bytes of data to read from file
+ * @param buffer Buffer to read data into
+ * @return Number of bytes read
+ */
+size_t File_RomFS::Read(const u64 offset, const u32 length, u8* buffer) const {
+    return -1;
+}
+
+/**
+ * Write data to the file
+ * @param offset Offset in bytes to start writing data to
+ * @param length Length in bytes of data to write to file
+ * @param buffer Buffer to write data from
+ * @param flush The flush parameters (0 == do not flush)
+ * @return Number of bytes written
+ */
+size_t File_RomFS::Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const {
+    return -1;
+}
+
+/**
+ * Get the size of the file in bytes
+ * @return Size of the file in bytes
+ */
+size_t File_RomFS::GetSize() const {
+    return -1;
+}
+
+/**
+ * Close the file
+ * @return true if the file closed correctly
+ */
+bool File_RomFS::Close() const {
+    return false;
+}
+
+} // namespace FileSys
diff --git a/src/core/file_sys/file_romfs.h b/src/core/file_sys/file_romfs.h
new file mode 100644
index 00000000..5db43d4a
--- /dev/null
+++ b/src/core/file_sys/file_romfs.h
@@ -0,0 +1,54 @@
+// Copyright 2014 Citra Emulator Project
+// Licensed under GPLv2
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include "common/common_types.h"
+
+#include "core/file_sys/file.h"
+#include "core/loader/loader.h"
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+// FileSys namespace
+
+namespace FileSys {
+
+class File_RomFS final : public File {
+public:
+    File_RomFS();
+    ~File_RomFS() override;
+
+    /**
+     * Read data from the file
+     * @param offset Offset in bytes to start reading data from
+     * @param length Length in bytes of data to read from file
+     * @param buffer Buffer to read data into
+     * @return Number of bytes read
+     */
+    size_t Read(const u64 offset, const u32 length, u8* buffer) const override;
+
+    /**
+     * Write data to the file
+     * @param offset Offset in bytes to start writing data to
+     * @param length Length in bytes of data to write to file
+     * @param buffer Buffer to write data from
+     * @param flush The flush parameters (0 == do not flush)
+     * @return Number of bytes written
+     */
+    size_t Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const override;
+
+    /**
+     * Get the size of the file in bytes
+     * @return Size of the file in bytes
+     */
+    size_t GetSize() const override;
+
+    /**
+     * Close the file
+     * @return true if the file closed correctly
+     */
+    bool Close() const override;
+};
+
+} // namespace FileSys