2 grob.hh -- declare Grob
4 source file of the LilyPond music typesetter
6 (c) 1996--2007 Han-Wen Nienhuys
13 #include "virtual-methods.hh"
14 #include "dimension-cache.hh"
15 #include "grob-interface.hh"
21 DECLARE_CLASSNAME(Grob);
27 Dimension_cache dim_cache_[NO_AXES];
32 SCM immutable_property_alist_;
33 SCM mutable_property_alist_;
37 If this is a property, it accounts for 25% of the property
42 void substitute_object_links (SCM, SCM);
43 Real get_offset (Axis a) const;
44 SCM try_callback (SCM, SCM);
45 SCM try_callback_on_alist (SCM *, SCM, SCM);
46 void internal_set_value_on_alist (SCM *alist, SCM sym, SCM val);
53 friend SCM ly_grob_properties (SCM);
54 friend SCM ly_grob_basic_properties (SCM);
56 /* standard callbacks */
57 DECLARE_SCHEME_CALLBACK(x_parent_positioning, (SCM));
58 DECLARE_SCHEME_CALLBACK(y_parent_positioning, (SCM));
59 DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob));
60 DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob));
63 Output_def *layout () const { return layout_; }
64 Grob *original () const { return original_; }
65 SCM interfaces () const { return interfaces_; }
68 Grob (SCM basic_props);
70 virtual Grob *clone () const;
74 bool is_live () const;
80 SCM get_property_alist_chain (SCM) const;
81 SCM internal_get_property (SCM symbol) const;
82 SCM internal_get_property_data (SCM symbol) const;
83 SCM internal_get_non_callback_marker_property_data (SCM symbol) const;
84 SCM internal_get_object (SCM symbol) const;
85 void internal_set_object (SCM sym, SCM val);
86 void internal_del_property (SCM symbol);
89 void internal_set_property (SCM sym, SCM val, char const *file, int line, char const *fun);
91 void internal_set_property (SCM sym, SCM val);
95 void warning (string) const;
96 void programming_error (string) const;
100 virtual System *get_system () const;
101 virtual void do_break_processing ();
102 virtual Grob *find_broken_piece (System *) const;
103 virtual void discretionary_processing ();
104 virtual void derived_mark () const;
105 virtual void handle_broken_dependencies ();
106 virtual void handle_prebroken_dependencies ();
109 Stencil *get_stencil () const;
110 Stencil get_print_stencil () const;
113 bool internal_has_interface (SCM intf);
114 DECLARE_GROB_INTERFACE();
117 void translate_axis (Real, Axis);
118 Real relative_coordinate (Grob const *refp, Axis) const;
119 Real pure_relative_y_coordinate (Grob const *refp, int start, int end);
120 Real maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end);
123 Interval extent (Grob *refpoint, Axis) const;
124 void flush_extent_cache (Axis);
125 Interval pure_height (Grob *refpoint, int start_col, int end_col);
126 Interval maybe_pure_extent (Grob *refpoint, Axis, bool pure, int start, int end);
129 Grob *common_refpoint (Grob const *s, Axis a) const;
130 void set_parent (Grob *e, Axis);
131 Grob *get_parent (Axis a) const;
132 void fixup_refpoint ();
134 virtual Interval_t<int> spanned_rank_iv ();
138 DECLARE_UNSMOB (Grob, grob);
139 Spanner *unsmob_spanner (SCM);
140 Item *unsmob_item (SCM);
143 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
144 Grob *common_refpoint_of_array (vector<Grob*> const &, Grob *, Axis a);
145 System *get_root_system (Grob *me);
148 Interval robust_relative_extent (Grob *, Grob *, Axis);
150 /* offset/extent callbacks. */
151 void add_offset_callback (Grob *g, SCM proc, Axis a);
152 void chain_offset_callback (Grob *g, SCM proc, Axis a);
153 SCM axis_offset_symbol (Axis a);
154 SCM axis_parent_positioning (Axis a);
156 SCM call_pure_function (SCM unpure, SCM args, int start, int end);