]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob.cc
($(outdir)/%.pdf): add DVIPS_FLAGS. This will
[lilypond.git] / lily / grob.cc
index 61f48a6aff5f00609a431372a3c5c603495ed8d3..d44f3ce7c53aab0665404436af76107d698e7b4e 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
 #include "group-interface.hh"
 #include "misc.hh"
 #include "paper-score.hh"
-#include "molecule.hh"
+#include "stencil.hh"
 #include "grob.hh"
 #include "warn.hh"
 #include "spanner.hh"
 #include "system.hh"
 #include "item.hh"
-#include "molecule.hh"
+#include "stencil.hh"
 #include "misc.hh"
 #include "music.hh"
 #include "item.hh"
@@ -45,7 +45,7 @@ Grob::Grob (SCM basicprops)
   /*
     fixme: default should be no callback.
    */
-
+  self_scm_ = SCM_EOL;
   pscore_=0;
   status_ = 0;
   original_ = 0;
@@ -86,6 +86,7 @@ Grob::Grob (SCM basicprops)
     eg. when using \override with StaffSymbol.  */
   
   char const*onames[] = {"X-offset-callbacks", "Y-offset-callbacks"};
+  char const*xnames[] = {"X-extent", "Y-extent"};
   char const*enames[] = {"X-extent-callback", "Y-extent-callback"};
   
   for (int a = X_AXIS; a <= Y_AXIS; a++)
@@ -103,15 +104,17 @@ Grob::Grob (SCM basicprops)
        }
 
       SCM cb = get_grob_property (enames[a]);
-
+      SCM xt = get_grob_property (xnames[a]);
+      
       /*
-       Should change default to be empty? 
+       Should change default to empty? 
       */
-      if (cb != SCM_BOOL_F
+      if (is_number_pair (xt))
+       cb = xt;
+      else if (cb != SCM_BOOL_F
          && !gh_procedure_p (cb) && !gh_pair_p (cb)
-         && gh_procedure_p (get_grob_property ("molecule-callback"))
-         )
-       cb = molecule_extent_proc;
+         && gh_procedure_p (get_grob_property ("print-function")))
+       cb = stencil_extent_proc;
     
       dim_cache_[a].dimension_ = cb;
     }
@@ -122,8 +125,9 @@ Grob::Grob (Grob const&s)
    : dim_cache_ (s.dim_cache_)
 {
   original_ = (Grob*) &s;
-  immutable_property_alist_ = s.immutable_property_alist_;
+  self_scm_ = SCM_EOL;
 
+  immutable_property_alist_ = s.immutable_property_alist_;
   mutable_property_alist_ = SCM_EOL;
   
   /*
@@ -131,7 +135,7 @@ Grob::Grob (Grob const&s)
    */
   
   status_ = s.status_;
-  pscore_ = s.pscore_;
+  pscore_ = 0;
 
   smobify_self ();
 
@@ -148,46 +152,20 @@ Grob::~Grob ()
 }
 
 
-
-
-
-MAKE_SCHEME_CALLBACK (Grob,molecule_extent,2);
+MAKE_SCHEME_CALLBACK (Grob,stencil_extent,2);
 SCM
-Grob::molecule_extent (SCM element_smob, SCM scm_axis)
+Grob::stencil_extent (SCM element_smob, SCM scm_axis)
 {
   Grob *s = unsmob_grob (element_smob);
   Axis a = (Axis) gh_scm2int (scm_axis);
 
-  Molecule *m = s->get_molecule ();
+  Stencil *m = s->get_stencil ();
   Interval e ;
   if (m)
     e = m->extent (a);
   return ly_interval2scm (e);
 }
 
-MAKE_SCHEME_CALLBACK (Grob,preset_extent,2);
-SCM
-Grob::preset_extent (SCM element_smob, SCM scm_axis)
-{
-  Grob *s = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (scm_axis);
-
-  SCM ext = s->get_grob_property ((a == X_AXIS)
-                                ? "extent-X"
-                                : "extent-Y");
-  
-  if (gh_pair_p (ext))
-    {
-      Real l = gh_scm2double (ly_car (ext));
-      Real r = gh_scm2double (ly_cdr (ext));
-      return ly_interval2scm (Interval (l, r));
-    }
-  
-  return ly_interval2scm (Interval ());
-}
-
-
-
 Paper_def*
 Grob::get_paper ()  const
 {
@@ -223,67 +201,69 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname)
   status_= final;
 }
 
-Molecule *
-Grob::get_molecule ()  const
+Stencil *
+Grob::get_stencil ()  const
 {
   if (!live())
     {
       return 0;
-      
     }
   
-  SCM mol = get_grob_property ("molecule");
-  if (unsmob_molecule (mol))
-    return unsmob_molecule (mol);
+  SCM mol = get_grob_property ("stencil");
+  if (unsmob_stencil (mol))
+    return unsmob_stencil (mol);
 
-  mol =  get_uncached_molecule ();
+  mol = get_uncached_stencil ();
   
-  Grob *me = (Grob*)this;
-  me->set_grob_property ("molecule", mol);
+  if (live ())
+    {
+      Grob *me = (Grob*)this;
+      me->set_grob_property ("stencil", mol);
+    }
   
-  return unsmob_molecule (mol);  
+  return unsmob_stencil (mol);  
 }
 
 SCM
