]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/score-engraver.cc
* VERSION (MY_PATCH_LEVEL): make 1.7.0
[lilypond.git] / lily / score-engraver.cc
index 733aa5a3c045400fefae61d2ed8387c2191a3b8b..ce13f5ec447eee430d1a684c00f92d29a064aa66 100644 (file)
@@ -3,12 +3,14 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-#include "debug.hh"
-
-#include "line-of-score.hh"
+#include "all-font-metrics.hh"
+#include "afm.hh"
+#include "warn.hh"
+#include "main.hh"
+#include "system.hh"
 #include "item.hh"
 #include "score-engraver.hh"
 #include "paper-score.hh"
 #include "axis-group-interface.hh"
 #include "translator-def.hh"
 
+#include "staff-spacing.hh"
+#include "note-spacing.hh"
 
 /*
   TODO: the column creation logic is rather hairy. Revise it.
  */
 Score_engraver::Score_engraver ()
 {
-  scoreline_l_ =0;
-  command_column_l_ =0;
-  musical_column_l_ =0;
-  breaks_i_ =0;
-  pscore_p_ = 0;
+  system_ =0;
+  command_column_ =0;
+  musical_column_ =0;
+  breaks_ =0;
+  pscore_ = 0;
 }
 
 void
@@ -37,18 +41,20 @@ Score_engraver::make_columns ()
   /*
     ugh.
    */
-  if (!command_column_l_)
-    //      || *unsmob_moment (command_column_l_->get_grob_property ("when")) != w)
+  if (!command_column_)
     {
-      set_columns (new Paper_column (get_property (ly_symbol2scm ("NonMusicalPaperColumn"))),
-                  new Paper_column (get_property (ly_symbol2scm ("PaperColumn"))));
+      set_columns (new Paper_column (get_property ("NonMusicalPaperColumn")),
+                  new Paper_column (get_property ("PaperColumn")));
   
-      command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
+      command_column_->set_grob_property ("breakable", SCM_BOOL_T);
+
 
-      Grob_info i1 (command_column_l_, 0), i2 (musical_column_l_,0);
+      Grob_info i1 (command_column_);
+      i1.origin_trans_ = this;
+  
+      Grob_info i2 (musical_column_);
+      i2.origin_trans_ = this;
 
-      i1.origin_trans_l_ = this;
-      i2.origin_trans_l_ = this;
       announce_grob (i1);
       announce_grob (i2);
     }
@@ -59,15 +65,23 @@ Score_engraver::prepare (Moment w)
 {
   Global_translator::prepare (w);
 
+  /*
+    TODO: don't make columns when skipTypesetting is true.
+   */
   make_columns ();
-  start_translation_timestep ();
+  
+  command_column_->set_grob_property ("when", now_mom_.smobbed_copy ());
+  musical_column_->set_grob_property ("when", now_mom_.smobbed_copy ());
+
+  
+  Translator_group::start_translation_timestep();
 }
 
 void
 Score_engraver::finish ()
 {
-  if ((breaks_i_%8))
-    progress_indication ("[" + to_str (breaks_i_) + "]");
+  if ((breaks_%8))
+    progress_indication ("[" + to_string (breaks_) + "]");
    
   check_removal ();
   removal_processing ();
@@ -80,21 +94,26 @@ Score_engraver::finish ()
 void
 Score_engraver::initialize ()
 {
+  Font_metric *fm = all_fonts_global->find_afm("feta20");
+  if (!fm)
+    error (_f ("can't find `%s'", "feta20.afm")
+          + "\n" +_ ("Fonts have not been installed properly.  Aborting"));
+   
   unsmob_translator_def (definition_)->apply_property_operations (this);
 
-  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_);
+  assert (dynamic_cast<Paper_def *> (output_def_));
+  assert (!daddy_trans_);
+  pscore_ = new Paper_score;
+  pscore_->paper_ = dynamic_cast<Paper_def*> (output_def_);
 
-  SCM props = get_property (ly_symbol2scm ("LineOfScore"));
+  SCM props = get_property ("System");
 
-  pscore_p_->typeset_line (new Line_of_score (props));
+  pscore_->typeset_line (new System (props));
   
   make_columns ();
-  scoreline_l_ = pscore_p_->line_l_;
-  scoreline_l_->set_bound (LEFT, command_column_l_);
-  command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
+  system_ = pscore_->system_;
+  system_->set_bound (LEFT, command_column_);
+  command_column_->set_grob_property ("breakable", SCM_BOOL_T);
 
   Engraver_group_engraver::initialize ();
 }
