]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob.cc
* lily/book.cc (to_stencil): New method.
[lilypond.git] / lily / grob.cc
index 81df59f7531b4ff16ca578be3ae626fd3de9539a..b1e6324a943a7f7904f12ff08dd488e8e0eccc99 100644 (file)
@@ -53,9 +53,9 @@ Grob::Grob (SCM basicprops)
   mutable_property_alist_ = SCM_EOL;
 
   /*
-    We do smobify_self() as the first step. Since the object lives on
+    We do smobify_self () as the first step. Since the object lives on
     the heap, none of its SCM variables are protected from GC. After
-    smobify_self(), they are.
+    smobify_self (), they are.
    */
   smobify_self ();
 
@@ -64,8 +64,8 @@ Grob::Grob (SCM basicprops)
   mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE);
 #endif
   
-  SCM meta = get_grob_property ("meta");
-  if (gh_pair_p (meta))
+  SCM meta = get_property ("meta");
+  if (ly_c_pair_p (meta))
     {
       SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
 
@@ -74,7 +74,7 @@ Grob::Grob (SCM basicprops)
        */
       bool itc = internal_type_checking_global_b;
       internal_type_checking_global_b = false;
-      internal_set_grob_property (ly_symbol2scm ("interfaces"), gh_cdr(ifs));
+      internal_set_property (ly_symbol2scm ("interfaces"), ly_cdr (ifs));
       internal_type_checking_global_b = itc;
     }
   
@@ -91,7 +91,7 @@ Grob::Grob (SCM basicprops)
   
   for (int a = X_AXIS; a <= Y_AXIS; a++)
     {
-      SCM l = get_grob_property (onames[a]);
+      SCM l = get_property (onames[a]);
 
       if (scm_ilength (l) >=0)
        {
@@ -103,8 +103,8 @@ Grob::Grob (SCM basicprops)
          programming_error ("[XY]-offset-callbacks must be a list");
        }
 
-      SCM cb = get_grob_property (enames[a]);
-      SCM xt = get_grob_property (xnames[a]);
+      SCM cb = get_property (enames[a]);
+      SCM xt = get_property (xnames[a]);
       
       /*
        Should change default to empty? 
@@ -112,8 +112,8 @@ Grob::Grob (SCM basicprops)
       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 ("print-function")))
+         && !ly_c_procedure_p (cb) && !ly_c_pair_p (cb)
+         && ly_c_procedure_p (get_property ("print-function")))
        cb = stencil_extent_proc;
     
       dim_cache_[a].dimension_ = cb;
@@ -157,7 +157,7 @@ SCM
 Grob::stencil_extent (SCM element_smob, SCM scm_axis)
 {
   Grob *s = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (scm_axis);
+  Axis a = (Axis) ly_scm2int (scm_axis);
 
   Stencil *m = s->get_stencil ();
   Interval e ;
@@ -186,7 +186,7 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname)
   
   status_= busy;
 
-  for (SCM d = get_grob_property ("dependencies"); gh_pair_p (d);
+  for (SCM d = get_property ("dependencies"); ly_c_pair_p (d);
        d = ly_cdr (d))
     {
       unsmob_grob (ly_car (d))
@@ -194,9 +194,9 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname)
     }
 
   
-  SCM proc = internal_get_grob_property (funcname);
-  if (gh_procedure_p (proc))
-    gh_call1 (proc, this->self_scm ());
+  SCM proc = internal_get_property (funcname);
+  if (ly_c_procedure_p (proc))
+    scm_call_1 (proc, this->self_scm ());
  
   status_= final;
 }
@@ -204,12 +204,12 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname)
 Stencil *
 Grob::get_stencil ()  const
 {
-  if (!live())
+  if (!live ())
     {
       return 0;
     }
   
-  SCM mol = get_grob_property ("stencil");
+  SCM mol = get_property ("stencil");
   if (unsmob_stencil (mol))
     return unsmob_stencil (mol);
 
@@ -218,7 +218,7 @@ Grob::get_stencil ()  const
   if (live ())
     {
       Grob *me = (Grob*)this;
-      me->set_grob_property ("stencil", mol);
+      me->set_property ("stencil", mol);
     }
   
   return unsmob_stencil (mol);  
@@ -227,11 +227,11 @@ Grob::get_stencil ()  const
 SCM
 Grob::get_uncached_stencil ()const
 {
-  SCM proc = get_grob_property ("print-function");
+  SCM proc = get_property ("print-function");
 
   SCM  mol = SCM_EOL;
-  if (gh_procedure_p (proc)) 
-    mol = gh_apply (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
+  if (ly_c_procedure_p (proc)) 
+    mol = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
   
   Stencil *m = unsmob_stencil (mol);
   
@@ -241,10 +241,10 @@ Grob::get_uncached_stencil ()const
       
       if (store_locations_global_b)
        {
-         SCM cause = get_grob_property ("cause");
+         SCM cause = get_property ("cause");
          if (Music*m = unsmob_music (cause))
            {
-             SCM music_origin = m->get_mus_property ("origin");
+             SCM music_origin = m->get_property ("origin");
              if (unsmob_input (music_origin))
                origin = music_origin;
            }
@@ -253,7 +253,7 @@ Grob::get_uncached_stencil ()const
       // ugr.
       
       mol = Stencil (m->extent_box (),
-                     scm_list_n (origin, m->get_expr (), SCM_UNDEFINED)
+                     scm_list_n (origin, m->expr (), SCM_UNDEFINED)
                      ). smobbed_copy ();
 
       m = unsmob_stencil (mol);
@@ -262,7 +262,7 @@ Grob::get_uncached_stencil ()const
   /*
     transparent retains dimensions of element.
    */
-  if (m && to_boolean (get_grob_property ("transparent")))
+  if (m && to_boolean (get_property ("transparent")))
     mol = Stencil (m->extent_box (), SCM_EOL).smobbed_copy ();
 
   return mol;
@@ -310,11 +310,11 @@ Grob::handle_broken_dependencies ()
        because some Spanners have enormously long lists in their
        properties.
        */
-      for (SCM s = mutable_property_alist_; gh_pair_p(s);
-          s = gh_cdr(s))
+      for (SCM s = mutable_property_alist_; ly_c_pair_p (s);
+          s = ly_cdr (s))
        {
-         sp->substitute_one_mutable_property (gh_caar (s),
-                                             gh_cdar (s));
+         sp->substitute_one_mutable_property (ly_caar (s),
+                                             ly_cdar (s));
        }
     }
 
