/*
- engraver.cc -- implement Engraver
+ This file is part of LilyPond, the GNU music typesetter.
- Sourcefile of GNU LilyPond music type setter
+ Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2007 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 "engraver.hh"
void
Engraver::announce_end_grob (Grob_info inf)
{
+ inf.start_end_ = STOP;
get_daddy_engraver ()->announce_grob (inf);
}
-/*
- CAUSE is the object (typically a Stream_event object) that
- was the reason for making E.
-*/
-void
-Engraver::announce_grob (Grob *e, SCM cause)
+Grob_info
+Engraver::make_grob_info (Grob *e, SCM cause)
{
/* TODO: Remove Music code when it's no longer needed */
if (Music *m = unsmob_music (cause))
{
cause = m->to_event ()->unprotect ();
}
- if (unsmob_stream_event (cause) || unsmob_grob (cause))
+ if (e->get_property ("cause") == SCM_EOL
+ && (unsmob_stream_event (cause) || unsmob_grob (cause)))
e->set_property ("cause", cause);
- Grob_info i (this, e);
-
- Engraver_group *g = get_daddy_engraver ();
- if (g)
- g->announce_grob (i);
+ return Grob_info (this, e);
}
-
/*
- CAUSE is the object (typically a Music object) that
+ CAUSE is the object (typically a Stream_event object) that
was the reason for making E.
*/
void
-Engraver::announce_end_grob (Grob *e, SCM cause)
+Engraver::announce_grob (Grob *e, SCM cause)
{
- /* TODO: Remove Music code when it's no longer needed */
- if (Music *m = unsmob_music (cause))
- {
- cause = m->to_event ()->unprotect ();
- }
- if (unsmob_stream_event (cause) || unsmob_grob (cause))
- e->set_property ("cause", cause);
-
- Grob_info i (this, e);
-
- i.start_end_ = STOP;
- Engraver_group *g = get_daddy_engraver ();
- if (g)
- g->announce_grob (i);
+ announce_grob (make_grob_info (e, cause));
}
+/*
+ CAUSE is the object (typically a grob or stream-event object) that
+ was the reason for ending E. */
+void
+Engraver::announce_end_grob (Grob *e, SCM cause)
+{
+ announce_end_grob (make_grob_info (e, cause));
+}
Engraver::Engraver ()
{
#ifndef NDEBUG
static SCM creation_callback = SCM_EOL;
LY_DEFINE (ly_set_grob_creation_callback, "ly:set-grob-creation-callback",
- 1, 0, 0, (SCM cb),
- "Specify a procedure that will be called every time a new grob "
- "is created. The callback will receive as arguments the grob "
- "that was created, the name of the C++ source file that caused "
- "the grob to be created and the corresponding line number in the "
- "C++ source file.")
+ 1, 0, 0, (SCM cb),
+ "Specify a procedure that will be called every time a new grob"
+ " is created. The callback will receive as arguments the grob"
+ " that was created, the name of the C++ source file that caused"
+ " the grob to be created, and the corresponding line number in"
+ " the C++ source file.")
{
LY_ASSERT_TYPE (ly_is_procedure, cb, 1);
#endif
Grob *
-Engraver::internal_make_grob (SCM symbol, SCM cause, char const *name, char const *file, int line, char const *fun)
+Engraver::internal_make_grob (SCM symbol,
+ SCM cause,
+ char const * /* name */,
+ char const *file,
+ int line,
+ char const *fun)
{
- (void) file;
- (void) fun;
- (void) line;
- (void) name;
-
+#ifdef NDEBUG
+ (void)file;
+ (void)line;
+ (void)fun;
+#endif
+
SCM props = updated_grob_properties (context (), symbol);
Grob *grob = 0;
#ifndef NDEBUG
if (ly_is_procedure (creation_callback))
scm_apply_0 (creation_callback,
- scm_list_n (grob->self_scm (), scm_from_locale_string (file),
- scm_from_int (line), scm_from_locale_string (fun), SCM_UNDEFINED));
+ scm_list_n (grob->self_scm (), scm_from_locale_string (file),
+ scm_from_int (line), scm_from_locale_string (fun), SCM_UNDEFINED));
#endif
return grob;
Item *
Engraver::internal_make_item (SCM x, SCM cause,
- char const *name,
- char const *file, int line, char const *fun)
+ char const *name,
+ char const *file, int line, char const *fun)
{
Item *it = dynamic_cast<Item *> (internal_make_grob (x, cause, name, file, line, fun));
assert (it);
Paper_column *
Engraver::internal_make_column (SCM x, char const *name,
- char const *file, int line, char const *fun)
+ char const *file, int line, char const *fun)
{
return dynamic_cast<Paper_column *> (internal_make_grob (x, SCM_EOL, name, file, line, fun));
}
Spanner *
-Engraver::internal_make_spanner (SCM x, SCM cause, char const *name, char const *file, int line, char const *fun)
+Engraver::internal_make_spanner (SCM x, SCM cause, char const *name,
+ char const *file, int line, char const *fun)
{
Spanner *sp = dynamic_cast<Spanner *> (internal_make_grob (x, cause, name, file, line, fun));
assert (sp);
return sp;
}
+Engraver *
+unsmob_engraver (SCM eng)
+{
+ return dynamic_cast<Engraver *> (unsmob_translator (eng));
+}
+
+bool
+ly_is_grob_cause (SCM obj)
+{
+ return unsmob_grob (obj) || unsmob_stream_event (obj) || (obj == SCM_EOL);
+}
+
#include "translator.icc"
ADD_TRANSLATOR (Engraver,
- "Base class for engravers. Does nothing, so it is not used.",
- "",
- "",
- "");
+ /* doc */
+ "Base class for engravers. Does nothing, so it is not used.",
+
+ /* create */
+ "",
+
+ /* read */
+ "",
+
+ /* write */
+ ""
+ );