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
|
/**
* Copyright (C) 2021 Saturneric <[email protected]>
*
* This file is part of GpgFrontend.
*
* GpgFrontend 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.
*
* GpgFrontend 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 GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
*
* The initial version of the source code is inherited from
* the gpg4usb project, which is under GPL-3.0-or-later.
*
* All the source code of GpgFrontend was modified and released by
* Saturneric <[email protected]> starting on May 12, 2021.
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#pragma once
#include "core/model/GFBuffer.h"
namespace GpgFrontend {
/**
* @brief read file content using std struct
*
*
* @param file_name file name
* @param data data read from file
* @return
*/
auto GPGFRONTEND_CORE_EXPORT ReadFileStd(const std::filesystem::path &file_name,
std::string &data) -> bool;
/**
* @brief
*
* @param file_name
* @return GFBuffer
*/
auto GPGFRONTEND_CORE_EXPORT ReadFileGFBuffer(
const std::filesystem::path &file_name) -> std::tuple<bool, GFBuffer>;
/**
* @brief write file content using std struct
*
* @param file_name file name
* @param data data to write to file
* @return
*/
auto GPGFRONTEND_CORE_EXPORT WriteFileStd(
const std::filesystem::path &file_name, const std::string &data) -> bool;
/**
* @brief
*
* @param file_name
* @param data
* @return true
* @return false
*/
auto GPGFRONTEND_CORE_EXPORT WriteFileGFBuffer(
const std::filesystem::path &file_name, GFBuffer data) -> bool;
/**
* @brief read file content
*
* @param file_name file name
* @param data data read from file
* @return true if success
* @return false if failed
*/
auto GPGFRONTEND_CORE_EXPORT ReadFile(const QString &file_name,
QByteArray &data) -> bool;
/**
* @brief write file content
*
* @param file_name file name
* @param data data to write to file
* @return true if success
* @return false if failed
*/
auto GPGFRONTEND_CORE_EXPORT WriteFile(const QString &file_name,
const QByteArray &data) -> bool;
/**
* calculate the hash of a file
* @param file_path
* @return
*/
auto GPGFRONTEND_CORE_EXPORT
CalculateHash(const std::filesystem::path &file_path) -> std::string;
/**
* @brief
*
* @param path
* @return std::string
*/
auto GPGFRONTEND_CORE_EXPORT ReadAllDataInFile(const std::string &path)
-> std::string;
/**
* @brief
*
* @param path
* @param out_buffer
* @return true
* @return false
*/
auto GPGFRONTEND_CORE_EXPORT WriteBufferToFile(const std::string &path,
const std::string &out_buffer)
-> bool;
/**
* @brief
*
* @param path
* @return std::filesystem::path
*/
auto GPGFRONTEND_CORE_EXPORT ConvertPathByOS(const std::string &path)
-> std::filesystem::path;
/**
* @brief
*
* @return std::filesystem::path
*/
auto GPGFRONTEND_CORE_EXPORT ConvertPathByOS(const QString &)
-> std::filesystem::path;
/**
* @brief
*
* @return std::filesystem::path
*/
auto GPGFRONTEND_CORE_EXPORT GetTempFilePath() -> std::filesystem::path;
/**
* @brief
*
* @param data
* @return std::filesystem::path
*/
auto GPGFRONTEND_CORE_EXPORT CreateTempFileAndWriteData(const std::string &data)
-> std::filesystem::path;
/**
* @brief
*
* @param path
* @param read
* @return std::tuple<bool, std::string>
*/
auto GPGFRONTEND_CORE_EXPORT
TargetFilePreCheck(const std::filesystem::path &path, bool read)
-> std::tuple<bool, std::string>;
/**
* @brief
*
* @param path
* @return std::string
*/
auto GPGFRONTEND_CORE_EXPORT GetFullExtension(std::filesystem::path path)
-> std::string;
} // namespace GpgFrontend
|
