lily/accidental.cc

   1 /*
   2   accidental.cc -- implement Accidental_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2001--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "font-interface.hh"
  10 #include "item.hh"
  11 #include "stencil.hh"
  12 #include "accidental-interface.hh"
  13 #include "output-def.hh"
  14 #include "pitch.hh"
  15
  16 /*
  17   TODO: insert support for smaller cautionaries, tie-break-reminders.
  18   Either here or in new-accidental-engraver.
  19
  20   'accidentals should go, for a single 'accidental property -- see
  21   accidental-placement.cc
  22 */
  23 Stencil
  24 parenthesize (Grob *me, Stencil m)
  25 {
  26   Stencil open = Font_interface::get_default_font (me)->find_by_name ("accidentals.leftparen");
  27   Stencil close = Font_interface::get_default_font (me)->find_by_name ("accidentals.rightparen");
  28
  29   m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0, 0);
  30   m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0, 0);
  31
  32   return m;
  33 }
  34
  35 MAKE_SCHEME_CALLBACK (Accidental_interface, after_line_breaking, 1);
  36 SCM
  37 Accidental_interface::after_line_breaking (SCM smob)
  38 {
  39   Grob *me = unsmob_grob (smob);
  40   Grob *tie = unsmob_grob (me->get_property ("tie"));
  41
  42   if (tie && !tie->original_)
  43     {
  44       me->suicide ();
  45     }
  46   return SCM_UNSPECIFIED;
  47 }
  48
  49 Array<Box>
  50 Accidental_interface::accurate_boxes (Grob *a, Grob **common)
  51 {
  52   Box b;
  53   b[X_AXIS] = a->extent (a, X_AXIS);
  54   b[Y_AXIS] = a->extent (a, Y_AXIS);
  55
  56   Array<Box> boxes;
  57
  58   bool parens = false;
  59   if (to_boolean (a->get_property ("cautionary")))
  60     {
  61       SCM cstyle = a->get_property ("cautionary-style");
  62       parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
  63     }
  64
  65   SCM accs = a->get_property ("accidentals");
  66   SCM scm_style = a->get_property ("style");
  67   if (!scm_is_symbol (scm_style)
  68       && !parens
  69       && scm_ilength (accs) == 1)
  70     {
  71       switch (scm_to_int (scm_car (accs))
  72         {
  73         case FLAT:
  74           {
  75             Box stem = b;
  76             Box bulb = b;
  77
  78             /*
  79               we could make the stem thinner, but that places the flats
  80               really close.
  81             */
  82             stem[X_AXIS][RIGHT] *= .5;
  83
  84             /*
  85               To prevent vertical alignment for 6ths
  86             */
  87             stem[Y_AXIS] *= 1.1;
  88             bulb[Y_AXIS][UP] *= .35;
  89
  90             boxes.push (bulb);
  91             boxes.push (stem);
  92           }
  93           break;
  94         case NATURAL:
  95           {
  96             Box lstem = b;
  97             Box rstem = b;
  98             Box belly = b;
  99
 100             lstem[Y_AXIS] *= 1.1;
 101             rstem[Y_AXIS] *= 1.1;
 102
 103             belly[Y_AXIS] *= 0.75;
 104             lstem[X_AXIS][RIGHT] *= .5;
 105             rstem[X_AXIS][LEFT] = lstem[X_AXIS][RIGHT];
 106             lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
 107             rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
 108             boxes.push (belly);
 109             boxes.push (lstem);
 110             boxes.push (rstem);
 111           }
 112           break;
 113           /*
 114             TODO: add support for, double flat.
 115           */
 116         }
 117
 118               if (!boxes.size ())
 119                 boxes.push (b);
 120
 121               Offset o (a->relative_coordinate (common[X_AXIS], X_AXIS),
 122                         a->relative_coordinate (common[Y_AXIS], Y_AXIS));
 123               for (int i = boxes.size (); i--;)
 124                 {
 125                   boxes[i].translate (o);
 126                 }
 127
 128               return boxes;
 129               }
 130
 131       /*
 132        * Some styles do not provide all flavours of accidentals, e.g. there
 133        * is currently no sharp accidental in vaticana style.  In these cases
 134        * this function falls back to one of the other styles.
 135        */
 136
 137       /*
 138         todo: this sort of stuff in Scheme. --hwn.
 139       */
 140       String
 141         Accidental_interface::get_fontcharname (String style, int alteration)
 142       {
 143         if (alteration == DOUBLE_FLAT
 144             || alteration == DOUBLE_SHARP)
 145           {
 146             return to_string (alteration);
 147           }
 148
 149         if (style == "hufnagel")
 150           switch (alteration)
 151             {
 152             case FLAT: return "hufnagel-1";
 153             case 0: return "vaticana0";
 154             case SHARP: return "mensural1";
 155             }
 156         if (style == "medicaea")
 157           switch (alteration)
 158             {
 159             case FLAT: return "medicaea-1";
 160             case 0: return "vaticana0";
 161             case SHARP: return "mensural1";
 162             }
 163         if (style == "vaticana")
 164           switch (alteration)
 165             {
 166             case FLAT: return "vaticana-1";
 167             case 0: return "vaticana0";
 168             case SHARP: return "mensural1";
 169             }
 170         if (style == "mensural")
 171           switch (alteration)
 172             {
 173             case FLAT: return "mensural-1";
 174             case 0: return "vaticana0";
 175             case SHARP: return "mensural1";
 176             }
 177
 178         if (style == "neomensural")
 179           style = ""; // currently same as default
 180         if (style == "default")
 181           style = "";
 182         return style + to_string (alteration);
 183       }
 184
 185       MAKE_SCHEME_CALLBACK (Accidental_interface, print, 1);
 186       SCM
 187         Accidental_interface::print (SCM smob)
 188       {
 189         Grob *me = unsmob_grob (smob);
 190         bool smaller = false;
 191         bool parens = false;
 192
 193         bool caut = to_boolean (me->get_property ("cautionary"));
 194         if (caut)
 195           {
 196             SCM cstyle = me->get_property ("cautionary-style");
 197             parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
 198             smaller = ly_c_equal_p (cstyle, ly_symbol2scm ("smaller"));
 199           }
 200
 201         SCM scm_style = me->get_property ("style");
 202         String style;
 203         if (scm_is_symbol (scm_style))
 204           {
 205             style = ly_symbol2string (scm_style);
 206           }
 207         else
 208           {
 209             /*
 210               preferably no name for the default style.
 211             */
 212             style = "";
 213           }
 214
 215         Font_metric *fm = 0;
 216         if (smaller)
 217           {
 218             SCM ac = Font_interface::music_font_alist_chain (me);
 219             /*
 220               TODO: should calc font-size by adding -2 to current font-size
 221             */
 222             ac = scm_cons (scm_list_1 (scm_cons
 223                                        (ly_symbol2scm ("font-size"),
 224                                         scm_int2num (-2))),
 225                            ac);
 226             fm = select_font (me->get_layout (), ac);
 227           }
 228         else
 229           fm = Font_interface::get_default_font (me);
 230
 231         Stencil mol;
 232         for (SCM s = me->get_property ("accidentals");
 233              scm_is_pair (s); s = scm_cdr (s))
 234           {
 235             int alteration = scm_to_int (scm_car (s));
 236             String font_char = get_fontcharname (style, alteration);
 237             Stencil acc (fm->find_by_name ("accidentals." + font_char));
 238
 239             if (acc.is_empty ())
 240               {
 241                 me->warning (_f ("accidental `%s' not found", font_char));
 242               }
 243             else
 244               {
 245                 mol.add_at_edge (X_AXIS, RIGHT, acc, 0.1, 0);
 246               }
 247           }
 248
 249         if (parens)
 250           mol = parenthesize (me, mol);
 251
 252         return mol.smobbed_copy ();
 253       }
 254
 255       /*
 256         TODO: should move inside-slur into item?
 257
 258       */
 259       ADD_INTERFACE (Accidental_interface, "accidental-interface",
 260                      "a single accidental",
 261                      "inside-slur cautionary cautionary-style style tie accidentals");