]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/ledger-line-spanner.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / ledger-line-spanner.cc
index ab591ac4c11b7229dcdba739b31c9f3868578dce..1bca089b142d42ceb6fa631ec52381310860c5dd 100644 (file)
@@ -3,10 +3,11 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2004--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include <map>
+using namespace std;
 
 #include "item.hh"
 #include "note-head.hh"
@@ -14,7 +15,7 @@
 #include "staff-symbol.hh"
 #include "lookup.hh"
 #include "spanner.hh"
-#include "group-interface.hh"
+#include "pointer-group-interface.hh"
 #include "paper-column.hh"
 
 struct Ledger_line_spanner
@@ -48,8 +49,8 @@ Ledger_line_spanner::brew_ledger_lines (Grob *staff,
     {
       Real blotdiameter = ledgerlinethickness;
       Interval y_extent
-       = Interval (-0.5* (ledgerlinethickness),
-                   +0.5* (ledgerlinethickness));
+       = Interval (-0.5 * (ledgerlinethickness),
+                   +0.5 * (ledgerlinethickness));
       Stencil proto_ledger_line
        = Lookup::round_filled_box (Box (x_extent, y_extent), blotdiameter);
 
@@ -76,7 +77,6 @@ Ledger_line_spanner::brew_ledger_lines (Grob *staff,
   return stencil;
 }
 
-
 static void
 set_rods (Drul_array<Interval> const &current_extents,
          Drul_array<Interval> const &previous_extents,
@@ -95,7 +95,7 @@ set_rods (Drul_array<Interval> const &current_extents,
 
          Rod rod;
          rod.distance_ = total_head_length
-           * (3/2 * min_length_fraction)
+           * (3 / 2 * min_length_fraction)
            /*
              we go from right to left.
            */
@@ -106,12 +106,10 @@ set_rods (Drul_array<Interval> const &current_extents,
          rod.item_drul_[RIGHT] = previous_column;
          rod.add_to_cols ();
        }
-
     }
   while (flip (&d) != DOWN);
 }
 
-
 MAKE_SCHEME_CALLBACK (Ledger_line_spanner, set_spacing_rods, 1);
 SCM
 Ledger_line_spanner::set_spacing_rods (SCM smob)
@@ -123,47 +121,44 @@ Ledger_line_spanner::set_spacing_rods (SCM smob)
   if (!staff)
     return SCM_EOL;
 
-  SCM heads = me->get_property ("note-heads");
-
-
   Real min_length_fraction
     = robust_scm2double (me->get_property ("minimum-length-fraction"), 0.15);
 
-
   Drul_array<Interval> current_extents;
   Drul_array<Interval> previous_extents;
   Item *previous_column = 0;
   Item *current_column = 0;
 
+  int interspaces = Staff_symbol::line_count (staff) - 1;
+
   /*
-    Run through heads using a loop. Since Legder_line_spanner can
+    Run through heads using a loop. Since Ledger_line_spanner can
     contain a lot of noteheads, superlinear performance is too slow.
   */
-  int interspaces = Staff_symbol::line_count (staff) - 1;
-  for (SCM hp = heads; scm_is_pair (hp); hp = scm_cdr (hp))
+  extract_item_set (me, "note-heads", heads);
+  for (int i = heads.size (); i--;)
     {
-      Item *h = dynamic_cast<Item *> (unsmob_grob (scm_car (hp)));
-      
+      Item *h = heads[i];
+
       int pos = Staff_symbol_referencer::get_rounded_position (h);
       if (abs (pos) <= interspaces)
        continue;
-      
+
       Item *column = h->get_column ();
       if (current_column != column)
        {
          set_rods (current_extents, previous_extents,
                    current_column, previous_column,
                    min_length_fraction);
-         
+
          previous_column = current_column;
          current_column = column;
          previous_extents = current_extents;
-         
-         current_extents[DOWN].set_empty();
-         current_extents[UP].set_empty();
+
+         current_extents[DOWN].set_empty ();
+         current_extents[UP].set_empty ();
        }
-      
-      
+
       Interval head_extent = h->extent (column, X_AXIS);
       Direction vdir = Direction (sign (pos));
       if (!vdir)
@@ -177,8 +172,6 @@ Ledger_line_spanner::set_spacing_rods (SCM smob)
              current_column, previous_column,
              min_length_fraction);
 
-  
-  
   return SCM_UNSPECIFIED;
 }
 
@@ -196,19 +189,19 @@ struct Ledger_request
   }
 };
 
