]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/translator.cc
* lily/bar-line.cc: Add documentation for "||:" also in the
[lilypond.git] / lily / translator.cc
index d6a4a79ca2a7bfbbcd635275c5e649f9c262555a..cf07d527e8e956be25dd589bfa701fb2b5289b7c 100644 (file)
@@ -3,16 +3,19 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "translator.hh"
 
-#include "warn.hh"
-#include "translator-group.hh"
 #include "context-def.hh"
+#include "dispatcher.hh"
 #include "global-context.hh"
+#include "international.hh"
+#include "translator-group.hh"
+#include "warn.hh"
 
+#include "translator.icc"
 #include "ly-smobs.icc"
 
 Translator::~Translator ()
@@ -24,19 +27,18 @@ Translator::init ()
 {
   must_be_last_ = false;
   self_scm_ = SCM_EOL;
-  daddy_context_ =0;
+  daddy_context_ = 0;
   smobify_self ();
 }
 
 void
-Translator::do_announces ()
+Translator::process_music ()
 {
 }
 
 void
-Translator::process_music ()
+Translator::process_acknowledged ()
 {
-  
 }
 
 Translator::Translator ()
@@ -55,7 +57,6 @@ Translator::try_music (Music *)
 {
   return false;
 }
-                           
 
 Moment
 Translator::now_mom () const
@@ -69,13 +70,17 @@ Translator::get_output_def () const
   return daddy_context_->get_output_def ();
 }
 
-
-Translator_group*
+Translator_group *
 Translator::get_daddy_translator () const
 {
   return daddy_context_->implementation ();
 }
 
+void
+Translator::protect_event (SCM ev)
+{
+  get_daddy_translator ()->protect_event (ev);
+}
 
 SCM
 Translator::internal_get_property (SCM sym) const
@@ -95,8 +100,7 @@ Translator::stop_translation_timestep ()
 
   - It is called before any user information enters the translators.
   (i.e. any \property or event is not processed yet.)
-
-  */
+*/
 void
 Translator::start_translation_timestep ()
 {
@@ -112,51 +116,83 @@ Translator::finalize ()
 {
 }
 
+void
+Translator::connect_to_context (Context *c)
+{
+  for (translator_listener_record *r = get_listener_list (); r; r=r->next_)
+    c->events_below ()->add_listener (r->get_listener_ (this), r->event_class_);
+}
+
+void
+Translator::disconnect_from_context (Context *c)
+{
+  for (translator_listener_record *r = get_listener_list (); r; r=r->next_)
+    c->events_below ()->remove_listener (r->get_listener_ (this), r->event_class_);
+}
+
+static SCM listened_event_classes = SCM_EOL;
+
+LY_DEFINE (ly_get_listened_event_classes, "ly:get-listened-event-classes",
+          0, 0, 0, (),
+          "Returns a list of all event classes that some translator listens to.")
+{
+  return listened_event_classes;
+}
 
 /*
+  Internally called once, statically, for each translator
+  listener. Connects the name of an event class with a procedure that
+  fetches the corresponding listener.
 
-  SMOBS
+  The method should only be called from the macro
+  IMPLEMENT_TRANSLATOR_LISTENER.
+ */
+void
+Translator::add_translator_listener (translator_listener_record **listener_list,
+                        translator_listener_record *r,
+                        Listener (*get_listener) (void *), 
+                        const char *ev_class)
+{
+  /* ev_class is the C++ identifier name. Convert to scm symbol */
+  string name = string (ev_class);
+  name = replace_all (name, '_', '-');
+  name = name + "-event";
+  /* It's OK to use scm_gc_protect_object for protection, because r is
+     statically allocated. */
+  SCM class_sym = scm_gc_protect_object (scm_str2symbol (name.c_str ()));
+  listened_event_classes = scm_gc_protect_object (scm_cons (class_sym, listened_event_classes));
+  r->event_class_ = class_sym;
+  r->get_listener_ = get_listener;
+  r->next_ = *listener_list;
+  *listener_list = r;
+}
 
+/*
+  SMOBS
 */
 SCM
 Translator::mark_smob (SCM sm)
 {
-  Translator * me = (Translator*) SCM_CELL_WORD_1 (sm);
+  Translator *me = (Translator *) SCM_CELL_WORD_1 (sm);
   me->derived_mark ();
   return SCM_EOL;
 }
 
-SCM
-Translator::translator_description () const
-{
-  return SCM_EOL;
-}
-
-
 Global_context *
 Translator::get_global_context () const
 {
-  return daddy_context_ ->get_global_context ();
+  return daddy_context_->get_global_context ();
 }
 
-
-Score_context *
+Context *
 Translator::get_score_context () const
 {
   return daddy_context_->get_score_context ();
-}  
-
-
-SCM
-Translator::static_translator_description ()const
-{
-  return SCM_EOL;
 }
 
-
 IMPLEMENT_SMOBS (Translator);
 IMPLEMENT_DEFAULT_EQUAL_P (Translator);
-IMPLEMENT_TYPE_P (Translator,"ly:translator?");
+IMPLEMENT_TYPE_P (Translator, "ly:translator?");
 
 bool
 Translator::must_be_last () const
@@ -167,5 +203,90 @@ Translator::must_be_last () const
 void
 Translator::derived_mark () const
 {
-  
 }
+
+int
+Translator::print_smob (SCM s, SCM port, scm_print_state *)
+{
+  Translator *me = (Translator *) SCM_CELL_WORD_1 (s);
+  scm_puts ("#<Translator ", port);
+  scm_puts (me->class_name (), port);
+  scm_puts (" >", port);
+  return 1;
+}
+
+void
+add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
+                 char const *func_name,
+                 vector<Acknowledge_information> *ack_array)
+{
+  Acknowledge_information inf;
+  inf.function_ = ptr;
+
+  string interface_name (func_name);
+
+  interface_name = replace_all (interface_name, '_', '-');
+  interface_name += "-interface";
+
+  inf.symbol_ = scm_gc_protect_object (ly_symbol2scm (interface_name.c_str ()));
+  ack_array->push_back (inf);
+}
+
+Engraver_void_function_engraver_grob_info
+generic_get_acknowledger (SCM sym, vector<Acknowledge_information> const *ack_array)
+{
+  for (vsize i = 0; i < ack_array->size (); i++)
+    {
+      if (ack_array->at (i).symbol_ == sym)
+       return ack_array->at (i).function_;
+    }
+  return 0;
+}
+
+Moment
+get_event_length (Stream_event *e)
+{
+  Moment *m = unsmob_moment (e->get_property ("length"));
+  if (m)
+    return *m;
+  else
+    return Moment (0);
+}
+
+/*
+  Helper, used through ASSIGN_EVENT_ONCE to throw warnings for
+  simultaneous events. The helper is only useful in listen_* methods
+  of translators.
+*/
+bool
+internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function)
+{
+  if (*old_ev)
+    {
+      /* extract event class from function name */
+      const char *prefix = "listen_";
+      assert (!strncmp (function, "listen_", strlen (prefix)));
+      function += strlen (prefix);
+      char ev_class[strlen (function) + 1];
+      strcpy (ev_class, function);
+      for (char *c = ev_class; *c; c++)
+       if (*c == '_')
+         *c = '-';
+
+      new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class));
+      (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class));
+      return false;
+    }
+  else
+    {
+      *old_ev = new_ev;
+      return true;
+    }
+}
+
+ADD_TRANSLATOR (Translator,
+               "Base class. Unused",
+               "",
+               "",
+               "",
+               "");