]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/paper-column.cc
Merge branch 'master' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / paper-column.cc
index 5373d06f341796d28e7d4d29265da292361d207c..4dba6bbbd58f08784b55e5cbef2e38e96edc8355 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "moment.hh"
 #include "paper-column.hh"
+
+#include "moment.hh"
 #include "paper-score.hh"
 #include "warn.hh"
 #include "axis-group-interface.hh"
 #include "spaceable-grob.hh"
-#include "molecule.hh"
-#include "text-item.hh"
+#include "text-interface.hh"
 #include "lookup.hh"
 #include "font-interface.hh"
+#include "output-def.hh"
+#include "pointer-group-interface.hh"
+#include "grob-array.hh"
+#include "system.hh"
+#include "spring.hh"
+#include "lookup.hh"
+#include "string-convert.hh"
 
-
-
-
-
-ADD_INTERFACE (Paper_column, "paper-column-interface",
-  "  Paper_columns form the top-most item parent. (The Paper_columns X
-  parent is System, which is a spanner.)
-
-  Paper_columns form the units for the spacing engine. They are
-  numbered, the first (leftmost) is column 0. Numbering happens before
-  line-breaking, and columns are not renumbered after line breaking.
-
-  Since many columns go unused, you should only use the rank field to
-  get ordering information.  Two adjacent columns may have
-  non-adjacent numbers.
-
-  Don't be confused by right-items: each spacing wish can also contain
-  a number of items, with which a spacing constraint may be kept. It's
-  a little baroque, but it might come in handy later on?
-
-",
-  "between-cols between-system-string when bounded-by-me shortest-playing-duration shortest-starter-duration");
-
+Grob *
+Paper_column::clone () const
+{
+  return new Paper_column (*this);
+}
 
 void
 Paper_column::do_break_processing ()
 {
-  Spaceable_grob::remove_interface (this);
   Item::do_break_processing ();
 }
 
-
 int
-Paper_column::get_rank (Grob*me) 
+Paper_column::get_rank (Grob const *me)
 {
-  return dynamic_cast<Paper_column*> (me)->rank_;
+  return dynamic_cast<Paper_column const *> (me)->rank_;
 }
 
-System*
+System *
 Paper_column::get_system () const
 {
   return system_;
 }
 
-Paper_column*
+void
+Paper_column::set_system (System *s)
+{
+  system_ = s;
+}
+
+Paper_column *
 Paper_column::get_column () const
 {
-  return (Paper_column*) (this);
+  return (Paper_column *) (this);
 }
 
 Paper_column::Paper_column (SCM l)
-  : Item (l)           // guh.?
+  : Item (l)
 {
-  system_=0;
+  system_ = 0;
   rank_ = -1;
 }
 
+Paper_column::Paper_column (Paper_column const &src)
+  : Item (src)
+{
+  system_ = 0;
+  rank_ = src.rank_;
+}
+
+int
+Paper_column::compare (Grob * const &a,
+                      Grob * const &b)
+{
+  return sign (dynamic_cast<Paper_column*> (a)->rank_
+              - dynamic_cast<Paper_column*> (b)->rank_);
+}
+
+bool
+Paper_column::less_than (Grob *const &a,
+                        Grob *const &b)
+{
+  Paper_column *pa = dynamic_cast<Paper_column*> (a);
+  Paper_column *pb = dynamic_cast<Paper_column*> (b);
+  
+  return pa->rank_ < pb->rank_;
+}
+
 Moment
-Paper_column::when_mom (Grob*me)
+Paper_column::when_mom (Grob *me)
 {
-  SCM m = me->get_grob_property ("when");
-  Moment s (0);
-  if (unsmob_moment (m))
-    {
-      return *unsmob_moment (m);
-    }
-  return s;
+  SCM m = me->get_property ("when");
+  if (Moment *when = unsmob_moment (m))
+    return *when;
+  return Moment (0);
 }
 
 bool
