2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "engraver.hh"
23 #include "international.hh"
25 #include "paper-column.hh"
26 #include "score-engraver.hh"
28 #include "stream-event.hh"
32 Engraver::get_daddy_engraver () const
34 return dynamic_cast<Engraver_group *> (get_daddy_translator ());
38 Engraver::announce_grob (Grob_info inf)
40 get_daddy_engraver ()->announce_grob (inf);
44 Engraver::announce_end_grob (Grob_info inf)
46 inf.start_end_ = STOP;
47 get_daddy_engraver ()->announce_grob (inf);
51 Engraver::make_grob_info (Grob *e, SCM cause)
53 /* TODO: Remove Music code when it's no longer needed */
54 if (Music *m = unsmob_music (cause))
56 cause = m->to_event ()->unprotect ();
58 if (e->get_property ("cause") == SCM_EOL
59 && (unsmob_stream_event (cause) || unsmob_grob (cause)))
60 e->set_property ("cause", cause);
62 return Grob_info (this, e);
66 CAUSE is the object (typically a Stream_event object) that
67 was the reason for making E.
70 Engraver::announce_grob (Grob *e, SCM cause)
72 announce_grob (make_grob_info (e, cause));
76 CAUSE is the object (typically a grob or stream-event object) that
77 was the reason for ending E. */
79 Engraver::announce_end_grob (Grob *e, SCM cause)
81 announce_end_grob (make_grob_info (e, cause));
89 static SCM creation_callback = SCM_EOL;
90 LY_DEFINE (ly_set_grob_creation_callback, "ly:set-grob-creation-callback",
92 "Specify a procedure that will be called every time a new grob"
93 " is created. The callback will receive as arguments the grob"
94 " that was created, the name of the C++ source file that caused"
95 " the grob to be created, and the corresponding line number in"
96 " the C++ source file.")
98 LY_ASSERT_TYPE (ly_is_procedure, cb, 1);
100 creation_callback = cb;
102 return SCM_UNSPECIFIED;
107 Engraver::internal_make_grob (SCM symbol,
109 char const * /* name */,
120 SCM props = updated_grob_properties (context (), symbol);
124 SCM handle = scm_sloppy_assq (ly_symbol2scm ("meta"), props);
125 SCM klass = scm_cdr (scm_sloppy_assq (ly_symbol2scm ("class"), scm_cdr (handle)));
127 if (klass == ly_symbol2scm ("Item"))
128 grob = new Item (props);
129 else if (klass == ly_symbol2scm ("Spanner"))
130 grob = new Spanner (props);
131 else if (klass == ly_symbol2scm ("Paper_column"))
132 grob = new Paper_column (props);
135 announce_grob (grob, cause);
138 if (ly_is_procedure (creation_callback))
139 scm_apply_0 (creation_callback,
140 scm_list_n (grob->self_scm (), scm_from_locale_string (file),
141 scm_from_int (line), scm_from_locale_string (fun), SCM_UNDEFINED));
148 Engraver::internal_make_item (SCM x, SCM cause,
150 char const *file, int line, char const *fun)
152 Item *it = dynamic_cast<Item *> (internal_make_grob (x, cause, name, file, line, fun));
158 Engraver::internal_make_column (SCM x, char const *name,
159 char const *file, int line, char const *fun)
161 return dynamic_cast<Paper_column *> (internal_make_grob (x, SCM_EOL, name, file, line, fun));
165 Engraver::internal_make_spanner (SCM x, SCM cause, char const *name,
166 char const *file, int line, char const *fun)
168 Spanner *sp = dynamic_cast<Spanner *> (internal_make_grob (x, cause, name, file, line, fun));
174 unsmob_engraver (SCM eng)
176 return dynamic_cast<Engraver *> (unsmob_translator (eng));
180 ly_is_grob_cause (SCM obj)
182 return unsmob_grob (obj) || unsmob_stream_event (obj) || (obj == SCM_EOL);
185 #include "translator.icc"
187 ADD_TRANSLATOR (Engraver,
189 "Base class for engravers. Does nothing, so it is not used.",