aboutsummaryrefslogtreecommitdiffstats
path: root/src/sdk/GFSDKBasic.h
blob: da83b157b448bcd10451839f5b530bf1830a6576 (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
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) 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 <cstddef>
#include <cstdint>

#include "GFSDKExport.h"

extern "C" {

// MAX STRLEN -> 64 MB
constexpr int32_t kGfStrlenMax = static_cast<const int32_t>(1024 * 1024 * 32);

using GFCommandExecuteCallback = void (*)(void* data, int errcode,
                                          const char* out, const char* err);

using GFCommandExecuteContext = struct {
  char* cmd;
  int32_t argc;
  char** argv;
  GFCommandExecuteCallback cb;
  void* data;  ///< must free by user
};

using GFTranslatorDataReader = int (*)(const char* locale, char** data);

/**
 * @brief
 *
 * @param size
 * @return void*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFAllocateMemory(uint32_t size) -> void*;

/**
 * @brief
 *
 * @param ptr
 * @param size
 * @return void*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFReallocateMemory(void* ptr,
                                                      uint32_t size) -> void*;

/**
 * @brief
 *
 * @return const char*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFProjectVersion() -> const char*;

/**
 * @brief
 *
 * @return const char*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFProjectGitCommitHash() -> const char*;

/**
 * @brief
 *
 * @return const char*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFQtEnvVersion() -> const char*;

/**
 * @brief
 *
 */
void GPGFRONTEND_MODULE_SDK_EXPORT GFFreeMemory(void*);

/**
 * @brief
 *
 * @param cmd
 * @param argc
 * @param argv
 * @param cb
 * @param data
 */
void GPGFRONTEND_MODULE_SDK_EXPORT
GFExecuteCommandSync(const char* cmd, int32_t argc, char** argv,
                     GFCommandExecuteCallback cb, void* data);

/**
 * @brief
 *
 * @param context_size
 * @param context
 */
void GPGFRONTEND_MODULE_SDK_EXPORT GFExecuteCommandBatchSync(
    GFCommandExecuteContext** contexts, int32_t contexts_size);

/**
 * @brief
 *
 * @return char*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFModuleStrDup(const char*) -> char*;

/**
 * @brief
 *
 * @return char*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFAppActiveLocale() -> char*;

/**
 * @brief
 *
 * @param data
 * @param size
 * @return auto
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFAppRegisterTranslatorReader(
    const char* id, GFTranslatorDataReader reader) -> int;

/**
 * @brief
 *
 * @param key
 * @param value
 * @return auto
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFCacheSave(const char* key,
                                               const char* value) -> int;

/**
 * @brief
 *
 * @param key
 * @param value
 * @return auto
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFCacheSaveWithTTL(const char* key,
                                                      const char* value,
                                                      int ttl) -> int;

/**
 * @brief
 *
 * @param key
 * @return const char*
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFCacheGet(const char* key) -> const char*;

/**
 * @brief
 *
 * @return true
 * @return false
 */
auto GPGFRONTEND_MODULE_SDK_EXPORT GFIsFlatpakENV() -> bool;
}