X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpiano-pedal-engraver.cc;h=b68359a4d7fe154963485fab97f34bae4dc7a00f;hb=051d7e7cbdbbe5f5337ab2b477b0bd1e72eedd04;hp=09f5d1e09355f99075d1bb4f8eec4f0b2d4e5ea9;hpb=fc3e875d6bf06f0680e897faffdcab36ad975a03;p=lilypond.git

diff --git a/lily/piano-pedal-engraver.cc b/lily/piano-pedal-engraver.cc
index 09f5d1e093..b68359a4d7 100644
--- a/lily/piano-pedal-engraver.cc
+++ b/lily/piano-pedal-engraver.cc
@@ -3,69 +3,115 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 2000--2001 Jan Nieuwenhuizen <janneke@gnu.org>
- */
+ (c) 2000--2002 Jan Nieuwenhuizen <janneke@gnu.org>
+  
+  Chris Jackson <chris@fluffhouse.org.uk> - extended to support
+  bracketed pedals.
+*/
 
 #include "engraver.hh"
-#include "musical-request.hh"
+#include "request.hh"
 #include "grob.hh"
 #include "item.hh"
 #include "lily-guile.hh"
-#include "rhythmic-head.hh"
-#include "stem.hh"
 #include "side-position-interface.hh"
 #include "staff-symbol-referencer.hh"
 #include "item.hh"
+#include "axis-group-interface.hh"
+#include "translator-group.hh"
+#include "directional-element-interface.hh"
+#include "note-column.hh"
+
+struct Pedal_info
+{
+  char const * name_;
+  Music* start_req_;
+  Drul_array<Music*> req_l_drul_;
+  Item* item_;
+  Spanner* bracket_;     // A single portion of a pedal bracket
+  Spanner* finished_bracket_;
+
+  /*
+    This grob contains all the pedals of the same type on the same staff
+   */
+  Spanner* line_spanner_;
+  Spanner* finished_line_spanner_;
+  Music* current_bracket_req_;
+};
+
 
 class Piano_pedal_engraver : public Engraver
 {
 public:
-  VIRTUAL_COPY_CONS (Translator);
-  Piano_pedal_engraver ();
+  TRANSLATOR_DECLARATIONS (Piano_pedal_engraver);
   ~Piano_pedal_engraver ();
 protected:
   virtual void initialize ();
+  virtual void finalize ();
   virtual bool try_music (Music*);
   virtual void stop_translation_timestep ();
   virtual void start_translation_timestep ();
   virtual void acknowledge_grob (Grob_info);
-  virtual void create_grobs ();
+  virtual void process_acknowledged_grobs ();
 
 private:
-  struct Pedal_info
-  {
-    char const * name_;
-    Span_req* start_req_l_;
-    Drul_array<Span_req*> req_l_drul_;
-    Item* item_p_;
-  };
-
 
   Pedal_info *info_list_;
+
+  /*
+    Record a stack of the current pedal spanners, so if more than one pedal
+    occurs simultaneously then extra space can be added between them.
+
+
+    Why 4, why not 3. Why not 3423 ?  ---hwn.
+  */
+  
+  Spanner *previous_ [4];
+  
+  int spanner_count_;
+
+  /*
+    Left and right flare widths of a \___/, as specified by the grob
+    property edge-widen.
+   */
+  Drul_array<SCM> edge_width_drul_;
+  
+  void create_text_grobs (Pedal_info *p, SCM pedaltype);
+  void create_bracket_grobs (Pedal_info *p, SCM pedaltype);
+  void typeset_all ();
 };
 
-ADD_THIS_TRANSLATOR (Piano_pedal_engraver);
 
 Piano_pedal_engraver::Piano_pedal_engraver ()
 {
   info_list_ = 0;
 }
