]> git.donarmstrong.com Git - lilypond.git/blob - lily/dot-column.cc
Doc-es: Update of Input.
[lilypond.git] / lily / dot-column.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
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 #include "dot-column.hh"
21
22 #include <cstdio>
23 #include <cmath>
24 #include <map>
25 #include <set>
26
27 using namespace std;
28
29 #include "axis-group-interface.hh"
30 #include "directional-element-interface.hh"
31 #include "dot-column.hh"
32 #include "dot-configuration.hh"
33 #include "dot-formatting-problem.hh"
34 #include "dots.hh"
35 #include "grob.hh"
36 #include "note-head.hh"
37 #include "pointer-group-interface.hh"
38 #include "rest.hh"
39 #include "rhythmic-head.hh"
40 #include "side-position-interface.hh"
41 #include "staff-symbol-referencer.hh"
42 #include "stem.hh"
43
44 MAKE_SCHEME_CALLBACK (Dot_column, calc_positioning_done, 1);
45 SCM
46 Dot_column::calc_positioning_done (SCM smob)
47 {
48   Grob *me = unsmob_grob (smob);  
49
50   /*
51     Trigger note collision resolution first, since that may kill off
52     dots when merging.
53   */
54   if (Grob *collision = unsmob_grob (me->get_object ("note-collision")))
55     (void) collision->get_property ("positioning-done");
56
57   me->set_property ("positioning-done", SCM_BOOL_T);
58
59   vector<Grob*> dots
60     = extract_grob_array (me, "dots");
61
62   vector<Grob*> main_heads;
63   Real ss = 0;
64
65   Grob *commonx = me;
66   for (vsize i = 0; i < dots.size (); i++)
67     {
68       Grob *n = dots[i]->get_parent (Y_AXIS);
69       commonx = n->common_refpoint (commonx, X_AXIS);
70       
71       if (Grob *stem = unsmob_grob (n->get_object("stem")))
72         {
73           commonx = stem->common_refpoint (commonx, X_AXIS);
74           
75           if (Stem::first_head (stem) == n)
76             main_heads.push_back (n);
77         }
78     }
79
80   vector<Box> boxes;
81   set<Grob*> stems;
82
83   extract_grob_set(me, "side-support-elements", support);
84
85   Interval base_x;
86   for (vsize i = 0; i < main_heads.size (); i++)
87     base_x.unite (main_heads[i]->extent (commonx, X_AXIS));
88  
89   for (vsize i = 0; i < support.size (); i++)
90     {
91       Grob *s = support[i];
92       if (!ss)
93         ss = Staff_symbol_referencer::staff_space (s);
94
95       /* can't inspect Y extent of rest.
96          
97          Rest collisions should wait after line breaking.
98       */
99       Interval y;
100       if (Rest::has_interface (s))
101         {
102           base_x.unite (s->extent (commonx, X_AXIS));
103           continue;
104         }
105       else if (Stem::has_interface (s))
106         {
107           Real y1 = Stem::head_positions (s)[-get_grob_direction (s)];
108           Real y2 = y1 + get_grob_direction (s) * 7;
109
110           y.add_point (y1);
111           y.add_point (y2);
112         }
113       else if (Note_head::has_interface (s))
114         y = Interval (-1, 1);
115       else
116         {
117           programming_error ("unknown grob in dot col support");
118           continue;
119         }
120
121       y *= 2 / ss;
122       y += Staff_symbol_referencer::get_position (s);
123
124       Box b (s->extent (commonx, X_AXIS), y);
125       boxes.push_back (b);
126
127       if (Grob *stem = unsmob_grob (s->get_object ("stem")))
128         stems.insert (stem);
129     }
130
131   for (set<Grob*>::const_iterator i(stems.begin());
132        i != stems.end (); i++)
133     {
134       Grob *stem = (*i);
135       Stencil flag = Stem::flag (stem);
136       if (!flag.is_empty ())
137         {
138           Interval y = flag.extent (Y_AXIS)
139             * (2 / ss)
140             + Stem::stem_end_position (stem);
141
142           Interval x = stem->relative_coordinate (commonx, X_AXIS)
143             + flag.extent (X_AXIS);
144
145           boxes.push_back (Box (x,y));
146         }
147     }
148               
149   vector_sort (dots, position_less);
150   for (vsize i = dots.size (); i--;)
151     if (!dots[i]->is_live ())
152       dots.erase (dots.begin () + i);
153
154   Dot_formatting_problem problem (boxes, base_x);
155
156   Dot_configuration cfg (problem);
157   for (vsize i = 0; i < dots.size (); i++)
158     {
159       Dot_position dp;
160       dp.dot_ = dots[i];
161
162       Grob *note = dots[i]->get_parent (Y_AXIS);
163       if (note)
164         {
165           Grob *stem = unsmob_grob (note->get_object ("stem"));
166           if (stem)
167             dp.extremal_head_ = Stem::first_head (stem) == note;
168           
169           dp.x_extent_ = note->extent (commonx, X_AXIS);
170         }
171
172       int p = Staff_symbol_referencer::get_rounded_position (dp.dot_);
173
174       /* icky, since this should go via a Staff_symbol_referencer
175          offset callback but adding a dot overwrites Y-offset. */
176       p += (int) robust_scm2double (dp.dot_->get_property ("staff-position"), 0.0);
177       dp.pos_ = p;
178       if (dp.extremal_head_)
179         dp.dir_ = to_dir (dp.dot_->get_property ("direction"));
180
181       cfg.remove_collision (p);
182       cfg[p] = dp;
183       if (Staff_symbol_referencer::on_line (dp.dot_, p))
184         cfg.remove_collision (p);
185     }
186
187   problem.register_configuration (cfg);
188
189   for (Dot_configuration::const_iterator i (cfg.begin ());
190        i != cfg.end (); i++)
191     {
192       /*
193         Junkme?
194        */
195       Staff_symbol_referencer::set_position (i->second.dot_, i->first);
196     }
197   
198   me->translate_axis (cfg.x_offset () - me->relative_coordinate (commonx, X_AXIS),
199                       X_AXIS);
200   return SCM_BOOL_T;
201 }
202
203 void
204 Dot_column::add_head (Grob *me, Grob *head)
205 {
206   Grob *d = unsmob_grob (head->get_object ("dot"));
207   if (d)
208     {
209       Side_position_interface::add_support (me, head);
210
211       Pointer_group_interface::add_grob (me, ly_symbol2scm ("dots"), d);
212       d->set_property ("Y-offset", Grob::x_parent_positioning_proc);
213       // Dot formatting requests the Y-offset, -which- for rests may
214       // trigger post-linebreak callbacks.
215       if (!Rest::has_interface (head))
216         d->set_property ("X-offset", Grob::x_parent_positioning_proc);
217       Axis_group_interface::add_element (me, d);
218     }
219 }
220
221 ADD_INTERFACE (Dot_column,
222                "Group dot objects so they form a column, and position"
223                " dots so they do not clash with staff lines.",
224
225                /* properties */
226                "dots "
227                "positioning-done "
228                "direction "
229                );
230