X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob.cc;h=911243bd5bd0a77a72e4f076a457d94ea9f03ef3;hb=40652d626dc52d09f28ec25e1a986c036ac171ae;hp=0591ab115f6cc6ac8ed0ffddb2960141c4e77695;hpb=635bff94c5a920d5866be4ff16751d771a35b7da;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index 0591ab115f..911243bd5b 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -1,9 +1,20 @@ /* - grob.cc -- implement Grob + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2010 Han-Wen Nienhuys - (c) 1997--2006 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ #include "grob.hh" @@ -11,6 +22,7 @@ #include #include "align-interface.hh" +#include "axis-group-interface.hh" #include "input.hh" #include "international.hh" #include "item.hh" @@ -19,6 +31,7 @@ #include "music.hh" #include "output-def.hh" #include "pointer-group-interface.hh" +#include "program-option.hh" #include "stencil.hh" #include "stream-event.hh" #include "system.hh" @@ -27,15 +40,13 @@ #include "ly-smobs.icc" Grob * -Grob::clone (int count) const +Grob::clone () const { - return new Grob (*this, count); + return new Grob (*this); } -Grob::Grob (SCM basicprops, - Object_key const *key) +Grob::Grob (SCM basicprops) { - key_ = key; /* FIXME: default should be no callback. */ self_scm_ = SCM_EOL; @@ -51,12 +62,6 @@ Grob::Grob (SCM basicprops, GC. After smobify_self (), they are. */ smobify_self (); - /* - We always get a new key object for a new grob. - */ - if (key_) - ((Object_key *)key_)->unprotect (); - SCM meta = get_property ("meta"); if (scm_is_pair (meta)) { @@ -76,10 +81,9 @@ Grob::Grob (SCM basicprops, set_property ("Y-extent", Grob::stencil_height_proc); } -Grob::Grob (Grob const &s, int copy_index) +Grob::Grob (Grob const &s) : dim_cache_ (s.dim_cache_) { - key_ = (use_object_keys) ? new Copied_key (s.key_, copy_index) : 0; original_ = (Grob *) & s; self_scm_ = SCM_EOL; @@ -91,8 +95,6 @@ Grob::Grob (Grob const &s, int copy_index) layout_ = 0; smobify_self (); - if (key_) - ((Object_key *)key_)->unprotect (); } Grob::~Grob () @@ -139,7 +141,7 @@ Grob::get_print_stencil () const Real x = scm_to_double (scm_cadr (rot)); Real y = scm_to_double (scm_caddr (rot)); - retval.rotate (angle, Offset (x, y)); + retval.rotate_degrees (angle, Offset (x, y)); } /* color support... see interpret_stencil_expression () for more... */ @@ -153,6 +155,15 @@ Grob::get_print_stencil () const retval = Stencil (retval.extent_box (), expr); } + /* process whiteout */ + if (to_boolean (get_property ("whiteout"))) + { + /* Call the scheme procedure stencil-whiteout in scm/stencils.scm */ + /* to add a round-filled-box stencil to the stencil list */ + retval + = *unsmob_stencil (scm_call_1 (ly_lily_module_constant ("stencil-whiteout"), + retval.smobbed_copy())); + } } return retval; @@ -276,7 +287,8 @@ Grob::translate_axis (Real y, Axis a) Real Grob::relative_coordinate (Grob const *refp, Axis a) const { - if (refp == this) + /* eaa - hmmm, should we do a programming_error() here? */ + if ((this == NULL) || (refp == this)) return 0.0; /* We catch PARENT_L_ == nil case with this, but we crash if we did @@ -299,16 +311,23 @@ Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end) Real off = 0; if (dim_cache_[Y_AXIS].offset_) - off = *dim_cache_[Y_AXIS].offset_; + { + if (to_boolean (get_property ("pure-Y-offset-in-progress"))) + programming_error ("cyclic chain in pure-Y-offset callbacks"); + + off = *dim_cache_[Y_AXIS].offset_; + } else { SCM proc = get_property_data ("Y-offset"); dim_cache_[Y_AXIS].offset_ = new Real (0.0); + set_property ("pure-Y-offset-in-progress", SCM_BOOL_T); off = robust_scm2double (call_pure_function (proc, scm_list_1 (self_scm ()), start, end), 0.0); + del_property ("pure-Y-offset-in-progress"); delete dim_cache_[Y_AXIS].offset_; dim_cache_[Y_AXIS].offset_ = 0; } @@ -405,7 +424,7 @@ Grob::extent (Grob *refp, Axis a) const (a == X_AXIS) ? ly_symbol2scm ("X-extent") : ly_symbol2scm ("Y-extent"); - + SCM ext = internal_get_property (ext_sym); if (is_number_pair (ext)) real_ext.unite (ly_scm2interval (ext)); @@ -429,11 +448,11 @@ Grob::extent (Grob *refp, Axis a) const Interval Grob::pure_height (Grob *refp, int start, int end) { - SCM proc = get_property_data ( ly_symbol2scm ("Y-extent")); - Interval iv = robust_scm2interval (call_pure_function (proc, - scm_list_1 (self_scm ()), - start, end), - Interval (0, 0)); + SCM proc = get_property_data (ly_symbol2scm ("Y-extent")); + SCM iv_scm = call_pure_function (proc, + scm_list_1 (self_scm ()), + start, end); + Interval iv = robust_scm2interval (iv_scm, Interval (0, 0)); Real offset = pure_relative_y_coordinate (refp, start, end); SCM min_ext = get_property ("minimum-Y-extent"); @@ -444,7 +463,8 @@ Grob::pure_height (Grob *refp, int start, int end) if (!iv.is_empty () && is_number_pair (min_ext)) iv.unite (ly_scm2interval (min_ext)); - iv.translate (offset); + if (!iv.is_empty ()) + iv.translate (offset); return iv; } @@ -457,7 +477,7 @@ Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end) } Interval_t -Grob::spanned_rank_iv () +Grob::spanned_rank_interval () const { return Interval_t (-1, 0); } @@ -535,6 +555,9 @@ Grob::fixup_refpoint () void Grob::warning (string s) const { + if (get_program_option ("warning-as-error")) + error (s); + SCM cause = self_scm (); while (Grob *g = unsmob_grob (cause)) cause = g->get_property ("cause"); @@ -561,6 +584,9 @@ Grob::name () const void Grob::programming_error (string s) const { + if (get_program_option ("warning-as-error")) + error (s); + SCM cause = self_scm (); while (Grob *g = unsmob_grob (cause)) cause = g->get_property ("cause"); @@ -571,46 +597,49 @@ Grob::programming_error (string s) const if (Music *m = unsmob_music (cause)) m->origin ()->message (s); else if (Stream_event *ev = unsmob_stream_event (cause)) - ev->origin ()->warning (s); + ev->origin ()->message (s); else ::message (s); } ADD_INTERFACE (Grob, - "A grob represents a piece of music notation\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 objects.\n" + "All grobs have an X and Y@tie{}position on the page. These" + " X and Y@tie{}positions are stored in a relative format, thus" + " they can easily be combined by stacking them, hanging one" + " grob to the side of another, or coupling them into 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" + "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@tie{}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.\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" + "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} object is also an" + " abstract grob: It only moves around chords, but doesn't print" + " 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. " - "\n\n" - "The properties @code{after-line-breaking} and @code{before-line-breaking} " - "are dummies that are not user-serviceable. " - - , + "Grobs have properties (Scheme variables) that can be read and" + " set. Two types of them exist: immutable and mutable." + " Immutable variables define the default style and behavior." + " They are shared between many objects. They can be changed" + " using @code{\\override} and @code{\\revert}. Mutable" + " properties are variables that are specific to one grob." + " Typically, lists of other objects, or results from" + " computations are stored in mutable properties. In" + " particular, every call to @code{ly:grob-set-property!}" + " (or its C++ equivalent) sets a mutable property.\n" + "\n" + "The properties @code{after-line-breaking} and" + " @code{before-line-breaking} are dummies that are not" + " user-serviceable.", /* properties */ "X-extent " @@ -624,6 +653,7 @@ ADD_INTERFACE (Grob, "before-line-breaking " "cause " "color " + "cross-staff " "extra-X-extent " "extra-Y-extent " "extra-offset " @@ -635,11 +665,13 @@ ADD_INTERFACE (Grob, "outside-staff-horizontal-padding " "outside-staff-padding " "outside-staff-priority " + "pure-Y-offset-in-progress " "rotation " "springs-and-rods " "staff-symbol " "stencil " "transparent " + "whiteout " ); /**************************************************************** @@ -665,7 +697,7 @@ Grob::stencil_height (SCM smob) return grob_stencil_extent (me, Y_AXIS); } -MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1); +MAKE_SCHEME_CALLBACK (Grob, y_parent_positioning, 1); SCM Grob::y_parent_positioning (SCM smob) { @@ -678,7 +710,7 @@ Grob::y_parent_positioning (SCM smob) } -MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1); +MAKE_SCHEME_CALLBACK (Grob, x_parent_positioning, 1); SCM Grob::x_parent_positioning (SCM smob) { @@ -700,7 +732,6 @@ Grob::stencil_width (SCM smob) } - Grob * common_refpoint_of_list (SCM elist, Grob *common, Axis a) { @@ -719,14 +750,11 @@ common_refpoint_of_list (SCM elist, Grob *common, Axis a) Grob * common_refpoint_of_array (vector const &arr, Grob *common, Axis a) { - for (vsize i = arr.size (); i--;) - if (Grob *s = arr[i]) - { - if (common) - common = common->common_refpoint (s, a); - else - common = s; - } + for (vsize i = 0; i < arr.size (); i++) + if (common) + common = common->common_refpoint (arr[i], a); + else + common = arr[i]; return common; } @@ -741,3 +769,18 @@ robust_relative_extent (Grob *me, Grob *refpoint, Axis a) return ext; } +// Checks whether there is a vertical alignment in the chain of +// parents between this and commony. +bool +Grob::check_cross_staff (Grob *commony) +{ + if (Align_interface::has_interface (commony)) + return true; + + for (Grob *g = this; g && g != commony; g = g->get_parent (Y_AXIS)) + if (Align_interface::has_interface (g)) + return true; + + return false; +} +