lily/include/grob.hh

   1 /*
   2   grob.hh -- declare Grob
   3
   4   (c) 1996-1999--2002 Han-Wen Nienhuys
   5 */
   6
   7 #ifndef STAFFELEM_HH
   8 #define STAFFELEM_HH
   9
  10 #include "parray.hh"
  11 #include "virtual-methods.hh"
  12 #include "lily-guile.hh"
  13 #include "lily-proto.hh"
  14 #include "smobs.hh"
  15 #include "dimension-cache.hh"
  16 #include "grob-interface.hh"
  17
  18 /**
  19     for administration of what was done already
  20     */
  21 enum Grob_status {
  22   ORPHAN=0,                     // not yet added to Paper_score
  23   VIRGIN,
  24   PRECALCING,
  25   PRECALCED,            // calcs before spacing done
  26   POSTCALCING,          // busy calculating. This is used to trap cyclic deps.
  27   POSTCALCED,           // after spacing calcs done
  28 };
  29
  30 typedef void (Grob::*Grob_method_pointer) (void);
  31
  32
  33 #define get_grob_property(x) internal_get_grob_property(ly_symbol2scm(x))
  34 #define set_grob_property(x,y) internal_set_grob_property(ly_symbol2scm(x),y)
  35
  36 /*
  37    Basic output object.
  38 */
  39 class Grob  {
  40 public:
  41   SCM immutable_property_alist_;
  42   SCM mutable_property_alist_;
  43
  44   Grob *original_l_;
  45
  46   /**
  47     Administration: Where are we?. This is mainly used by Super_element and
  48     Grob::calcalute_dependencies ()
  49
  50     0 means ORPHAN,
  51    */
  52   char status_c_;
  53
  54
  55   /*
  56     IDEA: make this a global variable. This is the same for all
  57     elements, I think it is safe to assume that we will not have
  58     scores being formatted multithreadedly.
  59    */
  60   Paper_score *pscore_l_;
  61   Dimension_cache dim_cache_[NO_AXES];
  62
  63   Grob (SCM basic_props);
  64   Grob (Grob const&);
  65   String name () const;
  66
  67   /*
  68     properties
  69    */
  70   SCM internal_get_grob_property (SCM) const;
  71   void internal_set_grob_property (SCM, SCM val);
  72
  73   void warning (String)const;
  74   void programming_error (String)const;
  75
  76   void set_elt_pointer (const char*, SCM val);
  77   friend class Property_engraver; //  UGHUGHUGH.
  78   SCM remove_grob_property (const char* nm);
  79
  80   /*
  81     related classes.
  82    */
  83   Paper_def *paper_l () const;
  84
  85   /**
  86     add a dependency. It may be the 0 pointer, in which case, it is ignored.
  87     */
  88   void add_dependency (Grob*);
  89   virtual System * line_l () const;
  90   bool linked_b () const;
  91
  92
  93   VIRTUAL_COPY_CONS (Grob);
  94
  95   /**
  96      Recursively track all dependencies of this Grob.  The
  97      status_c_ field is used as a mark-field.  It is marked with
  98      #busy# during execution of this function, and marked with #final#
  99      when finished.
 100
 101      #funcptr# is the function to call to update this element.
 102    */
 103   void calculate_dependencies (int final, int busy, SCM funcname);
 104   static SCM handle_broken_grobs(SCM, SCM criterion);
 105
 106   virtual void do_break_processing ();
 107   virtual Grob *find_broken_piece (System*) const;
 108   virtual void discretionary_processing ();
 109   virtual SCM do_derived_mark ();
 110
 111   Molecule * get_molecule () const;
 112   SCM get_uncached_molecule () const;
 113
 114   void suicide ();
 115
 116   DECLARE_SCHEME_CALLBACK (preset_extent, (SCM smob, SCM axis));
 117   DECLARE_SCHEME_CALLBACK (point_dimension_callback, (SCM smob, SCM axis));
 118   DECLARE_SCHEME_CALLBACK (molecule_extent, (SCM smob, SCM axis));
 119
 120
 121   static SCM ly_set_grob_property (SCM, SCM,SCM);
 122   static SCM ly_get_grob_property (SCM, SCM);
 123
 124   bool internal_has_interface (SCM intf);
 125   static bool has_interface (Grob*me);
 126
 127   virtual void handle_broken_dependencies ();
 128   virtual void handle_prebroken_dependencies ();
 129
 130
 131   DECLARE_SMOBS (Grob,foo);
 132
 133   void init ();
 134
 135
 136 public:
 137
 138   bool empty_b (Axis a) const;
 139
 140   Interval extent (Grob * refpoint, Axis) const;
 141
 142   /**
 143     translate in one direction
 144     */
 145
 146   void translate_axis (Real, Axis);
 147
 148   /**
 149      Find the offset relative to D.  If   D equals THIS, then it is 0.
 150      Otherwise, it recursively defd as
 151
 152      OFFSET_ + PARENT_L_->relative_coordinate (D)
 153    */
 154   Real relative_coordinate (Grob const* refp, Axis) const;
 155   /**
 156     Find the group-element which has both #this# and #s#
 157    */
 158   Grob*common_refpoint (Grob const* s, Axis a) const;
 159
 160
 161   // duh. slim down interface here. (todo)
 162   bool has_offset_callback_b (SCM callback, Axis)const;
 163   void add_offset_callback (SCM callback, Axis);
 164   bool has_extent_callback_b (SCM, Axis)const;
 165   void set_extent (SCM , Axis);
 166
 167
 168   /**
 169     Invoke callbacks to get offset relative to parent.
 170    */
 171   Real get_offset (Axis a) const;
 172   /**
 173      Set the  parent refpoint of THIS to E
 174    */
 175   void set_parent (Grob* e, Axis);
 176
 177   Grob *get_parent (Axis a) const {   return  dim_cache_[a].parent_l_; }
 178   DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM));
 179 };
 180
 181 DECLARE_UNSMOB(Grob,grob);
 182 Spanner* unsmob_spanner (SCM );
 183 Item* unsmob_item (SCM );
 184
 185 Grob*common_refpoint_of_list (SCM elt_list, Grob * , Axis a);
 186 Grob*common_refpoint_of_array (Link_array<Grob> const&, Grob * , Axis a);
 187
 188 #endif // STAFFELEM_HH
 189