lily/time-signature.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "time-signature.hh"
  21
  22 #include "grob.hh"
  23 #include "font-interface.hh"
  24 #include "international.hh"
  25 #include "output-def.hh"
  26 #include "staff-symbol-referencer.hh"
  27 #include "text-interface.hh"
  28 #include "warn.hh"
  29
  30 /*
  31   TODO:
  32
  33   this file should go ; The formatting can completely be done with
  34   markups.
  35 */
  36
  37 MAKE_SCHEME_CALLBACK (Time_signature, print, 1);
  38 SCM
  39 Time_signature::print (SCM smob)
  40 {
  41   Grob *me = unsmob_grob (smob);
  42   SCM st = me->get_property ("style");
  43   SCM frac = me->get_property ("fraction");
  44   int n = 4;
  45   int d = 4;
  46   if (scm_is_pair (frac))
  47     {
  48       n = scm_to_int (scm_car (frac));
  49       d = scm_to_int (scm_cdr (frac));
  50     }
  51
  52   Stencil m;
  53   if (st == ly_symbol2scm ("single-digit"))
  54     m = numbered_time_signature (me, n, 0);
  55   else if (scm_is_symbol (st))
  56     m = special_time_signature (me, st, n, d);
  57   else
  58     m = numbered_time_signature (me, n, d);
  59
  60   if (Staff_symbol_referencer::line_count (me) % 2 == 0)
  61     m.translate_axis (Staff_symbol_referencer::staff_space (me) / 2, Y_AXIS);
  62
  63   return m.smobbed_copy ();
  64 }
  65
  66 Stencil
  67 Time_signature::special_time_signature (Grob *me, SCM scm_style, int n, int d)
  68 {
  69   string style = ly_scm2string (scm_symbol_to_string (scm_style));
  70
  71   if (style == "numbered")
  72     return numbered_time_signature (me, n, d);
  73
  74   if ((style == "default") || (style == ""))
  75     style = to_string ("C");
  76
  77   if (style == "C")
  78     {
  79       if /* neither C2/2 nor C4/4 */
  80         (((n != 2) || (d != 2))
  81          && ((n != 4) || (d != 4)))
  82         return numbered_time_signature (me, n, d);
  83     }
  84
  85   string char_name = style + to_string (n) + to_string (d);
  86   me->set_property ("font-encoding", ly_symbol2scm ("fetaMusic"));
  87   Stencil out = Font_interface::get_default_font (me)
  88     ->find_by_name ("timesig." + char_name);
  89   if (!out.is_empty ())
  90     return out;
  91
  92   /* If there is no such symbol, we default to the numbered style.
  93      (Here really with a warning!) */
  94   me->warning (_f ("time signature symbol `%s' not found; "
  95                    "reverting to numbered style", char_name));
  96   return numbered_time_signature (me, n, d);
  97 }
  98
  99 Stencil
 100 Time_signature::numbered_time_signature (Grob *me, int num, int den)
 101 {
 102   SCM chain = me->get_property_alist_chain (Font_interface::text_font_alist_chain (me));
 103   chain = scm_cons (scm_list_1 (scm_cons (ly_symbol2scm ("font-encoding"),
 104                                           ly_symbol2scm ("fetaText"))),
 105                     chain);
 106
 107   SCM sn = Text_interface::interpret_markup (me->layout ()->self_scm (), chain,
 108                                              ly_string2scm (to_string (num)));
 109   SCM sd = Text_interface::interpret_markup (me->layout ()->self_scm (), chain,
 110                                              ly_string2scm (to_string (den)));
 111
 112   Stencil n = *unsmob_stencil (sn);
 113   Stencil d = *unsmob_stencil (sd);
 114
 115   n.align_to (X_AXIS, CENTER);
 116   d.align_to (X_AXIS, CENTER);
 117   Stencil m;
 118   if (den)
 119     {
 120       m.add_at_edge (Y_AXIS, UP, n, 0.0);
 121       m.add_at_edge (Y_AXIS, DOWN, d, 0.0);
 122     }
 123   else
 124     {
 125       m = n;
 126       m.align_to (Y_AXIS, CENTER);
 127     }
 128
 129   m.align_to (X_AXIS, LEFT);
 130
 131   return m;
 132 }
 133
 134 ADD_INTERFACE (Time_signature,
 135                "A time signature, in different styles.  The following values"
 136                " for @code{style} are are recognized:\n"
 137                "\n"
 138                "@table @code\n"
 139                "@item C\n"
 140                "4/4 and 2/2 are typeset as C and struck C, respectively."
 141                "  All other time signatures are written with two digits."
 142                "  The value @code{default} is equivalent to @code{C}.\n"
 143                "@item neomensural\n"
 144                "2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are"
 145                " typeset with neo-mensural style mensuration marks.  All"
 146                " other time signatures are written with two digits.\n"
 147                "@item mensural\n"
 148                "2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are"
 149                " typeset with mensural style mensuration marks.  All other"
 150                " time signatures are written with two digits.\n"
 151                "@item single-digit\n"
 152                "All time signatures are typeset with a single digit, e.g.,"
 153                " 3/2 is written as 3.\n"
 154                "@item numbered\n"
 155                "All time signatures are typeset with two digits.\n"
 156                "@end table",
 157
 158                /* properties */
 159                "fraction "
 160                "style "
 161                );