2 grob.hh -- declare Grob
4 source file of the LilyPond music typesetter
6 (c) 1996--2004 Han-Wen Nienhuys
13 #include "virtual-methods.hh"
14 #include "lily-guile.hh"
15 #include "lily-proto.hh"
17 #include "dimension-cache.hh"
18 #include "grob-interface.hh"
21 for administration of what was done already
24 ORPHAN=0, // not yet added to Paper_score
26 PRECALCED, // calcs before spacing done
27 POSTCALCING, // busy calculating. This is used to trap cyclic deps.
28 POSTCALCED, // after spacing calcs done
31 typedef void (Grob::*Grob_method_pointer) (void);
33 // looking at gtk+/pango docstrings .. WIP
37 * @internal_get_property: get property #NAME.
39 * Class structure for #Grob.
44 DECLARE_SMOBS (Grob, foo);
48 SCM immutable_property_alist_;
49 SCM mutable_property_alist_;
53 friend SCM ly_grob_properties (SCM);
54 friend SCM ly_grob_basic_properties (SCM);
56 void substitute_mutable_properties (SCM, SCM);
62 /* TODO: junk this member. */
65 Dimension_cache dim_cache_[NO_AXES];
67 Grob (SCM basic_props);
69 VIRTUAL_COPY_CONSTRUCTOR (Grob, Grob);
70 DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis));
78 SCM internal_get_property (SCM) const;
79 void internal_set_property (SCM, SCM val);
80 void add_to_list_property (SCM, SCM);
82 SCM get_property_alist_chain (SCM) const;
83 static SCM ly_grob_set_property (SCM, SCM,SCM);
84 static SCM ly_grob_property (SCM, SCM);
86 void warning (String) const;
87 void programming_error (String) const;
89 Output_def *get_paper () const;
90 void add_dependency (Grob*);
91 virtual System *get_system () const;
93 void calculate_dependencies (int final, int busy, SCM funcname);
96 virtual void do_break_processing ();
97 virtual Grob *find_broken_piece (System*) const;
98 virtual void discretionary_processing ();
99 virtual SCM do_derived_mark () const;
101 Stencil *get_stencil () const;
102 SCM get_uncached_stencil () const;
105 bool is_live () const;
106 bool is_empty (Axis a) const;
108 bool internal_has_interface (SCM intf);
109 static bool has_interface (Grob *me);
111 virtual void handle_broken_dependencies ();
112 virtual void handle_prebroken_dependencies ();
114 Interval extent (Grob * refpoint, Axis) const;
116 void translate_axis (Real, Axis);
117 Real relative_coordinate (Grob const *refp, Axis) const;
118 Grob *common_refpoint (Grob const *s, Axis a) const;
120 // duh. slim down interface here. (todo)
121 bool has_offset_callback (SCM callback, Axis) const;
122 void add_offset_callback (SCM callback, Axis);
123 bool has_extent_callback (SCM, Axis) const;
124 void set_extent (SCM, Axis);
125 Real get_offset (Axis a) const;
127 void set_parent (Grob* e, Axis);
130 Grob *get_parent (Axis a) const
132 return dim_cache_[a].parent_;
135 DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM));
138 DECLARE_UNSMOB (Grob, grob);
139 Spanner *unsmob_spanner (SCM);
140 Item *unsmob_item (SCM);
142 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
143 Grob *common_refpoint_of_array (Link_array<Grob> const&, Grob *, Axis a);
145 void set_break_subsititution (SCM criterion);
146 SCM substitute_mutable_property_alist (SCM alist);
148 Link_array<Grob> ly_scm2grobs (SCM ell);
149 SCM ly_grobs2scm (Link_array<Grob> a);