src/Startup.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // MuldeR's Utilities for Qt
   3 // Copyright (C) 2004-2014 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.
  14 //
  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
  18 //
  19 // http://www.gnu.org/licenses/lgpl-2.1.txt
  20 //////////////////////////////////////////////////////////////////////////////////
  21
  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/Exception.h>
  28
  29 //Qt
  30 #include <QApplication>
  31 #include <QMutex>
  32 #include <QStringList>
  33 #include <QLibraryInfo>
  34 #include <QTextCodec>
  35 #include <QImageReader>
  36 #include <QFont>
  37 #include <QMessageBox>
  38
  39 ///////////////////////////////////////////////////////////////////////////////
  40 // MESSAGE HANDLER
  41 ///////////////////////////////////////////////////////////////////////////////
  42
  43 static void qt_message_handler(QtMsgType type, const char *msg)
  44 {
  45         if((!msg) || (!(msg[0])))
  46         {
  47                 return;
  48         }
  49
  50         MUtils::Terminal::write(type, msg);
  51
  52         if((type == QtCriticalMsg) || (type == QtFatalMsg))
  53         {
  54                 MUtils::OS::fatal_exit(MUTILS_WCHR(QString::fromUtf8(msg)));
  55         }
  56 }
  57
  58 static bool qt_event_filter(void *message, long *result)
  59 {
  60         return MUtils::OS::handle_os_message(message, result);
  61 }
  62
  63 ///////////////////////////////////////////////////////////////////////////////
  64 // STARTUP FUNCTION
  65 ///////////////////////////////////////////////////////////////////////////////
  66
  67 static int startup_main(int &argc, char **argv, MUtils::Startup::main_function_t *const entry_point, const bool &debugConsole)
  68 {
  69         qInstallMsgHandler(qt_message_handler);
  70         MUtils::Terminal::setup(argc, argv, MUTILS_DEBUG || debugConsole);
  71         return entry_point(argc, argv);
  72 }
  73
  74 static int startup_helper(int &argc, char **argv, MUtils::Startup::main_function_t *const entry_point, const bool &debugConsole)
  75 {
  76         int iResult = -1;
  77         try
  78         {
  79                 iResult = startup_main(argc, argv, entry_point, debugConsole);
  80         }
  81         catch(const std::exception &error)
  82         {
  83                 MUTILS_PRINT_ERROR("\nGURU MEDITATION !!!\n\nException error:\n%s\n", error.what());
  84                 MUtils::OS::fatal_exit(L"Unhandeled C++ exception error, application will exit!");
  85         }
  86         catch(...)
  87         {
  88                 MUTILS_PRINT_ERROR("\nGURU MEDITATION !!!\n\nUnknown exception error!\n");
  89                 MUtils::OS::fatal_exit(L"Unhandeled C++ exception error, application will exit!");
  90         }
  91         return iResult;
  92 }
  93
  94 int MUtils::Startup::startup(int &argc, char **argv, main_function_t *const entry_point, const bool &debugConsole)
  95 {
  96         int iResult = -1;
  97 #if (MUTILS_DEBUG)
  98 #ifdef _MSC_VER
  99         _CrtSetDbgFlag(_CRTDBG_CHECK_ALWAYS_DF || _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG));
 100 #endif //_MSCVER
 101         iResult = startup_main(argc, argv, entry_point, debugConsole);
 102 #else //MUTILS_DEBUG
 103 #ifdef _MSC_VER
 104         __try
 105         {
 106                 MUtils::ErrorHandler::initialize();
 107                 MUtils::OS::check_debugger();
 108                 iResult = startup_helper(argc, argv, entry_point, debugConsole);
 109         }
 110         __except(1)
 111         {
 112                 MUTILS_PRINT_ERROR("\nGURU MEDITATION !!!\n\nUnhandeled structured exception error!\n");
 113                 MUtils::OS::fatal_exit(L"Unhandeled structured exception error, application will exit!");
 114         }
 115 #else //_MSCVER
 116         MUtils::ErrorHandler::initialize();
 117         MUtils::OS::check_debugger();
 118         iResult = startup_helper(argc, argv, entry_point, debugConsole);
 119 #endif //_MSCVER
 120 #endif //MUTILS_DEBUG
 121         return iResult;
 122 }
 123
 124 ///////////////////////////////////////////////////////////////////////////////
 125 // QT INITIALIZATION
 126 ///////////////////////////////////////////////////////////////////////////////
 127
 128 static QMutex g_qt_lock;
 129 static QScopedPointer<QApplication> g_application;
 130
 131 static const char *const g_imageformats[] = {"bmp", "png", "jpg", "gif", "ico", "xpm", "svg", NULL};
 132
 133 bool MUtils::Startup::init_qt(int &argc, char **argv, const QString &appName)
 134 {
 135         QMutexLocker lock(&g_qt_lock);
 136         const QStringList &arguments = MUtils::OS::arguments();
 137
 138         //Don't initialized again, if done already
 139         if(!g_application.isNull())
 140         {
 141                 return true;
 142         }
 143
 144         //Extract executable name from argv[] array
 145         QString executableName = QLatin1String("LameXP.exe");
 146         if(arguments.count() > 0)
 147         {
 148                 static const char *delimiters = "\\/:?";
 149                 executableName = arguments[0].trimmed();
 150                 for(int i = 0; delimiters[i]; i++)
 151                 {
 152                         int temp = executableName.lastIndexOf(QChar(delimiters[i]));
 153                         if(temp >= 0) executableName = executableName.mid(temp + 1);
 154                 }
 155                 executableName = executableName.trimmed();
 156                 if(executableName.isEmpty())
 157                 {
 158                         executableName = QLatin1String("LameXP.exe");
 159                 }
 160         }
 161
 162         //Check Qt version
 163 #ifdef QT_BUILD_KEY
 164         qDebug("Using Qt v%s [%s], %s, %s", qVersion(), QLibraryInfo::buildDate().toString(Qt::ISODate).toLatin1().constData(), (qSharedBuild() ? "DLL" : "Static"), QLibraryInfo::buildKey().toLatin1().constData());
 165         qDebug("Compiled with Qt v%s [%s], %s\n", QT_VERSION_STR, QT_PACKAGEDATE_STR, QT_BUILD_KEY);
 166         if(_stricmp(qVersion(), QT_VERSION_STR))
 167         {
 168                 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());
 169                 return false;
 170         }
 171         if(QLibraryInfo::buildKey().compare(QString::fromLatin1(QT_BUILD_KEY), Qt::CaseInsensitive))
 172         {
 173                 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());
 174                 return false;
 175         }
 176 #else
 177         qDebug("Using Qt v%s [%s], %s", qVersion(), QLibraryInfo::buildDate().toString(Qt::ISODate).toLatin1().constData(), (qSharedBuild() ? "DLL" : "Static"));
 178         qDebug("Compiled with Qt v%s [%s]\n", QT_VERSION_STR, QT_PACKAGEDATE_STR);
 179 #endif
 180
 181         //Check the Windows version
 182
 183         const MUtils::OS::Version::os_version_t &osVersion = MUtils::OS::os_version();
 184         if((osVersion.type != MUtils::OS::Version::OS_WINDOWS) || (osVersion < MUtils::OS::Version::WINDOWS_WINXP))
 185         {
 186                 qFatal("%s", QApplication::tr("Executable '%1' requires Windows XP or later.").arg(executableName).toLatin1().constData());
 187         }
 188
 189         //Check whether we are running on a supported Windows version
 190         if(const char *const friendlyName = MUtils::OS::os_friendly_name(osVersion))
 191         {
 192                 qDebug("Running on %s (NT v%u.%u).\n", friendlyName, osVersion.versionMajor, osVersion.versionMinor);
 193         }
 194         else
 195         {
 196                 const QString message = QString().sprintf("Running on an unknown WindowsNT-based system (v%u.%u).", osVersion.versionMajor, osVersion.versionMinor);
 197                 qWarning("%s\n", MUTILS_UTF8(message));
 198                 MUtils::OS::system_message_wrn(MUTILS_WCHR(message), L"LameXP");
 199         }
 200
 201         //Check for compat mode
 202         if(osVersion.overrideFlag && (osVersion <= MUtils::OS::Version::WINDOWS_WN100))
 203         {
 204                 qWarning("Windows compatibility mode detected!");
 205                 if(!arguments.contains("--ignore-compat-mode", Qt::CaseInsensitive))
 206                 {
 207                         qFatal("%s", QApplication::tr("Executable '%1' doesn't support Windows compatibility mode.").arg(executableName).toLatin1().constData());
 208                         return false;
 209                 }
 210         }
 211
 212         //Check for Wine
 213         if(MUtils::OS::running_on_wine())
 214         {
 215                 qWarning("It appears we are running under Wine, unexpected things might happen!\n");
 216         }
 217
 218         //Set text Codec for locale
 219         QTextCodec::setCodecForLocale(QTextCodec::codecForName("UTF-8"));
 220
 221         //Create Qt application instance
 222         g_application.reset(new QApplication(argc, argv));
 223
 224         //Load plugins from application directory
 225         QCoreApplication::setLibraryPaths(QStringList() << QApplication::applicationDirPath());
 226         qDebug("Library Path:\n%s\n", MUTILS_UTF8(QApplication::libraryPaths().first()));
 227
 228         //Set application properties
 229         g_application->setApplicationName(appName);
 230         g_application->setOrganizationName("LoRd_MuldeR");
 231         g_application->setOrganizationDomain("mulder.at.gg");
 232         g_application->setEventFilter(qt_event_filter);
 233
 234         //Check for supported image formats
 235         QList<QByteArray> supportedFormats = QImageReader::supportedImageFormats();
 236         for(int i = 0; g_imageformats[i]; i++)
 237         {
 238                 if(!supportedFormats.contains(g_imageformats[i]))
 239                 {
 240                         qFatal("Qt initialization error: QImageIOHandler for '%s' missing!", g_imageformats[i]);
 241                         return false;
 242                 }
 243         }
 244
 245         //Setup console icon
 246         MUtils::Terminal::set_icon(QIcon(":/mutils/icons/bug.png"));
 247
 248         //Enable larger/smaller font size
 249         double fontScaleFactor = 1.0;
 250         if(arguments.contains("--huge-font",  Qt::CaseInsensitive)) fontScaleFactor = 1.500;
 251         if(arguments.contains("--big-font",   Qt::CaseInsensitive)) fontScaleFactor = 1.250;
 252         if(arguments.contains("--small-font", Qt::CaseInsensitive)) fontScaleFactor = 0.875;
 253         if(arguments.contains("--tiny-font",  Qt::CaseInsensitive)) fontScaleFactor = 0.750;
 254         if(!qFuzzyCompare(fontScaleFactor, 1.0))
 255         {
 256                 qWarning("Application font scale factor set to: %.3f\n", fontScaleFactor);
 257                 QFont appFont = g_application->font();
 258                 appFont.setPointSizeF(appFont.pointSizeF() * fontScaleFactor);
 259                 g_application->setFont(appFont);
 260         }
 261
 262         //Check for process elevation
 263         if(MUtils::OS::is_elevated() && (!MUtils::OS::running_on_wine()))
 264         {
 265                 QMessageBox messageBox(QMessageBox::Warning, "LameXP", "<nobr>LameXP was started with 'elevated' rights, altough LameXP 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);
 266                 messageBox.addButton("Quit Program (Recommended)", QMessageBox::NoRole);
 267                 messageBox.addButton("Ignore", QMessageBox::NoRole);
 268                 if(messageBox.exec() == 0)
 269                 {
 270                         return NULL;
 271                 }
 272         }
 273
 274         //Successful
 275         return g_application.data();
 276 }
 277
 278 ///////////////////////////////////////////////////////////////////////////////