]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/clef-engraver.cc
release: 1.5.0
[lilypond.git] / lily / clef-engraver.cc
index 854456200698872a7a5b179b9d5db21bdf53dc6d..d16cb8a20b5db7a4058e5ac061b73c10bc45c429 100644 (file)
@@ -1,10 +1,9 @@
 /*
-
   clef-engraver.cc -- implement Clef_engraver
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+  (c)  1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
 
   Mats Bengtsson <matsb@s3.kth.se>
 */
 
 #include "translator-group.hh"
 #include "key-item.hh"
-#include "local-key-item.hh"
 #include "bar.hh"
-#include "note-head.hh"
 #include "staff-symbol-referencer.hh"
 #include "debug.hh"
-#include "command-request.hh"
 #include "engraver.hh"
 #include "direction.hh"
 #include "side-position-interface.hh"
 #include "item.hh"
 
-/// where is c-0 in the staff?
+
 class Clef_engraver : public  Engraver
 {
-  Item * clef_p_;
-  Item * octavate_p_;
-  Clef_change_req * clef_req_l_;
-  
-  void create_clef();
-  bool set_type (String);
-protected:
-  virtual void do_process_music();
-  virtual void do_pre_move_processing();
-  virtual void do_creation_processing();
-  virtual void do_post_move_processing();
-  virtual bool do_try_music (Music*);
-  virtual void acknowledge_element (Score_element_info);
 public:
-  VIRTUAL_COPY_CONS(Translator);
-  int c0_position_i_;
-  int clef_position_i_;
-                               // junkme.
+  VIRTUAL_COPY_CONS (Translator);
+  Clef_engraver ();
+
   Direction octave_dir_;
-  SCM clef_glyph_;             // no need for protection. Always referenced somewhere else.
-   
-  Clef_engraver();
 
-  bool  first_b_;
-};
+protected:
+  virtual void stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  virtual void process_music ();
+  virtual void acknowledge_grob (Grob_info);
+  virtual void do_creation_processing ();
+private:
+  Item * clef_p_;
+  Item * octavate_p_;
 
+  SCM prev_glyph_;
+  SCM prev_cpos_;
+  SCM prev_octavation_;
+  void create_clef ();
+  void set_glyph ();
+  void inspect_clef_properties ();
+};
 
-Clef_engraver::Clef_engraver()
+Clef_engraver::Clef_engraver ()
 {
-  first_b_ = true;
-  clef_glyph_ = SCM_EOL;
   clef_p_ = 0;
-  clef_req_l_ = 0;
-  c0_position_i_ = 0;
-  clef_position_i_ = 0;
   octave_dir_ = CENTER;
   octavate_p_ = 0;
+
+  /*
+    will trigger a clef at the start since #f != ' ()
+   */
+  prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
 }
 
-bool
-Clef_engraver::set_type (String s)
+void
+Clef_engraver::set_glyph ()
 {
-  if (s.right_str(2) == "_8") // Down one octave
-    {
-      octave_dir_ = DOWN;
-      s = s.left_str(s.length_i() - 2);
-    }
-  else if (s.right_str(2) == "^8") // Up one octave
-    {
-      octave_dir_ = UP;
-      s = s.left_str(s.length_i() - 2);
-    }
-  else
-    octave_dir_ = CENTER;
-
-  SCM c = get_property ("supportedClefTypes");
-  SCM p = get_property ("clefPitches");
-  
-  if (gh_list_p (c))
-    {
-      SCM found = scm_assoc (ly_str02scm (s.ch_C()), c);
-      if (found == SCM_BOOL_F)
-       return false;
-      
-      clef_glyph_  = gh_cadr (found);
-      SCM pos  = gh_caddr (found);
-
-      clef_position_i_ = gh_scm2int (pos);
-
-      found = scm_assoc (clef_glyph_, p);
-      if (found == SCM_BOOL_F)
-       return false;
-
-      c0_position_i_ = clef_position_i_ + gh_scm2int (gh_cdr (found));
-    }
-
-  c0_position_i_ -= (int) octave_dir_ * 7;
+  SCM glyph_sym = ly_symbol2scm ("glyph-name");
+  SCM glyph = get_property ("clefGlyph");
 
   SCM basic = ly_symbol2scm ("Clef");
-  SCM c0 = ly_symbol2scm ("c0-position");
-  SCM gl = ly_symbol2scm ("glyph");
-  daddy_trans_l_->execute_single_pushpop_property (basic, gl, SCM_UNDEFINED);
-  daddy_trans_l_->execute_single_pushpop_property (basic, c0, SCM_UNDEFINED);  
-  daddy_trans_l_->execute_single_pushpop_property (basic, gl, clef_glyph_);
-  daddy_trans_l_->execute_single_pushpop_property (basic, c0, gh_int2scm (c0_position_i_));
-
-  return true;
+  
+  daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
+  daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, glyph);
 }
 
 /** 
@@ -121,129 +76,142 @@ Clef_engraver::set_type (String s)
   ie. a breakpoint) 
   */
 void
