]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/piano-pedal-engraver.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / piano-pedal-engraver.cc
index f04f31c413e91a90892226400bb3a32202cc3974..80677d7829df397627c0e494319d59a0cad17a93 100644 (file)
@@ -1,69 +1,60 @@
-/*   
-  piano-pedal-engraver.cc --  implement Piano_pedal_engraver
-  
+/*
+  piano-pedal-engraver.cc -- implement Piano_pedal_engraver
+
   source file of the GNU LilyPond music typesetter
-  
(c) 2000--2004 Jan Nieuwenhuizen <janneke@gnu.org>
-  
+
 (c) 2000--2006 Jan Nieuwenhuizen <janneke@gnu.org>
+
   Chris Jackson <chris@fluffhouse.org.uk> - extended to support
   bracketed pedals.
 */
 
 #include "engraver.hh"
-#include "event.hh"
-#include "grob.hh"
-#include "item.hh"
 #include "lily-guile.hh"
 #include "side-position-interface.hh"
 #include "staff-symbol-referencer.hh"
-#include "item.hh"
 #include "axis-group-interface.hh"
 #include "context.hh"
-
 #include "directional-element-interface.hh"
 #include "note-column.hh"
 #include "warn.hh"
 
 /*
   Urgh. This engraver is too complex. rewrite. --hwn
-
 */
 
 struct Pedal_info
 {
-  char const * name_;
+  char const *name_;
 
   /*
     Event for currently running pedal.
   */
-  Musiccurrent_bracket_ev_;
+  Music *current_bracket_ev_;
 
   /*
     Event for currently starting pedal, (necessary?
-    
+
     distinct from current_bracket_ev_, since current_bracket_ev_ only
     necessary for brackets, not for text style.
-   */
-  Music* start_ev_;
-
+  */
+  Music *start_ev_;
 
-  
   /*
     Events that were found in this timestep.
-   */
-  Drul_array<Music*> event_drul_;
-  Itemitem_;
-  Spanner* bracket_;     // A single portion of a pedal bracket
-  Spannerfinished_bracket_;
+  */
+  Drul_array<Music *> event_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
-   */
-  Spannerline_spanner_;
-  Spannerfinished_line_spanner_;
+  */
+  Spanner *line_spanner_;
+  Spanner *finished_line_spanner_;
 };
 
-
 class Piano_pedal_engraver : public Engraver
 {
 public:
@@ -72,10 +63,10 @@ public:
 protected:
   virtual void initialize ();
   virtual void finalize ();
-  virtual bool try_music (Music*);
-  virtual void stop_translation_timestep ();
-  virtual void acknowledge_grob (Grob_info);
-  virtual void process_music ();
+  virtual bool try_music (Music *);
+  void stop_translation_timestep ();
+  DECLARE_ACKNOWLEDGER (note_column);
+  void process_music ();
 
 private:
 
@@ -85,15 +76,15 @@ private:
     Record a stack of the current pedal spanners, so if more than one pedal
     occurs simultaneously then extra space can be added between them.
   */
-  
+
   Link_array<Spanner> previous_;
-  
+  void del_linespanner (Spanner *);
+
   void create_text_grobs (Pedal_info *p, bool);
   void create_bracket_grobs (Pedal_info *p, bool);
-  void typeset_all ();
+  void typeset_all (Pedal_info *p);
 };
 
-
 Piano_pedal_engraver::Piano_pedal_engraver ()
 {
   info_list_ = 0;
@@ -102,14 +93,12 @@ Piano_pedal_engraver::Piano_pedal_engraver ()
 void
 Piano_pedal_engraver::initialize ()
 {
-  previous_.clear ();
+  char *names [] = { "Sostenuto", "Sustain", "UnaCorda", 0 };
 
-  char * names [] = { "Sostenuto", "Sustain", "UnaCorda", 0  };
-
-  info_list_ = new Pedal_info[sizeof (names)/ sizeof (const char*)]; 
+  info_list_ = new Pedal_info[sizeof (names) / sizeof (char const *)];
   Pedal_info *p = info_list_;
 
-  char **np = names ;
+  char **np = names;
   do
     {
       p->name_ = *np;
@@ -125,7 +114,7 @@ Piano_pedal_engraver::initialize ()
 
       p++;
     }
-  while (* (np ++));
+  while (* (np++));
 }
 
 Piano_pedal_engraver::~Piano_pedal_engraver ()
@@ -134,39 +123,36 @@ Piano_pedal_engraver::~Piano_pedal_engraver ()
 }
 
 /*
-   Urg: Code dup
-   I'm a script
-  */
+  Urg: Code dup
+  I'm a script
+*/
 void
