]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/clef-engraver.cc
Imported sources
[lilypond.git] / lily / clef-engraver.cc
index 3d33c6cc7e99aede4e8adaac77b830dc7330ce4d..76c814444f48f23c19e0689ff0d43bef56f18525 100644 (file)
 /*
-  clef.cc -- implement Clef_engraver
+  clef-engraver.cc -- implement Clef_engraver
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
 
   Mats Bengtsson <matsb@s3.kth.se>
 */
 
-/*
-  CLEAN ME UP.
- */
 #include <ctype.h>
-#include "bar.hh"
-#include "clef-engraver.hh"
-#include "clef-item.hh"
-#include "debug.hh"
-#include "command-request.hh"
-#include "timing-translator.hh"
-#include "note-head.hh"
-#include "key-item.hh"
-#include "local-key-item.hh"
-
-Clef_engraver::Clef_engraver()
+
+#include "translator-group.hh"
+#include "bar-line.hh"
+#include "staff-symbol-referencer.hh"
+#include "engraver.hh"
+#include "direction.hh"
+#include "side-position-interface.hh"
+#include "item.hh"
+
+class Clef_engraver : public  Engraver
 {
-  clef_p_ = 0;
-  clef_req_l_ = 0;
-  clef_type_str_ = "";
-  c0_position_i_ = 0;
-  clef_position_i_ = 0;
+public:
+  TRANSLATOR_DECLARATIONS(Clef_engraver);
+
+  Direction octave_dir_;
+
+protected:
+  virtual void stop_translation_timestep ();
+  virtual void process_music ();
+  virtual void acknowledge_grob (Grob_info);
+private:
+  Item * clef_;
+  Item * octavate_;
+
+  SCM prev_glyph_;
+  SCM prev_cpos_;
+  SCM prev_octavation_;
+  void create_clef ();
+  void set_glyph ();
+  void inspect_clef_properties ();
+};
+
+Clef_engraver::Clef_engraver ()
+{
+  clef_ = 0;
   octave_dir_ = CENTER;
-  create_default_b_ = true;
+  octavate_ = 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 glyph_sym = ly_symbol2scm ("glyph-name");
+  SCM glyph = get_property ("clefGlyph");
 
-  bool found = false;
-  SCM c = get_property ("supportedClefTypes",0);
-  for (; gh_pair_p(c); c = gh_cdr (c))
-    {
-      SCM entry = gh_car (c);
-      SCM name  = gh_car (entry);
-
-      if (ly_scm2string (name) != s)
-       continue;
-      
-      SCM glyph  = gh_cadr (entry);
-      SCM pos  = gh_caddr (entry);
-      
-      clef_type_str_ = ly_scm2string (glyph);
-      clef_position_i_ = gh_scm2int (pos);
-      found = true;
-      break;
-    }
-    
-  if (!found)
-    {
-      switch(toupper (s[0]))
-       {
-       case 'F': 
-         clef_type_str_ = "bass";
-         break;
-       case  'G':
-         clef_type_str_ = "treble";
-         break;
-       case 'C': 
-         clef_type_str_ = "alto";
-         break;
-       default:
-         return false;
-       }
-      clef_position_i_ = 2 * (s[1] - '0') - 6;
-    }
-
-  if (clef_type_str_ == "treble")
-    c0_position_i_ = clef_position_i_ - 4;
-  else if (clef_type_str_ == "alto")
-    c0_position_i_ = clef_position_i_;
-  else if (clef_type_str_ == "bass")
-    c0_position_i_ = clef_position_i_ + 4;
-  else
-    assert (false);
-      
-  c0_position_i_ -= (int) octave_dir_ * 7;
+  SCM basic = ly_symbol2scm ("Clef");
   
-  return true;
+  execute_pushpop_property (daddy_trans_, basic, glyph_sym, SCM_UNDEFINED);
+  execute_pushpop_property (daddy_trans_, basic, glyph_sym, glyph);
 }
 
-
 /** 
   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::acknowledge_grob (Grob_info info)
 {
-  if (dynamic_cast<Bar*>(info.elem_l_)
-      && clef_type_str_.length_i())
+  Item * item =dynamic_cast <Item *> (info.grob_);
+  if (item)
     {
-      bool default_clef = !clef_p_;
-      create_clef();
-      if(!default_clef)
-       clef_p_->set_elt_property("visibility-lambda",
-                                 ly_ch_C_eval_scm ("all-visibility"));
-    }
-
-  /* ugh; should make Clef_referenced baseclass */
-  Item * it_l =dynamic_cast <Item *> (info.elem_l_);
-  if (it_l)
-    {
-      if (Note_head * h = dynamic_cast<Note_head*>(it_l))
-       {
-         h->set_position (int (h->position_f ()) + c0_position_i_);
-       }
-      else if (Local_key_item *i = dynamic_cast<Local_key_item*> (it_l))
-       {
-         i->c0_position_i_ =c0_position_i_;
-       }
-      else if (Key_item *k = dynamic_cast<Key_item*>(it_l))
-       {
-         k-> set_c_position (c0_position_i_);
-       }
+      if (Bar_line::has_interface (info.grob_)
+         && gh_string_p (get_property ("clefGlyph")))
+       create_clef ();
     } 
 }
 
 void
