lily/include/score-element.hh

   1 /*
   2   score-element.hh -- declare Score_element
   3
   4   (c) 1996-1999 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
  16 typedef void (Score_element::*Score_element_method_pointer) (void);
  17
  18 /** Both Spanner and Item are Score_element's. Most Score_element's depend
  19   on other Score_element's, eg, Beam needs to know and set direction of
  20   Stem. So the Beam has to be calculated *before* Stem. This is
  21   accomplished with the dependencies fields of struct Score_element,
  22   which are implemented in the Directed_graph_node class: all elements
  23   form an acyclic graph.
  24
  25   (elem)
  26
  27
  28 Element Properties:
  29
  30 Boolean (true iff defined)
  31
  32  break_helper_only -- if defined try to junk this after calcing breakpoints.
  33
  34  transparent -- do not calc. output
  35
  36 */
  37 class Score_element  {
  38   /**
  39      properties specific for this element. Destructor will not call
  40      scm_unprotect, so as to allow more flexible GC arrangements.  The
  41      real alist is in (cdr element_property_alist_), to reduce the
  42      need for more scm_protect calls.
  43
  44   */
  45   SCM element_property_alist_;
  46   Link_array<Score_element> dependency_arr_;
  47   /**
  48      The lookup, determined by the font size. Cache this value.
  49    */
  50   Lookup * lookup_l_;
  51 public:
  52   Score_element *original_l_;
  53
  54   /**
  55     Administration: Where are we?. This is mainly used by Super_element and
  56     Score_element::calcalute_dependencies ()
  57
  58     0 means ORPHAN,
  59     -1 means deleted
  60
  61    */
  62   int status_i_;
  63
  64   Paper_score *pscore_l_;
  65   Molecule * output_p_;
  66   Score_element ();
  67   Score_element (Score_element const&);
  68   virtual void print () const;
  69
  70   /*
  71     properties
  72    */
  73   SCM get_elt_property (String nm) const;
  74   void set_elt_property (String, SCM val);
  75   SCM remove_elt_property (String nm);
  76
  77   /*
  78     related classes.
  79    */
  80   Paper_def *paper_l () const;
  81   Lookup const *lookup_l () const;
  82
  83   void add_processing ();
  84
  85   /**
  86     add a dependency. It may be the 0 pointer, in which case, it is ignored.
  87     */
  88   void add_dependency (Score_element*);
  89   virtual Line_of_score * line_l () const;
  90   bool linked_b () const;
  91   VIRTUAL_COPY_CONS(Score_element);
  92
  93   /**
  94      Recursively track all dependencies of this Score_element.  The
  95      status_i_ field is used as a mark-field.  It is marked with
  96      #busy# during execution of this function, and marked with #final#
  97      when finished.
  98
  99      #funcptr# is the function to call to update this element.
 100    */
 101   void calculate_dependencies (int final, int busy, Score_element_method_pointer funcptr);
 102
 103   static SCM handle_broken_smobs (SCM, SCM criterion);
 104   void recurse_into_smobs (SCM s, void (Score_element::*meth_ptr)());
 105
 106
 107   virtual Score_element *find_broken_piece (Line_of_score*) const;
 108 protected:
 109
 110   /**
 111     Junk score element. This is protected because this is supposed to
 112     be handled by GUILE gc.  */
 113   virtual ~Score_element ();
 114
 115   Score_element* dependency (int) const;
 116   int dependency_size () const;
 117
 118   virtual void output_processing ();
 119   static Interval molecule_extent (Dimension_cache const*);
 120
 121   /// do printing of derived info.
 122   virtual void do_print () const;
 123   /// generate the molecule
 124   virtual Molecule* do_brew_molecule_p () const;
 125   ///executed directly after the item is added to the Paper_score
 126   virtual void do_add_processing ();
 127   /// do calculations before determining horizontal spacing
 128   virtual void do_pre_processing ();
 129
 130   /// generate rods & springs
 131   virtual void do_space_processing ();
 132
 133   virtual void do_breakable_col_processing ();
 134   /// do calculations after determining horizontal spacing
 135   virtual void do_post_processing ();
 136
 137   virtual void do_break_processing ();
 138
 139   virtual Link_array<Score_element> get_extra_dependencies () const;
 140
 141   static Interval dim_cache_callback (Dimension_cache const*);
 142 public:
 143   virtual void handle_broken_dependencies ();
 144   virtual void handle_prebroken_dependencies ();
 145
 146
 147   DECLARE_SMOBS;
 148
 149   void init ();
 150
 151 public:
 152   Dimension_cache *dim_cache_[NO_AXES];
 153
 154   /**
 155      Set this if anyone points to me, or if I point to anyone.
 156    */
 157   bool used_b_;
 158
 159   char const * name () const;
 160   /**
 161      Set empty in direction A.
 162    */
 163   void set_empty (Axis a);
 164   bool empty_b (Axis a) const;
 165   void invalidate_cache (Axis);
 166   Interval extent (Axis) const;
 167
 168   /**
 169     translate in one direction
 170     */
 171
 172   void translate_axis (Real, Axis);
 173
 174   Real relative_coordinate (Score_element const* refp, Axis) const;
 175   /**
 176     Find the group-element which has both #this# and #s#
 177    */
 178   Score_element*common_refpoint (Score_element const* s, Axis a) const;
 179   Score_element*common_refpoint (Link_array<Score_element> elems, Axis a) const;
 180
 181   /**
 182      Set the  parent refpoint of THIS to E
 183    */
 184   void set_parent (Score_element* e, Axis);
 185
 186   Score_element *parent_l (Axis a) const;
 187   void fixup_refpoint ();
 188 };
 189
 190 Score_element * unsmob_element (SCM);
 191
 192
 193
 194 #endif // STAFFELEM_HH
 195