lily/include/system.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2011 Han-Wen Nienhuys
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef SYSTEM_HH
  21 #define SYSTEM_HH
  22
  23 #include "column-x-positions.hh"
  24 #include "spanner.hh"
  25 #include "skyline.hh"
  26
  27 /*
  28   If you keep following offset reference points, you will always end
  29   up at the root object. This root object is called @ref{System}, and it
  30   represents a system (i.e. a line of music).
  31 */
  32 class System : public Spanner
  33 {
  34   int rank_;
  35   Grob_array *all_elements_;
  36   void init_elements ();
  37   friend class Paper_score;     // ugh.
  38   Paper_score *pscore_; // ugh.
  39   bool checked_footnotes_;
  40   vector<Grob *> footnote_grobs_; // TODO: make this a grob array
  41
  42 public:
  43   Paper_score *paper_score () const;
  44   Grob *get_vertical_alignment ();
  45   Grob *get_extremal_staff (Direction dir, Interval const &);
  46   Grob *get_pure_bound (Direction dir, int start, int end);
  47   Grob *get_maybe_pure_bound (Direction dir, bool pure, int start, int end);
  48   int get_rank () const;
  49   vector<Stencil *> get_footnotes_in_range (vsize st, vsize end);
  50   void get_footnote_grobs_in_range (vector<Grob *> &out, vsize st, vsize end);
  51   vector<Grob *> *footnote_grobs ();
  52   vsize num_footnotes ();
  53   void do_break_substitution_and_fixup_refpoints ();
  54   void post_processing ();
  55   void populate_footnote_grob_vector ();
  56   SCM get_paper_system ();
  57   SCM get_paper_systems ();
  58   SCM get_broken_system_grobs ();
  59   SCM get_broken_footnote_stencils ();
  60
  61   DECLARE_SCHEME_CALLBACK (calc_pure_relevant_grobs, (SCM));
  62   DECLARE_SCHEME_CALLBACK (height, (SCM));
  63   DECLARE_SCHEME_CALLBACK (calc_pure_height, (SCM, SCM, SCM));
  64
  65   System (SCM);
  66   System (System const &);
  67
  68   int element_count () const;
  69   int spanner_count () const;
  70
  71   void break_into_pieces (vector<Column_x_positions> const &);
  72   DECLARE_GROB_INTERFACE ();
  73
  74   vector<Item *> broken_col_range (Item const *, Item const *) const;
  75   vector<Grob *> used_columns () const;
  76   Paper_column *column (vsize i) const;
  77
  78   void add_column (Paper_column *);
  79   void typeset_grob (Grob *);
  80   void pre_processing ();
  81
  82   Interval begin_of_line_pure_height (vsize start, vsize end);
  83   Interval rest_of_line_pure_height (vsize start, vsize end);
  84   Interval pure_refpoint_extent (vsize start, vsize end);
  85   void collect_labels (Grob const *, SCM *);
  86
  87 protected:
  88   virtual void derived_mark () const;
  89   virtual Grob *clone () const;
  90
  91 private:
  92   Interval part_of_line_pure_height (vsize start, vsize end, bool begin);
  93 };
  94
  95 void set_loose_columns (System *which, Column_x_positions const *posns);
  96
  97 #endif /* SYSTEM_HH */
  98