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
|
/*
* Tools for dealing with save game previews.
*/
#ifndef SAVEGAMEPREVIEW_H
#define SAVEGAMEPREVIEW_H
#include <vector>
#include <string>
#include "Export.h"
#include "MultiplayerCommon.h"
/** Contains preview information about a savegame.
* Stored the beginning of a savefile for quick access. */
struct FO_COMMON_API SaveGamePreviewData {
SaveGamePreviewData(); /// Initialize with unknown markers.
bool Valid() const; /// Checks that this is a valid preview
void SetBinary(bool bin = true); /// Sets the description string appropriate for a binary or XML save file header
static constexpr int16_t PREVIEW_PRESENT_MARKER = 0xDA; /// A marker for the presence of the header
int16_t magic_number = PREVIEW_PRESENT_MARKER; /// This should always contain PREVIEW_PRESENT_MARKER
std::string description; /// Bit of text explaining what this file contains as human-readable text
std::string freeorion_version; /// By what version of FreeOrion was this save generated
std::string main_player_name; /// The name of the hosting player, or the single human player in single player games
std::string main_player_empire_name; /// The name of the empire of the main player
std::array<uint8_t, 4> main_player_empire_colour = {{192, 192, 255, 255}};/// The colour of the empire of the main player
int32_t current_turn = -1; /// The turn the game as saved one
std::string save_time; /// The time the game was saved as ISO 8601 YYYY-MM-DD"T"HH:MM:SS±HH:MM or Z
int16_t number_of_empires = -1; /// The number of empires in the game
int16_t number_of_human_players = -1; /// The number of human players in the game
std::string save_format_marker; /// What format was used for this save?
uint32_t uncompressed_text_size = 0; /// How many bytes capacity does the uncompressed save text take up? (ie. the part that was / will be compressed with zlib for compressed xml format saves)
uint32_t compressed_text_size = 0; /// How many bytes capacity does the compressed save text take up?
};
/** Stores all aggregated information about a save file */
struct FO_COMMON_API FullPreview {
std::string filename;
SaveGamePreviewData preview;
GalaxySetupData galaxy;
};
/** The preview information the server sends to the client. */
struct FO_COMMON_API PreviewInformation {
std::vector<std::string> subdirectories; /// A list of all subfolders of the save game directory, in the format /name1/child1/grandchild
std::string folder; /// The directory whose previews are being listed now
std::vector<FullPreview> previews; /// The previews of the saves in this folder
};
/// Attempts to load headers of a save file.
/// Returns true on success, false if header data could not be loaded
/// @param path Filename to load headers of
FO_COMMON_API bool SaveFileWithValidHeader(const boost::filesystem::path& path);
/// Get the value of column name in this preview
/// @param full FullPreview to match for column @p name
/// \param name The name of the column
/// \param thin If true, tries to make the value less wide
FO_COMMON_API std::string ColumnInPreview(const FullPreview& full, const std::string& name, bool thin = true);
/// Load previews from files
/// \param path Directory where to look for files
/// \param extension File name extension to filter by
/// \param [out] previews The previews will be put here
FO_COMMON_API void LoadSaveGamePreviews(const boost::filesystem::path& path, const std::string& extension,
std::vector<FullPreview>& previews);
#endif
|
