]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-head.cc
Release: bump Welcome versions.
[lilypond.git] / lily / note-head.cc
index 9fc325784851864ee5ff4c1c1e4751501e8e5a03..73a2255d9040a91199e994cf05c2fe0e6f9a74b5 100644 (file)
 /*
-  notehead.cc -- implement Note_head
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-*/
-#include <math.h>
-#include <ctype.h>
-
-#include "staff-symbol.hh"
-#include "misc.hh"
-#include "dots.hh"
-#include "note-head.hh"
-#include "warn.hh"
-#include "font-interface.hh"
-#include "molecule.hh"
-#include "event.hh"
-#include "rhythmic-head.hh"
-#include "staff-symbol-referencer.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-
-/*
-  Note_head contains the code for printing note heads.
+  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.
 
-  Ledger lines:
+  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.
 
-  It also contains the ledger lines, for historical reasons.  Ledger
-  lines are somewhat of a PITA. In some cases, they take up no space, in
-  some cases they don't:
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
-  DO take space:
+#include "note-head.hh"
 
-  - when ledgered notes are juxtaposed: there should be some white
-   space between the ledger lines.
+#include <cmath>
+#include <cctype>
+#include <algorithm>            //  min, max
 
-  - when accidentals are near: the accidentals should not be on the
-  ledger lines
+using namespace std;
 
-  [both tips by Heinz Stolba from Universal Edition].
+#include "directional-element-interface.hh"
+#include "font-interface.hh"
+#include "grob.hh"
+#include "international.hh"
+#include "staff-symbol.hh"
+#include "staff-symbol-referencer.hh"
+#include "warn.hh"
 
-  DO NOT take space into account:
+static Stencil
+internal_print (Grob *me, string *font_char)
+{
+  string style = robust_symbol2string (me->get_property ("style"), "default");
 
-  - for basically everything else, e.g. swapping ledgered notes on
-   clustered chords, spacing between ledgered and unledgered notes.
-  
-  TODO: fix this. It is not feasible to have a special grob for
-  ledgers, since you basically don't know if there will be ledgers,
-  unless you know at interpretation phase already 1. the Y-position,
-  2. the number of staff lines. It's not yet specced when both pieces
-  of information are there, so for now, it is probably better to build
-  special support for ledgers into the accidental and separation-item
-  code.
+  string suffix = ::to_string (min (robust_scm2int (me->get_property ("duration-log"), 2), 2));
+  if (style != "default")
+    suffix = robust_scm2string (me->get_property ("glyph-name"), "");
 
-  (Besides a separate ledger seems overkill. For what else would
-  it be useful?)
+  Font_metric *fm = Font_interface::get_default_font (me);
 
-*/
+  string prefix = "noteheads.";
+  string idx_symmetric;
+  string idx_directed;
+  string idx_either = idx_symmetric = prefix + "s";
+  Stencil out = fm->find_by_name (idx_either + suffix);
+  if (out.is_empty ())
+    {
+      Grob *stem = unsmob<Grob> (me->get_object ("stem"));
+      Direction stem_dir = stem ? get_grob_direction (stem) : CENTER;
 
-/*
-  TODO: ledger lines are also a property of the staff. Maybe move them
-  to there?
- */
-Molecule
-Note_head::brew_ledger_lines (Grob *me,
-                              int pos,
-                              int interspaces,
-                              Interval x_extent,
-                             Real left_shorten,
-                             bool take_space)
-{
-  Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
-  Real inter_f = Staff_symbol_referencer::staff_space (me)/2;
-  int line_count = (abs (pos) < interspaces)
-    ? 0
-    : (abs (pos) - interspaces) / 2;
-  Molecule molecule = Molecule();
+      if (stem_dir == CENTER)
+        programming_error ("must have stem dir for note head");
 
+      idx_either = idx_directed = prefix + (stem_dir == UP ? "u" : "d");
+      out = fm->find_by_name (idx_either + suffix);
+    }
 
-  if (line_count)
+  if (style == "mensural"
+      || style == "neomensural"
+      || style == "petrucci"
+      || style == "baroque"
+      || style == "kievan")
     {
-      Real ledgerlinethickness =
-       Staff_symbol::get_ledger_line_thickness (staff);
-      Real blotdiameter = ledgerlinethickness;
-      Interval y_extent =
-       Interval (-0.5*(ledgerlinethickness),
-                 +0.5*(ledgerlinethickness));
-      Molecule proto_ledger_line =
-       Lookup::round_filled_box (Box (x_extent, y_extent), blotdiameter);
-
-      x_extent[LEFT] += left_shorten;
-      Molecule proto_first_line =
-       Lookup::round_filled_box (Box (x_extent, y_extent), blotdiameter);
-
-      if (!take_space)
+      if (!Staff_symbol_referencer::on_line
+          (me,
+           robust_scm2int (me->get_property ("staff-position"), 0)))
         {
-         proto_ledger_line.set_empty (true);
-         proto_first_line.set_empty (true);
-       }
-      
-      Direction dir = (Direction)sign (pos);
-      Real offs = (Staff_symbol_referencer::on_staffline (me, pos))
-        ? 0.0
-        : -dir * inter_f;
-      
-      for (int i = 0; i < line_count; i++)
-        {
-          Molecule ledger_line ((i == 0) 
-                               ? proto_first_line
-                               : proto_ledger_line
-                               );
-          ledger_line.translate_axis (-dir * inter_f * i * 2 + offs, Y_AXIS);
-          molecule.add_molecule (ledger_line);
+          Stencil test = fm->find_by_name (idx_either + "r" + suffix);
+          if (!test.is_empty ())
+            {
+              idx_either += "r";
+              out = test;
+            }
         }
     }
 
-  return molecule;
-}
-
-Molecule
-internal_brew_molecule (Grob *me, bool with_ledgers)
-{
-  SCM style  = me->get_grob_property ("style");
-  if (!gh_symbol_p (style))
+  if (style == "kievan"
+      && 3 == robust_scm2int (me->get_property ("duration-log"), 2))
     {
-      return Molecule ();
+      Grob *stem = unsmob<Grob> (me->get_object ("stem"));
+      Grob *beam = unsmob<Grob> (stem->get_object ("beam"));
+      if (beam)
+        out = fm->find_by_name (idx_either + "2kievan");
     }
 
-  SCM log = gh_int2scm (Note_head::get_balltype (me));
-  SCM proc = me->get_grob_property ("glyph-name-procedure");
-  SCM scm_font_char = scm_call_2 (proc, log, style);
-  String font_char = "noteheads-" + ly_scm2string (scm_font_char);
-
-  Font_metric * fm = Font_interface::get_default_font (me);
-  Molecule out = fm->find_by_name (font_char);
+  idx_either += suffix;
   if (out.is_empty ())
     {
-      me->warning (_f ("note head `%s' not found", font_char.to_str0 ()));
+      me->warning (_f ("none of note heads `%s' or `%s' found",
+                       idx_symmetric.c_str (), idx_directed.c_str ()));
+      out = Stencil (Box (Interval (0, 0), Interval (0, 0)), SCM_EOL);
     }
+  else
+    *font_char = idx_either;
 
-  int interspaces = Staff_symbol_referencer::line_count (me)-1;
-  int pos = (int)rint (Staff_symbol_referencer::get_position (me));
-  if (with_ledgers && interspaces >= 0
-      && abs (pos) - interspaces > 1)
-    {
-      Interval ledger_size = out.extent (X_AXIS);
-      ledger_size.widen ( ledger_size.length ()/4);
-
-      Real left_shorten =0.0;
-      if (Grob * g = unsmob_grob(me->get_grob_property ("accidental-grob")))
-       {
-         /*
-           make a little room for accidentals.
-         
-           TODO: this will look silly if a chord has ledger lines,
-           and only the bottom note has an accidental.
-         */
-
-         Grob *common = g->common_refpoint (me, X_AXIS);
-         Real d =
-           (me->extent (common, X_AXIS)[LEFT]
-            +g->extent (common, X_AXIS)[RIGHT]) /2;
-
-         left_shorten =  (-ledger_size[LEFT] + d) >?  0 ;
-
-         /*
-           TODO: shorten 2 ledger lines for the case natural +
-           downstem.
-          */
-       }
-
-      out.add_molecule (Note_head::brew_ledger_lines (me, pos, interspaces,
-                                                     ledger_size,
-                                                     left_shorten,
-                                                     false));
-    }
   return out;
 }
 
