]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/volta-engraver.cc
2003 -> 2004
[lilypond.git] / lily / volta-engraver.cc
index ed97955f7c46c73fbc3f52003bb4d85c022b890d..7e2b3376a34eed2403a239be03aa819fcfefe993 100644 (file)
@@ -3,17 +3,19 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2000--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
 #include "engraver.hh"
 #include "translator-group.hh"
-#include "volta-spanner.hh"
+#include "volta-bracket.hh"
 #include "item.hh"
 #include "note-column.hh"
-#include "bar.hh"
+#include "bar-line.hh"
 #include "side-position-interface.hh"
+#include "warn.hh"
+#include "staff-symbol.hh"
 
 /*
   Create Volta spanners, by reading repeatCommands  property, usually
 class Volta_engraver : public Engraver
 {
 public:
-  Volta_engraver();
-  VIRTUAL_COPY_CONS(Translator);
+  TRANSLATOR_DECLARATIONS(Volta_engraver);
 protected:
 
-  virtual void acknowledge_element (Score_element_info);
-  virtual void do_removal_processing ();
-  virtual void do_pre_move_processing ();
-  virtual void do_process_music ();
-
+  virtual void acknowledge_grob (Grob_info);
+  virtual void finalize ();
+  virtual void stop_translation_timestep ();
+  virtual void process_music ();
+  
   Moment started_mom_;
-  Spanner * volta_span_p_;
-  Spanner* end_volta_span_p_;
-};
+  Spanner *volta_span_;
+  Spanner *end_volta_span_;
+  SCM staff_;
+  SCM start_string_;
 
-ADD_THIS_TRANSLATOR(Volta_engraver);
+  bool staff_eligible ();
+};
 
 Volta_engraver::Volta_engraver ()
 {
-  volta_span_p_ = 0;
-  end_volta_span_p_ = 0;
+  staff_ = SCM_EOL;
+  volta_span_ = 0;
+  end_volta_span_ = 0;
+}
+
+
+/*
+  TODO: this logic should be rewritten, it is buggy.
+
+  One of the problems is that we can't determine wether or not to
+  print the volta bracket during the first step, since that requires
+  acknowledging the staff.
+ */
+bool
+Volta_engraver::staff_eligible ()
+{
+  /*
+    UGH.
+   */
+  if (!unsmob_grob (staff_))
+    return true;
+  
+  if (!to_boolean (get_property ("voltaOnThisStaff")))
+    {
+      /*
+       TODO: this does weird things when you open a piece with a
+       volta spanner.
+       
+       */
+      SCM staffs = get_property ("stavesFound");
+
+      /*
+       only put a volta on the top staff.
+       
+       May be this is a bit convoluted, and we should have a single
+       volta engraver in score context or somesuch.
+       
+      */
+      if (!gh_pair_p (staffs))
+       {
+         programming_error ("Huh? Volta engraver can't find staffs?");
+         return false;
+       }
+      else if (ly_car (scm_last_pair (staffs)) != staff_)
+       {
+         return false;
+       }
+    }
+  return true;
 }
 
 void
-Volta_engraver::do_process_music ()
+Volta_engraver::process_music ()
 {
   SCM cs = get_property ("repeatCommands");
 
-  SCM str = SCM_EOL; 
-  bool end = false;
+  if (!staff_eligible ())
+    return ; 
+
+    
+  bool  end = false;
+  start_string_ = SCM_EOL;
   while (gh_pair_p (cs))
     {
-      SCM c = gh_car (cs);
+      SCM c = ly_car (cs);
 
-      if (gh_pair_p (c) && gh_car (c) == ly_symbol2scm ("volta"))
+      if (gh_pair_p (c)
+         && ly_car (c) == ly_symbol2scm ("volta")
+         && gh_pair_p (ly_cdr (c)))
        {
-         if (gh_cadr (c) ==  SCM_BOOL_F)
+         if (ly_cadr (c) ==  SCM_BOOL_F)
            end = true;
          else
-           str = gh_cadr (c);
+           start_string_ = ly_cadr (c);
        }
       
-      cs = gh_cdr (cs);
+      cs = ly_cdr (cs);
     }
 
-  SCM l (get_property ("voltaSpannerDuration"));
-  Moment now = now_mom ();
+  if (volta_span_)
+    {
+      SCM l (get_property ("voltaSpannerDuration"));
+      Moment now = now_mom ();
   
-  bool early_stop = volta_span_p_ &&    unsmob_moment (l)
-    &&*unsmob_moment (l) <= now - started_mom_;
+      bool early_stop = unsmob_moment (l)
+       && *unsmob_moment (l) <= now - started_mom_;
+      
+      end = end || early_stop;
+    }
 
-  if (end || early_stop)
+  
+  if (end && !volta_span_)
     {
-      end_volta_span_p_ = volta_span_p_;
-      volta_span_p_ =0;
-
-      /*
-       maybe do typeset_element () directly?
-      */
-
-      if (!gh_string_p (str))
-       end_volta_span_p_->set_elt_property ("last-volta", SCM_BOOL_T);
+      warning (_ ("No volta spanner to end")); // fixme: be more verbose.
+    }
+  else if (end)
+    {
+      end_volta_span_ = volta_span_;
+      volta_span_ =0;
     }
 
-  if (gh_string_p (str))
+  if (volta_span_ && 
+      (gh_string_p (start_string_) || gh_pair_p (start_string_)))
     {
-      started_mom_ = now;
-      if (volta_span_p_)
+      warning (_ ("Already have a volta spanner.  Stopping that one prematurely."));
+      
+      if (end_volta_span_)
        {
-         warning (_ ("Already have a volta spanner. Stopping that one prematurely."));
-
-         if (end_volta_span_p_)
-           {
-             warning (_("Also have a stopped spanner. Giving up."));
+         warning (_ ("Also have a stopped spanner.  Giving up."));
+         return ;
+       }
 
-             return ;
+      end_volta_span_ = volta_span_;
+      volta_span_ = 0;
+    }
 
-           }
+  if (!volta_span_ && 
+      (gh_string_p (start_string_) || gh_pair_p (start_string_)))
+    {
+      started_mom_ = now_mom () ;
 
-                    
-         end_volta_span_p_ = volta_span_p_;
-         volta_span_p_ = 0;
-       }
+      volta_span_ = make_spanner ("VoltaBracket");
 
-      volta_span_p_ = new Spanner (get_property ("basicVoltaBracketProperties"));
-      Volta_spanner::set_interface (volta_span_p_);
-      announce_element (volta_span_p_,0);
-      volta_span_p_->set_elt_property ("text", str);
+      announce_grob (volta_span_, SCM_EOL);
+      volta_span_->set_grob_property ("text", start_string_);
     }
 }
 