-Piano_pedal_engraver::acknowledge_grob (Grob_info info)
+Piano_pedal_engraver::acknowledge_note_column (Grob_info info)
 {
-  for (Pedal_info*p = info_list_; p && p->name_; p ++)
+  for (Pedal_info *p = info_list_; p && p->name_; p++)
     {
-      if (Note_column::has_interface (info.grob_))
+      if (p->line_spanner_)
        {
-         if (p->line_spanner_)
-           {
-             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_);
-         if (p->finished_bracket_)
-           add_bound_item (p->finished_bracket_,info.grob_);             
+         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 ());
+      if (p->finished_bracket_)
+       add_bound_item (p->finished_bracket_, info.grob ());
     }
 }
 
 bool
 Piano_pedal_engraver::try_music (Music *m)
 {
if  (m->is_mus_type ("pedal-event"))
 if (m->is_mus_type ("pedal-event"))
     {
-      for (Pedal_info*p = info_list_; p->name_; p ++)
+      for (Pedal_info *p = info_list_; p->name_; p++)
        {
          String nm = p->name_ + String ("Event");
-         if (gh_equal_p (m->get_property ("name") ,
-                         gh_symbol2scm (nm.to_str0())))
+         if (ly_is_equal (m->get_property ("name"),
+                          scm_str2symbol (nm.to_str0 ())))
            {
              Direction d = to_dir (m->get_property ("span-direction"));
              p->event_drul_[d] = m;
@@ -180,47 +166,43 @@ Piano_pedal_engraver::try_music (Music *m)
 void
 Piano_pedal_engraver::process_music ()
 {
-  for (Pedal_info*p = info_list_; p && p->name_; p ++)
+  for (Pedal_info *p = info_list_; p && p->name_; p++)
     {
       if (p->event_drul_[STOP] || p->event_drul_[START])
        {
          if (!p->line_spanner_)
            {
-             String name  = String (p->name_) + "PedalLineSpanner";
-             p->line_spanner_ = make_spanner (name.to_str0 ());
-
-             Music * rq = (p->event_drul_[START]  ?  p->event_drul_[START]  :  p->event_drul_[STOP]);
-             announce_grob (p->line_spanner_, rq->self_scm ());
+             String name = String (p->name_) + "PedalLineSpanner";
+             Music *rq = (p->event_drul_[START] ? p->event_drul_[START] : p->event_drul_[STOP]);
+             p->line_spanner_ = make_spanner (name.to_str0 (), rq->self_scm ());
            }
-      
+
          /* Choose the appropriate grobs to add to the line spanner
-          These can be text items or text-spanners
+            These can be text items or text-spanners
          */
 
          /*
            ugh, code dup, should read grob to create from other
            property.
 
-             bracket: |_________/\____|
-             text:    Ped.     *Ped.  *
-             mixed:   Ped. _____/\____|
-          */
-
+           bracket: |_________/\____|
+           text:    Ped.     *Ped.  *
+           mixed:   Ped. _____/\____|
+         */
 
-         String prop = String ("pedal")  + p->name_ + "Style";
+         String prop = String ("pedal") + p->name_ + "Style";
          SCM style = get_property (prop.to_str0 ());
+
          bool mixed = style == ly_symbol2scm ("mixed");
-         if (style == ly_symbol2scm ("text") ||
-             mixed)    
-           {
-             if (! p->item_)
-               create_text_grobs (p, mixed);
-           }
-         if (style == ly_symbol2scm ("bracket") ||
-             mixed)
-          {
-            create_bracket_grobs (p, mixed);
-          }
+         bool bracket = (mixed
+                         || style == ly_symbol2scm ("bracket"));
+         bool text = (style == ly_symbol2scm ("text")
+                      || mixed);
+
+         if (text && !p->item_)
+           create_text_grobs (p, mixed);
+         if (bracket)
+           create_bracket_grobs (p, mixed);
        }
     }
 }
@@ -229,58 +211,49 @@ void
 Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
 {
   SCM s = SCM_EOL;
-  SCM strings = get_property ( ("pedal" + String (p->name_) + "Strings").to_str0 ());
+  SCM strings = get_property (("pedal" + String (p->name_) + "Strings").to_str0 ());
 
   if (scm_ilength (strings) < 3)
     {
-      Music * m =       p->event_drul_[START]; 
+      Music *m = p->event_drul_[START];
       if (!m) m = p->event_drul_ [STOP];
 
-      String msg = _ ("Need 3 strings for piano pedals. No pedal made. ");
+      String msg = _f ("expect 3 strings for piano pedals, found: %d",
+                      scm_ilength (strings));
       if (m)
        m->origin ()->warning (msg);
       else
        warning (msg);
-      
-      return ;
+
+      return;
     }
-  
-  if (p->event_drul_[STOP] && p->event_drul_[START]) 
+
+  if (p->event_drul_[STOP] && p->event_drul_[START])
     {
       if (!mixed)
        {
          if (!p->start_ev_)
-           {
-             p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'",  p->name_));
-           }
+           p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_));
          else
-           {
-             s = ly_cadr (strings);
-           }
+           s = scm_cadr (strings);
          p->start_ev_ = p->event_drul_[START];
        }
     }
   else if (p->event_drul_[STOP])
-    { 
+    {
       if (!mixed)
        {
          if (!p->start_ev_)
-           {
-             p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_));
-           }
+           p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_));
          else
-           {
-             s = ly_caddr (strings);
-             if (previous_.size ())
-               previous_.pop ();
-           }
+           s = scm_caddr (strings);
          p->start_ev_ = 0;
        }
     }
   else if (p->event_drul_[START])
     {
       p->start_ev_ = p->event_drul_[START];
-      s = ly_car (strings);
+      s = scm_car (strings);
       if (!mixed)
        {
          /*
@@ -290,22 +263,20 @@ Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
            // add extra space below the previous already-occuring pedal
            Side_position_interface::add_support (p->line_spanner_,
                                                  previous_.top ());
-         previous_.push ( p->line_spanner_);
+         previous_.push (p->line_spanner_);
        }
     }
-      
-  if (gh_string_p (s))
+
+  if (scm_is_string (s))
     {
       String propname = String (p->name_) + "Pedal";
 
-      p->item_ = make_item (propname.to_str0 ());
+      p->item_ = make_item (propname.to_str0 (), (p->event_drul_[START]
+                                                 ? p->event_drul_[START]
+                                                 : p->event_drul_[STOP])->self_scm ());
+
       p->item_->set_property ("text", s);
       Axis_group_interface::add_element (p->line_spanner_, p->item_);
-         
-      announce_grob (p->item_,
-                    (p->event_drul_[START]
-                     ? p->event_drul_[START]
-                     : p->event_drul_[STOP])->self_scm ());
     }
 
   if (!mixed)
@@ -320,20 +291,14 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
 {
   if (!p->bracket_ && p->event_drul_[STOP])
     {
-      String msg =_f ("can't find start of piano pedal bracket: `%s'", p->name_);
+      String msg = _f ("can't find start of piano pedal bracket: `%s'", p->name_);
       p->event_drul_[STOP]->origin ()->warning (msg);
-      p->event_drul_[STOP] =  0;
+      p->event_drul_[STOP] = 0;
     }
 
   if (p->event_drul_[STOP])
     {
-      if (!p->event_drul_[START])
-       {
-         if (previous_.size ())
-           previous_.pop ();
-       }
-      
-      assert (!p->finished_bracket_); 
+      assert (!p->finished_bracket_);
 
       Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
 
@@ -343,13 +308,13 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
       /*
        Set properties so that the stencil-creating function will
        know whether the right edge should be flared ___/
-       */
+      */
 
       if (!p->event_drul_[START])
        {
          SCM flare = p->bracket_->get_property ("bracket-flare");
-         p->bracket_->set_property ("bracket-flare", scm_cons (gh_car (flare),
-                                                                    gh_double2scm (0)));
+         p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare),
+                                                               scm_from_double (0)));
        }
 
       p->finished_bracket_ = p->bracket_;
@@ -362,7 +327,7 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
       p->start_ev_ = p->event_drul_[START];
       p->current_bracket_ev_ = p->event_drul_[START];
 
-      p->bracket_  = make_spanner ("PianoPedalBracket");
+      p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
 
       /*
        Set properties so that the stencil-creating function will
@@ -372,12 +337,11 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
       if (!p->finished_bracket_)
        {
          SCM flare = p->bracket_->get_property ("bracket-flare");
-         p->bracket_->set_property ("bracket-flare", scm_cons (gh_double2scm (0),gh_cdr (flare)));
+         p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
        }
 
-
-      /* Set this property for 'mixed style' pedals,    Ped._______/\ ,  
-        so the stencil function will shorten the ____ line by the length of the Ped. text.
+      /* Set this property for 'mixed style' pedals,    Ped._______/\ ,
+        so the stencil function will shorten the ____ line by the length of the Ped. text.
       */
 
       if (mixed)
@@ -392,10 +356,9 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
            WTF is pedal-text not the bound of the object? --hwn
          */
          if (p->item_)
-           p->bracket_->set_property ("pedal-text", p->item_->self_scm ());
+           p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
        }
 
-
       /*
        We do not use currentMusicalColumn for the left span-point.
        If the column as accidentals (eg on a different stave), the
@@ -408,10 +371,9 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
        TODO:
 
        what about the right span point?
-       
-       */
-      Axis_group_interface::add_element (p->line_spanner_, p->bracket_);             
-      announce_grob (p->bracket_, p->event_drul_[START]->self_scm ());
+
+      */
+      Axis_group_interface::add_element (p->line_spanner_, p->bracket_);
 
       if (!p->event_drul_[STOP])
        {
@@ -420,11 +382,11 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
            code dup. --hwn.
 
            // position new pedal spanner below the current one
-         */
-         if (previous_.size ()) 
+           */
+         if (previous_.size ())
            Side_position_interface::add_support (p->line_spanner_, previous_.top ());
 
-         previous_.push (p->line_spanner_);    
+         previous_.push (p->line_spanner_);
        }
     }
 
