/*
- 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, 1997 Han-Wen Nienhuys <hanwen@stack.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 "varray.hh"
-#include "request.hh"
-#include "score-elem-info.hh"
-#include "staff-info.hh"
-
-
-
+#include "grob-info.hh"
+#include "translator.hh"
/**
- a struct which processes requests, and creates the #Score_elem#s.
- It may use derived classes. Hungarian postfix: grav
-
- */
-
-class Engraver {
-
- friend class Engraver_group_engraver;
- /**
- You cannot copy a Engraver
- */
- Engraver(const Engraver&){}
-
- enum {
- VIRGIN,
- CREATION_INITED,
- MOVE_INITED,
- ACCEPTED_REQS,
- PROCESSED_REQS,
- ACKED_REQS,
- MOVE_DONE
- } status;
-
+ 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:
-
-
- /// utility
- virtual Paper_def * paper() const;
-
-
- /// make items/spanners with the requests you got
- virtual void do_process_requests(){}
-
- /** typeset any items/spanners. Default: do nothing
- */
- virtual void do_pre_move_processing(){}
- /** reset any appropriate data. Default: do nothing
- */
- virtual void do_post_move_processing(){}
-
-
- virtual void do_creation_processing () {}
- virtual void do_removal_processing() {}
-
- /**
- typeset a "command" item. Default: pass on to daddy.
- If the column is not breakable, #pre_p# and #post_p# are junked
- */
- virtual void typeset_breakable_item(Item * nobreak_p);
- /**
- Invoke walker method to typeset element. Default: pass on to daddy.
- */
- virtual void typeset_element(Score_elem*elem_p);
-
- /**
- take note of item/spanner
- put item in spanner. Adjust local key; etc.
-
- Default: ignore the info
- */
- virtual void acknowledge_element(Score_elem_info) {}
- /**
- Announce element. Default: pass on to daddy. Utility
- */
- virtual void announce_element(Score_elem_info);
- /**
- Set Feature of the engraver(s). Default: ignore Feature.
- */
- virtual void set_feature(Feature){}
- /**
- ask daddy for a feature
- */
- virtual Scalar get_feature(String type_str);
- /**
- Does this equal or contain a certain engraver?
- */
-
- virtual void sync_features() {}
-
- virtual bool contains_b(Engraver*grav_l)const;
- /**
- Get information on the staff. Default: ask daddy.
- */
- virtual Staff_info get_staff_info()const;
- virtual void fill_staff_info(Staff_info&);
+ /*
+ take note of item/spanner
+ put item in spanner. Adjust local key; etc.
+ Default: ignore the info
+ */
+ virtual void acknowledge_grob (Grob_info) {}
+ virtual void announce_grob (Grob_info);
+ virtual void announce_end_grob (Grob_info);
+ Engraver_group *get_daddy_engraver () const;
- virtual void do_print()const;
- /*
- @see{try_request}
- Default: always return false
- */
- virtual bool do_try_request(Request *req_l);
public:
- void pre_move_processing();
- void process_requests();
- /**
- try to fit the request in this engraver
-
- @return
- false: not noted, not taken.
-
- true: request swallowed. Don't try to put the request elsewhere.
+ /**
+ Announce element. Default: pass on to daddy. Utility
+ */
+ void announce_grob (Grob *, SCM cause);
+ void announce_end_grob (Grob *, SCM cause);
- */
- bool try_request(Request*);
- bool is_bottom_engraver() const;
+ Grob_info make_grob_info (Grob *, SCM cause);
- void post_move_processing();
-
- Engraver_group_engraver * daddy_grav_l_;
+ 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);
- Engraver();
- virtual ~Engraver(){}
- DECLARE_MY_RUNTIME_TYPEINFO;
- void print() const;
+ /**
+ override other ctor
+ */
+ TRANSLATOR_DECLARATIONS (Engraver);
};
-/**
- A macro to automate administration of engravers.
- */
-#define ADD_THIS_ENGRAVER(c) \
-struct c ## init { \
- static Engraver * globalctor (){ \
- return new c; \
- } \
- c ## init () { \
- add_engraver(c::static_name(), globalctor); \
- \
- } \
-} _ ## c ## init;
+#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__)
-typedef Engraver*(*Grav_ctor)(void);
-void add_engraver(String s, Grav_ctor f);
+Engraver *unsmob_engraver (SCM eng);
+bool ly_is_grob_cause (SCM obj);
#endif // ENGRAVER_HH
-
projects / lilypond.git / blobdiff