/*
- script-engraver.cc -- implement Script_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.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.
+
+ 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 "script-engraver.hh"
-#include "script.hh"
-#include "stem-staff-side.hh"
-#include "musical-request.hh"
-#include "stem.hh"
-#include "staff-symbol.hh"
+#include "engraver.hh"
+
+#include "context.hh"
+#include "directional-element-interface.hh"
+#include "international.hh"
+#include "note-column.hh"
+#include "paper-column.hh"
#include "rhythmic-head.hh"
-#include "dimension-cache.hh"
+#include "script-interface.hh"
+#include "side-position-interface.hh"
+#include "slur.hh"
+#include "staff-symbol-referencer.hh"
+#include "stem.hh"
+#include "stream-event.hh"
+#include "warn.hh"
-Script_engraver::Script_engraver()
+#include "translator.icc"
+
+struct Script_tuple
+{
+ Stream_event *event_;
+ Grob *script_;
+ Script_tuple ()
+ {
+ event_ = 0;
+ script_ = 0;
+ }
+};
+
+class Script_engraver : public Engraver
{
- do_post_move_processing();
+ vector<Script_tuple> scripts_;
+
+protected:
+ void stop_translation_timestep ();
+ void process_music ();
+
+ void listen_articulation (Stream_event *);
+ void acknowledge_rhythmic_head (Grob_info);
+ void acknowledge_stem (Grob_info);
+ void acknowledge_stem_tremolo (Grob_info);
+ void acknowledge_tie (Grob_info);
+ void acknowledge_end_tie (Grob_info);
+ void acknowledge_note_column (Grob_info);
+ void acknowledge_inline_accidental (Grob_info);
+
+public:
+ TRANSLATOR_DECLARATIONS (Script_engraver);
+};
+
+Script_engraver::Script_engraver (Context *c)
+ : Engraver (c)
+{
+}
+
+void
+Script_engraver::listen_articulation (Stream_event *ev)
+{
+ /* Discard double articulations for part-combining. */
+ for (vsize i = 0; i < scripts_.size (); i++)
+ if (ly_is_equal (scripts_[i].event_
+ ->get_property ("articulation-type"),
+ ev->get_property ("articulation-type")))
+ return;
+
+ Script_tuple t;
+ t.event_ = ev;
+ scripts_.push_back (t);
}
-bool
-Script_engraver::do_try_music (Music *r_l)
+void
+copy_property (Grob *g, SCM sym, SCM alist)
{
- if (Articulation_req *mr = dynamic_cast <Articulation_req *> (r_l))
+ if (scm_is_null (g->get_property (sym)))
{
- for (int i=0; i < script_req_l_arr_.size(); i++)
- {
- if (script_req_l_arr_[i]->equal_b (mr))
- return true;
- }
- script_req_l_arr_.push (mr);
- return true;
+ SCM entry = scm_assoc (sym, alist);
+ if (scm_is_pair (entry))
+ g->set_property (sym, scm_cdr (entry));
}
- return false;
}
+/* Add the properties, one by one for each Script. A little memory
+ could be saved by tacking the props onto the Script grob (i.e. make
+ ScriptStaccato , ScriptMarcato, etc. ).
+*/
void
-Script_engraver::do_process_requests()
+make_script_from_event (Grob *p, Context *tg,
+ SCM art_type, int index)
{
- for (int i=0; i < script_req_l_arr_.size(); i++)
+ SCM alist = tg->get_property ("scriptDefinitions");
+ SCM art = scm_assoc (art_type, alist);
+
+ if (scm_is_false (art))
{
- Articulation_req* l=script_req_l_arr_[i];
-
-
- SCM list = ly_ch_C_eval_scm (("(articulation-to-scriptdef \"" + l->articulation_str_ + "\")").ch_C());
-
- if (list == SCM_BOOL_F)
- {
- l->warning (_f ("Don't know how to interpret articulation `%s'",
- l->articulation_str_.ch_C ()));
- continue;
- }
- Script *p =new Script;
- Stem_staff_side_item * ss =new Stem_staff_side_item;
- list = SCM_CDR (list);
-
- p->set_elt_property (molecule_scm_sym,
- SCM_CAR(list));
-
- list = SCM_CDR(list);
- bool follow_staff = gh_scm2bool (SCM_CAR(list));
- list = SCM_CDR(list);
- int relative_stem_dir = gh_scm2int (SCM_CAR(list));
- list = SCM_CDR(list);
- int force_dir =gh_scm2int (SCM_CAR(list));
- list = SCM_CDR(list);
- SCM priority = SCM_CAR(list);
-
- if (relative_stem_dir)
- ss->relative_dir_ = (Direction)relative_stem_dir;
- else
- ss->dir_ = (Direction)force_dir;
-
- Scalar dir_prop (get_property ("articulationScriptVerticalDirection", 0));
- if (dir_prop.isnum_b () && (int) dir_prop != CENTER)
- ss->dir_ = (Direction)(int)dir_prop;
-
- if (l->dir_)
- ss->dir_ = l->dir_;
-
- Real padding = 0.0;
- Scalar paddingprop = get_property ("articulationScriptPadding", 0);
- if (paddingprop.length_i() && paddingprop.isnum_b ())
- {
- padding = (Real)paddingprop;
- }
-
-
- Scalar axisprop = get_property ("scriptHorizontal",0);
- if (axisprop.to_bool ())
- ss->axis_ = X_AXIS;
-
- if (follow_staff && !axisprop.to_bool ())
- ss->set_elt_property (no_staff_support_scm_sym, SCM_BOOL_T);
-
- p->set_staff_side (ss);
- ss->set_elt_property (script_priority_scm_sym, priority);
- if (padding)
- ss->set_elt_property (padding_scm_sym, gh_double2scm(padding));
- script_p_arr_.push (p);
- staff_side_p_arr_.push (ss);
-
- announce_element (Score_element_info (p, l));
- announce_element (Score_element_info (ss, l));
+ /* FIXME: */
+ warning (_ ("do not know how to interpret articulation:"));
+ warning (_ (" scheme encoding: "));
+ scm_write (art_type, scm_current_error_port ());
+ message ("");
+ return;
+ }
+
+ art = scm_cdr (art);
+
+ bool priority_found = false;
+
+ for (SCM s = art; scm_is_pair (s); s = scm_cdr (s))
+ {
+ SCM sym = scm_caar (s);
+ SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
+ if (!ly_is_procedure (type))
+ continue;
+
+ SCM val = scm_cdar (s);
+
+ if (scm_is_eq (sym, ly_symbol2scm ("script-priority")))
+ {
+ priority_found = true;
+ /* Make sure they're in order of user input by adding index i.
+ Don't use the direction in this priority. Smaller means closer
+ to the head. */
+ int prio = scm_to_int (val) + index;
+
+ val = scm_from_int (prio);
+ }
+
+ SCM preset = p->get_property_data (sym);
+ if (scm_is_null (val)
+ || scm_is_false (scm_call_1 (type, preset)))
+ p->set_property (sym, val);
+ }
+
+ if (!priority_found)
+ {
+ p->set_property ("script-priority",
+ scm_from_int (index));
}
}
void
-Script_engraver::acknowledge_element (Score_element_info inf)
+Script_engraver::process_music ()
{
- if (Stem *s = dynamic_cast<Stem*>(inf.elem_l_))
+ for (vsize i = 0; i < scripts_.size (); i++)
{
- for (int i=0; i < staff_side_p_arr_.size(); i++)
- if (Stem_staff_side_item * ss = dynamic_cast<Stem_staff_side_item*>(staff_side_p_arr_[i]))
- {
- ss->set_stem (s);
- ss->add_support (s);
- }
+ Stream_event *ev = scripts_[i].event_;
+
+ Grob *p = make_item ("Script", ev->self_scm ());
+
+ make_script_from_event (p, context (),
+ ev->get_property ("articulation-type"),
+ i);
+
+ scripts_[i].script_ = p;
+
+ SCM force_dir = ev->get_property ("direction");
+ if (is_direction (force_dir) && to_dir (force_dir))
+ p->set_property ("direction", force_dir);
}
- else if (Rhythmic_head * rh = dynamic_cast<Rhythmic_head*>(inf.elem_l_))
+}
+
+void
+Script_engraver::acknowledge_stem (Grob_info info)
+{
+ for (vsize i = 0; i < scripts_.size (); i++)
{
- for (int i=0; i < staff_side_p_arr_.size(); i++)
- {
- Staff_side_item * ss = dynamic_cast<Staff_side_item*>(staff_side_p_arr_[i]);
-
- if (!ss->parent_l (X_AXIS))
- {
- ss->set_parent (inf.elem_l_, X_AXIS);
- }
- ss->add_support (rh);
- }
- }
+ Grob *e = scripts_[i].script_;
+
+ if (to_dir (e->get_property ("side-relative-direction")))
+ e->set_object ("direction-source", info.grob ()->self_scm ());
+
+ Side_position_interface::add_support (e, info.grob ());
+ }
+}
+
+void
+Script_engraver::acknowledge_stem_tremolo (Grob_info info)
+{
+ for (vsize i = 0; i < scripts_.size (); i++)
+ {
+ Grob *e = scripts_[i].script_;
+ Side_position_interface::add_support (e, info.grob ());
+ }
+}
+
+void
+Script_engraver::acknowledge_tie (Grob_info info)
+{
+ for (vsize i = 0; i < scripts_.size (); i++)
+ {
+ Grob *e = scripts_[i].script_;
+ Side_position_interface::add_support (e, info.grob ());
+ }
+}
+
+void
+Script_engraver::acknowledge_end_tie (Grob_info info)
+{
+ for (vsize i = 0; i < scripts_.size (); i++)
+ {
+ Grob *e = scripts_[i].script_;
+ Side_position_interface::add_support (e, info.grob ());
+ }
}
void
-Script_engraver::do_pre_move_processing()
+Script_engraver::acknowledge_inline_accidental (Grob_info info)
{
- for (int i=0; i < script_p_arr_.size(); i++)
+ for (vsize i = 0; i < scripts_.size (); i++)
{
- typeset_element (script_p_arr_[i]);
- typeset_element (staff_side_p_arr_[i]);
+ Grob *e = scripts_[i].script_;
+ Side_position_interface::add_support (e, info.grob ());
}
- script_p_arr_.clear();
- staff_side_p_arr_.clear ();
}
void
-Script_engraver::do_post_move_processing()
+Script_engraver::acknowledge_rhythmic_head (Grob_info info)
+{
+ if (info.event_cause ())
+ {
+ for (vsize i = 0; i < scripts_.size (); i++)
+ {
+ Grob *e = scripts_[i].script_;
+
+ if (Side_position_interface::get_axis (e) == X_AXIS
+ && !e->get_parent (Y_AXIS))
+ {
+ e->set_parent (info.grob (), Y_AXIS);
+ }
+ Side_position_interface::add_support (e, info.grob ());
+ }
+ }
+}
+
+void
+Script_engraver::acknowledge_note_column (Grob_info info)
+{
+ /* Make note column the parent of the script. That is not
+ correct, but due to seconds in a chord, noteheads may be
+ swapped around horizontally.
+
+ As the note head to put it on is not known now, postpone this
+ decision to Script_interface::calc_direction (). */
+ for (vsize i = 0; i < scripts_.size (); i++)
+ {
+ Grob *e = scripts_[i].script_;
+
+ if (!e->get_parent (X_AXIS)
+ && Side_position_interface::get_axis (e) == Y_AXIS)
+ e->set_parent (info.grob (), X_AXIS);
+ }
+}
+
+void
+Script_engraver::stop_translation_timestep ()
+{
+ scripts_.clear ();
+}
+
+
+void
+Script_engraver::boot ()
{
- script_req_l_arr_.clear();
+ ADD_LISTENER (Script_engraver, articulation);
+ ADD_ACKNOWLEDGER (Script_engraver, rhythmic_head);
+ ADD_ACKNOWLEDGER (Script_engraver, stem);
+ ADD_ACKNOWLEDGER (Script_engraver, tie);
+ ADD_END_ACKNOWLEDGER (Script_engraver, tie);
+ ADD_ACKNOWLEDGER (Script_engraver, note_column);
+ ADD_ACKNOWLEDGER (Script_engraver, stem_tremolo);
+ ADD_ACKNOWLEDGER (Script_engraver, inline_accidental);
}
+ADD_TRANSLATOR (Script_engraver,
+ /* doc */
+ "Handle note scripted articulations.",
+ /* create */
+ "Script ",
-ADD_THIS_TRANSLATOR(Script_engraver);
+ /* read */
+ "scriptDefinitions ",
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff