]> 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 2a7ca06770857746fce991c63a6c9406b5dafe3e..71dfcce857cadd90f9e1be69bd26eb58b92d7110 100644 (file)
@@ -3,28 +3,39 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 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 "crescendo.hh"
-#include "musical-request.hh"
-#include "paper-column.hh"
-#include "note-column.hh"
-#include "item.hh"
-#include "side-position-interface.hh"
+#include "directional-element-interface.hh"
 #include "engraver.hh"
+#include "event.hh"
 #include "group-interface.hh"
-#include "directional-element-interface.hh"
-#include "translator-group.hh"
-#include "axis-group-interface.hh"
-
+#include "hairpin.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 "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
+  the handling of the basic grobs and the  linespanner
+
+  - TODO: the line-spanner is not killed after the (de)crescs are
+  finished.
+
 */
 
 /**
  */
 class Dynamic_engraver : public Engraver
 {
-  Item * script_p_;
-  Spanner * finished_cresc_p_;
-  Spanner * cresc_p_;
+  Item *script_;
+  Spanner *line_spanner_;
+  Spanner *slur_;
+  Spanner *cresc_;
 
-  Dynamic_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<Score_element> pending_element_arr_;
+  Link_array<Note_column> pending_columns_;
+  Link_array<Grob> pending_elements_;
   
   void typeset_all ();
 
-public:
-  VIRTUAL_COPY_CONS(Translator);
-  Dynamic_engraver ();
+  TRANSLATOR_DECLARATIONS (Dynamic_engraver);
   
 protected:
-  virtual void do_removal_processing ();
-  virtual void acknowledge_element (Score_element_info);
-  virtual bool do_try_music (Music *req_l);
-  virtual void do_process_music ();
-  virtual void do_pre_move_processing ();
-  virtual void do_post_move_processing ();
+  virtual void finalize ();
+  virtual void acknowledge_grob (Grob_info);
+  virtual bool try_music (Music *req);
+  virtual void stop_translation_timestep ();
+  virtual void process_music ();  
 };
 
-ADD_THIS_TRANSLATOR (Dynamic_engraver);
+
 
 
 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::do_post_move_processing ()
-{
-  script_req_l_ = 0;
+  script_ev_ = 0;
   accepted_spanreqs_drul_[START] = 0;
   accepted_spanreqs_drul_[STOP] = 0;
 }
 
 bool
-Dynamic_engraver::do_try_music (Music * m)
+Dynamic_engraver::try_music (Music *m)
 {
-  if (Dynamic_script_req* d = dynamic_cast <Dynamic_script_req*> (m))
+  if (m->is_mus_type ("absolute-dynamic-event"))
     {
-      script_req_l_ = d;
+      /*
+       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"))
     {
-      if (s->span_type_str_ == "abort")
-       {
-         accepted_spanreqs_drul_[LEFT] = 0;
-         accepted_spanreqs_drul_[RIGHT] = 0;
-         if (line_spanner_)
-           line_spanner_->suicide ();
-         line_spanner_ = 0;
-         if (cresc_p_)
-           cresc_p_->suicide ();
-         cresc_p_ = 0;
-       }
-      else if ((s->span_type_str_ == "crescendo"
-          || s->span_type_str_ == "decrescendo"))
-       {
-         accepted_spanreqs_drul_[s->span_dir_] = s;
-         return true;
-       }
+      Direction d = to_dir (m->get_property ("span-direction"));
+
+      accepted_spanreqs_drul_[d] = m;
+      if (current_cresc_ev_ && d == START)
+       accepted_spanreqs_drul_[STOP] = m;
+      return true;
     }
   return false;
 }
 
 void
-Dynamic_engraver::do_process_music ()
+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::set_axis (line_spanner_, Y_AXIS);
-         Axis_group_interface::set_interface (line_spanner_);
-         Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS);
-
-         Request * rq = accepted_spanreqs_drul_[START];
-         if (script_req_l_) rq =  script_req_l_ ;
-         announce_element (line_spanner_, rq);
-                        
+         Music * rq = accepted_spanreqs_drul_[START];
+         line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm (): SCM_EOL );
 
+         if (script_ev_)
+           rq =  script_ev_;
        }
     }
-
+  
   /*
-    finish side position alignment if the (de)cresc ends here, and
-    there are no new dynamics.
-    
-   */
-  else if (accepted_spanreqs_drul_[STOP]
-          && !accepted_spanreqs_drul_[START] && !script_req_l_)
-    {
-      finished_line_spanner_ = line_spanner_;
-      line_spanner_ = 0;
-    }
-
-       /*
-       todo: resurrect  dynamic{direction, padding,minimumspace}
-       */
-       /*
-       During a (de)crescendo, pending request will not be cleared,
-       and a line-spanner will always be created, as \< \! are already
-       two requests.
-
-       Maybe always creating a line-spanner for a (de)crescendo (see
-       below) is not a good idea:
-
-           a\< b\p \!c
+    During a (de)crescendo, pending event will not be cleared,
+    and a line-spanner will always be created, as \< \! are already
+    two events.
 
-       the \p will be centred on the line-spanner, and thus clash
-       with the hairpin.  When axis-group code is in place, the \p
-       should move below the hairpin, which is probably better?
-
-       Urg, but 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.
+  */
 
   
 
@@ -179,157 +143,287 @@ Dynamic_engraver::do_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_elt_property ("text", script_req_l_->text_);
-      if (Direction d = script_req_l_->get_direction ())
-       Directional_element_interface::set (line_spanner_, d);
+      script_ = make_item ("DynamicText", script_ev_->self_scm ());
+      script_->set_property ("text",
+                            script_ev_->get_property ("text"));
 
-      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_element (script_p_, script_req_l_);
+      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_)
     {
-      if (!cresc_p_)
-       {
-         accepted_spanreqs_drul_[STOP]->origin ()->warning
-           (_ ("can't find start of (de)crescendo"));
-       }
-      else
+      /*
+       finish side position alignment if the (de)cresc ends here, and
+       there are no new dynamics.
+       */
+
+
+      if (cresc_)
        {
-         assert (!finished_cresc_p_);
-         Score_element* cc = unsmob_element (get_property ("currentMusicalColumn"));
+         assert (!finished_cresc_ && cresc_);
+
+         cresc_->set_bound (RIGHT, script_
+                              ? script_
+                              : unsmob_grob (get_property ("currentMusicalColumn")));
+         add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
          
-         cresc_p_->set_bound (RIGHT, cc);
 
-         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_->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.
-          */
-         SCM s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Spanner").ch_C());
+         */
 
-         if (!gh_string_p (s) || ly_scm2string (s) == "hairpin")
+         String start_type = 
+           ly_symbol2string (current_cresc_ev_->get_property ("name"));
+
+         /*
+           ugh. Use push/pop?
+         */
+         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 ("Crescendo"));
-             cresc_p_->set_elt_property ("grow-direction",
-                                         gh_int2scm ((accepted_spanreqs_drul_[START]->span_type_str_ == "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.
            Hmm.
-          */
+         */
          else
            {
-             cresc_p_  = new Spanner (get_property ("TextSpanner"));
-             cresc_p_->set_elt_property ("type", s);
-             daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_
-                                           + "Spanner", SCM_UNDEFINED);
-             s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Text").ch_C());
-             if (gh_string_p (s))
+             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 get_markup () to check type.
+             */
+             if (scm_is_string (s) || ly_c_pair_p (s))
                {
-                 cresc_p_->set_elt_property ("edge-text",
-                                             gh_cons (s, ly_str02scm ("")));
-                 daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_
-                                               + "Text", SCM_UNDEFINED);
+                 cresc_->set_property ("edge-text",
+                                       scm_cons (s, scm_makfrom0str ("")));
+                 context ()->set_property ((start_type + "Text").to_str0 (),
+                                           SCM_EOL);
                }
            }
-       
-         Score_element *cc = unsmob_element (get_property ("currentMusicalColumn"));
-         cresc_p_->set_bound (LEFT, cc);
 
-         if (script_p_)
-           {
-             Side_position::set_direction (script_p_, LEFT);
-             Side_position::set_axis (script_p_, X_AXIS);
-             Side_position::add_support (script_p_, cresc_p_);
-           }
+         cresc_->set_bound (LEFT, script_
+                            ? script_
+                            : unsmob_grob (get_property ("currentMusicalColumn")));
+
+         Axis_group_interface::add_element (line_spanner_, cresc_);
 
-         Axis_group_interface::add_element (line_spanner_, cresc_p_);
-         announce_element (cresc_p_, accepted_spanreqs_drul_[START]);
+         add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
        }
     }
 }
 
 void
