/*
- mark-engraver.cc -- implement Mark_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
- (c) 1998 Jan Nieuwenhuizen <janneke@gnu.org>
+ 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 <cctype>
+using namespace std;
+
+#include "engraver.hh"
+
+#include "axis-group-interface.hh"
+#include "context.hh"
+#include "grob-array.hh"
+#include "international.hh"
+#include "item.hh"
+#include "stream-event.hh"
+#include "text-interface.hh"
+#include "warn.hh"
+
+#include "translator.icc"
+
+/**
+ put stuff over or next to bars. Examples: bar numbers, marginal notes,
+ rehearsal marks.
*/
+class Mark_engraver : public Engraver
+{
+
+ void create_items (Stream_event *);
+ Item *text_;
+ Item *final_text_;
+ Stream_event *mark_ev_;
+
+public:
+ TRANSLATOR_DECLARATIONS (Mark_engraver);
+
+protected:
+ void process_music ();
+ void start_translation_timestep ();
+ void stop_translation_timestep ();
+ virtual void finalize ();
-#include "mark-engraver.hh"
-#include "text-def.hh"
-#include "script.hh"
-#include "paper-def.hh"
-#include "command-request.hh"
-#include "time-description.hh"
-#include "engraver-group.hh"
-#include "staff-sym.hh"
-#include "g-text-item.hh"
-#include "g-staff-side.hh"
-#include "stem.hh"
-#include "rhythmic-head.hh"
-#include "align-element.hh"
-#include "vertical-group-element.hh"
-
-ADD_THIS_TRANSLATOR (Mark_engraver);
+ DECLARE_TRANSLATOR_LISTENER (mark);
+ DECLARE_ACKNOWLEDGER (break_alignment);
+};
Mark_engraver::Mark_engraver ()
{
- mark_req_l_ = 0;
- staff_side_p_ = 0;
- text_p_ = 0;
+ text_ = 0;
+ final_text_ = 0;
+ mark_ev_ = 0;
}
-bool
-Mark_engraver::do_try_music (Music* r_l)
+void
+Mark_engraver::acknowledge_break_alignment (Grob_info inf)
{
- if (Mark_req *mr = dynamic_cast <Mark_req *> (r_l))
- {
- mark_req_l_ = mr;
- return true;
- }
- return false;
+ Grob *s = inf.grob ();
+ if (text_
+ && dynamic_cast<Item *> (s))
+ text_->set_parent (s, X_AXIS);
}
void
-Mark_engraver::do_process_requests ()
-{
- if (!mark_req_l_ || staff_side_p_)
- return;
-
- staff_side_p_ = new G_staff_side_item;
-
- text_p_ = new G_text_item;
-
- text_p_->text_str_ = mark_req_l_->str_;
- // text_p_->align_dir_ = CENTER;
-
- text_p_->style_str_ = text_p_->text_str_.index_any_i ("0123456789") >= 0
- ? "mark" : "Large";
+Mark_engraver::start_translation_timestep ()
+{
+ final_text_ = 0;
+}
- Scalar prop = get_property ("markDirection", 0);
- if (prop.isnum_b ())
- {
- staff_side_p_->dir_ = (Direction) (int) prop;
- }
- else
+void
+Mark_engraver::stop_translation_timestep ()
+{
+ if (text_)
{
- staff_side_p_->dir_ = UP;
+ text_->set_object ("side-support-elements",
+ grob_list_to_grob_array (get_property ("stavesFound")));
+ final_text_ = text_;
+ text_ = 0;
}
+ mark_ev_ = 0;
+}
- staff_side_p_->set_victim(text_p_);
-
- Scalar padding = get_property ("markScriptPadding", 0);
- if (padding.length_i() && padding.isnum_b ())
- {
- staff_side_p_->padding_f_ = Real(padding);
- }
- // Scalar break_priority = get_property ("markBreakPriority", 0);
- // if (break_priority.length_i() && break_priority.isnum_b ())
- // {
- // staff_side_p_->break_priority_i_ = int(break_priority);
- // }
-
-
- announce_element (Score_element_info (text_p_, mark_req_l_));
- announce_element (Score_element_info (staff_side_p_, mark_req_l_));
+void
+Mark_engraver::finalize ()
+{
+ if (final_text_)
+ final_text_->set_property ("break-visibility",
+ scm_c_make_vector (3, SCM_BOOL_T));
+ final_text_ = 0;
}
-void
-Mark_engraver::do_pre_move_processing ()
+void
+Mark_engraver::create_items (Stream_event *ev)
{
- if (staff_side_p_)
- {
- Staff_symbol* s_l = get_staff_info().staff_sym_l_;
- if (s_l != 0)
- {
- staff_side_p_->add_support (s_l);
- }
- typeset_element (text_p_);
- typeset_element (staff_side_p_);
- text_p_ = 0;
- staff_side_p_ = 0;
- mark_req_l_ = 0;
- }
+ if (text_)
+ return;
+
+ text_ = make_item ("RehearsalMark", ev->self_scm ());
}
+IMPLEMENT_TRANSLATOR_LISTENER (Mark_engraver, mark);
void
-Mark_engraver::acknowledge_element (Score_element_info i)
+Mark_engraver::listen_mark (Stream_event *ev)
{
- if (staff_side_p_)
+ ASSIGN_EVENT_ONCE (mark_ev_, ev);
+}
+
+/*
+ TODO: make the increment function in Scheme.
+*/
+void
+Mark_engraver::process_music ()
+{
+ if (mark_ev_)
{
- if (dynamic_cast<Stem *> (i.elem_l_) ||
- // dynamic_cast<Align_element *> (i.elem_l_) ||
- dynamic_cast<Vertical_group_element *> (i.elem_l_) ||
- dynamic_cast<Rhythmic_head *> (i.elem_l_))
- {
- staff_side_p_->add_support (i.elem_l_);
- }
+ create_items (mark_ev_);
+
+ /*
+ automatic marks.
+ */
+
+ SCM m = mark_ev_->get_property ("label");
+ SCM proc = get_property ("markFormatter");
+ if (!Text_interface::is_markup (m)
+ && ly_is_procedure (proc))
+ {
+ if (!scm_is_number (m))
+ m = get_property ("rehearsalMark");
+
+ if (scm_integer_p (m) == SCM_BOOL_T
+ && scm_exact_p (m) == SCM_BOOL_T)
+ {
+ int mark_count = scm_to_int (m);
+ mark_count++;
+ context ()->set_property ("rehearsalMark",
+ scm_from_int (mark_count));
+ }
+
+ if (scm_is_number (m))
+ m = scm_call_2 (proc, m, context ()->self_scm ());
+ else
+ /* FIXME: constant error message. */
+ warning (_ ("rehearsalMark must have integer value"));
+ }
+
+ if (Text_interface::is_markup (m))
+ text_->set_property ("text", m);
+ else
+ warning (_ ("mark label must be a markup object"));
}
}
+
+ADD_ACKNOWLEDGER (Mark_engraver, break_alignment);
+
+ADD_TRANSLATOR (Mark_engraver,
+ /* doc */
+ "Create @code{RehearsalMark} objects. It puts them on top of"
+ " all staves (which is taken from the property"
+ " @code{stavesFound}). If moving this engraver to a different"
+ " context, @ref{Staff_collecting_engraver} must move along,"
+ " otherwise all marks end up on the same Y@tie{}location.",
+
+ /* create */
+ "RehearsalMark ",
+
+ /* read */
+ "markFormatter "
+ "rehearsalMark "
+ "stavesFound ",
+
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff