lily/include/spacing-spanner.hh

   1 /*
   2   spacing-spanner.hh -- declare Spacing spanner
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #ifndef SPACING_SPANNER_HH
  11 #define SPACING_SPANNER_HH
  12
  13 #include "lily-proto.hh"
  14 #include "lily-guile.hh"
  15 #include "rational.hh"
  16
  17 struct Spacing_options
  18 {
  19   bool packed_;
  20   bool stretch_uniformly_;
  21   bool float_nonmusical_columns_;
  22   Rational global_shortest_;
  23   Real increment_;
  24   Real shortest_duration_space_;
  25
  26   void init ();
  27   void init_from_grob (Grob *me);
  28   Real get_duration_space (Moment d, bool*) const;
  29 };
  30
  31 /*
  32   TODO: prune to public interface.
  33  */
  34 class Spacing_spanner
  35 {
  36 public:
  37   static void generate_pair_spacing (Grob *me,
  38                                      Paper_column *l, Paper_column *r,
  39                                      Paper_column *nextr,
  40                                      Spacing_options const *options);
  41   static void standard_breakable_column_spacing (Grob *me, Item *l, Item *r,
  42                                                  Real *fixed, Real *space,
  43                                                  Spacing_options const*);
  44   static Real default_bar_spacing (Grob *, Grob *, Grob *, Moment);
  45   static Real note_spacing (Grob *, Grob *, Grob *, Spacing_options const*, bool *);
  46   static Real get_duration_space (Moment dur, Spacing_options const*,  bool *);
  47   static Rational find_shortest (Grob *, Link_array<Grob> const &);
  48   static Rational effective_shortest_duration (Grob *me, Link_array<Grob> const &all);
  49   static void breakable_column_spacing (Grob *, Item *l, Item *r, Spacing_options const*);
  50   static void prune_loose_columns (Grob *, Link_array<Grob> *cols, Spacing_options const*);
  51   static void set_explicit_neighbor_columns (Link_array<Grob> const &cols);
  52   static void set_implicit_neighbor_columns (Link_array<Grob> const &cols);
  53   static void generate_springs (Grob *me, Link_array<Grob> const &cols, Spacing_options const*);
  54   static void musical_column_spacing (Grob *, Item *, Item *, Spacing_options const*);
  55   DECLARE_SCHEME_CALLBACK (set_springs, (SCM));
  56   static bool has_interface (Grob *);
  57 };
  58
  59 #endif /* SPACING_SPANNER_HH */