1 /*
2  * Copyright (C) 2013, The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef LATINIME_FORMAT_UTILS_H
18 #define LATINIME_FORMAT_UTILS_H
19 
20 #include <cstdint>
21 
22 #include "defines.h"
23 
24 namespace latinime {
25 
26 /**
27  * Methods to handle binary dictionary format version.
28  */
29 class FormatUtils {
30  public:
31     enum FORMAT_VERSION {
32         // These MUST have the same values as the relevant constants in FormatSpec.java.
33         VERSION_2 = 2,
34         VERSION_4_ONLY_FOR_TESTING = 399,
35         VERSION_4 = 402,
36         VERSION_4_DEV = 403,
37         UNKNOWN_VERSION = -1
38     };
39 
40     // 32 bit magic number is stored at the beginning of the dictionary header to reject
41     // unsupported or obsolete dictionary formats.
42     static const uint32_t MAGIC_NUMBER;
43 
44     static FORMAT_VERSION getFormatVersion(const int formatVersion);
45     static FORMAT_VERSION detectFormatVersion(const uint8_t *const dict, const int dictSize);
46 
47  private:
48     DISALLOW_IMPLICIT_CONSTRUCTORS(FormatUtils);
49 
50     static const int DICTIONARY_MINIMUM_SIZE;
51 };
52 } // namespace latinime
53 #endif /* LATINIME_FORMAT_UTILS_H */
54