-
-MAKE_SCHEME_CALLBACK (Note_head,brew_molecule,1);
-SCM
-Note_head::brew_molecule (SCM smob)  
-{
-  Grob *me = unsmob_grob (smob);
-
-  /*
-    ledgers don't take space. See top of file.
-   */
-  return internal_brew_molecule (me, true).smobbed_copy ();
-}
-
 /*
-  Compute the width the head without ledgers.
-
-  -- there used to be some code from the time that ledgers
-  did take space. Nowadays, we can simply take the standard extent.
+  TODO: make stem X-parent of notehead.
  */
-Interval
-Note_head::head_extent (Grob *me, Axis a)
+MAKE_SCHEME_CALLBACK (Note_head, stem_x_shift, 1);
+SCM
+Note_head::stem_x_shift (SCM smob)
 {
-  SCM brewer = me->get_grob_property ("molecule-callback");
-  if (brewer == Note_head::brew_molecule_proc)
-    {
-      Molecule mol = internal_brew_molecule (me, false);
-  
-      if (!mol.is_empty ())
-       return mol.extent (a);
-    }
-  else
-    {
-      Molecule * mol = me->get_molecule ();
-      if (mol)
-       return  mol->extent (a) ;
-    }
-  
-  return Interval (0,0);
+  Grob *me = unsmob<Grob> (smob);
+  Grob *stem = unsmob<Grob> (me->get_object ("stem"));
+  if (stem)
+    (void) stem->get_property ("positioning-done");
+
+  return scm_from_int (0);
 }
 
