]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/key-signature-interface.cc
unsmob_pitch -> Pitch::unsmob and related
[lilypond.git] / lily / key-signature-interface.cc
index 802a6bf015657e20661e2a260fb49348d40dcf43..e345e9d132308b768584cea3daf40919f5439a00 100644 (file)
-
 /*
-  key-item.cc -- implement Key_signature_interface
-
-  source file of the GNU LilyPond music typesetter
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1996--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   keyplacement by Mats Bengtsson
-*/
 
-#include "item.hh"
+  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.
+
+  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.
 
-#include "molecule.hh"
-#include "paper-def.hh"
+  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 "staff-symbol-referencer.hh"
+#include "international.hh"
+#include "item.hh"
 #include "lookup.hh"
-#include "lily-guile.hh"
-#include "lily-proto.hh"
-
+#include "output-def.hh"
+#include "staff-symbol-referencer.hh"
+#include "rational.hh"
 
 struct Key_signature_interface
 {
-  DECLARE_SCHEME_CALLBACK (brew_molecule, (SCM ));
+  DECLARE_SCHEME_CALLBACK (print, (SCM));
+  DECLARE_GROB_INTERFACE ();
 };
 
-
-/*
-  FIXME: too much hardcoding here.
- */
-const int FLAT_TOP_PITCH=2; /* fes,ges,as and bes typeset in lower octave */
-const int SHARP_TOP_PITCH=4; /*  ais and bis typeset in lower octave */
-
-
-/*
-  FIXME: key-item should just get a list of (position, acc), and leave
-  the thinking to other parties.
-
-  - TODO: put this in Scheme
-  
-  - lots of values trivially shared (key doesn't change very
-  often). Compute those once, and use that as cache for the rest.
-
-*/
-int
-alteration_pos  (SCM what, int alter, int c0p)
-{
-  if (gh_pair_p (what))
-    return gh_scm2int (ly_car (what)) * 7 + gh_scm2int (ly_cdr (what)) + c0p;
-
-  int p = gh_scm2int (what);
-
-  // Find the c in the range -4 through 2
-  int from_bottom_pos = c0p + 4;
-  from_bottom_pos = from_bottom_pos%7;
-  from_bottom_pos = (from_bottom_pos + 7)%7; // Precaution to get positive.
-  int c0 = from_bottom_pos - 4;
-
-    
-  if ((alter <0 && ((p>FLAT_TOP_PITCH) || (p+c0>4)) && (p+c0>1)) 
-      ||
-      (alter >0 && ((p>SHARP_TOP_PITCH) || (p+c0>5)) && (p+c0>2))) 
-    {
-      p -= 7; /* Typeset below c_position */
-    }
-  /* Provide for the four cases in which there's a glitch 
-       it's a hack, but probably not worth  
-       the effort of finding a nicer solution.
-       --dl. */
-  if (c0==2 && alter >0 && p==3)
-    p -= 7;
-  if (c0==-3 && alter>0 && p==-1)
-    p += 7;
-  if (c0==-4 && alter<0 && p==-1)
-    p += 7;
-  if (c0==-2 && alter<0 && p==-3)
-    p += 7;
-    
-  return p + c0;
-}
-
 /*
   TODO
   - space the `natural' signs wider
- */
-MAKE_SCHEME_CALLBACK (Key_signature_interface,brew_molecule,1);
+*/
+MAKE_SCHEME_CALLBACK (Key_signature_interface, print, 1);
 SCM
