lily/include/tie-formatting-problem.hh

   1 /*
   2   tie-formatting-problem.hh -- declare Tie_formatting_problem
   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 "std-vector.hh"
  15 #include "skyline.hh"
  16 #include "lily-proto.hh"
  17 #include "tie-configuration.hh"
  18 #include "tie-details.hh"
  19
  20 #include <map>
  21 #include <set>
  22
  23 template<class T, int N>
  24 struct Tuple
  25 {
  26   T t_array[N];
  27   Tuple (T const *src)
  28   {
  29     for (int i = 0; i < N; i++)
  30       t_array[i] = src[i];
  31   }
  32 };
  33
  34 template<class T, int N>
  35 inline bool
  36 operator<(Tuple<T, N> const &t1,
  37           Tuple<T, N> const &t2)
  38 {
  39   for (int i = 0; i < N ; i++)
  40     {
  41       if (t1.t_array[i] > t2.t_array[i])
  42         return false;
  43       if (t1.t_array[i] < t2.t_array[i])
  44         return true;
  45     }
  46
  47   return false;
  48 }
  49
  50
  51 typedef map< Tuple<int,4>, Tie_configuration *> Tie_configuration_map;
  52
  53 struct Tie_specification
  54 {
  55   int position_;
  56   Drul_array<Grob*> note_head_drul_;
  57   Drul_array<int> column_ranks_;
  58
  59   bool has_manual_position_;
  60   bool has_manual_dir_;
  61
  62   Real manual_position_;
  63   Direction manual_dir_;
  64
  65   Tie_specification ();
  66   int column_span () const;
  67 };
  68
  69 struct Tie_configuration_variation
  70 {
  71   int index_;
  72   Tie_configuration *suggestion_;
  73   Tie_configuration_variation ();
  74 };
  75
  76 typedef map <int, vector<Skyline_entry> > Chord_outline_map;
  77 typedef map <int, Box> Column_extent_map;
  78 class Tie_formatting_problem
  79 {
  80   Chord_outline_map chord_outlines_;
  81   Column_extent_map stem_extents_;
  82   Column_extent_map head_extents_;
  83
  84   set<int> dot_positions_;
  85   Interval dot_x_;
  86   vector<Tie_specification> specifications_;
  87
  88   Tie_configuration_map possibilities_;
  89
  90   Grob *x_refpoint_;
  91
  92
  93   Tie_configuration *get_configuration (int position, Direction dir, Drul_array<int> cols) const;
  94   Tie_configuration *generate_configuration (int position, Direction dir, Drul_array<int> cols) const;
  95   vector<Tie_configuration_variation> generate_collision_variations (Ties_configuration const &ties) const;
  96   vector<Tie_configuration_variation> generate_extremal_tie_variations (Ties_configuration const &ties) const;
  97
  98   void score_configuration (Tie_configuration *) const;
  99   Real score_aptitude (Tie_configuration *, Tie_specification const &,
 100                        Ties_configuration *, int) const;
 101   void score_ties_aptitude (Ties_configuration *ties) const;
 102   void score_ties_configuration (Ties_configuration *ties) const;
 103   void set_ties_config_standard_directions (Ties_configuration *tie_configs_ptr);
 104   void score_ties (Ties_configuration *) const;
 105
 106   Ties_configuration generate_base_chord_configuration ();
 107   Ties_configuration find_best_variation (Ties_configuration const &base,
 108                                           vector<Tie_configuration_variation> vars);
 109
 110 public:
 111   Tie_details details_;
 112   void print_ties_configuration (Ties_configuration const *);
 113
 114   Interval get_stem_extent (int, Axis) const;
 115   Interval get_head_extent (int, Axis) const;
 116
 117 public:
 118   Tie_formatting_problem ();
 119   ~Tie_formatting_problem ();
 120
 121   Tie_specification get_tie_specification (int) const;
 122   Ties_configuration generate_optimal_chord_configuration ();
 123   Ties_configuration generate_ties_configuration (Ties_configuration const &);
 124   Tie_configuration find_optimal_tie_configuration (Tie_specification const &) const;
 125
 126   void from_ties (vector<Grob*> const &ties);
 127   void from_tie (Grob *tie);
 128   void from_semi_ties (vector<Grob*> const &, Direction head_dir);
 129   void set_chord_outline (vector<Item*>, Direction);
 130   void set_column_chord_outline (vector<Item*>, Direction, int rank);
 131   void set_manual_tie_configuration (SCM);
 132   Interval get_attachment (Real, Drul_array<int>) const;
 133   Grob *common_x_refpoint () const;
 134 };
 135
 136 #endif /* TIE_FORMATTING_PROBLEM_HH */