Added new MUtils::parent_path() function.
[MUtilities.git] / src / Startup.cpp
blobe193bdcbf3271f3be68d8f8068d861b85209feef
1 ///////////////////////////////////////////////////////////////////////////////
2 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2019 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library 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 GNU
13 // Lesser General Public License for more details.
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
20 //////////////////////////////////////////////////////////////////////////////////
22 //MUtils
23 #include <MUtils/Startup.h>
24 #include <MUtils/OSSupport.h>
25 #include <MUtils/Terminal.h>
26 #include <MUtils/ErrorHandler.h>
27 #include <MUtils/Registry.h>
28 #include <MUtils/Exception.h>
30 //Qt
31 #include <QApplication>
32 #include <QMutex>
33 #include <QStringList>
34 #include <QLibraryInfo>
35 #include <QTextCodec>
36 #include <QImageReader>
37 #include <QFont>
38 #include <QMessageBox>
39 #include <QtPlugin>
40 #if QT_VERSION >= QT_VERSION_CHECK(5,0,0)
41 #include <QAbstractNativeEventFilter>
42 #else
43 #define QAbstractNativeEventFilter QObject
44 #define Q_DECL_OVERRIDE
45 #endif
47 //CRT
48 #include <string.h>
50 //MSVC
51 #if defined(_MSC_VER)
52 #define FORCE_INLINE __forceinline
53 #else
54 #define FORCE_INLINE inline
55 #endif
57 ///////////////////////////////////////////////////////////////////////////////
58 // Qt Static Initialization
59 ///////////////////////////////////////////////////////////////////////////////
61 #ifdef QT_NODLL
63 #if QT_VERSION < QT_VERSION_CHECK(5,0,0)
64 Q_IMPORT_PLUGIN(qico)
65 Q_IMPORT_PLUGIN(qsvg)
66 #else
67 Q_IMPORT_PLUGIN(QWindowsIntegrationPlugin)
68 Q_IMPORT_PLUGIN(QICOPlugin)
69 #endif
71 static void doInitializeResources(void)
73 Q_INIT_RESOURCE(MUtilsData);
76 static void doCleanupResources(void)
78 Q_CLEANUP_RESOURCE(MUtilsData);
81 namespace MUtils
83 namespace Startup
85 namespace Internal
87 class ResourceInitializer
89 public:
90 ResourceInitializer(void)
92 doInitializeResources();
95 ~ResourceInitializer(void)
97 doCleanupResources();
101 static ResourceInitializer resourceInitializer;
106 #endif //QT_NODLL
108 ///////////////////////////////////////////////////////////////////////////////
109 // MESSAGE HANDLER
110 ///////////////////////////////////////////////////////////////////////////////
112 #if QT_VERSION < QT_VERSION_CHECK(5,0,0)
113 static void qt_message_handler(QtMsgType type, const char *const msg)
115 if (msg && msg[0])
117 MUtils::Terminal::write(type, msg);
118 if ((type == QtCriticalMsg) || (type == QtFatalMsg))
120 MUtils::OS::fatal_exit(MUTILS_WCHR(QString::fromUtf8(msg)));
124 #else
125 #define qInstallMsgHandler(X) qInstallMessageHandler((X))
126 static void qt_message_handler(QtMsgType type, const QMessageLogContext&, const QString &msg)
128 if (!msg.isEmpty())
130 MUtils::Terminal::write(type, msg.toUtf8().constData());
131 if ((type == QtCriticalMsg) || (type == QtFatalMsg))
133 MUtils::OS::fatal_exit(MUTILS_WCHR(msg));
137 #endif
139 ///////////////////////////////////////////////////////////////////////////////
140 // EVENT FILTER
141 ///////////////////////////////////////////////////////////////////////////////
143 namespace MUtils
145 namespace Startup
147 namespace Internal
149 class NativeEventFilter : public QAbstractNativeEventFilter
151 public:
152 bool nativeEventFilter(const QByteArray&, void *message, long *result) Q_DECL_OVERRIDE
154 return filterEvent(message, result);
157 static FORCE_INLINE bool filterEvent(void *message, long *result)
159 return MUtils::OS::handle_os_message(message, result);
162 static NativeEventFilter *instance(void)
164 while (m_instance.isNull())
166 m_instance.reset(new NativeEventFilter());
168 return m_instance.data();
171 private:
172 NativeEventFilter(void) {}
173 static QScopedPointer<MUtils::Startup::Internal::NativeEventFilter> m_instance;
179 ///////////////////////////////////////////////////////////////////////////////
180 // STARTUP FUNCTION
181 ///////////////////////////////////////////////////////////////////////////////
183 static FORCE_INLINE int startup_main(int &argc, char **argv, MUtils::Startup::main_function_t *const entry_point, const char* const appName, const bool &debugConsole)
185 qInstallMsgHandler(qt_message_handler);
186 MUtils::Terminal::setup(argc, argv, appName, MUTILS_DEBUG || debugConsole);
187 return entry_point(argc, argv);
190 static FORCE_INLINE int startup_helper(int &argc, char **argv, MUtils::Startup::main_function_t *const entry_point, const char* const appName, const bool &debugConsole)
192 int iResult = -1;
195 iResult = startup_main(argc, argv, entry_point, appName, debugConsole);
197 catch(const std::exception &error)
199 MUTILS_PRINT_ERROR("\nGURU MEDITATION !!!\n\nException error:\n%s\n", error.what());
200 MUtils::OS::fatal_exit(L"Unhandeled C++ exception error, application will exit!");
202 catch(...)
204 MUTILS_PRINT_ERROR("\nGURU MEDITATION !!!\n\nUnknown exception error!\n");
205 MUtils::OS::fatal_exit(L"Unhandeled C++ exception error, application will exit!");
207 return iResult;
210 int MUtils::Startup::startup(int &argc, char **argv, main_function_t *const entry_point, const char* const appName, const bool &debugConsole)
212 int iResult = -1;
213 #if (MUTILS_DEBUG)
214 #ifdef _MSC_VER
215 _CrtSetDbgFlag(_CRTDBG_CHECK_ALWAYS_DF || _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG));
216 #endif //_MSCVER
217 iResult = startup_main(argc, argv, entry_point, appName, debugConsole);
218 #else //MUTILS_DEBUG
219 #ifdef _MSC_VER
220 __try
222 MUtils::ErrorHandler::initialize();
223 MUtils::OS::check_debugger();
224 iResult = startup_helper(argc, argv, entry_point, appName, debugConsole);
226 __except(1)
228 MUTILS_PRINT_ERROR("\nGURU MEDITATION !!!\n\nUnhandeled structured exception error!\n");
229 MUtils::OS::fatal_exit(L"Unhandeled structured exception error, application will exit!");
231 #else //_MSCVER
232 MUtils::ErrorHandler::initialize();
233 MUtils::OS::check_debugger();
234 iResult = startup_helper(argc, argv, entry_point, appName, debugConsole);
235 #endif //_MSCVER
236 #endif //MUTILS_DEBUG
237 return iResult;
240 ///////////////////////////////////////////////////////////////////////////////
241 // QT INITIALIZATION
242 ///////////////////////////////////////////////////////////////////////////////
244 static QMutex g_init_lock;
245 static const char *const g_imageformats[] = {"bmp", "png", "jpg", "gif", "ico", "xpm", "svg", NULL};
247 #define REQUIRE_OS(MIN_OS, MIN_SP) \
248 ((osVersion.type == MUtils::OS::Version::OS_WINDOWS) && ((osVersion > MUtils::OS::Version::MIN_OS) || \
249 ((osVersion == MUtils::OS::Version::MIN_OS) && (osVersion.versionSPack >= (MIN_SP)))))
251 #define REQUIRE_SP(OS_VER, MIN_SP) \
252 ((osVersion != MUtils::OS::Version::OS_VER) || (osVersion.versionSPack >= (MIN_SP)))
254 static FORCE_INLINE QString getExecutableName(int &argc, char **argv)
256 if(argc >= 1)
258 const char *argv0 = argv[0];
259 for (int i = 0; i < 2; i++)
261 static const char SEP[2] = { '/', '\\' };
262 if (const char *const ptr = strrchr(argv0, SEP[i]))
264 argv0 = ptr + 1;
267 if(strlen(argv0) > 1)
269 return QString::fromLatin1(argv0);
272 return QLatin1String("Program.exe");
275 static FORCE_INLINE void qt_registry_cleanup(void)
277 static const wchar_t *const QT_JUNK_KEY = L"Software\\Trolltech\\OrganizationDefaults";
278 MUtils::Registry::reg_key_delete(MUtils::Registry::root_user, MUTILS_QSTR(QT_JUNK_KEY), true, true);
281 QApplication *MUtils::Startup::create_qt(int &argc, char **argv, const QString &appName, const QString &appAuthor, const QString &appDomain, const bool xpSupport)
283 QMutexLocker lock(&g_init_lock);
284 const OS::ArgumentMap &arguments = MUtils::OS::arguments();
286 //Don't initialized again, if done already
287 QScopedPointer<QApplication> application(dynamic_cast<QApplication*>(QApplication::instance()));
288 if(!application.isNull())
290 qWarning("Qt is already initialized!");
291 return application.take();
294 //Extract executable name from argv[] array
295 const QString executableName = getExecutableName(argc, argv);
297 //Check Qt version
298 #ifdef QT_BUILD_KEY
299 qDebug("Using Qt v%s [%s], %s, %s", qVersion(), QLibraryInfo::buildDate().toString(Qt::ISODate).toLatin1().constData(), (qSharedBuild() ? "DLL" : "Static"), QLibraryInfo::buildKey().toLatin1().constData());
300 qDebug("Compiled with Qt v%s, %s\n", QT_VERSION_STR, QT_BUILD_KEY);
301 if(_stricmp(qVersion(), QT_VERSION_STR))
303 qFatal("%s", QApplication::tr("Executable '%1' requires Qt v%2, but found Qt v%3.").arg(executableName, QString::fromLatin1(QT_VERSION_STR), QString::fromLatin1(qVersion())).toLatin1().constData());
304 return false;
306 if(QLibraryInfo::buildKey().compare(QString::fromLatin1(QT_BUILD_KEY), Qt::CaseInsensitive))
308 qFatal("%s", QApplication::tr("Executable '%1' was built for Qt '%2', but found Qt '%3'.").arg(executableName, QString::fromLatin1(QT_BUILD_KEY), QLibraryInfo::buildKey()).toLatin1().constData());
309 return false;
311 #else
312 qDebug("Using Qt v%s [%s], %s", qVersion(), QLibraryInfo::buildDate().toString(Qt::ISODate).toLatin1().constData(), (qSharedBuild() ? "DLL" : "Static"));
313 qDebug("Compiled with Qt v%s\n", QT_VERSION_STR);
314 #endif
316 //Detect the operating system version
317 const MUtils::OS::Version::os_version_t &osVersion = MUtils::OS::os_version();
318 if (const char *const friendlyName = MUtils::OS::os_friendly_name(osVersion))
320 qDebug("Running on %s (NT v%u.%u.%u-sp%u).\n", friendlyName, osVersion.versionMajor, osVersion.versionMinor, osVersion.versionBuild, osVersion.versionSPack);
322 else
324 qWarning("Running on an unknown WindowsNT-based system (v%u.%u.%u-sp%u).\n", osVersion.versionMajor, osVersion.versionMinor, osVersion.versionBuild, osVersion.versionSPack);
327 //Check whether we are running on a supported Windows version
328 if (xpSupport)
330 if (!REQUIRE_OS(WINDOWS_WINXP, 3))
332 qFatal("%s", MUTILS_L1STR(QApplication::tr("Executable '%1' requires Windows XP with SP-3 or later.").arg(executableName)));
334 if (!REQUIRE_SP(WINDOWS_XPX64, 2))
336 qFatal("%s", MUTILS_L1STR(QApplication::tr("Executable '%1' requires Windows XP x64-Edition with SP-2 or later.").arg(executableName)));
339 else
341 if (!REQUIRE_OS(WINDOWS_VISTA, 2))
343 qFatal("%s", MUTILS_L1STR(QApplication::tr("Executable '%1' requires Windows Vista with SP-2 or later.").arg(executableName)));
346 if (osVersion == MUtils::OS::Version::WINDOWS_WIN80)
348 qFatal("%s", MUTILS_L1STR(QApplication::tr("Executable '%1' requires Windows 8.1 or later.").arg(executableName)));
351 //Check for compat mode
352 if(osVersion.overrideFlag && (osVersion <= MUtils::OS::Version::WINDOWS_WN100))
354 qWarning("Windows compatibility mode detected!");
355 if(!arguments.contains("ignore-compat-mode"))
357 qFatal("%s", QApplication::tr("Executable '%1' doesn't support Windows compatibility mode.").arg(executableName).toLatin1().constData());
358 return NULL;
362 //Check for Wine
363 if(MUtils::OS::running_on_wine())
365 qWarning("It appears we are running under Wine, unexpected things might happen!\n");
368 //Set text Codec for locale
369 QTextCodec::setCodecForLocale(QTextCodec::codecForName("UTF-8"));
371 //Create Qt application instance
372 application.reset(new QApplication(argc, argv));
374 //Register the Qt clean-up function
375 atexit(qt_registry_cleanup);
377 //Load plugins from application directory
378 QCoreApplication::setLibraryPaths(QStringList() << QApplication::applicationDirPath());
379 qDebug("Library Path:\n%s\n", MUTILS_UTF8(QApplication::libraryPaths().first()));
381 //Set application properties
382 application->setApplicationName(appName);
383 application->setOrganizationDomain(appDomain);
384 application->setOrganizationName(appAuthor);
385 #if QT_VERSION < QT_VERSION_CHECK(5,0,0)
386 application->setEventFilter(&Internal::NativeEventFilter::filterEvent);
387 #else
388 application->installNativeEventFilter(Internal::NativeEventFilter::instance());
389 #endif
391 //Check for supported image formats
392 QList<QByteArray> supportedFormats = QImageReader::supportedImageFormats();
393 for(int i = 0; g_imageformats[i]; i++)
395 if(!supportedFormats.contains(g_imageformats[i]))
397 qFatal("Qt initialization error: QImageIOHandler for '%s' missing!", g_imageformats[i]);
398 return NULL;
402 //Setup console icon
403 MUtils::Terminal::set_icon(QIcon(":/mutils/icons/bug.png"));
405 //Enable larger/smaller font size
406 double fontScaleFactor = 1.0;
407 if(arguments.contains("huge-font" )) fontScaleFactor = 1.500;
408 if(arguments.contains("big-font" )) fontScaleFactor = 1.250;
409 if(arguments.contains("small-font")) fontScaleFactor = 0.875;
410 if(arguments.contains("tiny-font" )) fontScaleFactor = 0.750;
411 if(!qFuzzyCompare(fontScaleFactor, 1.0))
413 qWarning("Application font scale factor set to: %.3f\n", fontScaleFactor);
414 QFont appFont = application->font();
415 appFont.setPointSizeF(appFont.pointSizeF() * fontScaleFactor);
416 application->setFont(appFont);
419 //Check for process elevation
420 if(MUtils::OS::is_elevated() && (!MUtils::OS::running_on_wine()))
422 QMessageBox messageBox(QMessageBox::Warning, executableName, "<nobr>This program was started with 'elevated' rights, altough it does not need these rights.<br>Running an applications with unnecessary rights is a potential security risk!</nobr>", QMessageBox::NoButton, NULL, Qt::Dialog | Qt::MSWindowsFixedSizeDialogHint | Qt::WindowStaysOnTopHint);
423 messageBox.addButton("Quit Program (Recommended)", QMessageBox::NoRole);
424 messageBox.addButton("Ignore", QMessageBox::NoRole);
425 if(messageBox.exec() == 0)
427 return NULL;
431 //QApplication created successfully
432 return application.take();
435 ///////////////////////////////////////////////////////////////////////////////