lily/include/page-spacing-result.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2007--2009 Han-Wen Nienhuys <hanwen@lilypond.org>
   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 PAGE_SPACING_RESULT_HH
  21 #define PAGE_SPACING_RESULT_HH
  22
  23 #include "std-vector.hh"
  24 #include "lily-proto.hh"
  25
  26 // This enum is a bitfield: since we use one System_count_status
  27 // to represent the system count of several pages simultaneously,
  28 // it could be that one page has too many systems while another
  29 // has too few.
  30 typedef enum {
  31   SYSTEM_COUNT_OK = 0,
  32   SYSTEM_COUNT_TOO_MANY = 1,
  33   SYSTEM_COUNT_TOO_FEW = 2
  34 } System_count_status;
  35
  36 struct Page_spacing_result {
  37   vector<vsize> systems_per_page_;
  38   vector<Real> force_;
  39   Real penalty_;
  40   Real demerits_;
  41   int system_count_status_;
  42
  43   Real average_force () const;
  44   vsize page_count () const;
  45   vsize system_count () const;
  46   void print () const;
  47   Page_spacing_result ();
  48 };
  49
  50 #endif /* PAGE_SPACING_RESULT_HH */