X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fgrob.hh;h=6c3ef612bd7a81c3526592c0a50baf31bd246a91;hb=9e752ec70a160d6c3d7632036de75630438c4142;hp=8d50bf135bf9b5a29d64843005b3e6bd2218d871;hpb=2745cbd907f8216a4cc1fc5f488ae19efdfdbd10;p=lilypond.git diff --git a/lily/include/grob.hh b/lily/include/grob.hh index 8d50bf135b..6c3ef612bd 100644 --- a/lily/include/grob.hh +++ b/lily/include/grob.hh @@ -2,173 +2,143 @@ grob.hh -- declare Grob source file of the LilyPond music typesetter - - (c) 1996--2003 Han-Wen Nienhuys + + (c) 1996--2006 Han-Wen Nienhuys */ #ifndef GROB_HH #define GROB_HH -#include "parray.hh" #include "virtual-methods.hh" -#include "lily-guile.hh" -#include "lily-proto.hh" -#include "smobs.hh" #include "dimension-cache.hh" #include "grob-interface.hh" +#include "object-key.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); - - -#define get_grob_property(x) internal_get_grob_property(ly_symbol2scm(x)) -#define set_grob_property(x,y) internal_set_grob_property(ly_symbol2scm(x),y) +class Grob +{ +private: + DECLARE_SMOBS (Grob, foo); + DECLARE_CLASSNAME(Grob); + + void init (); -/* - Basic output object. -*/ -class Grob { protected: + /* data */ + Dimension_cache dim_cache_[NO_AXES]; + Output_def *layout_; + Grob *original_; + Object_key const *key_; + + /* SCM data */ SCM immutable_property_alist_; SCM mutable_property_alist_; - friend class Spanner; + SCM object_alist_; - 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_; - - /* - 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_; - Dimension_cache dim_cache_[NO_AXES]; - - Grob (SCM basic_props); - Grob (Grob const&); - String name () const; + If this is a property, it accounts for 25% of the property + lookups. + */ + SCM interfaces_; - /* - properties - */ - SCM internal_get_grob_property (SCM) const; - void internal_set_grob_property (SCM, SCM val); - void add_to_list_property (SCM, SCM); - void warning (String)const; - void programming_error (String)const; + void substitute_object_links (SCM, SCM); + Real get_offset (Axis a) const; + SCM try_callback (SCM, SCM); +public: - void set_elt_pointer (const char*, SCM val); - friend class Property_engraver; // UGHUGHUGH. - /* - related classes. - */ - Paper_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; - bool linked_b () const; + /* 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_; } + Object_key const *key () const { return key_; } + + /* life & death */ + Grob (SCM basic_props, Object_key const *); + Grob (Grob const &, int copy_count); + virtual Grob *clone (int count) const; + + /* forced death */ + void suicide (); + bool is_live () const; + /* naming. */ + string name () const; - VIRTUAL_COPY_CONS (Grob); - - /** - 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. + /* Properties */ + SCM get_property_alist_chain (SCM) const; + SCM internal_get_property (SCM symbol) const; + SCM get_property_data (SCM symbol) const; + SCM internal_get_object (SCM symbol) const; + void del_property (SCM symbol); + void internal_set_property (SCM sym, SCM val); + void internal_set_object (SCM sym, SCM val); - #funcptr# is the function to call to update this element. - */ - 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; - - Molecule * get_molecule () const; - SCM get_uncached_molecule () const; - - SCM get_property_alist_chain (SCM) const; - void suicide (); - bool live () const; - - DECLARE_SCHEME_CALLBACK (preset_extent, (SCM smob, SCM axis)); - DECLARE_SCHEME_CALLBACK (point_dimension_callback, (SCM smob, SCM axis)); - DECLARE_SCHEME_CALLBACK (molecule_extent, (SCM smob, SCM axis)); - - static SCM ly_set_grob_property (SCM, SCM,SCM); - static SCM ly_get_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 empty_b (Axis a) const; + /* interfaces */ + bool internal_has_interface (SCM intf); + static bool has_interface (Grob *me); - 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; + /* extents */ + Interval extent (Grob *refpoint, Axis) const; + void flush_extent_cache (Axis); - // duh. slim down interface here. (todo) - bool has_offset_callback_b (SCM callback, Axis)const; - void add_offset_callback (SCM callback, Axis); - bool has_extent_callback_b (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 (Grob const *s, Axis a) const; + void set_parent (Grob *e, Axis); + Grob *get_parent (Axis a) const; + void fixup_refpoint (); }; -DECLARE_UNSMOB(Grob,grob); -Spanner* unsmob_spanner (SCM ); -Item* unsmob_item (SCM ); +/* smob utilities */ +DECLARE_UNSMOB (Grob, grob); +Spanner *unsmob_spanner (SCM); +Item *unsmob_item (SCM); -Grob*common_refpoint_of_list (SCM elt_list, Grob * , Axis a); -Grob*common_refpoint_of_array (Link_array const&, Grob * , Axis a); +/* 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); -void set_break_subsititution (SCM criterion); -SCM substitute_mutable_property_alist (SCM alist); +/* extents */ +Interval robust_relative_extent (Grob *, Grob *, Axis); -Link_array ly_scm2grobs (SCM l); -SCM ly_grobs2scm (Link_array a); +/* offset/extent callbacks. */ +void add_offset_callback (Grob *g, SCM proc, Axis a); +void chain_offset_callback (Grob *g, SCM proc, Axis a); +SCM axis_offset_symbol (Axis a); +SCM axis_parent_positioning (Axis a); -#endif /* GROB_HH */ +#endif /* GROB_HH */