mpq_storage.hpp

Go to the documentation of this file.

#pragma once

 
#include <filesystem>
#include <memory>
#include <mutex>
#include <span>
#include <string>
#include <unordered_map>
#include <vector>
 
#include <wowlib/core/buffer.hpp>
#include <wowlib/core/client_version.hpp>
#include <wowlib/core/error.hpp>
#include <wowlib/core/file_key.hpp>
#include <wowlib/fs/mpq/mpq_chain.hpp>
 
namespace wowlib::fs {
  class MpqStorage {
  public:
    struct Options {
      std::filesystem::path dataDir; 
      ClientVersion version; 
      Locale locale = Locale::enUS; 
    };

    static Result<MpqStorage> open(Options options);
 
    ~MpqStorage() { _close(); }
 
    MpqStorage(const MpqStorage&) = delete;
    MpqStorage& operator=(const MpqStorage&) = delete;
 
    MpqStorage(MpqStorage&& other) noexcept
      : _options(std::move(other._options)), _archives(std::move(other._archives)) {}
 
    MpqStorage& operator=(MpqStorage&& other) noexcept {
      if (this != &other) {
        _close();
        _options = std::move(other._options);
        _archives = std::move(other._archives);
      }
      return *this;
    }

    Result<FileBuffer> readFile(const FileKey& key);

    bool exists(const FileKey& key);

    Result<std::vector<std::string>> enumeratePaths();

    static constexpr StorageKind kind() { return StorageKind::Mpq; }

    struct OpenedArchive {
      std::filesystem::path path; 
      bool isDirectory = false; 
 
      void* handle = nullptr; 
      std::unique_ptr<std::mutex> mtx; 

      bool patched = false;

      std::unordered_map<std::string, std::filesystem::path> loose;
    };

    std::span<const OpenedArchive> archives() const { return _archives; }

    Locale locale() const { return _options.locale; }
 
  private:
    explicit MpqStorage(Options options)
      : _options(std::move(options)) {}

    Result<void> _openChain();

    void _close() noexcept;

    bool _isOpen() const { return !_archives.empty(); }
 
    Options _options;
    std::vector<OpenedArchive> _archives;
  };
}