lily/include/p-score.hh

   1 /*
   2   p-score.hh -- declare PScore
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996,1997 Han-Wen Nienhuys <hanwen@stack.nl>
   7 */
   8
   9
  10 #ifndef P_SCORE_HH
  11 #define P_SCORE_HH
  12
  13 #include "colhpos.hh"
  14 #include "parray.hh"
  15 #include "lily-proto.hh"
  16 #include "plist.hh"
  17
  18 /** all stuff which goes onto paper. notes, signs, symbols in a score
  19      #PScore# contains the items, the columns.
  20
  21     */
  22
  23 class PScore {
  24 public:
  25     Paper_def *paper_l_;
  26
  27     /// the columns, ordered left to right
  28     Pointer_list<PCol *> col_p_list_;
  29
  30     /// the idealspacings, no particular order
  31     Pointer_list<Idealspacing*> suz_p_list_;
  32
  33     /// crescs etc; no particular order
  34     Pointer_list<Spanner *> span_p_list_;
  35
  36     /// other elements
  37     Pointer_list<Score_elem*> elem_p_list_;
  38
  39     Super_elem *super_elem_l_;
  40
  41     /* *************** */
  42     /* CONSTRUCTION */
  43
  44     PScore(Paper_def*);
  45     /// add a line to the broken stuff. Positions given in #config#
  46     void set_breaking(Array<Col_hpositions> const &);
  47
  48     /** add an item.
  49        add the item in specified containers. If breakstatus is set
  50        properly, add it to the {pre,post}break of the pcol.
  51        */
  52     void typeset_item(Item *item_p,  PCol *pcol_l,int breakstatus=0);
  53
  54     ///    add to bottom of pcols
  55     void add(PCol*);
  56
  57     /**
  58       @return argument as a cursor of the list
  59       */
  60     PCursor<PCol *> find_col(PCol const *)const;
  61
  62     Link_array<PCol> col_range(PCol *left_l, PCol *right_l) const;
  63     Link_array<PCol> breakable_col_range(PCol*,PCol*) const;
  64     Link_array<PCol> broken_col_range(PCol*,PCol*) const;
  65
  66     /* MAIN ROUTINES */
  67     void process();
  68
  69     /// last deed of this struct
  70     void output(Tex_stream &ts);
  71
  72     /* UTILITY ROUTINES */
  73
  74
  75     /* STANDARD ROUTINES */
  76     void OK()const;
  77     void print() const;
  78     ~PScore();
  79     void typeset_element(Score_elem*);
  80     void typeset_broken_spanner(Spanner*);
  81     /// add a Spanner
  82     void typeset_unbroken_spanner(Spanner*);
  83
  84
  85 private:
  86     /// before calc_breaking
  87     void preprocess();
  88
  89     void calc_idealspacing();
  90     /// calculate where the lines are to be broken, and use results
  91     void calc_breaking();
  92
  93     /// after calc_breaking
  94     void postprocess();
  95
  96     /// delete unused columns
  97     void clean_cols();
  98 };
  99
 100 #endif