2 grob.hh -- declare Grob
4 source file of the LilyPond music typesetter
6 (c) 1996--2005 Han-Wen Nienhuys
12 #include "virtual-methods.hh"
13 #include "dimension-cache.hh"
14 #include "grob-interface.hh"
15 #include "object-key.hh"
17 typedef void (Grob:: *Grob_method_pointer) (void);
22 DECLARE_SMOBS (Grob, foo);
26 Object_key const *key_;
27 SCM immutable_property_alist_;
28 SCM mutable_property_alist_;
30 SCM property_callbacks_;
33 If this is a property, it accounts for 25% of the property
40 friend SCM ly_grob_properties (SCM);
41 friend SCM ly_grob_basic_properties (SCM);
42 friend void check_interfaces_for_property (Grob const *, SCM);
43 void substitute_object_links (SCM, SCM);
46 DECLARE_CLASSNAME(Grob);
48 DECLARE_SCHEME_CALLBACK(same_axis_parent_positioning, (SCM, SCM));
49 DECLARE_SCHEME_CALLBACK(other_axis_parent_positioning, (SCM, SCM));
51 Object_key const *get_key () const;
55 /* TODO: junk this member. */
58 Dimension_cache dim_cache_[NO_AXES];
60 Grob (SCM basic_props, Object_key const *);
61 Grob (Grob const &, int copy_count);
63 virtual Grob *clone (int count) const;
64 DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis));
70 SCM internal_get_property (SCM symbol) const;
71 SCM get_property_data (SCM symbol) const;
72 SCM internal_get_object (SCM symbol) const;
74 void internal_set_property (SCM sym, SCM val);
75 void internal_set_object (SCM sym, SCM val);
77 SCM try_callback (SCM);
81 void add_to_list_property (SCM, SCM);
82 void add_to_object_list (SCM sym, SCM thing);
84 SCM get_property_alist_chain (SCM) const;
85 static SCM ly_grob_set_property (SCM, SCM, SCM);
86 static SCM ly_grob_property (SCM, SCM);
88 void warning (String) const;
89 void programming_error (String) const;
91 Output_def *get_layout () const;
92 void add_dependency (Grob *);
93 virtual System *get_system () const;
95 void calculate_dependencies (int final, int busy, SCM funcname);
97 virtual void do_break_processing ();
98 virtual Grob *find_broken_piece (System *) const;
99 virtual void discretionary_processing ();
100 virtual void derived_mark () const;
102 Stencil *get_stencil () const;
103 Stencil get_print_stencil () const;
106 bool is_live () const;
107 bool is_empty (Axis a) const;
109 bool internal_has_interface (SCM intf);
110 static bool has_interface (Grob *me);
112 virtual void handle_broken_dependencies ();
113 virtual void handle_prebroken_dependencies ();
115 Interval extent (Grob *refpoint, Axis) const;
117 void translate_axis (Real, Axis);
118 Real relative_coordinate (Grob const *refp, Axis) const;
119 Grob *common_refpoint (Grob const *s, Axis a) const;
121 // duh. slim down interface here. (todo)
122 bool has_offset_callback (SCM callback, Axis) const;
123 void add_offset_callback (SCM callback, Axis);
124 bool has_extent_callback (SCM, Axis) const;
125 void flush_extent_cache (Axis);
126 void set_extent (SCM, Axis);
127 void set_extent_callback (SCM, Axis);
128 Real get_offset (Axis a) const;
130 void set_parent (Grob *e, Axis);
133 Grob *get_parent (Axis a) const;
134 void fixup_refpoint ();
137 DECLARE_UNSMOB (Grob, grob);
138 Spanner *unsmob_spanner (SCM);
139 Item *unsmob_item (SCM);
141 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
142 Grob *common_refpoint_of_array (Link_array<Grob> const &, Grob *, Axis a);
144 void set_break_subsititution (SCM criterion);
145 SCM substitute_object_alist (SCM alist, SCM dest);
147 Link_array<Grob> ly_scm2grobs (SCM ell);
148 SCM ly_grobs2scm (Link_array<Grob> a);
150 Interval robust_relative_extent (Grob *, Grob *, Axis);