lily/dispatcher-scheme.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2006--2015 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
  22 LY_DEFINE (ly_make_dispatcher, "ly:make-dispatcher",
  23            0, 0, 0, (),
  24            "Return a newly created dispatcher.")
  25 {
  26   return (new Dispatcher ())->unprotect ();
  27 }
  28
  29 LY_DEFINE (ly_connect_dispatchers, "ly:connect-dispatchers",
  30            2, 0, 0, (SCM to, SCM from),
  31            "Make the dispatcher @var{to} listen to events from @var{from}.")
  32 {
  33   Dispatcher *t = Dispatcher::unsmob (to);
  34   Dispatcher *f = Dispatcher::unsmob (from);
  35
  36   LY_ASSERT_SMOB (Dispatcher, to, 1);
  37   LY_ASSERT_SMOB (Dispatcher, from, 2);
  38
  39   t->register_as_listener (f);
  40
  41   return SCM_UNSPECIFIED;
  42 }
  43
  44 LY_DEFINE (ly_add_listener, "ly:add-listener",
  45            2, 0, 1, (SCM callback, SCM disp, SCM cl),
  46            "Add the single-argument procedure @var{callback} as listener"
  47            " to the dispatcher @var{disp}.  Whenever @var{disp} hears"
  48            " an event of class @var{cl}, it calls @var{callback} with it.")
  49 {
  50   Dispatcher *d = Dispatcher::unsmob (disp);
  51
  52   LY_ASSERT_TYPE (ly_is_procedure, callback, 1);
  53   LY_ASSERT_SMOB (Dispatcher, disp, 2);
  54
  55   for (int arg = SCM_ARG3; scm_is_pair (cl); cl = scm_cdr (cl), arg++)
  56     {
  57       SCM sym = scm_car (cl);
  58       SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, arg, __FUNCTION__, "symbol");
  59       d->add_listener (callback, sym);
  60     }
  61
  62   return SCM_UNSPECIFIED;
  63 }
  64
  65 LY_DEFINE (ly_listened_event_types, "ly:listened-event-types",
  66            1, 0, 0, (SCM disp),
  67            "Return a list of all event types that @var{disp} listens"
  68            " to.")
  69 {
  70   LY_ASSERT_SMOB (Dispatcher, disp, 1);
  71
  72   SCM result = Dispatcher::unsmob (disp)->listened_types ();
  73
  74   scm_remember_upto_here_1 (disp);
  75
  76   return result;
  77 }
  78
  79 LY_DEFINE (ly_listened_event_class_p, "ly:listened-event-class?",
  80            2, 0, 0, (SCM disp, SCM cl),
  81            "Does @var{disp} listen to any event type in the list"
  82            " @var{cl}?")
  83 {
  84   LY_ASSERT_SMOB (Dispatcher, disp, 1);
  85   LY_ASSERT_TYPE (scm_is_pair, cl, 2);
  86
  87   bool result = Dispatcher::unsmob (disp)->is_listened_class (cl);
  88
  89   scm_remember_upto_here_1 (disp);
  90
  91   return scm_from_bool (result);
  92 }
  93
  94 LY_DEFINE (ly_broadcast, "ly:broadcast",
  95            2, 0, 0, (SCM disp, SCM ev),
  96            "Send the stream event @var{ev} to the dispatcher @var{disp}.")
  97 {
  98   Dispatcher *d = Dispatcher::unsmob (disp);
  99   Stream_event *e = Stream_event::unsmob (ev);
 100
 101   LY_ASSERT_SMOB (Dispatcher, disp, 1);
 102
 103   LY_ASSERT_SMOB (Stream_event, ev, 2);
 104   d->broadcast (e);
 105   return SCM_UNSPECIFIED;
 106 }