2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1996--2012 Han-Wen Nienhuys
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
24 #include "virtual-methods.hh"
25 #include "dimension-cache.hh"
26 #include "grob-interface.hh"
34 DECLARE_CLASSNAME (Grob);
40 Dimension_cache dim_cache_[NO_AXES];
45 SCM immutable_property_alist_;
46 SCM mutable_property_alist_;
50 If this is a property, it accounts for 25% of the property
55 void substitute_object_links (SCM, SCM);
56 Real get_offset (Axis a) const;
57 SCM try_callback (SCM, SCM);
58 SCM try_callback_on_alist (SCM *, SCM, SCM);
59 void internal_set_value_on_alist (SCM *alist, SCM sym, SCM val);
66 friend SCM ly_grob_properties (SCM);
67 friend SCM ly_grob_basic_properties (SCM);
69 /* standard callbacks */
70 DECLARE_SCHEME_CALLBACK (x_parent_positioning, (SCM));
71 DECLARE_SCHEME_CALLBACK (y_parent_positioning, (SCM));
72 DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob));
73 DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob));
74 DECLARE_SCHEME_CALLBACK (pure_simple_vertical_skylines_from_extents, (SCM smob, SCM, SCM));
75 DECLARE_SCHEME_CALLBACK (simple_vertical_skylines_from_extents, (SCM smob));
76 DECLARE_SCHEME_CALLBACK (vertical_skylines_from_stencil, (SCM smob));
77 DECLARE_SCHEME_CALLBACK (vertical_skylines_from_element_stencils, (SCM smob));
78 DECLARE_SCHEME_CALLBACK (pure_simple_horizontal_skylines_from_extents, (SCM smob, SCM, SCM));
79 DECLARE_SCHEME_CALLBACK (simple_horizontal_skylines_from_extents, (SCM smob));
80 DECLARE_SCHEME_CALLBACK (horizontal_skylines_from_stencil, (SCM smob));
81 DECLARE_SCHEME_CALLBACK (horizontal_skylines_from_element_stencils, (SCM smob));
84 Output_def *layout () const { return layout_; }
85 Grob *original () const { return original_; }
86 SCM interfaces () const { return interfaces_; }
89 Grob (SCM basic_props);
91 virtual Grob *clone () const;
95 bool is_live () const;
101 SCM get_property_alist_chain (SCM) const;
102 SCM internal_get_property (SCM symbol) const;
103 SCM internal_get_property_data (SCM symbol) const;
104 SCM internal_get_pure_property (SCM symbol, int start, int end) const;
105 SCM internal_get_maybe_pure_property (SCM symbol, bool pure, int start, int end) const;
106 SCM internal_get_non_callback_marker_property_data (SCM symbol) const;
107 SCM internal_get_object (SCM symbol) const;
108 void internal_set_object (SCM sym, SCM val);
109 void internal_del_property (SCM symbol);
110 void instrumented_set_property (SCM, SCM, char const *, int, char const *);
111 void internal_set_property (SCM sym, SCM val);
114 void warning (string) const;
115 void programming_error (string) const;
117 /* class hierarchy */
118 virtual System *get_system () const;
119 static System *get_system (Grob *);
120 virtual void do_break_processing ();
121 virtual Grob *find_broken_piece (System *) const;
122 virtual void discretionary_processing ();
123 virtual void derived_mark () const;
124 virtual void handle_broken_dependencies ();
125 virtual void handle_prebroken_dependencies ();
128 Stencil *get_stencil () const;
129 Stencil get_print_stencil () const;
132 bool internal_has_interface (SCM intf);
133 DECLARE_GROB_INTERFACE ();
136 void translate_axis (Real, Axis);
137 Real relative_coordinate (Grob const *refp, Axis) const;
138 Real pure_relative_y_coordinate (Grob const *refp, int start, int end);
139 Real maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end);
142 Interval extent (Grob *refpoint, Axis) const;
143 void flush_extent_cache (Axis);
144 virtual Interval pure_height (Grob *refpoint, int start_col, int end_col);
145 Interval maybe_pure_extent (Grob *refpoint, Axis, bool pure, int start, int end);
148 Grob *common_refpoint (Grob const *s, Axis a) const;
149 void set_parent (Grob *e, Axis);
150 Grob *get_parent (Axis a) const;
151 void fixup_refpoint ();
153 /* vertical ordering */
154 static bool internal_vertical_less (Grob *g1, Grob *g2, bool pure);
155 static Grob *get_root_vertical_alignment (Grob *g);
156 static Grob *get_vertical_axis_group (Grob *g);
157 static bool vertical_less (Grob *g1, Grob *g2);
158 static bool pure_vertical_less (Grob *g1, Grob *g2);
159 static int get_vertical_axis_group_index (Grob *g);
162 virtual Interval_t<int> spanned_rank_interval () const;
163 virtual bool pure_is_visible (int start, int end) const;
164 bool check_cross_staff (Grob *common);
165 static bool less (Grob *g1, Grob *g2);
166 static SCM maybe_pure_internal_simple_skylines_from_extents (Grob *, Axis, bool, int, int, bool, bool);
167 static SCM internal_skylines_from_element_stencils (SCM, Axis);
171 DECLARE_UNSMOB (Grob, grob);
172 Spanner *unsmob_spanner (SCM);
173 Item *unsmob_item (SCM);
176 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
177 Grob *common_refpoint_of_array (vector<Grob *> const &, Grob *, Axis a);
178 Grob *common_refpoint_of_array (set<Grob *> const &, Grob *, Axis a);
179 System *get_root_system (Grob *me);
182 Interval robust_relative_extent (Grob *, Grob *, Axis);
184 /* offset/extent callbacks. */
185 void add_offset_callback (Grob *g, SCM proc, Axis a);
186 void chain_offset_callback (Grob *g, SCM proc, Axis a);
187 void chain_callback (Grob *g, SCM proc, SCM sym);
188 SCM axis_offset_symbol (Axis a);
189 SCM axis_parent_positioning (Axis a);
191 SCM call_pure_function (SCM unpure, SCM args, int start, int end);
193 void set_nested_property (Grob *, SCM property_path, SCM value);