lily/coherent-ligature-engraver.cc

   1 /*
   2   coherent-ligature-engraver.cc -- implement Coherent_ligature_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  2003 Juergen Reuter <reuter@ipd.uka.de>
   7  */
   8
   9 #include "coherent-ligature-engraver.hh"
  10 #include "item.hh"
  11 #include "warn.hh"
  12 #include "staff-symbol-referencer.hh"
  13 #include "spanner.hh"
  14 #include "paper-column.hh"
  15
  16 /*
  17  * This abstract class serves as common superclass for all ligature
  18  * engravers thet produce a single connected graphical object of fixed
  19  * width, consisting of noteheads and other primitives (see class
  20  * Ligature_engraver for more information on the interaction between
  21  * this class and its superclass).  In particular, it cares for the
  22  * following tasks:
  23  *
  24  * - provide a function for putting all grobs of the ligature into a
  25  * single paper column,
  26  *
  27  * - delegate actual creation of ligature to concrete subclass,
  28  *
  29  * - collect all accidentals that occur within the ligature and put
  30  * them at the left side of the ligature (TODO; see function
  31  * collect_accidentals()),
  32  *
  33  * - collapse superflous space after each ligature (TODO).
  34  *
  35  * Concrete subclasses must implement function build_ligature (Spanner
  36  * *, Array<Grob_info>).  This function is responsible for actually
  37  * building the ligature by transforming the array of noteheads.
  38  *
  39  * Currently, there are two subclasses: Gregorian_ligature_engraver
  40  * for Gregorian chant notation (also known as plain song or cantus
  41  * planus) and Mensural_ligature_engraver for white mensural notation.
  42  * Subclasses for other music notation styles such as modal notation
  43  * or ars nova notation may eventually be added.
  44  */
  45
  46 /*
  47  * TODO: local accidentals: collect accidentals that occur within a
  48  * ligature and put them before the ligature.  If an accidental
  49  * changes within a ligature, print a warning (user error) and ignore
  50  * any further accidental for that pitch within that ligature
  51  * (actually, in such a case, the user should split the ligature into
  52  * two separate ligatures).  Similarly, any object that, in ordinary
  53  * notation, may be put to the left or to the right of a
  54  * note-head/ligature-head, should be collected and put before or
  55  * after the ligature.
  56  *
  57  * TODO: make spacing more robust: do not screw up spacing if user
  58  * erroneously puts rest in ligature.
  59  *
  60  * TODO: for each ligature, add Rod that represents the total length
  61  * of the ligature (to preemptively avoid collision with adjacent
  62  * notes); or maybe just additionally create a
  63  * mensural/vaticana/whatever-ligature grob (e.g. via
  64  * Mensural_ligature::brew_molecule(SCM)) that just consists of a
  65  * bounding box around all primitives of the ligature.
  66  *
  67  * TODO: Maybe move functions fold_up_primitives() and
  68  * join_primitives() from subclasses to here?  N.B. it is not
  69  * appropriate to put these into Ligature_engraver, since, for
  70  * example, Ligature_bracket_engraver does not share any of this code.
  71  */
  72
  73 /*
  74  * TODO: Let superflous space after each ligature collapse.  The
  75  * following code should help in doing so (though it does not yet
  76  * fully work).  Just put the following code into
  77  * Spacing_spanner::do_measure().  I put it temporarily here as memo
  78  * until it really works and I also get Han-Wen's/Jan's permission to
  79  * add it to the spacing spanner code.
  80  */
  81 #if 0 // experimental code to collapse spacing after ligature
  82       SCM incr_scm = lc->get_grob_property ("forced-spacing");
  83       if (incr_scm != SCM_EOL) /* (Paper_column::musical_b (l)) */
  84         {
  85           me->warning (_f ("gotcha: ptr=%ul", lc));//debug
  86           ly_display_scm (lc->self_scm ());
  87           Real distance;
  88           if (incr_scm != SCM_EOL)
  89             {
  90               distance = gh_scm2double (incr_scm);
  91             }
  92           else
  93             {
  94               me->warning ("distance undefined, assuming 0.1");
  95               distance = 0.1;
  96             }
  97           me->warning (_f ("distance=%f", distance));//debug
  98           Real strength = 1.0;
  99           Spaceable_grob::add_spring (lc, rc, distance, strength, false);
 100           if (Item *rb = r->find_prebroken_piece (LEFT))
 101             Spaceable_grob::add_spring (lc, rb, distance, strength, false);
 102
 103           continue;
 104         }
 105 #endif
 106
 107 Coherent_ligature_engraver::Coherent_ligature_engraver ()
 108 {
 109 }
 110
 111 /*
 112  * TODO: move this function to class Item?
 113  */
 114 void
 115 Coherent_ligature_engraver::get_set_column (Item *item, Paper_column *column)
 116 {
 117   Item *parent = dynamic_cast<Item*> (item->get_parent (X_AXIS));
 118   if (!parent)
 119     {
 120       programming_error ("failed tweaking paper column in ligature");
 121       return;
 122     }
 123
 124   String name = parent->name ();
 125   if (!String::compare (name, "PaperColumn"))
 126     {
 127       // Change column not only for targeted item (NoteColumn), but
 128       // also for all associated grobs (NoteSpacing, SeparationItem).
 129       Grob *sl = Staff_symbol_referencer::get_staff_symbol (item);
 130       for (SCM tail = parent->get_grob_property ("elements");
 131            gh_pair_p (tail);
 132            tail = ly_cdr (tail))
 133         {
 134           Item *sibling = unsmob_item (ly_car (tail));
 135           if ((sibling) &&
 136               (Staff_symbol_referencer::get_staff_symbol (sibling) == sl))
 137             {
 138 #if 0 // experimental code to collapse spacing after ligature
 139               Grob *sibling_parent = sibling->get_parent (X_AXIS);
 140               sibling_parent->warning (_f ("Coherent_ligature_engraver: "
 141                                            "setting `spacing-increment = "
 142                                            "0.01': ptr=%ul", parent));
 143               sibling_parent->set_grob_property("forced-spacing",
 144                                               gh_double2scm (0.01));
 145 #endif
 146               sibling->set_parent (column, X_AXIS);
 147             }
 148         }
 149     }
 150   else
 151     {
 152       get_set_column (parent, column);
 153     }
 154 }
 155
 156 /*
 157  * TODO: This function should collect all accidentals that occur
 158  * within the ligature (by scanning through the primitives array) and
 159  * place all of them at the left of the ligature.  If there is an
 160  * alteration within the ligature (e.g. an "f" followed by a "fis"
 161  * somewhere later in the ligature), issue a warning (and maybe create
 162  * an additional natural symbol to explicitly make clear that there is
 163  * an "f" first?).  The warning should suggest the user to break the
 164  * ligature into two or more smaller ligatures such that no alteration
 165  * occurs within the broken ligatures any more.
 166  */
 167 void
 168 Coherent_ligature_engraver::collect_accidentals (Spanner *, Array<Grob_info>)
 169 {
 170   /* TODO */
 171 }
 172
 173 void
 174 Coherent_ligature_engraver::build_ligature (Spanner *, Array<Grob_info>)
 175 {
 176   programming_error ("Cohrent_ligature_engraver::build_ligature (): "
 177                      "this is an abstract method that should not be called, "
 178                      "but overridden by a subclass");
 179 }
 180
 181 void
 182 Coherent_ligature_engraver::typeset_ligature (Spanner *ligature,
 183                                               Array<Grob_info> primitives)
 184 {
 185   // prepare ligature for typesetting
 186   build_ligature (ligature, primitives);
 187   collect_accidentals (ligature, primitives);
 188
 189   // now actually typeset
 190   for (int i = 0; i < primitives.size (); i++)
 191     {
 192       typeset_grob (primitives[i].grob_);
 193     }
 194 }
 195
 196 ENTER_DESCRIPTION (Coherent_ligature_engraver,
 197 /* descr */       "This is an abstract class.  Subclasses such as Gregorian_ligature_engraver handle ligatures by glueing special ligature heads together.",
 198 /* creats*/       "",
 199 /* accepts */     "ligature-event abort-event",
 200 /* acks  */      "ligature-head-interface note-head-interface rest-interface",
 201 /* reads */       "",
 202 /* write */       "");