/*
- 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--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1996, 1997--1998 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 "score-element-info.hh"
-#include "staff-info.hh"
+#include "callback.hh"
+#include "grob.hh"
+#include "grob-info.hh"
#include "translator.hh"
-
/**
- a struct which processes requests, and creates the #Score_element#s.
- It may use derived classes. Hungarian postfix: grav
-
- */
-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 *f, int l, char const *fun);
+ friend SCM ly_engraver_make_grob (SCM, SCM, SCM);
+ friend class Engraver_group;
protected:
-
-
- /// utility
- Paper_def * paper() const;
- /**
- Invoke walker method to typeset element. Default: pass on to daddy.
- */
- virtual void typeset_element (Score_element*elem_p);
-
- /**
+ /*
take note of item/spanner
put item in spanner. Adjust local key; etc.
Default: ignore the info
- */
- virtual void acknowledge_element (Score_element_info) {}
-
- /** Do things with stuff found in acknowledge_element. Ugh. Should
- be looped with acknowledge_element.
-
- */
- virtual void process_acknowledged () {}
- /**
- Announce element. Default: pass on to daddy. Utility
- */
- virtual void announce_element (Score_element_info);
-
- /**
- Get information on the staff. Default: ask daddy.
- */
- virtual Staff_info get_staff_info() const;
- virtual void fill_staff_info (Staff_info&);
+ */
+ virtual void acknowledge_grob (Grob_info) {}
+ virtual void announce_grob (Grob_info, Context *reroute_context = 0);
+ virtual void announce_end_grob (Grob_info, Context *reroute_context = 0);
+ Engraver_group *get_daddy_engraver () const;
public:
- TRANSLATOR_CLONE(Engraver);
- Engraver_group_engraver * daddy_grav_l() const;
+ using Translator::trampoline;
+ template <class T, void (T::*callback)(Grob_info)>
+ static SCM trampoline (SCM target, SCM grob, SCM source_engraver)
+ {
+ T *t = LY_ASSERT_SMOB (T, target, 1);
+ Grob *g = LY_ASSERT_SMOB (Grob, grob, 2);
+ Engraver *e = LY_ASSERT_SMOB (Engraver, source_engraver, 3);
+
+ (t->*callback) (Grob_info (e, g));
+ return SCM_UNSPECIFIED;
+ }
+
/**
- override other ctor
- */
- 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);
- DECLARE_MY_RUNTIME_TYPEINFO;
- virtual Engraver * engraver_l () { return this; }
+ Item *internal_make_item (SCM sym, SCM cause,
+ char const *f, int l, char const *fun);
+ Spanner *internal_make_spanner (SCM sym, SCM cause,
+ char const *f, int l, char const *fun);
+ Paper_column *internal_make_column (SCM sym,
+ char const *f, int l, char const *fun);
+
+ /**
+ override other ctor
+ */
+ DECLARE_CLASSNAME (Engraver);
+ DECLARE_TRANSLATOR_CALLBACKS (Engraver);
+ Engraver ();
};
+#define make_item(x, cause) internal_make_item (ly_symbol2scm (x), cause, __FILE__, __LINE__, __FUNCTION__)
+#define make_spanner(x, cause) internal_make_spanner (ly_symbol2scm (x), cause, __FILE__, __LINE__, __FUNCTION__)
+#define make_paper_column(x) internal_make_column (ly_symbol2scm (x), __FILE__, __LINE__, __FUNCTION__)
-#endif // ENGRAVER_HH
+bool ly_is_grob_cause (SCM obj);
+#endif // ENGRAVER_HH