]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/dynamic-engraver.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / dynamic-engraver.cc
index 0e6573db9238ebba53da18fc1f686591efd2d3fe..ab242f653c0c760d1247bcd8eb30739a988fc8a9 100644 (file)
@@ -3,22 +3,27 @@
 
   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 "warn.hh"
+
+#include "axis-group-interface.hh"
+#include "context.hh"
 #include "dimensions.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
 #include "hairpin.hh"
-#include "event.hh"
-#include "paper-column.hh"
+#include "international.hh"
+#include "interval.hh"
 #include "note-column.hh"
-#include "item.hh"
+#include "paper-column.hh"
+#include "pointer-group-interface.hh"
+#include "script-interface.hh"
+#include "self-alignment-interface.hh"
 #include "side-position-interface.hh"
-#include "engraver.hh"
-#include "group-interface.hh"
-#include "directional-element-interface.hh"
-#include "context.hh"
-#include "axis-group-interface.hh"
-#include "script.hh"
+#include "staff-symbol-referencer.hh"
+#include "warn.hh"
+
+#include "translator.icc"
 
 /*
   TODO:
   line-spanner
 
   - TODO: this engraver is too complicated. We should split it into
-  the handling of the basic grobs and the  linespanner
+  the handling of the basic grobs and the linespanner
 
   - TODO: the line-spanner is not killed after the (de)crescs are
   finished.
-
 */
 
 /**
    print text & hairpin dynamics.
- */
+*/
 class Dynamic_engraver : public Engraver
 {
-  Item * script_;
-  Spanner * finished_cresc_;
-  Spanner * cresc_;
+  Item *script_;
+  Spanner *line_spanner_;
+  Spanner *cresc_;
+
+  Spanner *finished_line_spanner_;
+  Spanner *finished_cresc_;
+
+  Music *script_ev_;
+  Music *current_cresc_ev_;
 
-  Music* script_ev_;
-  
-  Music * current_cresc_ev_;
-  Drul_array<Music*> accepted_spanreqs_drul_;
+  Drul_array<Music *> accepted_spanevents_drul_;
 
-  Spanner* line_spanner_;
-  Spanner* finished_line_spanner_;
+  vector<Note_column*> pending_columns_;
+  vector<Grob*> pending_elements_;
 
-  Link_array<Note_column> pending_columns_;
-  Link_array<Grob> pending_elements_;
-  
   void typeset_all ();
 
   TRANSLATOR_DECLARATIONS (Dynamic_engraver);
-  
+  DECLARE_ACKNOWLEDGER (accidental);
+  DECLARE_ACKNOWLEDGER (script);
+  DECLARE_ACKNOWLEDGER (stem_tremolo);
+  DECLARE_ACKNOWLEDGER (note_column);
+  DECLARE_ACKNOWLEDGER (slur);
+
 protected:
   virtual void finalize ();
-  virtual void acknowledge_grob (Grob_info);
-  virtual bool try_music (Music *req);
-  virtual void stop_translation_timestep ();
-  virtual void process_music ();  
+  virtual bool try_music (Music *event);
+  void stop_translation_timestep ();
+  void process_music ();
 };
 
-
-
-
 Dynamic_engraver::Dynamic_engraver ()
 {
   script_ = 0;
@@ -76,15 +81,15 @@ Dynamic_engraver::Dynamic_engraver ()
   line_spanner_ = 0;
   finished_line_spanner_ = 0;
   current_cresc_ev_ = 0;
-  cresc_ =0;
+  cresc_ = 0;
 
   script_ev_ = 0;
-  accepted_spanreqs_drul_[START] = 0;
-  accepted_spanreqs_drul_[STOP] = 0;
+  accepted_spanevents_drul_[START] = 0;
+  accepted_spanevents_drul_[STOP] = 0;
 }
 
 bool
-Dynamic_engraver::try_music (Music * m)
+Dynamic_engraver::try_music (Music *m)
 {
   if (m->is_mus_type ("absolute-dynamic-event"))
     {
@@ -99,9 +104,9 @@ Dynamic_engraver::try_music (Music * m)
     {
       Direction d = to_dir (m->get_property ("span-direction"));
 
-      accepted_spanreqs_drul_[d] = m;
+      accepted_spanevents_drul_[d] = m;
       if (current_cresc_ev_ && d == START)
-       accepted_spanreqs_drul_[STOP] = m;
+       accepted_spanevents_drul_[STOP] = m;
       return true;
     }
   return false;
@@ -110,19 +115,17 @@ Dynamic_engraver::try_music (Music * m)
 void
 Dynamic_engraver::process_music ()
 {
-  if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
+  if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
     {
       if (!line_spanner_)
        {
-         line_spanner_ = make_spanner ("DynamicLineSpanner");
-
-         Music * rq = accepted_spanreqs_drul_[START];
+         Music *rq = accepted_spanevents_drul_[START];
+         line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
          if (script_ev_)
-           rq =  script_ev_ ;
-         announce_grob (line_spanner_, rq ? rq->self_scm (): SCM_EOL);
+           rq = script_ev_;
        }
     }
-  
+
   /*
     During a (de)crescendo, pending event will not be cleared,
     and a line-spanner will always be created, as \< \! are already
@@ -132,74 +135,69 @@ Dynamic_engraver::process_music ()
     as (de)crecsendo, b.o. line-breaking.
   */
 
-  
-
   /*
     maybe we should leave dynamic texts to the text-engraver and
     simply acknowledge them?
   */
   if (script_ev_)
     {
-      script_ = make_item ("DynamicText");
+      script_ = make_item ("DynamicText", script_ev_->self_scm ());
       script_->set_property ("text",
-                                  script_ev_->get_property ("text"));
+                            script_ev_->get_property ("text"));
 
-      
       if (Direction d = to_dir (script_ev_->get_property ("direction")))
        set_grob_direction (line_spanner_, d);
+      else if (Direction d = to_dir (line_spanner_->get_property ("direction")))
+       set_grob_direction (script_, d);
 
       Axis_group_interface::add_element (line_spanner_, script_);
-
-      announce_grob (script_, script_ev_->self_scm ());
     }
 
-  Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
-    accepted_spanreqs_drul_[STOP] : script_ev_;
+  Music *stop_ev = accepted_spanevents_drul_ [STOP]
+    ? accepted_spanevents_drul_[STOP] : script_ev_;
 
-  if (accepted_spanreqs_drul_[STOP] || script_ev_)
+  if (accepted_spanevents_drul_[STOP] || script_ev_)
     {
       /*
        finish side position alignment if the (de)cresc ends here, and
        there are no new dynamics.
-       */
-
+      */
 
       if (cresc_)
        {
          assert (!finished_cresc_ && cresc_);
 
-         cresc_->set_bound (RIGHT, script_
-                              ? script_
-                              : unsmob_grob (get_property ("currentMusicalColumn")));
-         add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
-         
+         if (script_)
+           {
+             cresc_->set_bound (RIGHT, script_);
+             add_bound_item (line_spanner_, script_);
+           }
 
          finished_cresc_ = cresc_;
          cresc_ = 0;
          current_cresc_ev_ = 0;
        }
-      else if (accepted_spanreqs_drul_[STOP])
+      else if (accepted_spanevents_drul_[STOP])
        {
-         accepted_spanreqs_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
+         accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
          stop_ev = 0;
        }
-      
     }
-  
-  if (accepted_spanreqs_drul_[START])
+
+  if (accepted_spanevents_drul_[START])
     {
       if (current_cresc_ev_)
        {
-         String msg = _ ("already have a decrescendo");
+         string msg = _ ("already have a decrescendo");
          if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
            msg = _ ("already have a crescendo");
 
-         accepted_spanreqs_drul_[START]->origin ()->warning (msg);
-         current_cresc_ev_->origin ()->warning (_("Cresc started here"));
+         accepted_spanevents_drul_[START]->origin ()->warning (msg);
+         current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
        }
       else
        {
-         current_cresc_ev_ = accepted_spanreqs_drul_[START];
+         current_cresc_ev_ = accepted_spanevents_drul_[START];
 
          if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
            set_grob_direction (line_spanner_, d);
@@ -208,28 +206,39 @@ Dynamic_engraver::process_music ()
            TODO: Use symbols.
          */
 
-         String start_type = 
-           ly_symbol2string (current_cresc_ev_->get_property ("name"));
-
-         /*
-           ugh. Use push/pop?
-         */
+         string start_type
+           = ly_symbol2string (current_cresc_ev_->get_property ("name"));
+         
          if (start_type == "DecrescendoEvent")
            start_type = "decrescendo";
          else if (start_type == "CrescendoEvent")
            start_type = "crescendo";
          
-         SCM s = get_property ((start_type + "Spanner").to_str0 ());
-         if (!is_symbol (s) || s == ly_symbol2scm ("hairpin"))
+                                      
+
+         /*
+           UGH. TODO: should read from original event, so appearance
+           may be altered with \tweak.
+          */
+         SCM s = get_property ((start_type + "Spanner").c_str ());
+         if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
            {
-             cresc_  = make_spanner ("Hairpin");
+             cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
+             if (finished_cresc_)
+               {
+                 Pointer_group_interface::add_grob (finished_cresc_,
+                                                    ly_symbol2scm ("adjacent-hairpins"),
+                                                    cresc_);
+
+                 Pointer_group_interface::add_grob (cresc_,
+                                                    ly_symbol2scm ("adjacent-hairpins"),
+                                                    finished_cresc_);
+               }
              cresc_->set_property ("grow-direction",
-                                          scm_int2num ((start_type == "crescendo")
-                                                      ? BIGGER : SMALLER));
-             
+                                   scm_from_int ((start_type == "crescendo")
+                                                 ? BIGGER : SMALLER));
            }
 
-         
          /*
            This is a convenient (and legacy) interface to TextSpanners
            for use in (de)crescendi.
@@ -237,32 +246,30 @@ Dynamic_engraver::process_music ()
          */
          else
            {
-             cresc_  = make_spanner ("TextSpanner");
+             cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
              cresc_->set_property ("style", s);
-             get_parent_context ()->set_property ((start_type
-                                           + "Spanner").to_str0 (), SCM_EOL);
-             s = get_property ((start_type + "Text").to_str0 ());
+             context ()->set_property ((start_type
+                                        + "Spanner").c_str (), SCM_EOL);
+             s = get_property ((start_type + "Text").c_str ());
              /*
                FIXME: use get_markup () to check type.
              */
-             if (is_string (s) || is_pair (s))
+             if (scm_is_string (s) || scm_is_pair (s))
                {
                  cresc_->set_property ("edge-text",
-                                            scm_cons (s, scm_makfrom0str ("")));
-                 get_parent_context ()->set_property ((start_type + "Text").to_str0 (),
-                                               SCM_EOL);
+                                       scm_cons (s, scm_makfrom0str ("")));
+                 context ()->set_property ((start_type + "Text").c_str (),
+                                           SCM_EOL);
                }
            }
 
-         cresc_->set_bound (LEFT, script_
-                              ? script_
-                              : unsmob_grob (get_property ("currentMusicalColumn")));
+         if (script_)
+           {
+             cresc_->set_bound (LEFT, script_);
+             add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
+           }
 
          Axis_group_interface::add_element (line_spanner_, cresc_);
-
-         add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
-         
-         announce_grob (cresc_, accepted_spanreqs_drul_[START]->self_scm ());
        }
     }
 }
@@ -270,26 +277,33 @@ Dynamic_engraver::process_music ()
 void
 Dynamic_engraver::stop_translation_timestep ()
 {
-  typeset_all ();
-  if (!current_cresc_ev_)
+  if (!current_cresc_ev_ && line_spanner_)
     {
+      assert (!finished_line_spanner_);
       finished_line_spanner_ = line_spanner_;
-      line_spanner_ =0;
-      typeset_all ();
+      line_spanner_ = 0;
+    }
+
+  typeset_all ();
+
+  if (cresc_ && !cresc_->get_bound (LEFT))
+    {
+      cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
+      add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
     }
 
   script_ev_ = 0;
-  accepted_spanreqs_drul_[START] = 0;
-  accepted_spanreqs_drul_[STOP] = 0;
+  accepted_spanevents_drul_[START] = 0;
+  accepted_spanevents_drul_[STOP] = 0;
 }
 
 void
 Dynamic_engraver::finalize ()
 {
   typeset_all ();
-  
+
   if (line_spanner_
-      && !line_spanner_->live ())
+      && !line_spanner_->is_live ())
     line_spanner_ = 0;
   if (line_spanner_)
     {
@@ -298,7 +312,7 @@ Dynamic_engraver::finalize ()
     }
 
   if (cresc_
-      && !cresc_->live ())
+      && !cresc_->is_live ())
     cresc_ = 0;
   if (cresc_)
     {
@@ -310,47 +324,39 @@ Dynamic_engraver::finalize ()
 
 void
 Dynamic_engraver::typeset_all ()
-{  
-  /*
-    remove suicided spanners,
-    ugh: we'll need this for every spanner, beam, slur
-    Hmm, how to do this, cleanly?
-    Maybe just check at typeset_grob ()?
-  */
-  if (finished_cresc_
-      && !finished_cresc_->live ())
-    finished_cresc_ = 0;
-  if (finished_line_spanner_
-      && !finished_line_spanner_->live ())
-    finished_line_spanner_ = 0;
-
+{
   if (finished_cresc_)
     {
-      if (!finished_cresc_->get_bound (RIGHT))
+      bool use_bar = to_boolean (get_property ("hairpinToBarline"))
+       && scm_is_string (get_property ("whichBar"))
+       && !script_ev_;
+                         
+      
+      if (!finished_cresc_->get_bound (RIGHT)
+         || use_bar)
        {
+         Grob *column_bound = unsmob_grob (use_bar
+                                           ? get_property ("currentCommandColumn")
+                                           : get_property ("currentMusicalColumn"));
+           
          finished_cresc_->set_bound (RIGHT, script_
-                                       ? script_
-                                       : unsmob_grob (get_property ("currentMusicalColumn")));
+                                     ? script_
+                                     : column_bound);
 
          if (finished_line_spanner_)
            add_bound_item (finished_line_spanner_,
                            finished_cresc_->get_bound (RIGHT));
        }
-      typeset_grob (finished_cresc_);
-      finished_cresc_ =0;
-    }
-  
-  if (script_)
-    {
-      typeset_grob (script_);
-      script_ = 0;
+      finished_cresc_ = 0;
     }
+
+  script_ = 0;
   if (finished_line_spanner_)
     {
       /*
        We used to have
-       
-            extend-spanner-over-elements (finished_line_spanner_);
+
+       extend-spanner-over-elements (finished_line_spanner_);
 
        but this is rather kludgy, since finished_line_spanner_
        typically has a staff-symbol field set , extending it over the
@@ -358,8 +364,8 @@ Dynamic_engraver::typeset_all ()
 
       */
 
-      Grob * l = finished_line_spanner_->get_bound (LEFT );
-      Grob * r = finished_line_spanner_->get_bound (RIGHT);      
+      Grob *l = finished_line_spanner_->get_bound (LEFT);
+      Grob *r = finished_line_spanner_->get_bound (RIGHT);
       if (!r && l)
        finished_line_spanner_->set_bound (RIGHT, l);
       else if (!l && r)
@@ -369,68 +375,112 @@ Dynamic_engraver::typeset_all ()
          /*
            This is a isolated dynamic apparently, and does not even have
            any interesting support item.
-          */
-         Grob * cc = unsmob_grob (get_property ("currentMusicalColumn"));
-         Item * ci = dynamic_cast<Item*>(cc);
+         */
+         Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
+         Item *ci = dynamic_cast<Item *> (cc);
          finished_line_spanner_->set_bound (RIGHT, ci);
-         finished_line_spanner_->set_bound (LEFT, ci);   
+         finished_line_spanner_->set_bound (LEFT, ci);
        }
-       
-      typeset_grob (finished_line_spanner_);
+
       finished_line_spanner_ = 0;
     }
 }
 
+
+void
+Dynamic_engraver::acknowledge_accidental (Grob_info info)
+{
+  if (line_spanner_)
+    Side_position_interface::add_support (line_spanner_, info.grob ());
+}
+
+
+void
+Dynamic_engraver::acknowledge_stem_tremolo (Grob_info info)
+{
+  if (line_spanner_)
+    Side_position_interface::add_support (line_spanner_, info.grob ());
+}
+
+
+void
+Dynamic_engraver::acknowledge_slur (Grob_info info)
+{
+  if (line_spanner_)
+    Side_position_interface::add_support (line_spanner_, info.grob ());
+}
+
+
 void
-Dynamic_engraver::acknowledge_grob (Grob_info i)
+Dynamic_engraver::acknowledge_note_column (Grob_info info)
 {
   if (!line_spanner_)
-    return ;
-  
-  if (Note_column::has_interface (i.grob_))
+    return;
+
+  if (line_spanner_
+      /* Don't refill killed spanner */
+      && line_spanner_->is_live ())
+    {
+      Side_position_interface::add_support (line_spanner_, info.grob ());
+      add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
+    }
+
+  if (script_ && !script_->get_parent (X_AXIS))
     {
-      if (line_spanner_
-         /* Don't refill killed spanner */
-         && line_spanner_->live ())
+      extract_grob_set (info.grob (), "note-heads", heads);
+      if (heads.size ())
        {
-         Side_position_interface::add_support (line_spanner_,i.grob_);
-         add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_));
+         Grob *head = heads[0];
+         script_->set_parent (head, X_AXIS);
+         Self_alignment_interface::set_center_parent (script_, X_AXIS);
        }
+    }
 
-      if (script_ && !script_->get_parent (X_AXIS))
+  if (cresc_)
+    {
+      if (!cresc_->get_bound (LEFT))
        {
-         SCM head = scm_last_pair (i.grob_->get_property ("note-heads"));
-         if (is_pair (head))
-           script_->set_parent (unsmob_grob (ly_car (head)),  X_AXIS);
+         cresc_->set_bound (LEFT, info.grob ());
+         add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
        }
-      
     }
-  else if (Script_interface::has_interface (i.grob_) && script_)
-    {
-      SCM p = i.grob_->get_property ("script-priority");
 
-      /*
-       UGH.
+  if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
+    finished_cresc_->set_bound (RIGHT, info.grob ());
+}
 
-       DynamicText doesn't really have a script-priority field.
-       */
-      if (is_number (p)
-         && ly_scm2int (p) < ly_scm2int (script_->get_property ("script-priority")))
-       {
-         Side_position_interface::add_support (line_spanner_, i.grob_);
+void
+Dynamic_engraver::acknowledge_script (Grob_info info)
+{
+  if (!line_spanner_ || !script_)
+    return;
 
-       }         
-    }
+  SCM p = info.grob ()->get_property ("script-priority");
+
+  /*
+    UGH.
+
+    DynamicText doesn't really have a script-priority field.
+  */
+  if (scm_is_number (p)
+      && scm_to_int (p)
+      < scm_to_int (script_->get_property ("script-priority")))
+    Side_position_interface::add_support (line_spanner_, info.grob ());
 }
-ENTER_DESCRIPTION (Dynamic_engraver,
-/* descr */       
-"This engraver creates hairpins, dynamic texts, and their vertical\n"
-"alignments.  The symbols are collected onto a DynamicLineSpanner grob\n"
-"which takes care of vertical positioning.  "
-,
-                 
-/* creats*/       "DynamicLineSpanner DynamicText Hairpin TextSpanner",
-/* accepts */     "absolute-dynamic-event crescendo-event decrescendo-event",
-/* acks  */      "note-column-interface script-interface",
-/* reads */       "",
-/* write */       "");
+
+ADD_ACKNOWLEDGER (Dynamic_engraver, accidental);
+ADD_ACKNOWLEDGER (Dynamic_engraver, script);
+ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
+ADD_ACKNOWLEDGER (Dynamic_engraver, slur);
+ADD_ACKNOWLEDGER (Dynamic_engraver, stem_tremolo);
+
+ADD_TRANSLATOR (Dynamic_engraver,
+               /* doc */
+               "This engraver creates hairpins, dynamic texts, and their vertical\n"
+               "alignments.  The symbols are collected onto a DynamicLineSpanner grob\n"
+               "which takes care of vertical positioning.  ",
+
+               /* create */ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
+               /* accept */ "absolute-dynamic-event crescendo-event decrescendo-event",
+               /* read */ "",
+               /* write */ "");