1 /***************************************************************************
2 * Copyright (C) 2005-2015 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
24 #include <QCoreApplication>
28 #include "abstractcliparser.h"
34 Q_DECLARE_TR_FUNCTIONS(Quassel)
44 QString fancyVersionString; // clickable rev
45 QString plainVersionString; // no <a> tag
48 QString generatedVersion;
53 uint protocolVersion; // deprecated
55 QString applicationName;
56 QString coreApplicationName;
57 QString clientApplicationName;
58 QString organizationName;
59 QString organizationDomain;
62 //! A list of features that are optional in core and/or client, but need runtime checking
63 /** Some features require an uptodate counterpart, but don't justify a protocol break.
64 * This is what we use this enum for. Add such features to it and check at runtime on the other
65 * side for their existence.
67 * This list should be cleaned up after every protocol break, as we can assume them to be present then.
70 SynchronizedMarkerLine = 0x0001,
71 SaslAuthentication = 0x0002,
72 SaslExternal = 0x0004,
73 HideInactiveNetworks = 0x0008,
74 PasswordChange = 0x0010,
78 Q_DECLARE_FLAGS(Features, Feature);
80 //! The features the current version of Quassel supports (\sa Feature)
81 /** \return An ORed list of all enum values in Feature
83 static Features features();
87 static void setupBuildInfo();
88 static inline const BuildInfo &buildInfo();
89 static inline RunMode runMode();
91 static QString configDirPath();
93 //! Returns a list of data directory paths
94 /** There are several locations for applications to install their data files in. On Unix,
95 * a common location is /usr/share; others include $PREFIX/share and additional directories
96 * specified in the env variable XDG_DATA_DIRS.
97 * \return A list of directory paths to look for data files in
99 static QStringList dataDirPaths();
101 //! Searches for a data file in the possible data directories
102 /** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories
103 * returned by \sa dataDirPaths().
104 * \Note With KDE integration enabled, files are searched (only) in KDE's appdata dirs.
105 * \return The full path to the data file if found; a null QString else
107 static QString findDataFilePath(const QString &filename);
109 static QString translationDirPath();
111 //! Returns a list of directories we look for scripts in
112 /** We look for a subdirectory named "scripts" in the configdir and in all datadir paths.
113 * \return A list of directory paths containing executable scripts for /exec
115 static QStringList scriptDirPaths();
117 static void loadTranslation(const QLocale &locale);
119 static inline void setCliParser(AbstractCliParser *cliParser);
120 static inline AbstractCliParser *cliParser();
121 static inline QString optionValue(const QString &option);
122 static inline bool isOptionSet(const QString &option);
124 static const QString &coreDumpFileName();
135 static inline LogLevel logLevel();
136 static inline QFile *logFile();
137 static inline bool logToSyslog();
139 static void logFatalMessage(const char *msg);
146 inline void setRunMode(RunMode mode);
147 inline void setDataDirPaths(const QStringList &paths);
148 QStringList findDataDirPaths() const;
149 inline void disableCrashhandler();
152 void setupEnvironment();
153 void registerMetaTypes();
155 static void handleSignal(int signal);
156 static void logBacktrace(const QString &filename);
158 static Quassel *_instance;
159 static BuildInfo _buildInfo;
160 static AbstractCliParser *_cliParser;
161 static RunMode _runMode;
162 static bool _initialized;
163 static bool _handleCrashes;
165 static QString _coreDumpFileName;
166 static QString _configDirPath;
167 static QStringList _dataDirPaths;
168 static QString _translationDirPath;
170 static LogLevel _logLevel;
171 static QFile *_logFile;
172 static bool _logToSyslog;
176 Q_DECLARE_OPERATORS_FOR_FLAGS(Quassel::Features);
178 const Quassel::BuildInfo &Quassel::buildInfo() { return _buildInfo; }
179 Quassel::RunMode Quassel::runMode() { return _runMode; }
180 void Quassel::setRunMode(Quassel::RunMode mode) { _runMode = mode; }
181 void Quassel::setDataDirPaths(const QStringList &paths) { _dataDirPaths = paths; }
182 void Quassel::disableCrashhandler() { _handleCrashes = false; }
184 void Quassel::setCliParser(AbstractCliParser *parser) { _cliParser = parser; }
185 AbstractCliParser *Quassel::cliParser() { return _cliParser; }
186 QString Quassel::optionValue(const QString &key) { return cliParser()->value(key); }
187 bool Quassel::isOptionSet(const QString &key) { return cliParser()->isSet(key); }
189 Quassel::LogLevel Quassel::logLevel() { return _logLevel; }
190 QFile *Quassel::logFile() { return _logFile; }
191 bool Quassel::logToSyslog() { return _logToSyslog; }