lily/rest.cc

   1 /*
   2  rest.cc -- implement Rest
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "stencil.hh"
  10 #include "paper-def.hh"
  11 #include "font-interface.hh"
  12 #include "rest.hh"
  13 #include "dots.hh"
  14 #include "paper-score.hh"
  15 #include "staff-symbol-referencer.hh"
  16 #include "directional-element-interface.hh"
  17
  18 // -> offset callback
  19 MAKE_SCHEME_CALLBACK (Rest,after_line_breaking,1);
  20 SCM
  21 Rest::after_line_breaking (SCM smob)
  22 {
  23   Grob *me = unsmob_grob (smob);
  24   int bt = gh_scm2int (me->get_property ("duration-log"));
  25   int lc = Staff_symbol_referencer::line_count (me);
  26   Real ss = Staff_symbol_referencer::staff_space (me);
  27   if (lc % 2)
  28     {
  29       if (bt == 0 && lc > 1)
  30         {
  31           me->translate_axis (ss , Y_AXIS);
  32         }
  33     }
  34   else
  35     {
  36       me->translate_axis (ss/2 , Y_AXIS);
  37     }
  38
  39   Grob * d = unsmob_grob (me->get_property ("dot"));
  40   if (d && bt > 4) // UGH.
  41     {
  42       d->set_property ("staff-position",
  43                             gh_int2scm ((bt == 7) ? 4 : 3));
  44     }
  45   if (d && bt >= -1 && bt <= 1) // UGH again.
  46     {
  47       d->set_property ("staff-position",
  48                             gh_int2scm ((bt == 0) ? -1 : 1));
  49     }
  50   return SCM_UNSPECIFIED;
  51 }
  52
  53 /*
  54   make this function easily usable in C++
  55  */
  56 String
  57 Rest::glyph_name (Grob *me, int balltype, String style)
  58 {
  59   bool ledgered_b = false;
  60
  61   if (balltype == 0 || balltype == 1)
  62     {
  63       Real rad = Staff_symbol_referencer::staff_radius (me) * 2.0;
  64       Real pos = Staff_symbol_referencer::get_position (me);
  65
  66       /*
  67         Figure out when the rest is far enough outside the staff. This
  68         could bemore generic, but hey, we understand this even after
  69         dinner.
  70        */
  71       ledgered_b |= (balltype == 0) && (pos >= +rad + 2 || pos < -rad);
  72       ledgered_b |= (balltype == 1) && (pos <= -rad - 2 || pos > +rad);
  73     }
  74
  75   String actual_style (style.to_str0 ());
  76
  77   if ((style == "mensural") || (style == "neo_mensural")) {
  78
  79     /*
  80       FIXME: Currently, ancient font does not provide ledgered rests;
  81       hence the "o" suffix in the glyph name is bogus.  But do we need
  82       ledgered rests at all now that we can draw ledger lines with
  83       variable width, length and blotdiameter? -- jr
  84     */
  85     ledgered_b = 0;
  86
  87     /*
  88       There are no 32th/64th/128th mensural/neo_mensural rests.  In
  89       these cases, revert back to default style.
  90     */
  91     if (balltype > 4)
  92       actual_style = "";
  93   }
  94
  95   if ((style == "classical") && (balltype != 2)) {
  96     /*
  97       classical style: revert back to default style for any rest other
  98       than quarter rest
  99     */
 100     actual_style = "";
 101   }
 102
 103   if (style == "default") {
 104     /*
 105       Some parts of lily still prefer style "default" over "".
 106       Correct this here. -- jr
 107     */
 108     actual_style = "";
 109   }
 110
 111   return ("rests-") + to_string (balltype) + (ledgered_b ? "o" : "") + actual_style;
 112 }
 113
 114
 115 MAKE_SCHEME_CALLBACK (Rest,print,1);
 116
 117 SCM
 118 Rest::brew_internal_stencil (SCM smob)
 119 {
 120   Grob* me = unsmob_grob (smob);
 121
 122   SCM balltype_scm = me->get_property ("duration-log");
 123   if (!gh_number_p (balltype_scm))
 124     return Stencil ().smobbed_copy ();
 125
 126   int balltype = gh_scm2int (balltype_scm);
 127
 128   String style;
 129   SCM style_scm = me->get_property ("style");
 130   if (gh_symbol_p (style_scm))
 131     {
 132       style = ly_scm2string (scm_symbol_to_string (style_scm));
 133     }
 134
 135   Font_metric *fm = Font_interface::get_default_font (me);
 136   String font_char = glyph_name (me, balltype, style);
 137   Stencil out = fm->find_by_name (font_char);
 138   if (out.is_empty ())
 139     {
 140       me->warning (_f ("rest `%s' not found, ", font_char.to_str0 ()));
 141     }
 142
 143   return out.smobbed_copy ();
 144 }
 145
 146 SCM
 147 Rest::print (SCM smob)
 148 {
 149   return brew_internal_stencil (smob);
 150 }
 151 MAKE_SCHEME_CALLBACK (Rest,extent_callback,2);
 152 /*
 153   We need the callback. The real stencil has ledgers depending on
 154   Y-position. The Y-position is known only after line breaking.  */
 155 SCM
 156 Rest::extent_callback (SCM smob, SCM ax)
 157 {
 158   Axis a = (Axis) gh_scm2int (ax);
 159   SCM m = brew_internal_stencil (smob);
 160   return ly_interval2scm (unsmob_stencil (m)->extent (a));
 161 }
 162
 163 MAKE_SCHEME_CALLBACK (Rest,polyphonic_offset_callback,2);
 164 SCM
 165 Rest::polyphonic_offset_callback (SCM smob, SCM)
 166 {
 167   Grob* me = unsmob_grob (smob);
 168   if (gh_number_p (me->get_property ("staff-position")))
 169     return gh_double2scm (0);
 170
 171   Direction d = get_grob_direction (me);
 172   Real off = 2* d ;
 173   if (off)
 174     off *= Staff_symbol_referencer::staff_space (me);
 175   return gh_double2scm (off);
 176 }
 177
 178 ADD_INTERFACE (Rest,"rest-interface",
 179   "A rest symbol.",
 180   "style minimum-distance");
 181