Merge with master

[lilypond.git] / lily / engraver.cc

diff --git a/lily/engraver.cc b/lily/engraver.cc
index 7b2fb0c90c3e99b8cca3b71b85ad245cd5823fd5..84780dd0a2fc489997560a472ab67db2bb18fab3 100644 (file)
--- a/lily/engraver.cc
+++ b/lily/engraver.cc
@@ -1,64 +1,174 @@
 /*
   engraver.cc -- implement Engraver
 
-  Sourcefile of GNU LilyPond musictypesetter
+  Sourcefile of GNU LilyPond music type setter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "music-list.hh"
-#include "musical-request.hh"
 #include "engraver.hh"
-#include "engraver-group-engraver.hh"
-#include "debug.hh"
-#include "paper-def.hh"
-#include "score-element.hh"
+
+#include "context.hh"
+#include "international.hh"
+#include "music.hh"
+#include "paper-column.hh"
+#include "score-engraver.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+Engraver_group *
+Engraver::get_daddy_engraver () const
+{
+  return dynamic_cast<Engraver_group *> (get_daddy_translator ());
+}
 
 void
-Engraver::fill_staff_info (Staff_info&)
+Engraver::announce_grob (Grob_info inf)
 {
-  
+  get_daddy_engraver ()->announce_grob (inf);
 }
 
 void
-Engraver::announce_element (Score_element_info i)
+Engraver::announce_end_grob (Grob_info inf)
 {
-  if (!i.origin_trans_l_)
-    i.origin_trans_l_ = this;
-  daddy_grav_l()->announce_element (i);
+  get_daddy_engraver ()->announce_grob (inf);
 }
 
+/*
+  CAUSE is the object (typically a Stream_event object)  that
+  was the reason for making E.
+*/
 void
-Engraver::typeset_element (Score_element*p)
+Engraver::announce_grob (Grob *e, SCM cause)
 {
-  daddy_grav_l()->typeset_element (p);
+  /* 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);
+
+  Engraver_group *g = get_daddy_engraver ();
+  if (g)
+    g->announce_grob (i);
 }
 
 
-Paper_def*
-Engraver::paper_l () const
+/*
+  CAUSE is the object (typically a Music object)  that
+  was the reason for making E.
+*/
+void
+Engraver::announce_end_grob (Grob *e, SCM cause)
 {
-  return dynamic_cast<Paper_def*>(output_def_l_);
+  /* 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);
 }
 
 
-Staff_info
-Engraver::get_staff_info() const
+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.")
 {
-  if (daddy_grav_l())
-    return daddy_grav_l()->get_staff_info();
-  Staff_info info;
-  return info;
+  LY_ASSERT_TYPE (ly_is_procedure, cb, 1);
+
+  creation_callback = cb;
+
+  return SCM_UNSPECIFIED;
 }
+#endif
+
+Grob *
+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;
+  
+  SCM props = updated_grob_properties (context (), symbol);
 
+  Grob *grob = 0;
 
+  SCM handle = scm_sloppy_assq (ly_symbol2scm ("meta"), props);
+  SCM klass = scm_cdr (scm_sloppy_assq (ly_symbol2scm ("class"), scm_cdr (handle)));
 
+  if (klass == ly_symbol2scm ("Item"))
+    grob = new Item (props);
+  else if (klass == ly_symbol2scm ("Spanner"))
+    grob = new Spanner (props);
+  else if (klass == ly_symbol2scm ("Paper_column"))
+    grob = new Paper_column (props);
 
+  assert (grob);
+  announce_grob (grob, cause);
 
-Engraver_group_engraver*
-Engraver::daddy_grav_l () const
+#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));
+#endif
+
+  return grob;
+}
+
+Item *
+Engraver::internal_make_item (SCM x, SCM cause,
+                             char const *name,
+                             char const *file, int line, char const *fun)
 {
-  return (daddy_trans_l_ )
-       ? dynamic_cast<Engraver_group_engraver *> (daddy_trans_l_)
-       : 0;
+  Item *it = dynamic_cast<Item *> (internal_make_grob (x, cause, name, file, line, fun));
+  assert (it);
+  return it;
 }
+
+Paper_column *
+Engraver::internal_make_column (SCM x, char const *name,
+                               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)
+{
+  Spanner *sp = dynamic_cast<Spanner *> (internal_make_grob (x, cause, name, file, line, fun));
+  assert (sp);
+  return sp;
+}
+
+#include "translator.icc"
+
+ADD_TRANSLATOR (Engraver,
+               "Base class for engravers. Does nothing, so it is not used.",
+               "",
+               "",
+               "");
+