/*
- clef.cc -- implement Clef_engraver
+ clef-engraver.cc -- implement Clef_engraver
source file of the GNU LilyPond music typesetter
- (c) 1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+ (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+
Mats Bengtsson <matsb@s3.kth.se>
*/
#include <ctype.h>
-#include "bar.hh"
-#include "clef-engraver.hh"
-#include "clef-item.hh"
-#include "debug.hh"
-#include "command-request.hh"
-#include "time-description.hh"
-#include "note-head.hh"
-#include "key-item.hh"
-#include "local-key-item.hh"
-
-Clef_engraver::Clef_engraver()
-{
- clef_req_l_ = 0;
- clef_type_str_ = "";
- c0_position_i_ = 0;
- clef_position_i_ = 0;
- octave_dir_ = CENTER;
-}
-struct Clef_settings {
- char const *name;
- char const *cleftype;
- int position;
-} clef_settings[] = {
- {"treble", "treble", -2},
- {"violin", "treble", -2},
- {"G", "treble", -2},
- {"G2", "treble", -2},
- {"scarlatti", "scarlatti", 0 },
- {"french", "treble",-4 },
- {"soprano", "alto",-4 },
- {"mezzosoprano", "alto",-2 },
- {"alto", "alto",0 },
- {"tenor", "alto",2 },
- {"baritone", "alto",4 },
- {"varbaritone", "bass",0 },
- {"bass" , "bass",2 },
- {"F", "bass", 2},
- {"subbass", "bass",4},
- {0,0,0}
-};
+#include "translator-group.hh"
+#include "bar-line.hh"
+#include "staff-symbol-referencer.hh"
+#include "engraver.hh"
+#include "direction.hh"
+#include "side-position-interface.hh"
+#include "item.hh"
-/*
- Ugh. Should have support for Dictionaries in mudela.
- */
-bool
-Clef_engraver::set_type (String s)
+class Clef_engraver : public 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;
+public:
+ TRANSLATOR_DECLARATIONS(Clef_engraver);
+
+ Direction octave_dir_;
+
+protected:
+ virtual void stop_translation_timestep ();
+ virtual void start_translation_timestep ();
+ virtual void process_music ();
+ virtual void acknowledge_grob (Grob_info);
+private:
+ Item * clef_;
+ Item * octavate_;
+
+ SCM prev_glyph_;
+ SCM prev_cpos_;
+ SCM prev_octavation_;
+ void create_clef ();
+ void set_glyph ();
+ void inspect_clef_properties ();
+};
- bool found = 0;
- for (Clef_settings *c = clef_settings; !found && c->name; c++)
- {
- if (c->name == s)
- {
- clef_type_str_ = c->cleftype;
- clef_position_i_ = c->position;
- found = 1;
- }
- }
- 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;
- }
+Clef_engraver::Clef_engraver ()
+{
+ clef_ = 0;
+ octave_dir_ = CENTER;
+ octavate_ = 0;
- 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 if (clef_type_str_ == "scarlatti")
- c0_position_i_ = 0;
- else
- assert (false);
-
- c0_position_i_ -= (int) octave_dir_ * 7;
-
- return true;
+ /*
+ will trigger a clef at the start since #f != ' ()
+ */
+ prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
}
void
-Clef_engraver::read_req (Clef_change_req*c_l)
+Clef_engraver::set_glyph ()
{
- if (!set_type (c_l->clef_str_))
- c_l->error (_ ("unknown clef type "));
-}
+ SCM glyph_sym = ly_symbol2scm ("glyph-name");
+ SCM glyph = get_property ("clefGlyph");
+ SCM basic = ly_symbol2scm ("Clef");
+
+ daddy_trans_->execute_single_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
+ daddy_trans_->execute_single_pushpop_property (basic, glyph_sym, glyph);
+}
/**
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::acknowledge_grob (Grob_info info)
{
- if (dynamic_cast<Bar*>(info.elem_l_)
- && clef_type_str_.length_i())
+ Item * item =dynamic_cast <Item *> (info.grob_);
+ if (item)
{
- create_clef();
- if (!clef_req_l_)
- for (int i=0; i < clef_p_arr_.size (); i++)
- {
- clef_p_arr_[i]->default_b_ = true;
- }
+ if (Bar_line::has_interface (info.grob_)
+ && gh_string_p (get_property ("clefGlyph")))
+ create_clef ();
- }
+ }
+}
- /* ugh; should make Clef_referenced baseclass */
- Item * it_l =dynamic_cast <Item *> (info.elem_l_);
- if (it_l)
+void
+Clef_engraver::create_clef ()
+{
+ if (!clef_)
{
- if (Note_head * h = dynamic_cast<Note_head*>(it_l))
- {
- h->position_i_ += 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))
+ Item *c= new Item (get_property ("Clef"));
+ announce_grob(c, SCM_EOL);
+
+ clef_ = c;
+ SCM cpos = get_property ("clefPosition");
+
+ if (gh_number_p (cpos))
+ Staff_symbol_referencer::set_position (clef_, gh_scm2int (cpos));
+
+ SCM oct = get_property ("clefOctavation");
+ if (gh_number_p (oct) && gh_scm2int (oct))
{
- k-> set_c_position (c0_position_i_);
+ Item * g = new Item (get_property ("OctavateEight"));
+
+ Side_position_interface::add_support (g,clef_);
+
+ g->set_parent (clef_, Y_AXIS);
+ g->set_parent (clef_, X_AXIS);
+
+ g->set_grob_property ("direction", scm_int2num (sign (gh_scm2int (oct))));
+ octavate_ = g;
+ announce_grob(octavate_, SCM_EOL);
}
- }
+ }
+}
+void
+Clef_engraver::process_music ()
+{
+ inspect_clef_properties ();
}
void
-Clef_engraver::do_creation_processing()
+Clef_engraver::inspect_clef_properties ()
{
- Scalar def = get_property ("defaultClef");
- if (def.to_bool ()) // egcs: Scalar to bool is ambiguous
- set_type (def);
+ SCM glyph = get_property ("clefGlyph");
+ SCM clefpos = get_property ("clefPosition");
+ SCM octavation = get_property ("clefOctavation");
+ SCM force_clef = get_property ("forceClef");
- if (clef_type_str_.length_i ())
- {
- create_clef();
- for (int i=0; i < clef_p_arr_.size (); i++)
+ 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)
+)
+ {
+ set_glyph ();
+ create_clef ();
+
+ clef_->set_grob_property ("non-default", SCM_BOOL_T);
- clef_p_arr_[i]->default_b_ = false;
+ prev_cpos_ = clefpos;
+ prev_glyph_ = glyph;
+ prev_octavation_ = octavation;
}
-}
-bool
-Clef_engraver::do_try_music (Music * r_l)
-{
- if (Clef_change_req *cl = dynamic_cast <Clef_change_req *> (r_l))
+ if (to_boolean (force_clef))
{
- clef_req_l_ = cl;
- read_req (clef_req_l_);
- return true;
+ Translator_group * w = daddy_trans_->where_defined (ly_symbol2scm ("forceClef"));
+ w->set_property ("forceClef", SCM_EOL);
}
- else
- return false;
-
}
+
void
-Clef_engraver::create_clef()
+Clef_engraver::stop_translation_timestep ()
{
- if (clef_type_str_ == "scarlatti")
+ if (clef_)
{
- while (clef_p_arr_.size () < 2)
+ SCM vis = 0;
+ if (to_boolean (clef_->get_grob_property ("non-default")))
{
- Clef_item *ct= new Clef_item;
- ct->break_priority_i_ = -2; // UGH
- announce_element (Score_element_info (ct, clef_req_l_));
- clef_p_arr_.push (ct);
+ vis = get_property ("explicitClefVisibility");
}
- clef_p_arr_[0]->symbol_ = "treble";
- clef_p_arr_[0]->y_position_i_ = 4;
- clef_p_arr_[1]->symbol_ = "bass";
- clef_p_arr_[1]->y_position_i_ = -4;
- }
- else
- {
- if (!clef_p_arr_.size ())
+
+ if (vis)
{
- Clef_item *c= new Clef_item;
- c->break_priority_i_ = -2; // ugh
- announce_element (Score_element_info (c, clef_req_l_));
- clef_p_arr_.push (c);
+ clef_->set_grob_property ("break-visibility", vis);
+ if (octavate_)
+ {
+ octavate_->set_grob_property ("break-visibility", vis);
+
+ }
}
+
+ typeset_grob (clef_);
+ clef_ =0;
- for (int i=0; i < clef_p_arr_.size (); i++)
+ if (octavate_)
{
- clef_p_arr_[i]->symbol_ = clef_type_str_;
- clef_p_arr_[i]->y_position_i_ = clef_position_i_;
- clef_p_arr_[i]->octave_dir_ = octave_dir_;
+ Side_position_interface::add_staff_support (octavate_);
+ typeset_grob (octavate_);
}
- }
-}
-
-
-void
-Clef_engraver::do_process_requests()
-{
- if (clef_req_l_)
- {
- create_clef();
- for (int i=0; i < clef_p_arr_.size (); i++)
- clef_p_arr_[i]->default_b_ = false;
- }
-}
-void
-Clef_engraver::do_pre_move_processing()
-{
- for (int i=0; i <clef_p_arr_.size (); i++)
- {
- typeset_element (clef_p_arr_[i]);
+ octavate_ = 0;
}
- clef_p_arr_.clear ();
}
void
-Clef_engraver::do_post_move_processing()
+Clef_engraver::start_translation_timestep ()
{
- clef_req_l_ = 0;
-}
-
-void
-Clef_engraver::do_removal_processing()
-{
- if (clef_p_arr_.size ())
- {
- assert (false);
- }
}
-ADD_THIS_TRANSLATOR(Clef_engraver);
+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 */ "");