]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/clef-engraver.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / clef-engraver.cc
index 11f1554bca3db723799aedb6f20dddc37e3982b4..6e16d7fde8cf5af036e0880942cb07391493d8ad 100644 (file)
@@ -1,84 +1,97 @@
 /*
-  clef-engraver.cc -- implement Clef_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Mats Bengtsson <matsb@s3.kth.se>
 
-  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
 
-  Mats Bengtsson <matsb@s3.kth.se>
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#include <ctype.h>
+#include <cctype>
+using namespace std;
 
+#include "item.hh"
 #include "context.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
+#include "translator.icc"
+
+class Clef_engraver : public Engraver
 {
 public:
   TRANSLATOR_DECLARATIONS (Clef_engraver);
 
-  Direction octave_dir_;
-
 protected:
-  virtual void stop_translation_timestep ();
-  virtual void process_music ();
-  virtual void acknowledge_grob (Grob_info);
+  void stop_translation_timestep ();
+  void process_music ();
+  DECLARE_ACKNOWLEDGER (bar_line);
+
+  virtual void derived_mark () const;
 private:
-  Item * clef_;
-  Item * octavate_;
+  Item *clef_;
+  Item *modifier_;
 
   SCM prev_glyph_;
   SCM prev_cpos_;
-  SCM prev_octavation_;
+  SCM prev_transposition_;
   void create_clef ();
   void set_glyph ();
   void inspect_clef_properties ();
 };
 
+void
+Clef_engraver::derived_mark () const
+{
+  scm_gc_mark (prev_transposition_);
+  scm_gc_mark (prev_cpos_);
+  scm_gc_mark (prev_glyph_);
+}
+
 Clef_engraver::Clef_engraver ()
 {
   clef_ = 0;
-  octave_dir_ = CENTER;
-  octavate_ = 0;
+  modifier_ = 0;
 
   /*
     will trigger a clef at the start since #f != ' ()
-   */
-  prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
+  */
+  prev_transposition_ = prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
 }
 
 void
 Clef_engraver::set_glyph ()
 {
-  SCM glyph_sym = ly_symbol2scm ("glyph-name");
-  SCM glyph = get_property ("clefGlyph");
-
+  SCM glyph_sym = ly_symbol2scm ("glyph");
   SCM basic = ly_symbol2scm ("Clef");
-  
+
   execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
-  execute_pushpop_property (context (), basic, glyph_sym, glyph);
+  execute_pushpop_property (context (), basic, glyph_sym, get_property ("clefGlyph"));
 }
 
-/** 
-  Generate a clef at the start of a measure. (when you see a Bar,
-  ie. a breakpoint) 
-  */
+/**
+   Generate a clef at the start of a measure. (when you see a Bar,
+   ie. a breakpoint)
+*/
 void
-Clef_engraver::acknowledge_grob (Grob_info info)
+Clef_engraver::acknowledge_bar_line (Grob_info info)
 {
-  Item * item =dynamic_cast <Item *> (info.grob_);
-  if (item)
-    {
-      if (Bar_line::has_interface (info.grob_)
-         && scm_is_string (get_property ("clefGlyph")))
-       create_clef ();
-    } 
+  Item *item = info.item ();
+  if (item && scm_is_string (get_property ("clefGlyph")))
+    create_clef ();
 }
 
 void
@@ -87,37 +100,38 @@ Clef_engraver::create_clef ()
   if (!clef_)
     {
       Item *c = make_item ("Clef", SCM_EOL);
-      
 
       clef_ = c;
       SCM cpos = get_property ("clefPosition");
 
-      if (ly_c_number_p (cpos))
-       clef_->set_property ("staff-position", cpos);
+      if (scm_is_number (cpos))
+        clef_->set_property ("staff-position", cpos);
+
+      SCM transp = get_property ("clefTransposition");
+      if (scm_is_number (transp) && scm_to_int (transp))
+        {
+          Item *g = make_item ("ClefModifier", SCM_EOL);
 
-      SCM oct =  get_property ("clefOctavation");
-      if (ly_c_number_p (oct) && ly_scm2int (oct))
-       {
-         Item * g = make_item ("OctavateEight", SCM_EOL);
+          int abs_transp = scm_to_int (transp);
+          int dir = sign (abs_transp);
+          abs_transp = abs (abs_transp) + 1;
 
-         int abs_oct = ly_scm2int (oct) ;
-         int dir = sign (abs_oct);
-         abs_oct = abs (abs_oct)  + 1;
+          SCM txt = scm_number_to_string (scm_from_int (abs_transp),
+                                          scm_from_int (10));
 
-         SCM txt = scm_number_to_string (scm_int2num (abs_oct),
-                                         scm_from_int (10));
+          SCM style = get_property ("clefTranspositionStyle");
 
-         g->set_property ("text",
-                          scm_list_n (ly_scheme_function ("vcenter-markup"),
-                                      txt,  SCM_UNDEFINED));
-         Side_position_interface::add_support (g,clef_);      
+          SCM formatter = get_property ("clefTranspositionFormatter");
+          if (ly_is_procedure (formatter))
+            g->set_property ("text", scm_call_2 (formatter, txt, style));
 
-         g->set_parent (clef_, Y_AXIS);
-         g->set_parent (clef_, X_AXIS);
-         g->set_property ("direction", scm_int2num (dir));
-         octavate_ = g;
-         
-       }
+          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));
+          modifier_ = g;
+        }
     }
 }
 void
