Doc-es: various updates.

[lilypond.git] / lily / note-column.cc

diff --git a/lily/note-column.cc b/lily/note-column.cc
index d756a9121b86c4008c2b4b7235564ea20e14a5e1..b3f7e4aab9e350d22b64d3e536b69b50f8cd9f0b 100644 (file)
--- a/lily/note-column.cc
+++ b/lily/note-column.cc
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -19,7 +19,7 @@
 
 #include "note-column.hh"
 
-#include <cmath>               // ceil
+#include <cmath>                // ceil
 using namespace std;
 
 #include "accidental-placement.hh"
@@ -43,7 +43,7 @@ using namespace std;
 bool
 Note_column::has_rests (Grob *me)
 {
-  return unsmob_grob (me->get_object ("rest"));
+  return unsmob<Grob> (me->get_object ("rest"));
 }
 
 bool
@@ -61,7 +61,19 @@ Item *
 Note_column::get_stem (Grob *me)
 {
   SCM s = me->get_object ("stem");
-  return unsmob_item (s);
+  return unsmob<Item> (s);
+}
+
+Item *
+Note_column::get_flag (Grob *me)
+{
+  Item *stem = get_stem (me);
+  if (stem)
+    {
+      SCM s = stem->get_object ("flag");
+      return unsmob<Item> (s);
+    }
+  return 0;
 }
 
 Slice
@@ -85,17 +97,20 @@ Note_column::head_positions_interval (Grob *me)
 Direction
 Note_column::dir (Grob *me)
 {
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
-  if (stem && Stem::has_interface (stem))
+  Grob *stem = unsmob<Grob> (me->get_object ("stem"));
+  if (has_interface<Stem> (stem))
     return get_grob_direction (stem);
   else
     {
       extract_grob_set (me, "note-heads", heads);
       if (heads.size ())
-       return (Direction)sign (head_positions_interval (me).center ());
+        return (Direction)sign (head_positions_interval (me).center ());
     }
 
-  programming_error ("note column without heads and stem");
+  if (has_interface<Note_column> (me))
+    programming_error ("Note_column without heads and stem");
+  else
+    programming_error ("dir() given grob without Note_column interface");
   return CENTER;
 }
 
@@ -109,25 +124,25 @@ Note_column::set_stem (Grob *me, Grob *stem)
 Grob *
 Note_column::get_rest (Grob *me)
 {
-  return unsmob_grob (me->get_object ("rest"));
+  return unsmob<Grob> (me->get_object ("rest"));
 }
 
 void
 Note_column::add_head (Grob *me, Grob *h)
 {
   bool both = false;
-  if (Rest::has_interface (h))
+  if (has_interface<Rest> (h))
     {
       extract_grob_set (me, "note-heads", heads);
       if (heads.size ())
-       both = true;
+        both = true;
       else
-       me->set_object ("rest", h->self_scm ());
+        me->set_object ("rest", h->self_scm ());
     }
-  else if (Note_head::has_interface (h))
+  else if (has_interface<Note_head> (h))
     {
-      if (unsmob_grob (me->get_object ("rest")))
-       both = true;
+      if (unsmob<Grob> (me->get_object ("rest")))
+        both = true;
       Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), h);
     }
 
@@ -144,6 +159,33 @@ Note_column::first_head (Grob *me)
   return st ? Stem::first_head (st) : 0;
 }
 
+/*
+  Return extent of the noteheads in the "main column",
+  (i.e. excluding any suspended noteheads), or extent
+  of the rest (if there are no heads).
+*/
+Interval
+Note_column::calc_main_extent (Grob *me)
+{
+    Grob *main_head = 0;
+    if (get_stem (me))
+        main_head = first_head (me);
+    else
+      {
+        // no stems => no suspended noteheads.
+        extract_grob_set (me, "note-heads", heads);
+        if (heads.size())
+        main_head = heads[0];
+      }
+    Grob *main_item = main_head
+            ? main_head
+            : unsmob<Grob> (me->get_object ("rest"));
+
+    return main_item
+            ? main_item->extent (me, X_AXIS)
+            : Interval (0, 0);
+}
+
 /*
   Return the first AccidentalPlacement grob that we find in a note-head.
 */
@@ -155,15 +197,15 @@ Note_column::accidentals (Grob *me)
   for (vsize i = 0; i < heads.size (); i++)
     {
       Grob *h = heads[i];
-      acc = h ? unsmob_grob (h->get_object ("accidental-grob")) : 0;
+      acc = h ? unsmob<Grob> (h->get_object ("accidental-grob")) : 0;
       if (acc)
-       break;
+        break;
     }
 
   if (!acc)
     return 0;
 
-  if (Accidental_placement::has_interface (acc->get_parent (X_AXIS)))
+  if (has_interface<Accidental_placement> (acc->get_parent (X_AXIS)))
     return acc->get_parent (X_AXIS);
 
   /* compatibility. */
@@ -176,20 +218,14 @@ Note_column::dot_column (Grob *me)
   extract_grob_set (me, "note-heads", heads);
   for (vsize i = 0; i < heads.size (); i++)
     {
-      Grob *dots = unsmob_grob (heads[i]->get_object ("dot"));
+      Grob *dots = unsmob<Grob> (heads[i]->get_object ("dot"));
       if (dots)
-       return dots->get_parent (X_AXIS);
+        return dots->get_parent (X_AXIS);
     }
 
   return 0;
 }
 
-Grob *
-Note_column::arpeggio (Grob *me)
-{
-  return unsmob_grob (me->get_object ("arpeggio"));
-}
-
 /* If a note-column contains a cross-staff stem then
    nc->extent (Y_AXIS, refp) will not consider the extent of the stem.
    If you want the extent of the stem to be included (and you are safe
@@ -205,15 +241,15 @@ Note_column::cross_staff_extent (Grob *me, Grob *refp)
 }
 
 ADD_INTERFACE (Note_column,
-              "Stem and noteheads combined.",
-
-              /* properties */
-              "arpeggio "
-              "force-hshift "
-              "horizontal-shift "
-              "ignore-collision "
-              "note-heads "
-              "rest "
-              "rest-collision "
-              "stem "
-              );
+               "Stem and noteheads combined.",
+
+               /* properties */
+               "force-hshift "
+               "horizontal-shift "
+               "ignore-collision "
+               "note-heads "
+               "rest "
+               "rest-collision "
+               "stem "
+               "glissando-skip "
+              );