+
 void
-Volta_engraver::acknowledge_element (Score_element_info i)
+Volta_engraver::acknowledge_grob (Grob_info i)
 {
-  if (Item* item = dynamic_cast<Item*> (i.elem_l_))
+  if (Item* item = dynamic_cast<Item*> (i.grob_))
     {
       if (Note_column::has_interface (item))
        {
-         if (volta_span_p_)
-           Volta_spanner::add_column (volta_span_p_,item);
-         if (end_volta_span_p_)
-           Volta_spanner::add_column (end_volta_span_p_,item);      
+         if (volta_span_)
+           Volta_bracket_interface::add_column (volta_span_,item);
        }
-      if (Bar::has_interface (item))
+      if (Bar_line::has_interface (item))
        {
-         if (volta_span_p_)
-           Volta_spanner::add_bar (volta_span_p_, item);
-         if (end_volta_span_p_)
-           Volta_spanner::add_bar(end_volta_span_p_ , item);
+         if (volta_span_)
+           Volta_bracket_interface::add_bar (volta_span_, item);
+         if (end_volta_span_)
+           Volta_bracket_interface::add_bar (end_volta_span_ , item);
        }
     }
+  else if (Staff_symbol::has_interface (i.grob_))
+    {
+      /*
+       We only want to know about a single staff: then we add to the
+       support.  */
+      if (staff_ != SCM_EOL)
+       staff_ = SCM_UNDEFINED;
+
+      if (staff_ != SCM_UNDEFINED)
+       staff_ = i.grob_->self_scm();
+    }
 }
 
 void
-Volta_engraver::do_removal_processing ()
+Volta_engraver::finalize ()
 {
-  if (volta_span_p_)
+  if (volta_span_)
     {
-      typeset_element(volta_span_p_);
+      typeset_grob (volta_span_);
     }
-  if (end_volta_span_p_)
+  if (end_volta_span_)
     {
-      typeset_element (end_volta_span_p_);
+      typeset_grob (end_volta_span_);
     }
 }
 
+
+
 void 
-Volta_engraver::do_pre_move_processing ()
+Volta_engraver::stop_translation_timestep ()
 {
-  if (end_volta_span_p_)
+  if (volta_span_ && !staff_eligible ())
     {
-      Side_position::add_staff_support (end_volta_span_p_);
+      /*
+       THIS IS A KLUDGE.
+
+       we need to do this here, because STAFF_ is not initialized yet
+       in the 1st call of process_music()
+      */
       
-      typeset_element (end_volta_span_p_ );
-      end_volta_span_p_ =0;
+      volta_span_->suicide( );
+      volta_span_ = 0;
+    }
+  
+  if (end_volta_span_)
+    {
+      typeset_grob (end_volta_span_);
+      end_volta_span_ =0;
     }
 }
+
+/*
+  TODO: should attach volta to paper-column if no bar is found.
+ */
+
+ENTER_DESCRIPTION(Volta_engraver,
+/* descr */       "Make volta brackets",
+/* creats*/       "VoltaBracket",
+/* accepts */     "",
+/* acks  */       "bar-line-interface staff-symbol-interface note-column-interface",
+/* reads */       "repeatCommands voltaSpannerDuration stavesFound",
+/* write */       "");