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"
19 ORPHAN = 0, // not yet added to Paper_score
21 PRECALCED, // calcs before spacing done
22 POSTCALCING, // busy calculating. This is used to trap cyclic deps.
23 POSTCALCED, // after spacing calcs done
26 typedef void (Grob:: *Grob_method_pointer) (void);
31 DECLARE_SMOBS (Grob, foo);
34 Object_key const *key_;
35 SCM immutable_property_alist_;
36 SCM mutable_property_alist_;
40 If this is a property, it accounts for 25% of the property
47 friend SCM ly_grob_properties (SCM);
48 friend SCM ly_grob_basic_properties (SCM);
49 friend void check_interfaces_for_property (Grob const *, SCM);
50 void substitute_object_links (SCM, SCM);
53 DECLARE_CLASSNAME(Grob);
55 Object_key const *get_key () const;
59 /* TODO: junk this member. */
62 Dimension_cache dim_cache_[NO_AXES];
64 Grob (SCM basic_props, Object_key const *);
65 Grob (Grob const &, int copy_count);
67 virtual Grob *clone (int count) const;
68 DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis));
74 SCM internal_get_property (SCM) const;
75 SCM internal_get_object (SCM) const;
77 void internal_set_property (SCM sym, SCM val);
78 void internal_set_object (SCM sym, SCM val);
83 void add_to_list_property (SCM, SCM);
84 void add_to_object_list (SCM sym, SCM thing);
86 SCM get_property_alist_chain (SCM) const;
87 static SCM ly_grob_set_property (SCM, SCM, SCM);
88 static SCM ly_grob_property (SCM, SCM);
90 void warning (String) const;
91 void programming_error (String) const;
93 Output_def *get_layout () const;
94 void add_dependency (Grob *);
95 virtual System *get_system () const;
97 void calculate_dependencies (int final, int busy, SCM funcname);
99 virtual void do_break_processing ();
100 virtual Grob *find_broken_piece (System *) const;
101 virtual void discretionary_processing ();
102 virtual void derived_mark () const;
104 Stencil *get_stencil () const;
105 SCM get_uncached_stencil () const;
108 bool is_live () const;
109 bool is_empty (Axis a) const;
111 bool internal_has_interface (SCM intf);
112 static bool has_interface (Grob *me);
114 virtual void handle_broken_dependencies ();
115 virtual void handle_prebroken_dependencies ();
117 Interval extent (Grob *refpoint, Axis) const;
119 void translate_axis (Real, Axis);
120 Real relative_coordinate (Grob const *refp, Axis) const;
121 Grob *common_refpoint (Grob const *s, Axis a) const;
123 // duh. slim down interface here. (todo)
124 bool has_offset_callback (SCM callback, Axis) const;
125 void add_offset_callback (SCM callback, Axis);
126 bool has_extent_callback (SCM, Axis) const;
127 void flush_extent_cache (Axis);
128 void set_extent (SCM, Axis);
129 void set_extent_callback (SCM, Axis);
130 Real get_offset (Axis a) const;
132 void set_parent (Grob *e, Axis);
135 Grob *get_parent (Axis a) const;
136 void fixup_refpoint ();
139 DECLARE_UNSMOB (Grob, grob);
140 Spanner *unsmob_spanner (SCM);
141 Item *unsmob_item (SCM);
143 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
144 Grob *common_refpoint_of_array (Link_array<Grob> const &, Grob *, Axis a);
146 void set_break_subsititution (SCM criterion);
147 SCM substitute_object_alist (SCM alist, SCM dest);
149 Link_array<Grob> ly_scm2grobs (SCM ell);
150 SCM ly_grobs2scm (Link_array<Grob> a);
152 Interval robust_relative_extent (Grob *, Grob *, Axis);