aboutsummaryrefslogtreecommitdiffstats
path: root/include/GFModule.h
blob: 740ed815d3351285ae3042540f58a5fc4891aaa1 (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
/**
 * Copyright (C) 2021-2024 Saturneric <eric@bktus.com>
 *
 * 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 <eric@bktus.com> starting on May 12, 2021.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#pragma once

/**
 * @file GFModule.h
 * @brief The one header a module includes.
 *
 * Everything a module needs, grouped by what it is for. Include this; the
 * individual headers are there for when you want to see what is in each area,
 * not because you have to pick.
 *
 * | Header            | What lives there                                 |
 * | ----------------- | ------------------------------------------------ |
 * | GFModuleLog.h     | `LOG_*`, `FLOG_*`, `MLog*`                       |
 * | GFModuleEvent.h   | `LISTEN`, `CB_*`, handlers, event conversion     |
 * | GFModuleI18n.h    | translation context and `.qm` reader             |
 * | GFModuleMemory.h  | who frees what: `DUP`/`UDUP`, SDK allocation     |
 * | GFModuleConvert.h | QString/QMap <-> C, `FormatString`               |
 *
 * Deliberately NOT here: `GFModuleBootstrap.h`, and through it the generated
 * `GFModuleIdentity.h`. Exactly one translation unit per module bootstraps, so
 * only that one includes it. Everything else -- including the sources a
 * module's own gtest target compiles without the SDK -- then builds without
 * needing anything generated.
 *
 * A module declares itself in `module.json` beside its `CMakeLists.txt`, and
 * `gf_add_module()` turns that one file into the generated identity, the
 * translation wiring and the signed package. Nothing about a module's identity
 * is written twice.
 */

#include "GFModuleConvert.h"
#include "GFModuleEvent.h"
#include "GFModuleExport.h"
#include "GFModuleI18n.h"
#include "GFModuleLog.h"
#include "GFModuleMemory.h"
#include "GFSDKBuildInfo.h"