/*
    SPDX-FileCopyrightText: 1997 Torben Weis <weis@stud.uni-frankfurt.de>
    SPDX-FileCopyrightText: 1999 Dirk Mueller <mueller@kde.org>
    Portions SPDX-FileCopyrightText: 1999 Preston Brown <pbrown@kde.org>
    SPDX-FileCopyrightText: 2007 Pino Toscano <pino@kde.org>
    SPDX-FileCopyrightText: 2023 Harald Sitter <sitter@kde.org>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#pragma once

#include <QString>

#ifdef Q_QDOC
#include <KService>
#else
#include <QExplicitlySharedDataPointer>
#endif

#include "kiocore_export.h"

class KService;

namespace KIO
{

/*!
 * \class KIO::OpenWith
 * \inheaderfile KIO/OpenWith
 *
 * \brief Core class for open with style dialog handling.
 *
 * This only implements core functionality. For an actual open with
 * implementation see KOpenWithDialog. For a way to trigger open with dialogs see OpenUrlJob and OpenWithHandlerInterface.
 */
class KIOCORE_EXPORT OpenWith
{
public:
    struct [[nodiscard]] AcceptResult {
        /*!
         * Whether the accept was successful (if not error is set)
         */
        bool accept;
        /*!
         * The error message if the accept failed
         */
        QString error;
        /*!
         * Whether the sycoca needs rebuilding (e.g. call KBuildSycocaProgressDialog::rebuildKSycoca)
         */
        bool rebuildSycoca = false;
    };
    /*!
     * Accept an openwith request with the provided arguments as context.
     * This function may have side effects to do with accepting, such as setting the default application for the
     * mimetype if \a remember is true.
     *
     * Returns an AcceptResult
     */
#ifdef Q_QDOC
    static AcceptResult accept(KService::Ptr &service,
#else
    // Avoiding the actual use of class internal typedef KService::Ptr here,
    // otherwise the whole KIOCore needs to declare public dependency on KService just for this method.
    // The caller of this method has to have an instance of KService around and thus need themselves
    // to depend on KService, so KIOCore here can rely on that.
    static AcceptResult accept(QExplicitlySharedDataPointer<KService> &service,
#endif
                               const QString &typedExec,
                               bool remember,
                               const QString &mimeType,
                               bool openInTerminal,
                               bool lingerTerminal,
                               bool saveNewApps);
};

} // namespace KIO