/*
- 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--2012 Jan Nieuwenhuizen <janneke@gnu.org>
- (c) 1998--2001 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 <ctype.h>
-#include "bar.hh"
-#include "command-request.hh"
-#include "staff-symbol.hh"
-#include "engraver-group-engraver.hh"
+#include <cctype>
+using namespace std;
+
#include "engraver.hh"
-#include "lily-guile.hh"
-#include "paper-column.hh"
-#include "paper-def.hh"
-#include "side-position-interface.hh"
-#include "staff-symbol-referencer.hh"
+#include "axis-group-interface.hh"
+#include "context.hh"
+#include "grob-array.hh"
+#include "international.hh"
#include "item.hh"
-#include "group-interface.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.
- */
+ put stuff over or next to bars. Examples: bar numbers, marginal notes,
+ rehearsal marks.
+*/
class Mark_engraver : public Engraver
{
-public:
- TRANSLATOR_DECLARATIONS(Mark_engraver);
-protected:
- Item* text_p_;
-
-protected:
- virtual void stop_translation_timestep ();
- virtual void acknowledge_grob (Grob_info);
- void create_items (Request*);
- virtual bool try_music (Music *req_l);
- virtual void start_translation_timestep ();
- virtual void initialize ();
- virtual void process_music ();
-
-private:
- Mark_req * mark_req_l_;
-};
+ 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 ();
+ DECLARE_TRANSLATOR_LISTENER (mark);
+ DECLARE_ACKNOWLEDGER (break_alignment);
+};
Mark_engraver::Mark_engraver ()
{
- text_p_ =0;
- mark_req_l_ = 0;
+ text_ = 0;
+ final_text_ = 0;
+ mark_ev_ = 0;
}
void
-Mark_engraver::initialize ()
+Mark_engraver::acknowledge_break_alignment (Grob_info inf)
{
- daddy_trans_l_->set_property ("stavesFound", SCM_EOL); // ugh: sharing with barnumber grav.
+ Grob *s = inf.grob ();
+ if (text_
+ && dynamic_cast<Item *> (s))
+ text_->set_parent (s, X_AXIS);
}
-
-
-
-/*
-
-which grobs carry INVISIBLE-STAFF ?
-
-*/
-
void
-Mark_engraver::acknowledge_grob (Grob_info inf)
+Mark_engraver::start_translation_timestep ()
{
- Grob * s = inf.grob_l_;
- if (Staff_symbol::has_interface (s)
- || to_boolean (s->get_grob_property ("invisible-staff")))
- {
- SCM sts = get_property ("stavesFound");
- SCM thisstaff = inf.grob_l_->self_scm ();
- if (scm_memq (thisstaff, sts) == SCM_BOOL_F)
- daddy_trans_l_->set_property ("stavesFound", gh_cons (thisstaff, sts));
- }
- else if (text_p_ && Bar::has_interface (s))
- {
- /*
- Ugh. Figure out how to do this right at beginning of line, (without
- creating class Bar_script : public Item).
- */
- text_p_->set_parent (s, X_AXIS);
- }
+ final_text_ = 0;
}
-void
+void
Mark_engraver::stop_translation_timestep ()
{
- if (text_p_)
+ if (text_)
{
- text_p_->set_grob_property ("side-support-elements" , get_property ("stavesFound"));
- typeset_grob (text_p_);
- text_p_ =0;
+ text_->set_object ("side-support-elements",
+ grob_list_to_grob_array (get_property ("stavesFound")));
+ final_text_ = text_;
+ text_ = 0;
}
+ mark_ev_ = 0;
}
-
void
-Mark_engraver::create_items (Request *rq)
+Mark_engraver::finalize ()
{
- if (text_p_)
- return;
-
- SCM s = get_property ("RehearsalMark");
- text_p_ = new Item (s);
-
-
- Side_position_interface::set_axis (text_p_, Y_AXIS);
-
- announce_grob (text_p_, rq);
+ if (final_text_)
+ final_text_->set_property ("break-visibility",
+ scm_c_make_vector (3, SCM_BOOL_T));
+ final_text_ = 0;
}
-
void
-Mark_engraver::start_translation_timestep ()
+Mark_engraver::create_items (Stream_event *ev)
{
- mark_req_l_ = 0;
-}
+ if (text_)
+ return;
+ text_ = make_item ("RehearsalMark", ev->self_scm ());
+}
-bool
-Mark_engraver::try_music (Music* r_l)
+IMPLEMENT_TRANSLATOR_LISTENER (Mark_engraver, mark);
+void
+Mark_engraver::listen_mark (Stream_event *ev)
{
- if (Mark_req *mr = dynamic_cast <Mark_req *> (r_l))
- {
- if (mark_req_l_ && mr->equal_b (mark_req_l_))
- return true;
- if (mark_req_l_)
- return false;
- mark_req_l_ = mr;
- return true;
- }
- return false;
+ ASSIGN_EVENT_ONCE (mark_ev_, ev);
}
-
/*
-
TODO: make the increment function in Scheme.
-
*/
void
Mark_engraver::process_music ()
{
- if (mark_req_l_)
+ if (mark_ev_)
{
- create_items (mark_req_l_);
-
- String t;
+ create_items (mark_ev_);
/*
- automatic marks.
- */
-
- SCM m = mark_req_l_->get_mus_property ("label");
- if (gh_pair_p (m)) // markup text
- text_p_->set_grob_property ("text",m);
- else
- {
- if (!gh_string_p (m))
- m = get_property ("rehearsalMark");
- ;
-
- if (gh_number_p (m))
- {
- int mark_count = gh_scm2int (m);
- t = to_str (mark_count);
- mark_count ++;
- m = gh_int2scm (mark_count);
- }
- else if (gh_string_p (m))
- {
- t = ly_scm2string (m);
- String next;
- if (t.length_i ())
- {
- char c = t[0];
- c++;
- next = to_str (c);
- }
- m = ly_str02scm (next.ch_C ());
- }
- else
- {
- m = gh_int2scm (1);
- }
-
- daddy_trans_l_->set_property ("rehearsalMark", m);
-
- text_p_->set_grob_property ("text",
- ly_str02scm (t.ch_C ()));
-
- String style = "mark";
- for (int i=0; i < t.length_i (); i++)
- {
- if (!isdigit (t[i]))
- {
- style = "large";
- break;
- }
- }
- SCM st = ly_symbol2scm (style.ch_C ());
- text_p_->set_grob_property ("font-style", st);
- }
+ 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"));
}
}
-ENTER_DESCRIPTION(Mark_engraver,
-/* descr */ "",
-/* creats*/ "RehearsalMark",
-/* acks */ "grob-interface",
-/* reads */ "rehearsalMark stavesFound",
-/* write */ "");
+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 */
+ ""
+ );