X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fgrob.hh;h=f0191e3e446570b1db9c4ebd55b8f9756c4e444e;hb=f287d7846e9d5f2de14894cd655b2f84341c4a2c;hp=ba7a7b8a0da8ee564c9f15864ecc0da1ee1d715f;hpb=664070d837cc4855091455892cb942cdcedeef0c;p=lilypond.git diff --git a/lily/include/grob.hh b/lily/include/grob.hh index ba7a7b8a0d..f0191e3e44 100644 --- a/lily/include/grob.hh +++ b/lily/include/grob.hh @@ -2,166 +2,156 @@ grob.hh -- declare Grob source file of the LilyPond music typesetter - - (c) 1996--2004 Han-Wen Nienhuys + + (c) 1996--2007 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 - VIRGIN, - 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); - - -/* Basic G[raphical output] O[bject]. */ class Grob { -protected: - SCM immutable_property_alist_; - SCM mutable_property_alist_; - friend class Spanner; +private: + DECLARE_SMOBS (Grob); + DECLARE_CLASSNAME(Grob); - void substitute_mutable_properties(SCM,SCM); - -public: - Grob *original_; - - /** - Administration: Where are we?. This is mainly used by Super_element and - Grob::calcalute_dependencies () - - 0 means ORPHAN, - */ - char status_; - + void init (); - /* - IDEA: make this a global variable. This is the same for all - elements, I think it is safe to assume that we will not have - scores being formatted multithreadedly. - */ - Paper_score *pscore_; +protected: + /* data */ Dimension_cache dim_cache_[NO_AXES]; + Output_def *layout_; + Grob *original_; - Grob (SCM basic_props); - Grob (Grob const&); - VIRTUAL_COPY_CONSTRUCTOR(Grob,Grob); - - String name () const; + /* SCM data */ + SCM immutable_property_alist_; + SCM mutable_property_alist_; + SCM object_alist_; /* - properties - */ - SCM internal_get_property (SCM) const; - void internal_set_property (SCM, SCM val); - void add_to_list_property (SCM, SCM); - void warning (String)const; - void programming_error (String)const; + If this is a property, it accounts for 25% of the property + lookups. + */ + SCM interfaces_; - void set_elt_pointer (const char*, SCM val); - friend class Property_engraver; // UGHUGHUGH. - /* - related classes. - */ - Output_def *get_paper () const; - - /** - add a dependency. It may be the 0 pointer, in which case, it is ignored. - */ - void add_dependency (Grob*); - virtual System * get_system () const; + 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); - /** - Recursively track all dependencies of this Grob. The - status_ field is used as a mark-field. It is marked with - #busy# during execution of this function, and marked with #final# - when finished. +public: + + /* friends */ + friend class Spanner; + friend class System; + friend SCM ly_grob_properties (SCM); + friend SCM ly_grob_basic_properties (SCM); + + /* 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)); + + /* 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 Grob *clone () const; - #funcptr# is the function to call to update this element. - */ - void calculate_dependencies (int final, int busy, SCM funcname); + /* forced death */ + void suicide (); + bool is_live () const; + /* naming. */ + string name () const; + /* Properties */ + SCM get_property_alist_chain (SCM) 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); + + /* 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; - - Stencil * get_stencil () const; - SCM get_uncached_stencil () const; - - SCM get_property_alist_chain (SCM) const; - void suicide (); - bool live () const; - - DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis)); - - static SCM ly_grob_set_property (SCM, SCM,SCM); - static SCM ly_grob_property (SCM, SCM); - - bool internal_has_interface (SCM intf); - static bool has_interface (Grob*me); - + virtual void derived_mark () const; virtual void handle_broken_dependencies (); virtual void handle_prebroken_dependencies (); - DECLARE_SMOBS (Grob,foo); + /* printing */ + Stencil *get_stencil () const; + Stencil get_print_stencil () const; - void init (); -public: - bool is_empty (Axis a) const; + /* interfaces */ + bool internal_has_interface (SCM intf); + 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 relative_coordinate (Grob const *refp, Axis) 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); + + /* 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); + + /* 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 (); + + virtual Interval_t spanned_rank_interval () const; +}; +/* smob utilities */ +DECLARE_UNSMOB (Grob, grob); +Spanner *unsmob_spanner (SCM); +Item *unsmob_item (SCM); - // 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); - - Grob *get_parent (Axis a) const { return dim_cache_[a].parent_; } - DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM)); -}; +/* refpoints */ +Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a); +Grob *common_refpoint_of_array (vector const &, Grob *, Axis a); +System *get_root_system (Grob *me); -DECLARE_UNSMOB(Grob,grob); -Spanner* unsmob_spanner (SCM ); -Item* unsmob_item (SCM ); +/* extents */ +Interval robust_relative_extent (Grob *, Grob *, Axis); -Grob*common_refpoint_of_list (SCM elt_list, Grob * , Axis a); -Grob*common_refpoint_of_array (Link_array const&, Grob * , Axis a); +/* 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); -void set_break_subsititution (SCM criterion); -SCM substitute_mutable_property_alist (SCM alist); +SCM call_pure_function (SCM unpure, SCM args, int start, int end); -Link_array ly_scm2grobs (SCM l); -SCM ly_grobs2scm (Link_array a); +void set_nested_property (Grob *, SCM property_path, SCM value); #endif /* GROB_HH */ -