Horizon
imp.hpp
1 #pragma once
2 #include "core/core.hpp"
3 #include "imp_interface.hpp"
4 #include "keyseq_dialog.hpp"
5 #include "main_window.hpp"
6 #include "pool/pool.hpp"
7 #include "preferences/preferences.hpp"
8 #include "selection_filter_dialog.hpp"
9 #include "util/window_state_store.hpp"
10 #include "widgets/spin_button_dim.hpp"
11 #include "widgets/warnings_box.hpp"
12 #include "action.hpp"
13 #include "nlohmann/json.hpp"
14 #include "search/searcher.hpp"
15 #include <zmq.hpp>
16 #include "util/item_set.hpp"
17 #include "canvas/canvas_gl.hpp"
18 #include "grid_controller.hpp"
19 #include "util/action_label.hpp"
20 #include <optional>
21 #include "core/clipboard/clipboard.hpp"
22 #include "clipboard_handler.hpp"
23 #include "util/win32_undef.hpp"
24 
25 namespace horizon {
26 
27 class PoolParams {
28 public:
29  PoolParams(const std::string &bp) : base_path(bp)
30  {
31  }
32  std::string base_path;
33 };
34 
35 class ImpBase {
36  friend class ImpInterface;
37 
38 public:
39  ImpBase(const PoolParams &params);
40  void run(int argc, char *argv[]);
41  virtual void handle_tool_change(ToolID id);
42  virtual void construct() = 0;
43  void canvas_update_from_pp();
44  virtual ~ImpBase()
45  {
46  }
47  void set_read_only(bool v);
48 
49  std::set<ObjectRef> highlights;
50  virtual void update_highlights(){};
51 
53  public:
54  enum class Flag {
55  DEFAULT,
56  HAS_OTHERS,
57  WORK_LAYER_ONLY_ENABLED,
58  };
60  {
61  }
62  SelectionFilterInfo(const std::vector<int> &l, Flag fl) : layers(l), flags(fl)
63  {
64  }
65  std::vector<int> layers;
66  Flag flags = Flag::DEFAULT;
67  };
68 
69  virtual std::map<ObjectType, SelectionFilterInfo> get_selection_filter_info() const;
70  virtual bool is_layered() const
71  {
72  return false;
73  };
74 
75 protected:
76  MainWindow *main_window;
77  CanvasGL *canvas;
78  class PropertyPanels *panels;
79  WarningsBox *warnings_box;
80  class ToolPopover *tool_popover;
81  Gtk::Menu *context_menu = nullptr;
82  std::unique_ptr<SelectionFilterDialog> selection_filter_dialog;
83  std::optional<GridController> grid_controller;
84 
85  std::unique_ptr<Pool> pool;
86  std::unique_ptr<Pool> real_pool_caching;
87  Pool *pool_caching;
88  class Core *core = nullptr;
89  std::unique_ptr<ClipboardBase> clipboard = nullptr;
90  std::unique_ptr<ClipboardHandler> clipboard_handler = nullptr;
91  std::unique_ptr<KeySequenceDialog> key_sequence_dialog = nullptr;
92  std::unique_ptr<ImpInterface> imp_interface = nullptr;
93  Glib::RefPtr<Glib::Binding> grid_spacing_binding;
94 
95  std::map<ActionToolID, ActionConnection> action_connections;
96  ActionConnection &connect_action(ToolID tool_id, std::function<void(const ActionConnection &)> cb);
97  ActionConnection &connect_action(ToolID tool_id);
98  ActionConnection &connect_action(ActionID action_id, std::function<void(const ActionConnection &)> cb);
99 
100  class RulesWindow *rules_window = nullptr;
101 
102  zmq::context_t zctx;
103  zmq::socket_t sock_broadcast_rx;
104  zmq::socket_t sock_project;
105  bool sockets_connected = false;
106  int mgr_pid = -1;
107  bool no_update = false;
108  bool distraction_free = false;
109 
110  virtual void canvas_update() = 0;
111  virtual void expand_selection_for_property_panel(std::set<SelectableRef> &sel_extra,
112  const std::set<SelectableRef> &sel);
113  void handle_selection_changed(void);
114  virtual void handle_selection_cross_probe()
115  {
116  }
117  bool handle_key_press(const GdkEventKey *key_event);
118  void handle_cursor_move(const Coordi &pos);
119  bool handle_click(const GdkEventButton *button_event);
120  virtual void handle_extra_button(const GdkEventButton *button_event)
121  {
122  }
123  bool handle_click_release(const GdkEventButton *button_event);
124  bool handle_context_menu(const GdkEventButton *button_event);
125  void tool_process(ToolResponse &resp);
126  void tool_begin(ToolID id, bool override_selection = false, const std::set<SelectableRef> &sel = {},
127  std::unique_ptr<ToolData> data = nullptr);
128  void add_tool_button(ToolID id, const std::string &label, bool left = true);
129  void handle_warning_selected(const Coordi &pos);
130  virtual bool handle_broadcast(const json &j);
131  bool handle_close(const GdkEventAny *ev);
132  json send_json(const json &j);
133 
134  bool trigger_action(const ActionToolID &action);
135  bool trigger_action(ActionID aid);
136  bool trigger_action(ToolID tid);
137 
138  void add_tool_action(ToolID tid, const std::string &action);
139  void add_tool_action(ActionID aid, const std::string &action);
140  void add_hamburger_menu();
141 
142  Preferences preferences;
143 
144  virtual const CanvasPreferences &get_canvas_preferences()
145  {
146  return preferences.canvas_non_layer;
147  }
148  virtual void apply_preferences();
149 
150  std::unique_ptr<WindowStateStore> state_store = nullptr;
151 
152  virtual void handle_maybe_drag(bool ctrl);
153 
154  virtual ActionCatalogItem::Availability get_editor_type_for_action() const = 0;
155  ObjectType get_editor_type() const;
156 
157  void layer_up_down(bool up);
158  void goto_layer(int layer);
159 
160  Gtk::Button *create_action_button(ActionToolID action);
161 
162  void set_action_sensitive(ActionToolID, bool v);
163  bool get_action_sensitive(ActionToolID) const;
164  virtual void update_action_sensitivity();
165 
166  typedef sigc::signal<void> type_signal_action_sensitive;
167  type_signal_action_sensitive signal_action_sensitive()
168  {
169  return s_signal_action_sensitive;
170  }
171 
172  virtual std::string get_hud_text(std::set<SelectableRef> &sel);
173  std::string get_hud_text_for_component(const Component *comp);
174  std::string get_hud_text_for_net(const Net *net);
175 
176  void set_monitor_files(const std::set<std::string> &files);
177  void set_monitor_items(const ItemSet &items);
178  virtual void update_monitor()
179  {
180  }
181  void edit_pool_item(ObjectType type, const UUID &uu);
182 
183  void parameter_window_add_polygon_expand(class ParameterWindow *parameter_window);
184 
185  bool read_only = false;
186 
187  void tool_update_data(std::unique_ptr<ToolData> &data);
188 
189  virtual void search_center(const Searcher::SearchResult &res);
190  virtual ActionToolID get_doubleclick_action(ObjectType type, const UUID &uu);
191 
192  Glib::RefPtr<Gio::Menu> hamburger_menu;
193 
194  json m_meta;
195  void load_meta();
196  static const std::string meta_suffix;
197 
198  virtual void get_save_meta(json &j)
199  {
200  }
201 
202  void set_window_title(const std::string &s);
203  void set_window_title_from_block();
204 
205  void update_view_hints();
206  virtual std::vector<std::string> get_view_hints();
207 
208  Gtk::Box *view_options_menu = nullptr;
209  void view_options_menu_append_action(const std::string &label, const std::string &action);
210 
211  virtual Searcher *get_searcher_ptr()
212  {
213  return nullptr;
214  }
215 
216  bool has_searcher()
217  {
218  return get_searcher_ptr();
219  }
220 
221  Searcher &get_searcher()
222  {
223  auto s = get_searcher_ptr();
224  if (!s)
225  throw std::runtime_error("not implemented");
226  return *s;
227  }
228 
229  class ActionButton &add_action_button(ActionToolID action);
230  class ActionButtonMenu &add_action_button_menu(const char *icon_name);
231  class ActionButton &add_action_button_polygon();
232  class ActionButton &add_action_button_line();
233 
234  virtual ToolID get_tool_for_drag_move(bool ctrl, const std::set<SelectableRef> &sel) const;
235  void force_end_tool();
236 
237 private:
238  void fix_cursor_pos();
239  Glib::RefPtr<Gio::FileMonitor> preferences_monitor;
240  void handle_drag();
241  void update_selection_label();
242  std::string get_tool_settings_filename(ToolID id);
243 
244  void hud_update();
245 
246  std::map<std::string, Glib::RefPtr<Gio::FileMonitor>> file_monitors;
247  sigc::connection file_monitor_delay_connection;
248 
249  void handle_file_changed(const Glib::RefPtr<Gio::File> &file1, const Glib::RefPtr<Gio::File> &file2,
250  Gio::FileMonitorEvent ev);
251 
252  ActionConnection &connect_action(ActionID action_id, ToolID tool_id,
253  std::function<void(const ActionConnection &)> cb);
254 
255  void create_context_menu(Gtk::Menu *parent, const std::set<SelectableRef> &sel);
256  Gtk::MenuItem *create_context_menu_item(ActionToolID act);
257 
258  KeySequence keys_current;
259  enum class MatchResult { NONE, PREFIX, COMPLETE };
260  MatchResult keys_match(const KeySequence &keys) const;
261  bool handle_action_key(const GdkEventKey *ev);
262  void handle_tool_action(const ActionConnection &conn);
263  void handle_select_polygon(const ActionConnection &a);
264 
265  void handle_search();
266  void search_go(int dir);
267  std::list<Searcher::SearchResult> search_results;
268  unsigned int search_result_current = 0;
269  void update_search_markers();
270  void update_search_types_label();
271  void set_search_mode(bool enabled, bool focus = true);
272  std::map<Searcher::Type, Gtk::CheckButton *> search_check_buttons;
273 
274  class LogWindow *log_window = nullptr;
275  std::set<SelectableRef> selection_for_drag_move;
276  ToolID drag_tool;
277  Coordf cursor_pos_drag_begin;
278  Coordi cursor_pos_grid_drag_begin;
279 
280  std::map<ActionToolID, bool> action_sensitivity;
281  type_signal_action_sensitive s_signal_action_sensitive;
282 
283  bool property_panel_has_focus();
284 
285  sigc::connection initial_view_all_conn;
286 
287  bool sockets_broken = false;
288  void show_sockets_broken_dialog(const std::string &msg = "");
289  bool needs_autosave = false;
290  bool queue_autosave = false;
291 
292  void update_property_panels();
293  std::map<CanvasGL::SelectionTool, CanvasGL::SelectionQualifier> selection_qualifiers;
294  std::list<class ActionButtonBase *> action_buttons;
295 
296  Glib::RefPtr<Gio::SimpleAction> bottom_view_action;
297  Glib::RefPtr<Gio::SimpleAction> distraction_free_action;
298 
299  int left_panel_width = 0;
300 
301  void tool_bar_set_actions(const std::vector<ActionLabelInfo> &labels);
302  void tool_bar_append_action(InToolActionID action1, InToolActionID action2, const std::string &s);
303  void tool_bar_clear_actions();
304  InToolKeySequencesPreferences in_tool_key_sequeces_preferences;
305  std::vector<ActionLabelInfo> in_tool_action_label_infos;
306 
307  void show_preferences(std::optional<std::string> page = std::nullopt);
308 
309  void init_search();
310  void init_key();
311  void init_action();
312 
313  void handle_pan_action(const ActionConnection &c);
314  void handle_zoom_action(const ActionConnection &c);
315 
316  std::string get_complete_display_name(const SelectableRef &sr);
317 
318  void set_flip_view(bool flip);
319  void apply_arrow_keys();
320  void check_version();
321 
322  void update_cursor(ToolID tool_id);
323 
324  std::set<SelectableRef> last_canvas_selection;
325 };
326 } // namespace horizon
Definition: action.hpp:143
Definition: canvas_gl.hpp:18
Where Tools and and documents meet.
Definition: core.hpp:42
Definition: imp.hpp:35
Definition: imp_interface.hpp:12
Definition: main_window.hpp:7
Definition: imp.hpp:27
Stores objects (Unit, Entity, Symbol, Part, etc.) from the pool.
Definition: pool.hpp:24
Definition: property_panels.hpp:8
Definition: rules_window.hpp:13
Definition: tool_popover.hpp:8
Definition: warnings_box.hpp:7
a class to store JSON values
Definition: json.hpp:170