Commit | Line | Data |
7df24e1f |
1 | /* |
2 | |
4f5a1ae2 |
3 | ShadowFlare MPQ API Library. (c) ShadowFlare Software 2002-2010 |
7df24e1f |
4 | License information for this code is in license.txt and |
5 | included in this file at the end of this comment. |
6 | |
7 | All functions below are actual functions that are part of this |
8 | library and do not need any additional dll files. It does not |
9 | even require Storm to be able to decompress or compress files. |
10 | |
11 | This library emulates the interface of Lmpqapi and Storm MPQ |
12 | functions, so it may be used as a replacement for them in |
13 | MPQ extractors/archivers without even needing to recompile |
14 | the program that uses Lmpqapi or Storm. It has a few features |
15 | not included in Lmpqapi and Storm, such as extra flags for some |
16 | functions, setting the locale ID of existing files, and adding |
17 | files without having to write them somewhere else first. Also, |
18 | MPQ handles used by functions prefixed with "SFile" and "Mpq" |
19 | can be used interchangably; all functions use the same type |
20 | of MPQ handles. You cannot, however, use handles from this |
21 | library with storm or lmpqapi or vice-versa. Doing so will |
22 | most likely result in a crash. |
23 | |
24 | Revision History: |
25 | (Release date) 1.08 (ShadowFlare) |
26 | - Fixed a buffer overflow that would occur when reading files |
27 | if neither using a buffer that is large enough to contain the |
28 | entire file nor has a size that is a multiple of 4096 |
29 | - Added SFileOpenFileAsArchive which opens an archive that is |
30 | contained within an already open archive |
31 | - Added MpqRenameAndSetFileLocale and MpqDeleteFileWithLocale. |
32 | These have extra parameters that allow you to use them with |
33 | files having language codes other than what was last set |
34 | using SFileSetLocale |
35 | - Fixed a bug that caused (listfile) to get cleared if adding |
36 | files with a locale ID other than 0 |
a9771b7c |
37 | - Added MpqOpenArchiveForUpdateEx which allows creating |
38 | archives with different block sizes |
39 | - SFileListFiles can list the contents of bncache.dat without |
40 | needing an external list |
7df24e1f |
41 | |
42 | 06/12/2002 1.07 (ShadowFlare) |
43 | - No longer requires Storm.dll to compress or decompress |
44 | Warcraft III files |
45 | - Added SFileListFiles for getting names and information |
46 | about all of the files in an archive |
47 | - Fixed a bug with renaming and deleting files |
48 | - Fixed a bug with adding wave compressed files with |
49 | low compression setting |
50 | - Added a check in MpqOpenArchiveForUpdate for proper |
51 | dwMaximumFilesInArchive values (should be a number that |
52 | is a power of 2). If it is not a proper value, it will |
53 | be rounded up to the next higher power of 2 |
54 | |
55 | 05/09/2002 1.06 (ShadowFlare) |
56 | - Compresses files without Storm.dll! |
57 | - If Warcraft III is installed, this library will be able to |
58 | find Storm.dll on its own. (Storm.dll is needed to |
59 | decompress Warcraft III files) |
60 | - Fixed a bug where an embedded archive and the file that |
61 | contains it would be corrupted if the archive was modified |
62 | - Able to open all .w3m maps now |
63 | |
64 | 29/06/2002 1.05 (ShadowFlare) |
65 | - Supports decompressing files from Warcraft III MPQ archives |
66 | if using Storm.dll from Warcraft III |
67 | - Added MpqAddFileToArchiveEx and MpqAddFileFromBufferEx for |
68 | using extra compression types |
69 | |
70 | 29/05/2002 1.04 (ShadowFlare) |
71 | - Files can be compressed now! |
72 | - Fixed a bug in SFileReadFile when reading data not aligned |
73 | to the block size |
74 | - Optimized some of SFileReadFile's code. It can read files |
75 | faster now |
76 | - SFile functions may now be used to access files not in mpq |
77 | archives as you can with the real storm functions |
78 | - MpqCompactArchive will no longer corrupt files with the |
79 | MODCRYPTKEY flag as long as the file is either compressed, |
80 | listed in "(listfile)", is "(listfile)", or is located in |
81 | the same place in the compacted archive; so it is safe |
82 | enough to use it on almost any archive |
83 | - Added MpqAddWaveFromBuffer |
84 | - Better handling of archives with no files |
85 | - Fixed compression with COMPRESS2 flag |
86 | |
87 | 15/05/2002 1.03 (ShadowFlare) |
88 | - Supports adding files with the compression attribute (does |
89 | not actually compress files). Now archives created with |
90 | this dll can have files added to them through lmpqapi |
91 | without causing staredit to crash |
92 | - SFileGetBasePath and SFileSetBasePath work more like their |
93 | Storm equivalents now |
94 | - Implemented MpqCompactArchive, but it is not finished yet. |
95 | In its current state, I would recommend against using it |
96 | on archives that contain files with the MODCRYPTKEY flag, |
97 | since it will corrupt any files with that flag |
98 | - Added SFMpqGetVersionString2 which may be used in Visual |
99 | Basic to get the version string |
100 | |
101 | 07/05/2002 1.02 (ShadowFlare) |
102 | - SFileReadFile no longer passes the lpOverlapped parameter it |
103 | receives to ReadFile. This is what was causing the function |
104 | to fail when used in Visual Basic |
105 | - Added support for more Storm MPQ functions |
106 | - GetLastError may now be used to get information about why a |
107 | function failed |
108 | |
109 | 01/05/2002 1.01 (ShadowFlare) |
110 | - Added ordinals for Storm MPQ functions |
111 | - Fixed MPQ searching functionality of SFileOpenFileEx |
112 | - Added a check for whether a valid handle is given when |
113 | SFileCloseArchive is called |
114 | - Fixed functionality of SFileSetArchivePriority when multiple |
115 | files are open |
116 | - File renaming works for all filenames now |
117 | - SFileReadFile no longer reallocates the buffer for each block |
118 | that is decompressed. This should make SFileReadFile at least |
119 | a little faster |
120 | |
121 | 30/04/2002 1.00 (ShadowFlare) |
122 | - First version. |
123 | - Compression not yet supported |
124 | - Does not use SetLastError yet, so GetLastError will not return any |
125 | errors that have to do with this library |
126 | - MpqCompactArchive not implemented |
127 | |
128 | Any comments or suggestions are accepted at blakflare@hotmail.com (ShadowFlare) |
129 | |
130 | License information: |
131 | |
4f5a1ae2 |
132 | Copyright (c) 2002-2010, ShadowFlare <blakflare@hotmail.com> |
7df24e1f |
133 | All rights reserved. |
134 | |
135 | Redistribution and use in source and binary forms, with or without |
136 | modification, are permitted provided that the following conditions |
137 | are met: |
138 | |
139 | 1. Redistributions of source code must retain the above copyright |
140 | notice, this list of conditions and the following disclaimer. |
141 | 2. Redistributions in binary form must reproduce the above copyright |
142 | notice, this list of conditions and the following disclaimer in the |
143 | documentation and/or other materials provided with the distribution. |
144 | |
145 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND |
146 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
147 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
148 | ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
149 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
150 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
151 | OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
152 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
153 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
154 | OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
155 | SUCH DAMAGE. |
156 | */ |
157 | |
158 | #ifndef SHADOWFLARE_MPQ_API_INCLUDED |
159 | #define SHADOWFLARE_MPQ_API_INCLUDED |
160 | |
161 | #include <windows.h> |
162 | |
163 | #ifdef __cplusplus |
164 | extern "C" { |
165 | #endif |
166 | |
167 | typedef struct { |
168 | WORD Major; |
169 | WORD Minor; |
170 | WORD Revision; |
171 | WORD Subrevision; |
172 | } SFMPQVERSION; |
173 | |
174 | // These no longer need to be called. They only provided for |
175 | // compatibility with older versions of this code |
176 | #define LoadSFMpq() |
177 | #define FreeSFMpq() |
178 | |
179 | // MpqInitialize does nothing. It is only provided for |
180 | // compatibility with MPQ archivers that use lmpqapi. |
181 | extern BOOL (WINAPI* MpqInitialize)(); |
182 | |
183 | extern LPCSTR (WINAPI* MpqGetVersionString)(); |
184 | extern float (WINAPI* MpqGetVersion)(); |
185 | |
186 | extern void (WINAPI* SFMpqDestroy)(); // This no longer needs to be called. It is only provided for compatibility with older versions |
187 | |
188 | extern void (WINAPI* AboutSFMpq)(); // Displays an about page in a web browser (this has only been tested in Internet Explorer). This is only for the dll version of SFmpq |
189 | |
190 | // SFMpqGetVersionString2's return value is the required length of the buffer plus |
191 | // the terminating null, so use SFMpqGetVersionString2(0, 0); to get the length. |
192 | extern LPCSTR (WINAPI* SFMpqGetVersionString)(); |
193 | extern DWORD (WINAPI* SFMpqGetVersionString2)(LPCSTR lpBuffer, DWORD dwBufferLength); |
194 | extern SFMPQVERSION (WINAPI* SFMpqGetVersion)(); |
195 | |
196 | // Returns 0 if the dll version is equal to the version your program was compiled |
197 | // with, 1 if the dll is newer, -1 if the dll is older. |
198 | long SFMpqCompareVersion(); |
199 | |
200 | // General error codes |
201 | #define MPQ_ERROR_MPQ_INVALID 0x85200065 |
202 | #define MPQ_ERROR_FILE_NOT_FOUND 0x85200066 |
203 | #define MPQ_ERROR_DISK_FULL 0x85200068 //Physical write file to MPQ failed. Not sure of exact meaning |
204 | #define MPQ_ERROR_HASH_TABLE_FULL 0x85200069 |
205 | #define MPQ_ERROR_ALREADY_EXISTS 0x8520006A |
206 | #define MPQ_ERROR_BAD_OPEN_MODE 0x8520006C //When MOAU_READ_ONLY is used without MOAU_OPEN_EXISTING |
207 | |
208 | #define MPQ_ERROR_COMPACT_ERROR 0x85300001 |
209 | |
210 | // MpqOpenArchiveForUpdate flags |
211 | #define MOAU_CREATE_NEW 0x00 //If archive does not exist, it will be created. If it exists, the function will fail |
212 | #define MOAU_CREATE_ALWAYS 0x08 //Will always create a new archive |
213 | #define MOAU_OPEN_EXISTING 0x04 //If archive exists, it will be opened. If it does not exist, the function will fail |
214 | #define MOAU_OPEN_ALWAYS 0x20 //If archive exists, it will be opened. If it does not exist, it will be created |
215 | #define MOAU_READ_ONLY 0x10 //Must be used with MOAU_OPEN_EXISTING. Archive will be opened without write access |
216 | #define MOAU_MAINTAIN_ATTRIBUTES 0x02 //Will be used in a future version to create the (attributes) file. Contact me about any information you may have about the format of this file |
217 | #define MOAU_MAINTAIN_LISTFILE 0x01 //Creates and maintains a list of files in archive when they are added, replaced, or deleted |
218 | |
a9771b7c |
219 | // MpqOpenArchiveForUpdateEx constants |
220 | #define DEFAULT_BLOCK_SIZE 3 // 512 << number = block size |
221 | #define USE_DEFAULT_BLOCK_SIZE 0xFFFFFFFF // Use default block size that is defined internally |
222 | |
7df24e1f |
223 | // MpqAddFileToArchive flags |
224 | #define MAFA_EXISTS 0x80000000 //This flag will be added if not present |
225 | #define MAFA_UNKNOWN40000000 0x40000000 //Unknown flag |
226 | #define MAFA_MODCRYPTKEY 0x00020000 //Used with MAFA_ENCRYPT. Uses an encryption key based on file position and size |
227 | #define MAFA_ENCRYPT 0x00010000 //Encrypts the file. The file is still accessible when using this, so the use of this has depreciated |
228 | #define MAFA_COMPRESS 0x00000200 //File is to be compressed when added. This is used for most of the compression methods |
229 | #define MAFA_COMPRESS2 0x00000100 //File is compressed with standard compression only (was used in Diablo 1) |
230 | #define MAFA_REPLACE_EXISTING 0x00000001 //If file already exists, it will be replaced |
231 | |
232 | // MpqAddFileToArchiveEx compression flags |
233 | #define MAFA_COMPRESS_STANDARD 0x08 //Standard PKWare DCL compression |
234 | #define MAFA_COMPRESS_DEFLATE 0x02 //ZLib's deflate compression |
a9771b7c |
235 | #define MAFA_COMPRESS_BZIP2 0x10 //bzip2 compression |
236 | #define MAFA_COMPRESS_WAVE 0x81 //Stereo wave compression |
237 | #define MAFA_COMPRESS_WAVE2 0x41 //Mono wave compression |
7df24e1f |
238 | |
239 | // Flags for individual compression types used for wave compression |
a9771b7c |
240 | #define MAFA_COMPRESS_WAVECOMP1 0x80 //Main compressor for stereo wave compression |
241 | #define MAFA_COMPRESS_WAVECOMP2 0x40 //Main compressor for mono wave compression |
7df24e1f |
242 | #define MAFA_COMPRESS_WAVECOMP3 0x01 //Secondary compressor for wave compression |
243 | |
244 | // ZLib deflate compression level constants (used with MpqAddFileToArchiveEx and MpqAddFileFromBufferEx) |
245 | #define Z_NO_COMPRESSION 0 |
246 | #define Z_BEST_SPEED 1 |
247 | #define Z_BEST_COMPRESSION 9 |
248 | #define Z_DEFAULT_COMPRESSION (-1) //Default level is 6 with current ZLib version |
249 | |
250 | // MpqAddWaveToArchive quality flags |
251 | #define MAWA_QUALITY_HIGH 1 //Higher compression, lower quality |
252 | #define MAWA_QUALITY_MEDIUM 0 //Medium compression, medium quality |
253 | #define MAWA_QUALITY_LOW 2 //Lower compression, higher quality |
254 | |
255 | // SFileGetFileInfo flags |
256 | #define SFILE_INFO_BLOCK_SIZE 0x01 //Block size in MPQ |
257 | #define SFILE_INFO_HASH_TABLE_SIZE 0x02 //Hash table size in MPQ |
258 | #define SFILE_INFO_NUM_FILES 0x03 //Number of files in MPQ |
259 | #define SFILE_INFO_TYPE 0x04 //Is MPQHANDLE a file or an MPQ? |
260 | #define SFILE_INFO_SIZE 0x05 //Size of MPQ or uncompressed file |
261 | #define SFILE_INFO_COMPRESSED_SIZE 0x06 //Size of compressed file |
262 | #define SFILE_INFO_FLAGS 0x07 //File flags (compressed, etc.), file attributes if a file not in an archive |
263 | #define SFILE_INFO_PARENT 0x08 //Handle of MPQ that file is in |
264 | #define SFILE_INFO_POSITION 0x09 //Position of file pointer in files |
265 | #define SFILE_INFO_LOCALEID 0x0A //Locale ID of file in MPQ |
266 | #define SFILE_INFO_PRIORITY 0x0B //Priority of open MPQ |
267 | #define SFILE_INFO_HASH_INDEX 0x0C //Hash index of file in MPQ |
a9771b7c |
268 | #define SFILE_INFO_BLOCK_INDEX 0x0D //Block table index of file in MPQ |
7df24e1f |
269 | |
270 | // Return values of SFileGetFileInfo when SFILE_INFO_TYPE flag is used |
271 | #define SFILE_TYPE_MPQ 0x01 |
272 | #define SFILE_TYPE_FILE 0x02 |
273 | |
274 | // SFileListFiles flags |
275 | #define SFILE_LIST_MEMORY_LIST 0x01 // Specifies that lpFilelists is a file list from memory, rather than being a list of file lists |
276 | #define SFILE_LIST_ONLY_KNOWN 0x02 // Only list files that the function finds a name for |
277 | #define SFILE_LIST_ONLY_UNKNOWN 0x04 // Only list files that the function does not find a name for |
a9771b7c |
278 | #define SFILE_LIST_FLAG_UNKNOWN 0x08 // Use without SFILE_LIST_ONLY_KNOWN or SFILE_LIST_FLAG_UNKNOWN to list all files, but will set dwFileExists to 3 if file's name is not found |
7df24e1f |
279 | |
280 | // SFileOpenArchive flags |
281 | #define SFILE_OPEN_HARD_DISK_FILE 0x0000 //Open archive without regard to the drive type it resides on |
282 | #define SFILE_OPEN_CD_ROM_FILE 0x0001 //Open the archive only if it is on a CD-ROM |
283 | #define SFILE_OPEN_ALLOW_WRITE 0x8000 //Open file with write access |
284 | |
285 | // SFileOpenFileEx search scopes |
286 | #define SFILE_SEARCH_CURRENT_ONLY 0x00 //Used with SFileOpenFileEx; only the archive with the handle specified will be searched for the file |
287 | #define SFILE_SEARCH_ALL_OPEN 0x01 //SFileOpenFileEx will look through all open archives for the file. This flag also allows files outside the archive to be used |
288 | |
289 | typedef HANDLE MPQHANDLE; |
290 | |
291 | struct FILELISTENTRY { |
292 | DWORD dwFileExists; // Nonzero if this entry is used |
293 | LCID lcLocale; // Locale ID of file |
294 | DWORD dwCompressedSize; // Compressed size of file |
295 | DWORD dwFullSize; // Uncompressed size of file |
296 | DWORD dwFlags; // Flags for file |
297 | char szFileName[260]; |
298 | }; |
299 | |
300 | struct MPQARCHIVE; |
301 | struct MPQFILE; |
302 | struct MPQHEADER; |
303 | struct BLOCKTABLEENTRY; |
304 | struct HASHTABLEENTRY; |
305 | |
306 | struct MPQHEADER { |
307 | DWORD dwMPQID; //"MPQ\x1A" for mpq's, "BN3\x1A" for bncache.dat |
308 | DWORD dwHeaderSize; // Size of this header |
309 | DWORD dwMPQSize; //The size of the mpq archive |
310 | WORD wUnused0C; // Seems to always be 0 |
311 | WORD wBlockSize; // Size of blocks in files equals 512 << wBlockSize |
312 | DWORD dwHashTableOffset; // Offset to hash table |
313 | DWORD dwBlockTableOffset; // Offset to block table |
314 | DWORD dwHashTableSize; // Number of entries in hash table |
315 | DWORD dwBlockTableSize; // Number of entries in block table |
316 | }; |
317 | |
318 | //Archive handles may be typecasted to this struct so you can access |
319 | //some of the archive's properties and the decrypted hash table and |
320 | //block table directly. This struct is based on Storm's internal |
321 | //struct for archive handles. |
322 | struct MPQARCHIVE { |
323 | // Arranged according to priority with lowest priority first |
324 | MPQARCHIVE * lpNextArc; //0// Pointer to the next MPQARCHIVE struct. Pointer to addresses of first and last archives if last archive |
325 | MPQARCHIVE * lpPrevArc; //4// Pointer to the previous MPQARCHIVE struct. 0xEAFC5E23 if first archive |
326 | char szFileName[260]; //8// Filename of the archive |
327 | HANDLE hFile; //10C// The archive's file handle |
328 | DWORD dwFlags1; //110// Some flags, bit 0 seems to be set when opening an archive from a hard drive if bit 1 in the flags for SFileOpenArchive is set, bit 1 (0 based) seems to be set when opening an archive from a CD |
329 | DWORD dwPriority; //114// Priority of the archive set when calling SFileOpenArchive |
330 | MPQFILE * lpLastReadFile; //118// Pointer to the last read file's MPQFILE struct. This is cleared when finished reading a block |
331 | DWORD dwUnk; //11C// Seems to always be 0 |
332 | DWORD dwBlockSize; //120// Size of file blocks in bytes |
333 | BYTE * lpLastReadBlock; //124// Pointer to the read buffer for archive. This is cleared when finished reading a block |
334 | DWORD dwBufferSize; //128// Size of the read buffer for archive. This is cleared when finished reading a block |
335 | DWORD dwMPQStart; //12C// The starting offset of the archive |
336 | DWORD dwMPQEnd; //130// The ending offset of the archive |
337 | MPQHEADER * lpMPQHeader; //134// Pointer to the archive header |
338 | BLOCKTABLEENTRY * lpBlockTable; //138// Pointer to the start of the block table |
339 | HASHTABLEENTRY * lpHashTable; //13C// Pointer to the start of the hash table |
340 | DWORD dwReadOffset; //140// Offset to the data for a file |
341 | DWORD dwRefCount; //144// Count of references to this open archive. This is incremented for each file opened from the archive, and decremented for each file closed |
342 | // Extra struct members used by SFmpq |
343 | MPQHEADER MpqHeader; |
344 | DWORD dwFlags; //The only flags that should be changed are MOAU_MAINTAIN_LISTFILE and MOAU_MAINTAIN_ATTRIBUTES, changing any others can have unpredictable effects |
345 | LPSTR lpFileName; |
346 | DWORD dwExtraFlags; |
347 | }; |
348 | |
349 | //Handles to files in the archive may be typecasted to this struct |
350 | //so you can access some of the file's properties directly. This |
351 | //struct is based on Storm's internal struct for file handles. |
352 | struct MPQFILE { |
353 | MPQFILE * lpNextFile; //0// Pointer to the next MPQFILE struct. Pointer to addresses of first and last files if last file |
354 | MPQFILE * lpPrevFile; //4// Pointer to the previous MPQFILE struct. 0xEAFC5E13 if first file |
355 | char szFileName[260]; //8// Filename of the file |
356 | HANDLE hFile; //10C// Always INVALID_HANDLE_VALUE for files in MPQ archives. For files not in MPQ archives, this is the file handle for the file and the rest of this struct is filled with zeros except for dwRefCount |
357 | MPQARCHIVE * lpParentArc; //110// Pointer to the MPQARCHIVE struct of the archive in which the file is contained |
358 | BLOCKTABLEENTRY * lpBlockEntry; //114// Pointer to the file's block table entry |
359 | DWORD dwCryptKey; //118// Decryption key for the file |
360 | DWORD dwFilePointer; //11C// Position of file pointer in the file |
361 | DWORD dwUnk; //120// Seems to always be 0 |
362 | DWORD dwBlockCount; //124// Number of blocks in file |
363 | DWORD * lpdwBlockOffsets; //128// Offsets to blocks in file. There are 1 more of these than the number of blocks. The values for this are set after the first read |
364 | DWORD dwReadStarted; //12C// Set to 1 after first read |
365 | BOOL bStreaming; //130// 1 when streaming a WAVE |
366 | BYTE * lpLastReadBlock; //134// Pointer to the read buffer for file. This starts at the position specified in the last SFileSetFilePointer call. This is cleared when SFileSetFilePointer is called or when finished reading the block |
367 | DWORD dwBytesRead; //138// Total bytes read from the current block in the open file. This is cleared when SFileSetFilePointer is called or when finished reading the block |
368 | DWORD dwBufferSize; //13C// Size of the read buffer for file. This is cleared when SFileSetFilePointer is called or when finished reading the block |
369 | DWORD dwRefCount; //140// Count of references to this open file |
370 | // Extra struct members used by SFmpq |
371 | HASHTABLEENTRY *lpHashEntry; |
372 | LPSTR lpFileName; |
373 | }; |
374 | |
375 | struct BLOCKTABLEENTRY { |
376 | DWORD dwFileOffset; // Offset to file |
377 | DWORD dwCompressedSize; // Compressed size of file |
378 | DWORD dwFullSize; // Uncompressed size of file |
379 | DWORD dwFlags; // Flags for file |
380 | }; |
381 | |
382 | struct HASHTABLEENTRY { |
383 | DWORD dwNameHashA; // First name hash of file |
384 | DWORD dwNameHashB; // Second name hash of file |
385 | LCID lcLocale; // Locale ID of file |
386 | DWORD dwBlockTableIndex; // Index to the block table entry for the file |
387 | }; |
388 | |
389 | // Defines for backward compatibility with old lmpqapi function names |
390 | #define MpqAddFileToArcive MpqAddFileToArchive |
391 | #define MpqOpenArchive SFileOpenArchive |
392 | #define MpqOpenFileEx SFileOpenFileEx |
393 | #define MpqGetFileSize SFileGetFileSize |
394 | #define MpqReadFile SFileReadFile |
395 | #define MpqCloseFile SFileCloseFile |
396 | #define MpqCloseArchive SFileCloseArchive |
397 | |
398 | // Storm functions implemented by this library |
399 | extern BOOL (WINAPI* SFileOpenArchive)(LPCSTR lpFileName, DWORD dwPriority, DWORD dwFlags, MPQHANDLE *hMPQ); |
400 | extern BOOL (WINAPI* SFileCloseArchive)(MPQHANDLE hMPQ); |
401 | extern BOOL (WINAPI* SFileOpenFileAsArchive)(MPQHANDLE hSourceMPQ, LPCSTR lpFileName, DWORD dwPriority, DWORD dwFlags, MPQHANDLE *hMPQ); |
402 | extern BOOL (WINAPI* SFileGetArchiveName)(MPQHANDLE hMPQ, LPCSTR lpBuffer, DWORD dwBufferLength); |
403 | extern BOOL (WINAPI* SFileOpenFile)(LPCSTR lpFileName, MPQHANDLE *hFile); |
404 | extern BOOL (WINAPI* SFileOpenFileEx)(MPQHANDLE hMPQ, LPCSTR lpFileName, DWORD dwSearchScope, MPQHANDLE *hFile); |
405 | extern BOOL (WINAPI* SFileCloseFile)(MPQHANDLE hFile); |
406 | extern DWORD (WINAPI* SFileGetFileSize)(MPQHANDLE hFile, LPDWORD lpFileSizeHigh); |
407 | extern BOOL (WINAPI* SFileGetFileArchive)(MPQHANDLE hFile, MPQHANDLE *hMPQ); |
408 | extern BOOL (WINAPI* SFileGetFileName)(MPQHANDLE hFile, LPCSTR lpBuffer, DWORD dwBufferLength); |
409 | extern DWORD (WINAPI* SFileSetFilePointer)(MPQHANDLE hFile, long lDistanceToMove, PLONG lplDistanceToMoveHigh, DWORD dwMoveMethod); |
410 | extern BOOL (WINAPI* SFileReadFile)(MPQHANDLE hFile,LPVOID lpBuffer,DWORD nNumberOfBytesToRead,LPDWORD lpNumberOfBytesRead,LPOVERLAPPED lpOverlapped); |
411 | extern LCID (WINAPI* SFileSetLocale)(LCID nNewLocale); |
412 | extern BOOL (WINAPI* SFileGetBasePath)(LPCSTR lpBuffer, DWORD dwBufferLength); |
413 | extern BOOL (WINAPI* SFileSetBasePath)(LPCSTR lpNewBasePath); |
414 | |
415 | // Extra storm-related functions |
416 | extern DWORD (WINAPI* SFileGetFileInfo)(MPQHANDLE hFile, DWORD dwInfoType); |
417 | extern BOOL (WINAPI* SFileSetArchivePriority)(MPQHANDLE hMPQ, DWORD dwPriority); |
418 | extern DWORD (WINAPI* SFileFindMpqHeader)(HANDLE hFile); |
419 | extern BOOL (WINAPI* SFileListFiles)(MPQHANDLE hMPQ, LPCSTR lpFileLists, FILELISTENTRY *lpListBuffer, DWORD dwFlags); |
420 | |
421 | // Archive editing functions implemented by this library |
422 | extern MPQHANDLE (WINAPI* MpqOpenArchiveForUpdate)(LPCSTR lpFileName, DWORD dwFlags, DWORD dwMaximumFilesInArchive); |
423 | extern DWORD (WINAPI* MpqCloseUpdatedArchive)(MPQHANDLE hMPQ, DWORD dwUnknown2); |
424 | extern BOOL (WINAPI* MpqAddFileToArchive)(MPQHANDLE hMPQ, LPCSTR lpSourceFileName, LPCSTR lpDestFileName, DWORD dwFlags); |
425 | extern BOOL (WINAPI* MpqAddWaveToArchive)(MPQHANDLE hMPQ, LPCSTR lpSourceFileName, LPCSTR lpDestFileName, DWORD dwFlags, DWORD dwQuality); |
426 | extern BOOL (WINAPI* MpqRenameFile)(MPQHANDLE hMPQ, LPCSTR lpcOldFileName, LPCSTR lpcNewFileName); |
427 | extern BOOL (WINAPI* MpqDeleteFile)(MPQHANDLE hMPQ, LPCSTR lpFileName); |
428 | extern BOOL (WINAPI* MpqCompactArchive)(MPQHANDLE hMPQ); |
429 | |
430 | // Extra archive editing functions |
a9771b7c |
431 | extern MPQHANDLE (WINAPI* MpqOpenArchiveForUpdateEx)(LPCSTR lpFileName, DWORD dwFlags, DWORD dwMaximumFilesInArchive, DWORD dwBlockSize); |
7df24e1f |
432 | extern BOOL (WINAPI* MpqAddFileToArchiveEx)(MPQHANDLE hMPQ, LPCSTR lpSourceFileName, LPCSTR lpDestFileName, DWORD dwFlags, DWORD dwCompressionType, DWORD dwCompressLevel); |
433 | extern BOOL (WINAPI* MpqAddFileFromBufferEx)(MPQHANDLE hMPQ, LPVOID lpBuffer, DWORD dwLength, LPCSTR lpFileName, DWORD dwFlags, DWORD dwCompressionType, DWORD dwCompressLevel); |
434 | extern BOOL (WINAPI* MpqAddFileFromBuffer)(MPQHANDLE hMPQ, LPVOID lpBuffer, DWORD dwLength, LPCSTR lpFileName, DWORD dwFlags); |
435 | extern BOOL (WINAPI* MpqAddWaveFromBuffer)(MPQHANDLE hMPQ, LPVOID lpBuffer, DWORD dwLength, LPCSTR lpFileName, DWORD dwFlags, DWORD dwQuality); |
436 | extern BOOL (WINAPI* MpqRenameAndSetFileLocale)(MPQHANDLE hMPQ, LPCSTR lpcOldFileName, LPCSTR lpcNewFileName, LCID nOldLocale, LCID nNewLocale); |
437 | extern BOOL (WINAPI* MpqDeleteFileWithLocale)(MPQHANDLE hMPQ, LPCSTR lpFileName, LCID nLocale); |
438 | extern BOOL (WINAPI* MpqSetFileLocale)(MPQHANDLE hMPQ, LPCSTR lpFileName, LCID nOldLocale, LCID nNewLocale); |
439 | |
440 | // These functions do nothing. They are only provided for |
441 | // compatibility with MPQ extractors that use storm. |
442 | extern BOOL (WINAPI* SFileDestroy)(); |
443 | extern void (WINAPI* StormDestroy)(); |
444 | |
445 | #ifdef __cplusplus |
446 | }; // extern "C" |
447 | #endif |
448 | |
449 | #endif |
450 | |