2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "script-column.hh"
22 #include "accidental-placement.hh"
23 #include "arpeggio.hh"
24 #include "directional-element-interface.hh"
25 #include "side-position-interface.hh"
28 #include "pointer-group-interface.hh"
32 typedef map<Grob*, vector <Grob*> > Grob_scripts_map;
35 Script_column::add_side_positioned (Grob *me, Grob *script)
37 SCM p = script->get_property ("script-priority");
38 if (!scm_is_number (p))
41 Pointer_group_interface::add_grob (me, ly_symbol2scm ("scripts"), script);
44 LY_DEFINE (ly_grob_script_priority_less, "ly:grob-script-priority-less",
45 2, 0, 0, (SCM a, SCM b),
46 "Compare two grobs by script priority. For internal use.")
48 Grob *i1 = unsmob_grob (a);
49 Grob *i2 = unsmob_grob (b);
51 SCM p1 = i1->get_property ("script-priority");
52 SCM p2 = i2->get_property ("script-priority");
54 return scm_to_int (p1) < scm_to_int (p2) ? SCM_BOOL_T : SCM_BOOL_F;
57 MAKE_SCHEME_CALLBACK (Script_column, row_before_line_breaking, 1);
59 Script_column::row_before_line_breaking (SCM smob)
61 Grob *me = unsmob_grob (smob);
62 vector<Grob*> horizontal_grobs;
63 extract_grob_set (me, "scripts", scripts);
65 Grob_scripts_map head_scripts_map;
66 vector<Grob *> affect_all_grobs;
67 for (vsize i = 0; i < scripts.size (); i++)
69 Grob *sc = scripts[i];
72 Don't want to consider scripts horizontally next to notes.
74 if (Accidental_placement::has_interface (sc)
75 || Arpeggio::has_interface (sc))
77 affect_all_grobs.push_back (sc);
79 else if (sc->get_property_data ("Y-offset") !=
80 Side_position_interface::y_aligned_side_proc)
82 head_scripts_map[sc->get_parent (Y_AXIS)].push_back (sc);
86 for (Grob_scripts_map::const_iterator i (head_scripts_map.begin ());
87 i != head_scripts_map.end ();
90 vector<Grob*> grobs = (*i).second;
92 // this isn't right in all cases, but in general a safe assumption.
93 concat (grobs, affect_all_grobs);
97 return SCM_UNSPECIFIED;
101 MAKE_SCHEME_CALLBACK (Script_column, before_line_breaking, 1);
103 Script_column::before_line_breaking (SCM smob)
105 Grob *me = unsmob_grob (smob);
106 vector<Grob*> staff_sided;
108 extract_grob_set (me, "scripts", scripts);
109 for (vsize i = 0; i < scripts.size (); i++)
111 Grob *sc = scripts[i];
113 Don't want to consider scripts horizontally next to notes.
115 if (sc->get_property_data ("X-offset") !=
116 Side_position_interface::x_aligned_side_proc)
117 staff_sided.push_back (sc);
120 order_grobs (staff_sided);
121 return SCM_UNSPECIFIED;
125 Script_column::order_grobs (vector<Grob*> grobs)
127 Drul_array<SCM> scripts_drul (SCM_EOL, SCM_EOL);
128 for (vsize i = 0; i < grobs.size (); i++)
131 Direction d = get_grob_direction (g);
133 scripts_drul[d] = scm_cons (g->self_scm (), scripts_drul[d]);
139 SCM ss = scm_reverse_x (scripts_drul[d], SCM_EOL);
140 ss = scm_stable_sort_x (ss, ly_grob_script_priority_less_proc);
144 SCM default_outside_staff = scm_from_double (0);
145 // script_column may have no entries
146 if (scm_is_pair (ss))
148 first = unsmob_grob (scm_car (ss));
149 default_outside_staff = first->get_property ("outside-staff-priority");
151 for (SCM s = ss; scm_is_pair (s); s = scm_cdr (s))
153 Grob *g = unsmob_grob (scm_car (s));
156 SCM last_outside_staff = last->get_property ("outside-staff-priority");
157 if (scm_is_number (last_outside_staff))
160 we allow the outside-staff-priority ordering to override the
161 script-priority ordering; we must set new
162 outside-staff-priority if outside-staff-priority is
163 missing or equal to last
165 SCM g_outside_staff = g->get_property ("outside-staff-priority");
166 if (!scm_is_number (g_outside_staff))
167 g->set_property ("outside-staff-priority",
169 scm_to_double (last_outside_staff) + 0.1));
170 else if (fabs (scm_to_double (g_outside_staff) -
171 robust_scm2double (default_outside_staff, 0)) < 0.001)
173 SCM last_script = last->get_property ("script-priority");
174 SCM g_script = g->get_property ("script-priority");
176 "outside-staff-priority",
177 scm_from_double (scm_to_double (last_outside_staff) +
178 scm_to_double (g_script) -
179 scm_to_double (last_script)));
181 default_outside_staff = g_outside_staff;
184 Side_position_interface::add_support (g, last);
189 while (flip (&d) != DOWN);
192 ADD_INTERFACE (Script_column,
193 "An interface that sorts scripts according to their"
194 " @code{script-priority}.",