@@ -434,142 +396,129 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
 
 void
 Piano_pedal_engraver::finalize ()
-{  
-  for (Pedal_info*p = info_list_; p && p->name_; p ++)
+{
+  for (Pedal_info *p = info_list_; p && p->name_; p++)
     {
       /*
        suicide?
-       */
+      */
       if (p->line_spanner_
-         && !p->line_spanner_->live ())
+         && !p->line_spanner_->is_live ())
        p->line_spanner_ = 0;
-      
+
       if (p->bracket_
-         && !p->bracket_->live ())
+         && !p->bracket_->is_live ())
        p->bracket_ = 0;
-      
+
       if (p->bracket_)
        {
          SCM cc = get_property ("currentCommandColumn");
          Item *c = unsmob_item (cc);
          if (p->line_spanner_)
-           {
-             p->line_spanner_->set_bound (RIGHT, c);
-           }
-         p->bracket_ ->set_bound (RIGHT, c);
+           p->line_spanner_->set_bound (RIGHT, c);
+         p->bracket_->set_bound (RIGHT, c);
 
          p->finished_bracket_ = p->bracket_;
          p->bracket_ = 0;
          p->finished_line_spanner_ = p->line_spanner_;
          p->line_spanner_ = 0;
-         typeset_all ();
+         typeset_all (p);
        }
 
       if (p->line_spanner_)
        {
          p->finished_line_spanner_ = p->line_spanner_;
-         typeset_all ();
+         typeset_all (p);
        }
     }
 }
 
