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
|
#pragma once
#include "platform/country_file.hpp"
#include "platform/country_defines.hpp"
#include "std/string.hpp"
#include "std/vector.hpp"
namespace platform
{
// This class represents a path to disk files corresponding to some
// country region.
//
// This class also wraps World.mwm and WorldCoasts.mwm
// files from resource bundle, when they can't be found in a data
// directory. In this exceptional case, directory will be empty and
// SyncWithDisk()/DeleteFromDisk()/GetPath()/GetSize() will return
// incorrect results.
//
// TODO (@gorshenin): fix this hack somehow
// (https://trello.com/c/qcveFw3M/27-world-worldcoasts-mwm-localcountryfile)
//
// In any case, when you're going to read a file LocalCountryFile points to,
// use GetCountryReader().
class LocalCountryFile
{
public:
// Creates empty instance.
LocalCountryFile();
// Creates an instance holding a path to countryFile's in a
// directory. Note that no disk operations are not performed until
// SyncWithDisk() is called.
LocalCountryFile(string const & directory, CountryFile const & countryFile, int64_t version);
// Syncs internal state like availability of map and routing files,
// their sizes etc. with disk.
// In case of one component (single) mwm this method assumed the every mwm has a routing section.
// Generality speaking it's not always true. To know it for sure it's necessary to read a mwm in
// this method but it's not implemented by performance reasons. This check is done on
// building routes stage.
void SyncWithDisk();
// Removes specified files from disk if they're known for LocalCountryFile, i.e.
// were found by previous SyncWithDisk() call.
void DeleteFromDisk(MapOptions files) const;
// Returns path to a file. Return value may be empty until
// SyncWithDisk() is called.
string GetPath(MapOptions file) const;
// Returns size of a file. Return value may be zero until
// SyncWithDisk() is called.
uint64_t GetSize(MapOptions filesMask) const;
// Returns a mask of all known country files. Return value may be
// empty until SyncWithDisk() is called.
inline MapOptions GetFiles() const { return m_files; }
// Checks whether files specified in filesMask are on disk. Return
// value will be false until SyncWithDisk() is called.
inline bool OnDisk(MapOptions filesMask) const
{
return (static_cast<unsigned>(m_files) & static_cast<unsigned>(filesMask)) ==
static_cast<unsigned>(filesMask);
}
inline string const & GetDirectory() const { return m_directory; }
inline string const & GetCountryName() const { return m_countryFile.GetName(); }
inline int64_t GetVersion() const { return m_version; }
inline CountryFile const & GetCountryFile() const { return m_countryFile; }
bool operator<(LocalCountryFile const & rhs) const;
bool operator==(LocalCountryFile const & rhs) const;
// Creates LocalCountryFile for test purposes, for a country region
// with countryFileName (without any extensions). Automatically
// performs sync with disk.
static LocalCountryFile MakeForTesting(string const & countryFileName, int64_t version = 0);
/// @todo The easiest solution for now. Need to be removed in future.
/// @param fullPath Full path to the mwm file.
static LocalCountryFile MakeTemporary(string const & fullPath);
private:
friend string DebugPrint(LocalCountryFile const &);
friend void UnitTest_LocalCountryFile_DirectoryLookup();
friend void FindAllLocalMapsAndCleanup(int64_t latestVersion,
string const & dataDir, vector<LocalCountryFile> & localFiles);
/// @note! If directory is empty, the file is stored in resources.
/// In this case, the only valid params are m_countryFile and m_version.
string m_directory;
CountryFile m_countryFile;
int64_t m_version;
MapOptions m_files;
/// Size of file which contains map section in bytes. It's mwm file in any case.
uint64_t m_mapSize;
/// Size of file which contains routing section in bytes.
/// It's .mwm.routing file in case of big (two component) mwms.
/// And m_routingSize == 0 for small (one compontent) mwms.
uint64_t m_routingSize;
};
string DebugPrint(LocalCountryFile const & file);
} // namespace platform
|