-/*
-  This is necessary to prevent a cyclic dependency: the appearance of
-  the ledgers depends on positioning, so the Grob::get_molecule() can
-  not be used for determining the note head extent.
-  
- */ 
-MAKE_SCHEME_CALLBACK (Note_head,extent,2);
+MAKE_SCHEME_CALLBACK (Note_head, print, 1);
 SCM
-Note_head::extent (SCM smob, SCM axis)  
+Note_head::print (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
 
-  return ly_interval2scm (head_extent (me, (Axis) gh_scm2int (axis)));
+  string idx;
+  return internal_print (me, &idx).smobbed_copy ();
 }
 
-MAKE_SCHEME_CALLBACK (Note_head,brew_ez_molecule,1);
+MAKE_SCHEME_CALLBACK (Note_head, include_ledger_line_height, 1);
 SCM
-Note_head::brew_ez_molecule (SCM smob)
+Note_head::include_ledger_line_height (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  int l = Note_head::get_balltype (me);
-
-  int b = (l >= 2);
-
-  SCM cause = me->get_grob_property ("cause");
-  SCM spitch = unsmob_music (cause)->get_mus_property ("pitch");
-  Pitch* pit =  unsmob_pitch (spitch);
-
-  char s[2] = "a";
-  s[0] = (pit->get_notename () + 2)%7 + 'a';
-  s[0] = toupper (s[0]);
-  
-  SCM charstr = scm_makfrom0str (s);
-  
-  SCM at = scm_list_n (ly_symbol2scm ("ez-ball"),
-                      charstr,
-                      gh_int2scm (b),
-                      gh_int2scm (1-b),
-                      SCM_UNDEFINED);
-  Box bx (Interval (0, 1.0), Interval (-0.5, 0.5));
-  Molecule m (bx, at);
-
-  int pos = (int)rint (Staff_symbol_referencer::get_position (me));
-  int interspaces = Staff_symbol_referencer::line_count (me)-1;
-  if (abs (pos) - interspaces > 1)
+  Grob *me = unsmob<Grob> (smob);
+  Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+
+  if (staff)
     {
-      Interval hd = m.extent (X_AXIS);
-      hd.widen ( hd.length ()/4);
-      m.add_molecule (brew_ledger_lines (me, pos, interspaces, hd, 0, false));
+      Real ss = Staff_symbol::staff_space (staff);
+      Interval lines = Staff_symbol::line_span (staff) * (ss / 2.0);
+      Real my_pos = Staff_symbol_referencer::get_position (me) * ss / 2.0;
+      Interval my_ext = me->extent (me, Y_AXIS) + my_pos;
+
+      // The +1 and -1 come from the fact that we only want to add
+      // the interval between the note and the first ledger line, not
+      // the whole interval between the note and the staff.
+      Interval iv (min (0.0, lines[UP] - my_ext[DOWN] + 1),
+                   max (0.0, lines[DOWN] - my_ext[UP] - 1));
+      return ly_interval2scm (iv);
     }
 
-  return m.smobbed_copy ();
+  return ly_interval2scm (Interval (0, 0));
 }
 
