aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/utils/IOUtils.h
blob: 47aa034f1d27fb01516fb458996bf5eecdfc9a0b (plain)
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
/**
 * Copyright (C) 2021-2024 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
 *
 * @param file_name
 * @return GFBuffer
 */
auto GPGFRONTEND_CORE_EXPORT ReadFileGFBuffer(const QString &file_name)
    -> std::tuple<bool, GFBuffer>;

/**
 * @brief
 *
 * @param file_name
 * @param data
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT WriteFileGFBuffer(const QString &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 QString &file_path) -> QString;

/**
 * @brief
 *
 * @param path
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT CalculateBinaryChacksum(const QString &path)
    -> QString;

/**
 * @brief
 *
 * @param path
 * @param out_buffer
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT
WriteBufferToFile(const QString &path, const QString &out_buffer) -> bool;

/**
 * @brief
 *
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT GetTempFilePath() -> QString;

/**
 * @brief
 *
 * @param data
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT CreateTempFileAndWriteData(const QString &data)
    -> QString;

/**
 * @brief
 *
 * @param data
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT CreateTempFileAndWriteData(const GFBuffer &data)
    -> QString;

/**
 * @brief
 *
 * @param path
 * @param read
 * @return std::tuple<bool, QString>
 */
auto GPGFRONTEND_CORE_EXPORT TargetFilePreCheck(const QString &path, bool read)
    -> std::tuple<bool, QString>;

/**
 * @brief
 *
 * @param path
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT GetFullExtension(QString path) -> QString;

}  // namespace GpgFrontend