kis_assert.cpp File Reference

#include "kis_assert.h"
#include <QString>
#include <QMessageBox>
#include <QThread>
#include <QProcessEnvironment>
#include <QCoreApplication>
#include <QApplication>
#include <klocalizedstring.h>
#include <KisUsageLogger.h>
#include <string>
#include "config-safe-asserts.h"

Go to the source code of this file.

Functions
void	kis_assert_common (const char *assertion, const char *file, int line, bool abort, bool isIgnorable)
void	kis_assert_exception (const char *assertion, const char *file, int line)
void	kis_assert_recoverable (const char *assertion, const char *file, int line)
void	kis_assert_x_exception (const char *assertion, const char *where, const char *what, const char *file, int line)
void	kis_safe_assert_recoverable (const char *assertion, const char *file, int line)

Function Documentation

kis_assert_common()

void kis_assert_common	(	const char *	assertion,
		const char *	file,
		int	line,
		bool	abort,
		bool	isIgnorable )

TODO: Add automatic saving of the documents

Requirements: 1) Should save all open KisDocument objects 2) Should not overwrite original document since the saving process may fail. 3) Should not overwrite any autosaved documents since the saving process may fail. 4) Double-fault tolerance! Assert during emergency saving should not lead to an infinite loop.

Definition at line 34 of file kis_assert.cpp.

{
    QString shortMessage =
        QString("%4ASSERT (krita): \"%1\" in file %2, line %3")
        .arg(assertion)
        .arg(file)
        .arg(line)
        .arg(isIgnorable ? "SAFE " : "");
 
    QString longMessage =
        QString(
            "Krita has encountered an internal error:\n\n"
            "%1\n\n"
            "Please report a bug to developers!\n\n"
            "Press Ignore to try to continue.\n"
            "Press Abort to see developers information (all unsaved data will be lost)")
        .arg(shortMessage);
 
    KisUsageLogger::log(shortMessage);
 
    bool disableAssertMsg =
        QProcessEnvironment::systemEnvironment().value("KRITA_NO_ASSERT_MSG", "0").toInt();
 
    // disable message box if the assert happened in non-gui thread
    // or if the GUI is not yet instantiated
    if (!QCoreApplication::instance() || QThread::currentThread() != QCoreApplication::instance()->thread()) {
        disableAssertMsg = true;
    }
 
    bool shouldIgnoreAsserts = false;
    bool forceCrashOnSafeAsserts = false;
 
#ifdef HIDE_SAFE_ASSERTS
    shouldIgnoreAsserts |= HIDE_SAFE_ASSERTS;
#endif
 
#ifdef CRASH_ON_SAFE_ASSERTS
    forceCrashOnSafeAsserts |= CRASH_ON_SAFE_ASSERTS;
#endif
 
    disableAssertMsg |= shouldIgnoreAsserts || forceCrashOnSafeAsserts;
 
    QMessageBox::StandardButton button =
        isIgnorable && !forceCrashOnSafeAsserts ?
            QMessageBox::Ignore : QMessageBox::Abort;
 
    if (!disableAssertMsg) {
        button =
            QMessageBox::critical(qApp->activeWindow(), i18nc("@title:window", "Krita: Internal Error"),
                                  longMessage,
                                  QMessageBox::Ignore | QMessageBox::Abort,
                                  QMessageBox::Ignore);
    }
 
    if (button == QMessageBox::Abort || abort) {
        qFatal("%s", shortMessage.toLatin1().data());
    } else if (isIgnorable) {
        // Assert is a bug! Please don't change this line to warnKrita,
        // the user must see it!
        qWarning("%s", shortMessage.toLatin1().data());
    }
}

References button(), and KisUsageLogger::log().

kis_assert_exception()

void kis_assert_exception	(	const char *	assertion,
		const char *	file,
		int	line )

Definition at line 108 of file kis_assert.cpp.

{
    kis_assert_common(assertion, file, line, true, false);
}

References kis_assert_common().

kis_assert_recoverable()

void kis_assert_recoverable	(	const char *	assertion,
		const char *	file,
		int	line )

Definition at line 98 of file kis_assert.cpp.

{
    kis_assert_common(assertion, file, line, false, false);
}

References kis_assert_common().

kis_assert_x_exception()

void kis_assert_x_exception	(	const char *	assertion,
		const char *	where,
		const char *	what,
		const char *	file,
		int	line )

Definition at line 113 of file kis_assert.cpp.

{
    QString res =
        QString("ASSERT failure in %1: \"%2\" (%3)")
        .arg(where, what, assertion);
 
    kis_assert_common(res.toLatin1().data(), file, line, true, false);
}

References kis_assert_common().

kis_safe_assert_recoverable()

void kis_safe_assert_recoverable	(	const char *	assertion,
		const char *	file,
		int	line )

Definition at line 103 of file kis_assert.cpp.

{
    kis_assert_common(assertion, file, line, false, true);
}

References kis_assert_common().