X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fgrob.hh;h=f8c8a04daeaff8ccbf2a03b230e1a8fdfb0513e1;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=c4d09fec84cd2ef92afdfc43a30a5062dc973af0;hpb=f79e161e5f81421337a4f459eb8f8a6978abf9fb;p=lilypond.git diff --git a/lily/include/grob.hh b/lily/include/grob.hh index c4d09fec84..f8c8a04dae 100644 --- a/lily/include/grob.hh +++ b/lily/include/grob.hh @@ -2,152 +2,156 @@ grob.hh -- declare Grob source file of the LilyPond music typesetter - - (c) 1996--2004 Han-Wen Nienhuys + + (c) 1996--2008 Han-Wen Nienhuys */ #ifndef GROB_HH #define GROB_HH -#include "parray.hh" +#include "box.hh" #include "virtual-methods.hh" -#include "lily-guile.hh" -#include "lily-proto.hh" -#include "smobs.hh" #include "dimension-cache.hh" #include "grob-interface.hh" -/** - for administration of what was done already - */ -enum Grob_status { - ORPHAN=0, // not yet added to Paper_score - PRECALCING, - PRECALCED, // calcs before spacing done - POSTCALCING, // busy calculating. This is used to trap cyclic deps. - POSTCALCED, // after spacing calcs done -}; - -typedef void (Grob::*Grob_method_pointer) (void); - -// looking at gtk+/pango docstrings .. WIP - -/** - * Grob: - * @internal_get_property: get property #NAME. - * - * Class structure for #Grob. - **/ class Grob { -private: - DECLARE_SMOBS (Grob, foo); +private: + DECLARE_SMOBS (Grob); + DECLARE_CLASSNAME(Grob); + void init (); protected: + /* data */ + Dimension_cache dim_cache_[NO_AXES]; + Output_def *layout_; + Grob *original_; + + /* SCM data */ SCM immutable_property_alist_; SCM mutable_property_alist_; + SCM object_alist_; - /* BARF */ + /* + If this is a property, it accounts for 25% of the property + lookups. + */ + SCM interfaces_; + + void substitute_object_links (SCM, SCM); + Real get_offset (Axis a) const; + SCM try_callback (SCM, SCM); + SCM try_callback_on_alist (SCM *, SCM, SCM); + void internal_set_value_on_alist (SCM *alist, SCM sym, SCM val); + +public: + + /* friends */ friend class Spanner; + friend class System; friend SCM ly_grob_properties (SCM); friend SCM ly_grob_basic_properties (SCM); - - void substitute_mutable_properties (SCM, SCM); - char status_; - -public: - Grob *original_; - /* TODO: junk this member. */ - Paper_score *pscore_; + /* standard callbacks */ + DECLARE_SCHEME_CALLBACK(x_parent_positioning, (SCM)); + DECLARE_SCHEME_CALLBACK(y_parent_positioning, (SCM)); + DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob)); + DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob)); - Dimension_cache dim_cache_[NO_AXES]; + /* R/O access */ + Output_def *layout () const { return layout_; } + Grob *original () const { return original_; } + SCM interfaces () const { return interfaces_; } + /* life & death */ Grob (SCM basic_props); - Grob (Grob const&); - VIRTUAL_COPY_CONSTRUCTOR (Grob, Grob); - DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis)); - - String name () const; + Grob (Grob const &); + virtual Grob *clone () const; + /* forced death */ + void suicide (); + bool is_live () const; - /* - Properties - */ - SCM internal_get_property (SCM) const; - void internal_set_property (SCM, SCM val); - void add_to_list_property (SCM, SCM); + /* naming. */ + string name () const; + /* Properties */ SCM get_property_alist_chain (SCM) const; - static SCM ly_grob_set_property (SCM, SCM,SCM); - static SCM ly_grob_property (SCM, SCM); - - void warning (String) const; - void programming_error (String) const; - - Output_def *get_layout () const; - void add_dependency (Grob*); - virtual System *get_system () const; + SCM internal_get_property (SCM symbol) const; + SCM internal_get_property_data (SCM symbol) const; + SCM internal_get_non_callback_marker_property_data (SCM symbol) const; + SCM internal_get_object (SCM symbol) const; + void internal_set_object (SCM sym, SCM val); + void internal_del_property (SCM symbol); + void instrumented_set_property (SCM, SCM, char const*, int, char const*); + void internal_set_property (SCM sym, SCM val); - void calculate_dependencies (int final, int busy, SCM funcname); + /* messages */ + void warning (string) const; + void programming_error (string) const; + /* class hierarchy */ + virtual System *get_system () const; virtual void do_break_processing (); - virtual Grob *find_broken_piece (System*) const; + virtual Grob *find_broken_piece (System *) const; virtual void discretionary_processing (); - virtual SCM do_derived_mark () const; + virtual void derived_mark () const; + virtual void handle_broken_dependencies (); + virtual void handle_prebroken_dependencies (); + /* printing */ Stencil *get_stencil () const; - SCM get_uncached_stencil () const; + Stencil get_print_stencil () const; - void suicide (); - bool is_live () const; - bool is_empty (Axis a) const; - + /* interfaces */ bool internal_has_interface (SCM intf); - static bool has_interface (Grob *me); - - virtual void handle_broken_dependencies (); - virtual void handle_prebroken_dependencies (); + DECLARE_GROB_INTERFACE(); - Interval extent (Grob * refpoint, Axis) const; - + /* offsets */ void translate_axis (Real, Axis); Real relative_coordinate (Grob const *refp, Axis) const; - Grob *common_refpoint (Grob const *s, Axis a) const; + Real pure_relative_y_coordinate (Grob const *refp, int start, int end); + Real maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end); - // duh. slim down interface here. (todo) - bool has_offset_callback (SCM callback, Axis) const; - void add_offset_callback (SCM callback, Axis); - bool has_extent_callback (SCM, Axis) const; - void set_extent (SCM, Axis); - Real get_offset (Axis a) const; - - void set_parent (Grob* e, Axis); + /* extents */ + Interval extent (Grob *refpoint, Axis) const; + void flush_extent_cache (Axis); + virtual Interval pure_height (Grob *refpoint, int start_col, int end_col); + Interval maybe_pure_extent (Grob *refpoint, Axis, bool pure, int start, int end); - // URG - Grob *get_parent (Axis a) const - { - return dim_cache_[a].parent_; - } + /* refpoints */ + Grob *common_refpoint (Grob const *s, Axis a) const; + void set_parent (Grob *e, Axis); + Grob *get_parent (Axis a) const; + void fixup_refpoint (); - DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM)); + virtual Interval_t spanned_rank_interval () const; }; +/* smob utilities */ DECLARE_UNSMOB (Grob, grob); Spanner *unsmob_spanner (SCM); Item *unsmob_item (SCM); +/* refpoints */ Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a); -Grob *common_refpoint_of_array (Link_array const&, Grob *, Axis a); +Grob *common_refpoint_of_array (vector const &, Grob *, Axis a); +System *get_root_system (Grob *me); + +/* extents */ +Interval robust_relative_extent (Grob *, Grob *, Axis); -void set_break_subsititution (SCM criterion); -SCM substitute_mutable_property_alist (SCM alist); +/* offset/extent callbacks. */ +void add_offset_callback (Grob *g, SCM proc, Axis a); +void chain_offset_callback (Grob *g, SCM proc, Axis a); +void chain_callback (Grob *g, SCM proc, SCM sym); +SCM axis_offset_symbol (Axis a); +SCM axis_parent_positioning (Axis a); -Link_array ly_scm2grobs (SCM ell); -SCM ly_grobs2scm (Link_array a); +SCM call_pure_function (SCM unpure, SCM args, int start, int end); -Interval robust_relative_extent (Grob*, Grob*, Axis); +void set_nested_property (Grob *, SCM property_path, SCM value); #endif /* GROB_HH */