lily/include/item.hh

   1 /*
   2   item.hh -- declare Item
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8 #ifndef ITEM_HH
   9 #define ITEM_HH
  10
  11
  12 #include "box.hh"
  13 #include "string.hh"
  14 #include "score-element.hh"
  15 #include "drul-array.hh"
  16 #include "protected-scm.hh"
  17
  18 /**
  19   A horizontally fixed size element of the score.
  20
  21   Item is the datastructure for printables whose width is known
  22   before the spacing is calculated
  23
  24   NB. This doesn't mean an Item has to initialize the output field before
  25   spacing calculation.
  26
  27
  28
  29   @signature
  30   visibility_lambda :: int -> (bool . bool)
  31
  32   @in
  33   break direction
  34
  35   @out
  36   (transparent, empty) cons
  37
  38    */
  39 class Item : public virtual Score_element {
  40   void do_break ();
  41   void try_visibility_lambda ();
  42
  43 public:
  44   Link_array<Spanner> attached_span_l_arr_;
  45   Drul_array<Item*> broken_to_drul_;
  46   Item *unbroken_original_l_;
  47
  48   /// should be put in a breakable col.
  49   bool breakable_b_;
  50
  51   /// I am really to be broken?
  52   virtual bool breakable_b () const;
  53
  54   Direction break_status_dir_;
  55   int break_priority_i_;
  56
  57   /// nobreak = 0, pre = -1, post = 1
  58   Direction break_status_dir() const;
  59   Item * find_prebroken_piece (Direction) const;
  60   Item * find_prebroken_piece (Line_of_score*) const;
  61
  62   Item();
  63   Real hpos_f() const;
  64
  65   virtual Line_of_score * line_l() const;
  66   virtual Paper_column * column_l () const;
  67
  68   static int left_right_compare (Item const *, Item const*);
  69
  70   Item (Item const &);
  71 protected:
  72   virtual void do_breakable_col_processing();
  73   virtual void handle_prebroken_dependencies();
  74   virtual void do_print() const;
  75   virtual bool linked_b() const;
  76
  77   virtual void handle_prebroken_dependents ();
  78
  79   void copy_breakable_items();
  80 };
  81
  82
  83
  84 #endif