lily/include/engraver.hh

   1 /*
   2   engraver.hh -- declare Engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9
  10 #ifndef ENGRAVER_HH
  11 #define ENGRAVER_HH
  12
  13 #include "lily-proto.hh"
  14 #include "array.hh"
  15 #include "request.hh"
  16 #include "score-element-info.hh"
  17 #include "translator.hh"
  18
  19
  20 /**
  21   a struct which processes requests, and creates the #Score_element#s.
  22   It may use derived classes.
  23   */
  24 class Engraver : public virtual Translator {
  25
  26   friend class Engraver_group_engraver;
  27 protected:
  28   /// utility
  29   Paper_def * paper_l() const;
  30   /**
  31     Invoke walker method to typeset element. Default: pass on to daddy.
  32     */
  33   virtual void typeset_element (Score_element*elem_p);
  34   /**
  35     take note of item/spanner
  36     put item in spanner. Adjust local key; etc.
  37
  38     Default: ignore the info
  39     */
  40   virtual void acknowledge_element (Score_element_info) {}
  41
  42   /** Do things with stuff found in acknowledge_element. Ugh. Should
  43      be looped with acknowledge_element.
  44
  45    */
  46   virtual void process_acknowledged () {}
  47   /**
  48     Announce element. Default: pass on to daddy. Utility
  49     */
  50   virtual void announce_element (Score_element*, Music*);
  51   virtual void announce_element (Score_element_info);
  52 public:
  53   VIRTUAL_COPY_CONS(Translator);
  54   Engraver_group_engraver * daddy_grav_l() const;
  55   /**
  56     override other ctor
  57    */
  58   Engraver () {}
  59 };
  60
  61
  62 #endif // ENGRAVER_HH
  63