-  
+void
+Piano_pedal_engraver::del_linespanner (Spanner *g)
+{
+  int idx = previous_.find_index (g);
+  if (idx >= 0)
+    previous_.del (idx);
+}
+
 void
 Piano_pedal_engraver::stop_translation_timestep ()
 {
-  for (Pedal_info*p = info_list_; p && p->name_; p ++)
+  for (Pedal_info *p = info_list_; p && p->name_; p++)
     {
       if (!p->bracket_)
        {
          p->finished_line_spanner_ = p->line_spanner_;
          p->line_spanner_ = 0;
+         del_linespanner (p->finished_line_spanner_);
        }
+
+      typeset_all (p);
     }
-  
-  typeset_all ();
 
-  for (Pedal_info*p = info_list_; p->name_; p ++)
+  for (Pedal_info *p = info_list_; p->name_; p++)
     {
       p->event_drul_[STOP] = 0;
       p->event_drul_[START] = 0;
     }
 }
 
-
 void
-Piano_pedal_engraver::typeset_all ()
+Piano_pedal_engraver::typeset_all (Pedal_info *p)
 {
-  Item * sustain = 0;
-  for (Pedal_info*p = info_list_; p->name_; 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;
-
+  /*
+    Handle suicide.
+  */
+  if (p->finished_line_spanner_
+      && !p->finished_line_spanner_->is_live ())
+    p->finished_line_spanner_ = 0;
+  if (p->finished_bracket_
+      && !p->finished_bracket_->is_live ())
+    p->finished_bracket_ = 0;
 
-      if (p->name_ == String ("Sustain"))
-       sustain = p->item_;
+  if (p->item_)
+    p->item_ = 0;
 
-      if (p->item_)
-       {
-         /*
-           Hmm.
-         */
-         if (p->name_ != String ("Sustain") && sustain)
-           {
-             Side_position_interface::add_support (p->item_,sustain);
-           }
-         typeset_grob (p->item_);
-         p->item_ = 0;
-       }
-      
-      if (p->finished_bracket_)
-       {
-         Grob * r = p->finished_bracket_->get_bound (RIGHT);      
-         if (!r)
-           {
-             p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
-           }
+  if (p->finished_bracket_)
+    {
+      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;
-       }
+      p->finished_bracket_ = 0;
+    }
 
-      if (p->finished_line_spanner_)
+  if (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 * 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;
+         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);
        }
+
+      p->finished_line_spanner_ = 0;
     }
 }
 
-ENTER_DESCRIPTION (Piano_pedal_engraver,
-/* descr */       "Engrave piano pedal symbols and brackets.",
-/* creats*/       "SostenutoPedal SustainPedal UnaCordaPedal SostenutoPedalLineSpanner SustainPedalLineSpanner UnaCordaPedalLineSpanner",
-/* accepts */     "pedal-event",
-/* acks  */       "note-column-interface",
-/* reads */       "currentCommandColumn "
-                  "pedalSostenutoStrings pedalSustainStrings "
-                  "pedalUnaCordaStrings pedalSostenutoStyle "
-                  "pedalSustainStyle pedalUnaCordaStyle",
-/* write */       "");
+#include "translator.icc"
+ADD_ACKNOWLEDGER (Piano_pedal_engraver, note_column);
+ADD_TRANSLATOR (Piano_pedal_engraver,
+               /* doc */ "Engrave piano pedal symbols and brackets.",
+               /* create */ "SostenutoPedal SustainPedal UnaCordaPedal SostenutoPedalLineSpanner SustainPedalLineSpanner UnaCordaPedalLineSpanner",
+               /* accept */ "pedal-event",
+               /* read */ "currentCommandColumn "
+               "pedalSostenutoStrings "
+               "pedalSustainStrings "
+               "pedalUnaCordaStrings "
+               "pedalSostenutoStyle "
+               "pedalSustainStyle "
+               "pedalUnaCordaStyle",
+               /* write */ "");