]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/clef-engraver.cc
Merge with master
[lilypond.git] / lily / clef-engraver.cc
index 53d9bd62d4cc964e0f4bf8e82c98b2dd24fc99fa..d9b2e27dea3d9cd544d7ccd831c757217028a9bb 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>,
 
   Mats Bengtsson <matsb@s3.kth.se>
 */
 
-#include <ctype.h>
+#include <cctype>
+using namespace std;
 
-#include "translator-group.hh"
-#include "key-item.hh"
-#include "local-key-item.hh"
-#include "bar.hh"
-#include "note-head.hh"
+#include "item.hh"
+#include "context.hh"
+#include "bar-line.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"
-#include "custos.hh"
 
-/// where is c-0 in the staff?
-class Clef_engraver : public  Engraver
+#include "translator.icc"
+
+class Clef_engraver : public Engraver
 {
 public:
-  VIRTUAL_COPY_CONS (Translator);
-  Clef_engraver ();
+  TRANSLATOR_DECLARATIONS (Clef_engraver);
 
   Direction octave_dir_;
-  bool  first_b_;
 
 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);
+  void stop_translation_timestep ();
+  void process_music ();
+  DECLARE_ACKNOWLEDGER (bar_line);
 
+  virtual void derived_mark () const;
 private:
-  Item * clef_p_;
-  Item * octavate_p_;
-  Clef_change_req * clef_req_l_;
-  
+  Item *clef_;
+  Item *octavate_;
+
+  SCM prev_glyph_;
+  SCM prev_cpos_;
+  SCM prev_octavation_;
   void create_clef ();
-  bool set_type (String);
+  void set_glyph ();
+  void inspect_clef_properties ();
 };
 
-Clef_engraver::Clef_engraver ()
+void
+Clef_engraver::derived_mark () const
 {
-  first_b_ = true;
-  clef_p_ = 0;
-  clef_req_l_ = 0;
-  octave_dir_ = CENTER;
-  octavate_p_ = 0;
+  scm_gc_mark (prev_octavation_);
+  scm_gc_mark (prev_cpos_);
+  scm_gc_mark (prev_glyph_);
 }
 
-bool
-Clef_engraver::set_type (String s)
+Clef_engraver::Clef_engraver ()
 {
-  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;
-      
-      SCM glyph = gh_cadr (found);
-      SCM pos = gh_caddr (found);
-
-      daddy_trans_l_->set_property ("clefGlyph", glyph);
-      daddy_trans_l_->set_property ("clefPosition", pos);
-
-      found = scm_assoc (glyph, p);
-      if (found == SCM_BOOL_F)
-       return false;
-
-      int c0_position = gh_scm2int (pos) + gh_scm2int (gh_cdr (found));
-      daddy_trans_l_->set_property ("centralCPosition", gh_int2scm (c0_position));
-    }
-
-  int c0_position = gh_scm2int (get_property ("centralCPosition"));
-  c0_position -= (int)octave_dir_ * 7;
-  daddy_trans_l_->set_property ("centralCPosition", gh_int2scm (c0_position));
+  clef_ = 0;
+  octave_dir_ = CENTER;
+  octavate_ = 0;
 
+  /*
+    will trigger a clef at the start since #f != ' ()
+  */
+  prev_octavation_ = prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
+}
 
+void
+Clef_engraver::set_glyph ()
+{
+  SCM glyph_sym = ly_symbol2scm ("glyph");
   SCM basic = ly_symbol2scm ("Clef");
-  SCM gl = ly_symbol2scm ("glyph");
 
-  daddy_trans_l_->execute_single_pushpop_property (basic, gl, SCM_UNDEFINED);
-  daddy_trans_l_->execute_single_pushpop_property (basic, gl,
-                                                  get_property ("clefGlyph"));
+  execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
+  execute_pushpop_property (context (), basic, glyph_sym, get_property ("clefGlyph"));
+}
 
-  return true;
+/**
+   Generate a clef at the start of a measure. (when you see a Bar,
+   ie. a breakpoint)
+*/
+void
+Clef_engraver::acknowledge_bar_line (Grob_info info)
+{
+  Item *item = dynamic_cast<Item *> (info.grob ());
+  if (item && scm_is_string (get_property ("clefGlyph")))
+    create_clef ();
 }
 
-/** 
-  Generate a clef at the start of a measure. (when you see a Bar,
-  ie. a breakpoint) 
-  */
 void