@@ -126,71 +140,86 @@ Clef_engraver::process_music ()
   inspect_clef_properties ();
 }
 
+static void apply_on_children (Context *context, SCM fun)
+{
+  scm_call_1 (fun, context->self_scm ());
+  for (SCM s = context->children_contexts ();
+       scm_is_pair (s); s = scm_cdr (s))
+    apply_on_children (unsmob_context (scm_car (s)), fun);
+}
+
 void
 Clef_engraver::inspect_clef_properties ()
 {
   SCM glyph = get_property ("clefGlyph");
   SCM clefpos = get_property ("clefPosition");
-  SCM octavation = get_property ("clefOctavation");
+  SCM transposition = get_property ("clefTransposition");
   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
+      || scm_equal_p (transposition, prev_transposition_) == SCM_BOOL_F
       || to_boolean (force_clef))
     {
+      apply_on_children (context (),
+                         ly_lily_module_constant ("invalidate-alterations"));
+
       set_glyph ();
-      create_clef ();
+      if (prev_cpos_ != SCM_BOOL_F || to_boolean (get_property ("firstClef")))
+        create_clef ();
 
-      clef_->set_property ("non-default", SCM_BOOL_T);
+      if (clef_)
+        clef_->set_property ("non-default", SCM_BOOL_T);
 
       prev_cpos_ = clefpos;
       prev_glyph_ = glyph;
-      prev_octavation_ = octavation;
+      prev_transposition_ = transposition;
     }
 
   if (to_boolean (force_clef))
     {
-      Context * w = context ()->where_defined (ly_symbol2scm ("forceClef"));
+      SCM prev;
+      Context *w = context ()->where_defined (ly_symbol2scm ("forceClef"), &prev);
       w->set_property ("forceClef", SCM_EOL);
     }
 }
 
-
 void
 Clef_engraver::stop_translation_timestep ()
 {
   if (clef_)
     {
-      SCM vis = 0; 
+      SCM vis = 0;
       if (to_boolean (clef_->get_property ("non-default")))
-       {
-         vis = get_property ("explicitClefVisibility");
-       }
+        vis = get_property ("explicitClefVisibility");
 
       if (vis)
-       {
-         clef_->set_property ("break-visibility", vis);
-         if (octavate_)
-           {
-             octavate_->set_property ("break-visibility", vis);
-
-           }
-       }
-      
-      clef_ =0;
-
-      octavate_ = 0;
-    }
-}
+        clef_->set_property ("break-visibility", vis);
 
+      clef_ = 0;
 
+      modifier_ = 0;
+    }
+}
 
-ENTER_DESCRIPTION (Clef_engraver,
-/* descr */       "Determine and set reference point for pitches",
-/* creats*/       "Clef OctavateEight",
-/* accepts */     "",
-/* acks  */      "bar-line-interface",
-/* reads */       "clefPosition clefGlyph middleCPosition clefOctavation explicitClefVisibility forceClef",
-/* write */       "");
+ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
+ADD_TRANSLATOR (Clef_engraver,
+                /* doc */
+                "Determine and set reference point for pitches.",
+
+                /* create */
+                "Clef "
+                "ClefModifier ",
+
+                /* read */
+                "clefGlyph "
+                "clefTransposition "
+                "clefTranspositionStyle "
+                "clefPosition "
+                "explicitClefVisibility "
+                "forceClef ",
+
+                /* write */
+                ""
+               );