lily/note-head.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 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     {
  69       if (!Staff_symbol_referencer::on_line
  70           (me,
  71            robust_scm2int (me->get_property ("staff-position"), 0)))
  72         {
  73           Stencil test = fm->find_by_name (idx_either + "r" + suffix);
  74           if (!test.is_empty ())
  75             {
  76               idx_either += "r";
  77               out = test;
  78             }
  79         }
  80     }
  81
  82   idx_either += suffix;
  83   if (out.is_empty ())
  84     {
  85       me->warning (_f ("none of note heads `%s' or `%s' found",
  86                        idx_symmetric.c_str (), idx_directed.c_str ()));
  87       out = Stencil (Box (Interval (0, 0), Interval (0, 0)), SCM_EOL);
  88     }
  89   else
  90     *font_char = idx_either;
  91
  92   return out;
  93 }
  94
  95 /*
  96   TODO: make stem X-parent of notehead.
  97  */
  98 MAKE_SCHEME_CALLBACK (Note_head, stem_x_shift, 1);
  99 SCM
 100 Note_head::stem_x_shift (SCM smob)
 101 {
 102   Grob *me = unsmob_grob (smob);
 103   Grob *stem = unsmob_grob (me->get_object ("stem"));
 104   if (stem)
 105     (void) stem->get_property ("positioning-done");
 106
 107   return scm_from_int (0);
 108 }
 109
 110 MAKE_SCHEME_CALLBACK (Note_head, print, 1);
 111 SCM
 112 Note_head::print (SCM smob)
 113 {
 114   Grob *me = unsmob_grob (smob);
 115
 116   string idx;
 117   return internal_print (me, &idx).smobbed_copy ();
 118 }
 119
 120 MAKE_SCHEME_CALLBACK (Note_head, include_ledger_line_height, 1);
 121 SCM
 122 Note_head::include_ledger_line_height (SCM smob)
 123 {
 124   Grob *me = unsmob_grob (smob);
 125   Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
 126
 127   if (staff)
 128     {
 129       Real ss = Staff_symbol::staff_space (staff);
 130       Interval lines = Staff_symbol::line_span (staff) * (ss / 2.0);
 131       Real my_pos = Staff_symbol_referencer::get_position (me) * ss / 2.0;
 132       Interval my_ext = me->extent (me, Y_AXIS) + my_pos;
 133
 134       // The +1 and -1 come from the fact that we only want to add
 135       // the interval between the note and the first ledger line, not
 136       // the whole interval between the note and the staff.
 137       Interval iv (min (0.0, lines[UP] - my_ext[DOWN] + 1),
 138                    max (0.0, lines[DOWN] - my_ext[UP] - 1));
 139       return ly_interval2scm (iv);
 140     }
 141
 142   return ly_interval2scm (Interval (0, 0));
 143 }
 144
 145 Real
 146 Note_head::stem_attachment_coordinate (Grob *me, Axis a)
 147 {
 148   Offset off = robust_scm2offset (me->get_property ("stem-attachment"),
 149                                   Offset (0, 0));
 150
 151   return off [a];
 152 }
 153
 154 Offset
 155 Note_head::get_stem_attachment (Font_metric *fm, string key)
 156 {
 157   Offset att;
 158
 159   int k = fm->name_to_index (key);
 160   if (k >= 0)
 161     {
 162       Box b = fm->get_indexed_char_dimensions (k);
 163       Offset wxwy = fm->attachment_point (key);
 164       for (int i = X_AXIS; i < NO_AXES; i++)
 165         {
 166           Axis a = Axis (i);
 167
 168           Interval v = b[a];
 169           if (!v.is_empty ())
 170             {
 171               att[a] = (2 * (wxwy[a] - v.center ()) / v.length ());
 172             }
 173         }
 174     }
 175
 176   return att;
 177 }
 178
 179 MAKE_SCHEME_CALLBACK (Note_head, calc_stem_attachment, 1);
 180 SCM
 181 Note_head::calc_stem_attachment (SCM smob)
 182 {
 183   Grob *me = unsmob_grob (smob);
 184   Font_metric *fm = Font_interface::get_default_font (me);
 185   string key;
 186   internal_print (me, &key);
 187
 188   return ly_offset2scm (get_stem_attachment (fm, key));
 189 }
 190
 191 ADD_INTERFACE (Note_head,
 192                "A note head.  There are many possible values for"
 193                " @code{style}.  For a complete list, see"
 194                " @ruser{Note head styles}.",
 195
 196                /* properties */
 197                "note-names "
 198                "accidental-grob "
 199                "glyph-name "
 200                "stem-attachment "
 201                "style "
 202               );
 203