lily/include/system.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2010 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
  40 public:
  41   Paper_score *paper_score () const;
  42   Grob *get_vertical_alignment ();
  43   Grob *get_extremal_staff (Direction dir, Interval const&);
  44   int get_rank () const;
  45   void do_break_substitution_and_fixup_refpoints ();
  46   void post_processing ();
  47   SCM get_paper_system ();
  48   SCM get_paper_systems ();
  49   SCM get_broken_system_grobs ();
  50
  51   DECLARE_SCHEME_CALLBACK (calc_pure_relevant_grobs, (SCM));
  52   DECLARE_SCHEME_CALLBACK (height, (SCM));
  53   DECLARE_SCHEME_CALLBACK (calc_pure_height, (SCM, SCM, SCM));
  54
  55   System (SCM);
  56   System (System const &);
  57
  58   int element_count () const;
  59   int spanner_count () const;
  60
  61   void break_into_pieces (vector<Column_x_positions> const &);
  62   DECLARE_GROB_INTERFACE();
  63
  64   vector<Item*> broken_col_range (Item const *, Item const *) const;
  65   vector<Grob*> used_columns () const;
  66   Paper_column *column (vsize i) const;
  67
  68   void add_column (Paper_column *);
  69   void typeset_grob (Grob *);
  70   void pre_processing ();
  71
  72   Interval begin_of_line_pure_height (vsize start, vsize end);
  73   Interval rest_of_line_pure_height (vsize start, vsize end);
  74   Interval pure_refpoint_extent (vsize start, vsize end);
  75
  76 protected:
  77   virtual void derived_mark () const;
  78   virtual Grob *clone () const;
  79
  80 private:
  81   Interval part_of_line_pure_height (vsize start, vsize end, bool begin);
  82 };
  83
  84 void set_loose_columns (System *which, Column_x_positions const *posns);
  85
  86 #endif /* SYSTEM_HH */
  87