// SPDX-License-Identifier: GPL-2.0-or-later
/** @file
 * @brief Color swatches dialog
 */
/* Authors:
 *   Jon A. Cruz
 *   PBS <pbs3141@gmail.com>
 *
 * Copyright (C) 2022 Authors
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */
#ifndef UI_DIALOG_SWATCHES_H
#define UI_DIALOG_SWATCHES_H

#include <array>
#include <vector>
#include <boost/unordered_map.hpp>
#include <boost/variant.hpp>
#include <glibmm/ustring.h>

#include "ui/dialog/dialog-base.h"

namespace Inkscape {
namespace UI {

namespace Widget {
class ColorPalette;
}

namespace Dialog {
class ColorItem;

/**
 * A dialog that displays paint swatches.
 *
 * It comes in two flavors, depending on the prefsPath argument passed to
 * the constructor: the default "/dialog/swatches" is just a regular dialog;
 * the "/embedded/swatches" is the horizontal color palette at the bottom
 * of the window.
 */
class SwatchesPanel : public DialogBase
{
public:
    SwatchesPanel(char const *prefsPath = "/dialogs/swatches");
    ~SwatchesPanel() override;

protected:
    void documentReplaced() override;
    void desktopReplaced() override;
    void selectionChanged(Selection *selection) override;
    void selectionModified(Selection *selection, guint flags) override;

    void on_size_allocate(Gtk::Allocation&) override;

private:
    void update_palettes();
    void rebuild();

    Inkscape::UI::Widget::ColorPalette *_palette;

    // Mapping between palette names and indexes.
    enum PaletteIndex
    {
        PALETTE_NONE = -2,
        PALETTE_AUTO = -1,
        PALETTE_GLOBAL = 0,
    };
    PaletteIndex index;
    static PaletteIndex name_to_index(Glib::ustring const&);
    static Glib::ustring index_to_name(PaletteIndex);
    void set_index(PaletteIndex new_index);

    // Asynchronous update mechanism.
    sigc::connection conn_gradients;
    sigc::connection conn_defs;
    bool gradients_changed = false;
    bool defs_changed = false;
    bool selection_changed = false;
    void track_gradients();
    void untrack_gradients();

    // For each gradient, whether or not it is a swatch. Used to track when isSwatch() changes.
    std::vector<bool> isswatch;
    void rebuild_isswatch();
    bool update_isswatch();

    // A map from colors to their respective widgets. Used to quickly find the widgets corresponding
    // to the current fill/stroke color, in order to update their fill/stroke indicators.
     // TODO: Upgrade to boost::variant2 or std::variant when possible.
    using ColorKey = boost::variant<std::monostate, std::array<unsigned, 3>, SPGradient*>;
    boost::unordered_multimap<ColorKey, ColorItem*> widgetmap; // need boost for array hash
    std::vector<ColorItem*> current_fill;
    std::vector<ColorItem*> current_stroke;
    void update_fillstroke_indicators();

    Inkscape::PrefObserver _pinned_observer;
};

} // namespace Dialog
} // namespace UI
} // namespace Inkscape

#endif // UI_DIALOG_SWATCHES_H

/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :