]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/dynamic-engraver.cc
* lily/hairpin.cc: lengthen hairpin if space is available.
[lilypond.git] / lily / dynamic-engraver.cc
index fd92417cbc1fd53ea5c58e4ff6431153b41861a7..71dfcce857cadd90f9e1be69bd26eb58b92d7110 100644 (file)
@@ -3,27 +3,31 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
-#include "debug.hh"
+
+#include "axis-group-interface.hh"
+#include "context.hh"
 #include "dimensions.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
+#include "event.hh"
+#include "group-interface.hh"
 #include "hairpin.hh"
-#include "musical-request.hh"
-#include "paper-column.hh"
-#include "note-column.hh"
+#include "interval.hh"
 #include "item.hh"
+#include "slur.hh"
+#include "note-column.hh"
+#include "paper-column.hh"
+#include "script-interface.hh"
 #include "side-position-interface.hh"
-#include "engraver.hh"
-#include "group-interface.hh"
-#include "directional-element-interface.hh"
-#include "translator-group.hh"
-#include "axis-group-interface.hh"
-
+#include "staff-symbol-referencer.hh"
+#include "warn.hh"
 
 /*
   TODO:
 
-  * direction of text-dynamic-request if not equal to direction of
+  * direction of text-dynamic-event if not equal to direction of
   line-spanner
 
   - TODO: this engraver is too complicated. We should split it into
  */
 class Dynamic_engraver : public Engraver
 {
-  Item * script_p_;
-  Spanner * finished_cresc_p_;
-  Spanner * cresc_p_;
+  Item *script_;
+  Spanner *line_spanner_;
+  Spanner *slur_;
+  Spanner *cresc_;
 
-  Text_script_req* script_req_l_;
-  
-  Span_req * current_cresc_req_;
-  Drul_array<Span_req*> accepted_spanreqs_drul_;
+  Spanner *finished_line_spanner_;
+  Spanner *finished_cresc_;
 
-  Spanner* line_spanner_;
-  Spanner* finished_line_spanner_;
+  Music *script_ev_;
+  Music *current_cresc_ev_;
+  
+  Drul_array<Music*> accepted_spanreqs_drul_;
 
-  Link_array<Note_column> pending_column_arr_;
-  Link_array<Grob> pending_element_arr_;
+  Link_array<Note_column> pending_columns_;
+  Link_array<Grob> pending_elements_;
   
   void typeset_all ();
 
-TRANSLATOR_DECLARATIONS(Dynamic_engraver );
+  TRANSLATOR_DECLARATIONS (Dynamic_engraver);
   
 protected:
   virtual void finalize ();
   virtual void acknowledge_grob (Grob_info);
-  virtual bool try_music (Music *req_l);
+  virtual bool try_music (Music *req);
   virtual void stop_translation_timestep ();
   virtual void process_music ();  
-  virtual void start_translation_timestep ();
 };
 
 
@@ -72,59 +76,39 @@ protected:
 
 Dynamic_engraver::Dynamic_engraver ()
 {
-  script_p_ = 0;
-  finished_cresc_p_ = 0;
+  script_ = 0;
+  slur_ = 0;
+  finished_cresc_ = 0;
   line_spanner_ = 0;
   finished_line_spanner_ = 0;
-  current_cresc_req_ = 0;
-  cresc_p_ =0;
+  current_cresc_ev_ = 0;
+  cresc_ =0;
 
-  script_req_l_ = 0;
-  accepted_spanreqs_drul_[START] = 0;
-  accepted_spanreqs_drul_[STOP] = 0;
-}
-
-void
-Dynamic_engraver::start_translation_timestep ()
-{
-  script_req_l_ = 0;
+  script_ev_ = 0;
   accepted_spanreqs_drul_[START] = 0;
   accepted_spanreqs_drul_[STOP] = 0;
 }
 
 bool