-Paper_column::musical_b (Grob *me)
+Paper_column::is_musical (Grob *me)
 {
-  SCM m = me->get_grob_property ("shortest-starter-duration");
+  SCM m = me->get_property ("shortest-starter-duration");
   Moment s (0);
   if (unsmob_moment (m))
-    {
-      s = *unsmob_moment (m);
-    }
+    s = *unsmob_moment (m);
   return s != Moment (0);
-  
 }
+
+bool
+Paper_column::is_used (Grob *me)
+{
+  extract_grob_set (me, "elements", elts);
+  if (elts.size ())
+    return true;
+
+  extract_grob_set (me, "bounded-by-me", bbm);
+  if (bbm.size ())
+    return true;
   
+  if (Paper_column::is_breakable (me))
+    return true;
+
+  if (to_boolean (me->get_property ("used")))
+    return true;
+  return false;
+}
 
 bool
-Paper_column::used_b (Grob*me)
+Paper_column::is_breakable (Grob *me)
 {
-  return gh_pair_p (me->get_grob_property ("elements")) ||  Item::breakable_b (me)
-    || gh_pair_p (me->get_grob_property ("bounded-by-me"))
-    ;
+  return scm_is_symbol (me->get_property ("line-break-permission"));
 }
 
 /*
-  Print a vertical line and  the rank number, to aid debugging.  
- */
-
-MAKE_SCHEME_CALLBACK(Paper_column,brew_molecule,1);
+  Print a vertical line and  the rank number, to aid debugging.
+*/
+MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
 SCM
-Paper_column::brew_molecule (SCM p)
+Paper_column::print (SCM p)
 {
-  Grob *me = unsmob_grob (p);
+  Paper_column *me = dynamic_cast<Paper_column*> (unsmob_grob (p));
 
-  String r = to_string (Paper_column::get_rank (me));
-  SCM properties = Font_interface::font_alist_chain (me);
-  
-  Molecule t = Text_item::text2molecule (me, ly_str02scm (r.to_str0 ()),
-                                        properties);
+  string r = to_string (Paper_column::get_rank (me));
+
+  Moment *mom = unsmob_moment (me->get_property ("when"));
+  string when = mom ? mom->to_string () : "?/?";
+
+  Font_metric *musfont = Font_interface::get_default_font (me);
+  SCM properties = Font_interface::text_font_alist_chain (me);
+
+  SCM scm_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
+                                                 properties,
+                                                 ly_string2scm (r));
+  SCM when_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
+                                                  properties,
+                                                  ly_string2scm (when));
+  Stencil t = *unsmob_stencil (scm_mol);
+  t.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (when_mol), 0.1);
   t.align_to (X_AXIS, CENTER);
   t.align_to (Y_AXIS, DOWN);
-  
-  Molecule l = Lookup::filledbox (Box (Interval (-0.01, 0.01),
-                                      Interval (-2, -1)));
 