-Clef_engraver::acknowledge_element (Score_element_info info)
+Clef_engraver::acknowledge_grob (Grob_info info)
 {
   Item * item =dynamic_cast <Item *> (info.elem_l_);
   if (item)
     {
       if (Bar::has_interface (info.elem_l_)
-         && gh_string_p (clef_glyph_))
-       create_clef();
-      
+         && gh_string_p (get_property ("clefGlyph")))
+       create_clef ();
 
-      if (Note_head::has_interface (item)
-         || Local_key_item::has_interface (item))
-       {
-         int p = int (Staff_symbol_referencer::position_f (item)) + c0_position_i_;
-         Staff_symbol_referencer::set_position (item,p);
-       }
-      else if (Key_item::has_interface (item))
+      if (Key_item::has_interface (item))
        {
-         item->set_elt_property ("c0-position", gh_int2scm (c0_position_i_));
+         /*
+           Key_item adapts its formatting to make sure that the
+           accidentals stay in the upper half of the staff. It needs
+           to know c0-pos for this. (?)
+         */
+
+         item->set_grob_property ("c0-position", get_property ("centralCPosition"));
        }
     } 
 }
 
 void
-Clef_engraver::do_creation_processing()
-{
-  SCM def = get_property ("defaultClef");
-  if (gh_string_p (def))
-    {
-      set_type (ly_scm2string (def));
-    }
-}
-
-bool
-Clef_engraver::do_try_music (Music * r_l)
-{
-  if (Clef_change_req *cl = dynamic_cast <Clef_change_req *> (r_l))
-    {
-      clef_req_l_ = cl;
-      if (!set_type (cl->clef_str_))
-       cl->origin ()->warning (_ ("unknown clef type"));
-
-      return true;
-    }
-  else
-    return false;
-
-}
-
-void
-Clef_engraver::create_clef()
+Clef_engraver::create_clef ()
 {
   if (!clef_p_)
     {
       Item *c= new Item (get_property ("Clef"));
-      announce_element (c, clef_req_l_);
+      announce_grob (c, 0);
 
       Staff_symbol_referencer::set_interface (c);
       
       clef_p_ = c;
     }
-  Staff_symbol_referencer::set_position(clef_p_, clef_position_i_);
-  if (octave_dir_)
+  Staff_symbol_referencer::set_position (clef_p_,
+                                        gh_scm2int (get_property ("clefPosition")));
+
+  SCM oct =  get_property ("clefOctavation");
+  if (gh_number_p (oct) && gh_scm2int (oct))
     {
       Item * g = new Item (get_property ("OctavateEight"));
 
-      Side_position::add_support (g,clef_p_);      
+      Side_position_interface::add_support (g,clef_p_);      
 
       g->set_parent (clef_p_, Y_AXIS);
       g->set_parent (clef_p_, X_AXIS);
 
-      g->set_elt_property ("direction", gh_int2scm (octave_dir_));
+      g->set_grob_property ("direction", gh_int2scm (sign (gh_scm2int (oct))));
       octavate_p_ = g;
-      announce_element (octavate_p_, clef_req_l_);
+      announce_grob (octavate_p_, 0);
     }
 }
 
+void
+Clef_engraver::process_music ()
+{
+  inspect_clef_properties ();
+}
+
+/*
+  this must be done in creation_proc() since grace notes will be
+  processed before Clef_engraver::prcoess_music()
+
+  Grace notes and clef changes are still broken.
+*/
+void
+Clef_engraver::do_creation_processing ()
+{
+  inspect_clef_properties ();
+}
 
 void
-Clef_engraver::do_process_music()
+Clef_engraver::inspect_clef_properties ()
 {
-  if (clef_req_l_ || first_b_)
+  SCM glyph = get_property ("clefGlyph");
+  SCM clefpos = get_property ("clefPosition");
+  SCM octavation = get_property ("clefOctavation");
+  SCM force_clef = get_property ("forceClef");
+  
+  if (clefpos == SCM_EOL
+      || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
+      || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
+      || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
+      || to_boolean (force_clef)
+)
+    {
+      set_glyph ();
+      create_clef ();
+
+      clef_p_->set_grob_property ("non-default", SCM_BOOL_T);
+
+      prev_cpos_ = clefpos;
+      prev_glyph_ = glyph;
+      prev_octavation_ = octavation;
+    }
+
+  if (to_boolean (force_clef))
     {
-      create_clef();
-      clef_p_->set_elt_property ("non-default", SCM_BOOL_T);
+      Translator_group * w = daddy_trans_l_->where_defined (ly_symbol2scm ("forceClef"));
+      w->set_property ("forceClef", SCM_EOL);
     }
 }
 
+
 void
-Clef_engraver::do_pre_move_processing()
+Clef_engraver::stop_translation_timestep ()
 {
   if (clef_p_)
     {
       SCM vis = 0; 
-      if(to_boolean (clef_p_->get_elt_property("non-default")))
+      if (to_boolean (clef_p_->get_grob_property ("non-default")))
        {
          vis = get_property ("explicitClefVisibility");
        }
 
       if (vis)
        {
-         clef_p_->set_elt_property("visibility-lambda", vis);
+         clef_p_->set_grob_property ("visibility-lambda", vis);
          if (octavate_p_)
-           octavate_p_->set_elt_property("visibility-lambda", vis);
+           octavate_p_->set_grob_property ("visibility-lambda", vis);
        }
       
-      typeset_element (clef_p_);
+      typeset_grob (clef_p_);
       clef_p_ =0;
 
       if (octavate_p_)
-       typeset_element(octavate_p_);
+       typeset_grob (octavate_p_);
 
       octavate_p_ = 0;
     }
-
-  first_b_ = 0;
 }
 
 void
-Clef_engraver::do_post_move_processing()
+Clef_engraver::start_translation_timestep ()
 {
-  clef_req_l_ = 0;
 }
 
-ADD_THIS_TRANSLATOR(Clef_engraver);
+ADD_THIS_TRANSLATOR (Clef_engraver);