/*
+ This file is part of LilyPond, the GNU music typesetter.
- clef-engraver.cc -- implement Clef_engraver
+ Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Mats Bengtsson <matsb@s3.kth.se>
- source file of the GNU LilyPond music typesetter
+ 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.
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+ 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.
- Mats Bengtsson <matsb@s3.kth.se>
+ 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 "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 "command-request.hh"
-#include "array.hh"
#include "engraver.hh"
#include "direction.hh"
#include "side-position-interface.hh"
-#include "item.hh"
-/// where is c-0 in the staff?
-class Clef_engraver : public Engraver {
- Item * clef_p_;
- Item * octavate_p_;
- Clef_change_req * clef_req_l_;
-
- void create_clef();
- bool set_type (String);
-protected:
- virtual void do_process_music();
- virtual void do_pre_move_processing();
- virtual void do_creation_processing();
- virtual void do_post_move_processing();
- virtual bool do_try_music (Music*);
- virtual void acknowledge_element (Score_element_info);
+#include "translator.icc"
+
+class Clef_engraver : public Engraver
+{
public:
- VIRTUAL_COPY_CONS(Translator);
- int c0_position_i_;
- int clef_position_i_;
- // junkme.
- Direction octave_dir_;
- SCM clef_glyph_; // no need for protection. Always referenced somewhere else.
-
- Clef_engraver();
-
- bool first_b_;
-
- Protected_scm current_settings_;
-};
+ TRANSLATOR_DECLARATIONS (Clef_engraver);
+protected:
+ void stop_translation_timestep ();
+ void process_music ();
+ DECLARE_ACKNOWLEDGER (bar_line);
+
+ 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 ();
+};
-Clef_engraver::Clef_engraver()
+void
+Clef_engraver::derived_mark () const
{
- current_settings_ = SCM_EOL;
-
- first_b_ = true;
- clef_glyph_ = SCM_EOL;
- clef_p_ = 0;
- clef_req_l_ = 0;
- c0_position_i_ = 0;
- clef_position_i_ = 0;
- octave_dir_ = CENTER;
- octavate_p_ = 0;
+ scm_gc_mark (prev_transposition_);
+ scm_gc_mark (prev_cpos_);
+ scm_gc_mark (prev_glyph_);
}
-bool
-Clef_engraver::set_type (String s)
+Clef_engraver::Clef_engraver ()
{
- 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;
+ clef_ = 0;
+ modifier_ = 0;
- SCM c = get_property ("supportedClefTypes");
- SCM p = get_property ("clefPitches");
-
- if (gh_list_p (c))
- {
- SCM found = scm_assoc (ly_str02scm (s.ch_C()), c);
- if (found == SCM_BOOL_F)
- return false;
-
- clef_glyph_ = gh_cadr (found);
- SCM pos = gh_caddr (found);
-
- clef_position_i_ = gh_scm2int (pos);
-
- found = scm_assoc (clef_glyph_, p);
- if (found == SCM_BOOL_F)
- return false;
-
- c0_position_i_ = clef_position_i_ + gh_scm2int (gh_cdr (found));
- }
-
- c0_position_i_ -= (int) octave_dir_ * 7;
-
- SCM basic = get_property ("basicClefItemProperties");
- current_settings_ = gh_cons (gh_cons (ly_symbol2scm ("glyph"), clef_glyph_), basic);
- current_settings_ =
- gh_cons (gh_cons (ly_symbol2scm ("c0-position"),
- gh_int2scm (c0_position_i_)),
- current_settings_);
-
- return true;
+ /*
+ will trigger a clef at the start since #f != ' ()
+ */
+ prev_transposition_ = prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
}
-/**
- 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::set_glyph ()
{
- Item * item =dynamic_cast <Item *> (info.elem_l_);
- if (item)
- {
- if (Bar::has_interface (info.elem_l_)
- && gh_string_p (clef_glyph_))
- create_clef();
-
-
- if (Note_head::has_interface (item)
- || Local_key_item::has_interface (item))
- {
- int p = int (Staff_symbol_referencer::position_f (item)) + c0_position_i_;
- Staff_symbol_referencer::set_position (item,p);
-
- }
- else if (Key_item::has_interface (item))
- {
- item->set_elt_property ("c0-position", gh_int2scm (c0_position_i_));
- }
- }
+ 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, 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)
{
- SCM def = get_property ("defaultClef");
- if (gh_string_p (def))
- {
- set_type (ly_scm2string (def));
- }
+ 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);
+
+ 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");
- return true;
+ 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;
+ }
}
- else
- return false;
+}
+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_clef()
+Clef_engraver::inspect_clef_properties ()
{
- if (!clef_p_)
+ SCM glyph = get_property ("clefGlyph");
+ SCM clefpos = get_property ("clefPosition");
+ 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 (transposition, prev_transposition_) == SCM_BOOL_F
+ || to_boolean (force_clef))
{
- Item *c= new Item ( current_settings_);
- announce_element (Score_element_info (c, clef_req_l_));
+ apply_on_children (context (),
+ ly_lily_module_constant ("invalidate-alterations"));
- Staff_symbol_referencer::set_interface (c);
-
- clef_p_ = c;
- }
- Staff_symbol_referencer::set_position(clef_p_, clef_position_i_);
- if (octave_dir_)
- {
- Item * g = new Item (get_property ("basicOctavateEightProperties"));
- Side_position::set_axis (g,Y_AXIS);
- Side_position::add_support (g,clef_p_);
-
- g->set_parent (clef_p_, Y_AXIS);
- g->set_parent (clef_p_, X_AXIS);
- g->add_offset_callback (Side_position::aligned_on_self, X_AXIS);
- g->add_offset_callback (Side_position::centered_on_parent, X_AXIS);
- g->set_elt_property ("direction", gh_int2scm (octave_dir_));
- octavate_p_ = g;
- announce_element (Score_element_info (octavate_p_, clef_req_l_));
- }
-}
+ set_glyph ();
+ if (prev_cpos_ != SCM_BOOL_F || to_boolean (get_property ("firstClef")))
+ create_clef ();
+ if (clef_)
+ clef_->set_property ("non-default", SCM_BOOL_T);
-void
-Clef_engraver::do_process_music()
-{
- if (clef_req_l_ || first_b_)
+ prev_cpos_ = clefpos;
+ prev_glyph_ = glyph;
+ prev_transposition_ = transposition;
+ }
+
+ if (to_boolean (force_clef))
{
- create_clef();
- clef_p_->set_elt_property ("non-default", SCM_BOOL_T);
+ 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_)
{
- SCM vis = 0;
- if(to_boolean (clef_p_->get_elt_property("non-default")))
- {
- vis = ly_symbol2scm ("all-visible");
- vis = scm_eval (vis);
- }
+ SCM vis = 0;
+ if (to_boolean (clef_->get_property ("non-default")))
+ vis = get_property ("explicitClefVisibility");
if (vis)
- {
- clef_p_->set_elt_property("visibility-lambda", vis);
- if (octavate_p_)
- octavate_p_->set_elt_property("visibility-lambda", vis);
- }
-
- typeset_element (clef_p_);
- clef_p_ =0;
-
- if (octavate_p_)
- typeset_element(octavate_p_);
-
- octavate_p_ = 0;
- }
+ clef_->set_property ("break-visibility", vis);
- first_b_ = 0;
-}
+ clef_ = 0;
-void
-Clef_engraver::do_post_move_processing()
-{
- clef_req_l_ = 0;
+ modifier_ = 0;
+ }
}
-ADD_THIS_TRANSLATOR(Clef_engraver);
-
+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