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
182
183
184
185
186
|
// SPDX-FileCopyrightText: 2010 Manjeet Dahiya <manjeetdahiya@gmail.com>
// SPDX-FileCopyrightText: 2017 Niels Ole Salscheider <niels_ole@salscheider-online.de>
// SPDX-FileCopyrightText: 2019 Linus Jahn <lnj@kaidan.im>
// SPDX-FileCopyrightText: 2022 Melvin Keskin <melvo@olomono.de>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#ifndef QXMPPGLOBAL_H
#define QXMPPGLOBAL_H
#include "qxmpp_export.h"
#include <QString>
#define QXMPP_AUTOTEST_EXPORT
///
/// This macro expands a numeric value of the form 0xMMNNPP (MM =
/// major, NN = minor, PP = patch) that specifies QXmpp's version
/// number. For example, if you compile your application against
/// QXmpp 1.2.3, the QXMPP_VERSION macro will expand to 0x010203.
///
/// You can use QXMPP_VERSION to use the latest QXmpp features where
/// available.
///
#define QXMPP_VERSION QT_VERSION_CHECK(QXMPP_VERSION_MAJOR, QXMPP_VERSION_MINOR, QXMPP_VERSION_PATCH)
///
/// Returns the version of QXmpp used at compile time as a string.
///
inline QLatin1String QXmppVersion()
{
return QLatin1String(
QT_STRINGIFY(QXMPP_VERSION_MAJOR) "." QT_STRINGIFY(QXMPP_VERSION_MINOR) "." QT_STRINGIFY(QXMPP_VERSION_PATCH));
}
// This sets which deprecated functions should still be usable
// It works exactly like QT_DISABLE_DEPRECATED_BEFORE
#ifndef QXMPP_DISABLE_DEPRECATED_BEFORE
#define QXMPP_DISABLE_DEPRECATED_BEFORE 0x0
#endif
// This works exactly like QT_DEPRECATED_SINCE, but checks QXMPP_DISABLE_DEPRECATED_BEFORE instead.
#define QXMPP_DEPRECATED_SINCE(major, minor) (QT_VERSION_CHECK(major, minor, 0) > QXMPP_DISABLE_DEPRECATED_BEFORE)
// workaround for Qt < 5.12
#ifndef Q_DECL_ENUMERATOR_DEPRECATED_X
#define Q_DECL_ENUMERATOR_DEPRECATED_X(msg)
#endif
#ifndef QT_WARNING_DISABLE_DEPRECATED
#define QT_WARNING_DISABLE_DEPRECATED
#endif
// Adds constructor and operator declarations to a ".h" file corresponding to the rule of six.
// A default constructor has to be declared manually.
#define QXMPP_PRIVATE_DECLARE_RULE_OF_SIX(name) \
name(const name &); \
name(name &&) noexcept; \
~name(); \
name &operator=(const name &); \
name &operator=(name &&) noexcept;
// Adds constructor and operator definitions to a ".cpp" file corresponding to the rule of six.
// A default constructor has to be defined manually.
#define QXMPP_PRIVATE_DEFINE_RULE_OF_SIX(name) \
name::name(const name &) = default; \
name::name(name &&) noexcept = default; \
name::~name() = default; \
name &name::operator=(const name &) = default; \
name &name::operator=(name &&) noexcept = default;
///
/// \namespace QXmpp
///
/// Contains global functions and enumerations.
///
/// \since QXmpp 1.5
///
namespace QXmpp {
///
/// This enum describes different end-to-end encryption methods. These can
/// be used to mark a stanza as encrypted or decrypted with a specific algorithm
/// (e.g., for \xep{0380, Explicit Message Encryption}).
///
/// \since QXmpp 1.5
///
enum EncryptionMethod {
/// No encryption
NoEncryption,
/// Unknown encryption
UnknownEncryption,
/// \xep{0364, Current Off-the-Record Messaging Usage}
Otr,
/// \xep{0027, Current Jabber OpenPGP Usage}
LegacyOpenPgp,
/// \xep{0373, OpenPGP for XMPP}
Ox,
/// \xep{0384, OMEMO Encryption}
Omemo0,
/// \xep{0384, OMEMO Encryption} since version 0.4
Omemo1,
/// \xep{0384, OMEMO Encryption} since version 0.8
Omemo2,
// Keep in sync with namespaces and names in Global.cpp!
#if QXMPP_DEPRECATED_SINCE(1, 5)
/// \xep{0364, Current Off-the-Record Messaging Usage}
/// \deprecated This enum is deprecated since QXmpp 1.5. Use
/// \c QXmpp::Otr instead.
OTR = Otr,
/// \xep{0027, Current Jabber OpenPGP Usage}
/// \deprecated This enum is deprecated since QXmpp 1.5. Use
/// \c QXmpp::LegacyOpenPgp instead.
LegacyOpenPGP = LegacyOpenPgp,
/// \xep{0373, OpenPGP for XMPP}
/// \deprecated This enum is deprecated since QXmpp 1.5. Use
/// \c QXmpp::Ox instead.
OX = Ox,
/// \xep{0384, OMEMO Encryption}
/// \deprecated This enum is deprecated since QXmpp 1.5. Use
/// \c QXmpp::Omemo0 instead.
OMEMO = Omemo0,
#endif
};
///
/// Parsing/serialization mode when using Stanza Content Encryption.
///
/// \sa \xep{0420, Stanza Content Encryption}
///
/// \since QXmpp 1.5
///
enum SceMode : uint8_t {
SceAll, ///< Processes all known elements.
ScePublic, ///< Only processes 'public' elements (e.g. needed for routing).
SceSensitive, ///< Only processes sensitive elements that should be encrypted.
};
///
/// Checks whether a mode is enabled.
///
/// When an SceMode is given you can use this to check whether Public or Private
/// elements are enabled.
///
/// \since QXmpp 1.5
///
inline constexpr bool operator&(SceMode mode1, SceMode mode2)
{
return mode1 == SceAll || mode1 == mode2;
}
///
/// Cipher for encrypting data streams and files.
///
/// \since QXmpp 1.5
///
enum Cipher {
Aes128GcmNoPad,
Aes256GcmNoPad,
Aes256CbcPkcs7,
};
///
/// An empty struct indicating success in results.
///
/// \since QXmpp 1.5
///
struct Success
{
};
///
/// Unit struct used to indicate that a process has been cancelled.
///
/// \since QXmpp 1.5
///
struct Cancelled
{
};
} // namespace QXmpp
#endif // QXMPPGLOBAL_H
|