-typedef std::map < int, Drul_array<Ledger_request> > Ledger_requests;
+typedef map < int, Drul_array<Ledger_request> > Ledger_requests;
 
 /*
   TODO: ledger share a lot of info. Lots of room to optimize away
   common use of objects/variables.
-
 */
 MAKE_SCHEME_CALLBACK (Ledger_line_spanner, print, 1);
 SCM
 Ledger_line_spanner::print (SCM smob)
 {
   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
-  Link_array<Grob> heads (extract_grob_array (me, ly_symbol2scm ("note-heads")));
+
+  extract_grob_set (me, "note-heads", heads);
 
   if (heads.is_empty ())
     return SCM_EOL;
@@ -231,7 +224,7 @@ Ledger_line_spanner::print (SCM smob)
       Axis a = Axis (i);
       common[a] = common_refpoint_of_array (heads, me, a);
       for (int i = heads.size (); i--;)
-       if (Grob *g = unsmob_grob (me->get_property ("accidental-grob")))
+       if (Grob *g = unsmob_grob (me->get_object ("accidental-grob")))
          common[a] = common[a]->common_refpoint (g, a);
     }
 
@@ -250,12 +243,12 @@ Ledger_line_spanner::print (SCM smob)
          ledger_extent.widen (length_fraction * head_extent.length ());
 
          Direction vdir = Direction (sign (pos));
-         int rank = Paper_column::get_rank (h->get_column ());
+         int rank = h->get_column ()->get_rank ();
 
          reqs[rank][vdir].ledger_extent_.unite (ledger_extent);
          reqs[rank][vdir].head_extent_.unite (head_extent);
          reqs[rank][vdir].position_
-           = vdir * ((vdir* reqs[rank][vdir].position_) >? (vdir *pos));
+           = vdir * max (vdir * reqs[rank][vdir].position_, vdir * pos);
        }
     }
 
@@ -266,9 +259,7 @@ Ledger_line_spanner::print (SCM smob)
        i != reqs.end (); last = i++)
     {
       if (last == reqs.end ())
-       {
-         continue;
-       }
+       continue;
 
       Direction d = DOWN;
       do
@@ -283,16 +274,16 @@ Ledger_line_spanner::print (SCM smob)
              Direction which = LEFT;
              do
                {
-                 Ledger_request &lr = ((which == LEFT) ? *last : *i).second[d];
+                 Ledger_request &lr = ((which == LEFT) ? * last : *i).second[d];
 
                  // due tilt of quarter note-heads
                  bool both
                    = (abs (last->second[d].position_) > interspaces + 1
                       && abs (i->second[d].position_) > interspaces + 1);
 
-                 Real limit = (center + (both? which * gap / 2 : 0));
+                 Real limit = (center + (both ? which * gap / 2 : 0));
                  lr.ledger_extent_.elem_ref (-which)
-                   = which * (which * lr.ledger_extent_[-which] >? which * limit);
+                   = which * max (which * lr.ledger_extent_[-which], which * limit);
                }
              while (flip (&which) != LEFT);
            }
@@ -313,13 +304,13 @@ Ledger_line_spanner::print (SCM smob)
        {
          Interval head_size = h->extent (common[X_AXIS], X_AXIS);
          Interval ledger_size = head_size;
-         ledger_size.widen (ledger_size.length ()* length_fraction);
+         ledger_size.widen (ledger_size.length () * length_fraction);
 
-         Interval max_size = reqs[Paper_column::get_rank (h->get_column ())][Direction (sign (pos))].ledger_extent_;
+         Interval max_size = reqs[h->get_column ()->get_rank ()][Direction (sign (pos))].ledger_extent_;
 
          ledger_size.intersect (max_size);
          Real left_shorten = 0.0;
-         if (Grob *g = unsmob_grob (h->get_property ("accidental-grob")))
+         if (Grob *g = unsmob_grob (h->get_object ("accidental-grob")))
            {
              Interval accidental_size = g->extent (common[X_AXIS], X_AXIS);
              Real d
@@ -327,13 +318,12 @@ Ledger_line_spanner::print (SCM smob)
                                                        head_size[LEFT]),
                                      0.0);
 
-             left_shorten = (-ledger_size[LEFT] + d) >? 0;
+             left_shorten = max (-ledger_size[LEFT] + d, 0.0);
 
              /*
                TODO: shorten 2 ledger lines for the case natural +
                downstem.
              */
-
            }
 
          ledgers.add_stencil (brew_ledger_lines (staff, pos, interspaces,
@@ -352,7 +342,11 @@ Ledger_line_spanner::print (SCM smob)
 
 ADD_INTERFACE (Ledger_line_spanner,
               "ledger-line-interface",
-              "This spanner draws the ledger lines of a staff, for note heads that stick out. ",
+
+              "This spanner draws the ledger lines of a staff.\n"
+              "This is a separate grob because it has to process\n"
+              "all potential collisions between all note heads.",
+
               "note-heads thickness minimum-length-fraction length-fraction gap");
 
 struct Ledgered_interface
@@ -362,5 +356,8 @@ struct Ledgered_interface
 
 ADD_INTERFACE (Ledgered_interface,
               "ledgered-interface",
-              "Objects that need ledger lines.",
+
+              "Objects that need ledger lines, typically "
+              "note heads. See also @ref{ledger-line-interface}.",
+
               "no-ledgers");