lily/note-head.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2012 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 "note-head.hh"
  21
  22 #include <cmath>
  23 #include <cctype>
  24 #include <algorithm>            //  min, max
  25
  26 using namespace std;
  27
  28 #include "directional-element-interface.hh"
  29 #include "font-interface.hh"
  30 #include "grob.hh"
  31 #include "international.hh"
  32 #include "staff-symbol.hh"
  33 #include "staff-symbol-referencer.hh"
  34 #include "warn.hh"
  35
  36 static Stencil
  37 internal_print (Grob *me, string *font_char)
  38 {
  39   string style = robust_symbol2string (me->get_property ("style"), "default");
  40
  41   string suffix = to_string (min (robust_scm2int (me->get_property ("duration-log"), 2), 2));
  42   if (style != "default")
  43     suffix = robust_scm2string (me->get_property ("glyph-name"), "");
  44
  45   Font_metric *fm = Font_interface::get_default_font (me);
  46
  47   string prefix = "noteheads.";
  48   string idx_symmetric;
  49   string idx_directed;
  50   string idx_either = idx_symmetric = prefix + "s";
  51   Stencil out = fm->find_by_name (idx_either + suffix);
  52   if (out.is_empty ())
  53     {
  54       Grob *stem = unsmob_grob (me->get_object ("stem"));
  55       Direction stem_dir = stem ? get_grob_direction (stem) : CENTER;
  56
  57       if (stem_dir == CENTER)
  58         programming_error ("must have stem dir for note head");
  59
  60       idx_either = idx_directed = prefix + (stem_dir == UP ? "u" : "d");
  61       out = fm->find_by_name (idx_either + suffix);
  62     }
  63
  64   if (style == "mensural"
  65       || style == "neomensural"
  66       || style == "petrucci"
  67       || style == "baroque"
  68       || style == "kievan")
  69     {
  70       if (!Staff_symbol_referencer::on_line
  71           (me,
  72            robust_scm2int (me->get_property ("staff-position"), 0)))
  73         {
  74           Stencil test = fm->find_by_name (idx_either + "r" + suffix);
  75           if (!test.is_empty ())
  76             {
  77               idx_either += "r";
  78               out = test;
  79             }
  80         }
  81     }
  82
  83   idx_either += suffix;
  84   if (out.is_empty ())
  85     {
  86       me->warning (_f ("none of note heads `%s' or `%s' found",
  87                        idx_symmetric.c_str (), idx_directed.c_str ()));
  88       out = Stencil (Box (Interval (0, 0), Interval (0, 0)), SCM_EOL);
  89     }
  90   else
  91     *font_char = idx_either;
  92
  93   return out;
  94 }
  95
  96 /*
  97   TODO: make stem X-parent of notehead.
  98  */
  99 MAKE_SCHEME_CALLBACK (Note_head, stem_x_shift, 1);
 100 SCM
 101 Note_head::stem_x_shift (SCM smob)
 102 {
 103   Grob *me = unsmob_grob (smob);
 104   Grob *stem = unsmob_grob (me->get_object ("stem"));
 105   if (stem)
 106     (void) stem->get_property ("positioning-done");
 107
 108   return scm_from_int (0);
 109 }
 110
 111 MAKE_SCHEME_CALLBACK (Note_head, print, 1);
 112 SCM
 113 Note_head::print (SCM smob)
 114 {
 115   Grob *me = unsmob_grob (smob);
 116
 117   string idx;
 118   return internal_print (me, &idx).smobbed_copy ();
 119 }
 120
 121 MAKE_SCHEME_CALLBACK (Note_head, include_ledger_line_height, 1);
 122 SCM
 123 Note_head::include_ledger_line_height (SCM smob)
 124 {
 125   Grob *me = unsmob_grob (smob);
 126   Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
 127
 128   if (staff)
 129     {
 130       Real ss = Staff_symbol::staff_space (staff);
 131       Interval lines = Staff_symbol::line_span (staff) * (ss / 2.0);
 132       Real my_pos = Staff_symbol_referencer::get_position (me) * ss / 2.0;
 133       Interval my_ext = me->extent (me, Y_AXIS) + my_pos;
 134
 135       // The +1 and -1 come from the fact that we only want to add
 136       // the interval between the note and the first ledger line, not
 137       // the whole interval between the note and the staff.
 138       Interval iv (min (0.0, lines[UP] - my_ext[DOWN] + 1),
 139                    max (0.0, lines[DOWN] - my_ext[UP] - 1));
 140       return ly_interval2scm (iv);
 141     }
 142
 143   return ly_interval2scm (Interval (0, 0));
 144 }
 145
 146 Real
 147 Note_head::stem_attachment_coordinate (Grob *me, Axis a)
 148 {
 149   Offset off = robust_scm2offset (me->get_property ("stem-attachment"),
 150                                   Offset (0, 0));
 151
 152   return off [a];
 153 }
 154
 155 Offset
 156 Note_head::get_stem_attachment (Font_metric *fm, string key)
 157 {
 158   Offset att;
 159
 160   int k = fm->name_to_index (key);
 161   if (k >= 0)
 162     {
 163       Box b = fm->get_indexed_char_dimensions (k);
 164       Offset wxwy = fm->attachment_point (key);
 165       for (int i = X_AXIS; i < NO_AXES; i++)
 166         {
 167           Axis a = Axis (i);
 168
 169           Interval v = b[a];
 170           if (!v.is_empty ())
 171             {
 172               att[a] = (2 * (wxwy[a] - v.center ()) / v.length ());
 173             }
 174         }
 175     }
 176
 177   return att;
 178 }
 179
 180 MAKE_SCHEME_CALLBACK (Note_head, calc_stem_attachment, 1);
 181 SCM
 182 Note_head::calc_stem_attachment (SCM smob)
 183 {
 184   Grob *me = unsmob_grob (smob);
 185   Font_metric *fm = Font_interface::get_default_font (me);
 186   string key;
 187   internal_print (me, &key);
 188
 189   return ly_offset2scm (get_stem_attachment (fm, key));
 190 }
 191
 192 ADD_INTERFACE (Note_head,
 193                "A note head.  There are many possible values for"
 194                " @code{style}.  For a complete list, see"
 195                " @ruser{Note head styles}.",
 196
 197                /* properties */
 198                "note-names "
 199                "accidental-grob "
 200                "glyph-name "
 201                "stem-attachment "
 202                "style "
 203               );
 204