-Dynamic_engraver::do_pre_move_processing ()
+Dynamic_engraver::stop_translation_timestep ()
 {
   typeset_all ();
+  if (!current_cresc_ev_)
+    {
+      
+      finished_line_spanner_ = line_spanner_;
+      line_spanner_ = 0;
+      typeset_all ();
+    }
+
+  script_ev_ = 0;
+  accepted_spanreqs_drul_[START] = 0;
+  accepted_spanreqs_drul_[STOP] = 0;
 }
 
 void
-Dynamic_engraver::do_removal_processing ()
+Dynamic_engraver::finalize ()
 {
   typeset_all ();
+  
+  if (line_spanner_
+      && !line_spanner_->is_live ())
+    line_spanner_ = 0;
   if (line_spanner_)
     {
       finished_line_spanner_ = line_spanner_;
       typeset_all ();
     }
 
-  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 ()
-{  
-  if (finished_cresc_p_)
+{
+  if (finished_cresc_)
     {
-      typeset_element (finished_cresc_p_);
-      finished_cresc_p_ =0;
+      if (!finished_cresc_->get_bound (RIGHT))
+       {
+         finished_cresc_->set_bound (RIGHT, script_
+                                     ? script_
+                                     : unsmob_grob (get_property ("currentMusicalColumn")));
+         
+         if (finished_line_spanner_)
+           add_bound_item (finished_line_spanner_,
+                           finished_cresc_->get_bound (RIGHT));
+       }
+      finished_cresc_ =0;
     }
   
-  if (script_p_)
-    {
-      typeset_element (script_p_);
-      script_p_ = 0;
-    }
+  script_ = 0;
   if (finished_line_spanner_)
     {
-      Side_position::add_staff_support (finished_line_spanner_);
-      extend_spanner_over_elements (finished_line_spanner_);
-      typeset_element (finished_line_spanner_);
+      /*
+       We used to have
+       
+            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
+       entire staff.
+
+      */
+
+      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)
+       finished_line_spanner_->set_bound (LEFT, r);
+      else if (!r && !l)
+       {
+         /*
+           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);
+         finished_line_spanner_->set_bound (RIGHT, ci);
+         finished_line_spanner_->set_bound (LEFT, ci);   
+       }
+       
       finished_line_spanner_ = 0;
     }
 }
 
 void
-Dynamic_engraver::acknowledge_element (Score_element_info i)
+Dynamic_engraver::acknowledge_grob (Grob_info info)
 {
-  if (Note_column::has_interface (i.elem_l_))
+  if (!line_spanner_)
+    return;
+
+  if (Note_column::has_interface (info.grob_))
     {
-      if (line_spanner_)
+      if (line_spanner_
+         /* Don't refill killed spanner */
+         && line_spanner_->is_live ())
        {
-         Side_position::add_support (line_spanner_,i.elem_l_);
-         add_bound_item (line_spanner_,dynamic_cast<Item*>(i.elem_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\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 slur-interface",
+/* reads */       "",
+/* write */       "");