lily/include/tie-formatting-problem.hh

   1 /*
   2   tie-formatting-problem.hh -- declare
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #ifndef TIE_FORMATTING_PROBLEM_HH
  11 #define TIE_FORMATTING_PROBLEM_HH
  12
  13 #include "drul-array.hh"
  14 #include "parray.hh"
  15 #include "skyline.hh"
  16 #include "lily-proto.hh"
  17 #include "tie-configuration.hh"
  18
  19 #include <map>
  20 #include <set>
  21
  22 struct Tie_details
  23 {
  24   Real height_limit_;
  25   Real ratio_;
  26   Real staff_space_;
  27   Real x_gap_;
  28   Real between_length_limit_;
  29   Real wrong_direction_offset_penalty_;
  30   Real distance_penalty_factor_;
  31   Real length_penalty_factor_;
  32   Real min_length_;
  33   Real staff_line_clearance_;
  34   Real staff_line_collision_penalty_;
  35   Real dot_collision_clearance_;
  36   Real dot_collision_penalty_;
  37   Real tie_column_monotonicity_penalty_;
  38   Real tie_tie_collision_penalty_;
  39   Real tie_tie_collision_distance_;
  40
  41   Grob *staff_symbol_referencer_;
  42
  43   Tie_details ();
  44   void from_grob (Grob *);
  45 };
  46
  47
  48 typedef map< pair<int, int>, Tie_configuration *> Tie_configuration_map;
  49
  50 struct Tie_specification
  51 {
  52   int position_;
  53   Drul_array<Grob*> note_head_drul_;
  54
  55   bool has_manual_position_;
  56   bool has_manual_dir_;
  57
  58   Real manual_position_;
  59   Direction manual_dir_;
  60
  61   Tie_specification ();
  62 };
  63
  64 struct Tie_configuration_variation
  65 {
  66   int index_;
  67   Tie_configuration *suggestion_;
  68   Tie_configuration_variation ();
  69 };
  70
  71 class Tie_formatting_problem
  72 {
  73   Drul_array< Array<Skyline_entry> > chord_outlines_;
  74   set<int> dot_positions_;
  75   Interval dot_x_;
  76   Array<Tie_specification> specifications_;
  77
  78   Tie_configuration_map possibilities_;
  79
  80   Grob *x_refpoint_;
  81
  82
  83   Tie_configuration *get_configuration (int position, Direction dir);
  84   Tie_configuration *generate_configuration (int position, Direction dir) const;
  85   Array<Tie_configuration_variation> get_variations (Ties_configuration const &ties);
  86
  87   Real score_configuration (Tie_configuration const &) const;
  88   Real score_aptitude (Tie_configuration const &, Tie_specification const &) const;
  89   Real score_ties_aptitude (Ties_configuration const &ties) const;
  90   Real score_ties_configuration (Ties_configuration const &ties) const;
  91   void set_ties_config_standard_directions (Ties_configuration *tie_configs_ptr);
  92   Real score_ties (Ties_configuration const&) const;
  93   Ties_configuration generate_base_chord_configuration ();
  94
  95 public:
  96   Tie_details details_;
  97
  98 public:
  99   Tie_formatting_problem ();
 100   ~Tie_formatting_problem ();
 101
 102   Tie_specification get_tie_specification (int) const;
 103   Ties_configuration generate_optimal_chord_configuration ();
 104   Ties_configuration generate_ties_configuration (Ties_configuration const &);
 105   Tie_configuration find_optimal_tie_configuration (Tie_specification const &) const;
 106   void from_ties (Link_array<Grob> const &ties);
 107   void from_tie (Grob *tie);
 108   void from_lv_ties (Link_array<Grob> const &);
 109   void set_chord_outline (Link_array<Item>, Direction);
 110   void set_manual_tie_configuration (SCM);
 111   Interval get_attachment (Real) const;
 112   Grob *common_x_refpoint () const;
 113 };
 114
 115 #endif /* TIE_FORMATTING_PROBLEM_HH */