+
 void
 Piano_pedal_engraver::initialize ()
 {
   info_list_ = new Pedal_info[4];
   Pedal_info *p = info_list_;
 
+  spanner_count_ = 0;
+  for (int i = 0; i < 3; ++i)
+    previous_[i] = 0; 
+
 
-  char * names [] = { "Sostenuto", "Sustain", "UnaChorda", 0  };
+  char * names [] = { "Sostenuto", "Sustain", "UnaCorda", 0  };
   char **np = names ;
   do
     {
       p->name_ = *np;
-      p->item_p_ = 0;
+      p->item_ = 0;
+      p->bracket_ = 0;
+      p->finished_bracket_ = 0;
+      p->line_spanner_ = 0;
+      p->finished_line_spanner_ = 0;
+      p->current_bracket_req_ = 0;
       p->req_l_drul_[START] = 0;
       p->req_l_drul_[STOP] = 0;
-      p->start_req_l_ = 0;
+      p->start_req_ = 0;
 
       p++;
     }
@@ -86,20 +132,17 @@ Piano_pedal_engraver::acknowledge_grob (Grob_info info)
 {
   for (Pedal_info*p = info_list_; p && p->name_; p ++)
     {
-      if (p->item_p_)
+      if (Note_column::has_interface (info.grob_))
 	{
-	  if (Rhythmic_head::has_interface (info.elem_l_))
+	  if (p->line_spanner_)
 	    {
-	      Side_position_interface::add_support (p->item_p_, info.elem_l_);
-
-	      if (Side_position_interface::get_axis (p->item_p_) == X_AXIS
-		  && !p->item_p_->parent_l (Y_AXIS))
-		p->item_p_->set_parent (info.elem_l_, Y_AXIS);
-	    }
-	  if (Stem::has_interface (info.elem_l_))
-	    {
-	      Side_position_interface::add_support (p->item_p_,info.elem_l_);
-	    }
+	      Side_position_interface::add_support (p->line_spanner_, info.grob_);
+	      
+	      add_bound_item (p->line_spanner_,info.grob_);
+	    }	  
+	  if (p->bracket_)
+	    add_bound_item (p->bracket_,info.grob_);		  
+	  
 	}
     }
 }
