#include <KisImportExportErrorCode.h>

Public Member Functions
QString	errorMessage () const

bool	isCancelled () const

bool	isInternalError () const

bool	isOk () const

	KisImportExportErrorCode ()

	KisImportExportErrorCode (ImportExportCodes::ErrorCodeID code)

	KisImportExportErrorCode (KisImportExportErrorCannotRead code)

	KisImportExportErrorCode (KisImportExportErrorCannotWrite code)

bool	operator== (KisImportExportErrorCode errorCode)

Private Types
enum	ErrorFieldUsed { None , CodeId , CannotRead , CannotWrite }

Private Attributes
KisImportExportErrorCannotRead	cannotRead

KisImportExportErrorCannotWrite	cannotWrite

ImportExportCodes::ErrorCodeID	codeId {ImportExportCodes::OK}

ErrorFieldUsed	errorFieldUsed

Friends
QDebug &	operator<< (QDebug &d, const KisImportExportErrorCode &errorCode)

Detailed Description

Definition at line 109 of file KisImportExportErrorCode.h.

Member Enumeration Documentation

◆ ErrorFieldUsed

enum KisImportExportErrorCode::ErrorFieldUsed

private

Enumerator
None
CodeId
CannotRead
CannotWrite

Definition at line 130 of file KisImportExportErrorCode.h.

    {
        None,
        CodeId,
        CannotRead,
        CannotWrite
    };

Constructor & Destructor Documentation

◆ KisImportExportErrorCode() [1/4]

KisImportExportErrorCode::KisImportExportErrorCode ( )

Definition at line 93 of file KisImportExportErrorCode.cpp.

    : errorFieldUsed(None)
    , cannotRead()
    , cannotWrite()
{ }

◆ KisImportExportErrorCode() [2/4]

KisImportExportErrorCode::KisImportExportErrorCode ( ImportExportCodes::ErrorCodeID code )

Definition at line 99 of file KisImportExportErrorCode.cpp.

    : errorFieldUsed(CodeId)
    , codeId(id)
    , cannotRead()
    , cannotWrite()
{ }

◆ KisImportExportErrorCode() [3/4]

KisImportExportErrorCode::KisImportExportErrorCode ( KisImportExportErrorCannotRead code )

Definition at line 106 of file KisImportExportErrorCode.cpp.

    : errorFieldUsed(CannotRead)
    , codeId(ImportExportCodes::Failure)
    , cannotRead(error)
    , cannotWrite()
{ }

◆ KisImportExportErrorCode() [4/4]

KisImportExportErrorCode::KisImportExportErrorCode ( KisImportExportErrorCannotWrite code )

Definition at line 113 of file KisImportExportErrorCode.cpp.

    : errorFieldUsed(CannotWrite)
    , codeId(ImportExportCodes::Failure)
    , cannotRead()
    , cannotWrite(error)
{ }

Member Function Documentation

◆ errorMessage()

QString KisImportExportErrorCode::errorMessage ( ) const

Definition at line 137 of file KisImportExportErrorCode.cpp.

{
    QString internal = i18n("Unexpected error.");
    if (errorFieldUsed == CannotRead) {
        return cannotRead.errorMessage();
    } else if (errorFieldUsed == CannotWrite) {
        return cannotWrite.errorMessage();
    } else if (errorFieldUsed == CodeId) {
        switch (codeId) {
            // Reading
            case ImportExportCodes::FileNotExist:
                return i18n("The file doesn't exist.");
            case ImportExportCodes::NoAccessToRead:
                return i18n("Permission denied: Krita is not allowed to read the file.");
            case ImportExportCodes::FileFormatIncorrect:
                return i18n("The file format cannot be parsed.");
            case ImportExportCodes::FormatFeaturesUnsupported:
                return i18n("The file format contains unsupported features.");
            case ImportExportCodes::FormatColorSpaceUnsupported:
                return i18n("The file format contains unsupported color space.");
            case ImportExportCodes::ErrorWhileReading:
                return i18n("Error occurred while reading from the file.");
 
            // Writing
            case ImportExportCodes::CannotCreateFile:
                return i18n("The file cannot be created.");
            case ImportExportCodes::NoAccessToWrite:
                return i18n("Permission denied: Krita is not allowed to write to the file.");
            case ImportExportCodes::InsufficientMemory:
                return i18n("There is not enough disk space left to save the file.");
            case ImportExportCodes::ErrorWhileWriting:
                return i18n("Error occurred while writing to the file.");
            case ImportExportCodes::FileFormatNotSupported:
                return i18n("Krita does not support this file format.");
 
            // Both
            case ImportExportCodes::Cancelled:
                return i18n("The action was cancelled by the user.");
 
            // Other
            case ImportExportCodes::Failure:
                return i18n("Unknown error.");
            case ImportExportCodes::InternalError:
                return internal;
            case ImportExportCodes::Busy:
                return i18n("Image is busy.");
            // OK
            case ImportExportCodes::OK:
                return i18n("The action has been completed successfully.");
            default:
                return internal;
 
        }
    }
    return internal; // errorFieldUsed = None
}

◆ isCancelled()

bool KisImportExportErrorCode::isCancelled ( ) const

Definition at line 127 of file KisImportExportErrorCode.cpp.

{
    return errorFieldUsed == CodeId && codeId == ImportExportCodes::Cancelled;
}

References ImportExportCodes::Cancelled, CodeId, codeId, and errorFieldUsed.

◆ isInternalError()

bool KisImportExportErrorCode::isInternalError ( ) const

Definition at line 132 of file KisImportExportErrorCode.cpp.

{
    return errorFieldUsed == CodeId && codeId == ImportExportCodes::InternalError;
}

References CodeId, codeId, errorFieldUsed, and ImportExportCodes::InternalError.

◆ isOk()

bool KisImportExportErrorCode::isOk ( ) const

Definition at line 121 of file KisImportExportErrorCode.cpp.

{
    // if cannotRead or cannotWrite is "NoError", it means that something is wrong in our code
    return errorFieldUsed == CodeId && codeId == ImportExportCodes::OK;
}

References CodeId, codeId, errorFieldUsed, and ImportExportCodes::OK.

◆ operator==()

bool KisImportExportErrorCode::operator== ( KisImportExportErrorCode errorCode )

Definition at line 196 of file KisImportExportErrorCode.cpp.

{
    if (errorFieldUsed != errorCode.errorFieldUsed) {
        return false;
    }
    if (errorFieldUsed == CodeId) {
        return codeId == errorCode.codeId;
    }
    if (errorFieldUsed == CannotRead) {
        return cannotRead == errorCode.cannotRead;
    }
    return cannotWrite == errorCode.cannotWrite;
}

References CannotRead, cannotRead, cannotWrite, CodeId, codeId, and errorFieldUsed.

Friends And Related Symbol Documentation

◆ operator<<

QDebug & operator<<	(	QDebug &	d,
		const KisImportExportErrorCode &	errorCode )

friend

Definition at line 145 of file KisImportExportErrorCode.h.

{
    switch (errorCode.errorFieldUsed) {
    case KisImportExportErrorCode::None:
        d << "None of the error fields is in use.";
        break;
    case KisImportExportErrorCode::CannotRead:
        d << "Cannot read: " << errorCode.cannotRead.m_error;
        break;
    case KisImportExportErrorCode::CannotWrite:
        d << "Cannot write: " << errorCode.cannotRead.m_error;
        break;
    case KisImportExportErrorCode::CodeId:
        d << "Error code = " << errorCode.codeId;
    }
    d << " " << errorCode.errorMessage();
    return d;
}