Run grand-replace (issue 3765)

[lilypond.git] / lily / include / engraver.hh

diff --git a/lily/include/engraver.hh b/lily/include/engraver.hh
index 279b60511c0113ab9d15f1564c649dba18a82181..4a102aa2655289b4a321a1616d7c631ec774fedd 100644 (file)
--- a/lily/include/engraver.hh
+++ b/lily/include/engraver.hh
@@ -1,61 +1,77 @@
 /*
-  engraver.hh -- declare Engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1996--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1996--2001 Han-Wen Nienhuys <hanwen@cs.uu.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/>.
+*/
 
 #ifndef ENGRAVER_HH
 #define ENGRAVER_HH
 
-#include "lily-proto.hh"
-#include "array.hh"
-#include "request.hh"
 #include "grob-info.hh"
 #include "translator.hh"
 
-
 /**
-  a struct which processes requests, and creates the #Grob#s.
-  It may use derived classes. 
-  */
-class Engraver : public virtual Translator {
-    
-  friend class Engraver_group_engraver;
+   a struct which processes events, and creates the #Grob#s.
+   It may use derived classes.
+*/
+class Engraver : public Translator
+{
+  Grob *internal_make_grob (SCM sym, SCM cause, char const *name,
+                            char const *f, int l, char const *fun);
+  friend SCM ly_engraver_make_grob (SCM, SCM, SCM);
+  friend class Engraver_group;
 protected:
-  /*
-    Call this when you're finished with ELEM_P.
-   */
-  virtual void typeset_grob (Grob*elem_p);
   /*
     take note of item/spanner
     put item in spanner. Adjust local key; etc.
 
     Default: ignore the info
-    */
+  */
   virtual void acknowledge_grob (Grob_info) {}
-
-  /** Do things with stuff found in acknowledge_grob. Ugh. Should
-     be looped with acknowledge_grob.
-     
-   */
-  virtual void create_grobs () {}
-  /**
-    Announce element. Default: pass on to daddy. Utility
-    */
-  virtual void announce_grob (Grob*, Music*);
   virtual void announce_grob (Grob_info);
-  virtual void process_music ();
+  virtual void announce_end_grob (Grob_info);
+  Engraver_group *get_daddy_engraver () const;
+
 public:
-  Engraver_group_engraver * daddy_grav_l () const;
   /**
-    override other ctor
-   */
-  TRANSLATOR_DECLARATIONS(Engraver);
+     Announce element. Default: pass on to daddy. Utility
+  */
+  void announce_grob (Grob *, SCM cause);
+  void announce_end_grob (Grob *, SCM cause);
+
+  Grob_info make_grob_info (Grob *, SCM cause);
+
+  Item *internal_make_item (SCM sym, SCM cause, char const *name,
+                            char const *f, int l, char const *fun);
+  Spanner *internal_make_spanner (SCM sym, SCM cause, char const *name,
+                                  char const *f, int l, char const *fun);
+  Paper_column *internal_make_column (SCM sym, char const *name,
+                                      char const *f, int l, char const *fun);
+
+  /**
+     override other ctor
+  */
+  TRANSLATOR_DECLARATIONS (Engraver);
 };
 
+#define make_item(x, cause) internal_make_item (ly_symbol2scm (x), cause, x, __FILE__, __LINE__, __FUNCTION__)
+#define make_spanner(x, cause) internal_make_spanner (ly_symbol2scm (x), cause, x, __FILE__, __LINE__, __FUNCTION__)
+#define make_paper_column(x) internal_make_column (ly_symbol2scm (x), x, __FILE__, __LINE__, __FUNCTION__)
 
-#endif // ENGRAVER_HH
+Engraver *unsmob_engraver (SCM eng);
+bool ly_is_grob_cause (SCM obj);
 
+#endif // ENGRAVER_HH