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
|
/** @file chert_version.h
* @brief ChertVersion class
*/
/* Copyright (C) 2006,2007,2008,2009 Olly Betts
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef OM_HGUARD_CHERT_VERSION_H
#define OM_HGUARD_CHERT_VERSION_H
#include <cstring>
#include <string>
#include "common/safeuuid.h"
/** The ChertVersion class manages the "iamchert" file.
*
* The "iamchert" file (currently) contains a "magic" string identifying
* that this is a chert database and a database format version number.
*/
class ChertVersion {
/// The filename of the version file.
std::string filename;
/** The UUID of this database.
*
* This is mutable for older uuid libraries which take non-const uuid_t.
*/
mutable uuid_t uuid;
public:
explicit ChertVersion(const std::string & dbdir) : filename(dbdir) {
filename += "/iamchert";
}
/** Create the version file. */
void create();
/** Read the version file and check it's a version we understand.
*
* On failure, an exception is thrown.
*/
void read_and_check();
/// Return pointer to 16 byte UUID.
const char * get_uuid() const {
// uuid is unsigned char[].
return reinterpret_cast<const char *>(uuid);
}
/// Return UUID in the standard 36 character string format.
std::string get_uuid_string() const {
char buf[37];
uuid_unparse_lower(uuid, buf);
return std::string(buf, 36);
}
#if 0 // Unused currently.
/// Set the UUID from 16 byte binary value @a data.
void set_uuid(const void * data) {
std::memcpy(uuid, data, 16);
}
/** Set the UUID from the standard 36 character string format.
*
* @return true if @a s was successfully parsed; false otherwise.
*/
bool set_uuid_string(const std::string & s) {
return uuid_parse(s.c_str(), uuid);
}
#endif
};
#endif
|