-Key_signature_interface::brew_molecule (SCM smob)
+Key_signature_interface::print (SCM smob)
 {
-  Grob*me =unsmob_grob (smob);
+  Item *me = dynamic_cast<Item *> (Grob::unsmob (smob));
 
-  Real inter = Staff_symbol_referencer::staff_space (me)/2.0;
-  
-  SCM scm_style = me->get_grob_property ("style");
-  String style;
-  if (gh_symbol_p (scm_style))
-    {
-      style = ly_scm2string (scm_symbol_to_string (scm_style));
-    }
-  else
-    {
-      style = "";
-    }
+  Real inter = Staff_symbol_referencer::staff_space (me) / 2.0;
+
+  Stencil mol;
 
-  SCM newas = me->get_grob_property ("new-accidentals");  
-  Molecule mol;
+  SCM c0s = me->get_property ("c0-position");
 
-  SCM c0s = me->get_grob_property ("c0-position");
-  int c0p=0;
-  if (gh_number_p (c0s))
-     c0p = gh_scm2int (c0s);
+  bool is_cancellation = me->internal_has_interface
+                         (ly_symbol2scm ("key-cancellation-interface"));
 
   /*
     SCM lists are stacks, so we work from right to left, ending with
     the cancellation signature.
   */
 
-  for (SCM s = newas; gh_pair_p (s); s = ly_cdr (s))
-    {
-      SCM what = ly_caar (s);
-      int alter = gh_scm2int (ly_cdar (s));
-      int pos = alteration_pos (what, alter, c0p);
-      
-      Molecule m = Font_interface::get_default_font (me)->
-         find_by_name (String ("accidentals-") + style + to_str (alter));
-      m.translate_axis (pos * inter, Y_AXIS);
-      mol.add_at_edge (X_AXIS, LEFT, m, 0);
-    }
+  Slice pos, overlapping_pos;
+  SCM last_glyph_name = SCM_BOOL_F;
+  SCM padding_pairs = me->get_property ("padding-pairs");
+
+  Font_metric *fm = Font_interface::get_default_font (me);
+  SCM alist = me->get_property ("glyph-name-alist");
 
-  Item *it = dynamic_cast<Item*> (me) ;
-  if (it->break_status_dir () != RIGHT)
+  for (SCM s = me->get_property ("alteration-alist"); scm_is_pair (s); s = scm_cdr (s))
     {
-      SCM old = me->get_grob_property ("old-accidentals");
-      
-      /*
-       Add half a space between  cancellation and key sig.
-
-       As suggested by [Ross], p.148.
-       */
-      Interval x (0, inter);
-      Interval y (0,0);
-
-      mol.add_at_edge (X_AXIS, LEFT, Lookup::blank (Box (x,y)),0);
-
-      Molecule natural;
-      if (gh_pair_p (old))
-       natural=Font_interface::get_default_font (me)->
-           find_by_name (String ("accidentals-") + style + String ("0"));
-      
-      for (; gh_pair_p (old); old = ly_cdr (old))
+      SCM alt = is_cancellation
+                ? scm_from_int (0)
+                : scm_cdar (s);
+
+      SCM glyph_name_scm = ly_assoc_get (alt, alist, SCM_BOOL_F);
+      if (!scm_is_string (glyph_name_scm))
+        {
+          me->warning (_f ("No glyph found for alteration: %s",
+                           ly_scm2rational (alt).to_string ().c_str ()));
+          continue;
+        }
+
+      string glyph_name = ly_scm2string (glyph_name_scm);
+
+      Stencil acc (fm->find_by_name (glyph_name));
+
+      if (acc.is_empty ())
+        me->warning (_ ("alteration not found"));
+      else
         {
-         SCM found = scm_assoc (ly_caar (old), newas);
-         if (found == SCM_BOOL_F
-             || ly_cdr (found) != ly_cdar (old))
-           {
-             SCM what = ly_caar (old);
-             int alter = 0;
-             int pos = alteration_pos (what, alter, c0p);
-
-             Molecule m = natural;
-              m.translate_axis (pos* inter, Y_AXIS);
-
-             mol.add_at_edge (X_AXIS, LEFT, m, 0);
+          SCM proc = ly_lily_module_constant ("key-signature-interface::alteration-positions");
+
+          pos.set_empty ();
+          Stencil column;
+          for (SCM pos_list = scm_call_3 (proc, scm_car (s), c0s, smob);
+               scm_is_pair (pos_list); pos_list = scm_cdr (pos_list))
+            {
+              int p = scm_to_int (scm_car (pos_list));
+              pos.add_point (p);
+              column.add_stencil (acc.translated (Offset (0, p * inter)));
             }
+          /*
+            The natural sign (unlike flat & sharp)
+            has vertical edges on both sides. A little padding is
+            needed to prevent collisions.
+          */
+          Real padding = robust_scm2double (me->get_property ("padding"),
+                                            0.0);
+          SCM handle = scm_assoc (scm_cons (glyph_name_scm, last_glyph_name),
+                                  padding_pairs);
+          if (scm_is_pair (handle))
+            padding = robust_scm2double (scm_cdr (handle), 0.0);
+          else if (glyph_name == "accidentals.natural"
+                   && !intersection (overlapping_pos, pos).is_empty ())
+            padding += 0.3;
+
+          mol.add_at_edge (X_AXIS, LEFT, column, padding);
+
+          pos.widen (4);
+          overlapping_pos = pos + 2;
+          last_glyph_name = glyph_name_scm;
         }
     }
 
   mol.align_to (X_AXIS, LEFT);
-  
+
   return mol.smobbed_copy ();
 }
 
-ADD_INTERFACE (Key_signature_interface, "key-signature-interface",
-  "A group of  accidentals.",
-  "c0-position old-accidentals new-accidentals");
+ADD_INTERFACE (Key_signature_interface,
+               "A group of accidentals, to be printed as signature sign.",
+
+               /* properties */
+               "alteration-alist "
+               "c0-position "
+               "glyph-name-alist "
+               "flat-positions "
+               "sharp-positions "
+               "padding "
+               "padding-pairs "
+              );