/*
- 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--2009 Jan Nieuwenhuizen <janneke@gnu.org>
- (c) 1998--2004 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 <cctype>
+using namespace std;
+#include "engraver.hh"
+
+#include "axis-group-interface.hh"
#include "bar-line.hh"
#include "context.hh"
-#include "engraver-group-engraver.hh"
-#include "engraver.hh"
+#include "grob-array.hh"
+#include "international.hh"
#include "item.hh"
+#include "stream-event.hh"
+#include "text-interface.hh"
#include "warn.hh"
-#include "text-item.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_;
-protected:
- virtual void stop_translation_timestep ();
- virtual void acknowledge_grob (Grob_info);
- void create_items (Music*);
- virtual bool try_music (Music *ev);
- virtual void process_music ();
-
-private:
- Music * mark_ev_;
-};
+ 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_ =0;
+ text_ = 0;
+ final_text_ = 0;
mark_ev_ = 0;
}
void
-Mark_engraver::acknowledge_grob (Grob_info inf)
+Mark_engraver::acknowledge_break_alignment (Grob_info inf)
{
- Grob * s = inf.grob_;
- if (text_ && Bar_line::has_interface (s))
- {
- /*
- TODO: make this configurable. RehearsalMark cannot be
- break-aligned, since the width of the object should not be taken
- into alignment considerations.
- */
- text_->set_parent (s, X_AXIS);
- }
+ Grob *s = inf.grob ();
+ if (text_
+ && dynamic_cast<Item *> (s))
+ text_->set_parent (s, X_AXIS);
}
-void
+void
+Mark_engraver::start_translation_timestep ()
+{
+ final_text_ = 0;
+}
+
+void
Mark_engraver::stop_translation_timestep ()
{
if (text_)
- {
- SCM lst = get_property ("stavesFound");
- text_->set_property ("side-support-elements" , lst);
- typeset_grob (text_);
- text_ =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::finalize ()
+{
+ if (final_text_)
+ final_text_->set_property ("break-visibility",
+ scm_c_make_vector (3, SCM_BOOL_T));
+ final_text_ = 0;
+}
void
-Mark_engraver::create_items (Music *ev)
+Mark_engraver::create_items (Stream_event *ev)
{
if (text_)
return;
- text_ = make_item ("RehearsalMark");
- announce_grob (text_, ev->self_scm ());
+ text_ = make_item ("RehearsalMark", ev->self_scm ());
}
-
-bool
-Mark_engraver::try_music (Music* r)
+IMPLEMENT_TRANSLATOR_LISTENER (Mark_engraver, mark);
+void
+Mark_engraver::listen_mark (Stream_event *ev)
{
- mark_ev_ = r;
- return true;
+ ASSIGN_EVENT_ONCE (mark_ev_, ev);
}
-
/*
TODO: make the increment function in Scheme.
*/
/*
automatic marks.
- */
+ */
-
SCM m = mark_ev_->get_property ("label");
SCM proc = get_property ("markFormatter");
- if (!Text_item::markup_p (m) &&
- is_procedure (proc))
+ if (!Text_interface::is_markup (m)
+ && ly_is_procedure (proc))
{
- if (!is_number (m))
- m = get_property ("rehearsalMark");
+ 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 = ly_scm2int (m);
- mark_count ++;
- daddy_context_->set_property ("rehearsalMark",
- scm_int2num (mark_count));
+ int mark_count = scm_to_int (m);
+ mark_count++;
+ context ()->set_property ("rehearsalMark",
+ scm_from_int (mark_count));
}
- if (is_number (m))
- m = scm_call_2 (proc, m, daddy_context_->self_scm ());
+ if (scm_is_number (m))
+ m = scm_call_2 (proc, m, context ()->self_scm ());
else
- warning ("rehearsalMark does not have integer value.");
+ /* FIXME: constant error message. */
+ warning (_ ("rehearsalMark must have integer value"));
}
- if (Text_item::markup_p (m))
+ if (Text_interface::is_markup (m))
text_->set_property ("text", m);
else
- warning ("Mark label should be markup object.");
+ warning (_ ("mark label must be a markup object"));
}
}
-ENTER_DESCRIPTION (Mark_engraver,
-/* descr */ "This engraver will create 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-location"
- ,
-/* creats*/ "RehearsalMark",
-/* accepts */ "mark-event",
-/* acks */ "bar-line-interface",
-/* reads */ "rehearsalMark markFormatter 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 */
+ ""
+ );