source: window.c @ d6f2d21

release-1.7release-1.8release-1.9
Last change on this file since d6f2d21 was f041595, checked in by David Benjamin <davidben@mit.edu>, 11 years ago
Don't attempt to create windows with invalid dimensions newwin will interpret height or width of 0 to be something special, so let's filter them out.
  • Property mode set to 100644
File size: 12.2 KB
Line 
1#include "owl.h"
2
3#include <assert.h>
4
5struct _owl_window { /*noproto*/
6  GObject object;
7  /* hierarchy information */
8  owl_window *parent;
9  owl_window *child;
10  owl_window *next, *prev;
11  /* flags */
12  int dirty : 1;
13  int dirty_subtree : 1;
14  int shown : 1;
15  int is_screen : 1;
16  /* window information */
17  WINDOW *win;
18  PANEL *pan;
19  int nlines, ncols;
20  int begin_y, begin_x;
21};
22
23enum {
24  REDRAW,
25  RESIZED,
26  LAST_SIGNAL
27};
28
29static guint window_signals[LAST_SIGNAL] = { 0 };
30
31static void owl_window_dispose(GObject *gobject);
32static void owl_window_finalize(GObject *gobject);
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_link(owl_window *w, owl_window *parent);
37
38static void _owl_window_create_curses(owl_window *w);
39static void _owl_window_destroy_curses(owl_window *w);
40
41static void _owl_window_realize(owl_window *w);
42static void _owl_window_unrealize(owl_window *w);
43
44static owl_window *cursor_owner;
45
46G_DEFINE_TYPE (OwlWindow, owl_window, G_TYPE_OBJECT)
47
48static void owl_window_class_init (OwlWindowClass *klass)
49{
50  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
51
52  /* Set up the vtabl */
53  gobject_class->dispose = owl_window_dispose;
54  gobject_class->finalize = owl_window_finalize;
55
56  klass->redraw = NULL;
57  klass->resized = NULL;
58
59  /* Create the signals, remember IDs */
60  window_signals[REDRAW] =
61    g_signal_new("redraw",
62                 G_TYPE_FROM_CLASS(gobject_class),
63                 G_SIGNAL_RUN_CLEANUP,
64                 G_STRUCT_OFFSET(OwlWindowClass, redraw),
65                 NULL, NULL,
66                 g_cclosure_marshal_VOID__POINTER,
67                 G_TYPE_NONE,
68                 1,
69                 G_TYPE_POINTER, NULL);
70
71  /* TODO: maybe type should be VOID__INT_INT_INT_INT; will need to generate a
72   * marshaller */
73  window_signals[RESIZED] =
74    g_signal_new("resized",
75                 G_TYPE_FROM_CLASS(gobject_class),
76                 G_SIGNAL_RUN_FIRST,
77                 G_STRUCT_OFFSET(OwlWindowClass, resized),
78                 NULL, NULL,
79                 g_cclosure_marshal_VOID__VOID,
80                 G_TYPE_NONE,
81                 0,
82                 NULL);
83}
84
85static void owl_window_dispose (GObject *object)
86{
87  owl_window *w = OWL_WINDOW (object);
88
89  /* Unmap the window */
90  owl_window_hide (w);
91
92  /* Unlink and unref all children */
93  while (w->child) {
94    owl_window *child = w->child;
95    owl_window_unlink (child);
96  }
97
98  /* Remove from hierarchy */
99  owl_window_unlink (w);
100
101  G_OBJECT_CLASS (owl_window_parent_class)->dispose (object);
102}
103
104static void owl_window_finalize (GObject *object)
105{
106  owl_window *w = OWL_WINDOW(object);
107
108  if (w->pan) {
109    del_panel(w->pan);
110    w->pan = NULL;
111  }
112
113  G_OBJECT_CLASS (owl_window_parent_class)->finalize (object);
114}
115
116static void owl_window_init (owl_window *w)
117{
118}
119
120/** singletons **/
121
122static WINDOW *_dummy_window(void)
123{
124  static WINDOW *dummy = NULL;
125  if (!dummy) {
126    dummy = newwin(1, 1, 0, 0);
127  }
128  return dummy;
129}
130
131owl_window *owl_window_get_screen(void)
132{
133  static owl_window *screen = NULL;
134  if (!screen) {
135    /* The screen is magical. It's 'shown', but the only mean of it going
136     * invisible is if we're tore down curses (i.e. screen resize) */
137    screen = _owl_window_new(NULL, g.lines, g.cols, 0, 0);
138    screen->is_screen = 1;
139    owl_window_show(screen);
140  }
141  return screen;
142}
143
144/** Creation and Destruction **/
145
146owl_window *owl_window_new(owl_window *parent)
147{
148  if (!parent)
149    parent = owl_window_get_screen();
150  return _owl_window_new(parent, 0, 0, 0, 0);
151}
152
153static owl_window *_owl_window_new(owl_window *parent, int nlines, int ncols, int begin_y, int begin_x)
154{
155  owl_window *w;
156
157  w = g_object_new (OWL_TYPE_WINDOW, NULL);
158  if (w == NULL) g_error("Failed to create owl_window instance");
159
160  w->nlines = nlines;
161  w->ncols = ncols;
162  w->begin_y = begin_y;
163  w->begin_x = begin_x;
164
165  _owl_window_link(w, parent);
166  if (parent && parent->is_screen) {
167    w->pan = new_panel(_dummy_window());
168    set_panel_userptr(w->pan, w);
169  }
170
171  return w;
172}
173
174/** Hierarchy **/
175
176void owl_window_unlink(owl_window *w)
177{
178  /* make sure the window is unmapped first */
179  _owl_window_unrealize(w);
180  /* unlink parent/child information */
181  if (w->parent) {
182    if (w->prev)
183      w->prev->next = w->next;
184    if (w->next)
185      w->next->prev = w->prev;
186    if (w->parent->child == w)
187      w->parent->child = w->next;
188    w->parent = NULL;
189    g_object_unref (w);
190  }
191}
192
193static void _owl_window_link(owl_window *w, owl_window *parent)
194{
195  if (w->parent == parent)
196    return;
197
198  owl_window_unlink(w);
199  if (parent) {
200    w->parent = parent;
201    w->next = parent->child;
202    parent->child = w;
203    g_object_ref (w);
204  }
205}
206
207/* mimic g_list_foreach for consistency */
208void owl_window_children_foreach(owl_window *parent, GFunc func, gpointer user_data)
209{
210  owl_window *w;
211  for (w = parent->child;
212       w != NULL;
213       w = w->next) {
214    func(w, user_data);
215  }
216}
217
218owl_window *owl_window_get_parent(owl_window *w)
219{
220  return w->parent;
221}
222
223/** Internal window management **/
224
225static void _owl_window_create_curses(owl_window *w)
226{
227  if (w->is_screen) {
228    resizeterm(w->nlines, w->ncols);
229    w->win = stdscr;
230  } else if (w->pan) {
231    w->win = newwin(w->nlines, w->ncols, w->begin_y, w->begin_x);
232    replace_panel(w->pan, w->win);
233  } else {
234    if (w->parent == NULL || w->parent->win == NULL)
235      return;
236    w->win = derwin(w->parent->win, w->nlines, w->ncols, w->begin_y, w->begin_x);
237  }
238}
239
240static void _owl_window_destroy_curses(owl_window *w)
241{
242  if (w->is_screen) {
243    /* don't deallocate the dummy */
244    w->win = NULL;
245  } else {
246    if (w->pan) {
247      /* panels assume their windows always exist, so we put in a fake one */
248      replace_panel(w->pan, _dummy_window());
249    }
250    if (w->win) {
251      /* and destroy our own window */
252      delwin(w->win);
253      w->win = NULL;
254    }
255  }
256}
257
258void owl_window_show(owl_window *w)
259{
260  w->shown = 1;
261  _owl_window_realize(w);
262  if (w->pan)
263    show_panel(w->pan);
264}
265
266void owl_window_show_all(owl_window *w)
267{
268  owl_window_show(w);
269  owl_window_children_foreach(w, (GFunc)owl_window_show, 0);
270}
271
272void owl_window_hide(owl_window *w)
273{
274  /* you can't unmap the screen */
275  if (w->is_screen)
276    return;
277  w->shown = 0;
278  if (w->pan)
279    hide_panel(w->pan);
280  _owl_window_unrealize(w);
281}
282
283int owl_window_is_shown(owl_window *w)
284{
285  return w->shown;
286}
287
288int owl_window_is_realized(owl_window *w)
289{
290  return w->win != NULL;
291}
292
293int owl_window_is_toplevel(owl_window *w)
294{
295  return w->pan != NULL;
296}
297
298static void _owl_window_realize(owl_window *w)
299{
300  /* check if we can create a window */
301  if ((w->parent && w->parent->win == NULL)
302      || !w->shown
303      || w->win != NULL)
304    return;
305  if (w->nlines <= 0 || w->ncols <= 0)
306    return;
307  _owl_window_create_curses(w);
308  if (w->win == NULL)
309    return;
310  /* schedule a repaint */
311  owl_window_dirty(w);
312  /* map the children */
313  owl_window_children_foreach(w, (GFunc)_owl_window_realize, 0);
314}
315
316static void _owl_window_unrealize(owl_window *w)
317{
318  if (w->win == NULL)
319    return;
320  /* unmap all the children */
321  owl_window_children_foreach(w, (GFunc)_owl_window_unrealize, 0);
322  _owl_window_destroy_curses(w);
323  w->dirty = w->dirty_subtree = 0;
324  /* subwins leave a mess in the parent; dirty it */
325  if (w->parent)
326    owl_window_dirty(w->parent);
327}
328
329/** Painting and book-keeping **/
330
331void owl_window_set_cursor(owl_window *w)
332{
333  cursor_owner = w;
334  g_object_add_weak_pointer(G_OBJECT(w), (gpointer*) &cursor_owner);
335  owl_global_set_needrefresh(&g);
336}
337
338void owl_window_dirty(owl_window *w)
339{
340  /* don't put the screen on this list; pointless */
341  if (w->is_screen)
342    return;
343  if (!owl_window_is_realized(w))
344    return;
345  if (!w->dirty) {
346    w->dirty = 1;
347    while (w && !w->dirty_subtree) {
348      w->dirty_subtree = 1;
349      w = w->parent;
350    }
351    owl_global_set_needrefresh(&g);
352  }
353}
354
355void owl_window_dirty_children(owl_window *w)
356{
357  owl_window_children_foreach(w, (GFunc)owl_window_dirty, 0);
358}
359
360static void _owl_window_redraw(owl_window *w)
361{
362  if (!w->dirty) return;
363  if (w->win) {
364    if (!owl_window_is_toplevel(w)) {
365      /* If a subwin, we might have gotten random touched lines from wsyncup or
366       * past drawing. That information is useless, so we discard it all */
367      untouchwin(w->win);
368    }
369    g_signal_emit(w, window_signals[REDRAW], 0, w->win);
370    wsyncup(w->win);
371  }
372  w->dirty = 0;
373}
374
375static void _owl_window_redraw_subtree(owl_window *w)
376{
377  if (!w->dirty_subtree)
378    return;
379  _owl_window_redraw(w);
380  owl_window_children_foreach(w, (GFunc)_owl_window_redraw_subtree, 0);
381}
382
383/*
384Redraw all the windows with scheduled redraws.
385NOTE: This function shouldn't be called outside the event loop
386*/
387void owl_window_redraw_scheduled(void)
388{
389  _owl_window_redraw_subtree(owl_window_get_screen());
390  update_panels();
391  if (cursor_owner && cursor_owner->win) {
392    /* untouch it to avoid drawing; window should be clean now, but we must
393     * clean up in case there was junk left over on a subwin (cleaning up after
394     * subwin drawing isn't sufficient because a wsyncup messes up subwin
395     * ancestors */
396    untouchwin(cursor_owner->win);
397    wnoutrefresh(cursor_owner->win);
398  }
399}
400
401void owl_window_erase_cb(owl_window *w, WINDOW *win, void *user_data)
402{
403  werase(win);
404  owl_window_dirty_children(w);
405}
406
407/** Window position **/
408
409void owl_window_get_position(owl_window *w, int *nlines, int *ncols, int *begin_y, int *begin_x)
410{
411  if (nlines)  *nlines  = w->nlines;
412  if (ncols)   *ncols   = w->ncols;
413  if (begin_y) *begin_y = w->begin_y;
414  if (begin_x) *begin_x = w->begin_x;
415}
416
417void owl_window_move(owl_window *w, int begin_y, int begin_x)
418{
419  owl_window_set_position(w, w->nlines, w->ncols, begin_y, begin_x);
420#if 0
421  /* This routine tries to move a window efficiently, but begy and begx are
422   * then wrong. Currently, this only effects the wnoutrefresh to move cursor.
423   * TODO: fix that and reinstate this code if it's worth the trouble */
424  if (w->is_screen) return; /* can't move the screen */
425  if (w->begin_y == begin_y && w->begin_x == begin_x) return;
426
427  w->begin_y = begin_y;
428  w->begin_x = begin_x;
429  if (w->shown) {
430    /* Window is shown, we must try to have a window at the end */
431    if (w->win) {
432      /* We actually do have a window; let's move it */
433      if (w->pan) {
434        if (move_panel(w->pan, begin_y, begin_x) == OK)
435          return;
436      } else {
437        if (mvderwin(w->win, begin_y, begin_x) == OK) {
438          /* now both we and the parent are dirty */
439          owl_window_dirty(w->parent);
440          owl_window_dirty(w);
441          return;
442        }
443      }
444    }
445    /* We don't have a window or failed to move it. Fine. Brute force. */
446    _owl_window_unrealize(w);
447    _owl_window_realize(w);
448  }
449#endif
450}
451
452void owl_window_set_position(owl_window *w, int nlines, int ncols, int begin_y, int begin_x)
453{
454  /* can't move the screen */
455  if (w->is_screen) {
456    begin_y = begin_x = 0;
457  }
458
459  if (w->nlines == nlines && w->ncols == ncols
460      && w->begin_y == begin_y && w->begin_x == begin_x) {
461    return;
462  }
463
464  _owl_window_unrealize(w);
465  w->begin_y = begin_y;
466  w->begin_x = begin_x;
467  w->nlines = nlines;
468  w->ncols = ncols;
469  g_signal_emit(w, window_signals[RESIZED], 0);
470  if (w->shown) {
471    /* ncurses is screwy: give up and recreate windows at the right place */
472    _owl_window_realize(w);
473  }
474}
475
476void owl_window_resize(owl_window *w, int nlines, int ncols)
477{
478  owl_window_set_position(w, nlines, ncols, w->begin_y, w->begin_x);
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.