]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/item.cc
Run `make grand-replace'.
[lilypond.git] / lily / item.cc
index e94b5bc26762862fd4e38a8a4406bfc5c590b690..fc8028e7e42d9f17ed87fa931551b77f0dca6525 100644 (file)
@@ -3,51 +3,53 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "item.hh"
 
+#include "axis-group-interface.hh"
 #include "paper-score.hh"
 #include "warn.hh"
 #include "paper-column.hh"
 #include "lily-guile.hh"
 #include "system.hh"
-#include "group-interface.hh"
+#include "pointer-group-interface.hh"
+
+#include "moment.hh"
+
 
 Grob *
-Item::clone (int count) const
+Item::clone () const
 {
-  return new Item (*this, count);
+  return new Item (*this);
 }
 
-Item::Item (SCM s, Object_key const *key)
-  : Grob (s, key)
+Item::Item (SCM s)
+  : Grob (s)
 {
-  broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]= 0;
-  Group_interface::add_thing (this, ly_symbol2scm ("interfaces"), ly_symbol2scm ("item-interface"));
+  broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
+  cached_pure_height_valid_ = false;
 }
 
 /**
    Item copy ctor.  Copy nothing: everything should be a elt property
    or a special purpose pointer (such as broken_to_drul_[]) */
-Item::Item (Item const &s, int copy_count)
-  : Grob (s, copy_count)
+Item::Item (Item const &s)
+  : Grob (s)
 {
   broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
+  cached_pure_height_valid_ = false;
 }
 
 bool
-Item::is_breakable (Grob *me)
+Item::is_non_musical (Grob *me)
 {
-  if (me->original_)
+  if (me->original ())
     return false;
 
-  if (!dynamic_cast<Item *> (me))
-    me->programming_error ("only items can be breakable.");
-
   Item *i = dynamic_cast<Item *> (me->get_parent (X_AXIS));
-  return (i) ? Item::is_breakable (i) : to_boolean (me->get_property ("breakable"));
+  return i ? Item::is_non_musical (i) : to_boolean (me->get_property ("non-musical"));
 }
 
 Paper_column *
@@ -69,15 +71,15 @@ Item::copy_breakable_items ()
 {
   Drul_array<Item *> new_copies;
   Direction i = LEFT;
-  int count = 0;
   do
     {
-      Grob *dolly = clone (count++);
+      Grob *dolly = clone ();
       Item *item = dynamic_cast<Item *> (dolly);
-      pscore_->system_->typeset_grob (item);
+      get_root_system (this)->typeset_grob (item);
       new_copies[i] = item;
     }
   while (flip (&i) != LEFT);
+
   broken_to_drul_ = new_copies;
 }
 
@@ -96,7 +98,7 @@ Item::discretionary_processing ()
   if (is_broken ())
     return;
 
-  if (Item::is_breakable (this))
+  if (Item::is_non_musical (this))
     copy_breakable_items ();
 }
 
@@ -130,9 +132,9 @@ Item::find_prebroken_piece (Direction d) const
 Direction
 Item::break_status_dir () const
 {
-  if (original_)
+  if (original ())
     {
-      Item *i = dynamic_cast<Item *> (original_);
+      Item *i = dynamic_cast<Item *> (original ());
 
       return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
     }
@@ -148,40 +150,79 @@ Item::handle_prebroken_dependencies ()
   /*
     Can't do this earlier, because try_visibility_lambda () might set
     the elt property transparent, which would then be copied.
+  */
+  if (!Item::break_visible (this))
+    suicide ();
+}
 
-    TODO:
+bool
+Item::break_visible (Grob *g)
+{
+  Item *it = dynamic_cast<Item*> (g);
+  SCM vis = g->get_property ("break-visibility");
+  if (scm_is_vector (vis))
+    return to_boolean (scm_c_vector_ref (vis, it->break_status_dir () + 1));
+  return true;
+}
 
-    give the item to break-visibility itself, so the function can do
-    more complicated things.
-  */
+bool
+Item::pure_is_visible (int start, int end) const
+{
   SCM vis = get_property ("break-visibility");
-  if (ly_c_procedure_p (vis))
+  if (scm_is_vector (vis))
+    {
+      int pos = 1;
+      int pc_rank = Paper_column::get_rank (get_column ());
+      if (pc_rank == start)
+       pos = 2;
+      else if (pc_rank == end)
+       pos = 0;
+      return to_boolean (scm_vector_ref (vis, scm_from_int (pos)));
+    }
+  return true;
+}
+
+Interval_t<int>
+Item::spanned_rank_interval () const
+{
+  int c = get_column ()->get_rank ();
+  return Interval_t<int> (c, c);
+}
+
+Interval_t<Moment>
+spanned_time_interval (Item *l, Item *r) 
+{
+  Drul_array<Item*> bounds (l, r);
+  Interval_t<Moment> iv;
+
+  Direction d = LEFT;
+  do
     {
-      SCM args = scm_list_n (scm_int2num (break_status_dir ()), SCM_UNDEFINED);
-      SCM result = scm_apply_0 (vis, args);
-      bool trans = ly_scm2bool (scm_car (result));
-      bool empty = ly_scm2bool (scm_cdr (result));
-
-      if (empty && trans)
-       suicide ();
-      else if (empty)
-       {
-         set_extent (SCM_EOL, X_AXIS);
-         set_extent (SCM_EOL, Y_AXIS);
-       }
-      else if (trans)
-       set_property ("print-function", SCM_EOL);
+      if (bounds[d] && bounds[d]->get_column ())
+       iv[d] = robust_scm2moment (bounds[d]->get_column ()->get_property ("when"),
+                                 iv[d]);
     }
+  while (flip (&d) != LEFT);
+
+  do
+    {
+      if (!bounds[d] || !bounds[d]->get_column ())
+       iv[d] = iv[-d];
+    }
+  while (flip (&d) != LEFT);
+  
+  
+  return iv;
 }
 
-SCM
-Item::do_derived_mark () const
+
+void
+Item::derived_mark () const
 {
   if (broken_to_drul_[LEFT])
     scm_gc_mark (broken_to_drul_[LEFT]->self_scm ());
   if (broken_to_drul_[RIGHT])
     scm_gc_mark (broken_to_drul_[RIGHT]->self_scm ());
-  return SCM_EOL;
 }
 
 Item *
@@ -190,31 +231,49 @@ unsmob_item (SCM s)
   return dynamic_cast<Item *> (unsmob_grob (s));
 }
 
+Interval
+Item::pure_height (Grob *g, int start, int end)
+{
+  if (cached_pure_height_valid_)
+    return cached_pure_height_ + pure_relative_y_coordinate (g, start, end);
+
+  cached_pure_height_ = Grob::pure_height (this, start, end);
+  cached_pure_height_valid_ = true;
+  return cached_pure_height_ + pure_relative_y_coordinate (g, start, end);
+}
+
+bool
+Item::less (Grob * const &g1, Grob * const &g2)
+{
+  return dynamic_cast<Item*> (g1)->get_column ()->get_rank () < dynamic_cast<Item*> (g2)->get_column ()->get_rank ();
+}
+
 ADD_INTERFACE (Item,
-              "item-interface",
-              "\n"
-              "\n"
-              "Grobs can be distinguished in their role in the horizontal spacing.\n"
-              "Many grobs define constraints on the spacing by their sizes. For\n"
-              "example, note heads, clefs, stems, and all other symbols with a fixed\n"
-              "shape.  These grobs form a subtype called @code{Item}.\n"
+              "Grobs can be distinguished in their role in the horizontal"
+              " spacing.  Many grobs define constraints on the spacing by"
+              " their sizes, for example, note heads, clefs, stems, and all"
+              " other symbols with a fixed shape.  These grobs form a"
+              " subtype called @code{Item}.\n"
               "\n"
+              "Some items need special treatment for line breaking.  For"
+              " example, a clef is normally only printed at the start of a"
+              " line (i.e., after a line break).   To model this,"
+              " @q{breakable} items (clef, key signature, bar lines, etc.)"
+              " are copied twice.  Then we have three versions of each"
+              " breakable item: one version if there is no line break, one"
+              " version that is printed before the line break (at the end of"
+              " a system), and one version that is printed after the line"
+              " break.\n"
               "\n"
-              "Some items need special treatment for line breaking. For example, a\n"
-              "clef is normally only printed at the start of a line (i.e. after a\n"
-              "line break).  To model this, `breakable' items (clef, key signature,\n"
-              "bar lines, etc.) are copied twice. Then we have three versions of each\n"
-              "breakable item: one version if there is no line break, one version\n"
-              "that is printed before the line break (at the end of a system), one\n"
-              "version that is printed after the line break.\n"
+              "Whether these versions are visible and take up space is"
+              " determined by the outcome of the @code{break-visibility}"
+              " grob property, which is a function taking a direction"
+              " (@code{-1}, @code{0} or@tie{}@code{1}) as an argument.  It"
+              " returns a cons of booleans, signifying whether this grob"
+              " should be transparent and have no extent.\n"
               "\n"
-              "Whether these versions are visible and take up space, is determined by\n"
-              "the outcome of the @code{break-visibility}. This grob property is a\n"
-              "function taking a direction (-1, 0 or 1) as argument. It returns a\n"
-              "cons of booleans, signifying whether this grob should be transparent\n"
-              "and have no extent.\n"
-              "\n"
-              "The following variables for break-visibility are predefined:\n"
+              "The following variables for @code{break-visibility} are"
+              " predefined:\n"
               "@example\n"
               "           grob will show:   before  no     after\n"
               "                             break   break  break\n"
@@ -224,5 +283,12 @@ ADD_INTERFACE (Item,
               "  all-visible                yes     yes    yes\n"
               "  begin-of-line-invisible    yes     yes    no\n"
               "  end-of-line-invisible      no      yes    yes\n"
-              "@end example\n",
-              "no-spacing-rods break-visibility breakable")
+              "  center-invisible           yes      no    yes\n"
+              "@end example",
+
+              /* properties */
+              "break-visibility "
+              "extra-spacing-height "
+              "extra-spacing-width "
+              "non-musical "
+              );