]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/accidental.cc
Run `make grand-replace'.
[lilypond.git] / lily / accidental.cc
index 61536c4ed44d3df9f6848d067228e0d89ce2b5da..1c2418500d750319a1ca67a76f21503c867f7bd5 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2001--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2001--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "accidental-interface.hh"
 #include "font-interface.hh"
+#include "international.hh"
 #include "item.hh"
 #include "output-def.hh"
+#include "paper-column.hh"
 #include "pitch.hh"
 #include "stencil.hh"
 
-/*
-  TODO: insert support for smaller cautionaries, tie-break-reminders.
-  Either here or in new-accidental-engraver.
-
-  'accidentals should go, for a single 'accidental property -- see
-  accidental-placement.cc
-*/
 Stencil
 parenthesize (Grob *me, Stencil m)
 {
-  Stencil open = Font_interface::get_default_font (me)->find_by_name ("accidentals.leftparen");
-  Stencil close = Font_interface::get_default_font (me)->find_by_name ("accidentals.rightparen");
+  Font_metric * font
+    = Font_interface::get_default_font (me); 
+  Stencil open
+    = font->find_by_name ("accidentals.leftparen");
+  Stencil close
+    = font->find_by_name ("accidentals.rightparen");
 
-  m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0, 0);
-  m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0, 0);
+  m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0);
+  m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0);
 
   return m;
 }
 
-MAKE_SCHEME_CALLBACK (Accidental_interface, after_line_breaking, 1);
-SCM
-Accidental_interface::after_line_breaking (SCM smob)
+/* If this gets called before line breaking, we will return a non-trivial
+   extent even if we belong to a tie and won't actually get printed. */
+static SCM
+get_extent (Grob *me, Axis a)
 {
-  Grob *me = unsmob_grob (smob);
-  Grob *tie = unsmob_grob (me->get_object ("tie"));
+  Stencil *s = unsmob_stencil (Accidental_interface::get_stencil (me));
 
-  if (tie && !tie->original_)
-    me->suicide ();
-  return SCM_UNSPECIFIED;
+  if (s)
+    return ly_interval2scm (s->extent (a));
+  return ly_interval2scm (Interval ());
 }
 
-Array<Box>
-Accidental_interface::accurate_boxes (Grob *a, Grob **common)
+MAKE_SCHEME_CALLBACK (Accidental_interface, height, 1);
+SCM
+Accidental_interface::height (SCM smob)
 {
-  Box b;
-  b[X_AXIS] = a->extent (a, X_AXIS);
-  b[Y_AXIS] = a->extent (a, Y_AXIS);
+  return get_extent (unsmob_grob (smob), Y_AXIS);
+}
 
-  Array<Box> boxes;
+MAKE_SCHEME_CALLBACK (Accidental_interface, width, 1);
+SCM
+Accidental_interface::width (SCM smob)
+{
+  return get_extent (unsmob_grob (smob), X_AXIS);
+}
 
-  bool parens = false;
-  if (to_boolean (a->get_property ("cautionary")))
+MAKE_SCHEME_CALLBACK (Accidental_interface, pure_height, 3);
+SCM
+Accidental_interface::pure_height (SCM smob, SCM start_scm, SCM)
+{
+  Item *me = dynamic_cast<Item*> (unsmob_grob (smob));
+  int start = scm_to_int (start_scm);
+  int rank = me->get_column ()->get_rank ();
+
+  if (to_boolean (me->get_property ("forced"))
+      || !unsmob_grob (me->get_object ("tie"))
+      || rank == start + 1) /* we are at the start of a line */
     {
-      SCM cstyle = a->get_property ("cautionary-style");
-      parens = ly_is_equal (cstyle, ly_symbol2scm ("parentheses"));
+      Stencil *s = unsmob_stencil (get_stencil (me));
+      if (s)
+       return ly_interval2scm (s->extent (Y_AXIS));
     }
 
-  SCM accs = a->get_property ("accidentals");
-  SCM scm_style = a->get_property ("style");
-  if (!scm_is_symbol (scm_style)
-      && !parens
-      && scm_ilength (accs) == 1)
+  return ly_interval2scm (Interval ());
+}
+
+vector<Box>
+Accidental_interface::accurate_boxes (Grob *me, Grob **common)
+{
+  Box b;
+  b[X_AXIS] = me->extent (me, X_AXIS);
+  b[Y_AXIS] = me->extent (me, Y_AXIS);
+
+  vector<Box> boxes;
+
+  bool parens = to_boolean (me->get_property ("parenthesized"));
+  if (!me->is_live ())
+    return boxes;
+
+  if (!to_boolean (me->get_property ("restore-first"))
+      && !parens)
     {
-      switch (scm_to_int (scm_car (accs)))
+      SCM alist = me->get_property ("glyph-name-alist");
+      SCM alt = me->get_property ("alteration");
+      string glyph_name = robust_scm2string (ly_assoc_get (alt, alist, SCM_BOOL_F),
+                                            "");
+      
+      if (glyph_name == "accidentals.flat"
+         || glyph_name == "accidentals.mirroredflat")
        {
-       case FLAT:
-         {
-           Box stem = b;
-           Box bulb = b;
-
-           /*
-             we could make the stem thinner, but that places the flats
-             really close.
-           */
-           stem[X_AXIS][RIGHT] *= .5;
-
-           /*
-             To prevent vertical alignment for 6ths
-           */
-           stem[Y_AXIS] *= 1.1;
-           bulb[Y_AXIS][UP] *= .35;
-
-           boxes.push (bulb);
-           boxes.push (stem);
-         }
-         break;
-       case NATURAL:
-         {
-           Box lstem = b;
-           Box rstem = b;
-           Box belly = b;
-
-           lstem[Y_AXIS] *= 1.1;
-           rstem[Y_AXIS] *= 1.1;
-
-           belly[Y_AXIS] *= 0.75;
-           lstem[X_AXIS][RIGHT] *= .33;
-           rstem[X_AXIS][LEFT] = rstem[X_AXIS].linear_combination (1.0 / 3.0);
-           lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
-           rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
-           boxes.push (belly);
-           boxes.push (lstem);
-           boxes.push (rstem);
-         }
-         break;
+         Box stem = b;
+         Box bulb = b;
+
+         /*
+           we could make the stem thinner, but that places the flats
+           really close.
+         */
+         Direction bulb_dir =
+           glyph_name == "accidentals.mirroredflat" ? LEFT : RIGHT;
+         stem[X_AXIS][bulb_dir] = stem[X_AXIS].center ();
+
          /*
-           TODO: add support for, double flat.
+           To prevent vertical alignment for 6ths
          */
+         stem[Y_AXIS] *= 1.1;
+         bulb[Y_AXIS][UP] *= .35;
+
+         boxes.push_back (bulb);
+         boxes.push_back (stem);
        }
+      else if (glyph_name ==  "accidentals.natural")
+       {
+         Box lstem = b;
+         Box rstem = b;
+         Box belly = b;
+
+         lstem[Y_AXIS] *= 1.1;
+         rstem[Y_AXIS] *= 1.1;
+
+         belly[Y_AXIS] *= 0.75;
+         lstem[X_AXIS][RIGHT] *= .33;
+         rstem[X_AXIS][LEFT] = rstem[X_AXIS].linear_combination (1.0 / 3.0);
+         lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
+         rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
+         boxes.push_back (belly);
+         boxes.push_back (lstem);
+         boxes.push_back (rstem);
+       }
+      /*
+       TODO: add support for, double flat.
+      */
     }
 
   if (!boxes.size ())
-    boxes.push (b);
-
-  Offset o (a->relative_coordinate (common[X_AXIS], X_AXIS),
-           a->relative_coordinate (common[Y_AXIS], Y_AXIS));
-  for (int i = boxes.size (); i--;)
-    {
-      boxes[i].translate (o);
-    }
+    boxes.push_back (b);
 
-  return boxes;
-}
+  Offset o (me->relative_coordinate (common[X_AXIS], X_AXIS),
+           me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 
-/*
- * Some styles do not provide all flavours of accidentals, e.g. there
- * is currently no sharp accidental in vaticana style.  In these cases
- * this function falls back to one of the other styles.
- */
+  for (vsize i = boxes.size (); i--;)
+    boxes[i].translate (o);
 
-/*
-  todo: this sort of stuff in Scheme. --hwn.
-*/
-String
-Accidental_interface::get_fontcharname (String style, int alteration)
-{
-  if (alteration == DOUBLE_FLAT
-      || alteration == DOUBLE_SHARP)
-    return to_string (alteration);
-
-  if (style == "hufnagel")
-    switch (alteration)
-      {
-      case FLAT: return "hufnagel-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-  if (style == "medicaea")
-    switch (alteration)
-      {
-      case FLAT: return "medicaea-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-  if (style == "vaticana")
-    switch (alteration)
-      {
-      case FLAT: return "vaticana-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-  if (style == "mensural")
-    switch (alteration)
-      {
-      case FLAT: return "mensural-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-
-  if (style == "neomensural")
-    style = ""; // currently same as default
-  if (style == "default")
-    style = "";
-  return style + to_string (alteration);
+  return boxes;
 }
 
 MAKE_SCHEME_CALLBACK (Accidental_interface, print, 1);
@@ -184,66 +161,65 @@ SCM
 Accidental_interface::print (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  bool smaller = false;
-  bool parens = false;
+  Grob *tie = unsmob_grob (me->get_object ("tie"));
 
-  bool caut = to_boolean (me->get_property ("cautionary"));
-  if (caut)
+  if (tie && !tie->original ()
+      && !to_boolean (me->get_property ("forced")))
     {
-      SCM cstyle = me->get_property ("cautionary-style");
-      parens = ly_is_equal (cstyle, ly_symbol2scm ("parentheses"));
-      smaller = ly_is_equal (cstyle, ly_symbol2scm ("smaller"));
+      me->suicide ();
+      return SCM_EOL;
     }
 
-  SCM scm_style = me->get_property ("style");
-  String style;
-  if (scm_is_symbol (scm_style))
-    style = ly_symbol2string (scm_style);
-  else
-    /*
-      preferably no name for the default style.
-    */
-    style = "";
-
-  Font_metric *fm = 0;
-  if (smaller)
+  return get_stencil (me);
+}
+
+SCM
+Accidental_interface::get_stencil (Grob *me)
+{
+  Font_metric *fm = Font_interface::get_default_font (me);
+
+  SCM alist = me->get_property ("glyph-name-alist");
+  SCM alt = me->get_property ("alteration");
+  SCM glyph_name = ly_assoc_get (alt, alist, SCM_BOOL_F);
+  
+  if (!scm_is_string (glyph_name))
     {
-      SCM ac = Font_interface::music_font_alist_chain (me);
-      /*
-       TODO: should calc font-size by adding -2 to current font-size
-      */
-      ac = scm_cons (scm_list_1 (scm_cons
-                                (ly_symbol2scm ("font-size"),
-                                 scm_int2num (-2))),
-                    ac);
-      fm = select_font (me->get_layout (), ac);
+      me->warning (_f ("Could not find glyph-name for alteration %s",
+                      ly_scm_write_string (alt).c_str ()));
+      return SCM_EOL;
     }
-  else
-    fm = Font_interface::get_default_font (me);
-
-  Stencil mol;
-  for (SCM s = me->get_property ("accidentals");
-       scm_is_pair (s); s = scm_cdr (s))
+  
+  Stencil mol (fm->find_by_name (ly_scm2string (glyph_name)));
+  if (to_boolean (me->get_property ("restore-first")))
     {
-      int alteration = scm_to_int (scm_car (s));
-      String font_char = get_fontcharname (style, alteration);
-      Stencil acc (fm->find_by_name ("accidentals." + font_char));
+      /*
+       this isn't correct for ancient accidentals, but they don't
+       use double flats/sharps anyway.
+       */
+      Stencil acc (fm->find_by_name ("accidentals.natural"));
 
       if (acc.is_empty ())
-       me->warning (_f ("accidental `%s' not found", font_char));
+       me->warning (_ ("natural alteration glyph not found"));
       else
-       mol.add_at_edge (X_AXIS, RIGHT, acc, 0.1, 0);
+       mol.add_at_edge (X_AXIS, LEFT, acc, 0.1);
     }
-
-  if (parens)
+  
+  if (to_boolean (me->get_property ("parenthesized")))
     mol = parenthesize (me, mol);
 
   return mol.smobbed_copy ();
 }
 
-/*
-  TODO: should move inside-slur into item?
-*/
-ADD_INTERFACE (Accidental_interface, "accidental-interface",
-              "a single accidental",
-              "inside-slur cautionary cautionary-style style tie accidentals");
+  
+ADD_INTERFACE (Accidental_interface,
+              "A single accidental.",
+              
+              /* properties */
+              "alteration "
+              "avoid-slur "
+              "forced "
+              "parenthesized "
+              "restore-first "
+              "glyph-name-alist "
+              "tie "
+              );