-Dynamic_engraver::try_music (Music * m)
+Dynamic_engraver::try_music (Music *m)
 {
-  if (dynamic_cast <Text_script_req*> (m)
-      && m->get_mus_property ("text-type") == ly_symbol2scm ("dynamic"))
+  if (m->is_mus_type ("absolute-dynamic-event"))
     {
-      script_req_l_ = dynamic_cast<Text_script_req*> (m);
+      /*
+       TODO: probably broken.
+      */
+      script_ev_ = m;
       return true;
     }
-  else if (Span_req* s =  dynamic_cast <Span_req*> (m))
+  else if (m->is_mus_type ("decrescendo-event")
+          || m->is_mus_type ("crescendo-event"))
     {
-      String t = ly_scm2string (s->get_mus_property ("span-type"));
-      if (t== "abort")
-       {
-         accepted_spanreqs_drul_[LEFT] = 0;
-         accepted_spanreqs_drul_[RIGHT] = 0;
-         /*
-           Let's not kill the line spanner, since that would fuck up
-           earlier, not-to-be-terminated stuff.
+      Direction d = to_dir (m->get_property ("span-direction"));
 
-           It will disappear by itself when stop_translation_timestep
- () finds that there is nothing to support anymore.  */
-         
-         if (cresc_p_)
-           cresc_p_->suicide ();
-         cresc_p_ = 0;
-       }
-      else if (t == "crescendo"
-          || t == "decrescendo")
-       {
-         accepted_spanreqs_drul_[s->get_span_dir ()] = s;
-         return true;
-       }
+      accepted_spanreqs_drul_[d] = m;
+      if (current_cresc_ev_ && d == START)
+       accepted_spanreqs_drul_[STOP] = m;
+      return true;
     }
   return false;
 }
@@ -132,33 +116,26 @@ Dynamic_engraver::try_music (Music * m)
 void
 Dynamic_engraver::process_music ()
 {
-  if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_req_l_)
+  if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
     {
       if (!line_spanner_)
        {
-         line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
-
-         Side_position_interface::set_axis (line_spanner_, Y_AXIS);
-         Axis_group_interface::set_interface (line_spanner_);
-         Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS);
-
          Music * rq = accepted_spanreqs_drul_[START];
-         if (script_req_l_)
-           rq =  script_req_l_ ;
-         announce_grob(line_spanner_, rq ? rq->self_scm(): SCM_EOL);
-                        
+         line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm (): SCM_EOL );
 
+         if (script_ev_)
+           rq =  script_ev_;
        }
     }
   
-       /*
-       During a (de)crescendo, pending request will not be cleared,
-       and a line-spanner will always be created, as \< \! are already
-       two requests.
+  /*
+    During a (de)crescendo, pending event will not be cleared,
+    and a line-spanner will always be created, as \< \! are already
+    two events.
 
-       Note: line-spanner must always have at least same duration
-       as (de)crecsendo, b.o. line-breaking.
-       */
+    Note: line-spanner must always have at least same duration
+    as (de)crecsendo, b.o. line-breaking.
+  */
 
   
 
@@ -166,82 +143,106 @@ Dynamic_engraver::process_music ()
     maybe we should leave dynamic texts to the text-engraver and
     simply acknowledge them?
   */
-  if (script_req_l_)
+  if (script_ev_)
     {
-      script_p_ = new Item (get_property ("DynamicText"));
-      script_p_->set_grob_property ("text",
-                                  script_req_l_->get_mus_property ("text"));
-      
-      Side_position_interface::set_direction (script_p_, DOWN);
+      script_ = make_item ("DynamicText", script_ev_->self_scm ());
+      script_->set_property ("text",
+                            script_ev_->get_property ("text"));
 
-      if (Direction d = script_req_l_->get_direction ())
-       Directional_element_interface::set (line_spanner_, d);
-
-      Axis_group_interface::add_element (line_spanner_, script_p_);
+      
+      if (Direction d = to_dir (script_ev_->get_property ("direction")))
+       set_grob_direction (line_spanner_, d);
 
-      announce_grob(script_p_, script_req_l_->self_scm());
+      Axis_group_interface::add_element (line_spanner_, script_);
     }
 
