]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob.cc
* flower
[lilypond.git] / lily / grob.cc
index 2ca648430ce3467ad428e5804046ae7fdce3429b..0594582d79ad343231f0307163a0b1a58081f8d8 100644 (file)
@@ -28,7 +28,7 @@
 
 #include "ly-smobs.icc"
 
-Grob * 
+Grob *
 Grob::clone (int count) const
 {
   return new Grob (*this, count);
@@ -36,14 +36,14 @@ Grob::clone (int count) const
 
 /* TODO:
 
-  - remove dynamic_cast<Spanner, Item> and put this code into respective
-    subclass.  */
+- remove dynamic_cast<Spanner, Item> and put this code into respective
+subclass.  */
 
 #define HASH_SIZE 3
 #define INFINITY_MSG "Infinity or NaN encountered"
 
 Grob::Grob (SCM basicprops,
-           Object_key constkey)
+           Object_key const *key)
 {
   key_ = key;
   /* FIXME: default should be no callback.  */
@@ -51,7 +51,7 @@ Grob::Grob (SCM basicprops,
   pscore_ = 0;
   status_ = 0;
   original_ = 0;
-  immutable_property_alist_ =  basicprops;
+  immutable_property_alist_ = basicprops;
   mutable_property_alist_ = SCM_EOL;
 
   /* We do smobify_self () as the first step.  Since the object lives
@@ -61,7 +61,7 @@ Grob::Grob (SCM basicprops,
 
   /*
     We always get a new key object for a new grob.
-   */
+  */
   scm_gc_unprotect_object (key_->self_scm ());
   SCM meta = get_property ("meta");
   if (scm_is_pair (meta))
@@ -77,14 +77,14 @@ Grob::Grob (SCM basicprops,
 
   /* TODO:
 
-    - destill this into a function, so we can re-init the immutable
-      properties with a new BASICPROPS value after
-      creation. Convenient eg. when using \override with
-      StaffSymbol.  */
+  - destill this into a function, so we can re-init the immutable
+  properties with a new BASICPROPS value after
+  creation. Convenient 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"};
+  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,7 +103,7 @@ Grob::Grob (SCM basicprops,
        {
          dim_cache_[a].dimension_ = SCM_BOOL_F;
        }
-      
+
       SCM xt = get_property (xnames[a]);
       if (is_number_pair (xt))
        {
@@ -120,10 +120,10 @@ Grob::Grob (SCM basicprops,
 }
 
 Grob::Grob (Grob const &s, int copy_index)
-   : dim_cache_ (s.dim_cache_)
+  : dim_cache_ (s.dim_cache_)
 {
   key_ = new Copied_key (s.key_, copy_index);
-  original_ = (Grob*) &s;
+  original_ = (Grob *) &s;
   self_scm_ = SCM_EOL;
 
   immutable_property_alist_ = s.immutable_property_alist_;
@@ -156,26 +156,24 @@ Grob::stencil_extent (SCM element_smob, SCM scm_axis)
   return ly_interval2scm (e);
 }
 
-
 Interval
-robust_relative_extent (Grob*me, Grob*refp, Axis a)
+robust_relative_extent (Grob *me, Grob *refp, Axis a)
 {
-  Interval ext =  me->extent  (refp, a);
-  if (ext.is_empty())
+  Interval ext = me->extent (refp, a);
+  if (ext.is_empty ())
     {
       ext.add_point (me->relative_coordinate (refp, a));
     }
 
-  return ext;      
+  return ext;
 }
 
 Output_def *
 Grob::get_layout () const
 {
- return pscore_ ? pscore_->layout_ : 0;
 return pscore_ ? pscore_->layout_ : 0;
 }
 
-
 /* Recursively track all dependencies of this Grob.  The status_ field
    is used as a mark-field.  It is marked with BUSY during execution
    of this function, and marked with FINAL when finished.
@@ -207,7 +205,7 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname)
 }
 
 Stencil *
-Grob::get_stencil ()  const
+Grob::get_stencil () const
 {
   if (!is_live ())
     return 0;
@@ -219,7 +217,7 @@ Grob::get_stencil ()  const
   stil = get_uncached_stencil ();
   if (is_live ())
     {
-      Grob *me = (Grob*) this;
+      Grob *me = (Grob *) this;
       me->set_property ("stencil", stil);
     }
 
@@ -236,12 +234,12 @@ Grob::get_uncached_stencil () const
     stil = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
 
   if (Stencil *m = unsmob_stencil (stil))
-     {
+    {
       if (to_boolean (get_property ("transparent")))
        stil = Stencil (m->extent_box (), SCM_EOL).smobbed_copy ();
       else
        {
-         SCM expr = scm_list_3 (ly_symbol2scm ("grob-cause"), self_scm(),
+         SCM expr = scm_list_3 (ly_symbol2scm ("grob-cause"), self_scm (),
                                 m->expr ());
          stil = Stencil (m->extent_box (), expr). smobbed_copy ();
        }
@@ -255,16 +253,16 @@ Grob::get_uncached_stencil () const
                                 color,
                                 m->expr ());
 
-         stil = Stencil (m->extent_box (), expr).smobbed_copy();
+         stil = Stencil (m->extent_box (), expr).smobbed_copy ();
        }
-     }
+    }
 
   return stil;
 }
 
 /*
   VIRTUAL STUBS
- */
+*/
 void
 Grob::do_break_processing ()
 {
@@ -289,7 +287,7 @@ Grob::add_dependency (Grob *e)
 void
 Grob::handle_broken_dependencies ()
 {
-  Spanner *sp = dynamic_cast<Spanner*> (this);
+  Spanner *sp = dynamic_cast<Spanner *> (this);
   if (original_ && sp)
     return;
 
@@ -308,7 +306,7 @@ Grob::handle_broken_dependencies ()
     substitute_mutable_properties (system
                                   ? system->self_scm () : SCM_UNDEFINED,
                                   mutable_property_alist_);
-  else if (dynamic_cast <System*> (this))
+  else if (dynamic_cast<System *> (this))
     substitute_mutable_properties (SCM_UNDEFINED, mutable_property_alist_);
   else
     /* THIS element is `invalid'; it has been removed from all
@@ -353,7 +351,7 @@ Grob::handle_prebroken_dependencies ()
      mutable_property_alist_ centralized.  */
   if (original_)
     {
-      Item *it = dynamic_cast<Item*> (this);
+      Item *it = dynamic_cast<Item *> (this);
       substitute_mutable_properties (scm_int2num (it->break_status_dir ()),
                                     original_->mutable_property_alist_);
     }
@@ -375,7 +373,6 @@ Grob::translate_axis (Real y, Axis a)
     dim_cache_[a].offset_ += y;
 }
 
-
 /* Find the offset relative to D.  If D equals THIS, then it is 0.
    Otherwise, it recursively defd as
 
@@ -398,14 +395,14 @@ Grob::relative_coordinate (Grob const *refp, Axis a) const
 Real
 Grob::get_offset (Axis a) const
 {
-  Grob *me = (Grob*) this;
+  Grob *me = (Grob *) this;
   while (dim_cache_[a].offsets_left_)
     {
       int l = --me->dim_cache_[a].offsets_left_;
       SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, scm_int2num (l));
       SCM retval = scm_call_2 (cb, self_scm (), scm_int2num (a));
 
-      Real r =  scm_to_double (retval);
+      Real r = scm_to_double (retval);
       if (isinf (r) || isnan (r))
        {
          programming_error (INFINITY_MSG);
@@ -426,15 +423,14 @@ Grob::is_empty (Axis a) const
 void
 Grob::flush_extent_cache (Axis axis)
 {
-  Dimension_cache * d = &dim_cache_[axis];
+  Dimension_cache *d = &dim_cache_[axis];
   if (ly_c_procedure_p (d->dimension_callback_)
       && scm_is_pair (d->dimension_))
     {
       d->dimension_ = SCM_EOL;
 
-
       if (get_parent (axis))
-       get_parent(axis)->flush_extent_cache (axis);
+       get_parent (axis)->flush_extent_cache (axis);
     }
 }
 
@@ -447,8 +443,7 @@ Grob::extent (Grob *refp, Axis a) const
   Interval ext;
 
   SCM dimpair = d->dimension_;
-  if (scm_is_pair (dimpair))
-    ;
+  if (scm_is_pair (dimpair));
   else if (ly_c_procedure_p (d->dimension_callback_)
           && d->dimension_ == SCM_EOL)
     d->dimension_ = scm_call_2 (d->dimension_callback_, self_scm (), scm_int2num (a));
@@ -493,7 +488,7 @@ Grob::common_refpoint (Grob const *s, Axis a) const
   for (Grob const *c = this; c; c = c->dim_cache_[a].parent_)
     for (Grob const *d = s; d; d = d->dim_cache_[a].parent_)
       if (d == c)
-       return (Grob*) d;
+       return (Grob *) d;
 
   return 0;
 }
@@ -516,7 +511,7 @@ common_refpoint_of_list (SCM elist, Grob *common, Axis a)
 Grob *
 common_refpoint_of_array (Link_array<Grob> const &arr, Grob *common, Axis a)
 {
-  for (int i = arr.size (); i--; )
+  for (int i = arr.size (); i--;)
     if (Grob *s = arr[i])
       {
        if (common)
@@ -541,11 +536,11 @@ void
 Grob::add_offset_callback (SCM cb, Axis a)
 {
   if (!has_offset_callback (cb, a))
-  {
-    dim_cache_[a].offset_callbacks_
-      = scm_cons (cb, dim_cache_[a].offset_callbacks_);
-    dim_cache_[a].offsets_left_ ++;
-  }
+    {
+      dim_cache_[a].offset_callbacks_
+       = scm_cons (cb, dim_cache_[a].offset_callbacks_);
+      dim_cache_[a].offsets_left_++;
+    }
 }
 
 bool
@@ -583,7 +578,7 @@ SCM
 Grob::fixup_refpoint (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  for (int a = X_AXIS; a < NO_AXES; a ++)
+  for (int a = X_AXIS; a < NO_AXES; a++)
     {
       Axis ax = (Axis)a;
       Grob *parent = me->get_parent (ax);
@@ -597,13 +592,13 @@ Grob::fixup_refpoint (SCM smob)
          me->set_parent (newparent, ax);
        }
 
-      if (Item *i = dynamic_cast<Item*> (me))
+      if (Item *i = dynamic_cast<Item *> (me))
        {
-         Item *parenti = dynamic_cast<Item*> (parent);
+         Item *parenti = dynamic_cast<Item *> (parent);
 
          if (parenti && i)
            {
-             Direction  my_dir = i->break_status_dir () ;
+             Direction my_dir = i->break_status_dir ();
              if (my_dir!= parenti->break_status_dir ())
                {
                  Item *newparent = parenti->find_prebroken_piece (my_dir);
@@ -635,10 +630,9 @@ Grob::programming_error (String s) const
   warning (s);
 }
 
-
 /****************************************************
   SMOB funcs
- ****************************************************/
+****************************************************/
 
 IMPLEMENT_SMOBS (Grob);
 IMPLEMENT_DEFAULT_EQUAL_P (Grob);
@@ -646,10 +640,10 @@ IMPLEMENT_DEFAULT_EQUAL_P (Grob);
 SCM
 Grob::mark_smob (SCM ses)
 {
-  Grob *s = (Grob*) SCM_CELL_WORD_1 (ses);
+  Grob *s = (Grob *) SCM_CELL_WORD_1 (ses);
   scm_gc_mark (s->immutable_property_alist_);
   scm_gc_mark (s->key_->self_scm ());
-  for (int a = 0 ; a < 2; a++)
+  for (int a = 0; a < 2; a++)
     {
       scm_gc_mark (s->dim_cache_[a].offset_callbacks_);
       scm_gc_mark (s->dim_cache_[a].dimension_);
@@ -702,13 +696,12 @@ Grob::internal_has_interface (SCM k)
   return scm_c_memq (k, ifs) != SCM_BOOL_F;
 }
 
-Grob*
+Grob *
 Grob::get_parent (Axis a) const
 {
   return dim_cache_[a].parent_;
 }
 
-
 /** Return Array of Grobs in SCM list LST */
 Link_array<Grob>
 ly_scm2grobs (SCM lst)
@@ -737,34 +730,33 @@ ly_grobs2scm (Link_array<Grob> a)
 {
   SCM s = SCM_EOL;
   for (int i = a.size (); i; i--)
-    s = scm_cons (a[i-1]->self_scm (), s);
+    s = scm_cons (a[i - 1]->self_scm (), s);
 
   return s;
 }
 
-
 IMPLEMENT_TYPE_P (Grob, "ly:grob?");
 
 ADD_INTERFACE (Grob, "grob-interface",
               "A grob represents a piece of music notation\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 objects.\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"
-"\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 objects.\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"
+              "\n"
               "Grobs have a properties: Scheme variables, that can be read and set. "
               "They have two types. Immutable variables "
               "define the default style and behavior.  They are shared between  many objects. "
@@ -773,9 +765,7 @@ ADD_INTERFACE (Grob, "grob-interface",
               "Mutable properties are variables that are specific to one grob. Typically, "
               "lists of other objects, or results from computations are stored in"
               "mutable properties: every call to set-grob-property (or its C++ equivalent) "
-              "sets a mutable property. "
-
-,
+              "sets a mutable property. ",
               "X-offset-callbacks Y-offset-callbacks X-extent-callback stencil cause "
               "Y-extent-callback print-function extra-offset spacing-procedure "
               "context staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent "
@@ -784,8 +774,5 @@ ADD_INTERFACE (Grob, "grob-interface",
               "axis-group-parent-X "
               "axis-group-parent-Y "
               "after-line-breaking-callback extra-Y-extent minimum-X-extent "
-              "minimum-Y-extent transparent tweak-count tweak-rank"
-              );
-
-
+              "minimum-Y-extent transparent tweak-count tweak-rank");