]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/score-engraver.cc
Fix 726.
[lilypond.git] / lily / score-engraver.cc
index 3b5f9465498eee6db295b4ce05e275a911263631..eff35efed4173fb2666a69a383970d569f5b495a 100644 (file)
 /*
-  score-grav.cc -- implement Score_engraver
+  score-engraver.cc -- implement Score_engraver
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
-#include "debug.hh"
-#include "dimension-cache.hh"
-#include "line-of-score.hh"
-#include "item.hh"
+
 #include "score-engraver.hh"
-#include "paper-score.hh"
-#include "musical-request.hh"
+
+#include "all-font-metrics.hh"
+#include "axis-group-interface.hh"
+#include "context-def.hh"
+#include "dispatcher.hh"
+#include "global-context.hh"
+#include "international.hh"
+#include "main.hh"
+#include "open-type-font.hh"
+#include "output-def.hh"
+#include "paper-column-engraver.hh"
 #include "paper-column.hh"
-#include "command-request.hh"
-#include "paper-def.hh"
+#include "paper-score.hh"
+#include "system.hh"
+#include "warn.hh"
 
-Score_engraver::Score_engraver()
+Score_engraver::Score_engraver ()
 {
-  scoreline_l_ =0;
-  command_column_l_ =0;
-  musical_column_l_ =0;
-  breaks_i_ =0;
-  pscore_p_ = 0;
+  system_ = 0;
+  pscore_ = 0;
 }
+
 void
-Score_engraver::prepare (Moment w)
+Score_engraver::derived_mark () const
 {
-  Global_translator::prepare (w);
-  set_columns (new Paper_column (w),  new Paper_column (w));
-
-  command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
-  post_move_processing();
+  if (pscore_)
+    scm_gc_mark (pscore_->self_scm ());
+  Engraver_group::derived_mark ();
 }
 
+IMPLEMENT_LISTENER (Score_engraver, prepare);
 void
-Score_engraver::finish()
+Score_engraver::prepare (SCM)
 {
-  if ((breaks_i_%8))
-    progress_indication ("[" + to_str ( breaks_i_) + "]");
-   
-  check_removal();
-  removal_processing();
+  precomputed_recurse_over_translators (context (), START_TRANSLATION_TIMESTEP, DOWN);
 }
 
-/*
-  use start/finish?
- */
+IMPLEMENT_LISTENER (Score_engraver, finish);
 void
-Score_engraver::do_creation_processing ()
+Score_engraver::finish (SCM)
 {
-  scoreline_l_ = pscore_p_->line_l_;
-
-  scoreline_l_->set_bounds(LEFT, command_column_l_);
-  
-  command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
-
-  Engraver_group_engraver::do_creation_processing();
+  recurse_over_translators (context (), &Translator::finalize,
+                           &Translator_group::finalize,
+                           UP);
 }
 
+#define MUSIC_FONT "emmentaler-20"
 
+/*
+  use start/finish?
+*/
 void
-Score_engraver::do_removal_processing()
+Score_engraver::initialize ()
 {
-  Engraver_group_engraver::do_removal_processing();
-  scoreline_l_->set_bounds(RIGHT,command_column_l_);
-  command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
+  Font_metric *fm = all_fonts_global->find_otf (MUSIC_FONT);
+  if (!fm)
+    {
+      error (_f ("cannot find `%s'", MUSIC_FONT ".otf")
+            + "\n"
+            + _ ("Music font has not been installed properly.")
+            + "\n"
+            + _f ("Search path `%s'", global_path.to_string ().c_str ())
+            + "\n"
+            + _ ("Aborting"));
+    }
 
-  typeset_all ();
-  set_columns (0,0);
-}
+  pscore_ = new Paper_score (dynamic_cast<Output_def *> (context ()->get_output_def ()));
+  pscore_->unprotect ();
+  context ()->set_property ("output", pscore_->self_scm ());
 
-void
-Score_engraver::process()
-{
-  process_requests();
-  do_announces();
-  pre_move_processing();
-  check_removal();
+  SCM props = updated_grob_properties (context (), ly_symbol2scm ("System"));
+
+  pscore_->typeset_system (new System (props));
+  
+  system_ = pscore_->root_system ();
+  context ()->set_property ("rootSystem", system_->self_scm ());
+
+  Engraver_group::initialize ();
 }
 
 void
