]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/translator.cc
* scm/define-grob-properties.scm (all-user-grob-properties): add
[lilypond.git] / lily / translator.cc
index 515a85af9bbba3ea26dabcee6468d4fd5d9474f6..6eab93b9a883e75cf004447f83f82722a09e054a 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-
 #include "translator.hh"
-#include "debug.hh"
+
+#include "warn.hh"
 #include "translator-group.hh"
+#include "context-def.hh"
+#include "dispatcher.hh"
+#include "global-context.hh"
 
-#include "moment.hh"
+#include "translator.icc"
+#include "ly-smobs.icc"
 
-char const*
-Translator::name() const
+Translator::~Translator ()
 {
-  return classname(this);
 }
 
-Translator::~Translator ()
+void
+Translator::init ()
 {
+  must_be_last_ = false;
+  self_scm_ = SCM_EOL;
+  daddy_context_ = 0;
+  smobify_self ();
 }
 
-Translator::Translator ()
+void
+Translator::process_music ()
 {
-  status = ORPHAN;
-  daddy_trans_l_ = 0;
-  output_def_l_ = 0;
 }
 
-Translator::Translator (Translator const &s)
-  : Input (s)
+void
+Translator::process_acknowledged ()
 {
-  status = ORPHAN;
-  daddy_trans_l_ =0;
-  output_def_l_ = s.output_def_l_;
-  type_str_ = s.type_str_;
 }
 
-bool
-Translator::is_alias_b (String s) const
+Translator::Translator ()
 {
-  return s == type_str_;
+  init ();
+}
+
+Translator::Translator (Translator const &src)
+{
+  init ();
+  must_be_last_ = src.must_be_last_;
 }
 
 bool
-Translator::do_try_music (Music *)
+Translator::try_music (Music *)
 {
   return false;
 }
-                           
 
 Moment
 Translator::now_mom () const
 {
-  return daddy_trans_l_->now_mom ();
+  return daddy_context_->now_mom ();
 }
 
+Output_def *
+Translator::get_output_def () const
+{
+  return daddy_context_->get_output_def ();
+}
 
-void
-Translator::add_processing ()
+Translator_group *
+Translator::get_daddy_translator () const
 {
-  if (status > ORPHAN)
-    return;
-  
-  do_add_processing ();
-  status = VIRGIN;
+  return daddy_context_->implementation ();
 }
 
 void
-Translator::do_add_processing ()
+Translator::protect_event (SCM ev)
 {
+  get_daddy_translator ()->protect_event (ev);
 }
 
-void
-Translator::print () const
+SCM
+Translator::internal_get_property (SCM sym) const
 {
-#ifndef NPRINT
-  DEBUG_OUT << classname (this) << " {";
-  if (classname (this) != type_str_)
-    DEBUG_OUT << "type = " << type_str_;
-  do_print ();
-  DEBUG_OUT << "}\n";
-#endif
+  return daddy_context_->internal_get_property (sym);
 }
 
 void
-Translator::do_print () const
+Translator::stop_translation_timestep ()
 {
 }
 
+/*
+  this function has 2 properties
 
+  - It is called before try_music ()
 
+  - 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 ()
+{
+}
 
 void
-Translator::creation_processing ()
+Translator::initialize ()
 {
-  if (status >= CREATION_INITED)
-    return ;
-  
-  do_creation_processing ();
-  status = CREATION_INITED;
 }
 
 void
-Translator::post_move_processing ()
+Translator::finalize ()
 {
-  if (status >= MOVE_INITED)
-    return;
+}
 
-  creation_processing ();
-  do_post_move_processing ();
-  status = MOVE_INITED;
+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::removal_processing ()
+Translator::disconnect_from_context (Context *c)
 {
-  if (status == ORPHAN)
-    return;
-  creation_processing ();
-  do_removal_processing ();
-  // elegancy ...
-  // status = ORPHAN;
+  for (translator_listener_record *r = get_listener_list (); r; r=r->next_)
+    c->events_below ()->remove_listener (r->get_listener_ (this), r->event_class_);
 }
 
+/*
+  Internally called once, statically, for each translator
+  listener. Connects the name of an event class with a procedure that
+  fetches the corresponding listener.
 
-bool
-Translator::try_music (Music * r)
-{
-  if (status < MOVE_INITED)
-    post_move_processing ();
+  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. */
+  r->event_class_ = scm_gc_protect_object (scm_str2symbol (name.c_str ()));
+  r->get_listener_ = get_listener;
+  r->next_ = *listener_list;
+  *listener_list = r;
+}
 
-  return do_try_music (r);
+/*
+  SMOBS
+*/
+SCM
+Translator::mark_smob (SCM sm)
+{
+  Translator *me = (Translator *) SCM_CELL_WORD_1 (sm);
+  me->derived_mark ();
+  return SCM_EOL;
 }
 
-void
-Translator::process_requests ()
+Global_context *
+Translator::get_global_context () const
 {
-  if (status < PROCESSED_REQS)
-    post_move_processing ();
-  else if (status >= PROCESSED_REQS)
-    return; 
-  
-  status = PROCESSED_REQS;
-  do_process_requests ();
+  return daddy_context_->get_global_context ();
 }
 
-void
-Translator::pre_move_processing ()
+Context *
+Translator::get_score_context () const
 {
-  do_pre_move_processing ();
-  status = CREATION_INITED;
+  return daddy_context_->get_score_context ();
 }
 
+IMPLEMENT_SMOBS (Translator);
+IMPLEMENT_DEFAULT_EQUAL_P (Translator);
+IMPLEMENT_TYPE_P (Translator, "ly:translator?");
 
+bool
+Translator::must_be_last () const
+{
+  return must_be_last_;
+}
 
-Music_output_def *
-Translator::output_def_l () const
+void
+Translator::derived_mark () const
 {
-  return output_def_l_;
 }
 
-SCM
-Translator::get_property (String id, Translator_group **where_l) const
+int
+Translator::print_smob (SCM s, SCM port, scm_print_state *)
 {
-  return daddy_trans_l_->get_property (ly_symbol2scm (id.ch_C()), where_l);
+  Translator *me = (Translator *) SCM_CELL_WORD_1 (s);
+  scm_puts ("#<Translator ", port);
+  scm_puts (me->class_name (), port);
+  scm_puts (" >", port);
+  return 1;
 }
 
-SCM
-Translator::get_property (SCM sym,
-                         Translator_group **where_l) const
+void
+add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
+                 char const *func_name,
+                 vector<Acknowledge_information> *ack_array)
 {
-  return daddy_trans_l_->get_property (sym, where_l);
+  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);
+}
 
-void
-Translator:: do_pre_move_processing(){}
-void
-Translator::do_post_move_processing(){}
-void
-Translator::do_process_requests () {}
-void
-Translator::do_creation_processing() {}
-void
-Translator::do_removal_processing(){}
+ADD_TRANSLATOR (Translator,
+               "Base class. Unused",
+               "",
+               "",
+               "",
+               "");