/*
- clef.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--1999 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/>.
*/
-/*
- CLEAN ME UP.
- */
+#include <cctype>
+using namespace std;
-#include <ctype.h>
+#include "item.hh"
+#include "context.hh"
#include "staff-symbol-referencer.hh"
-#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()
-{
- clef_p_ = 0;
- clef_req_l_ = 0;
- clef_type_str_ = "";
- c0_position_i_ = 0;
- clef_position_i_ = 0;
- octave_dir_ = CENTER;
- create_default_b_ = true;
-}
+#include "engraver.hh"
+#include "direction.hh"
+#include "side-position-interface.hh"
-bool
-Clef_engraver::set_type (String s)
-{
- 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;
+#include "translator.icc"
+#include "lily-imports.hh"
- 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;
- }
+class Clef_engraver : public Engraver
+{
+public:
+ TRANSLATOR_DECLARATIONS (Clef_engraver);
+
+protected:
+ void stop_translation_timestep ();
+ void process_music ();
+ void acknowledge_bar_line (Grob_info);
+
+ virtual void derived_mark () const;
+private:
+ Item *clef_;
+ Item *modifier_;
+
+ SCM prev_glyph_;
+ SCM prev_cpos_;
+ SCM prev_transposition_;
+ void create_clef ();
+ void set_glyph ();
+ void inspect_clef_properties ();
+};
- 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;
-
- return true;
+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;
+ modifier_ = 0;
-/**
- Generate a clef at the start of a measure. (when you see a Bar,
- ie. a breakpoint)
+ /*
+ will trigger a clef at the start since #f != ' ()
*/
+ prev_transposition_ = prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
+}
+
void
-Clef_engraver::acknowledge_element (Score_element_info info)
+Clef_engraver::set_glyph ()
{
- if (dynamic_cast<Bar*>(info.elem_l_)
- && clef_type_str_.length_i())
- {
- bool default_clef = !clef_p_;
- create_clef();
- if(!default_clef)
- clef_p_->set_elt_property("visibility-lambda",
- ly_eval_str ("all-visibility"));
- }
+ SCM glyph_sym = ly_symbol2scm ("glyph");
+ SCM basic = ly_symbol2scm ("Clef");
- /* 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))
- {
- Staff_symbol_referencer_interface si (h);
- si.set_position (int (si.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_);
- }
- }
+ 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)
+*/
void
-Clef_engraver::do_creation_processing()
+Clef_engraver::acknowledge_bar_line (Grob_info info)
{
- 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);
- }
+ Item *item = info.item ();
+ if (item && scm_is_string (get_property ("clefGlyph")))
+ create_clef ();
}
-bool
-Clef_engraver::do_try_music (Music * r_l)
+void
+Clef_engraver::create_clef ()
{
- 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", SCM_EOL);
- return true;
- }
- else
- return false;
+ clef_ = c;
+ SCM cpos = get_property ("clefPosition");
-}
+ 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;
+
+ SCM txt = scm_number_to_string (scm_from_int (abs_transp),
+ scm_from_int (10));
+
+ SCM style = get_property ("clefTranspositionStyle");
+
+ 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::create_clef()
+Clef_engraver::process_music ()
{
- if (!clef_p_)
- {
- Clef_item *c= new Clef_item;
- c->set_elt_property ("breakable", SCM_BOOL_T);
- c->set_elt_property ("break-aligned", SCM_BOOL_T);
- announce_element (Score_element_info (c, clef_req_l_));
-
- Staff_symbol_referencer_interface si(c);
- si.set_interface ();
-
- clef_p_ = c;
- }
- Staff_symbol_referencer_interface si(clef_p_);
- clef_p_->symbol_ = clef_type_str_;
- si.set_position (clef_position_i_);
- if (octave_dir_)
- {
- clef_p_->set_elt_property ("octave-dir", gh_int2scm (octave_dir_));
- }
+ 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::do_process_requests()
+Clef_engraver::inspect_clef_properties ()
{
- if (clef_req_l_)
+ SCM glyph = get_property ("clefGlyph");
+ SCM clefpos = get_property ("clefPosition");
+ SCM transposition = get_property ("clefTransposition");
+ SCM force_clef = get_property ("forceClef");
+
+ 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))
{
- create_clef();
+ apply_on_children (context (), Lily::invalidate_alterations);
+
+ set_glyph ();
+ if (scm_is_true (prev_cpos_) || to_boolean (get_property ("firstClef")))
+ create_clef ();
+
+ if (clef_)
+ clef_->set_property ("non-default", SCM_BOOL_T);
+
+ prev_cpos_ = clefpos;
+ prev_glyph_ = glyph;
+ prev_transposition_ = transposition;
}
- else if (create_default_b_)
+
+ if (to_boolean (force_clef))
{
- SCM type = get_property ("defaultClef", 0);
- if (gh_string_p (type))
- set_type (ly_scm2string (type));
- else
- set_type ( "treble");
- create_clef ();
- create_default_b_ = false;
+ 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_)
{
- typeset_element (clef_p_);
- clef_p_ =0;
- }
- create_default_b_ = false;
-}
+ SCM vis = 0;
+ if (to_boolean (clef_->get_property ("non-default")))
+ vis = get_property ("explicitClefVisibility");
-void
-Clef_engraver::do_post_move_processing()
-{
- clef_req_l_ = 0;
+ if (vis)
+ clef_->set_property ("break-visibility", vis);
+
+ clef_ = 0;
+
+ modifier_ = 0;
+ }
}
void
-Clef_engraver::do_removal_processing()
+Clef_engraver::boot ()
{
- assert (!clef_p_);
+ ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
}
-
-
-ADD_THIS_TRANSLATOR(Clef_engraver);
-
+ADD_TRANSLATOR (Clef_engraver,
+ /* doc */
+ "Determine and set reference point for pitches.",
+
+ /* create */
+ "Clef "
+ "ClefModifier ",
+
+ /* read */
+ "clefGlyph "
+ "clefTransposition "
+ "clefTranspositionStyle "
+ "clefPosition "
+ "explicitClefVisibility "
+ "forceClef ",
+
+ /* write */
+ ""
+ );