path: root/src/ui/tools/tool-base.h

// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef SEEN_SP_EVENT_CONTEXT_H
#define SEEN_SP_EVENT_CONTEXT_H

/*
 * Authors:
 *   Lauris Kaplinski <lauris@kaplinski.com>
 *   Frank Felfe <innerspace@iname.com>
 *
 * Copyright (C) 1999-2002 authors
 * Copyright (C) 2001-2002 Ximian, Inc.
 *
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */

#include <cstddef>
#include <string>
#include <memory>
#include <optional>

#include <boost/noncopyable.hpp>
#include <gdkmm/device.h>  // EventMask
#include <gdkmm/cursor.h>
#include <glib-object.h>
#include <sigc++/trackable.h>

#include <2geom/point.h>

#include "preferences.h"

class GrDrag;
class SPDesktop;
class SPObject;
class SPItem;
class SPGroup;
class KnotHolder;

namespace Inkscape {
class MessageContext;
class SelCue;

namespace UI {
class ShapeEditor;

namespace Tools {
class ToolBase;

class DelayedSnapEvent
{
public:
    enum DelayedSnapEventOrigin
    {
        UNDEFINED_HANDLER = 0,
        EVENTCONTEXT_ROOT_HANDLER,
        EVENTCONTEXT_ITEM_HANDLER,
        KNOT_HANDLER,
        CONTROL_POINT_HANDLER,
        GUIDE_HANDLER,
        GUIDE_HRULER,
        GUIDE_VRULER
    };

    DelayedSnapEvent(ToolBase *tool, gpointer item, gpointer item2, GdkEventMotion const *event,
                     DelayedSnapEvent::DelayedSnapEventOrigin origin)
        : _tool(tool)
        , _item(item)
        , _item2(item2)
        , _origin(origin)
    {
        _event = gdk_event_copy(reinterpret_cast<GdkEvent const*>(event));
        _event->motion.time = GDK_CURRENT_TIME;
    }

    ~DelayedSnapEvent()
    {
        gdk_event_free(_event);
    }

