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
  43   // rename me to ``property_alist_''
  44   SCM mutable_property_alist_;
  45
  46   Grob *original_l_;
  47
  48   /**
  49     Administration: Where are we?. This is mainly used by Super_element and
  50     Grob::calcalute_dependencies ()
  51
  52     0 means ORPHAN,
  53    */
  54   char status_c_;
  55   String name () const;
  56
  57   /*
  58     IDEA: make this a global variable. This is the same for all
  59     elements, I think it is safe to assume that we will not have
  60     scores being formatted multithreadedly.
  61    */
  62   Paper_score *pscore_l_;
  63
  64   Grob (SCM basic_props);
  65   Grob (Grob 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 #if 0
  74   void set_immutable_grob_property (const char * , SCM val);
  75   void set_immutable_grob_property (SCM key, SCM val);
  76 #endif
  77
  78   void warning (String);
  79
  80   void set_elt_pointer (const char*, SCM val);
  81   friend class Property_engraver; //  UGHUGHUGH.
  82   SCM remove_grob_property (const char* nm);
  83
  84   /*
  85     related classes.
  86    */
  87   Paper_def *paper_l () const;
  88
  89   /**
  90     add a dependency. It may be the 0 pointer, in which case, it is ignored.
  91     */
  92   void add_dependency (Grob*);
  93   virtual System * line_l () const;
  94   bool linked_b () const;
  95
  96
  97   VIRTUAL_COPY_CONS (Grob);
  98
  99   /**
 100      Recursively track all dependencies of this Grob.  The
 101      status_c_ field is used as a mark-field.  It is marked with
 102      #busy# during execution of this function, and marked with #final#
 103      when finished.
 104
 105      #funcptr# is the function to call to update this element.
 106    */
 107   void calculate_dependencies (int final, int busy, SCM funcname);
 108   static SCM handle_broken_grobs(SCM, SCM criterion);
 109
 110   virtual void do_break_processing ();
 111   virtual Grob *find_broken_piece (System*) const;
 112   virtual void discretionary_processing ();
 113   virtual SCM do_derived_mark ();
 114
 115   Molecule * get_molecule () const;
 116   SCM get_uncached_molecule () const;
 117
 118   void suicide ();
 119
 120   DECLARE_SCHEME_CALLBACK (preset_extent, (SCM smob, SCM axis));
 121   DECLARE_SCHEME_CALLBACK (point_dimension_callback, (SCM smob, SCM axis));
 122   DECLARE_SCHEME_CALLBACK (molecule_extent, (SCM smob, SCM axis));
 123
 124
 125   static SCM ly_set_grob_property (SCM, SCM,SCM);
 126   static SCM ly_get_grob_property (SCM, SCM);
 127
 128   bool internal_has_interface (SCM intf);
 129   static bool has_interface (Grob*me);
 130
 131   virtual void handle_broken_dependencies ();
 132   virtual void handle_prebroken_dependencies ();
 133
 134
 135   DECLARE_SMOBS (Grob,foo);
 136
 137   void init ();
 138
 139   Dimension_cache dim_cache_[NO_AXES];
 140
 141 public:
 142
 143   bool empty_b (Axis a) const;
 144
 145   Interval extent (Grob * refpoint, Axis) const;
 146
 147   /**
 148     translate in one direction
 149     */
 150
 151   void translate_axis (Real, Axis);
 152
 153   /**
 154      Find the offset relative to D.  If   D equals THIS, then it is 0.
 155      Otherwise, it recursively defd as
 156
 157      OFFSET_ + PARENT_L_->relative_coordinate (D)
 158    */
 159   Real relative_coordinate (Grob const* refp, Axis) const;
 160   /**
 161     Find the group-element which has both #this# and #s#
 162    */
 163   Grob*common_refpoint (Grob const* s, Axis a) const;
 164
 165
 166   // duh. slim down interface here. (todo)
 167   bool has_offset_callback_b (SCM callback, Axis)const;
 168   void add_offset_callback (SCM callback, Axis);
 169   bool has_extent_callback_b (SCM, Axis)const;
 170   void set_extent (SCM , Axis);
 171
 172
 173   /**
 174     Invoke callbacks to get offset relative to parent.
 175    */
 176   Real get_offset (Axis a) const;
 177   /**
 178      Set the  parent refpoint of THIS to E
 179    */
 180   void set_parent (Grob* e, Axis);
 181
 182   Grob *get_parent (Axis a) const {   return  dim_cache_[a].parent_l_; }
 183   DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM));
 184 };
 185
 186 DECLARE_UNSMOB(Grob,grob);
 187 Spanner* unsmob_spanner (SCM );
 188 Item* unsmob_item (SCM );
 189
 190 Grob*common_refpoint_of_list (SCM elt_list, Grob * , Axis a);
 191 Grob*common_refpoint_of_array (Link_array<Grob> const&, Grob * , Axis a);
 192
 193 #endif // STAFFELEM_HH
 194