include/QtCore/qtenvironmentvariables.h

0001 // Copyright (C) 2022 The Qt Company Ltd.
0002 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0003 // Qt-Security score:significant reason:default
0004
0005 #ifndef QTENVIRONMENTVARIABLES_H
0006 #define QTENVIRONMENTVARIABLES_H
0007
0008 #include <QtCore/qtconfigmacros.h>
0009 #include <QtCore/qtcoreexports.h>
0010 #include <QtCore/qtdeprecationmarkers.h>
0011 #include <QtCore/qtypes.h>
0012
0013 #include <optional>
0014
0015 #if 0
0016 #pragma qt_class(QtEnvironmentVariables)
0017 #pragma qt_sync_stop_processing
0018 #endif
0019
0020 QT_BEGIN_NAMESPACE
0021
0022 class QByteArray;
0023 class QByteArrayView;
0024 class QString;
0025
0026 Q_CORE_EXPORT QByteArray qgetenv(const char *varName);
0027 // need it as two functions because QString is only forward-declared here
0028 Q_CORE_EXPORT QString qEnvironmentVariable(const char *varName);
0029 Q_CORE_EXPORT QString qEnvironmentVariable(const char *varName, const QString &defaultValue);
0030 #if QT_CORE_REMOVED_SINCE(6, 5)
0031 Q_CORE_EXPORT bool qputenv(const char *varName, const QByteArray &value);
0032 #endif
0033 Q_CORE_EXPORT bool qputenv(const char *varName, QByteArrayView value);
0034 Q_CORE_EXPORT bool qunsetenv(const char *varName);
0035
0036 Q_CORE_EXPORT bool qEnvironmentVariableIsEmpty(const char *varName) noexcept;
0037 Q_CORE_EXPORT bool qEnvironmentVariableIsSet(const char *varName) noexcept;
0038 Q_CORE_EXPORT int  qEnvironmentVariableIntValue(const char *varName, bool *ok=nullptr) noexcept;
0039 Q_CORE_EXPORT std::optional<qint64> qEnvironmentVariableIntegerValue(const char *varName) noexcept;
0040
0041 QT_END_NAMESPACE
0042
0043 #endif /* QTENVIRONMENTVARIABLES_H */