    ToolBase *getEventContext() const { return _tool; }
    gpointer getItem() const { return _item; }
    gpointer getItem2() const { return _item2; }
    GdkEvent *getEvent() const { return _event; }
    DelayedSnapEventOrigin getOrigin() const { return _origin; }

private:
    ToolBase *_tool;
    gpointer _item;
    gpointer _item2;
    GdkEvent *_event;
    DelayedSnapEventOrigin _origin;
};

/**
 * Base class for Event processors.
 *
 * This is per desktop object, which (its derivatives) implements
 * different actions bound to mouse events.
 *
 * ToolBase is an abstract base class of all tools. As the name
 * indicates, event context implementations process UI events (mouse
 * movements and keypresses) and take actions (like creating or modifying
 * objects).  There is one event context implementation for each tool,
 * plus few abstract base classes. Writing a new tool involves
 * subclassing ToolBase.
 */
class ToolBase
    : public sigc::trackable
    , boost::noncopyable
{
public:
    ToolBase(SPDesktop *desktop, std::string prefs_path, std::string cursor_filename, bool uses_snap = true);
    virtual ~ToolBase();

    virtual void set(const Inkscape::Preferences::Entry &val);
    virtual bool root_handler(GdkEvent *event);
    virtual bool item_handler(SPItem *item, GdkEvent *event);
    virtual void menu_popup(GdkEvent *event, SPObject *obj = nullptr);
    virtual bool catch_undo(bool redo = false) { return false; }
    virtual bool can_undo(bool redo = false) { return false; }
    virtual bool is_ready() const { return true; }

    void set_on_buttons(GdkEvent *event);
    bool are_buttons_1_and_3_on() const;
    bool are_buttons_1_and_3_on(GdkEvent *event);

    std::string const &getPrefsPath() const { return _prefs_path; };
    void enableSelectionCue(bool enable = true);

    Inkscape::MessageContext *defaultMessageContext() const { return message_context.get(); }

    SPDesktop *getDesktop() const { return _desktop; }
    SPGroup *currentLayer() const;

    // Commonly used CanvasItemCatchall grab/ungrab.
    void grabCanvasEvents(Gdk::EventMask mask =
                          Gdk::KEY_PRESS_MASK      |
                          Gdk::BUTTON_RELEASE_MASK |
                          Gdk::POINTER_MOTION_MASK |
                          Gdk::BUTTON_PRESS_MASK);
    void ungrabCanvasEvents();

    virtual void switching_away(const std::string &new_tool) {}
private:
    std::unique_ptr<Inkscape::Preferences::PreferencesObserver> pref_observer;
    std::string _prefs_path;

protected:
    Glib::RefPtr<Gdk::Cursor> _cursor;
    std::string _cursor_filename = "select.svg";
    std::string _cursor_default = "select.svg";

    int xp = 0;           ///< where drag started
    int yp = 0;           ///< where drag started
    int tolerance = 0;
    bool within_tolerance = false;  ///< are we still within tolerance of origin
    bool _button1on = false;
    bool _button2on = false;
    bool _button3on = false;
    SPItem *item_to_select = nullptr; ///< the item where mouse_press occurred, to
                                      ///< be selected if this is a click not drag

    Geom::Point setup_for_drag_start(GdkEvent *ev);

private:
    enum
    {
        PANNING_NONE = 0,          //
        PANNING_SPACE_BUTTON1 = 1, // TODO is this mode relevant?
        PANNING_BUTTON2 = 2,       //
        PANNING_BUTTON3 = 3,       //
        PANNING_SPACE = 4
    } panning = PANNING_NONE;

    bool rotating = false;
    double start_angle, current_angle;

public:
    gint start_root_handler(GdkEvent *event);
    gint tool_root_handler(GdkEvent *event);
    gint start_item_handler(SPItem *item, GdkEvent *event);
    gint virtual_item_handler(SPItem *item, GdkEvent *event);

    /// True if we're panning with any method (space bar, middle-mouse, right-mouse+Ctrl)
    bool is_panning() const { return panning != 0; }

    /// True if we're panning with the space bar
    bool is_space_panning() const { return panning == PANNING_SPACE || panning == PANNING_SPACE_BUTTON1; }

    std::unique_ptr<Inkscape::MessageContext> message_context;
    Inkscape::SelCue *_selcue = nullptr;

    GrDrag *_grdrag = nullptr;

    ShapeEditor *shape_editor = nullptr;

    void snap_delay_handler(gpointer item, gpointer item2, GdkEventMotion const *event, DelayedSnapEvent::DelayedSnapEventOrigin origin);
    void process_delayed_snap_event();
    void discard_delayed_snap_event();
    bool _uses_snap = false;

    void set_cursor(std::string filename);
    void use_cursor(Glib::RefPtr<Gdk::Cursor> cursor);
    Glib::RefPtr<Gdk::Cursor> get_cursor(Glib::RefPtr<Gdk::Window> window, std::string const &filename) const;
    void use_tool_cursor();

    void enableGrDrag(bool enable = true);
    bool deleteSelectedDrag(bool just_one);
    bool hasGradientDrag() const;
    GrDrag *get_drag() { return _grdrag; }

protected:
    bool sp_event_context_knot_mouseover() const;

    void set_high_motion_precision(bool high_precision = true);

    SPDesktop *_desktop = nullptr;

private:
    bool _keyboardMove(GdkEventKey const &event, Geom::Point const &dir);

    std::optional<DelayedSnapEvent> _dse;
    void _schedule_delayed_snap_event();
    sigc::connection _dse_timeout_conn;
    bool _dse_callback_in_process = false;
};

void sp_event_context_read(ToolBase *ec, char const *key);

void sp_event_root_menu_popup(SPDesktop *desktop, SPItem *item, GdkEvent *event);

gint gobble_key_events(guint keyval, guint mask);
void gobble_motion_events(guint mask);

void sp_event_show_modifier_tip(Inkscape::MessageContext *message_context, GdkEvent *event,
                                char const *ctrl_tip, char const *shift_tip, char const *alt_tip);

void init_latin_keys_group();
unsigned get_latin_keyval(GdkEventKey const *event, unsigned *consumed_modifiers = nullptr);

SPItem *sp_event_context_find_item(SPDesktop *desktop, Geom::Point const &p, bool select_under, bool into_groups);
SPItem *sp_event_context_over_item(SPDesktop *desktop, SPItem *item, Geom::Point const &p);

void sp_toggle_dropper(SPDesktop *dt);

bool sp_event_context_knot_mouseover(ToolBase *ec);

} // namespace Tools
} // namespace UI
} // namespace Inkscape

#endif // SEEN_SP_EVENT_CONTEXT_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 :