1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*
OpenMW - The completely unofficial reimplementation of Morrowind
Copyright (C) 2008-2010 Nicolay Korslund
Email: < korslund@gmail.com >
WWW: https://openmw.org/
This file (bsa_file.h) is part of the OpenMW package.
OpenMW is distributed as free software: you can redistribute it
and/or modify it under the terms of the GNU General Public License
version 3, as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
version 3 along with this program. If not, see
https://www.gnu.org/licenses/ .
*/
#ifndef BSA_BSA_FILE_H
#define BSA_BSA_FILE_H
#include <cstdint>
#include <filesystem>
#include <string>
#include <vector>
#include <components/files/conversion.hpp>
#include <components/files/istreamptr.hpp>
namespace Bsa
{
enum class BsaVersion : std::uint32_t
{
Unknown = 0x0,
Uncompressed = 0x100,
Compressed = 0x415342, // B, S, A,
BA2GNRL, // used by FO4, BSA which contains files
BA2DX10 // used by FO4, BSA which contains textures
};
/**
This class is used to read "Bethesda Archive Files", or BSAs.
*/
class BSAFile
{
public:
#pragma pack(push)
#pragma pack(1)
struct Hash
{
uint32_t low, high;
};
#pragma pack(pop)
/// Represents one file entry in the archive
struct FileStruct
{
void setNameInfos(size_t index, std::vector<char>* stringBuf)
{
namesOffset = static_cast<uint32_t>(index);
namesBuffer = stringBuf;
}
// File size and offset in file. We store the offset from the
// beginning of the file, not the offset into the data buffer
// (which is what is stored in the archive.)
uint32_t fileSize, offset;
Hash hash;
// Zero-terminated file name
const char* name() const { return &(*namesBuffer)[namesOffset]; }
uint32_t namesOffset = 0;
std::vector<char>* namesBuffer = nullptr;
};
typedef std::vector<FileStruct> FileList;
protected:
bool mHasChanged = false;
/// Table of files in this archive
FileList mFiles;
/// Filename string buffer
std::vector<char> mStringBuf;
/// True when an archive has been loaded
bool mIsLoaded;
/// Used for error messages
std::filesystem::path mFilepath;
/// Error handling
[[noreturn]] void fail(const std::string& msg) const;
/// Read header information from the input source
virtual void readHeader();
virtual void writeHeader();
public:
/* -----------------------------------
* BSA management methods
* -----------------------------------
*/
BSAFile()
: mIsLoaded(false)
{
}
virtual ~BSAFile()
{
close();
}
/// Open an archive file.
void open(const std::filesystem::path& file);
void close();
/* -----------------------------------
* Archive file routines
* -----------------------------------
*/
/** Open a file contained in the archive.
* @note Thread safe.
*/
Files::IStreamPtr getFile(const FileStruct* file);
void addFile(const std::string& filename, std::istream& file);
/// Get a list of all files
/// @note Thread safe.
const FileList& getList() const
{
return mFiles;
}
std::string getFilename() const
{
return Files::pathToUnicodeString(mFilepath);
}
// checks version of BSA from file header
static BsaVersion detectVersion(const std::filesystem::path& filePath);
};
}
#endif
|
