lily/custos.cc

   1 /*
   2   custos.cc -- implement Custos
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (C) 2000 Juergen Reuter <reuterj@ira.uka.de>
   7 */
   8
   9 /* TODO:
  10
  11  - merge create_ledger_line () and Note_head::create_ledger_line()
  12
  13
  14  - rewrite create_ledger_line() to support short and thin ledger lines
  15
  16  - do not show if a clef change immediately follows in the next line
  17
  18  - make custos direction control configurable
  19
  20  - decide: do or do not print custos if the next line starts with a rest
  21
  22 */
  23
  24
  25 #include <stdio.h>
  26 #include "staff-symbol-referencer.hh"
  27 #include "custos.hh"
  28 #include "molecule.hh"
  29 #include "lookup.hh"
  30 #include "debug.hh"
  31 #include "note-head.hh"
  32 #include "item.hh"
  33 #include "font-interface.hh"
  34
  35 /*
  36    This function is a patched and hopefully much more understandable
  37    rewrite of Note_head::ledger_line().  It still has some
  38    bugs/limitations:
  39  *
  40    (1) The term thick/2 probably should be thick*2 (probably a bug,
  41    see the code below).
  42  *
  43    (2) The minimal width of the resulting ledger line equals the width
  44    of the noteheads-ledgerending symbol (a limitation):
  45  *
  46      (---- left ledger ending
  47      ----) right ledger ending
  48      (---) resulting ledger line (just ok)
  49  *
  50    If x_extent ("xwid" in Note_head) is less than the width of the
  51    ledger ending, the width of the total ledger line is even *greater*
  52    than the width of a ledger ending (I would call this a bug).  In
  53    the below code, the condition "if (x_extent.length() >
  54    slice_x_extent.length())" avoids outputting the left ending in such
  55    cases (rather a silly workaround, but better than nothing).
  56  *
  57        (---- left ledger ending
  58      ----)   right ledger ending
  59        (-)   desired ledger line
  60      ------- resulting ledger line (too long)
  61      ----)   resulting ledger line with additional "if" (still too long)
  62  *
  63    The algorithm works properly only for a desired ledger line width
  64    greater than the width of the ledger ending:
  65  *
  66      (----    left ledger ending
  67         ----) right ledger ending
  68      (------) desired ledger line
  69      (------) resulting ledger line (ok)
  70  *
  71  * (3) The thickness of the ledger line is fixed (limitation).
  72  */
  73 Molecule create_ledger_line (Interval x_extent, Score_element *me)
  74 {
  75   Molecule line;
  76   Molecule slice = Font_interface::get_default_font (me)->find_by_name ("noteheads-ledgerending");
  77   Interval slice_x_extent = slice.extent(X_AXIS);
  78   Interval slice_y_extent = slice.extent(Y_AXIS);
  79
  80   // Create left ending of ledger line.
  81   Molecule left_ending = slice;
  82   left_ending.translate_axis (x_extent[LEFT] - slice_x_extent[LEFT], X_AXIS);
  83   if (x_extent.length() > slice_x_extent.length())
  84     line.add_molecule (left_ending);
  85
  86   // Create right ending of ledger line.
  87   Molecule right_ending = slice;
  88   right_ending.translate_axis (x_extent[RIGHT] - slice_x_extent[RIGHT],
  89                                X_AXIS);
  90   line.add_molecule (right_ending);
  91
  92   // Fill out space between left and right ending of ledger line by
  93   // lining up a series of slices in a row between them.
  94   Molecule fill_out_slice = left_ending;
  95   Real thick = slice_y_extent.length();
  96   Real delta_x = slice_x_extent.length () - thick;
  97   Real xpos = x_extent [LEFT] + 2*delta_x + thick/2; // TODO: check: thick*2?
  98   while (xpos <= x_extent[RIGHT])
  99     {
 100       fill_out_slice.translate_axis (delta_x, X_AXIS);
 101       line.add_molecule (fill_out_slice);
 102       xpos += delta_x;
 103     }
 104
 105   return line;
 106 }
 107
 108 void add_streepjes(Score_element* me,
 109                    int pos,
 110                    int interspaces,
 111                    Molecule* custos_p_)
 112 {
 113   // TODO: This is (almost) duplicated code (see
 114   // Note_head::brew_molecule).  Junk me.
 115   Real inter_f = Staff_symbol_referencer::staff_space (me)/2;
 116   int streepjes_i = abs (pos) < interspaces
 117     ? 0
 118     : (abs(pos) - interspaces) /2;
 119   if (streepjes_i)
 120     {
 121       Direction dir = (Direction)sign (pos);
 122       Molecule ledger_line (create_ledger_line (custos_p_->extent (X_AXIS),
 123                                                 me));
 124       ledger_line.set_empty (true);
 125       Real offs = (Staff_symbol_referencer::on_staffline (me))
 126         ? 0.0
 127         : -dir * inter_f;
 128       for (int i = 0; i < streepjes_i; i++)
 129         {
 130           Molecule streep (ledger_line);
 131           streep.translate_axis (-dir * inter_f * i * 2 + offs,
 132                                  Y_AXIS);
 133           custos_p_->add_molecule (streep);
 134         }
 135     }
 136 }
 137
 138 MAKE_SCHEME_CALLBACK(Custos,brew_molecule,1);
 139 SCM
 140 Custos::brew_molecule (SCM smob)
 141 {
 142   Item *me = (Item *)unsmob_element (smob);
 143   SCM scm_style = me->get_elt_property ("style");
 144
 145   if (gh_string_p (scm_style))
 146     {
 147       String style = ly_scm2string (scm_style);
 148
 149       String idx = "custodes-";
 150       int interspaces = Staff_symbol_referencer::line_count (me)-1;
 151
 152       Real pos = Staff_symbol_referencer::position_f (me);
 153
 154       if (pos > (interspaces/2 + 1)) // TODO: make this rule configurable
 155         idx += "r";
 156       idx += style;
 157       Molecule molecule
 158         = Font_interface::get_default_font (me)->find_by_name (idx);
 159       if (molecule.empty_b())
 160         {
 161           String message = "unknown custos style: `" + style + "'";
 162           warning(_ (message.ch_C()));
 163           return SCM_EOL;
 164         }
 165       else
 166         {
 167           add_streepjes(me, (int)pos, interspaces, &molecule);
 168           return  molecule.smobbed_copy();
 169         }
 170     }
 171   else
 172     return SCM_EOL;
 173 }
 174
 175 bool
 176 Custos::has_interface (Score_element*m)
 177 {
 178   return m && m->has_interface (ly_symbol2scm ("custos-interface"));
 179 }