/*
- 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--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Mats Bengtsson <matsb@s3.kth.se>
- (c) 1997--2002 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 "translator-group.hh"
-#include "key-item.hh"
-#include "bar-line.hh"
+#include "item.hh"
+#include "context.hh"
#include "staff-symbol-referencer.hh"
-#include "debug.hh"
#include "engraver.hh"
#include "direction.hh"
#include "side-position-interface.hh"
-#include "item.hh"
+#include "translator.icc"
+#include "lily-imports.hh"
-class Clef_engraver : public Engraver
+class Clef_engraver : public Engraver
{
public:
- TRANSLATOR_DECLARATIONS(Clef_engraver);
-
- Direction octave_dir_;
+ TRANSLATOR_DECLARATIONS (Clef_engraver);
protected:
- virtual void stop_translation_timestep ();
- virtual void start_translation_timestep ();
- virtual void process_music ();
- virtual void acknowledge_grob (Grob_info);
+ void stop_translation_timestep ();
+ void process_music ();
+ void acknowledge_bar_line (Grob_info);
+
+ virtual void derived_mark () const;
private:
- Item * clef_p_;
- Item * octavate_p_;
+ 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 ();
};
-Clef_engraver::Clef_engraver ()
+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 (Context *c)
+ : Engraver (c)
{
- clef_p_ = 0;
- octave_dir_ = CENTER;
- octavate_p_ = 0;
+ clef_ = 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");
-
- daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
- daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, glyph);
+
+ execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
+ 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_l_);
- if (item)
- {
- if (Bar_line::has_interface (info.grob_l_)
- && gh_string_p (get_property ("clefGlyph")))
- create_clef ();
-
- }
+ Item *item = info.item ();
+ if (item && scm_is_string (get_property ("clefGlyph")))
+ create_clef ();
}
void
Clef_engraver::create_clef ()
{
- if (!clef_p_)
+ if (!clef_)
{
- Item *c= new Item (get_property ("Clef"));
- announce_grob(c, SCM_EOL);
+ Item *c = make_item ("Clef", SCM_EOL);
- Staff_symbol_referencer::set_interface (c);
-
- clef_p_ = c;
- }
- SCM cpos = get_property ("clefPosition");
+ clef_ = c;
+ SCM cpos = get_property ("clefPosition");
- if (gh_number_p (cpos))
- Staff_symbol_referencer::set_position (clef_p_, gh_scm2int (cpos));
+ if (scm_is_number (cpos))
+ clef_->set_property ("staff-position", cpos);
- SCM oct = get_property ("clefOctavation");
- if (gh_number_p (oct) && gh_scm2int (oct))
- {
- Item * g = new Item (get_property ("OctavateEight"));
+ SCM transp = get_property ("clefTransposition");
+ if (scm_is_number (transp) && scm_to_int (transp))
+ {
+ Item *g = make_item ("ClefModifier", SCM_EOL);
+
+ int abs_transp = scm_to_int (transp);
+ int dir = sign (abs_transp);
+ abs_transp = abs (abs_transp) + 1;
+
+ SCM txt = scm_number_to_string (scm_from_int (abs_transp),
+ scm_from_int (10));
- Side_position_interface::add_support (g,clef_p_);
+ SCM style = get_property ("clefTranspositionStyle");
- g->set_parent (clef_p_, Y_AXIS);
- g->set_parent (clef_p_, X_AXIS);
+ SCM formatter = get_property ("clefTranspositionFormatter");
+ if (ly_is_procedure (formatter))
+ g->set_property ("text", scm_call_2 (formatter, txt, style));
- g->set_grob_property ("direction", gh_int2scm (sign (gh_scm2int (oct))));
- octavate_p_ = g;
- announce_grob(octavate_p_, SCM_EOL);
+ 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
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
- || to_boolean (force_clef)
-)
+
+ if (scm_is_null (clefpos)
+ || !ly_is_equal (glyph, prev_glyph_)
+ || !ly_is_equal (clefpos, prev_cpos_)
+ || !ly_is_equal (transposition, prev_transposition_)
+ || to_boolean (force_clef))
{
+ apply_on_children (context (), Lily::invalidate_alterations);
+
set_glyph ();
- create_clef ();
+ if (scm_is_true (prev_cpos_) || to_boolean (get_property ("firstClef")))
+ create_clef ();
- clef_p_->set_grob_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))
{
- Translator_group * w = daddy_trans_l_->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_p_)
+ if (clef_)
{
- SCM vis = 0;
- if (to_boolean (clef_p_->get_grob_property ("non-default")))
- {
- vis = get_property ("explicitClefVisibility");
- }
-
- if (vis)
- {
- clef_p_->set_grob_property ("visibility-lambda", vis);
- if (octavate_p_)
- octavate_p_->set_grob_property ("visibility-lambda", vis);
- }
-
- typeset_grob (clef_p_);
- clef_p_ =0;
-
- if (octavate_p_)
- typeset_grob (octavate_p_);
-
- octavate_p_ = 0;
+ if (to_boolean (clef_->get_property ("non-default")))
+ {
+ SCM vis = get_property ("explicitClefVisibility");
+
+ if (scm_is_vector (vis))
+ clef_->set_property ("break-visibility", vis);
+ }
+
+ clef_ = 0;
+
+ modifier_ = 0;
}
}
void
-Clef_engraver::start_translation_timestep ()
+Clef_engraver::boot ()
{
+ ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
}
-
-
-ENTER_DESCRIPTION(Clef_engraver,
-/* descr */ "Determine and set reference point for pitches",
-/* creats*/ "Clef OctavateEight",
-/* acks */ "bar-line-interface",
-/* reads */ "clefPosition clefGlyph centralCPosition clefOctavation explicitClefVisibility",
-/* write */ "");
+ADD_TRANSLATOR (Clef_engraver,
+ /* doc */
+ "Determine and set reference point for pitches.",
+
+ /* create */
+ "Clef "
+ "ClefModifier ",
+
+ /* read */
+ "clefGlyph "
+ "clefTransposition "
+ "clefTranspositionStyle "
+ "clefPosition "
+ "explicitClefVisibility "
+ "forceClef ",
+
+ /* write */
+ ""
+ );