-Grob::get_uncached_molecule ()const
+Grob::get_uncached_stencil ()const
 {
-  SCM proc = get_grob_property ("molecule-callback");
+  SCM proc = get_grob_property ("print-function");
 
   SCM  mol = SCM_EOL;
   if (gh_procedure_p (proc)) 
     mol = gh_apply (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
-
   
-  Molecule *m = unsmob_molecule (mol);
+  Stencil *m = unsmob_stencil (mol);
   
-  if (unsmob_molecule (mol))
+  if (unsmob_stencil (mol))
     {
       SCM origin = ly_symbol2scm ("no-origin");
       
-      if (store_locations_global_b){
-       SCM cause = get_grob_property ("cause");
-       if (Music*m = unsmob_music (cause))
-         {
-           SCM music_origin = m->get_mus_property ("origin");
-           if (unsmob_input (music_origin))
-             origin = music_origin;
-         }
+      if (store_locations_global_b)
+       {
+         SCM cause = get_grob_property ("cause");
+         if (Music*m = unsmob_music (cause))
+           {
+             SCM music_origin = m->get_mus_property ("origin");
+             if (unsmob_input (music_origin))
+               origin = music_origin;
+           }
       }
 
       // ugr.
       
-      mol = Molecule (m->extent_box (),
+      mol = Stencil (m->extent_box (),
                      scm_list_n (origin, m->get_expr (), SCM_UNDEFINED)
                      ). smobbed_copy ();
 
-      m = unsmob_molecule (mol);
+      m = unsmob_stencil (mol);
     }
   
   /*
     transparent retains dimensions of element.
    */
   if (m && to_boolean (get_grob_property ("transparent")))
-    mol = Molecule (m->extent_box (), SCM_EOL).smobbed_copy ();
+    mol = Stencil (m->extent_box (), SCM_EOL).smobbed_copy ();
 
   return mol;
 }
@@ -319,30 +299,32 @@ Grob::add_dependency (Grob*e)
 void
 Grob::handle_broken_dependencies ()
 {
-  Spanner * s= dynamic_cast<Spanner*> (this);
-  if (original_ && s)
+  Spanner * s= dynamic_cast<Spanner*> (this);
+  if (original_ && sp)
     return;
 
-  if (s)
+  if (sp)
     {
-      for (int i = 0;  i< s->broken_intos_ .size (); i++)
+      /*
+       This is the original spanner. We use a special function
+       because some Spanners have enormously long lists in their
+       properties.
+       */
+      for (SCM s = mutable_property_alist_; gh_pair_p(s);
+          s = gh_cdr(s))
        {
-         Grob * sc = s->broken_intos_[i];
-         System * l = sc->get_system ();
-
-         sc->substitute_mutable_properties (l ? l->self_scm () : SCM_UNDEFINED,
-                                  mutable_property_alist_);
+         sp->substitute_one_mutable_property (gh_caar (s),
+                                             gh_cdar (s));
        }
     }
 
-
   System *system = get_system ();
 
   if (live ()
       && system && common_refpoint (system, X_AXIS) && common_refpoint (system, Y_AXIS))
     {
       substitute_mutable_properties (system ? system->self_scm () : SCM_UNDEFINED,
-                              mutable_property_alist_);
+                                    mutable_property_alist_);
     }
   else if (dynamic_cast <System*> (this))
     {
@@ -371,6 +353,13 @@ Grob::handle_broken_dependencies ()
 void
 Grob::suicide ()
 {
+  if (!live ())
+    return; 
+
+#if 0 // see below. 
+   String nm = name();
+#endif
+  
   mutable_property_alist_ = SCM_EOL;
   immutable_property_alist_ = SCM_EOL;
 
@@ -382,6 +371,19 @@ Grob::suicide ()
       dim_cache_[a].offset_callbacks_ = SCM_EOL;
       dim_cache_[a].offsets_left_ = 0;
     }
+
+#if 0
+  /*
+    This can make debugging a little easier: we can still know what
+    the object used to be. However, since all its links have been
+    broken, it's usually more convenient to set a conditional
+    breakpoint in GDB before the property lists are wiped.
+   */
+  mutable_property_alist_ = scm_acons (ly_symbol2scm ("name"),
+                                      scm_makfrom0str (nm.to_str0()),
+                                      mutable_property_alist_
+                                      );
+#endif
 }
 
 void
@@ -470,15 +472,8 @@ Grob::get_offset (Axis a) const
 }
 
 
-MAKE_SCHEME_CALLBACK (Grob,point_dimension_callback,2);
-SCM
-Grob::point_dimension_callback (SCM , SCM)
-{
-  return ly_interval2scm (Interval (0,0));
-}
-
 bool
-Grob::empty_b (Axis a)const
+Grob::is_empty (Axis a)const
 {
   return ! (gh_pair_p (dim_cache_[a].dimension_) ||
            gh_procedure_p (dim_cache_[a].dimension_));
@@ -510,8 +505,8 @@ Grob::extent (Grob * refp, Axis a) const
   ext = ly_scm2interval (d->dimension_);
 
   SCM extra = get_grob_property (a == X_AXIS
-                               ? "extra-extent-X"
-                               : "extra-extent-Y");
+                               ? "extra-X-extent"
+                               : "extra-Y-extent");
 
   /*
     signs ?
@@ -523,8 +518,8 @@ Grob::extent (Grob * refp, Axis a) const
     }
   
   extra = get_grob_property (a == X_AXIS
-                               ? "minimum-extent-X"
-                               : "minimum-extent-Y");
+                               ? "minimum-X-extent"
+                               : "minimum-Y-extent");
   if (gh_pair_p (extra))
     {
       ext.unite (Interval (gh_scm2double (ly_car (extra)),
@@ -677,9 +672,8 @@ void
 Grob::warning (String s)const
 {
   SCM cause = self_scm();
-  while (cause != SCM_EOL && !unsmob_music (cause))
+  while (Grob * g = unsmob_grob (cause))
     {
-      Grob * g = unsmob_grob (cause);
       cause = g->get_grob_property ("cause");
     }
 
@@ -752,7 +746,7 @@ Grob::print_smob (SCM s, SCM port, scm_print_state *)
 }
 
 SCM
-Grob::do_derived_mark ()
+Grob::do_derived_mark () const
 {
   return SCM_EOL;
 }
@@ -801,40 +795,40 @@ ly_grobs2scm (Link_array<Grob> a)
 }
 
 
-IMPLEMENT_TYPE_P (Grob, "ly-grob?");
+IMPLEMENT_TYPE_P (Grob, "ly:grob?");
 
 ADD_INTERFACE (Grob, "grob-interface",
-  "In music notation, lots of symbols are related in some way.  You can
-think of music notation as a graph where nodes are formed by the
-symbols, and the arcs by their relations. A grob is a node in that
-graph.  The directed edges in the graph are formed by references to
-other grobs (i.e. pointers).  This big graph of grobs specifies the
-notation problem. The solution of this problem is a description of the
-printout in closed form, i.e. a list of values.  These values are
-Molecules.
-
-All grobs have an X and Y-position on the page.  These X and Y positions
-are stored in a relative format, so they can easily be combined by
-stacking them, hanging one grob to the side of another, and coupling
-them into a grouping-grob.
-
-Each grob has a reference point (a.k.a.  parent): the position of a grob
-is stored relative to that reference point. For example the X-reference
-point of a staccato dot usually is the note head that it applies
-to. When the note head is moved, the staccato dot moves along
-automatically.
-
-A grob is often associated with a symbol, but some grobs do not print
-any symbols. They take care of grouping objects. For example, there is a
-separate grob that stacks staves vertically. The @ref{NoteCollision}
-is also an abstract grob: it only moves around chords, but doesn't print
-anything.
-",
-  "X-offset-callbacks Y-offset-callbacks X-extent-callback molecule cause
-Y-extent-callback molecule-callback extra-offset spacing-procedure
-staff-symbol interfaces dependencies extent-X extent-Y extra-extent-X
-causes meta layer before-line-breaking-callback
-after-line-breaking-callback extra-extent-Y minimum-extent-X
-minimum-extent-Y transparent");
+  "In music notation, lots of symbols are related in some way.  You can\n"
+"think of music notation as a graph where nodes are formed by the\n"
+"symbols, and the arcs by their relations. A grob is a node in that\n"
+"graph.  The directed edges in the graph are formed by references to\n"
+"other grobs (i.e. pointers).  This big graph of grobs specifies the\n"
+"notation problem. The solution of this problem is a description of the\n"
+"printout in closed form, i.e. a list of values.  These values are\n"
+"Stencils.\n"
+"\n"
+"All grobs have an X and Y-position on the page.  These X and Y positions\n"
+"are stored in a relative format, so they can easily be combined by\n"
+"stacking them, hanging one grob to the side of another, and coupling\n"
+"them into a grouping-grob.\n"
+"\n"
+"Each grob has a reference point (a.k.a.  parent): the position of a grob\n"
+"is stored relative to that reference point. For example the X-reference\n"
+"point of a staccato dot usually is the note head that it applies\n"
+"to. When the note head is moved, the staccato dot moves along\n"
+"automatically.\n"
+"\n"
+"A grob is often associated with a symbol, but some grobs do not print\n"
+"any symbols. They take care of grouping objects. For example, there is a\n"
+"separate grob that stacks staves vertically. The @ref{NoteCollision}\n"
+"is also an abstract grob: it only moves around chords, but doesn't print\n"
+"anything.\n"
+,
+  "X-offset-callbacks Y-offset-callbacks X-extent-callback stencil cause "
+"Y-extent-callback print-function extra-offset spacing-procedure "
+"staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent "
+"meta layer before-line-breaking-callback "
+"after-line-breaking-callback extra-Y-extent minimum-X-extent X-extent Y-extent "
+"minimum-Y-extent transparent");