source: window.c @ 1aa4cc4

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