source: window.c @ 50031f0

release-1.7release-1.8release-1.9
Last change on this file since 50031f0 was 50031f0, checked in by David Benjamin <davidben@mit.edu>, 12 years ago
Rename map/unmap to hide/show to match GTK+ Also, the names make much more sense.
  • Property mode set to 100644
File size: 11.9 KB
Line 
1#include "owl.h"
2
3#include <assert.h>
4
5struct _owl_window { /*noproto*/
6  /* hierarchy information */
7  owl_window *parent;
8  owl_window *child;
9  owl_window *next, *prev;
10  /* flags */
11  int dirty : 1;
12  int dirty_subtree : 1;
13  int shown : 1;
14  int is_screen : 1;
15  /* window information */
16  WINDOW *win;
17  PANEL *pan;
18  int nlines, ncols;
19  int begin_y, begin_x;
20  /* hooks */
21  void (*redraw_cb)(owl_window *, WINDOW *, void *);
22  void  *redraw_cbdata;
23  void (*redraw_cbdata_destroy)(void *);
24
25  void (*size_cb)(owl_window *, void *);
26  void  *size_cbdata;
27  void (*size_cbdata_destroy)(void *);
28
29  void (*destroy_cb)(owl_window *, void *);
30  void  *destroy_cbdata;
31  void (*destroy_cbdata_destroy)(void *);
32};
33
34static owl_window *_owl_window_new(owl_window *parent, int nlines, int ncols, int begin_y, int begin_x);
35
36static void _owl_window_unlink(owl_window *w);
37static void _owl_window_link(owl_window *w, owl_window *parent);
38
39static void _owl_window_create_curses(owl_window *w);
40static void _owl_window_destroy_curses(owl_window *w);
41
42static void _owl_window_realize(owl_window *w);
43static void _owl_window_unrealize(owl_window *w);
44
45/** singletons **/
46
47static WINDOW *_dummy_window(void)
48{
49  static WINDOW *dummy = NULL;
50  if (!dummy) {
51    dummy = newwin(1, 1, 0, 0);
52  }
53  return dummy;
54}
55
56static void _screen_calculate_size(owl_window *screen, void *user_data)
57{
58  owl_global *g = user_data;
59  int lines, cols;
60  owl_global_get_terminal_size(&lines, &cols);
61  if (!g->lines) g->lines = lines;
62  if (!g->cols) g->cols = cols;
63  owl_window_resize(screen, g->lines, g->cols);
64}
65
66owl_window *owl_window_get_screen(void)
67{
68  static owl_window *screen = NULL;
69  if (!screen) {
70    /* The screen is magical. It's 'shown', but the only mean of it going
71     * invisible is if we're tore down curses (i.e. screen resize) */
72    screen = _owl_window_new(NULL, g.lines, g.cols, 0, 0);
73    screen->is_screen = 1;
74    owl_window_set_size_cb(screen, _screen_calculate_size, &g, 0);
75    owl_window_show(screen, 0);
76  }
77  return screen;
78}
79
80/** Creation and Destruction **/
81
82owl_window *owl_window_new(owl_window *parent)
83{
84  if (!parent)
85    parent = owl_window_get_screen();
86  return _owl_window_new(parent, 0, 0, 0, 0);
87}
88
89static owl_window *_owl_window_new(owl_window *parent, int nlines, int ncols, int begin_y, int begin_x)
90{
91  owl_window *w;
92
93  w = owl_malloc(sizeof(owl_window));
94  memset(w, 0, sizeof(*w));
95
96  w->nlines = nlines;
97  w->ncols = ncols;
98  w->begin_y = begin_y;
99  w->begin_x = begin_x;
100
101  _owl_window_link(w, parent);
102  if (parent && parent->is_screen) {
103    w->pan = new_panel(_dummy_window());
104    set_panel_userptr(w->pan, w);
105  }
106
107  return w;
108}
109
110void owl_window_delete(owl_window *w)
111{
112  /* destroy all children */
113  owl_window_children_foreach_onearg(w, owl_window_delete);
114
115  /* notify everyone of your imminent demise */
116  if (w->destroy_cb)
117    w->destroy_cb(w, w->destroy_cbdata);
118
119  /* clear all cbs */
120  owl_window_set_redraw_cb(w, 0, 0, 0);
121  owl_window_set_size_cb(w, 0, 0, 0);
122  owl_window_set_destroy_cb(w, 0, 0, 0);
123
124  /* destroy curses structures */
125  owl_window_unmap(w);
126  if (w->pan) {
127    del_panel(w->pan);
128  }
129
130  /* remove from hierarchy */
131  _owl_window_unlink(w);
132  owl_free(w);
133}
134
135/** Callbacks **/
136
137void owl_window_set_redraw_cb(owl_window *w, void (*cb)(owl_window*, WINDOW*, void*), void *cbdata, void (*cbdata_destroy)(void*))
138{
139  if (w->redraw_cbdata_destroy) {
140    w->redraw_cbdata_destroy(w->redraw_cbdata);
141    w->redraw_cbdata = 0;
142    w->redraw_cbdata_destroy = 0;
143  }
144
145  w->redraw_cb = cb;
146  w->redraw_cbdata = cbdata;
147  w->redraw_cbdata_destroy = cbdata_destroy;
148
149  /* mark the window as dirty, to take new cb in account */
150  owl_window_dirty(w);
151}
152
153void owl_window_set_size_cb(owl_window *w, void (*cb)(owl_window*, void*), void *cbdata, void (*cbdata_destroy)(void*))
154{
155  if (w->size_cbdata_destroy) {
156    w->size_cbdata_destroy(w->size_cbdata);
157    w->size_cbdata = 0;
158    w->size_cbdata_destroy = 0;
159  }
160
161  w->size_cb = cb;
162  w->size_cbdata = cbdata;
163  w->size_cbdata_destroy = cbdata_destroy;
164
165  owl_window_recompute_position(w);
166}
167
168void owl_window_set_destroy_cb(owl_window *w, void (*cb)(owl_window*, void*), void *cbdata, void (*cbdata_destroy)(void*))
169{
170  if (w->destroy_cbdata_destroy) {
171    w->destroy_cbdata_destroy(w->destroy_cbdata);
172    w->destroy_cbdata = 0;
173    w->destroy_cbdata_destroy = 0;
174  }
175
176  w->destroy_cb = cb;
177  w->destroy_cbdata = cbdata;
178  w->destroy_cbdata_destroy = cbdata_destroy;
179}
180
181/** Hierarchy **/
182
183static void _owl_window_unlink(owl_window *w)
184{
185  /* make sure the window is unmapped first */
186  _owl_window_unrealize(w);
187  /* unlink parent/child information */
188  if (w->parent) {
189    if (w->prev)
190      w->prev->next = w->next;
191    if (w->next)
192      w->next->prev = w->prev;
193    if (w->parent->child == w)
194      w->parent->child = w->next;
195    w->parent = NULL;
196  }
197}
198
199static void _owl_window_link(owl_window *w, owl_window *parent)
200{
201  if (w->parent == parent)
202    return;
203
204  owl_window_unlink(w);
205  if (parent) {
206    w->parent = parent;
207    w->next = parent->child;
208    parent->child = w;
209  }
210}
211
212/* mimic g_list_foreach for consistency */
213void owl_window_children_foreach(owl_window *parent, GFunc func, gpointer user_data)
214{
215  owl_window *w;
216  for (w = parent->child;
217       w != NULL;
218       w = w->next) {
219    func(w, user_data);
220  }
221}
222
223void owl_window_children_foreach_onearg(owl_window *parent, void (*func)(owl_window*))
224{
225  owl_window *w;
226  for (w = parent->child;
227       w != NULL;
228       w = w->next) {
229    func(w);
230  }
231}
232
233owl_window *owl_window_get_parent(owl_window *w)
234{
235  return w->parent;
236}
237
238/** Internal window management **/
239
240static void _owl_window_create_curses(owl_window *w)
241{
242  if (w->is_screen) {
243    resizeterm(w->nlines, w->ncols);
244    w->win = stdscr;
245  } else if (w->pan) {
246    w->win = newwin(w->nlines, w->ncols, w->begin_y, w->begin_x);
247    replace_panel(w->pan, w->win);
248  } else {
249    if (w->parent == NULL || w->parent->win == NULL)
250      return;
251    w->win = derwin(w->parent->win, w->nlines, w->ncols, w->begin_y, w->begin_x);
252  }
253}
254
255static void _owl_window_destroy_curses(owl_window *w)
256{
257  if (w->is_screen) {
258    /* don't deallocate the dummy */
259    w->win = NULL;
260  } else {
261    if (w->pan) {
262      /* panels assume their windows always exist, so we put in a fake one */
263      replace_panel(w->pan, _dummy_window());
264    }
265    if (w->win) {
266      /* and destroy our own window */
267      delwin(w->win);
268      w->win = NULL;
269    }
270  }
271}
272
273static void _map_recurse_curry(owl_window *w)
274{
275  owl_window_show(w, 1);
276}
277
278void owl_window_show(owl_window *w, int recurse)
279{
280  w->shown = 1;
281  _owl_window_realize(w);
282  if (w->pan)
283    show_panel(w->pan);
284  if (recurse)
285    owl_window_children_foreach_onearg(w, _map_recurse_curry);
286}
287
288void owl_window_hide(owl_window *w)
289{
290  /* you can't unmap the screen */
291  if (w->is_screen)
292    return;
293  w->shown = 0;
294  if (w->pan)
295    hide_panel(w->pan);
296  _owl_window_unrealize(w);
297}
298
299int owl_window_is_shown(owl_window *w)
300{
301  return w->shown;
302}
303
304int owl_window_is_realized(owl_window *w)
305{
306  return w->win != NULL;
307}
308
309int owl_window_is_toplevel(owl_window *w)
310{
311  return w->pan != NULL;
312}
313
314static void _owl_window_realize(owl_window *w)
315{
316  /* check if we can create a window */
317  if ((w->parent && w->parent->win == NULL)
318      || !w->shown
319      || w->win != NULL)
320    return;
321  _owl_window_create_curses(w);
322  if (w->win == NULL)
323    return;
324  /* schedule a repaint */
325  owl_window_dirty(w);
326  /* map the children */
327  owl_window_children_foreach_onearg(w, _owl_window_realize);
328}
329
330static void _owl_window_unrealize(owl_window *w)
331{
332  if (w->win == NULL)
333    return;
334  /* unmap all the children */
335  owl_window_children_foreach_onearg(w, _owl_window_unrealize);
336  _owl_window_destroy_curses(w);
337  /* subwins leave a mess in the parent; dirty it */
338  if (w->parent)
339    owl_window_dirty(w->parent);
340}
341
342/** Painting and book-keeping **/
343
344void owl_window_dirty(owl_window *w)
345{
346  /* don't put the screen on this list; pointless */
347  if (w->is_screen)
348    return;
349  if (!owl_window_is_realized(w))
350    return;
351  if (!w->dirty) {
352    w->dirty = 1;
353    while (w && !w->dirty_subtree) {
354      w->dirty_subtree = 1;
355      w = w->parent;
356    }
357    owl_global_set_needrefresh(&g);
358  }
359}
360
361void owl_window_dirty_children(owl_window *w)
362{
363  owl_window_children_foreach_onearg(w, owl_window_dirty);
364}
365
366static void _owl_window_redraw(owl_window *w)
367{
368  if (!w->dirty) return;
369  if (w->win && w->redraw_cb) {
370    w->redraw_cb(w, w->win, w->redraw_cbdata);
371    wsyncup(w->win);
372  }
373  w->dirty = 0;
374}
375
376static void _owl_window_redraw_subtree(owl_window *w)
377{
378  if (!w->dirty_subtree)
379    return;
380  _owl_window_redraw(w);
381  owl_window_children_foreach_onearg(w, _owl_window_redraw_subtree);
382}
383
384/*
385Redraw all the windows with scheduled redraws.
386NOTE: This function shouldn't be called outside the event loop
387*/
388void owl_window_redraw_scheduled(void)
389{
390  _owl_window_redraw_subtree(owl_window_get_screen());
391}
392
393void owl_window_erase_cb(owl_window *w, WINDOW *win, void *user_data)
394{
395  werase(win);
396  owl_window_dirty_children(w);
397}
398
399/** Window position **/
400
401void owl_window_get_position(owl_window *w, int *nlines, int *ncols, int *begin_y, int *begin_x)
402{
403  if (nlines)  *nlines  = w->nlines;
404  if (ncols)   *ncols   = w->ncols;
405  if (begin_y) *begin_y = w->begin_y;
406  if (begin_x) *begin_x = w->begin_x;
407}
408
409void owl_window_move(owl_window *w, int begin_y, int begin_x)
410{
411  if (w->is_screen) return; /* can't move the screen */
412  if (w->begin_y == begin_y && w->begin_x == begin_x) return;
413
414  w->begin_y = begin_y;
415  w->begin_x = begin_x;
416  if (w->shown) {
417    /* Window is shown, we must try to have a window at the end */
418    if (w->win) {
419      /* We actually do have a window; let's move it */
420      if (w->pan) {
421        if (move_panel(w->pan, begin_y, begin_x) == OK)
422          return;
423      } else {
424        if (mvderwin(w->win, begin_y, begin_x) == OK) {
425          /* now both we and the parent are dirty */
426          owl_window_dirty(w->parent);
427          owl_window_dirty(w);
428          return;
429        }
430      }
431    }
432    /* We don't have a window or failed to move it. Fine. Brute force. */
433    _owl_window_unrealize(w);
434    _owl_window_realize(w);
435  }
436}
437
438void owl_window_set_position(owl_window *w, int nlines, int ncols, int begin_y, int begin_x)
439{
440  /* can't move the screen */
441  if (w->is_screen) {
442    begin_y = begin_x = 0;
443  }
444
445  if (w->nlines == nlines && w->ncols == ncols) {
446    /* moving is easier */
447    owl_window_move(w, begin_y, begin_x);
448    return;
449  }
450
451  w->begin_y = begin_y;
452  w->begin_x = begin_x;
453  w->nlines = nlines;
454  w->ncols = ncols;
455  /* window is shown, we must try to have a window at the end */
456  if (w->shown) {
457    /* resizing in ncurses is hard: give up do a unrealize/realize */
458    _owl_window_unrealize(w);
459  }
460  /* recalculate children sizes BEFORE remapping, so that everything can resize */
461  owl_window_children_foreach_onearg(w, owl_window_recompute_position);
462  if (w->shown) {
463    _owl_window_realize(w);
464  }
465}
466
467void owl_window_resize(owl_window *w, int nlines, int ncols)
468{
469  owl_window_set_position(w, nlines, ncols, w->begin_y, w->begin_x);
470}
471
472void owl_window_recompute_position(owl_window *w)
473{
474  if (w->size_cb) {
475    /* TODO: size_cb probably wants to actually take four int*s */
476    w->size_cb(w, w->size_cbdata);
477  }
478}
479
480
481/** Stacking order **/
482
483void owl_window_top(owl_window *w) {
484  if (!w->pan) {
485    owl_function_debugmsg("Warning: owl_window_top only makes sense on top-level window");
486    return;
487  }
488  top_panel(w->pan);
489}
490
491owl_window *owl_window_above(owl_window *w) {
492  PANEL *pan;
493
494  if (!w->pan) {
495    owl_function_debugmsg("Warning: owl_window_above only makes sense on top-level window");
496    return NULL;
497  }
498  pan = panel_above(w->pan);
499  /* cast because panel_userptr pointlessly returns a const void * */
500  return pan ? (void*) panel_userptr(pan) : NULL;
501}
502
503owl_window *owl_window_below(owl_window *w) {
504  PANEL *pan;
505
506  if (!w->pan) {
507    owl_function_debugmsg("Warning: owl_window_above only makes sense on top-level window");
508    return NULL;
509  }
510  pan = panel_below(w->pan);
511  /* cast because panel_userptr pointlessly returns a const void * */
512  return pan ? (void*) panel_userptr(pan) : NULL;
513}
Note: See TracBrowser for help on using the repository browser.