@@ -107,14 +150,28 @@ Piano_pedal_engraver::acknowledge_grob (Grob_info info)
 bool
 Piano_pedal_engraver::try_music (Music *m)
 {
-  if (Span_req * s = dynamic_cast<Span_req*> (m))
+  if (m->is_mus_type ("abort-event"))
+    {
+      for (Pedal_info*p = info_list_; p->name_; p ++)
+	{
+	  p->req_l_drul_[START] = 0;
+	  p->req_l_drul_[STOP] = 0;
+	  
+	      if (p->bracket_)
+		p->bracket_->suicide (); /* as in dynamic-engraver.cc */
+	      p->bracket_ = 0;
+	    }
+    }
+  else if  (m->is_mus_type ("pedal-event"))
     {
       for (Pedal_info*p = info_list_; p->name_; p ++)
 	{
-	  if (scm_equal_p (s->get_mus_property ("span-type"),
-			   ly_str02scm (p->name_))==SCM_BOOL_T)
+	  String nm = p->name_ + String ("Event");
+	  if (gh_equal_p (m->get_mus_property ("name") ,
+			  scm_makfrom0str (nm.to_str0())))
 	    {
-	      p->req_l_drul_[s->get_span_dir ()] = s;
+	      Direction d = to_dir (m->get_mus_property ("span-direction"));
+	      p->req_l_drul_[d] = m;
 	      return true;
 	    }
 	}
@@ -123,80 +180,279 @@ Piano_pedal_engraver::try_music (Music *m)
 }
 
 void
-Piano_pedal_engraver::create_grobs ()
+Piano_pedal_engraver::process_acknowledged_grobs ()
 {
   for (Pedal_info*p = info_list_; p && p->name_; p ++)
     {
-      if (p->item_p_ || ! (p->req_l_drul_[STOP] || p->req_l_drul_[START]))
-	continue;
-      
-      SCM s = SCM_EOL;
-      SCM strings = get_property (("pedal" + String (p->name_) + "Strings").ch_C ());
-      if (scm_ilength (strings) < 3)
-	continue;
-      
-      if (p->req_l_drul_[STOP] && p->req_l_drul_[START])
+      if (p->req_l_drul_[STOP] || p->req_l_drul_[START])
 	{
-	  if (!p->start_req_l_)
+	  if (!p->line_spanner_)
 	    {
-	      p->req_l_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: %s",  p->name_));
+	      String name  = String (p->name_) + "PedalLineSpanner";
+	      p->line_spanner_ = new Spanner (get_property (name.to_str0 ()));
+
+	      
+	      Music * rq = (p->req_l_drul_[START]  ?  p->req_l_drul_[START]  :  p->req_l_drul_[STOP]);
+	      announce_grob (p->line_spanner_, rq->self_scm ());
 	    }
-	  else
+      
+	  /* Choose the appropriate grobs to add to the line spanner
+	   These can be text items or text-spanners
+	  */
+	  SCM type = ly_cdr (scm_assoc (ly_symbol2scm ("pedal-type"), 
+					get_property ( (String (p->name_) + "Pedal").to_str0 ())));
+	  if (type == ly_symbol2scm ("text") ||      // Ped.     *Ped.  *
+	      type == ly_symbol2scm ("mixed")  )    // Ped. _____/\____|
 	    {
-	      s = gh_cadr (strings);
+	      if (! p->item_)
+		create_text_grobs (p, type);
 	    }
-	  p->start_req_l_ = p->req_l_drul_[START];
+	  if (type == ly_symbol2scm ("bracket") ||   // |_________/\____|
+	      type == ly_symbol2scm ("mixed")  )
+	   {
+	     create_bracket_grobs (p, type);
+	   }
 	}
-      else if (p->req_l_drul_[STOP])
+    }
+}
+
+
+void
+Piano_pedal_engraver::create_text_grobs (Pedal_info *p, SCM pedaltype)
+{
+  SCM b;
+  SCM s = SCM_EOL;
+  SCM strings = get_property ( ("pedal" + String (p->name_) + "Strings").to_str0 ());
+
+  if (scm_ilength (strings) >= 3)
+    {
+      if (p->req_l_drul_[STOP] && p->req_l_drul_[START]) 
 	{
-	  if (!p->start_req_l_)
+	  if (pedaltype == ly_symbol2scm ("text")) 
 	    {
-	      p->req_l_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: %s", p->name_));
+	      if (!p->start_req_)
+		{
+		  p->req_l_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'",  p->name_));
+		}
+	      else
+		{
+		  s = ly_cadr (strings);
+		}
+	      p->start_req_ = p->req_l_drul_[START];
 	    }
-	  else
+	}
+      else if (p->req_l_drul_[STOP])
+	{ 
+	  if (pedaltype == ly_symbol2scm ("text"))
 	    {
-	      s = gh_car (strings);
+	      if (!p->start_req_)
+		{
+		  p->req_l_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_));
+		}
+	      else
+		{
+		  s = ly_caddr (strings);
+		  spanner_count_ --;
+		}
+	      p->start_req_ = 0;
 	    }
-	  p->start_req_l_ = 0;
 	}
       else if (p->req_l_drul_[START])
 	{
-	  p->start_req_l_ = p->req_l_drul_[START];
-	  s = gh_caddr (strings);
+	  p->start_req_ = p->req_l_drul_[START];
+	  s = ly_car (strings);
+	  if (pedaltype == ly_symbol2scm ("text"))
+	    {
+	      spanner_count_ ++;
+	      previous_[spanner_count_] = p->line_spanner_;
+	      if (spanner_count_ > 1)
+		// add extra space below the previous already-occuring pedal
+		Side_position_interface::add_support (p->line_spanner_,
+						     previous_[spanner_count_ - 1]);
+	    }
 	}
-
+      
       if (gh_string_p (s))
 	{
 	  String propname = String (p->name_) + "Pedal";
-	  p->item_p_ = new Item (get_property (propname.ch_C ()));
-	  p->item_p_->set_grob_property ("text", s);
+	  b = get_property (propname.to_str0 ());
+	  p->item_ = new Item (b);
+	  p->item_->set_grob_property ("text", s);
+	  Axis_group_interface::add_element (p->line_spanner_, p->item_);
+	  
+	  announce_grob (p->item_,
+			 (p->req_l_drul_[START]
+			 ? p->req_l_drul_[START]
+			 : p->req_l_drul_[STOP])->self_scm ());
+	  
+	}
+      if (pedaltype == ly_symbol2scm ("text")) 
+	{
+	  p->req_l_drul_[START] = 0;
+	  p->req_l_drul_[STOP] = 0;
+	}
+    }
+}
+
+void
+Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, SCM pedaltype)
+{
 
-	  announce_grob (p->item_p_,
-			    p->req_l_drul_[START]
-			    ? p->req_l_drul_[START]
-			    : p->req_l_drul_[STOP]);
+  if (p->req_l_drul_[STOP])
+    {
+      if (!p->start_req_)
+	{
+	  p->req_l_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_));
 	}