-  if (accepted_spanreqs_drul_[STOP])
+  Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
+    accepted_spanreqs_drul_[STOP] : script_ev_;
+
+  if (accepted_spanreqs_drul_[STOP] || script_ev_)
     {
       /*
        finish side position alignment if the (de)cresc ends here, and
        there are no new dynamics.
        */
-      if (!cresc_p_)
-       {
-         accepted_spanreqs_drul_[STOP]->origin ()->warning
- (_ ("can't find start of (de)crescendo"));
-         accepted_spanreqs_drul_[STOP] = 0;
-       }
-      else
+
+
+      if (cresc_)
        {
-         assert (!finished_cresc_p_ && cresc_p_);
+         assert (!finished_cresc_ && cresc_);
 
-         cresc_p_->set_bound (RIGHT, script_p_
-                              ? script_p_
+         cresc_->set_bound (RIGHT, script_
+                              ? script_
                               : unsmob_grob (get_property ("currentMusicalColumn")));
-         add_bound_item (line_spanner_, cresc_p_->get_bound (RIGHT));
+         add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
          
 
-         finished_cresc_p_ = cresc_p_;
-         cresc_p_ = 0;
-         current_cresc_req_ = 0;
+         finished_cresc_ = cresc_;
+         cresc_ = 0;
+         current_cresc_ev_ = 0;
+       }
+      else if (accepted_spanreqs_drul_[STOP])
+       {
+         accepted_spanreqs_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
+         stop_ev = 0;
        }
+      
     }
   
   if (accepted_spanreqs_drul_[START])
     {
-      if (current_cresc_req_)
+      if (current_cresc_ev_)
        {
-         accepted_spanreqs_drul_[START]->origin ()->warning
- (current_cresc_req_->get_span_dir () == 1
-            ? _ ("already have a crescendo")
-            : _ ("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"));
        }
       else
        {
-         current_cresc_req_ = accepted_spanreqs_drul_[START];
+         current_cresc_ev_ = accepted_spanreqs_drul_[START];
+
+         if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
+           set_grob_direction (line_spanner_, d);
 
          /*
            TODO: Use symbols.
          */
 
-         String start_type = ly_scm2string (accepted_spanreqs_drul_[START]->get_mus_property ("span-type"));
+         String start_type = 
+           ly_symbol2string (current_cresc_ev_->get_property ("name"));
 
          /*
            ugh. Use push/pop?
          */
-         SCM s = get_property ((start_type + "Spanner").ch_C ());
-         if (!gh_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
+         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 (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
            {
-             cresc_p_  = new Spanner (get_property ("Hairpin"));
-             cresc_p_->set_grob_property ("grow-direction",
-                                          gh_int2scm ((start_type == "crescendo")
-                                                      ? BIGGER : SMALLER));
+             cresc_  = make_spanner ("Hairpin", accepted_spanreqs_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));
              
            }
+
+         
          /*
            This is a convenient (and legacy) interface to TextSpanners
            for use in (de)crescendi.
@@ -249,34 +250,30 @@ Dynamic_engraver::process_music ()
          */
          else
            {
-             cresc_p_  = new Spanner (get_property ("TextSpanner"));
-             cresc_p_->set_interface (ly_symbol2scm ("dynamic-interface"));
-             cresc_p_->set_grob_property ("type", s);
-             
-             daddy_trans_l_->set_property ((start_type
-                                           + "Spanner").ch_C(), SCM_UNDEFINED);
-             s = get_property ((start_type + "Text").ch_C ());
+             cresc_  = make_spanner ("DynamicTextSpanner", accepted_spanreqs_drul_[START]->self_scm ());
+             cresc_->set_property ("style", s);
+             context ()->set_property ((start_type
+                                        + "Spanner").to_str0 (), SCM_EOL);
+             s = get_property ((start_type + "Text").to_str0 ());
              /*
-               FIXME: use markup_p () to check type.
+               FIXME: use get_markup () to check type.
              */
-             if (gh_string_p (s) || gh_pair_p (s))
+             if (scm_is_string (s) || ly_c_pair_p (s))
                {
-                 cresc_p_->set_grob_property ("edge-text",
-                                              gh_cons (s, ly_str02scm ("")));
-                 daddy_trans_l_->set_property ((start_type + "Text").ch_C(),
-                                               SCM_UNDEFINED);
+                 cresc_->set_property ("edge-text",
+                                       scm_cons (s, scm_makfrom0str ("")));
+                 context ()->set_property ((start_type + "Text").to_str0 (),
+                                           SCM_EOL);
                }
            }
 
-         cresc_p_->set_bound (LEFT, script_p_
-                              ? script_p_
-                              : unsmob_grob (get_property ("currentMusicalColumn")));
+         cresc_->set_bound (LEFT, script_
+                            ? script_
+                            : unsmob_grob (get_property ("currentMusicalColumn")));
 
-         Axis_group_interface::add_element (line_spanner_, cresc_p_);
+         Axis_group_interface::add_element (line_spanner_, cresc_);
 
-         add_bound_item (line_spanner_, cresc_p_->get_bound (LEFT));
-         
-         announce_grob(cresc_p_, accepted_spanreqs_drul_[START]->self_scm());
+         add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
        }
     }
 }
@@ -285,12 +282,17 @@ void
 Dynamic_engraver::stop_translation_timestep ()
 {
   typeset_all ();
-  if (script_req_l_ && !current_cresc_req_)
+  if (!current_cresc_ev_)
     {
+      
       finished_line_spanner_ = line_spanner_;
-      line_spanner_ =0;
+      line_spanner_ = 0;
       typeset_all ();
     }
+
+  script_ev_ = 0;
+  accepted_spanreqs_drul_[START] = 0;
+  accepted_spanreqs_drul_[STOP] = 0;
 }
 
 void
@@ -299,7 +301,7 @@ Dynamic_engraver::finalize ()
   typeset_all ();
   
   if (line_spanner_
-      && line_spanner_->immutable_property_alist_ == SCM_EOL)
+      && !line_spanner_->is_live ())
     line_spanner_ = 0;
   if (line_spanner_)
     {
@@ -307,63 +309,42 @@ Dynamic_engraver::finalize ()
       typeset_all ();
     }
 
