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