]> de.git.xonotic.org Git - xonotic/netradiant.git/blob - libs/uilib/uilib.h
Merge branch 'TimePath/gtk++' into 'master'
[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
170     class Object :
171             public details::Convertible<Object, _GtkObject *, details::Convert::Explicit>,
172             public details::Convertible<Object, _GTypeInstance *, details::Convert::Explicit> {
173     public:
174         using self = Object *;
175         using native = _GtkObject *;
176         native _handle;
177
178         Object(native h) : _handle(h)
179         {}
180
181         explicit operator bool() const
182         { return _handle != nullptr; }
183
184         explicit operator void *() const
185         { return _handle; }
186
187         void unref()
188         { g_object_unref(_handle); }
189
190         template<class Lambda>
191         gulong connect(char const *detailed_signal, Lambda &&c_handler, void *data);
192
193         template<class Lambda>
194         gulong connect(char const *detailed_signal, Lambda &&c_handler, Object data);
195     };
196     static_assert(sizeof(Object) == sizeof(Object::native), "object slicing");
197
198 #define WRAP(name, super, T, interfaces, ctors, methods) \
199     class name; \
200     class I##name : public details::Convertible<name, T *, details::Convert::Implicit> { \
201     public: \
202         using self = name *; \
203         methods \
204     }; \
205     class name : public super, public I##name, public details::Mixin<name, void interfaces>::type { \
206     public: \
207         using self = name *; \
208         using native = T *; \
209         explicit name(native h) : super(reinterpret_cast<super::native>(h)) {} \
210         explicit name(Null n) : name((native) nullptr) {} \
211         static name from(void *ptr) { return name((native) ptr); } \
212         ctors \
213     }; \
214     inline bool operator<(name self, name other) { return self._handle < other._handle; } \
215     static_assert(sizeof(name) == sizeof(super), "object slicing")
216
217     // https://developer.gnome.org/gtk2/stable/ch01.html
218
219     // GInterface
220
221     WRAP(CellEditable, Object, _GtkCellEditable, (),
222     ,
223     );
224
225     WRAP(Editable, Object, _GtkEditable, (),
226          Editable();
227     ,
228          void editable(bool value);
229     );
230
231     WRAP(TreeModel, Object, _GtkTreeModel, (),
232     ,
233     );
234
235     // GObject
236
237     WRAP(Widget, Object, _GtkWidget, (),
238          Widget();
239     ,
240          alert_response alert(
241                  std::string text,
242                  std::string title = "NetRadiant",
243                  alert_type type = alert_type::OK,
244                  alert_icon icon = alert_icon::Default
245          );
246          const char *file_dialog(
247                  bool open,
248                  const char *title,
249                  const char *path = nullptr,
250                  const char *pattern = nullptr,
251                  bool want_load = false,
252                  bool want_import = false,
253                  bool want_save = false
254          );
255          void show();
256     );
257
258     WRAP(Container, Widget, _GtkContainer, (),
259     ,
260          void add(Widget widget);
261
262          void remove(Widget widget);
263
264          template<class Lambda>
265          void foreach(Lambda &&lambda);
266     );
267
268     WRAP(Bin, Container, _GtkBin, (),
269     ,
270     );
271
272     class AccelGroup;
273     WRAP(Window, Bin, _GtkWindow, (),
274          Window(window_type type);
275     ,
276          Window create_dialog_window(
277                  const char *title,
278                  void func(),
279                  void *data,
280                  int default_w = -1,
281                  int default_h = -1
282          );
283
284          Window create_modal_dialog_window(
285                  const char *title,
286                  ModalDialog &dialog,
287                  int default_w = -1,
288                  int default_h = -1
289          );
290
291          Window create_floating_window(const char *title);
292
293          std::uint64_t on_key_press(
294                  bool (*f)(Widget widget, _GdkEventKey *event, void *extra),
295                  void *extra = nullptr
296          );
297
298          void add_accel_group(AccelGroup group);
299     );
300
301     WRAP(Dialog, Window, _GtkDialog, (),
302     ,
303     );
304
305     WRAP(Alignment, Bin, _GtkAlignment, (),
306          Alignment(float xalign, float yalign, float xscale, float yscale);
307     ,
308     );
309
310     WRAP(Frame, Bin, _GtkFrame, (),
311          Frame(const char *label = nullptr);
312     ,
313     );
314
315     WRAP(Button, Bin, _GtkButton, (),
316          Button();
317          Button(const char *label);
318     ,
319     );
320
321     WRAP(ToggleButton, Button, _GtkToggleButton, (),
322     ,
323          bool active();
324     );
325
326     WRAP(CheckButton, ToggleButton, _GtkCheckButton, (),
327          CheckButton(const char *label);
328     ,
329     );
330
331     WRAP(RadioButton, CheckButton, _GtkRadioButton, (),
332     ,
333     );
334
335     WRAP(Item, Bin, _GtkItem, (),
336     ,
337     );
338
339     WRAP(MenuItem, Item, _GtkMenuItem, (),
340          MenuItem();
341          MenuItem(const char *label, bool mnemonic = false);
342     ,
343     );
344
345     WRAP(CheckMenuItem, MenuItem, _GtkCheckMenuItem, (),
346     ,
347     );
348
349     WRAP(RadioMenuItem, CheckMenuItem, _GtkRadioMenuItem, (),
350     ,
351     );
352
353     WRAP(TearoffMenuItem, MenuItem, _GtkTearoffMenuItem, (),
354          TearoffMenuItem();
355     ,
356     );
357
358     WRAP(ComboBox, Bin, _GtkComboBox, (),
359     ,
360     );
361
362     WRAP(ComboBoxText, ComboBox, _GtkComboBoxText, (),
363          ComboBoxText();
364     ,
365     );
366
367     WRAP(ToolItem, Bin, _GtkToolItem, (),
368     ,
369     );
370
371     WRAP(ToolButton, ToolItem, _GtkToolButton, (),
372     ,
373     );
374
375     WRAP(ToggleToolButton, ToolButton, _GtkToggleToolButton, (),
376     ,
377     );
378
379     WRAP(RadioToolButton, ToggleToolButton, _GtkRadioToolButton, (),
380     ,
381     );
382
383     WRAP(ScrolledWindow, Bin, _GtkScrolledWindow, (),
384          ScrolledWindow();
385     ,
386     );
387
388     WRAP(Box, Container, _GtkBox, (),
389     ,
390     );
391
392     WRAP(VBox, Box, _GtkVBox, (),
393          VBox(bool homogenous, int spacing);
394     ,
395     );
396
397     WRAP(HBox, Box, _GtkHBox, (),
398          HBox(bool homogenous, int spacing);
399     ,
400     );
401
402     WRAP(Paned, Container, _GtkPaned, (),
403     ,
404     );
405
406     WRAP(HPaned, Paned, _GtkHPaned, (),
407          HPaned();
408     ,
409     );
410
411     WRAP(VPaned, Paned, _GtkVPaned, (),
412          VPaned();
413     ,
414     );
415
416     WRAP(MenuShell, Container, _GtkMenuShell, (),
417     ,
418     );
419
420     WRAP(MenuBar, MenuShell, _GtkMenuBar, (),
421     ,
422     );
423
424     WRAP(Menu, MenuShell, _GtkMenu, (),
425          Menu();
426     ,
427     );
428
429     WRAP(Table, Container, _GtkTable, (),
430          Table(std::size_t rows, std::size_t columns, bool homogenous);
431     ,
432     );
433
434     WRAP(TextView, Container, _GtkTextView, (),
435          TextView();
436     ,
437     );
438
439     WRAP(Toolbar, Container, _GtkToolbar, (),
440     ,
441     );
442
443     class TreeModel;
444     WRAP(TreeView, Widget, _GtkTreeView, (),
445          TreeView();
446          TreeView(TreeModel model);
447     ,
448     );
449
450     WRAP(Misc, Widget, _GtkMisc, (),
451     ,
452     );
453
454     WRAP(Label, Widget, _GtkLabel, (),
455          Label(const char *label);
456     ,
457     );
458
459     WRAP(Image, Widget, _GtkImage, (),
460          Image();
461     ,
462     );
463
464     WRAP(Entry, Widget, _GtkEntry, (IEditable, ICellEditable),
465          Entry();
466          Entry(std::size_t max_length);
467     ,
468     );
469
470     class Adjustment;
471     WRAP(SpinButton, Entry, _GtkSpinButton, (),
472          SpinButton(Adjustment adjustment, double climb_rate, std::size_t digits);
473     ,
474     );
475
476     WRAP(Range, Widget, _GtkRange, (),
477     ,
478     );
479
480     WRAP(Scale, Range, _GtkScale, (),
481     ,
482     );
483
484     WRAP(HScale, Scale, _GtkHScale, (),
485          HScale(Adjustment adjustment);
486          HScale(double min, double max, double step);
487     ,
488     );
489
490     WRAP(Adjustment, Object, _GtkAdjustment, (),
491          Adjustment(double value,
492                     double lower, double upper,
493                     double step_increment, double page_increment,
494                     double page_size);
495     ,
496     );
497
498     WRAP(CellRenderer, Object, _GtkCellRenderer, (),
499     ,
500     );
501
502     WRAP(CellRendererText, CellRenderer, _GtkCellRendererText, (),
503          CellRendererText();
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          AccelGroup();
518     ,
519     );
520
521     WRAP(EntryCompletion, Object, _GtkEntryCompletion, (),
522     ,
523     );
524
525     WRAP(ListStore, Object, _GtkListStore, (ITreeModel),
526     ,
527          void clear();
528     );
529
530     WRAP(TreeSelection, Object, _GtkTreeSelection, (),
531     ,
532     );
533
534     // GBoxed
535
536     WRAP(TreePath, Object, _GtkTreePath, (),
537          TreePath();
538          TreePath(const char *path);
539     ,
540     );
541
542     // Custom
543
544     WRAP(GLArea, Widget, _GtkGLArea, (),
545     ,
546          guint on_render(GCallback pFunction, void *data);
547     );
548
549 #undef WRAP
550
551     // callbacks
552
553     namespace {
554         using GtkCallback = void (*)(_GtkWidget *, void *);
555         extern "C" {
556         void gtk_container_foreach(_GtkContainer *, GtkCallback, void *);
557         }
558     }
559
560 #define this (*static_cast<self>(this))
561
562     template<class Lambda>
563     gulong Object::connect(char const *detailed_signal, Lambda &&c_handler, void *data)
564     {
565         return g_signal_connect(G_OBJECT(this), detailed_signal, c_handler, data);
566     }
567
568     template<class Lambda>
569     gulong Object::connect(char const *detailed_signal, Lambda &&c_handler, Object data)
570     {
571         return g_signal_connect(G_OBJECT(this), detailed_signal, c_handler, (_GtkObject *) data);
572     }
573
574     template<class Lambda>
575     void IContainer::foreach(Lambda &&lambda)
576     {
577         GtkCallback cb = [](_GtkWidget *widget, void *data) -> void {
578             using Function = typename std::decay<Lambda>::type;
579             Function *f = static_cast<Function *>(data);
580             (*f)(Widget(widget));
581         };
582         gtk_container_foreach(this, cb, &lambda);
583     }
584
585 #undef this
586
587 }
588
589 #endif