/*
    This file is part of the KDE project
    SPDX-FileCopyrightText: 2020 Felix Ernst <fe.a.ernst@gmail.com>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/

#ifndef DOLPHINURLNAVIGATOR_H
#define DOLPHINURLNAVIGATOR_H

#include <KCompletion>
#include <KUrlNavigator>

#include <forward_list>

class KToggleAction;

/**
 * @brief Extends KUrlNavigator in a Dolphin-specific way
 *
 * Makes sure that Dolphin preferences, settings and settings changes are
 * applied to all constructed DolphinUrlNavigators.
 *
 * @see KUrlNavigator
 */
class DolphinUrlNavigator : public KUrlNavigator
{
    Q_OBJECT

public:
    /**
     * Applies all Dolphin-specific settings to a KUrlNavigator
     * @see KUrlNavigator::KurlNavigator()
     */
    DolphinUrlNavigator(QWidget *parent = nullptr);

    /**
     * Applies all Dolphin-specific settings to a KUrlNavigator
     * @see KUrlNavigator::KurlNavigator()
     */
    DolphinUrlNavigator(const QUrl &url, QWidget *parent = nullptr);

    virtual ~DolphinUrlNavigator();

    /**
     * This method is needed so the DolphinNavigatorWidgetAction knows when there is not enough
     * space to neatly align the UrlNavigator with the ViewContainers. Unfortunately KUrlNavigator
     * does not have a useful sizeHint() currently. It would make more sense to change
     * KUrlNavigator instead.
     */
    QSize sizeHint() const override;

    /**
     * Wraps the visual state of a DolphinUrlNavigator so it can be passed around.
     * This notably doesn't involve the locationUrl or history.
     */
    struct VisualState {
        bool isUrlEditable;
        bool hasFocus;
        QString text;
        int cursorPosition;
        int selectionStart;
        int selectionLength;
    };
    /**
     * Retrieve the visual state of this DolphinUrlNavigator.
     * If two DolphinUrlNavigators have the same visual state they should look identical.
     */
    std::unique_ptr<VisualState> visualState() const;
    /**
     * @param visualState A struct describing the new visual state of this object.
     */
    void setVisualState(const VisualState &visualState);

public slots:
    /**
     * Refreshes all DolphinUrlNavigators to get synchronized with the
     * Dolphin settings if they were changed.
     */
    static void slotReadSettings();

    /**
     * Switches to "breadcrumb" mode if the editable mode is not set to be
     * preferred in the Dolphin settings.
     */
    void slotReturnPressed();

    static void slotPlacesPanelVisibilityChanged(bool visible);

protected:
    /**
     * Constructor-helper function
     */
    void init();

protected slots:
    /**
     * Sets the completion mode for all DolphinUrlNavigators
     * and saves it in settings.
     */
    static void setCompletionMode(const KCompletion::CompletionMode completionMode);

protected:
    /** Contains all currently constructed DolphinUrlNavigators */
    static std::forward_list<DolphinUrlNavigator *> s_instances;

    /** Caches the (negated) places panel visibility */
    static bool s_placesSelectorVisible;
};

#endif // DOLPHINURLNAVIGATOR_H