[merge] Merge pull request #439 from inexorgame/hanni/file_wrapper_refactoring

[file|shader] Refactor file loading code

Author: IAmNotHanni

include/inexor/vulkan-renderer/tools/file.hpp

@@ -6,31 +6,14 @@
 
 namespace inexor::vulkan_renderer::tools {
 
-/// @brief A class for loading files into memory.
-/// @todo Refactor into an RAII wrapper.
-class File {
-private:
-    /// The file data.
-    std::vector<char> m_file_data;
-
-    /// The size of the file.
-    std::size_t m_file_size{0};
-
-public:
-    File() = default;
-
-    [[nodiscard]] std::size_t file_size() const {
-        return m_file_size;
-    }
-
-    [[nodiscard]] const std::vector<char> &file_data() const {
-        return m_file_data;
-    }
-
-    /// @brief Load the entire file into memory.
-    /// @param file_name The name of the file.
-    /// @return ``true`` if file was loaded successfully.
-    [[nodiscard]] bool load_file(const std::string &file_name);
-};
+/// @brief Extract the extension of a file as lowercase string.
+/// @param file_name the name of the file. This is allowed to include the relative or complete path
+/// @return The extension of the file as lowercase
+[[nodiscard]] std::string get_file_extension_lowercase(const std::string &file_name);
+
+/// @brief Read the data of a file into memory
+/// @param file_name The name of the file
+/// @return A std::vector of type char which contains the binary data of the file
+[[nodiscard]] std::vector<char> read_file_binary_data(const std::string &file_name);
 
 } // namespace inexor::vulkan_renderer::tools

src/vulkan-renderer/tools/file.cpp

@@ -1,45 +1,49 @@
 #include "inexor/vulkan-renderer/tools/file.hpp"
 
-#include <spdlog/spdlog.h>
-
+#include <algorithm>
 #include <cassert>
+#include <filesystem>
 #include <fstream>
 
 namespace inexor::vulkan_renderer::tools {
 
-bool File::load_file(const std::string &file_name) {
+std::string get_file_extension_lowercase(const std::string &file_name) {
     assert(!file_name.empty());
 
-    // Open stream at the end of the file to read it's size.
-    std::ifstream file_to_load(file_name.c_str(), std::ios::in | std::ios::binary | std::ios::ate);
+    // Extract the file extension
+    std::string file_extension = std::filesystem::path(file_name).extension().string();
+
+    if (file_extension.empty()) {
+        return "";
+    }
 
-    if (file_to_load.is_open()) {
-        spdlog::debug("File {} has been opened.", file_name);
+    // Convert file extension string to lowercase
+    std::transform(file_extension.begin(), file_extension.end(), file_extension.begin(),
+                   [](unsigned char c) { return std::tolower(c); });
 
-        // Read the size of the file.
-        const auto file_size = file_to_load.tellg();
+    return file_extension;
+}
 
-        // Preallocate memory for the file buffer.
-        m_file_data.resize(m_file_size);
+std::vector<char> read_file_binary_data(const std::string &file_name) {
 
-        // Reset the file read position to the beginning of the file.
-        file_to_load.seekg(0, std::ios::beg);
+    // Open stream at the end of the file to read it's size.
+    std::ifstream file(file_name.c_str(), std::ios::ate | std::ios::binary | std::ios::in);
 
-        // Read the file data.
-        file_to_load.read(m_file_data.data(), file_size);
+    if (!file) {
+        throw std::runtime_error("Error: Could not open file " + file_name + "!");
+    }
 
-        m_file_size = static_cast<std::size_t>(file_size);
+    // Read the size of the file
+    const auto file_size = file.tellg();
 
-        // Close the file stream.
-        file_to_load.close();
+    std::vector<char> buffer(file_size);
 
-        spdlog::debug("File {} has been closed.", file_name.c_str());
+    // Set the file read position to the beginning of the file
+    file.seekg(0);
 
-        return true;
-    }
+    file.read(buffer.data(), file_size);
 
-    spdlog::error("Could not open shader!");
-    return false;
+    return buffer;
 }
 
 } // namespace inexor::vulkan_renderer::tools

src/vulkan-renderer/wrapper/shader.cpp

@@ -1,42 +1,21 @@
 #include "inexor/vulkan-renderer/wrapper/shader.hpp"
 
 #include "inexor/vulkan-renderer/exception.hpp"
+#include "inexor/vulkan-renderer/tools/file.hpp"
 #include "inexor/vulkan-renderer/wrapper/device.hpp"
 #include "inexor/vulkan-renderer/wrapper/make_info.hpp"
 
 #include <spdlog/spdlog.h>
 
 #include <cassert>
-#include <fstream>
 #include <stdexcept>
 #include <utility>
 
-namespace {
-
-std::vector<char> read_binary(const std::string &file_name) {
-    // Open stream at the end of the file to read it's size.
-    std::ifstream file(file_name.c_str(), std::ios::ate | std::ios::binary | std::ios::in);
-
-    if (!file) {
-        throw std::runtime_error("Error: Could not open file " + file_name + "!");
-    }
-
-    const auto file_size = file.tellg();
-    std::vector<char> buffer(file_size);
-
-    file.seekg(0);
-    file.read(buffer.data(), file_size);
-
-    return buffer;
-}
-
-} // namespace
-
 namespace inexor::vulkan_renderer::wrapper {
 
 Shader::Shader(const Device &device, const VkShaderStageFlagBits type, const std::string &name,
                const std::string &file_name, const std::string &entry_point)
-    : Shader(device, type, name, read_binary(file_name), entry_point) {}
+    : Shader(device, type, name, tools::read_file_binary_data(file_name), entry_point) {}
 
 Shader::Shader(const Device &device, const VkShaderStageFlagBits type, const std::string &name,
                const std::vector<char> &code, const std::string &entry_point)