IKeychainService.h

/*
 * Copyright 2018-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/exception/IQuentierException.h>
#include <quentier/types/ErrorString.h>

#include <quentier/utility/Fwd.h>
#include <quentier/utility/Linkage.h>

#include <QFuture>

class QDebug;

namespace quentier::utility {

class QUENTIER_EXPORT IKeychainService
{
public:
    virtual ~IKeychainService() noexcept;

    enum class ErrorCode
    {
        NoError,
        EntryNotFound,
        CouldNotDeleteEntry,
        AccessDeniedByUser,
        AccessDenied,
        NoBackendAvailable,
        NotImplemented,
        OtherError
    };

    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, ErrorCode errorCode);

    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, ErrorCode errorCode);

    class QUENTIER_EXPORT Exception : public IQuentierException
    {
    public:
        explicit Exception(ErrorCode errorCode) noexcept;

        explicit Exception(
            ErrorCode errorCode, ErrorString errorDescription) noexcept;

        [[nodiscard]] ErrorCode errorCode() const noexcept;
        [[nodiscard]] QString exceptionDisplayName() const override;

        void raise() const override;
        [[nodiscard]] Exception * clone() const override;

    private:
        const ErrorCode m_errorCode;
    };

public:
    [[nodiscard]] virtual QFuture<void> writePassword(
        QString service, QString key, QString password) = 0;

    [[nodiscard]] virtual QFuture<QString> readPassword(
        QString service, QString key) const = 0;

    [[nodiscard]] virtual QFuture<void> deletePassword(
        QString service, QString key) = 0;
};

} // namespace quentier::utility