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 // looking at gtk+/pango docstrings .. WIP
  34
  35 /**
  36  * Grob:
  37  * @internal_get_property: get property #NAME.
  38  *
  39  * Class structure for #Grob.
  40  **/
  41 class Grob
  42 {
  43 private:
  44   DECLARE_SMOBS (Grob, foo);
  45   void init ();
  46
  47 protected:
  48   SCM immutable_property_alist_;
  49   SCM mutable_property_alist_;
  50   friend class Spanner;
  51
  52   void substitute_mutable_properties (SCM, SCM);
  53   char status_;
  54
  55 public:
  56   Grob *original_;
  57
  58   /* TODO: junk this member. */
  59   Paper_score *pscore_;
  60
  61   Dimension_cache dim_cache_[NO_AXES];
  62
  63   Grob (SCM basic_props);
  64   Grob (Grob const&);
  65   VIRTUAL_COPY_CONSTRUCTOR (Grob, Grob);
  66   DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis));
  67
  68   String name () const;
  69
  70
  71   /*
  72     Properties
  73    */
  74   SCM internal_get_property (SCM) const;
  75   void internal_set_property (SCM, SCM val);
  76   void add_to_list_property (SCM, SCM);
  77
  78   SCM get_property_alist_chain (SCM) const;
  79   static SCM ly_grob_set_property (SCM, SCM,SCM);
  80   static SCM ly_grob_property (SCM, SCM);
  81
  82   void warning (String) const;
  83   void programming_error (String) const;
  84
  85   Output_def *get_paper () const;
  86   void add_dependency (Grob*);
  87   virtual System *get_system () const;
  88
  89   void calculate_dependencies (int final, int busy, SCM funcname);
  90
  91
  92   virtual void do_break_processing ();
  93   virtual Grob *find_broken_piece (System*) const;
  94   virtual void discretionary_processing ();
  95   virtual SCM do_derived_mark () const;
  96
  97   Stencil *get_stencil () const;
  98   SCM get_uncached_stencil () const;
  99
 100   void suicide ();
 101   bool is_live () const;
 102   bool is_empty (Axis a) const;
 103
 104   bool internal_has_interface (SCM intf);
 105   static bool has_interface (Grob *me);
 106
 107   virtual void handle_broken_dependencies ();
 108   virtual void handle_prebroken_dependencies ();
 109
 110   Interval extent (Grob * refpoint, Axis) const;
 111
 112   void translate_axis (Real, Axis);
 113   Real relative_coordinate (Grob const *refp, Axis) const;
 114   Grob *common_refpoint (Grob const *s, Axis a) const;
 115
 116   // duh. slim down interface here. (todo)
 117   bool has_offset_callback (SCM callback, Axis) const;
 118   void add_offset_callback (SCM callback, Axis);
 119   bool has_extent_callback (SCM, Axis) const;
 120   void set_extent (SCM, Axis);
 121   Real get_offset (Axis a) const;
 122
 123   void set_parent (Grob* e, Axis);
 124
 125   // URG
 126   Grob *get_parent (Axis a) const
 127   {
 128     return  dim_cache_[a].parent_;
 129   }
 130
 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 #endif /* GROB_HH */
 148