]> git.donarmstrong.com Git - lilypond.git/blob - lily/paper-column.cc
print distances in Paper_column::print
[lilypond.git] / lily / paper-column.cc
1 /*
2   paper-column.cc -- implement Paper_column
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 */
8
9 #include "paper-column.hh"
10
11 #include "moment.hh"
12 #include "paper-score.hh"
13 #include "warn.hh"
14 #include "axis-group-interface.hh"
15 #include "spaceable-grob.hh"
16 #include "text-interface.hh"
17 #include "lookup.hh"
18 #include "font-interface.hh"
19 #include "output-def.hh"
20 #include "pointer-group-interface.hh"
21 #include "grob-array.hh"
22 #include "system.hh"
23 #include "spring.hh"
24 #include "lookup.hh"
25 #include "string-convert.hh"
26
27 Grob *
28 Paper_column::clone (int count) const
29 {
30   return new Paper_column (*this, count);
31 }
32
33 void
34 Paper_column::do_break_processing ()
35 {
36   Item::do_break_processing ();
37 }
38
39 int
40 Paper_column::get_rank (Grob const *me)
41 {
42   return dynamic_cast<Paper_column const *> (me)->rank_;
43 }
44
45 System *
46 Paper_column::get_system () const
47 {
48   return system_;
49 }
50
51 void
52 Paper_column::set_system (System *s)
53 {
54   system_ = s;
55 }
56
57 Paper_column *
58 Paper_column::get_column () const
59 {
60   return (Paper_column *) (this);
61 }
62
63 Paper_column::Paper_column (SCM l, Object_key const *key)
64   : Item (l, key)               // guh.?
65 {
66   system_ = 0;
67   rank_ = -1;
68 }
69
70 Paper_column::Paper_column (Paper_column const &src, int count)
71   : Item (src, count)
72 {
73   system_ = 0;
74   rank_ = src.rank_;
75 }
76
77 int
78 Paper_column::compare (Grob * const &a,
79                        Grob * const &b)
80 {
81   return sign (dynamic_cast<Paper_column*> (a)->rank_
82                - dynamic_cast<Paper_column*> (b)->rank_);
83 }
84
85 bool
86 Paper_column::less_than (Grob *const &a,
87                          Grob *const &b)
88 {
89   Paper_column *pa = dynamic_cast<Paper_column*> (a);
90   Paper_column *pb = dynamic_cast<Paper_column*> (b);
91   
92   return pa->rank_ < pb->rank_;
93 }
94
95 Moment
96 Paper_column::when_mom (Grob *me)
97 {
98   SCM m = me->get_property ("when");
99   if (Moment *when = unsmob_moment (m))
100     return *when;
101   return Moment (0);
102 }
103
104 bool
105 Paper_column::is_musical (Grob *me)
106 {
107   SCM m = me->get_property ("shortest-starter-duration");
108   Moment s (0);
109   if (unsmob_moment (m))
110     s = *unsmob_moment (m);
111   return s != Moment (0);
112 }
113
114 bool
115 Paper_column::is_used (Grob *me)
116 {
117   extract_grob_set (me, "elements", elts);
118   if (elts.size ())
119     return true;
120
121   extract_grob_set (me, "bounded-by-me", bbm);
122   if (bbm.size ())
123     return true;
124   
125   if (Paper_column::is_breakable (me))
126     return true;
127
128   if (to_boolean (me->get_property ("used")))
129     return true;
130   return false;
131 }
132
133 bool
134 Paper_column::is_breakable (Grob *me)
135 {
136   return scm_is_symbol (me->get_property ("line-break-permission"));
137 }
138
139 /*
140   Print a vertical line and  the rank number, to aid debugging.
141 */
142 MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
143 SCM
144 Paper_column::print (SCM p)
145 {
146   Paper_column *me = dynamic_cast<Paper_column*> (unsmob_grob (p));
147
148   string r = to_string (Paper_column::get_rank (me));
149
150   Moment *mom = unsmob_moment (me->get_property ("when"));
151   string when = mom ? mom->to_string () : "?/?";
152
153   Font_metric *musfont = Font_interface::get_default_font (me);
154   SCM properties = Font_interface::text_font_alist_chain (me);
155
156   SCM scm_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
157                                                   properties,
158                                                   ly_string2scm (r));
159   SCM when_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
160                                                    properties,
161                                                    ly_string2scm (when));
162   Stencil t = *unsmob_stencil (scm_mol);
163   t.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (when_mol), 0.1, 0.1);
164   t.align_to (X_AXIS, CENTER);
165   t.align_to (Y_AXIS, DOWN);
166
167   Stencil l = Lookup::filled_box (Box (Interval (-0.01, 0.01),
168                                        Interval (-2, -1)));
169   
170   System * my_system = me->get_system ();
171   SCM small_letters = scm_cons (scm_acons (ly_symbol2scm ("font-size"),
172                                            scm_from_int (-6), SCM_EOL),
173                                 properties);
174   
175   int j = 0;
176   for (SCM s = me->get_object ("ideal-distances");
177        scm_is_pair (s); s = scm_cdr (s))
178     {
179       Spring_smob *sp = unsmob_spring (scm_car (s));
180       
181       Real y = -j * 1 -3;
182       vector<Offset> pts;
183       pts.push_back (Offset (0, y));
184
185       Offset p2 (sp->distance_, y);
186       pts.push_back (p2);
187       
188       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
189       Stencil head (musfont->find_by_name ("arrowheads.open.01"));
190
191       SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
192                                                            small_letters,
193                                                            ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance_)));
194       
195       id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (sp->distance_/3, y+1)));
196       id_stencil.add_stencil (head.translated (p2));
197       id_stencil = id_stencil.in_color (0,0,1);
198       l.add_stencil (id_stencil);
199     }
200    
201   for (SCM s = me->get_object ("minimum-distances");
202        scm_is_pair (s); s = scm_cdr (s))
203     {
204       Real dist = scm_to_double (scm_cdar (s));
205
206       Real y = -j * 0.1 -3.5;
207       vector<Offset> pts;
208       pts.push_back (Offset (0, y));
209
210       Offset p2 (dist, y);
211       pts.push_back (p2);
212
213       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
214       Stencil head (musfont->find_by_name ("arrowheads.open.0M1"));
215       head.translate_axis (y, Y_AXIS);
216       id_stencil.add_stencil (head);
217
218       SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
219                                                            small_letters,
220                                                            ly_string2scm (String_convert::form_string ("%5.2lf",
221                                                                                                        dist)));
222           
223       id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (dist/3, y-1)));
224  
225        
226       id_stencil = id_stencil.in_color (1,0,0);
227       l.add_stencil (id_stencil);
228     }
229   t.add_stencil (l);
230   return t.smobbed_copy ();
231 }
232
233 /*
234   This is all too hairy. We use bounded-by-me to make sure that some
235   columns are kept "alive". Unfortunately, when spanners are suicided,
236   this falls apart again, because suicided spanners are still in
237   bounded-by-me
238
239   THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER.
240 */
241 MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1);
242 SCM
243 Paper_column::before_line_breaking (SCM grob)
244 {
245   Grob *me = unsmob_grob (grob);
246
247   SCM bbm = me->get_object ("bounded-by-me");
248   Grob_array *ga = unsmob_grob_array (bbm);
249   if (!ga)
250     return SCM_UNSPECIFIED;
251
252   vector<Grob*> &array (ga->array_reference ());
253
254   for (vsize i = array.size (); i--;)
255     {
256       Grob *g = array[i];
257
258       if (!g || !g->is_live ())
259         /* UGH . potentially quadratic. */
260         array.erase (array.begin () + i);
261     }
262
263   return SCM_UNSPECIFIED;
264 }
265
266
267 ADD_INTERFACE (Paper_column,
268                "@code{Paper_column} objects form the top-most X-parents for items."
269                "  The are two types of columns: musical columns, where are attached to, and "
270                "  non-musical columns, where bar-lines, clefs etc. are attached to. "
271                "  The spacing engine determines the X-positions of these objects."
272                
273                "\n\n"
274                "They are\n"
275                "  numbered, the first (leftmost) is column 0. Numbering happens before\n"
276                "  line-breaking, and columns are not renumbered after line breaking.\n"
277                "  Since many columns go unused, you should only use the rank field to\n"
278                "  get ordering information.  Two adjacent columns may have\n"
279                "  non-adjacent numbers.\n",
280                
281
282                /* properties */
283                "between-cols "
284                "bounded-by-me "
285                "grace-spacing " 
286                "line-break-system-details "
287                "line-break-penalty "
288                "line-break-permission "
289                "page-break-penalty "
290                "page-break-permission "
291                "page-turn-penalty "
292                "page-turn-permission "
293                "rhythmic-location "
294                "shortest-playing-duration "
295                "shortest-starter-duration "
296                "spacing "
297                "used "
298                "when ");
299