Repo created

libs/platform/mwm_version.hpp

@@ -0,0 +1,76 @@
+#pragma once
+
+#include "base/exception.hpp"
+
+#include <cstdint>
+#include <string>
+
+class FilesContainerR;
+class Writer;
+class ModelReaderPtr;
+
+DECLARE_EXCEPTION(CorruptedMwmFile, RootException);
+
+namespace version
+{
+enum class Format
+{
+  unknownFormat = -1,
+  v1 = 0,  // April 2011
+  v2,      // November 2011 (store type index, instead of raw type in mwm)
+  v3,      // March 2013 (store type index, instead of raw type in search data)
+  v4,      // April 2015 (distinguish и and й in search index)
+  v5,      // July 2015 (feature id is the index in vector now).
+  v6,      // October 2015 (offsets vector is in mwm now).
+  v7,      // November 2015 (supply different search index formats).
+  v8,      // February 2016 (long strings in metadata; store seconds since epoch in MwmVersion).
+           // December 2016 (index graph section was added in version 161206, between v8 and v9).
+  v9,      // April 2017 (OSRM sections are deleted and replaced by cross mwm section).
+  v10,     // April 2020 (dat section renamed to features, compressed metadata index, addr section with
+           // header, sdx section with header, dat section renamed to features, features section with
+           // header).
+  v11,     // September 2020 (compressed string storage for metadata).
+  lastFormat = v11
+};
+
+std::string DebugPrint(Format f);
+
+class MwmVersion
+{
+public:
+  Format GetFormat() const { return m_format; }
+  uint64_t GetSecondsSinceEpoch() const { return m_secondsSinceEpoch; }
+  /// \return version as YYMMDD.
+  uint32_t GetVersion() const;
+
+  /// @name Used in tests only.
+  /// @{
+  void SetFormat(Format format) { m_format = format; }
+  void SetSecondsSinceEpoch(uint64_t secondsSinceEpoch) { m_secondsSinceEpoch = secondsSinceEpoch; }
+  /// @}
+
+  static MwmVersion Read(FilesContainerR const & container);
+
+private:
+  /// Data layout format in mwm file.
+  Format m_format{Format::unknownFormat};
+  uint64_t m_secondsSinceEpoch{0};
+};
+
+std::string DebugPrint(MwmVersion const & mwmVersion);
+
+/// Writes latest format and current timestamp to the writer.
+void WriteVersion(Writer & w, uint64_t secondsSinceEpoch);
+
+/// Helper function that is used in FindAllLocalMaps.
+uint32_t ReadVersionDate(ModelReaderPtr const & reader);
+
+/// \brief This enum sets constants which are used for
+/// writing test to set a version of mwm which should be processed.
+enum ForTesting
+{
+  FOR_TESTING_MWM1 = 991215,
+  FOR_TESTING_MWM2,
+  FOR_TESTING_MWM_LATEST,
+};
+}  // namespace version