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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
// Copyright (C) 2019 Joel Rosdahl and other contributors
//
// See doc/AUTHORS.adoc for a complete list of contributors.
//
// 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 3 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 Street, Fifth Floor, Boston, MA 02110-1301 USA
#pragma once
#include "system.hpp"
#include "CacheFile.hpp"
#include "third_party/nonstd/string_view.hpp"
#include <functional>
#include <memory>
#include <string>
#include <utility>
#include <vector>
namespace Util {
typedef std::function<void(double)> ProgressReceiver;
typedef std::function<void(std::shared_ptr<CacheFile>)> CacheFileVisitor;
typedef std::function<void(const std::string& /*dir_path*/,
const ProgressReceiver& /*progress_receiver*/)>
SubdirVisitor;
// Get base name of path.
nonstd::string_view base_name(nonstd::string_view path);
// Get an integer value from bytes in big endian order.
//
// Parameters:
// - buffer: Bytes to read.
// - count: Number of bytes to read.
template<typename T>
void
big_endian_to_int(const uint8_t* buffer, T& value)
{
value = 0;
for (size_t i = 0; i < sizeof(T); ++i) {
value <<= 8;
value |= buffer[i];
}
}
template<>
inline void
big_endian_to_int(const uint8_t* buffer, int8_t& value)
{
value = buffer[0];
}
template<>
inline void
big_endian_to_int(const uint8_t* buffer, uint8_t& value)
{
value = buffer[0];
}
// Create a directory if needed, including its parents if needed.
//
// Returns true if the directory exists or could be created, otherwise false.
bool create_dir(nonstd::string_view dir);
// Create a unique temporary file.
//
// Parameters:
// - path_prefix: Base path. The resulting filename will be this path plus a
// unique suffix.
//
// Returns the open file descriptor (in read/write mode) and the actual
// filename.
std::pair<int, std::string> create_temp_fd(nonstd::string_view path_prefix);
// Get directory name of path.
nonstd::string_view dir_name(nonstd::string_view path);
// Return true if suffix is a suffix of string.
bool ends_with(nonstd::string_view string, nonstd::string_view suffix);
// Call a function for each subdir (0-9a-f) in the cache.
//
// Parameters:
// - cache_dir: Path to the cache directory.
// - visitor: Function to call with directory path and progress_receiver as
// arguments.
// - progress_receiver: Function that will be called for progress updates.
void for_each_level_1_subdir(const std::string& cache_dir,
const SubdirVisitor& visitor,
const ProgressReceiver& progress_receiver);
// Get a list of files in a level 1 subdirectory of the cache.
//
// The function works under the assumption that directory entries with one
// character names (except ".") are subdirectories and that there are no other
// subdirectories.
//
// Files ignored:
// - CACHEDIR.TAG
// - stats
// - .nfs* (temporary NFS files that may be left for open but deleted files).
//
// Parameters:
// - dir: The directory to traverse recursively.
// - progress_receiver: Function that will be called for progress updates.
// - files: Found files.
void get_level_1_files(const std::string& dir,
const ProgressReceiver& progress_receiver,
std::vector<std::shared_ptr<CacheFile>>& files);
// Write bytes in big endian order from an integer value.
//
// Parameters:
// - value: Integer value to read.
// - buffer: Buffer to write bytes to.
template<typename T>
void
int_to_big_endian(T value, uint8_t* buffer)
{
for (size_t i = 0; i < sizeof(T); ++i) {
buffer[sizeof(T) - i - 1] = value & 0xFF;
value >>= 8;
}
}
template<>
inline void
int_to_big_endian(uint8_t value, uint8_t* buffer)
{
buffer[0] = value;
}
template<>
inline void
int_to_big_endian(int8_t value, uint8_t* buffer)
{
buffer[0] = value;
}
// Parse a string into an integer.
//
// Throws Error on error.
int parse_int(const std::string& value);
// Read file data as a string.
//
// Throws Error on error.
std::string read_file(const std::string& path);
// Return true if prefix is a prefix of string.
bool starts_with(nonstd::string_view string, nonstd::string_view prefix);
// Strip whitespace from left and right side of a string.
[[gnu::warn_unused_result]] std::string
strip_whitespace(const std::string& string);
// Convert a string to lowercase.
[[gnu::warn_unused_result]] std::string to_lowercase(const std::string& string);
// Write file data from a string.
//
// Throws Error on error.
void write_file(const std::string& path,
const std::string& data,
bool binary = false);
} // namespace Util
|
