2 grob.hh -- declare Grob
4 source file of the LilyPond music typesetter
6 (c) 1996--2006 Han-Wen Nienhuys
13 #include "virtual-methods.hh"
14 #include "dimension-cache.hh"
15 #include "grob-interface.hh"
16 #include "object-key.hh"
22 DECLARE_CLASSNAME(Grob);
28 Dimension_cache dim_cache_[NO_AXES];
31 Object_key const *key_;
34 SCM immutable_property_alist_;
35 SCM mutable_property_alist_;
39 If this is a property, it accounts for 25% of the property
44 void substitute_object_links (SCM, SCM);
45 Real get_offset (Axis a) const;
46 SCM try_callback (SCM, SCM);
47 SCM try_callback_on_alist (SCM *, SCM, SCM);
48 void internal_set_value_on_alist (SCM *alist, SCM sym, SCM val);
55 friend SCM ly_grob_properties (SCM);
56 friend SCM ly_grob_basic_properties (SCM);
58 /* standard callbacks */
59 DECLARE_SCHEME_CALLBACK(x_parent_positioning, (SCM));
60 DECLARE_SCHEME_CALLBACK(y_parent_positioning, (SCM));
61 DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob));
62 DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob));
65 Output_def *layout () const { return layout_; }
66 Grob *original () const { return original_; }
67 SCM interfaces () const { return interfaces_; }
68 Object_key const *key () const { return key_; }
71 Grob (SCM basic_props, Object_key const *);
72 Grob (Grob const &, int copy_count);
73 virtual Grob *clone (int count) const;
77 bool is_live () const;
83 SCM get_property_alist_chain (SCM) const;
84 SCM internal_get_property (SCM symbol) const;
85 SCM internal_get_property_data (SCM symbol) const;
86 SCM internal_get_object (SCM symbol) const;
87 void internal_set_object (SCM sym, SCM val);
88 void internal_del_property (SCM symbol);
91 void internal_set_property (SCM sym, SCM val, char const *file, int line, char const *fun);
93 void internal_set_property (SCM sym, SCM val);
97 void warning (string) const;
98 void programming_error (string) const;
101 /* class hierarchy */
102 virtual System *get_system () const;
103 virtual void do_break_processing ();
104 virtual Grob *find_broken_piece (System *) const;
105 virtual void discretionary_processing ();
106 virtual void derived_mark () const;
107 virtual void handle_broken_dependencies ();
108 virtual void handle_prebroken_dependencies ();
111 Stencil *get_stencil () const;
112 Stencil get_print_stencil () const;
115 bool internal_has_interface (SCM intf);
116 DECLARE_GROB_INTERFACE();
119 void translate_axis (Real, Axis);
120 Real relative_coordinate (Grob const *refp, Axis) const;
121 Real pure_relative_y_coordinate (Grob const *refp, int start, int end);
122 Real maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end);
125 Interval extent (Grob *refpoint, Axis) const;
126 void flush_extent_cache (Axis);
127 Interval pure_height (Grob *refpoint, int start_col, int end_col);
128 Interval maybe_pure_extent (Grob *refpoint, Axis, bool pure, int start, int end);
131 Grob *common_refpoint (Grob const *s, Axis a) const;
132 void set_parent (Grob *e, Axis);
133 Grob *get_parent (Axis a) const;
134 void fixup_refpoint ();
136 virtual Interval_t<int> spanned_rank_iv ();
140 DECLARE_UNSMOB (Grob, grob);
141 Spanner *unsmob_spanner (SCM);
142 Item *unsmob_item (SCM);
145 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
146 Grob *common_refpoint_of_array (vector<Grob*> const &, Grob *, Axis a);
147 System *get_root_system (Grob *me);
150 Interval robust_relative_extent (Grob *, Grob *, Axis);
152 /* offset/extent callbacks. */
153 void add_offset_callback (Grob *g, SCM proc, Axis a);
154 void chain_offset_callback (Grob *g, SCM proc, Axis a);
155 SCM axis_offset_symbol (Axis a);
156 SCM axis_parent_positioning (Axis a);
158 SCM call_pure_function (SCM unpure, SCM args, int start, int end);