lily/key-signature-interface.cc

   1 /*
   2   key-item.cc -- implement Key_signature_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8   keyplacement by Mats Bengtsson
   9 */
  10
  11 #include "accidental-interface.hh"
  12 #include "font-interface.hh"
  13 #include "international.hh"
  14 #include "item.hh"
  15 #include "lookup.hh"
  16 #include "output-def.hh"
  17 #include "staff-symbol-referencer.hh"
  18
  19 struct Key_signature_interface
  20 {
  21   DECLARE_SCHEME_CALLBACK (print, (SCM));
  22
  23   static bool has_interface (Grob *);
  24 };
  25
  26 /*
  27   FIXME: too much hardcoding here.
  28 */
  29 const int FLAT_TOP_PITCH = 2; /* fes, ges, as and bes typeset in lower octave */
  30 const int SHARP_TOP_PITCH = 4; /*  ais and bis typeset in lower octave */
  31
  32 /*
  33   TODO: look this up. I'm not sure where the naturals ought to go.
  34 */
  35 const int NATURAL_TOP_PITCH = 4;
  36
  37 /*
  38   FIXME: key-item should just get a list of (position, acc), and leave
  39   the thinking to other parties.
  40
  41   - TODO: put this in Scheme
  42
  43   TODO: can  we do without c0pos? it's partly musical.
  44 */
  45 int
  46 alteration_pos (SCM what, int alter, int c0p)
  47 {
  48   if (scm_is_pair (what))
  49     return scm_to_int (scm_car (what)) * 7 + scm_to_int (scm_cdr (what)) + c0p;
  50
  51   int p = scm_to_int (what);
  52
  53   // Find the c in the range -4 through 2
  54   int from_bottom_pos = c0p + 4;
  55   from_bottom_pos = from_bottom_pos % 7;
  56   from_bottom_pos = (from_bottom_pos + 7) % 7; // Precaution to get positive.
  57   int c0 = from_bottom_pos - 4;
  58
  59   if ((alter < 0 && ((p > FLAT_TOP_PITCH) || (p + c0 > 4)) && (p + c0 > 1))
  60       || (alter > 0 && ((p > SHARP_TOP_PITCH) || (p + c0 > 5)) && (p + c0 > 2))
  61       || (alter == 0 && ((p > NATURAL_TOP_PITCH) || (p + c0 > 5)) && (p + c0 > 2)))
  62     {
  63       p -= 7; /* Typeset below c_position */
  64     }
  65
  66   /* Provide for the four cases in which there's a glitch
  67      it's a hack, but probably not worth
  68      the effort of finding a nicer solution.
  69      --dl. */
  70   if (c0 == 2 && alter > 0 && p == 3)
  71     p -= 7;
  72   if (c0==-3 && alter > 0 && p ==-1)
  73     p += 7;
  74   if (c0==-4 && alter < 0 && p ==-1)
  75     p += 7;
  76   if (c0==-2 && alter < 0 && p ==-3)
  77     p += 7;
  78
  79   return p + c0;
  80 }
  81
  82 /*
  83   TODO
  84   - space the `natural' signs wider
  85 */
  86 MAKE_SCHEME_CALLBACK (Key_signature_interface, print, 1);
  87 SCM
  88 Key_signature_interface::print (SCM smob)
  89 {
  90   Item *me = dynamic_cast<Item *> (unsmob_grob (smob));
  91
  92   Real inter = Staff_symbol_referencer::staff_space (me) / 2.0;
  93
  94   SCM scm_style = me->get_property ("style");
  95   string style;
  96   if (scm_is_symbol (scm_style))
  97     style = ly_symbol2string (scm_style);
  98   else
  99     style = "";
 100
 101   SCM newas = me->get_property ("alteration-alist");
 102   Stencil mol;
 103
 104   SCM c0s = me->get_property ("c0-position");
 105   int c0p = 0;
 106   if (scm_is_number (c0s))
 107     c0p = scm_to_int (c0s);
 108
 109   /*
 110     SCM lists are stacks, so we work from right to left, ending with
 111     the cancellation signature.
 112   */
 113
 114   int last_pos = -1000;
 115   Font_metric *fm = Font_interface::get_default_font (me);
 116   for (SCM s = newas; scm_is_pair (s); s = scm_cdr (s))
 117     {
 118       int alteration = scm_to_int (scm_cdar (s));
 119       string font_char
 120         = Accidental_interface::get_fontcharname (style, alteration);
 121       Stencil acc (fm->find_by_name ("accidentals." + font_char));
 122
 123       if (acc.is_empty ())
 124         me->warning (_f ("accidental `%s' not found", font_char));
 125       else
 126         {
 127           SCM what = scm_caar (s);
 128           int pos = alteration_pos (what, alteration, c0p);
 129           acc.translate_axis (pos * inter, Y_AXIS);
 130
 131           /*
 132             The natural sign (unlike flat & sharp)
 133             has vertical edges on both sides. A little padding is
 134             needed to prevent collisions.
 135           */
 136           Real padding = 0.0;
 137           if (alteration == 0
 138               && last_pos < pos + 2
 139               && last_pos > pos - 6)
 140             padding = 0.3;
 141
 142           mol.add_at_edge (X_AXIS, LEFT, acc, padding, 0);
 143           last_pos = pos;
 144         }
 145     }
 146
 147   mol.align_to (X_AXIS, LEFT);
 148
 149   return mol.smobbed_copy ();
 150 }
 151
 152 ADD_INTERFACE (Key_signature_interface, "key-signature-interface",
 153                "A group of accidentals, to be printed as signature sign.",
 154                "style c0-position alteration-alist");