-Score_engraver::announce_element (Score_element_info info)
+Score_engraver::connect_to_context (Context *c)
 {
-  announce_info_arr_.push (info);
-  info.origin_trans_l_arr_.push (this);
-  pscore_p_->typeset_element (info.elem_l_);
+  Engraver_group::connect_to_context (c);
+  
+  Dispatcher *d = c->get_global_context ()->event_source ();
+  d->add_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
+  d->add_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
+  d->add_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
 }
 
-/* All elements are propagated to the top upon announcement. If
-   something was created during one run of
-   Engraver_group_engraver::do_announces, then
-   announce_info_arr_.size() will be nonzero again
-*/
-/* junkme? Done by Engraver_group_engraver::do_announces ()?
+/*
+  uncovered:
+  
+  check_removal always returns false for Score contexts, it has been that way 
+since I joined the project. There is a reason for this: The typeset score is 
+stored in the Score_engraver, which in turn is accessed through the 
+Global_context returned by ly:run-translator. So the score-translator must be 
+connected to the score-context after run-translator finishes.
+
+I plan to change this: we should junk run-translator, and instead keep track 
+of both context and translator in the SCM code, and access the typeset score 
+directly via the created global-translator. Then it would be possible to 
+disconnect score-translators at iteration time. -es
  */
-   
 void
-Score_engraver::do_announces()
+Score_engraver::disconnect_from_context ()
 {
-  while (announce_info_arr_.size()) 
-    Engraver_group_engraver::do_announces();
-}
-
+  Dispatcher *d = context ()->get_global_context ()->event_source ();
+  d->remove_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
+  d->remove_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
+  d->remove_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
 
-void
-Score_engraver::typeset_element (Score_element *elem_p)
-{
-  elem_p_arr_.push (elem_p);
+  Engraver_group::disconnect_from_context ();
 }
 
-
 void
-Score_engraver::typeset_all()
+Score_engraver::finalize ()
 {
-  for  (int i =0; i < elem_p_arr_.size(); i++) 
-    {
-      Score_element * elem_p = elem_p_arr_[i];
-      elem_p->add_processing ();
+  Engraver_group::finalize ();
 
-      
-      if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
-       {
-           /*
-           do something sensible if spanner not 
-           spanned on 2 items.
-          */
-         Direction d = LEFT;
-         do {
-           if (!s->spanned_drul_[d])
-             {
-               s->set_bounds(d, command_column_l_);
-               ::warning (_f ("unbound spanner `%s'", classname(s)));
-             }
-         } while (flip(&d) != LEFT);
-       }
-      else 
-       {
-         Item *item_p = dynamic_cast <Item *> (elem_p);
-
-         if (!item_p->parent_l (X_AXIS))
-           {
-             bool br = to_boolean (item_p->remove_elt_property ("breakable"));
-             if (br)
-               command_column_l_->add_element(item_p);
-             else
-               musical_column_l_->add_element(item_p);
-           }
-       }
-      if (!elem_p->parent_l(Y_AXIS))
-       scoreline_l_->add_element (elem_p);
-    }
-  elem_p_arr_.clear();
+  typeset_all ();
 }
 
+IMPLEMENT_LISTENER (Score_engraver, one_time_step);
 void
-Score_engraver::do_pre_move_processing()
+Score_engraver::one_time_step (SCM)
 {
-  if (to_boolean (command_column_l_->get_elt_property ("breakable")))
+  if (!to_boolean (context ()->get_property ("skipTypesetting")))
     {
-      breaks_i_ ++;
-      if (! (breaks_i_%8))
-       progress_indication ("[" + to_str ( breaks_i_) + "]");
+      precomputed_recurse_over_translators (context (), PROCESS_MUSIC, UP);
+      Engraver_group::do_announces ();
     }
-  // this generates all items.
-  Engraver_group_engraver::do_pre_move_processing();
-  
-  typeset_all();
+
+  precomputed_recurse_over_translators (context (), STOP_TRANSLATION_TIMESTEP, UP);
+  typeset_all ();
 }
 
 void
