lily/include/grob.hh

   1 /*
   2   grob.hh -- declare Grob
   3
   4   source file of the LilyPond music typesetter
   5
   6   (c) 1996--2004 Han-Wen Nienhuys
   7 */
   8
   9 #ifndef GROB_HH
  10 #define GROB_HH
  11
  12 #include "parray.hh"
  13 #include "virtual-methods.hh"
  14 #include "lily-guile.hh"
  15 #include "lily-proto.hh"
  16 #include "smobs.hh"
  17 #include "dimension-cache.hh"
  18 #include "grob-interface.hh"
  19
  20 /**
  21     for administration of what was done already
  22     */
  23 enum Grob_status {
  24   ORPHAN=0,                     // not yet added to Paper_score
  25   PRECALCING,
  26   PRECALCED,            // calcs before spacing done
  27   POSTCALCING,          // busy calculating. This is used to trap cyclic deps.
  28   POSTCALCED,           // after spacing calcs done
  29 };
  30
  31 typedef void (Grob::*Grob_method_pointer) (void);
  32
  33
  34 /* Basic G[raphical output] O[bject].  */
  35 class Grob
  36 {
  37 protected:
  38   SCM immutable_property_alist_;
  39   SCM mutable_property_alist_;
  40   friend class Spanner;
  41
  42   void substitute_mutable_properties(SCM,SCM);
  43   char status_;
  44 public:
  45   Grob *original_;
  46
  47   /*
  48     TODO: junk this member.
  49    */
  50   Paper_score *pscore_;
  51   Dimension_cache dim_cache_[NO_AXES];
  52
  53   Grob (SCM basic_props);
  54   Grob (Grob const&);
  55   VIRTUAL_COPY_CONSTRUCTOR(Grob,Grob);
  56
  57   String name () const;
  58
  59   /*
  60     properties
  61    */
  62   SCM internal_get_property (SCM) const;
  63   void internal_set_property (SCM, SCM val);
  64   void add_to_list_property (SCM, SCM);
  65   void warning (String)const;
  66   void programming_error (String)const;
  67
  68   Output_def *get_paper () const;
  69   void add_dependency (Grob*);
  70   virtual System *get_system () const;
  71
  72   void calculate_dependencies (int final, int busy, SCM funcname);
  73
  74
  75   virtual void do_break_processing ();
  76   virtual Grob *find_broken_piece (System*) const;
  77   virtual void discretionary_processing ();
  78   virtual SCM do_derived_mark () const;
  79
  80   Stencil * get_stencil () const;
  81   SCM get_uncached_stencil () const;
  82
  83   SCM get_property_alist_chain (SCM) const;
  84   void suicide ();
  85   bool is_live () const;
  86
  87   DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis));
  88
  89   static SCM ly_grob_set_property (SCM, SCM,SCM);
  90   static SCM ly_grob_property (SCM, SCM);
  91
  92   bool internal_has_interface (SCM intf);
  93   static bool has_interface (Grob*me);
  94
  95   virtual void handle_broken_dependencies ();
  96   virtual void handle_prebroken_dependencies ();
  97
  98   DECLARE_SMOBS (Grob,foo);
  99
 100   void init ();
 101 public:
 102   bool is_empty (Axis a) const;
 103
 104   Interval extent (Grob * refpoint, Axis) const;
 105
 106   void translate_axis (Real, Axis);
 107   Real relative_coordinate (Grob const* refp, Axis) const;
 108   Grob*common_refpoint (Grob const* s, Axis a) const;
 109
 110   // duh. slim down interface here. (todo)
 111   bool has_offset_callback (SCM callback, Axis)const;
 112   void add_offset_callback (SCM callback, Axis);
 113   bool has_extent_callback (SCM, Axis)const;
 114   void set_extent (SCM , Axis);
 115   Real get_offset (Axis a) const;
 116
 117   void set_parent (Grob* e, Axis);
 118   Grob *get_parent (Axis a) const {   return  dim_cache_[a].parent_; }
 119
 120   DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM));
 121 };
 122
 123 DECLARE_UNSMOB(Grob,grob);
 124 Spanner* unsmob_spanner (SCM );
 125 Item* unsmob_item (SCM );
 126
 127 Grob*common_refpoint_of_list (SCM elt_list, Grob * , Axis a);
 128 Grob*common_refpoint_of_array (Link_array<Grob> const&, Grob * , Axis a);
 129
 130 void set_break_subsititution (SCM criterion);
 131 SCM substitute_mutable_property_alist (SCM alist);
 132
 133 Link_array<Grob> ly_scm2grobs (SCM l);
 134 SCM ly_grobs2scm (Link_array<Grob> a);
 135
 136 #endif /* GROB_HH */
 137