]> git.xonotic.org Git - xonotic/netradiant.git/blob - libs/uilib/uilib.h
Prevent implicit Widget construction
[xonotic/netradiant.git] / libs / uilib / uilib.h
1 #ifndef INCLUDED_UILIB_H
2 #define INCLUDED_UILIB_H
3
4 #include <string>
5 #include <glib-object.h>
6
7 struct _GdkEventKey;
8 struct _GtkAccelGroup;
9 struct _GtkAdjustment;
10 struct _GtkAlignment;
11 struct _GtkBin;
12 struct _GtkBox;
13 struct _GtkButton;
14 struct _GtkCellEditable;
15 struct _GtkCellRenderer;
16 struct _GtkCellRendererText;
17 struct _GtkCheckButton;
18 struct _GtkCheckMenuItem;
19 struct _GtkComboBox;
20 struct _GtkComboBoxText;
21 struct _GtkContainer;
22 struct _GtkDialog;
23 struct _GtkEditable;
24 struct _GtkEntry;
25 struct _GtkEntryCompletion;
26 struct _GtkFrame;
27 struct _GtkHBox;
28 struct _GtkHPaned;
29 struct _GtkHScale;
30 struct _GtkImage;
31 struct _GtkItem;
32 struct _GtkLabel;
33 struct _GtkListStore;
34 struct _GtkMenu;
35 struct _GtkMenuBar;
36 struct _GtkMenuItem;
37 struct _GtkMenuShell;
38 struct _GtkMisc;
39 struct _GtkObject;
40 struct _GtkPaned;
41 struct _GtkRadioButton;
42 struct _GtkRadioMenuItem;
43 struct _GtkRadioToolButton;
44 struct _GtkRange;
45 struct _GtkScale;
46 struct _GtkScrolledWindow;
47 struct _GtkSpinButton;
48 struct _GtkTable;
49 struct _GtkTearoffMenuItem;
50 struct _GtkTextView;
51 struct _GtkToggleButton;
52 struct _GtkToggleToolButton;
53 struct _GtkToolbar;
54 struct _GtkToolButton;
55 struct _GtkToolItem;
56 struct _GtkTreeModel;
57 struct _GtkTreePath;
58 struct _GtkTreeSelection;
59 struct _GtkTreeView;
60 struct _GtkTreeViewColumn;
61 struct _GtkVBox;
62 struct _GtkVPaned;
63 struct _GtkWidget;
64 struct _GtkWindow;
65 struct _GTypeInstance;
66
67 #if GTK_TARGET == 3
68 struct _GtkGLArea;
69 #endif
70
71 #if GTK_TARGET == 2
72 using _GtkGLArea = struct _GtkDrawingArea;
73 #endif
74
75 struct ModalDialog;
76
77 namespace ui {
78
79     bool init(int *argc, char **argv[], char const *parameter_string, char const **error);
80
81     void main();
82
83     void process();
84
85     extern class Widget root;
86
87     enum class alert_type {
88         OK,
89         OKCANCEL,
90         YESNO,
91         YESNOCANCEL,
92         NOYES,
93     };
94
95     enum class alert_icon {
96         Default,
97         Error,
98         Warning,
99         Question,
100         Asterisk,
101     };
102
103     enum class alert_response {
104         OK,
105         CANCEL,
106         YES,
107         NO,
108     };
109
110     enum class window_type {
111         TOP,
112         POPUP
113     };
114
115     enum class Shadow {
116         NONE,
117         IN,
118         OUT,
119         ETCHED_IN,
120         ETCHED_OUT
121     };
122
123     enum class Policy {
124         ALWAYS,
125         AUTOMATIC,
126         NEVER
127     };
128
129     namespace details {
130
131         enum class Convert {
132             Implicit, Explicit
133         };
134
135         template<class Self, class T, Convert mode>
136         struct Convertible;
137
138         template<class Self, class T>
139         struct Convertible<Self, T, Convert::Implicit> {
140             operator T() const
141             { return reinterpret_cast<T>(static_cast<Self const *>(this)->_handle); }
142         };
143
144         template<class Self, class T>
145         struct Convertible<Self, T, Convert::Explicit> {
146             explicit operator T() const
147             { return reinterpret_cast<T>(static_cast<Self const *>(this)->_handle); }
148         };
149
150         template<class Self, class... T>
151         struct All : T ... {
152             All()
153             {};
154         };
155
156         template<class Self, class Interfaces>
157         struct Mixin;
158         template<class Self>
159         struct Mixin<Self, void()> {
160             using type = All<Self>;
161         };
162         template<class Self, class... Interfaces>
163         struct Mixin<Self, void(Interfaces...)> {
164             using type = All<Self, Interfaces...>;
165         };
166     }
167
168     extern struct Null {} null;
169     extern struct New_t {} New;
170
171     class Object :
172             public details::Convertible<Object, _GtkObject *, details::Convert::Explicit>,
173             public details::Convertible<Object, _GTypeInstance *, details::Convert::Explicit> {
174     public:
175         using self = Object *;
176         using native = _GtkObject *;
177         native _handle;
178
179         explicit Object(native h) : _handle(h)
180         {}
181
182         explicit operator bool() const
183         { return _handle != nullptr; }
184
185         explicit operator void *() const
186         { return _handle; }
187
188         void unref()
189         { g_object_unref(_handle); }
190
191         template<class Lambda>
192         gulong connect(char const *detailed_signal, Lambda &&c_handler, void *data);
193
194         template<class Lambda>
195         gulong connect(char const *detailed_signal, Lambda &&c_handler, Object data);
196     };
197     static_assert(sizeof(Object) == sizeof(Object::native), "object slicing");
198
199 #define WRAP(name, super, T, interfaces, ctors, methods) \
200     class name; \
201     class I##name : public details::Convertible<name, T *, details::Convert::Implicit> { \
202     public: \
203         using self = name *; \
204         methods \
205     }; \
206     class name : public super, public I##name, public details::Mixin<name, void interfaces>::type { \
207     public: \
208         using self = name *; \
209         using native = T *; \
210         explicit name(native h) : super(reinterpret_cast<super::native>(h)) {} \
211         explicit name(Null n) : name((native) nullptr) {} \
212         explicit name(New_t); \
213         static name from(void *ptr) { return name((native) ptr); } \
214         ctors \
215     }; \
216     inline bool operator<(name self, name other) { return self._handle < other._handle; } \
217     static_assert(sizeof(name) == sizeof(super), "object slicing")
218
219     // https://developer.gnome.org/gtk2/stable/ch01.html
220
221     // GInterface
222
223     WRAP(CellEditable, Object, _GtkCellEditable, (),
224     ,
225     );
226
227     WRAP(Editable, Object, _GtkEditable, (),
228     ,
229          void editable(bool value);
230     );
231
232     WRAP(TreeModel, Object, _GtkTreeModel, (),
233     ,
234     );
235
236     // GObject
237
238     struct Dimensions {
239         int width;
240         int height;
241     };
242
243     WRAP(Widget, Object, _GtkWidget, (),
244     ,
245          alert_response alert(
246                  std::string text,
247                  std::string title = "NetRadiant",
248                  alert_type type = alert_type::OK,
249                  alert_icon icon = alert_icon::Default
250          );
251          const char *file_dialog(
252                  bool open,
253                  const char *title,
254                  const char *path = nullptr,
255                  const char *pattern = nullptr,
256                  bool want_load = false,
257                  bool want_import = false,
258                  bool want_save = false
259          );
260          bool visible();
261          void show();
262          Dimensions dimensions();
263          void dimensions(int width, int height);
264     );
265
266     WRAP(Container, Widget, _GtkContainer, (),
267     ,
268          void add(Widget widget);
269
270          void remove(Widget widget);
271
272          template<class Lambda>
273          void foreach(Lambda &&lambda);
274     );
275
276     WRAP(Bin, Container, _GtkBin, (),
277     ,
278     );
279
280     class AccelGroup;
281     WRAP(Window, Bin, _GtkWindow, (),
282          explicit Window(window_type type);
283     ,
284          Window create_dialog_window(
285                  const char *title,
286                  void func(),
287                  void *data,
288                  int default_w = -1,
289                  int default_h = -1
290          );
291
292          Window create_modal_dialog_window(
293                  const char *title,
294                  ModalDialog &dialog,
295                  int default_w = -1,
296                  int default_h = -1
297          );
298
299          Window create_floating_window(const char *title);
300
301          std::uint64_t on_key_press(
302                  bool (*f)(Widget widget, _GdkEventKey *event, void *extra),
303                  void *extra = nullptr
304          );
305
306          void add_accel_group(AccelGroup group);
307     );
308
309     WRAP(Dialog, Window, _GtkDialog, (),
310     ,
311     );
312
313     WRAP(Alignment, Bin, _GtkAlignment, (),
314          Alignment(float xalign, float yalign, float xscale, float yscale);
315     ,
316     );
317
318     WRAP(Frame, Bin, _GtkFrame, (),
319          explicit Frame(const char *label = nullptr);
320     ,
321     );
322
323     WRAP(Button, Bin, _GtkButton, (),
324          explicit Button(const char *label);
325     ,
326     );
327
328     WRAP(ToggleButton, Button, _GtkToggleButton, (),
329     ,
330          bool active();
331     );
332
333     WRAP(CheckButton, ToggleButton, _GtkCheckButton, (),
334          explicit CheckButton(const char *label);
335     ,
336     );
337
338     WRAP(RadioButton, CheckButton, _GtkRadioButton, (),
339     ,
340     );
341
342     WRAP(Item, Bin, _GtkItem, (),
343     ,
344     );
345
346     WRAP(MenuItem, Item, _GtkMenuItem, (),
347          explicit MenuItem(const char *label, bool mnemonic = false);
348     ,
349     );
350
351     WRAP(CheckMenuItem, MenuItem, _GtkCheckMenuItem, (),
352     ,
353     );
354
355     WRAP(RadioMenuItem, CheckMenuItem, _GtkRadioMenuItem, (),
356     ,
357     );
358
359     WRAP(TearoffMenuItem, MenuItem, _GtkTearoffMenuItem, (),
360     ,
361     );
362
363     WRAP(ComboBox, Bin, _GtkComboBox, (),
364     ,
365     );
366
367     WRAP(ComboBoxText, ComboBox, _GtkComboBoxText, (),
368     ,
369     );
370
371     WRAP(ToolItem, Bin, _GtkToolItem, (),
372     ,
373     );
374
375     WRAP(ToolButton, ToolItem, _GtkToolButton, (),
376     ,
377     );
378
379     WRAP(ToggleToolButton, ToolButton, _GtkToggleToolButton, (),
380     ,
381     );
382
383     WRAP(RadioToolButton, ToggleToolButton, _GtkRadioToolButton, (),
384     ,
385     );
386
387     WRAP(ScrolledWindow, Bin, _GtkScrolledWindow, (),
388     ,
389          void overflow(Policy x, Policy y);
390     );
391
392     WRAP(Box, Container, _GtkBox, (),
393     ,
394     );
395
396     WRAP(VBox, Box, _GtkVBox, (),
397          VBox(bool homogenous, int spacing);
398     ,
399     );
400
401     WRAP(HBox, Box, _GtkHBox, (),
402          HBox(bool homogenous, int spacing);
403     ,
404     );
405
406     WRAP(Paned, Container, _GtkPaned, (),
407     ,
408     );
409
410     WRAP(HPaned, Paned, _GtkHPaned, (),
411     ,
412     );
413
414     WRAP(VPaned, Paned, _GtkVPaned, (),
415     ,
416     );
417
418     WRAP(MenuShell, Container, _GtkMenuShell, (),
419     ,
420     );
421
422     WRAP(MenuBar, MenuShell, _GtkMenuBar, (),
423     ,
424     );
425
426     WRAP(Menu, MenuShell, _GtkMenu, (),
427     ,
428     );
429
430     WRAP(Table, Container, _GtkTable, (),
431          Table(std::size_t rows, std::size_t columns, bool homogenous);
432     ,
433     );
434
435     WRAP(TextView, Container, _GtkTextView, (),
436     ,
437          void text(char const *str);
438     );
439
440     WRAP(Toolbar, Container, _GtkToolbar, (),
441     ,
442     );
443
444     class TreeModel;
445     WRAP(TreeView, Widget, _GtkTreeView, (),
446          TreeView(TreeModel model);
447     ,
448     );
449
450     WRAP(Misc, Widget, _GtkMisc, (),
451     ,
452     );
453
454     WRAP(Label, Widget, _GtkLabel, (),
455          explicit Label(const char *label);
456     ,
457          void text(char const *str);
458     );
459
460     WRAP(Image, Widget, _GtkImage, (),
461     ,
462     );
463
464     WRAP(Entry, Widget, _GtkEntry, (IEditable, ICellEditable),
465          explicit Entry(std::size_t max_length);
466     ,
467         char const *text();
468         void text(char const *str);
469     );
470
471     class Adjustment;
472     WRAP(SpinButton, Entry, _GtkSpinButton, (),
473          SpinButton(Adjustment adjustment, double climb_rate, std::size_t digits);
474     ,
475     );
476
477     WRAP(Range, Widget, _GtkRange, (),
478     ,
479     );
480
481     WRAP(Scale, Range, _GtkScale, (),
482     ,
483     );
484
485     WRAP(HScale, Scale, _GtkHScale, (),
486          explicit HScale(Adjustment adjustment);
487          HScale(double min, double max, double step);
488     ,
489     );
490
491     WRAP(Adjustment, Object, _GtkAdjustment, (),
492          Adjustment(double value,
493                     double lower, double upper,
494                     double step_increment, double page_increment,
495                     double page_size);
496     ,
497     );
498
499     WRAP(CellRenderer, Object, _GtkCellRenderer, (),
500     ,
501     );
502
503     WRAP(CellRendererText, CellRenderer, _GtkCellRendererText, (),
504     ,
505     );
506
507     struct TreeViewColumnAttribute {
508         const char *attribute;
509         int column;
510     };
511     WRAP(TreeViewColumn, Object, _GtkTreeViewColumn, (),
512          TreeViewColumn(const char *title, CellRenderer renderer, std::initializer_list<TreeViewColumnAttribute> attributes);
513     ,
514     );
515
516     WRAP(AccelGroup, Object, _GtkAccelGroup, (),
517     ,
518     );
519
520     WRAP(EntryCompletion, Object, _GtkEntryCompletion, (),
521     ,
522     );
523
524     WRAP(ListStore, Object, _GtkListStore, (ITreeModel),
525     ,
526          void clear();
527     );
528
529     WRAP(TreeSelection, Object, _GtkTreeSelection, (),
530     ,
531     );
532
533     // GBoxed
534
535     WRAP(TreePath, Object, _GtkTreePath, (),
536          explicit TreePath(const char *path);
537     ,
538     );
539
540     // Custom
541
542     WRAP(GLArea, Widget, _GtkGLArea, (),
543     ,
544          guint on_render(GCallback pFunction, void *data);
545     );
546
547 #undef WRAP
548
549     // callbacks
550
551     namespace {
552         using GtkCallback = void (*)(_GtkWidget *, void *);
553         extern "C" {
554         void gtk_container_foreach(_GtkContainer *, GtkCallback, void *);
555         }
556     }
557
558 #define this (*static_cast<self>(this))
559
560     template<class Lambda>
561     gulong Object::connect(char const *detailed_signal, Lambda &&c_handler, void *data)
562     {
563         return g_signal_connect(G_OBJECT(this), detailed_signal, c_handler, data);
564     }
565
566     template<class Lambda>
567     gulong Object::connect(char const *detailed_signal, Lambda &&c_handler, Object data)
568     {
569         return g_signal_connect(G_OBJECT(this), detailed_signal, c_handler, (_GtkObject *) data);
570     }
571
572     template<class Lambda>
573     void IContainer::foreach(Lambda &&lambda)
574     {
575         GtkCallback cb = [](_GtkWidget *widget, void *data) -> void {
576             using Function = typename std::decay<Lambda>::type;
577             Function *f = static_cast<Function *>(data);
578             (*f)(Widget(widget));
579         };
580         gtk_container_foreach(this, cb, &lambda);
581     }
582
583 #undef this
584
585 }
586
587 #endif