File: BufferedArchive.h

package info (click to toggle)
spring 105.0.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 108,860 kB
  • sloc: cpp: 467,785; ansic: 302,607; python: 12,925; java: 12,201; awk: 5,889; sh: 2,371; xml: 655; perl: 405; php: 276; objc: 194; makefile: 75; sed: 2
file content (58 lines) | stat: -rw-r--r-- 1,552 bytes parent folder | download | duplicates (3)
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
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef _BUFFERED_ARCHIVE_H
#define _BUFFERED_ARCHIVE_H

#include "IArchive.h"
#include "System/Threading/SpringThreading.h"

/**
 * Provides a helper implementation for archive types that can only uncompress
 * one file to memory at a time.
 */
class CBufferedArchive : public IArchive
{
public:
	CBufferedArchive(const std::string& name, bool cached = true): IArchive(name) {
		noCache = !cached;
	}

	virtual ~CBufferedArchive();

	virtual int GetType() const override { return ARCHIVE_TYPE_BUF; }

	bool GetFile(unsigned int fid, std::vector<std::uint8_t>& buffer) override;

protected:
	virtual int GetFileImpl(unsigned int fid, std::vector<std::uint8_t>& buffer) = 0;

	struct FileBuffer {
		FileBuffer() = default;
		FileBuffer(const FileBuffer& fb) = delete;
		FileBuffer(FileBuffer&& fb) { *this = std::move(fb); }

		FileBuffer& operator = (const FileBuffer& fb) = delete;
		FileBuffer& operator = (FileBuffer&& fb) = default;

		bool populated = false; // files may be empty (0 bytes)
		bool exists = false;

		std::vector<std::uint8_t> data;
	};

	// indexed by file-id
	std::vector<FileBuffer> fileCache;
	// neither 7zip (.sd7) nor minizip (.sdz) are thread-safe
	// zlib (used to extract pool archive .gz entries) should
	// not need this, but currently each buffered GetFileImpl
	// call is protected
	static spring::mutex archiveLock;

private:
	uint32_t cacheSize = 0;
	uint32_t fileCount = 0;

	bool noCache = false;
};

#endif // _BUFFERED_ARCHIVE_H