/*
- 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--2000 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 "local-key-item.hh"
-#include "bar.hh"
-#include "note-head.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 "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 ();
-
- Direction octave_dir_;
+ TRANSLATOR_DECLARATIONS (Clef_engraver);
protected:
- virtual void stop_translation_timestep ();
- virtual void start_translation_timestep ();
- virtual void create_grobs ();
- 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_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_central_c (SCM, SCM, SCM);
void set_glyph ();
+ void inspect_clef_properties ();
};
-Clef_engraver::Clef_engraver ()
+void
+Clef_engraver::derived_mark () const
{
- clef_p_ = 0;
- octave_dir_ = CENTER;
- octavate_p_ = 0;
-
- /*
- will trigger a clef at the start since #f != '()
- */
- prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
+ scm_gc_mark (prev_transposition_);
+ scm_gc_mark (prev_cpos_);
+ scm_gc_mark (prev_glyph_);
}
-void
-Clef_engraver::set_central_c (SCM glyph,SCM clefpos, SCM octavation)
+Clef_engraver::Clef_engraver ()
{
- prev_cpos_ = clefpos;
- prev_glyph_ = glyph;
- prev_octavation_ = octavation;
+ clef_ = 0;
+ modifier_ = 0;
- SCM p = get_property ("clefPitches");
- int c0_position = 0;
- if (gh_list_p (p))
- {
- SCM found = scm_assoc (glyph, p);
- if (found == SCM_BOOL_F)
- {
- c0_position =0;
- }
- else
- {
- c0_position = gh_scm2int (gh_cdr (found));
-
- if (gh_number_p (octavation))
- c0_position -= gh_scm2int (octavation);
-
- if (gh_number_p (clefpos))
- c0_position += gh_scm2int (clefpos);
- }
-
- }
- daddy_trans_l_->set_property ("centralCPosition", gh_int2scm (c0_position));
+ /*
+ will trigger a clef at the start since #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)
{
- create_grobs ();
- Item * item =dynamic_cast <Item *> (info.elem_l_);
- if (item)
- {
- if (Bar::has_interface (info.elem_l_)
- && gh_string_p (get_property ("clefGlyph")))
- create_clef ();
-
-
- 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))
- {
- /*
- 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"));
- }
- }
+ 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, 0);
+ Item *c = make_item ("Clef", SCM_EOL);
- Staff_symbol_referencer::set_interface (c);
-
- clef_p_ = c;
- }
- Staff_symbol_referencer::set_position (clef_p_,
- gh_scm2int (get_property ("clefPosition")));
+ clef_ = c;
+ SCM cpos = get_property ("clefPosition");
- SCM oct = get_property("clefOctavation");
- if (gh_number_p (oct) && gh_scm2int (oct))
- {
- Item * g = new Item (get_property ("OctavateEight"));
+ 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);
+
+ int abs_transp = scm_to_int (transp);
+ int dir = sign (abs_transp);
+ abs_transp = abs (abs_transp) + 1;
- Side_position::add_support (g,clef_p_);
+ SCM txt = scm_number_to_string (scm_from_int (abs_transp),
+ scm_from_int (10));
- g->set_parent (clef_p_, Y_AXIS);
- g->set_parent (clef_p_, X_AXIS);
+ SCM style = get_property ("clefTranspositionStyle");
- g->set_grob_property ("direction", gh_int2scm (sign (gh_scm2int (oct))));
- octavate_p_ = g;
- announce_grob (octavate_p_, 0);
+ SCM formatter = get_property ("clefTranspositionFormatter");
+ if (ly_is_procedure (formatter))
+ g->set_property ("text", scm_call_2 (formatter, txt, style));
+
+ 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 (Context::unsmob (scm_car (s)), fun);
+}
void
-Clef_engraver::create_grobs ()
+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))
{
- set_glyph();
- set_central_c (glyph, clefpos, octavation);
-
- create_clef ();
+ apply_on_children (context (),
+ ly_lily_module_constant ("invalidate-alterations"));
+
+ set_glyph ();
+ if (prev_cpos_ != SCM_BOOL_F || 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_transposition_ = transposition;
+ }
+
+ if (to_boolean (force_clef))
+ {
+ 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");
- }
+ SCM vis = 0;
+ if (to_boolean (clef_->get_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;
- }
-}
+ clef_->set_property ("break-visibility", vis);
-void
-Clef_engraver::start_translation_timestep ()
-{
-}
+ clef_ = 0;
-ADD_THIS_TRANSLATOR (Clef_engraver);
+ modifier_ = 0;
+ }
+}
+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 */
+ ""
+ );
projects / lilypond.git / blobdiff