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--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8   keyplacement by Mats Bengtsson
   9 */
  10
  11 #include "item.hh"
  12 #include "output-def.hh"
  13 #include "font-interface.hh"
  14 #include "staff-symbol-referencer.hh"
  15 #include "lookup.hh"
  16 #include "accidental-interface.hh"
  17
  18 struct Key_signature_interface
  19 {
  20   DECLARE_SCHEME_CALLBACK (print, (SCM));
  21
  22   static bool has_interface (Grob *);
  23 };
  24
  25 /*
  26   FIXME: too much hardcoding here.
  27 */
  28 const int FLAT_TOP_PITCH =2; /* fes, ges, as and bes typeset in lower octave */
  29 const int SHARP_TOP_PITCH =4; /*  ais and bis typeset in lower octave */
  30
  31 /*
  32   TODO: look this up. I'm not sure where the naturals ought to go.
  33 */
  34 const int NATURAL_TOP_PITCH = 4;
  35
  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   Grob *me = 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     {
  98       style = ly_symbol2string (scm_style);
  99     }
 100   else
 101     {
 102       style = "";
 103     }
 104
 105   SCM newas = me->get_property ("new-accidentals");
 106   Stencil mol;
 107
 108   SCM c0s = me->get_property ("c0-position");
 109   int c0p = 0;
 110   if (scm_is_number (c0s))
 111     c0p = scm_to_int (c0s);
 112
 113   /*
 114     SCM lists are stacks, so we work from right to left, ending with
 115     the cancellation signature.
 116   */
 117
 118   Font_metric *fm = Font_interface::get_default_font (me);
 119   for (SCM s = newas; scm_is_pair (s); s = scm_cdr (s))
 120     {
 121       int alteration = scm_to_int (scm_cdar (s));
 122       String font_char
 123         = Accidental_interface::get_fontcharname (style, alteration);
 124       Stencil acc (fm->find_by_name ("accidentals." + font_char));
 125
 126       if (acc.is_empty ())
 127         {
 128           me->warning (_f ("accidental `%s' not found", font_char));
 129         }
 130       else
 131         {
 132           SCM what = scm_caar (s);
 133           int pos = alteration_pos (what, alteration, c0p);
 134           acc.translate_axis (pos * inter, Y_AXIS);
 135           mol.add_at_edge (X_AXIS, LEFT, acc, 0, 0);
 136         }
 137     }
 138
 139   Item *it = dynamic_cast<Item *> (me);
 140   if (it->break_status_dir () != RIGHT)
 141     {
 142       SCM old = me->get_property ("old-accidentals");
 143
 144       Stencil natural;
 145       if (scm_is_pair (old))
 146         natural = Font_interface::get_default_font (me)->
 147           find_by_name (String ("accidentals.") + style + String ("0"));
 148
 149       int last_pos = -100;
 150       for (; scm_is_pair (old); old = scm_cdr (old))
 151         {
 152           SCM found = scm_assoc (scm_caar (old), newas);
 153           if (found == SCM_BOOL_F
 154               || scm_cdr (found) != scm_cdar (old))
 155             {
 156               SCM what = scm_caar (old);
 157               int alteration = 0;
 158               int pos = alteration_pos (what, alteration, c0p);
 159
 160               Stencil m = natural;
 161               m.translate_axis (pos* inter, Y_AXIS);
 162
 163               /*
 164                 The natural sign (unlike flat & sharp)
 165                 has vertical edges on both sides. A little padding is
 166                 needed to prevent collisions.
 167               */
 168               Real padding = 0.0;
 169               if (last_pos < pos + 2
 170                   && last_pos> pos - 6)
 171                 padding = 0.3;
 172
 173               mol.add_at_edge (X_AXIS, LEFT, m, padding, 0);
 174               last_pos = pos;
 175             }
 176         }
 177     }
 178
 179   mol.align_to (X_AXIS, LEFT);
 180
 181   return mol.smobbed_copy ();
 182 }
 183
 184 ADD_INTERFACE (Key_signature_interface, "key-signature-interface",
 185                "A group of accidentals, to be printed as signature sign.",
 186                "style c0-position old-accidentals new-accidentals");