-      p->req_l_drul_[START] = 0;
-      p->req_l_drul_[STOP] = 0;
+      else if (!p->req_l_drul_[START])
+	spanner_count_ -- ;
+
+      assert (!p->finished_bracket_ && p->bracket_);
+
+      Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
+      p->bracket_->set_bound (RIGHT, cmc);
+
+      /*
+	Set properties so that the molecule-creating function will
+	know whether the right edge should be flared ___/
+       */
+      SCM eleft = ly_car (p->bracket_->get_grob_property ("edge-widen"));
+      SCM eright = (p->req_l_drul_[START]  ? edge_width_drul_[RIGHT] : gh_double2scm (0));
+      p->bracket_->set_grob_property ("edge-widen", gh_cons (eleft, eright));
+      
+      p->finished_bracket_ = p->bracket_;
+      p->bracket_ = 0;
+      p->current_bracket_req_ = 0;
+      p->start_req_ = p->req_l_drul_[START];
     }
+
+  if (p->req_l_drul_[START])
+    {
+      p->start_req_ = p->req_l_drul_[START];
+      p->current_bracket_req_ = p->req_l_drul_[START];
+
+      p->bracket_  = new Spanner (get_property ("PianoPedalBracket"));
+
+      /*
+	Set properties so that the molecule-creating function will
+	know whether the left edge should be flared \___
+      */
+
+      SCM ew = p->bracket_->get_grob_property ("edge-widen");
+      edge_width_drul_[LEFT] =  ly_car (ew);
+      edge_width_drul_[RIGHT] = ly_cdr (ew);
+      
+      SCM eleft = ( (bool) p->req_l_drul_[STOP]  ? 
+		    edge_width_drul_[LEFT]  :
+		    gh_double2scm (0));
+      SCM eright = gh_double2scm (0);
+      p->bracket_->set_grob_property ("edge-widen", gh_cons (eleft, eright));
+
+      /* Set this property for 'mixed style' pedals,    Ped._______/\ ,  
+        so the molecule function will shorten the ____ line by the length of the Ped. text.
+      */
+      
+      p->bracket_->set_grob_property ("text-start", 
+				       pedaltype == ly_symbol2scm ("mixed") ? 
+				       gh_bool2scm ( (bool) ! p->req_l_drul_[STOP]) :
+				       gh_bool2scm (false));
+
+      /*
+	Mixed style: Store a pointer to the preceding text for use in
+	calculating the length of the line 
+      */
+      if (p->item_)
+	p->bracket_->set_grob_property ("pedal-text", p->item_->self_scm ());
+      
+      p->bracket_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
+      Axis_group_interface::add_element (p->line_spanner_, p->bracket_);	      
+
+      add_bound_item (p->line_spanner_, p->bracket_->get_bound (LEFT));
+      announce_grob (p->bracket_, p->req_l_drul_[START]->self_scm ());
+
+      if (!p->req_l_drul_[STOP])
+	{
+	  spanner_count_ ++;
+	  previous_[spanner_count_] = p->line_spanner_;	
+
+	  if (spanner_count_ > 1) 
+	    // position new pedal spanner below the current one
+	    Side_position_interface::add_support (p->line_spanner_, previous_[spanner_count_ - 1]);
+	}
+    }
+
+  p->req_l_drul_[START] = 0;
+  p->req_l_drul_[STOP] = 0;
 }
 
+void
+Piano_pedal_engraver::finalize ()
+{  
+  for (Pedal_info*p = info_list_; p && p->name_; p ++)
+    {
+      /*
+	suicide?
+       */
+      if (p->line_spanner_
+	  && !p->line_spanner_->live())
+	p->line_spanner_ = 0;
+      
+      if (p->line_spanner_)
+	{
+	  p->finished_line_spanner_ = p->line_spanner_;
+	  typeset_all ();
+	}
+      if (p->bracket_
+	  && !p->bracket_->live())
+	p->bracket_ = 0;
+      if (p->bracket_)
+	{
+	  p->current_bracket_req_->origin ()->warning (_ ("unterminated pedal bracket"));
+	  p->bracket_->suicide ();
+	  p->bracket_ = 0;
+	}
+    }
+}
+
+  
 void
 Piano_pedal_engraver::stop_translation_timestep ()
 {
-  Item * sustain = 0;
-  for (Pedal_info*p = info_list_; p->name_; p ++)
+  for (Pedal_info*p = info_list_; p && p->name_; p ++)
     {
-      if (p->name_ == String ("Sustain"))
-	sustain = p->item_p_;
+      if (!p->bracket_)
+	{
+	  p->finished_line_spanner_ = p->line_spanner_;
+	  p->line_spanner_ = 0;
+	}
     }
+  
+  typeset_all ();
+}
 
+
+void
+Piano_pedal_engraver::typeset_all ()
+{
+  Item * sustain = 0;
   for (Pedal_info*p = info_list_; p->name_; p ++)
     {
-      if (p->item_p_)
+      /*
+	Handle suicide. 
+       */
+      if (p->finished_line_spanner_
+	  && !p->finished_line_spanner_->live ())
+	p->finished_line_spanner_ = 0;
+      if (p->finished_bracket_
+	  && !p->finished_bracket_->live())
+	p->finished_bracket_ = 0;
+
+
+      if (p->name_ == String ("Sustain"))
+	sustain = p->item_;
+
+      if (p->item_)
 	{
-	  Side_position_interface::add_staff_support (p->item_p_);
-	  
 	  /*
 	    Hmm.
 	  */
@@ -204,12 +460,45 @@ Piano_pedal_engraver::stop_translation_timestep ()
 	    {
 	      if (sustain)
 		{
-		  Side_position_interface::add_support (p->item_p_,sustain);
+		  Side_position_interface::add_support (p->item_,sustain);
 		}
 	    }
-	  typeset_grob (p->item_p_);
+	  typeset_grob (p->item_);
+	  p->item_ = 0;
+	}
+      
+      if (p->finished_bracket_)
+	{
+	  Grob * l = p->finished_bracket_->get_bound (LEFT);
+	  Grob * r = p->finished_bracket_->get_bound (RIGHT);      
+	  if (!r)
+	    {
+	      p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
+	    }
+
+	  typeset_grob (p->finished_bracket_);
+	  p->finished_bracket_ =0;
+	}
+
+      if (p->finished_line_spanner_)
+	{
+	  Side_position_interface::add_staff_support (p->finished_line_spanner_);
+	  Grob * l = p->finished_line_spanner_->get_bound (LEFT);
+	  Grob * r = p->finished_line_spanner_->get_bound (RIGHT);      
+	  if (!r && l)
+	    p->finished_line_spanner_->set_bound (RIGHT, l);
+	  else if (!l && r)
+	    p->finished_line_spanner_->set_bound (LEFT, r);
+	  else if (!r && !l)
+	    {
+	      Grob * cc = unsmob_grob (get_property ("currentMusicalColumn"));
+	      Item * ci = dynamic_cast<Item*> (cc);
+	      p->finished_line_spanner_->set_bound (RIGHT, ci);
+	      p->finished_line_spanner_->set_bound (LEFT, ci);	  
+	    }
+	  typeset_grob (p->finished_line_spanner_);
+	  p->finished_line_spanner_ = 0;
 	}
-      p->item_p_ = 0;
     }
 }
 
@@ -222,3 +511,10 @@ Piano_pedal_engraver::start_translation_timestep ()
       p->req_l_drul_[START] = 0;
     }
 }
+ENTER_DESCRIPTION (Piano_pedal_engraver,
+/* descr */       "Engrave piano pedal symbols and brackets.",
+/* creats*/       "SostenutoPedal SustainPedal UnaCordaPedal SostenutoPedalLineSpanner SustainPedalLineSpanner UnaCordaPedalLineSpanner",
+/* accepts */     "pedal-event abort-event",
+/* acks  */      "note-column-interface",
+/* reads */       "pedalSostenutoStrings pedalSustainStrings pedalUnaCordaStrings",
+/* write */       "");