-  if (cresc_p_
-      && cresc_p_->immutable_property_alist_ == SCM_EOL)
-    cresc_p_ = 0;
-  if (cresc_p_)
+  if (cresc_
+      && !cresc_->is_live ())
+    cresc_ = 0;
+  if (cresc_)
     {
-      current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo"));
-      cresc_p_->suicide ();
-      cresc_p_ = 0;
+      current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
+      cresc_->suicide ();
+      cresc_ = 0;
     }
 }
 
 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_p_
-      && finished_cresc_p_->immutable_property_alist_ == SCM_EOL)
-    finished_cresc_p_ = 0;
-  if (finished_line_spanner_
-      && finished_line_spanner_->immutable_property_alist_ == SCM_EOL)
-    finished_line_spanner_ = 0;
-
-  if (finished_cresc_p_)
+{
+  if (finished_cresc_)
     {
-      if (!finished_cresc_p_->get_bound (RIGHT))
+      if (!finished_cresc_->get_bound (RIGHT))
        {
-         finished_cresc_p_->set_bound (RIGHT, script_p_
-                                       ? script_p_
-                                       : unsmob_grob (get_property ("currentMusicalColumn")));
-
+         finished_cresc_->set_bound (RIGHT, script_
+                                     ? script_
+                                     : unsmob_grob (get_property ("currentMusicalColumn")));
+         
          if (finished_line_spanner_)
            add_bound_item (finished_line_spanner_,
-                           finished_cresc_p_->get_bound (RIGHT));
+                           finished_cresc_->get_bound (RIGHT));
        }
-      typeset_grob (finished_cresc_p_);
-      finished_cresc_p_ =0;
+      finished_cresc_ =0;
     }
   
-  if (script_p_)
-    {
-      typeset_grob (script_p_);
-      script_p_ = 0;
-    }
+  script_ = 0;
   if (finished_line_spanner_)
     {
-      /* To make sure that this works */
-      Side_position_interface::add_staff_support (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
@@ -371,7 +352,7 @@ Dynamic_engraver::typeset_all ()
 
       */
 
-      Grob * l = finished_line_spanner_->get_bound (LEFT );
+      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);
@@ -389,33 +370,60 @@ Dynamic_engraver::typeset_all ()
          finished_line_spanner_->set_bound (LEFT, ci);   
        }
        
-      typeset_grob (finished_line_spanner_);
       finished_line_spanner_ = 0;
     }
 }
 
 void
-Dynamic_engraver::acknowledge_grob (Grob_info i)
+Dynamic_engraver::acknowledge_grob (Grob_info info)
 {
-  if (Note_column::has_interface (i.grob_l_))
+  if (!line_spanner_)
+    return;
+
+  if (Note_column::has_interface (info.grob_))
     {
       if (line_spanner_
          /* Don't refill killed spanner */
-         && line_spanner_->immutable_property_alist_ != SCM_EOL)
+         && line_spanner_->is_live ())
        {
-         Side_position_interface::add_support (line_spanner_,i.grob_l_);
-         add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_l_));
+         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))
+       {
+         SCM head = scm_last_pair (info.grob_->get_property ("note-heads"));
+         if (ly_c_pair_p (head))
+           script_->set_parent (unsmob_grob (ly_car (head)),  X_AXIS);
+       }
+    }
+  else if (Script_interface::has_interface (info.grob_) && script_)
+    {
+      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_);
     }
+  else if (Slur::has_interface (info.grob_))
+    slur_ = dynamic_cast<Spanner*> (info.grob_);
 }
-ENTER_DESCRIPTION(Dynamic_engraver,
-/* descr */       "
-This engraver creates hairpins, dynamic texts, and their vertical
-alignments.  The symbols are collected onto a DynamicLineSpanner grob
-which takes care of vertical positioning.  
-",
+
+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",
-/* acks  */       "note-column-interface",
+/* accepts */     "absolute-dynamic-event crescendo-event decrescendo-event",
+/* acks  */      "note-column-interface script-interface slur-interface",
 /* reads */       "",
 /* write */       "");