-Clef_engraver::acknowledge_element (Score_element_info info)
+Clef_engraver::create_clef ()
 {
-  Item * item =dynamic_cast <Item *> (info.elem_l_);
-  if (item)
+  if (!clef_)
     {
-      if (Bar::has_interface (info.elem_l_)
-         && gh_string_p (get_property ("clefGlyph")))
-       create_clef ();
-      
+      Item *c = make_item ("Clef", SCM_EOL);
 
-      if (Note_head::has_interface (item)
-         || Local_key_item::has_interface (item)
-         || Custos::has_interface (item)
-         )
-       {
-         int p = int (Staff_symbol_referencer::position_f (item))
-           + gh_scm2int (get_property ("centralCPosition"));
-         Staff_symbol_referencer::set_position (item, p);
-       }
-      else if (Key_item::has_interface (item))
+      clef_ = c;
+      SCM cpos = get_property ("clefPosition");
+
+      if (scm_is_number (cpos))
+       clef_->set_property ("staff-position", cpos);
+
+      SCM oct = get_property ("clefOctavation");
+      if (scm_is_number (oct) && scm_to_int (oct))
        {
-         /*
-           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 *g = make_item ("OctavateEight", SCM_EOL);
 
-         item->set_elt_property ("c0-position", get_property ("centralCPosition"));
-       }
-    } 
-}
+         int abs_oct = scm_to_int (oct);
+         int dir = sign (abs_oct);
+         abs_oct = abs (abs_oct) + 1;
 
-void
-Clef_engraver::do_creation_processing ()
-{
-  daddy_trans_l_->set_property ("clefPosition", gh_int2scm (0));
-  daddy_trans_l_->set_property ("clefGlyph", SCM_EOL);
-  daddy_trans_l_->set_property ("centralCPosition", gh_int2scm (0));
+         SCM txt = scm_number_to_string (scm_from_int (abs_oct),
+                                         scm_from_int (10));
 
-  SCM def = get_property ("defaultClef");
-  if (gh_string_p (def))
-    {
-      set_type (ly_scm2string (def));
+         g->set_property ("text",
+                          scm_list_n (ly_lily_module_constant ("vcenter-markup"),
+                                      txt, SCM_UNDEFINED));
+         Side_position_interface::add_support (g, clef_);
+
+         g->set_parent (clef_, Y_AXIS);
+         g->set_parent (clef_, X_AXIS);
+         g->set_property ("direction", scm_from_int (dir));
+         octavate_ = g;
+       }
     }
 }
-
-bool
-Clef_engraver::do_try_music (Music * r_l)
+void
+Clef_engraver::process_music ()
 {
-  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;
-    }
-  return false;
+  inspect_clef_properties ();
 }
 
 void
-Clef_engraver::create_clef ()
+Clef_engraver::inspect_clef_properties ()
 {
-  if (!clef_p_)
+  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))
     {
-      Item *c= new Item (get_property ("Clef"));
-      announce_element (c, clef_req_l_);
-
-      Staff_symbol_referencer::set_interface (c);
+      set_context_property_on_children (context (),
+                                       ly_symbol2scm ("localKeySignature"),
+                                       get_property ("keySignature"));
       
-      clef_p_ = c;
-    }
-  Staff_symbol_referencer::set_position (clef_p_,
-                                        gh_scm2int (get_property ("clefPosition")
-                                                    ));
-  if (octave_dir_)
-    {
-      Item * g = new Item (get_property ("OctavateEight"));
-
-      Side_position::add_support (g,clef_p_);      
+      set_glyph ();
+      if (prev_cpos_ != SCM_BOOL_F || to_boolean (get_property ("firstClef")))
+       create_clef ();
 
-      g->set_parent (clef_p_, Y_AXIS);
-      g->set_parent (clef_p_, X_AXIS);
+      if (clef_)
+       clef_->set_property ("non-default", SCM_BOOL_T);
 
-      g->set_elt_property ("direction", gh_int2scm (octave_dir_));
-      octavate_p_ = g;
-      announce_element (octavate_p_, clef_req_l_);
+      prev_cpos_ = clefpos;
+      prev_glyph_ = glyph;
+      prev_octavation_ = octavation;
     }
-}
 
-void
-Clef_engraver::do_process_music ()
-{
-  if (clef_req_l_ || first_b_)
+  if (to_boolean (force_clef))
     {
-      create_clef ();
-      clef_p_->set_elt_property ("non-default", SCM_BOOL_T);
+      SCM prev;
+      Context *w = context ()->where_defined (ly_symbol2scm ("forceClef"), &prev);
+      w->set_property ("forceClef", SCM_EOL);
     }
 }
 
 void
-Clef_engraver::do_pre_move_processing ()
+Clef_engraver::stop_translation_timestep ()
 {
-  if (clef_p_)
+  if (clef_)
     {
-      SCM vis = 0; 
-      if (to_boolean (clef_p_->get_elt_property ("non-default")))
-       {
-         vis = get_property ("explicitClefVisibility");
-       }
+      SCM vis = 0;
+      if (to_boolean (clef_->get_property ("non-default")))
+       vis = get_property ("explicitClefVisibility");
 
       if (vis)
        {
-         clef_p_->set_elt_property ("visibility-lambda", vis);
-         if (octavate_p_)
-           octavate_p_->set_elt_property ("visibility-lambda", vis);
+         clef_->set_property ("break-visibility", vis);
+         if (octavate_)
+           octavate_->set_property ("break-visibility", vis);
        }
-      
-      typeset_element (clef_p_);
-      clef_p_ =0;
 
-      if (octavate_p_)
-       typeset_element (octavate_p_);
+      clef_ = 0;
 
-      octavate_p_ = 0;
+      octavate_ = 0;
     }
-
-  first_b_ = 0;
-}
-
-void
-Clef_engraver::do_post_move_processing ()
-{
-  clef_req_l_ = 0;
 }
 
-ADD_THIS_TRANSLATOR (Clef_engraver);
-
+ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
+ADD_TRANSLATOR (Clef_engraver,
+               /* doc */ "Determine and set reference point for pitches",
+               /* create */ "Clef "
+               "OctavateEight ",
+               /* read */
+               "clefGlyph "
+               "clefOctavation "
+               "clefPosition "
+               "explicitClefVisibility "
+               "forceClef "
+               "middleCPosition "
+               ,
+               /* write */ "");