-Clef_engraver::do_creation_processing()
+Clef_engraver::create_clef ()
 {
-  create_default_b_ = true;    // should read property.
-  SCM def = get_property ("createInitdefaultClef", 0);
-  if (gh_string_p (def))
-    set_type (ly_scm2string (def));
-  
-  if (clef_type_str_.length_i ())
-    { 
-      create_clef();
-      clef_p_->set_elt_property ("non-default", SCM_BOOL_T);
-    }
-}
-
-bool
-Clef_engraver::do_try_music (Music * r_l)
-{
-  if (Clef_change_req *cl = dynamic_cast <Clef_change_req *> (r_l))
+  if (!clef_)
     {
-      clef_req_l_ = cl;
-      if (!set_type (cl->clef_str_))
-       cl->error (_ ("unknown clef type"));
+      Item *c= make_item ("Clef");
+      announce_grob(c, SCM_EOL);
 
-      return true;
-    }
-  else
-    return false;
+      clef_ = c;
+      SCM cpos = get_property ("clefPosition");
 
-}
+      if (gh_number_p (cpos))
+       Staff_symbol_referencer::set_position (clef_, gh_scm2int (cpos));
 
+      SCM oct =  get_property ("clefOctavation");
+      if (gh_number_p (oct) && gh_scm2int (oct))
+       {
+         Item * g = make_item ("OctavateEight");
+
+         int abs_oct = gh_scm2int (oct) ;
+         int dir = sign (abs_oct);
+         abs_oct = abs (abs_oct)  + 1;
+           
+         g->set_grob_property ("text",
+                               scm_number_to_string (gh_int2scm (abs_oct),
+                                                     SCM_MAKINUM (10)));
+         Side_position_interface::add_support (g,clef_);      
+
+         g->set_parent (clef_, Y_AXIS);
+         g->set_parent (clef_, X_AXIS);
+         g->set_grob_property ("direction", scm_int2num (dir));
+         octavate_ = g;
+         announce_grob(octavate_, SCM_EOL);
+       }
+    }
+}
 void
-Clef_engraver::create_clef()
+Clef_engraver::process_music ()
 {
-  if (!clef_p_)
-    {
-      Clef_item *c= new Clef_item;
-      c->set_elt_property ("break-aligned", SCM_BOOL_T);
-      announce_element (Score_element_info (c, clef_req_l_));
-      clef_p_ = c;
-    }
-  
-  clef_p_->symbol_ = clef_type_str_;
-  clef_p_->set_position(clef_position_i_);
-  if (octave_dir_)
-    {
-      clef_p_->set_elt_property ("octave-dir", gh_int2scm (octave_dir_));
-    }
+  inspect_clef_properties ();
 }
 
-
 void
-Clef_engraver::do_process_requests()
+Clef_engraver::inspect_clef_properties ()
 {
-  if (clef_req_l_)
-    {
-      create_clef();
-    }
-  else if (create_default_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))
     {
-      SCM type = get_property ("defaultClef", 0);
-      if (gh_string_p (type))
-       set_type (ly_scm2string (type));
-      else
-       set_type ( "treble");
+      set_glyph ();
       create_clef ();
-      create_default_b_ = false;
+
+      clef_->set_grob_property ("non-default", SCM_BOOL_T);
+
+      prev_cpos_ = clefpos;
+      prev_glyph_ = glyph;
+      prev_octavation_ = octavation;
     }
-}
 
-void
-Clef_engraver::do_pre_move_processing()
-{
-  if (clef_p_)
+  if (to_boolean (force_clef))
     {
-      typeset_element (clef_p_);
-      clef_p_ =0;
+      Translator_group * w = daddy_trans_->where_defined (ly_symbol2scm ("forceClef"));
+      w->set_property ("forceClef", SCM_EOL);
     }
-  create_default_b_ = false;
 }
 
-void
-Clef_engraver::do_post_move_processing()
-{
-  clef_req_l_ = 0;
-}
 
 void
-Clef_engraver::do_removal_processing()
+Clef_engraver::stop_translation_timestep ()
 {
-  assert (!clef_p_);
-}
+  if (clef_)
+    {
+      SCM vis = 0; 
+      if (to_boolean (clef_->get_grob_property ("non-default")))
+       {
+         vis = get_property ("explicitClefVisibility");
+       }
+
+      if (vis)
+       {
+         clef_->set_grob_property ("break-visibility", vis);
+         if (octavate_)
+           {
+             octavate_->set_grob_property ("break-visibility", vis);
 
+           }
+       }
+      
+      typeset_grob (clef_);
+      clef_ =0;
+
+      if (octavate_)
+       {
+         typeset_grob (octavate_);
+       }
+
+      octavate_ = 0;
+    }
+}
 
 
-ADD_THIS_TRANSLATOR(Clef_engraver);
 
+ENTER_DESCRIPTION(Clef_engraver,
+/* descr */       "Determine and set reference point for pitches",
+/* creats*/       "Clef OctavateEight",
+/* accepts */     "",
+/* acks  */      "bar-line-interface",
+/* reads */       "clefPosition clefGlyph centralCPosition clefOctavation explicitClefVisibility",
+/* write */       "");