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 };
  36
  37 /*
  38   TODO
  39   - space the `natural' signs wider
  40 */
  41 MAKE_SCHEME_CALLBACK (Key_signature_interface, print, 1);
  42 SCM
  43 Key_signature_interface::print (SCM smob)
  44 {
  45   Item *me = unsmob<Item> (smob);
  46
  47   Real inter = Staff_symbol_referencer::staff_space (me) / 2.0;
  48
  49   Stencil mol;
  50
  51   SCM c0s = me->get_property ("c0-position");
  52
  53   bool is_cancellation = me->internal_has_interface
  54                          (ly_symbol2scm ("key-cancellation-interface"));
  55
  56   /*
  57     SCM lists are stacks, so we work from right to left, ending with
  58     the cancellation signature.
  59   */
  60
  61   Slice pos, overlapping_pos;
  62   SCM last_glyph_name = SCM_BOOL_F;
  63   SCM padding_pairs = me->get_property ("padding-pairs");
  64
  65   Font_metric *fm = Font_interface::get_default_font (me);
  66   SCM alist = me->get_property ("glyph-name-alist");
  67
  68   for (SCM s = me->get_property ("alteration-alist"); scm_is_pair (s); s = scm_cdr (s))
  69     {
  70       SCM alt = is_cancellation
  71                 ? scm_from_int (0)
  72                 : scm_cdar (s);
  73
  74       SCM glyph_name_scm = ly_assoc_get (alt, alist, SCM_BOOL_F);
  75       if (!scm_is_string (glyph_name_scm))
  76         {
  77           me->warning (_f ("No glyph found for alteration: %s",
  78                            ly_scm2rational (alt).to_string ().c_str ()));
  79           continue;
  80         }
  81
  82       string glyph_name = ly_scm2string (glyph_name_scm);
  83
  84       Stencil acc (fm->find_by_name (glyph_name));
  85
  86       if (acc.is_empty ())
  87         me->warning (_ ("alteration not found"));
  88       else
  89         {
  90           pos.set_empty ();
  91           Stencil column;
  92           for (SCM pos_list = Lily::key_signature_interface_alteration_positions
  93                  (scm_car (s), c0s, smob);
  94                scm_is_pair (pos_list); pos_list = scm_cdr (pos_list))
  95             {
  96               int p = scm_to_int (scm_car (pos_list));
  97               pos.add_point (p);
  98               column.add_stencil (acc.translated (Offset (0, p * inter)));
  99             }
 100           /*
 101             The natural sign (unlike flat & sharp)
 102             has vertical edges on both sides. A little padding is
 103             needed to prevent collisions.
 104           */
 105           Real padding = robust_scm2double (me->get_property ("padding"),
 106                                             0.0);
 107           SCM handle = scm_assoc (scm_cons (glyph_name_scm, last_glyph_name),
 108                                   padding_pairs);
 109           if (scm_is_pair (handle))
 110             padding = robust_scm2double (scm_cdr (handle), 0.0);
 111           else if (glyph_name == "accidentals.natural"
 112                    && !intersection (overlapping_pos, pos).is_empty ())
 113             padding += 0.3;
 114
 115           mol.add_at_edge (X_AXIS, LEFT, column, padding);
 116
 117           pos.widen (4);
 118           overlapping_pos = pos + 2;
 119           last_glyph_name = glyph_name_scm;
 120         }
 121     }
 122
 123   mol.align_to (X_AXIS, LEFT);
 124
 125   return mol.smobbed_copy ();
 126 }
 127
 128 ADD_INTERFACE (Key_signature_interface,
 129                "A group of accidentals, to be printed as signature sign.",
 130
 131                /* properties */
 132                "alteration-alist "
 133                "c0-position "
 134                "glyph-name-alist "
 135                "flat-positions "
 136                "sharp-positions "
 137                "padding "
 138                "padding-pairs "
 139                "non-default "
 140               );