@@ -357,7 +357,7 @@ Grob::suicide ()
     return; 
 
 #if 0 // see below. 
-   String nm = name();
+   String nm = name ();
 #endif
   
   mutable_property_alist_ = SCM_EOL;
@@ -396,7 +396,7 @@ Grob::handle_prebroken_dependencies ()
   if (original_)
     {
       Item * it = dynamic_cast<Item*> (this);
-      substitute_mutable_properties (gh_int2scm (it->break_status_dir ()),
+      substitute_mutable_properties (scm_int2num (it->break_status_dir ()),
                               original_->mutable_property_alist_);
     }
 }
@@ -457,10 +457,10 @@ Grob::get_offset (Axis a) const
   while (dim_cache_[a].offsets_left_)
     {
       int l = --me->dim_cache_[a].offsets_left_;
-      SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_,  gh_int2scm (l));
-      SCM retval = gh_call2 (cb, self_scm (), gh_int2scm (a));
+      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 =  gh_scm2double (retval);
+      Real r =  ly_scm2double (retval);
       if (isinf (r) || isnan (r))
        {
          programming_error (INFINITY_MSG);
@@ -475,8 +475,8 @@ Grob::get_offset (Axis a) const
 bool
 Grob::is_empty (Axis a)const
 {
-  return ! (gh_pair_p (dim_cache_[a].dimension_) ||
-           gh_procedure_p (dim_cache_[a].dimension_));
+  return ! (ly_c_pair_p (dim_cache_[a].dimension_) ||
+           ly_c_procedure_p (dim_cache_[a].dimension_));
 }
 
 Interval
@@ -487,43 +487,43 @@ Grob::extent (Grob * refp, Axis a) const
   
   Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
   Interval ext ;   
-  if (gh_pair_p (d->dimension_))
+  if (ly_c_pair_p (d->dimension_))
     ;
-  else if (gh_procedure_p (d->dimension_))
+  else if (ly_c_procedure_p (d->dimension_))
     {
       /*
        FIXME: add doco on types, and should typecheck maybe? 
        */
-      d->dimension_= gh_call2 (d->dimension_, self_scm (), gh_int2scm (a));
+      d->dimension_= scm_call_2 (d->dimension_, self_scm (), scm_int2num (a));
     }
   else
     return ext;
 
-  if (!gh_pair_p (d->dimension_))
+  if (!ly_c_pair_p (d->dimension_))
     return ext;
   
   ext = ly_scm2interval (d->dimension_);
 
-  SCM extra = get_grob_property (a == X_AXIS
+  SCM extra = get_property (a == X_AXIS
                                ? "extra-X-extent"
                                : "extra-Y-extent");
 
   /*
     signs ?
    */
-  if (gh_pair_p (extra))
+  if (ly_c_pair_p (extra))
     {
-      ext[BIGGER] +=  gh_scm2double (ly_cdr (extra));
-      ext[SMALLER] +=   gh_scm2double (ly_car (extra));
+      ext[BIGGER] +=  ly_scm2double (ly_cdr (extra));
+      ext[SMALLER] +=   ly_scm2double (ly_car (extra));
     }
   
-  extra = get_grob_property (a == X_AXIS
+  extra = get_property (a == X_AXIS
                                ? "minimum-X-extent"
                                : "minimum-Y-extent");
-  if (gh_pair_p (extra))
+  if (ly_c_pair_p (extra))
     {
-      ext.unite (Interval (gh_scm2double (ly_car (extra)),
-                          gh_scm2double (ly_cdr (extra))));
+      ext.unite (Interval (ly_scm2double (ly_car (extra)),
+                          ly_scm2double (ly_cdr (extra))));
     }
 
   ext.translate (x);
@@ -553,7 +553,7 @@ Grob::common_refpoint (Grob const* s, Axis a) const
 Grob *
 common_refpoint_of_list (SCM elist, Grob *common, Axis a) 
 {
-  for (; gh_pair_p (elist); elist = ly_cdr (elist))
+  for (; ly_c_pair_p (elist); elist = ly_cdr (elist))
     {
       Grob * s = unsmob_grob (ly_car (elist));
       if (!s)
@@ -572,7 +572,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--; )
     {
       Grob * s = arr[i];
       if (!s)
@@ -590,33 +590,33 @@ common_refpoint_of_array (Link_array<Grob> const &arr, Grob *common, Axis a)
 String
 Grob::name () const
 {
-  SCM meta = get_grob_property ("meta");
+  SCM meta = get_property ("meta");
   SCM nm = scm_assoc (ly_symbol2scm ("name"), meta);
-  nm = (gh_pair_p (nm)) ? ly_cdr (nm) : SCM_EOL;
-  return  gh_symbol_p (nm) ? ly_symbol2string (nm) :  classname (this);  
+  nm = (ly_c_pair_p (nm)) ? ly_cdr (nm) : SCM_EOL;
+  return  ly_c_symbol_p (nm) ? ly_symbol2string (nm) :  classname (this);  
 }
 
 void
 Grob::add_offset_callback (SCM cb, Axis a)
 {
-  if (!has_offset_callback_b (cb, a))
+  if (!has_offset_callback (cb, a))
   {
-    dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_);
+    dim_cache_[a].offset_callbacks_ = scm_cons (cb, dim_cache_[a].offset_callbacks_);
     dim_cache_[a].offsets_left_ ++;
   }
 }
 
 bool
-Grob::has_extent_callback_b (SCM cb, Axis a)const
+Grob::has_extent_callback (SCM cb, Axis a)const
 {
   return scm_equal_p (cb, dim_cache_[a].dimension_) == SCM_BOOL_T;
 }
 
 
 bool
-Grob::has_offset_callback_b (SCM cb, Axis a)const
+Grob::has_offset_callback (SCM cb, Axis a)const
 {
-  return scm_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F;
+  return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F;
 }
 
 void
@@ -671,15 +671,15 @@ Grob::fixup_refpoint (SCM smob)
 void
 Grob::warning (String s)const
 {
-  SCM cause = self_scm();
+  SCM cause = self_scm ();
   while (Grob * g = unsmob_grob (cause))
     {
-      cause = g->get_grob_property ("cause");
+      cause = g->get_property ("cause");
     }
 
   if (Music *m = unsmob_music (cause))
     {
-      m->origin()->warning (s);
+      m->origin ()->warning (s);
     }
   else
     ::warning (s);
@@ -761,9 +761,9 @@ Grob::discretionary_processing ()
 bool
 Grob::internal_has_interface (SCM k)
 {
-  SCM ifs = get_grob_property ("interfaces");
+  SCM ifs = get_property ("interfaces");
 
-  return scm_memq (k, ifs) != SCM_BOOL_F;
+  return scm_c_memq (k, ifs) != SCM_BOOL_F;
 }
 
 
@@ -773,9 +773,9 @@ ly_scm2grobs (SCM l)
 {
   Link_array<Grob> arr;
 
-  for (SCM s = l; gh_pair_p (s); s = gh_cdr (s))
+  for (SCM s = l; ly_c_pair_p (s); s = ly_cdr (s))
     {
-      SCM e = gh_car (s);
+      SCM e = ly_car (s);
       arr.push (unsmob_grob (e));
     }
 
@@ -789,7 +789,7 @@ ly_grobs2scm (Link_array<Grob> a)
 {
   SCM s = SCM_EOL;
   for (int i = a.size (); i; i--)
-    s = gh_cons (a[i-1]->self_scm (), s);
+    s = scm_cons (a[i-1]->self_scm (), s);
 
   return s;
 }
@@ -798,19 +798,12 @@ ly_grobs2scm (Link_array<Grob> a)
 IMPLEMENT_TYPE_P (Grob, "ly:grob?");
 
 ADD_INTERFACE (Grob, "grob-interface",
-  "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"
+              "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-grob.\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"
@@ -823,12 +816,25 @@ ADD_INTERFACE (Grob, "grob-interface",
 "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. "
+              "They can be changed using @code{\\override} and @code{\\revert}. "
+              "\n\n"
+              "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. " 
+
 ,
-  "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 "
-"minimum-Y-extent transparent");
+              "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 "
+              // FIXME: page-penalty?
+              "minimum-Y-extent page-penalty transparent "
+              );