lily/key-signature-interface.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   keyplacement by Mats Bengtsson
   7
   8   LilyPond is free software: you can redistribute it and/or modify
   9   it under the terms of the GNU General Public License as published by
  10   the Free Software Foundation, either version 3 of the License, or
  11   (at your option) any later version.
  12
  13   LilyPond is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "accidental-interface.hh"
  23 #include "font-interface.hh"
  24 #include "international.hh"
  25 #include "item.hh"
  26 #include "lookup.hh"
  27 #include "output-def.hh"
  28 #include "staff-symbol-referencer.hh"
  29 #include "rational.hh"
  30 #include "lily-imports.hh"
  31
  32 struct Key_signature_interface
  33 {
  34   DECLARE_SCHEME_CALLBACK (print, (SCM));
  35   DECLARE_GROB_INTERFACE ();
  36 };
  37
  38 /*
  39   TODO
  40   - space the `natural' signs wider
  41 */
  42 MAKE_SCHEME_CALLBACK (Key_signature_interface, print, 1);
  43 SCM
  44 Key_signature_interface::print (SCM smob)
  45 {
  46   Item *me = unsmob<Item> (smob);
  47
  48   Real inter = Staff_symbol_referencer::staff_space (me) / 2.0;
  49
  50   Stencil mol;
  51
  52   SCM c0s = me->get_property ("c0-position");
  53
  54   bool is_cancellation = me->internal_has_interface
  55                          (ly_symbol2scm ("key-cancellation-interface"));
  56
  57   /*
  58     SCM lists are stacks, so we work from right to left, ending with
  59     the cancellation signature.
  60   */
  61
  62   Slice pos, overlapping_pos;
  63   SCM last_glyph_name = SCM_BOOL_F;
  64   SCM padding_pairs = me->get_property ("padding-pairs");
  65
  66   Font_metric *fm = Font_interface::get_default_font (me);
  67   SCM alist = me->get_property ("glyph-name-alist");
  68
  69   for (SCM s = me->get_property ("alteration-alist"); scm_is_pair (s); s = scm_cdr (s))
  70     {
  71       SCM alt = is_cancellation
  72                 ? scm_from_int (0)
  73                 : scm_cdar (s);
  74
  75       SCM glyph_name_scm = ly_assoc_get (alt, alist, SCM_BOOL_F);
  76       if (!scm_is_string (glyph_name_scm))
  77         {
  78           me->warning (_f ("No glyph found for alteration: %s",
  79                            ly_scm2rational (alt).to_string ().c_str ()));
  80           continue;
  81         }
  82
  83       string glyph_name = ly_scm2string (glyph_name_scm);
  84
  85       Stencil acc (fm->find_by_name (glyph_name));
  86
  87       if (acc.is_empty ())
  88         me->warning (_ ("alteration not found"));
  89       else
  90         {
  91           pos.set_empty ();
  92           Stencil column;
  93           for (SCM pos_list = Lily::key_signature_interface_alteration_positions
  94                  (scm_car (s), c0s, smob);
  95                scm_is_pair (pos_list); pos_list = scm_cdr (pos_list))
  96             {
  97               int p = scm_to_int (scm_car (pos_list));
  98               pos.add_point (p);
  99               column.add_stencil (acc.translated (Offset (0, p * inter)));
 100             }
 101           /*
 102             The natural sign (unlike flat & sharp)
 103             has vertical edges on both sides. A little padding is
 104             needed to prevent collisions.
 105           */
 106           Real padding = robust_scm2double (me->get_property ("padding"),
 107                                             0.0);
 108           SCM handle = scm_assoc (scm_cons (glyph_name_scm, last_glyph_name),
 109                                   padding_pairs);
 110           if (scm_is_pair (handle))
 111             padding = robust_scm2double (scm_cdr (handle), 0.0);
 112           else if (glyph_name == "accidentals.natural"
 113                    && !intersection (overlapping_pos, pos).is_empty ())
 114             padding += 0.3;
 115
 116           mol.add_at_edge (X_AXIS, LEFT, column, padding);
 117
 118           pos.widen (4);
 119           overlapping_pos = pos + 2;
 120           last_glyph_name = glyph_name_scm;
 121         }
 122     }
 123
 124   mol.align_to (X_AXIS, LEFT);
 125
 126   return mol.smobbed_copy ();
 127 }
 128
 129 ADD_INTERFACE (Key_signature_interface,
 130                "A group of accidentals, to be printed as signature sign.",
 131
 132                /* properties */
 133                "alteration-alist "
 134                "c0-position "
 135                "glyph-name-alist "
 136                "flat-positions "
 137                "sharp-positions "
 138                "padding "
 139                "padding-pairs "
 140               );