]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/translator.cc
Add basic scheme programmable engravers.
[lilypond.git] / lily / translator.cc
index d90c8be045b4b3526ab778e5d54862037171469e..399ecce602e57f3323bc3ebf0cf1072337c5bc41 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  translator.cc -- implement Translator
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "translator.hh"
@@ -25,7 +36,6 @@ Translator::~Translator ()
 void
 Translator::init ()
 {
-  must_be_last_ = false;
   self_scm_ = SCM_EOL;
   daddy_context_ = 0;
   smobify_self ();
@@ -48,8 +58,8 @@ Translator::Translator ()
 
 Translator::Translator (Translator const &src)
 {
+  (void) src;
   init ();
-  must_be_last_ = src.must_be_last_;
 }
 
 Moment
@@ -110,15 +120,17 @@ 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_);
+  for (translator_listener_record *r = get_listener_list (); r; r = r->next_)
+    c->events_below ()->add_listener (r->get_listener_ (this, r->event_class_),
+                                     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_);
+  for (translator_listener_record *r = get_listener_list (); r; r = r->next_)
+    c->events_below ()->remove_listener (r->get_listener_ (this, r->event_class_),
+                                        r->event_class_);
 }
 
 static SCM listened_event_class_table;
@@ -132,7 +144,8 @@ ensure_listened_hash ()
 
 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 a list of all event classes that some translator listens"
+          " to.")
 {
   ensure_listened_hash ();
   return ly_hash_table_keys (listened_event_class_table);
@@ -165,12 +178,12 @@ add_listened_event_class (SCM sym)
 void
 Translator::add_translator_listener (translator_listener_record **listener_list,
                                     translator_listener_record *r,
-                                    Listener (*get_listener) (void *), 
+                                    Listener (*get_listener) (void *, SCM), 
                                     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 = replace_all (&name, '_', '-');
   name += "-event";
   
   SCM class_sym = scm_str2symbol (name.c_str ());
@@ -184,19 +197,38 @@ Translator::add_translator_listener (translator_listener_record **listener_list,
 }
 
 /*
-  Used by ADD_THIS_TRANSLATOR to extract a list of event-class names
-  for each translator.  This list is used by the internals
-  documentation.
+ Helps the individual static_translator_description methods of translators.
 */
 SCM
-Translator::get_listened_class_list (const translator_listener_record *listeners) const
+Translator::static_translator_description (const char *grobs,
+                                          const char *desc,
+                                          translator_listener_record *listener_list,
+                                          const char *read, 
+                                          const char *write) const
 {
+  SCM static_properties = SCM_EOL;                                     
+
+  static_properties = scm_acons (ly_symbol2scm ("grobs-created"),      
+                                parse_symbol_list (grobs), static_properties);
+  
+  static_properties = scm_acons (ly_symbol2scm ("description"),        
+                                scm_from_locale_string (desc), static_properties); 
+  
   SCM list = SCM_EOL;
-  for (; listeners; listeners = listeners->next_)
-    list = scm_cons (listeners->event_class_, list);
-  return list;
+  for (; listener_list; listener_list = listener_list->next_)
+    list = scm_cons (listener_list->event_class_, list);
+  static_properties = scm_acons (ly_symbol2scm ("events-accepted"),
+                                list, static_properties);
+  
+  static_properties = scm_acons (ly_symbol2scm ("properties-read"),    
+                                parse_symbol_list (read), static_properties); 
+  
+  static_properties = scm_acons (ly_symbol2scm ("properties-written"), 
+                                parse_symbol_list (write), static_properties); 
+  
+  return static_properties;                                            
 }
-
+  
 /*
   SMOBS
 */
@@ -227,7 +259,7 @@ IMPLEMENT_TYPE_P (Translator, "ly:translator?");
 bool
 Translator::must_be_last () const
 {
-  return must_be_last_;
+  return false;
 }
 
 void
@@ -255,11 +287,11 @@ add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
 
   string interface_name (func_name);
 
-  interface_name = replace_all (interface_name, '_', '-');
+  interface_name = replace_all (&interface_name, '_', '-');
   interface_name += "-interface";
 
   /*
-    this is only called during program init, so safe to use scm_gc_protect_object()
+    this is only called during program init, so safe to use scm_gc_protect_object ()
   */
   inf.symbol_ = scm_gc_protect_object (ly_symbol2scm (interface_name.c_str ()));
   ack_array->push_back (inf);
@@ -276,6 +308,7 @@ generic_get_acknowledger (SCM sym, vector<Acknowledge_information> const *ack_ar
   return 0;
 }
 
+
 Moment
 get_event_length (Stream_event *e)
 {
@@ -286,6 +319,19 @@ get_event_length (Stream_event *e)
     return Moment (0);
 }
 
+Moment
+get_event_length (Stream_event *e, Moment now)
+{
+  Moment len = get_event_length (e);
+  
+  if (now.grace_part_)
+    {
+      len.grace_part_ = len.main_part_;
+      len.main_part_ = Rational (0);
+    }
+  return len;
+}
+
 /*
   Helper, used through ASSIGN_EVENT_ONCE to throw warnings for
   simultaneous events. The helper is only useful in listen_* methods
@@ -294,18 +340,21 @@ get_event_length (Stream_event *e)
 bool
 internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function)
 {
-  if (*old_ev)
+  if (*old_ev &&
+      !to_boolean (scm_equal_p ((*old_ev)->self_scm (), 
+                              new_ev->self_scm ())))
     {
       /* extract event class from function name */
-      const char *prefix = "listen_";
       string ev_class = function;
+
       /* This assertion fails if EVENT_ASSIGNMENT was called outside a
         translator listener. Don't do that. */
+      const char *prefix = "listen_";
       assert (0 == ev_class.find (prefix));
 
       /* "listen_foo_bar" -> "foo-bar" */
-      ev_class.erase (0, strlen(prefix));
-      replace_all (ev_class, '_', '-');
+      ev_class.erase (0, strlen (prefix));
+      replace_all (&ev_class, '_', '-');
 
       new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class.c_str ()));
       (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class.c_str ()));
@@ -319,8 +368,15 @@ internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const ch
 }
 
 ADD_TRANSLATOR (Translator,
-               "Base class. Unused",
-               "",
+               /* doc */
+               "Base class.  Not instantiated.",
+
+               /* create */
                "",
+
+               /* read */
                "",
-               "");
+
+               /* write */
+               ""
+               );