]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/simple-spacer.hh
Run grand replace for 2015.
[lilypond.git] / lily / include / simple-spacer.hh
index 1b963650e07184f4abe07a1814800e24d58808b3..d036dd191d3b3e5f8ff124a6cda6c2063bd7d34d 100644 (file)
@@ -1,91 +1,70 @@
-/*   
-  simple-spacer.hh -- declare Simple_spacer
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1999--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+/*
+  This file is part of LilyPond, the GNU music typesetter.
 
-#ifndef SIMPLE_SPACER_HH
-#define SIMPLE_SPACER_HH
-
-#include "parray.hh"
-#include "lily-proto.hh"
-
-
-struct Spring_description
-{
-  Real ideal_f_;
-  Real hooke_f_;
-  bool active_b_;
-
-  Real block_force_f_;
-
-  Real length (Real force) const;
-  Spring_description ();
-
-  bool sane_b () const;
-};
-
-/**
-   A simple spacing constraint solver. The approach:
-
-   Stretch the line uniformly until none of the constraints (rods)
-   block.  It then is very wide.
+  Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
 
-      Compress until the next constraint blocks,
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
 
-      Mark the springs over the constrained part to be non-active.
-      
-   Repeat with the smaller set of non-active constraints, until all
-   constraints blocked, or until the line is as short as desired.
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
-   This is much simpler, and much much faster than full scale
-   Constrained QP. On the other hand, a situation like this will not
-   be typeset as dense as possible, because
-
-   c4                   c4           c4                  c4
-   veryveryverylongsyllable2         veryveryverylongsyllable2
-   " "4                 veryveryverylongsyllable2        syllable4
-
-
-   can be further compressed to
-
-
-   c4    c4                        c4   c4
-   veryveryverylongsyllable2       veryveryverylongsyllable2
-   " "4  veryveryverylongsyllable2      syllable4
+#ifndef SIMPLE_SPACER_HH
+#define SIMPLE_SPACER_HH
 
+#include "std-vector.hh"
+#include "lily-proto.hh"
+#include "spring.hh"
+#include "smobs.hh"
 
-   Perhaps this is not a bad thing, because the 1st looks better anyway.  */
-struct Simple_spacer
+class Simple_spacer : public Simple_smob<Simple_spacer>
 {
-  Array<Spring_description> springs_;
-  Link_array<Grob> spaced_cols_;
-  Link_array<Grob> loose_cols_;
-  Real force_f_;
-  Real indent_f_;
-  Real line_len_f_;
-  Real default_space_f_;
-  int active_count_;
-
+public:
   Simple_spacer ();
-  
-  void solve (Column_x_positions *) const;
-  void add_columns (Link_array<Grob>);
-  void my_solve_linelen ();
-  void my_solve_natural_len ();
-  Real active_springs_stiffness () const;
-  Real range_stiffness (int, int) const;
+
+  void solve (Real line_len, bool ragged);
   void add_rod (int l, int r, Real dist);
-  Real range_ideal_len (int l, int r)const;
-  Real active_blocking_force ()const;
-  Real configuration_length ()const;
-  void set_active_states ();
-  bool active_b () const;
+  void add_spring (Spring const &);
+  Real range_ideal_len (int l, int r) const;
+  Real range_stiffness (int l, int r, bool stretch) const;
+  Real configuration_length (Real) const;
+  vector<Real> spring_positions () const;
+
+  void set_force (Real force);
+  Real force () const;
+  Real force_penalty (bool ragged) const;
+  bool fits () const;
+
+
+private:
+  Real expand_line ();
+  Real compress_line ();
+  Real rod_force (int l, int r, Real dist);
+
+  vector<Spring> springs_;
+  Real line_len_;
+  Real force_;
+  bool ragged_;
+  bool fits_;
 };
 
-#endif /* SIMPLE_SPACER_HH */
+/* returns a vector of dimensions breaks.size () * breaks.size () */
+vector<Real> get_line_forces (vector<Grob *> const &columns,
+                              Real line_len,
+                              Real indent,
+                              bool ragged);
+
+Column_x_positions get_line_configuration (vector<Grob *> const &columns,
+                                           Real line_len,
+                                           Real indent,
+                                           bool ragged);
 
+#endif /* SIMPLE_SPACER_HH */