-  t.add_molecule (l);
-  return t.smobbed_copy ();                                            
+  Stencil l = Lookup::filled_box (Box (Interval (-0.01, 0.01),
+                                      Interval (-2, -1)));
+  
+  SCM small_letters = scm_cons (scm_acons (ly_symbol2scm ("font-size"),
+                                          scm_from_int (-6), SCM_EOL),
+                               properties);
+  
+  int j = 0;
+  for (SCM s = me->get_object ("ideal-distances");
+       scm_is_pair (s); s = scm_cdr (s))
+    {
+      Spring_smob *sp = unsmob_spring (scm_car (s));
+      if (!sp->other_->get_system ())
+       continue;
+      
+      j++;
+      Real y = -j * 1 -3;
+      vector<Offset> pts;
+      pts.push_back (Offset (0, y));
+
+      Offset p2 (sp->distance_, y);
+      pts.push_back (p2);
+      
+      Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
+      Stencil head (musfont->find_by_name ("arrowheads.open.01"));
+
+      SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
+                                                          small_letters,
+                                                          ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance_)));
+      
+      id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (sp->distance_/3, y+1)));
+      id_stencil.add_stencil (head.translated (p2));
+      id_stencil = id_stencil.in_color (0,0,1);
+      l.add_stencil (id_stencil);
+    }
+   
+  for (SCM s = me->get_object ("minimum-distances");
+       scm_is_pair (s); s = scm_cdr (s))
+    {
+      Real dist = scm_to_double (scm_cdar (s));
+      Grob *other =  unsmob_grob (scm_caar (s));
+      if (!other || other->get_system () != me->get_system ())
+       continue;
+
+      j++;
+      
+      Real y = -j * 1.0 -3.5;
+      vector<Offset> pts;
+      pts.push_back (Offset (0, y));
+
+      Offset p2 (dist, y);
+      pts.push_back (p2);
+
+      Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
+      Stencil head (musfont->find_by_name ("arrowheads.open.0M1"));
+      head.translate_axis (y, Y_AXIS);
+      id_stencil.add_stencil (head);
+
+      SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
+                                                          small_letters,
+                                                          ly_string2scm (String_convert::form_string ("%5.2lf",
+                                                                                                      dist)));
+          
+      id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (dist/3, y-1)));
+       
+      id_stencil = id_stencil.in_color (1,0,0);
+      l.add_stencil (id_stencil);
+    }
+  t.add_stencil (l);
+  return t.smobbed_copy ();
 }
 
 /*
   This is all too hairy. We use bounded-by-me to make sure that some
   columns are kept "alive". Unfortunately, when spanners are suicided,
-  this falls apart again. (sigh.)
+  this falls apart again, because suicided spanners are still in
+  bounded-by-me
 
-  THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER. 
- */
-MAKE_SCHEME_CALLBACK(Paper_column,before_line_breaking,1);
+  THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER.
+*/
+MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1);
 SCM
 Paper_column::before_line_breaking (SCM grob)
 {
   Grob *me = unsmob_grob (grob);
 
-  SCM c = me->get_grob_property ("bounded-by-me");
-  SCM *ptrptr = &c;
+  SCM bbm = me->get_object ("bounded-by-me");
+  Grob_array *ga = unsmob_grob_array (bbm);
+  if (!ga)
+    return SCM_UNSPECIFIED;
+
+  vector<Grob*> &array (ga->array_reference ());
 
-  while (gh_pair_p (*ptrptr))
+  for (vsize i = array.size (); i--;)
     {
-      Grob * g = unsmob_grob (gh_car (*ptrptr));
-
-      if (!g || !g->live ())
-       {
-         *ptrptr = gh_cdr (*ptrptr);
-       }
-      else
-       {
-         ptrptr = SCM_CDRLOC (*ptrptr);
-       }
+      Grob *g = array[i];
+
+      if (!g || !g->is_live ())
+       /* UGH . potentially quadratic. */
+       array.erase (array.begin () + i);
     }
 
-  me->set_grob_property ("bounded-by-me", c);
   return SCM_UNSPECIFIED;
 }
+
+
+ADD_INTERFACE (Paper_column,
+              "@code{Paper_column} objects form the top-most X-parents for items."
+              "  The are two types of columns: musical columns, where are attached to, and "
+              "  non-musical columns, where bar-lines, clefs etc. are attached to. "
+              "  The spacing engine determines the X-positions of these objects."
+              
+              "\n\n"
+              "They are\n"
+              "  numbered, the first (leftmost) is column 0. Numbering happens before\n"
+              "  line-breaking, and columns are not renumbered after line breaking.\n"
+              "  Since many columns go unused, you should only use the rank field to\n"
+              "  get ordering information.  Two adjacent columns may have\n"
+              "  non-adjacent numbers.\n",
+              
+
+              /* properties */
+              "between-cols "
+              "bounded-by-me "
+              "grace-spacing " 
+              "line-break-system-details "
+              "line-break-penalty "
+              "line-break-permission "
+              "page-break-penalty "
+              "page-break-permission "
+              "page-turn-penalty "
+              "page-turn-permission "
+              "rhythmic-location "
+              "shortest-playing-duration "
+              "shortest-starter-duration "
+              "spacing "
+              "used "
+              "when ");
+