lily/dispatcher.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2005--2011 Erik Sandberg  <mandolaerik@gmail.com>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "dispatcher.hh"
  21 #include "input.hh"
  22 #include "international.hh"
  23 #include "ly-smobs.icc"
  24 #include "warn.hh"
  25
  26 IMPLEMENT_SMOBS (Dispatcher);
  27 IMPLEMENT_TYPE_P (Dispatcher, "ly:dispatcher?");
  28 IMPLEMENT_DEFAULT_EQUAL_P (Dispatcher);
  29
  30 Dispatcher::~Dispatcher ()
  31 {
  32 }
  33
  34 Dispatcher::Dispatcher ()
  35 {
  36   self_scm_ = SCM_EOL;
  37   listeners_ = SCM_EOL;
  38   dispatchers_ = SCM_EOL;
  39   listen_classes_ = SCM_EOL;
  40   smobify_self ();
  41 // TODO: use resizable hash (guile 1.8)
  42 //  listeners_ = scm_c_make_hash_table (0);
  43   listeners_ = scm_c_make_hash_table (17);
  44   priority_count_ = 0;
  45 }
  46
  47 SCM
  48 Dispatcher::mark_smob (SCM sm)
  49 {
  50   Dispatcher *me = (Dispatcher *) SCM_CELL_WORD_1 (sm);
  51   scm_gc_mark (me->dispatchers_);
  52   scm_gc_mark (me->listen_classes_);
  53   return me->listeners_;
  54 }
  55
  56 int
  57 Dispatcher::print_smob (SCM s, SCM p, scm_print_state *)
  58 {
  59   Dispatcher *me = (Dispatcher *) SCM_CELL_WORD_1 (s);
  60   scm_puts ("#<Dispatcher ", p);
  61   scm_write (scm_vector_to_list (me->listeners_), p);
  62   scm_puts (">", p);
  63   return 1;
  64 }
  65
  66 /*
  67 Event dispatching:
  68 - Collect a list of listeners for each relevant class
  69 - Send the event to each of these listeners, in increasing priority order.
  70   This is done by keeping a priority queue of listener lists,
  71   and iteratively send the event to the lowest-priority listener.
  72 - An event is never sent twice to listeners with equal priority.
  73 */
  74 IMPLEMENT_LISTENER (Dispatcher, dispatch);
  75 void
  76 Dispatcher::dispatch (SCM sev)
  77 {
  78   Stream_event *ev = unsmob_stream_event (sev);
  79   SCM class_symbol = ev->get_property ("class");
  80   if (!scm_symbol_p (class_symbol))
  81     {
  82       warning (_ ("Event class should be a symbol"));
  83       return;
  84     }
  85
  86   SCM class_list = scm_call_1 (ly_lily_module_constant ("ly:make-event-class"), class_symbol);
  87   if (!scm_is_pair (class_list))
  88     {
  89       ev->origin ()->warning (_f ("Unknown event class %s", ly_symbol2string (class_symbol).c_str ()));
  90       return;
  91     }
  92 #if 0
  93   bool sent = false;
  94 #endif
  95   int num_classes = scm_ilength (class_list);
  96
  97   /*
  98     For each event class there is a list of listeners, which is
  99     ordered by priority. Our next task is to call these listeners, in
 100     priority order.  A priority queue stores the next element in each
 101     listener list, and the lowest priority element is repeatedly
 102     extracted and called.
 103
 104     The priority queue is implemented as a bubble-sorted C
 105     array. Using the stack instead of native Scheme datastructures
 106     avoids overheads for memory allocation. The queue is usually small
 107     (around 2 elements), so the quadratic sorting time is not a
 108     problem. (if this changes, it's easy to rewrite this routine using
 109     a heap)
 110
 111     The first step is to collect all listener lists and to initially
 112     insert them in the priority queue.
 113   */
 114   struct { int prio; SCM list; } lists[num_classes + 1];
 115   int i = 0;
 116   for (SCM cl = class_list; scm_is_pair (cl); cl = scm_cdr (cl))
 117     {
 118       SCM list = scm_hashq_ref (listeners_, scm_car (cl), SCM_EOL);
 119       if (!scm_is_pair (list))
 120         num_classes--;
 121       else
 122         {
 123           // bubblesort.
 124           int prio = scm_to_int (scm_caar (list));
 125           int j;
 126           for (j = i; j > 0 && lists[j - 1].prio > prio; j--)
 127             lists[j] = lists[j - 1];
 128           lists[j].prio = prio;
 129           lists[j].list = list;
 130           i++;
 131         }
 132     }
 133   lists[num_classes].prio = INT_MAX;
 134
 135   // Never send an event to two listeners with equal priority.
 136   int last_priority = -1;
 137   /*
 138     Each iteration extracts the lowest-priority element, which is a
 139     list of listeners. The first listener is called, and the tail of
 140     the list is pushed back into the priority queue.
 141   */
 142   while (num_classes)
 143     {
 144       // Send the event, if we haven't already sent it to this target.
 145       if (lists[0].prio != last_priority)
 146         {
 147           // process the listener
 148           assert (lists[0].prio > last_priority);
 149           last_priority = lists[0].prio;
 150
 151           Listener *l = unsmob_listener (scm_cdar (lists[0].list));
 152           l->listen (ev->self_scm ());
 153 #if 0
 154           sent = true;
 155 #endif
 156         }
 157       // go to the next listener; bubble-sort the class list.
 158       SCM next = scm_cdr (lists[0].list);
 159       if (!scm_is_pair (next))
 160         num_classes--;
 161       int prio = (scm_is_pair (next)) ? scm_to_int (scm_caar (next)) : INT_MAX;
 162       for (i = 0; prio > lists[i + 1].prio; i++)
 163         lists[i] = lists[i + 1];
 164       lists[i].prio = prio;
 165       lists[i].list = next;
 166     }
 167
 168 #if 0
 169   /* TODO: Uncomment. */
 170     if (!sent)
 171       warning (_f ("Junking event: %s", ly_symbol2string (class_symbol).c_str ()));
 172 #endif
 173 }
 174
 175 void
 176 Dispatcher::broadcast (Stream_event *ev)
 177 {
 178   dispatch (ev->self_scm ());
 179 }
 180
 181 void
 182 Dispatcher::add_listener (Listener l, SCM ev_class)
 183 {
 184   internal_add_listener (l, ev_class, ++priority_count_);
 185 }
 186
 187 inline void
 188 Dispatcher::internal_add_listener (Listener l, SCM ev_class, int priority)
 189 {
 190   SCM list = scm_hashq_ref (listeners_, ev_class, SCM_EOL);
 191   if (!scm_is_pair (list))
 192     {
 193       /* Tell all dispatchers that we listen to, that we want to hear ev_class
 194          events */
 195       for (SCM disp = dispatchers_; scm_is_pair (disp); disp = scm_cdr (disp))
 196         {
 197           int priority = scm_to_int (scm_cdar (disp));
 198           Dispatcher *d = unsmob_dispatcher (scm_caar (disp));
 199           d->internal_add_listener (GET_LISTENER (dispatch), ev_class, priority);
 200         }
 201       listen_classes_ = scm_cons (ev_class, listen_classes_);
 202     }
 203   SCM entry = scm_cons (scm_from_int (priority), l.smobbed_copy ());
 204   list = scm_merge (list, scm_list_1 (entry), ly_lily_module_constant ("car<"));
 205   scm_hashq_set_x (listeners_, ev_class, list);
 206 }
 207
 208 void
 209 Dispatcher::remove_listener (Listener l, SCM ev_class)
 210 {
 211   SCM list = scm_hashq_ref (listeners_, ev_class, SCM_EOL);
 212
 213   if (list == SCM_EOL)
 214     {
 215       programming_error ("remove_listener called with incorrect class.");
 216       return;
 217     }
 218
 219   // We just remove the listener once.
 220   bool first = true;
 221
 222   SCM dummy = scm_cons (SCM_EOL, list);
 223   SCM e = dummy;
 224   while (scm_is_pair (scm_cdr (e)))
 225     if (*unsmob_listener (scm_cdadr (e)) == l && first)
 226       {
 227         scm_set_cdr_x (e, scm_cddr (e));
 228         first = false;
 229         break;
 230       }
 231     else
 232       e = scm_cdr (e);
 233   list = scm_cdr (dummy);
 234   scm_hashq_set_x (listeners_, ev_class, list);
 235
 236   if (first)
 237     warning ("Attempting to remove nonexisting listener.");
 238   else if (!scm_is_pair (list))
 239     {
 240       /* Unregister with all dispatchers. */
 241       for (SCM disp = dispatchers_; scm_is_pair (disp); disp = scm_cdr (disp))
 242         {
 243           Dispatcher *d = unsmob_dispatcher (scm_caar (disp));
 244           d->remove_listener (GET_LISTENER (dispatch), ev_class);
 245         }
 246       listen_classes_ = scm_delq_x (ev_class, listen_classes_);
 247     }
 248 }
 249
 250 /* Register as a listener to another dispatcher. */
 251 void
 252 Dispatcher::register_as_listener (Dispatcher *disp)
 253 {
 254   int priority = ++disp->priority_count_;
 255
 256   // Don't register twice to the same dispatcher.
 257   if (scm_assq (disp->self_scm (), dispatchers_) != SCM_BOOL_F)
 258     {
 259       warning ("Already listening to dispatcher, ignoring request");
 260       return;
 261     }
 262
 263   dispatchers_ = scm_acons (disp->self_scm (), scm_from_int (priority), dispatchers_);
 264
 265   Listener list = GET_LISTENER (dispatch);
 266   for (SCM cl = listen_classes_; scm_is_pair (cl); cl = scm_cdr (cl))
 267     {
 268       disp->internal_add_listener (list, scm_car (cl), priority);
 269     }
 270 }
 271
 272 /* Unregister as a listener to another dispatcher. */
 273 void
 274 Dispatcher::unregister_as_listener (Dispatcher *disp)
 275 {
 276   dispatchers_ = scm_assq_remove_x (dispatchers_, disp->self_scm ());
 277
 278   Listener listener = GET_LISTENER (dispatch);
 279   for (SCM cl = listen_classes_; scm_is_pair (cl); cl = scm_cdr (cl))
 280     {
 281       disp->remove_listener (listener, scm_car (cl));
 282     }
 283 }