@@ -106,8 +125,8 @@ Score_engraver::finalize ()
   Engraver_group_engraver::finalize ();
 
   Grob * cc
-    = unsmob_grob (get_property (ly_symbol2scm ("currentCommandColumn")));
-  scoreline_l_->set_bound (RIGHT, cc);
+    = unsmob_grob (get_property ("currentCommandColumn"));
+  system_->set_bound (RIGHT, cc);
   cc->set_grob_property ("breakable", SCM_BOOL_T);
   
   typeset_all ();
@@ -116,93 +135,94 @@ Score_engraver::finalize ()
 void
 Score_engraver::one_time_step ()
 {
-  if (!to_boolean (get_property (ly_symbol2scm("skipTypesetting"))))
+  if (!to_boolean (get_property ("skipTypesetting")))
     {
       process_music ();
-      announces ();
+      do_announces ();
     }
-
   
   stop_translation_timestep ();
+  
+  apply_finalizations ();
   check_removal ();
-}
 
-void
-Score_engraver::announce_grob (Grob_info info)
-{
-  announce_info_arr_.push (info);
-  pscore_p_->line_l_->typeset_grob (info.elem_l_);
+
+  for (int i = announce_infos_.size(); i--;)
+    {
+      Grob *g = announce_infos_[i].grob_;
+      if (!dynamic_cast<Paper_column*> (g)) // ugh.
+       {
+      
+         String msg= "Grob "
+           + g->name()
+           + " was created too late!";
+         g->programming_error (msg);
+       }
+    }
+  announce_infos_.clear ();
 }
 
-/* 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 ()?
- */
-   
 void
-Score_engraver::do_announces ()
+Score_engraver::announce_grob (Grob_info info)
 {
-  //////  do
-    Engraver_group_engraver::do_announces ();
-    //////while (announce_info_arr_.size ());
+  announce_infos_.push (info);
+  pscore_->system_->typeset_grob (info.grob_);
 }
 
-
 void
-Score_engraver::typeset_grob (Grob *elem_p)
+Score_engraver::typeset_grob (Grob *elem)
 {
-  if (!elem_p)
+  if (!elem)
     programming_error ("Score_engraver: empty elt\n");
   else
-
-    elem_p_arr_.push (elem_p);
+    elems_.push (elem);
 }
 
-
 void
 Score_engraver::typeset_all ()
 {
-  for (int i =0; i < elem_p_arr_.size (); i++) 
+  for (int i =0; i < elems_.size (); i++) 
     {
-      Grob * elem_p = elem_p_arr_[i];
+      Grob * elem = elems_[i];
       
-      if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
+      if (Spanner *s = dynamic_cast <Spanner *> (elem))
        {
-           /*
+         /*
            do something sensible if spanner not 
            spanned on 2 items.
-          */
+         */
          Direction d = LEFT;
          do {
            if (!s->get_bound (d))
              {
-               s->set_bound (d, command_column_l_);
+               s->set_bound (d, command_column_);
                /* don't warn for empty/suicided spanners,
                   it makes real warningsinvisible.
                   maybe should be junked earlier? */
-               if (elem_p->immutable_property_alist_ == SCM_EOL)
+               if (!elem->live())
                  ; // gdb hook
                else
-                 ::warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
+                 elem->warning (_f ("unbound spanner `%s'", s->name ().to_str0 ()));
              }
-         } while (flip (&d) != LEFT);
+         }
+         while (flip (&d) != LEFT);
+
+         if (dynamic_cast<Item*> (s->get_parent (Y_AXIS)))
+           programming_error ("Spanner Y-parent is an item.");
        }
       else 
        {
-         if (!elem_p->parent_l (X_AXIS))
+         if (!elem->get_parent (X_AXIS))
            {
-             bool br = to_boolean (elem_p->get_grob_property ("breakable"));
-             Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
+             bool br = to_boolean (elem->get_grob_property ("breakable"));
+             Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
 
            }
        }
-      if (!elem_p->parent_l (Y_AXIS))
-       Axis_group_interface::add_element (scoreline_l_, elem_p);
+      if (!elem->get_parent (Y_AXIS))
+       Axis_group_interface::add_element (system_, elem);
     }
-  elem_p_arr_.clear ();
+  elems_.clear ();
 }
 
 void
@@ -212,42 +232,45 @@ Score_engraver::stop_translation_timestep ()
   Engraver_group_engraver::stop_translation_timestep ();
   
   typeset_all ();