-
 Real
 Note_head::stem_attachment_coordinate (Grob *me, Axis a)
 {
-  SCM brewer = me->get_grob_property ("molecule-callback");
-  Font_metric * fm  = Font_interface::get_default_font (me);
-  
-  if (brewer == Note_head::brew_molecule_proc)
+  Offset off = robust_scm2offset (me->get_property ("stem-attachment"),
+                                  Offset (0, 0));
+
+  return off [a];
+}
+
+Offset
+Note_head::get_stem_attachment (Font_metric *fm, const string &key)
+{
+  Offset att;
+
+  int k = fm->name_to_index (key);
+  if (k >= 0)
     {
-      SCM style  = me->get_grob_property ("style");
-      if (!gh_symbol_p (style))
-       {
-         return 0.0;
-       }
-      
-      SCM log = gh_int2scm (Note_head::get_balltype (me));
-      SCM proc = me->get_grob_property ("glyph-name-procedure");
-      SCM scm_font_char = scm_call_2 (proc, log, style);
-      String font_char = "noteheads-" + ly_scm2string (scm_font_char);
-
-      int k = fm->name_to_index (font_char) ;
-
-      if (k >= 0)
-       {
-         Box b = fm->get_indexed_char (k);
-         Offset wxwy = fm->get_indexed_wxwy (k);
-         Interval v = b[a];
-         if (!v.is_empty ())
-           return 2 * (wxwy[a] - v.center()) / v.length ();
-       }
+      Box b = fm->get_indexed_char_dimensions (k);
+      Offset wxwy = fm->attachment_point (key);
+      for (int i = X_AXIS; i < NO_AXES; i++)
+        {
+          Axis a = Axis (i);
+
+          Interval v = b[a];
+          if (!v.is_empty ())
+            {
+              att[a] = (2 * (wxwy[a] - v.center ()) / v.length ());
+            }
+        }
     }
-  
-  /*
-    Fallback
-   */
-  SCM v = me->get_grob_property ("stem-attachment-function");
-  if (!gh_procedure_p (v))
-    return 0.0;
-  
-  SCM result = scm_call_2 (v, me->self_scm(), gh_int2scm (a));
-  if (!gh_pair_p (result))
-    return 0.0;
-
-  result = (a == X_AXIS) ? ly_car (result) : ly_cdr (result);
-  
-  return robust_scm2double (result,0);
+
+  return att;
 }
 
-int
-Note_head::get_balltype (Grob*me) 
+MAKE_SCHEME_CALLBACK (Note_head, calc_stem_attachment, 1);
+SCM
+Note_head::calc_stem_attachment (SCM smob)
 {
-  SCM s = me->get_grob_property ("duration-log");
-  return gh_number_p (s) ? gh_scm2int (s) <? 2 : 0;
+  Grob *me = unsmob<Grob> (smob);
+  Font_metric *fm = Font_interface::get_default_font (me);
+  string key;
+  internal_print (me, &key);
+
+  return ly_offset2scm (get_stem_attachment (fm, key));
 }
 
-ADD_INTERFACE (Note_head,"note-head-interface",
-  "Note head",
-  "glyph-name-procedure accidental-grob style stem-attachment-function");
+ADD_INTERFACE (Note_head,
+               "A note head.  There are many possible values for"
+               " @code{style}.  For a complete list, see"
+               " @ruser{Note head styles}.",
+
+               /* properties */
+               "duration-log "
+               "note-names "
+               "accidental-grob "
+               "ignore-ambitus "
+               "glyph-name "
+               "stem-attachment "
+               "style "
+               "ledger-positions "
+              );