lily/include/grob.hh

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