-Score_engraver::set_columns (Paper_column *new_command_l, 
-                            Paper_column *new_musical_l)
+Score_engraver::announce_grob (Grob_info info)
 {
-  if (command_column_l_ && command_column_l_->linked_b()) 
-    {
-      pscore_p_->add_column (command_column_l_);
-      scoreline_l_->add_column (command_column_l_);
-    }
-  else 
-    command_column_l_ =0;
-
-  if (new_command_l) 
-    command_column_l_ = new_command_l;
-
-  if (musical_column_l_ && musical_column_l_->linked_b()) 
-    {
-      pscore_p_->add_column (musical_column_l_);
-      scoreline_l_->add_column (musical_column_l_);      
-    }
-  else 
-    musical_column_l_ = 0;
-  
-  if (new_musical_l) 
+  Engraver_group::announce_grob (info);
+  if (info.start_end () == START)
     {
-      musical_column_l_ = new_musical_l;
+      pscore_->root_system ()->typeset_grob (info.grob ());
+      elems_.push_back (info.grob ());
     }
 }
 
-Staff_info
-Score_engraver::get_staff_info() const
-{
-  Staff_info inf = Engraver_group_engraver::get_staff_info();
-
-  inf.command_l_ = command_column_l_;
-  inf.musical_l_ = musical_column_l_;
-  
-  return inf;
-}
-
-Music_output*
-Score_engraver::get_output_p ()
-{
-  Music_output * o = pscore_p_;
-  pscore_p_=0;
-  return o;
-}
-
-bool
-Score_engraver::do_try_music (Music*r)
+void
+Score_engraver::typeset_all ()
 {
-  bool gotcha = Engraver_group_engraver::do_try_music (r);  
-
-  if (!gotcha)
+  for (vsize i = 0; i < elems_.size (); i++)
     {
-      if (Break_req* b = dynamic_cast<Break_req *> (r))
-       {
-         gotcha = true;
-
-
-         SCM pen = command_column_l_->get_elt_property  ("penalty");
-         Real total_penalty = gh_number_p (pen)
-           ? gh_scm2double(pen)
-           : 0.0;
+      Grob *elem = elems_[i];
 
-         total_penalty += b->penalty_f_;
-         if (b->penalty_f_ > 10000.0) //  ugh. arbitrary.
-           forbid_breaks ();
-
-         command_column_l_->set_elt_property ("penalty",
-                                              gh_double2scm (total_penalty));
-       }
+      if (!elem->get_parent (Y_AXIS))
+       Axis_group_interface::add_element (system_, elem);
     }
-   return gotcha;
-}
-
-void
-Score_engraver::forbid_breaks ()
-{
-  /*
-    result is junked.
-   */
-  command_column_l_->remove_elt_property ("breakable");
-}
-
-ADD_THIS_TRANSLATOR(Score_engraver);
-
-void
-Score_engraver::do_add_processing ()
-{
-  Translator_group::do_add_processing ();
-  assert (dynamic_cast<Paper_def *> (output_def_l_));
-  assert (!daddy_trans_l_);
-  pscore_p_ = new Paper_score;
-  pscore_p_->paper_l_ = dynamic_cast<Paper_def*>(output_def_l_);
-}
-
+  elems_.clear ();
+}
+
+ADD_TRANSLATOR_GROUP (Score_engraver,
+                     /* doc */
+                     "The top-level engraver.  Takes care of generating"
+                     " columns and the complete system (i.e.,"
+                     " @code{System}).\n"
+                     "\n"
+                     "This engraver decides whether a column is breakable."
+                     "  The default is that a column is always breakable."
+                     "  However, every @code{Bar_engraver} that does not have"
+                     " a bar line at a certain point sets @code{forbidBreaks}"
+                     " to stop line breaks.  In practice, this means that you"
+                     " can make a break point by creating a bar line"
+                     " (assuming that there are no beams or notes that"
+                     " prevent a break point).",
+
+                     /* create */
+                     "System ",
+                     
+                     /* read */
+                     "currentMusicalColumn "
+                     "currentCommandColumn "
+                     "verticallySpacedContexts ",
+
+                     /* write */
+                     ""
+                     );