-  if (to_boolean (command_column_l_->get_grob_property ("breakable")))
+  if (to_boolean (command_column_->get_grob_property ("breakable")))
     {
-      breaks_i_ ++;
-      if (! (breaks_i_%8))
-       progress_indication ("[" + to_str (breaks_i_) + "]");
+      breaks_ ++;
+      if (! (breaks_%8))
+       progress_indication ("[" + to_string (breaks_) + "]");
     }
 
-  command_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
-  musical_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
 
-  scoreline_l_->add_column (command_column_l_);
-  scoreline_l_->add_column (musical_column_l_);
+  system_->add_column (command_column_);
+  system_->add_column (musical_column_);
   
-  command_column_l_ = 0;
-  musical_column_l_ = 0;
+  command_column_ = 0;
+  musical_column_ = 0;
 }
 
 void
-Score_engraver::set_columns (Paper_column *new_command_l
-                            Paper_column *new_musical_l)
+Score_engraver::set_columns (Paper_column *new_command, 
+                            Paper_column *new_musical)
 {
-  assert (!command_column_l_ && !musical_column_l_);
-  command_column_l_ = new_command_l;
-  musical_column_l_ = new_musical_l;
+  assert (!command_column_ && !musical_column_);
+
+  command_column_ = new_command;
+  musical_column_ = new_musical;
+  if (new_command)
+    {
+      set_property ("currentCommandColumn", new_command->self_scm ());  
+    }
   
-  if (new_musical_l)
-    set_property ("currentMusicalColumn", new_musical_l->self_scm ());
-  if (new_command_l)
-    set_property ("currentCommandColumn", new_command_l->self_scm ());  
+  if (new_musical)
+    {
+      set_property ("currentMusicalColumn", new_musical->self_scm ());
+    }
 }
 
 Music_output*
-Score_engraver::get_output_p ()
+Score_engraver::get_output ()
 {
-  Music_output * o = pscore_p_;
-  pscore_p_=0;
+  Music_output * o = pscore_;
+  pscore_=0;
   return o;
 }
 
@@ -263,7 +286,7 @@ Score_engraver::try_music (Music*r)
          gotcha = true;
 
 
-         SCM pen = command_column_l_->get_grob_property ("penalty");
+         SCM pen = command_column_->get_grob_property ("penalty");
          Real total_penalty = gh_number_p (pen)
            ? gh_scm2double (pen)
            : 0.0;
@@ -275,7 +298,7 @@ Score_engraver::try_music (Music*r)
          if (total_penalty > 10000.0) //  ugh. arbitrary.
            forbid_breaks ();
 
-         command_column_l_->set_grob_property ("penalty",
+         command_column_->set_grob_property ("penalty",
                                               gh_double2scm (total_penalty));
        }
     }
@@ -285,16 +308,49 @@ Score_engraver::try_music (Music*r)
 /*
   TODO:  use property Score.breakForbidden = #t
  */
-
 void
 Score_engraver::forbid_breaks ()
 {
   /*
     result is junked.
    */
-  command_column_l_->remove_grob_property ("breakable");
+  if (command_column_)
+    command_column_->set_grob_property ("breakable", SCM_EOL);
 }
+  
+void
+Score_engraver::acknowledge_grob (Grob_info gi)
+{
+  if (Staff_spacing::has_interface (gi.grob_))
+    {
+      Pointer_group_interface::add_grob (command_column_,
+                                        ly_symbol2scm ("spacing-wishes"),
+                                        gi.grob_);
+    }
+  if (Note_spacing::has_interface (gi.grob_))
+    {
+      Pointer_group_interface::add_grob (musical_column_,
+                                        ly_symbol2scm ("spacing-wishes"),
+                                        gi.grob_);
+    }
+}
+
+
+
+ENTER_DESCRIPTION(Score_engraver,
+/* descr */       "Top level engraver. Takes care of generating columns and the complete  system (ie. System)
+
 
-ADD_THIS_TRANSLATOR (Score_engraver);
+This engraver decides whether a column is breakable. The default is
+that a column is always breakable. However, when every Bar_engraver
+that does not have a barline at a certain point will call
+Score_engraver::forbid_breaks to stop linebreaks.  In practice, this
+means that you can make a breakpoint by creating a barline (assuming
+that there are no beams or notes that prevent a breakpoint.)
 
 
+",
+/* creats*/       "System PaperColumn NonMusicalPaperColumn",
+/* acks  */       "note-spacing-interface staff-spacing-interface",
+/* reads */       "currentMusicalColumn currentCommandColumn",
+/* write */       "");