Fix type predicates/docstrings for two music properties.
[lilypond/mpolesky.git] / lily / volta-bracket.cc
blob6e649b088a2e85a6944bbf9e1a27c3868e5a3f88
1 /*
2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2010 Jan Nieuwenhuizen <janneke@gnu.org>
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 <cstring>
21 using namespace std;
23 #include "warn.hh"
24 #include "font-interface.hh"
25 #include "line-interface.hh"
26 #include "paper-column.hh"
27 #include "output-def.hh"
28 #include "text-interface.hh"
29 #include "volta-bracket.hh"
30 #include "pointer-group-interface.hh"
31 #include "side-position-interface.hh"
32 #include "directional-element-interface.hh"
33 #include "lookup.hh"
34 #include "tuplet-bracket.hh"
37 this is too complicated. Yet another version of side-positioning,
38 badly implemented.
42 * Should look for system_start_delim to find left edge of staff.
45 MAKE_SCHEME_CALLBACK (Volta_bracket_interface, print, 1);
46 SCM
47 Volta_bracket_interface::print (SCM smob)
49 Spanner *me = unsmob_spanner (smob);
50 Spanner *orig_span = dynamic_cast<Spanner *> (me->original ());
51 bool broken_first_bracket = orig_span && (orig_span->broken_intos_[0]
52 == (Spanner *)me);
54 Output_def *layout = me->layout ();
55 Real half_space = 0.5;
57 Item *bound = dynamic_cast<Spanner *> (me)->get_bound (LEFT);
60 not a start, but really broken in two
62 Real left = 0.;
63 if (bound->break_status_dir () == RIGHT)
65 Paper_column *pc = bound->get_column ();
66 left = pc->extent (pc, X_AXIS)[RIGHT]
67 - bound->relative_coordinate (pc, X_AXIS);
69 else
72 the volta spanner is attached to the bar-line, which is moved
73 to the right. We don't need to compensate for the left edge.
77 modify_edge_height (me);
78 if (!me->is_live ())
79 return SCM_EOL;
81 Drul_array<Real> edge_height = robust_scm2interval (me->get_property ("edge-height"),
82 Interval (1.0, 1.0));
83 Drul_array<Real> flare = robust_scm2interval (me->get_property ("bracket-flare"),
84 Interval (0, 0));
85 Drul_array<Real> shorten = robust_scm2interval (me->get_property ("shorten-pair"),
86 Interval (0, 0));
90 scale_drul (&edge_height, - Real (get_grob_direction (me)));
92 Interval empty;
93 Offset start;
94 start[X_AXIS] = me->spanner_length () - left - half_space;
97 ugh, Tuplet_bracket should use Horizontal_bracket, not the other way around.
99 Stencil total
100 = Tuplet_bracket::make_bracket (me, Y_AXIS, start,
101 edge_height, empty, flare, shorten);
103 if (!orig_span || broken_first_bracket)
105 SCM text = me->get_property ("text");
106 SCM properties = me->get_property_alist_chain (SCM_EOL);
107 SCM snum = Text_interface::interpret_markup (layout->self_scm (),
108 properties, text);
109 Stencil num = *unsmob_stencil (snum);
110 num.align_to (Y_AXIS, UP);
111 num.translate_axis (-0.5, Y_AXIS);
112 total.add_at_edge (X_AXIS, LEFT, num, - num.extent (X_AXIS).length ()
113 - 1.0);
116 total.translate_axis (left, X_AXIS);
117 return total.smobbed_copy ();
121 void
122 Volta_bracket_interface::modify_edge_height (Spanner *me)
124 Spanner *orig_span = dynamic_cast<Spanner *> (me->original ());
126 bool broken_first_bracket = orig_span && (orig_span->broken_intos_[0] == (Spanner *)me);
127 bool broken_last_bracket = orig_span && (orig_span->broken_intos_.back () == (Spanner *)me);
128 bool no_vertical_start = orig_span && !broken_first_bracket;
129 bool no_vertical_end = orig_span && !broken_last_bracket;
131 extract_grob_set (me, "bars", bars);
132 Grob *endbar = bars.size () ? bars.back () : 0;
133 SCM glyph = endbar ? endbar->get_property ("glyph-name") : SCM_EOL;
135 string str;
136 if (scm_is_string (glyph))
137 str = ly_scm2string (glyph);
138 else
139 str = "|";
141 no_vertical_end
142 |= (str != ":|"
143 && str != "|:"
144 && str != "|."
145 && str != ":|:"
146 && str != ":|.|:"
147 && str != ":|.:"
148 && str != ".|");
150 if (no_vertical_end || no_vertical_start)
152 Drul_array<Real> edge_height = robust_scm2interval (me->get_property ("edge-height"),
153 Interval (1.0, 1.0));
154 if (no_vertical_start)
155 edge_height[LEFT] = 0.0;
157 if (no_vertical_end)
158 edge_height[RIGHT] = 0.0;
160 me->set_property ("edge-height", ly_interval2scm (edge_height));
163 if (broken_last_bracket && no_vertical_end && no_vertical_start
164 && !broken_first_bracket)
165 me->suicide ();
168 void
169 Volta_bracket_interface::add_bar (Grob *me, Item *b)
171 Pointer_group_interface::add_grob (me, ly_symbol2scm ("bars"), b);
172 add_bound_item (dynamic_cast<Spanner *> (me), b);
175 ADD_INTERFACE (Volta_bracket_interface,
176 "Volta bracket with number.",
178 /* properties */
179 "bars "
180 "thickness "
181 "height "