/*
- accidental.cc -- implement Accidental_interface
+ This file is part of LilyPond, the GNU music typesetter.
- (c) 2001--2004 Han-Wen Nienhuys
-
- */
-#include "font-interface.hh"
-#include "item.hh"
-#include "stencil.hh"
-#include "accidental-interface.hh"
-#include "paper-def.hh"
-#include "pitch.hh"
+ Copyright (C) 2001--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
-/*
- TODO: insert support for smaller cautionaries, tie-break-reminders.
- Either here or in new-accidental-engraver.
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
- 'accidentals should go, for a single 'accidental property -- see
- accidental-placement.cc
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
+#include "accidental-interface.hh"
+#include "font-interface.hh"
+#include "international.hh"
+#include "item.hh"
+#include "output-def.hh"
+#include "paper-column.hh"
+#include "pitch.hh"
+#include "stencil.hh"
+#include "skyline-pair.hh"
Stencil
-parenthesize (Grob*me, Stencil m)
+parenthesize (Grob *me, Stencil m)
{
- Stencil open = Font_interface::get_default_font (me)->find_by_name (String ("accidentals-leftparen"));
- Stencil close = Font_interface::get_default_font (me)->find_by_name (String ("accidentals-rightparen"));
- m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0,0);
- m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0,0);
+ Font_metric *font
+ = Font_interface::get_default_font (me);
+ Stencil open
+ = font->find_by_name ("accidentals.leftparen");
+ Stencil close
+ = font->find_by_name ("accidentals.rightparen");
+
+ m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0);
+ m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0);
return m;
}
-
-MAKE_SCHEME_CALLBACK (Accidental_interface,after_line_breaking,1);
-SCM
-Accidental_interface::after_line_breaking (SCM smob)
+/* If this gets called before line breaking, we will return a non-trivial
+ extent even if we belong to a tie and won't actually get printed. */
+static SCM
+get_extent (Grob *me, Axis a)
{
- Grob *me = unsmob_grob (smob);
- Grob *tie = unsmob_grob (me->get_property ("tie"));
+ Stencil *s = Stencil::unsmob (Accidental_interface::get_stencil (me));
- if (tie && !tie->original_)
- {
- me->suicide ();
- }
- return SCM_UNSPECIFIED;
+ if (s)
+ return ly_interval2scm (s->extent (a));
+ return ly_interval2scm (Interval ());
}
-Array<Box>
-Accidental_interface::accurate_boxes (Grob *a,Grob**common)
+MAKE_SCHEME_CALLBACK (Accidental_interface, height, 1);
+SCM
+Accidental_interface::height (SCM smob)
{
- Box b;
- b[X_AXIS] = a->extent (a, X_AXIS);
- b[Y_AXIS] = a->extent (a, Y_AXIS);
-
- Array<Box> boxes;
-
- bool parens = false;
- if (to_boolean (a->get_property ("cautionary")))
- {
- SCM cstyle = a->get_property ("cautionary-style");
- parens = ly_equal_p (cstyle, ly_symbol2scm ("parentheses"));
-
- }
-
- SCM accs = a->get_property ("accidentals");
- SCM scm_style = a->get_property ("style");
- if (!ly_symbol_p (scm_style)
- && !parens
- && scm_ilength (accs) == 1)
- {
- if (ly_scm2int (ly_car (accs)) == FLAT)
- {
- Box stem = b;
- Box bulb = b;
-
- /*
- we could make the stem thinner, but that places the flats
- really close.
- */
- stem[X_AXIS][RIGHT] *= .5;
-
- /*
- To prevent vertical alignment for 6ths
- */
- stem[Y_AXIS] *= 1.1;
- bulb[Y_AXIS][UP] *= .35;
-
- boxes.push (bulb);
- boxes.push (stem);
- }
-
- /*
- TODO: add support for natural, double flat.
- */
- }
+ return get_extent (Grob::unsmob (smob), Y_AXIS);
+}
- if (!boxes.size ())
- boxes.push (b);
+MAKE_SCHEME_CALLBACK (Accidental_interface, width, 1);
+SCM
+Accidental_interface::width (SCM smob)
+{
+ return get_extent (Grob::unsmob (smob), X_AXIS);
+}
- Offset o (a->relative_coordinate (common[X_AXIS], X_AXIS),
- a->relative_coordinate (common[Y_AXIS], Y_AXIS));
- for (int i = boxes.size (); i--;)
+MAKE_SCHEME_CALLBACK (Accidental_interface, horizontal_skylines, 1);
+SCM
+Accidental_interface::horizontal_skylines (SCM smob)
+{
+ Grob *me = Grob::unsmob (smob);
+ if (!me->is_live ())
+ return Skyline_pair ().smobbed_copy ();
+
+ /*
+ * Using the print function may trigger a suicide
+ * before line breaking. It is therefore `unpure' (c).
+ * We use the more basic get_stencil.
+ */
+ Stencil *my_stencil = Stencil::unsmob (get_stencil (me));
+ if (!my_stencil)
+ return Skyline_pair ().smobbed_copy ();
+
+ Skyline_pair *sky =
+ Skyline_pair::unsmob
+ (Stencil::skylines_from_stencil
+ (my_stencil->smobbed_copy (), 0.0, Y_AXIS));
+
+ SCM alist = me->get_property ("glyph-name-alist");
+ SCM alt = me->get_property ("alteration");
+ string glyph_name = robust_scm2string (ly_assoc_get (alt, alist, SCM_BOOL_F),
+ "");
+ if (glyph_name == "accidentals.flat"
+ || glyph_name == "accidentals.flatflat")
{
- boxes[i].translate (o);
+ // a bit more padding for the right of the stem
+ // we raise the stem horizontally to a bit less than the average
+ // horizontal "height" of the entire glyph. This will bring flats
+ // closer to doubleflats, which looks better (MS opinion).
+ // this should work for all fonts where the flat is not
+ // completely bizarre
+ Real left = my_stencil->extent (X_AXIS)[LEFT];
+ Real right = my_stencil->extent (X_AXIS)[RIGHT] * 0.375;
+ Real down = my_stencil->extent (Y_AXIS)[DOWN];
+ Real up = my_stencil->extent (Y_AXIS)[UP];
+ vector<Box> boxes;
+ boxes.push_back (Box (Interval (left, right), Interval (down, up)));
+ Skyline merge_with_me (boxes, Y_AXIS, RIGHT);
+ (*sky)[RIGHT].merge (merge_with_me);
}
-
- return boxes;
+ return sky->smobbed_copy ();
}
-/*
- * Some styles do not provide all flavours of accidentals, e.g. there
- * is currently no sharp accidental in vaticana style. In these cases
- * this function falls back to one of the other styles.
- */
-
-/*
- todo: this sort of stuff in Scheme. --hwn.
- */
-String
-Accidental_interface::get_fontcharname (String style, int alteration)
+MAKE_SCHEME_CALLBACK (Accidental_interface, pure_height, 3);
+SCM
+Accidental_interface::pure_height (SCM smob, SCM start_scm, SCM)
{
- if (alteration == DOUBLE_FLAT
- || alteration == DOUBLE_SHARP)
+ Item *me = dynamic_cast<Item *> (Grob::unsmob (smob));
+ int start = scm_to_int (start_scm);
+ int rank = me->get_column ()->get_rank ();
+
+ if (to_boolean (me->get_property ("forced"))
+ || !Grob::unsmob (me->get_object ("tie"))
+ || (rank == start + 1 && /* we are at the start of a line */
+ !to_boolean (me->get_property ("hide-tied-accidental-after-break"))))
{
- return to_string (alteration);
+ Stencil *s = Stencil::unsmob (get_stencil (me));
+ if (s)
+ return ly_interval2scm (s->extent (Y_AXIS));
}
-
- if (style == "hufnagel")
- switch (alteration)
- {
- case FLAT: return "hufnagel-1";
- case 0: return "vaticana0";
- case SHARP: return "mensural1";
- }
- if (style == "medicaea")
- switch (alteration)
- {
- case FLAT: return "medicaea-1";
- case 0: return "vaticana0";
- case SHARP: return "mensural1";
- }
- if (style == "vaticana")
- switch (alteration)
- {
- case FLAT: return "vaticana-1";
- case 0: return "vaticana0";
- case SHARP: return "mensural1";
- }
- if (style == "mensural")
- switch (alteration)
- {
- case FLAT: return "mensural-1";
- case 0: return "vaticana0";
- case SHARP: return "mensural1";
- }
-
- if (style == "neo_mensural")
- style = ""; // currently same as default
- if (style == "default")
- style = "";
- return style + to_string (alteration);
+
+ return ly_interval2scm (Interval ());
}
-MAKE_SCHEME_CALLBACK (Accidental_interface,print,1);
+MAKE_SCHEME_CALLBACK (Accidental_interface, print, 1);
SCM
Accidental_interface::print (SCM smob)
{
- Grob *me = unsmob_grob (smob);
- bool smaller = false;
- bool parens = false;
+ Grob *me = Grob::unsmob (smob);
+ Grob *tie = Grob::unsmob (me->get_object ("tie"));
- bool caut = to_boolean (me->get_property ("cautionary"));
- if (caut)
+ if (tie
+ && (to_boolean (me->get_property ("hide-tied-accidental-after-break"))
+ || (!tie->original () && !to_boolean (me->get_property ("forced")))))
{
- SCM cstyle = me->get_property ("cautionary-style");
- parens = ly_equal_p (cstyle, ly_symbol2scm ("parentheses"));
- smaller = ly_equal_p (cstyle, ly_symbol2scm ("smaller"));
+ me->suicide ();
+ return SCM_EOL;
}
- SCM scm_style = me->get_property ("style");
- String style;
- if (ly_symbol_p (scm_style))
- {
- style = ly_symbol2string (scm_style);
- }
- else
- {
- /*
- preferably no name for the default style.
- */
- style = "";
- }
+ return get_stencil (me);
+}
+
+SCM
+Accidental_interface::get_stencil (Grob *me)
+{
+ Font_metric *fm = Font_interface::get_default_font (me);
- Font_metric *fm = 0;
- if (smaller)
+ SCM alist = me->get_property ("glyph-name-alist");
+ SCM alt = me->get_property ("alteration");
+ SCM glyph_name = ly_assoc_get (alt, alist, SCM_BOOL_F);
+ Stencil mol;
+
+ if (!scm_is_string (glyph_name))
{
- SCM ac = Font_interface::text_font_alist_chain (me);
- ac = scm_cons (scm_cons (scm_cons
- (ly_symbol2scm ("font-size"),
- scm_int2num (-2)), SCM_EOL),
- ac);
- fm = select_font (me->get_paper (), ac);
+ me->warning (_f ("Could not find glyph-name for alteration %s",
+ ly_scm_write_string (alt).c_str ()));
+ mol = fm->find_by_name ("noteheads.s1cross");
}
else
- fm = Font_interface::get_default_font (me);
+ mol = fm->find_by_name (ly_scm2string (glyph_name));
- Stencil mol;
- for (SCM s = me->get_property ("accidentals");
- ly_pair_p (s); s = ly_cdr (s))
+ if (to_boolean (me->get_property ("restore-first")))
{
- int alteration = ly_scm2int (ly_car (s));
- String font_char = get_fontcharname (style, alteration);
- Stencil acc (fm->find_by_name ("accidentals-" + font_char));
+ /*
+ this isn't correct for ancient accidentals, but they don't
+ use double flats/sharps anyway.
+ */
+ Stencil acc (fm->find_by_name ("accidentals.natural"));
if (acc.is_empty ())
- {
- me->warning (_f ("accidental `%s' not found", font_char));
- }
+ me->warning (_ ("natural alteration glyph not found"));
else
- {
- mol.add_at_edge (X_AXIS, RIGHT, acc, 0.1,0);
- }
+ mol.add_at_edge (X_AXIS, LEFT, acc, 0.1);
}
- if (parens)
- mol = parenthesize (me, mol);
+ if (to_boolean (me->get_property ("parenthesized")))
+ mol = parenthesize (me, mol);
return mol.smobbed_copy ();
}
-
-
-ADD_INTERFACE (Accidental_interface, "accidental-interface",
- "a single accidental",
- "cautionary cautionary-style style tie accidentals");
+ADD_INTERFACE (Accidental_interface,
+ "A single accidental.",
+
+ /* properties */
+ "alteration "
+ "avoid-slur "
+ "forced "
+ "glyph-name-alist "
+ "glyph-name "
+ "hide-tied-accidental-after-break "
+ "parenthesized "
+ "restore-first "
+ "tie "
+ );