IQuentierException.h

/*
 * Copyright 2016-2025 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <quentier/types/ErrorString.h>
#include <quentier/utility/Printable.h>

#include <QException>

namespace quentier {

class QUENTIER_EXPORT IQuentierException :
    public utility::Printable,
    public QException
{
public:
    ~IQuentierException() noexcept override;

    [[nodiscard]] ErrorString errorMessage() const;
    [[nodiscard]] QString localizedErrorMessage() const;
    [[nodiscard]] QString nonLocalizedErrorMessage() const;

    // std::exception
    [[nodiscard]] const char * what() const noexcept override;

    // utility::Printable
    QTextStream & print(QTextStream & strm) const override;

protected:
    explicit IQuentierException(ErrorString message);
    IQuentierException(const IQuentierException & other);
    IQuentierException & operator=(const IQuentierException & other);

    [[nodiscard]] virtual QString exceptionDisplayName() const = 0;

private:
    ErrorString m_message;
    char * m_whatMessage = nullptr;
};

} // namespace quentier