X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fgrob.hh;h=bcd101b98ed971859e7f8e28631e347d38a291c3;hb=f9214bac21e9926dc3248416f58190c98c4167a9;hp=083e34ec4635ea56e7609dc7c4162c812d7fabd4;hpb=667d9bdb6227dd10819599c6d069a5eeb67eedd7;p=lilypond.git diff --git a/lily/include/grob.hh b/lily/include/grob.hh index 083e34ec46..bcd101b98e 100644 --- a/lily/include/grob.hh +++ b/lily/include/grob.hh @@ -1,194 +1,152 @@ /* grob.hh -- declare Grob - (c) 1996-1999--2002 Han-Wen Nienhuys + source file of the LilyPond music typesetter + + (c) 1996--2007 Han-Wen Nienhuys */ -#ifndef STAFFELEM_HH -#define STAFFELEM_HH +#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); - +class Grob +{ +private: + DECLARE_SMOBS (Grob); + DECLARE_CLASSNAME(Grob); + + void init (); -#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) +protected: + /* data */ + Dimension_cache dim_cache_[NO_AXES]; + Output_def *layout_; + Grob *original_; -/* - Basic output object. -*/ -class Grob { -public: + /* SCM data */ SCM immutable_property_alist_; - - // rename me to ``property_alist_'' SCM mutable_property_alist_; + SCM object_alist_; - Grob *original_l_; - - /** - Administration: Where are we?. This is mainly used by Super_element and - Grob::calcalute_dependencies () - - 0 means ORPHAN, - */ - char status_c_; - String name () const; - - /* - 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_l_; - - Grob (SCM basic_props); - Grob (Grob const&); - /* - properties - */ - SCM internal_get_grob_property (SCM) const; - void internal_set_grob_property (SCM, SCM val); + If this is a property, it accounts for 25% of the property + lookups. + */ + SCM interfaces_; -#if 0 - void set_immutable_grob_property (const char * , SCM val); - void set_immutable_grob_property (SCM key, SCM val); -#endif + 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); - void warning (String); +public: - void set_elt_pointer (const char*, SCM val); - friend class Property_engraver; // UGHUGHUGH. - SCM remove_grob_property (const char* nm); - - /* - related classes. - */ - Paper_def *paper_l () const; - - /** - add a dependency. It may be the 0 pointer, in which case, it is ignored. - */ - void add_dependency (Grob*); - virtual System * line_l () const; - bool linked_b () const; - - - VIRTUAL_COPY_CONS (Grob); - - /** - Recursively track all dependencies of this Grob. The - status_c_ field is used as a mark-field. It is marked with - #busy# during execution of this function, and marked with #final# - when finished. - - #funcptr# is the function to call to update this element. - */ - void calculate_dependencies (int final, int busy, SCM funcname); - static SCM handle_broken_grobs(SCM, SCM criterion); - - virtual void do_break_processing (); - virtual Grob *find_broken_piece (System*) const; - virtual void discretionary_processing (); - virtual SCM do_derived_mark (); + /* 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; - Molecule * get_molecule () const; - SCM get_uncached_molecule () const; - + /* forced death */ void suicide (); - - 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)); + bool is_live () const; + /* naming. */ + string name () const; - static SCM ly_set_grob_property (SCM, SCM,SCM); - static SCM ly_get_grob_property (SCM, SCM); + /* 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_object (SCM symbol) const; + void internal_set_object (SCM sym, SCM val); + void internal_del_property (SCM symbol); + void internal_set_property (SCM sym, SCM val); + + /* messages */ + void warning (string) const; + void programming_error (string) const; - bool internal_has_interface (SCM intf); - static bool has_interface (Grob*me); + /* class hierarchy */ + virtual System *get_system () const; + virtual void do_break_processing (); + virtual Grob *find_broken_piece (System *) const; + virtual void discretionary_processing (); + virtual void derived_mark () const; virtual void handle_broken_dependencies (); virtual void handle_prebroken_dependencies (); + /* printing */ + Stencil *get_stencil () const; + Stencil get_print_stencil () const; - DECLARE_SMOBS (Grob,foo); - - void init (); - - Dimension_cache dim_cache_[NO_AXES]; + /* interfaces */ + bool internal_has_interface (SCM intf); + DECLARE_GROB_INTERFACE(); -public: - - bool empty_b (Axis a) const; - - Interval extent (Grob * refpoint, Axis) const; - - /** - translate in one direction - */ - + /* offsets */ void translate_axis (Real, Axis); + 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); + 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_iv (); +}; - /** - Find the offset relative to D. If D equals THIS, then it is 0. - Otherwise, it recursively defd as - - OFFSET_ + PARENT_L_->relative_coordinate (D) - */ - Real relative_coordinate (Grob const* refp, Axis) const; - /** - Find the group-element which has both #this# and #s# - */ - Grob*common_refpoint (Grob const* s, Axis a) const; - - - // 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); +/* smob utilities */ +DECLARE_UNSMOB (Grob, grob); +Spanner *unsmob_spanner (SCM); +Item *unsmob_item (SCM); - - /** - Invoke callbacks to get offset relative to parent. - */ - Real get_offset (Axis a) const; - /** - Set the parent refpoint of THIS to E - */ - void set_parent (Grob* e, Axis); - - Grob *get_parent (Axis a) const { return dim_cache_[a].parent_l_; } - 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); +SCM axis_offset_symbol (Axis a); +SCM axis_parent_positioning (Axis a); -#endif // STAFFELEM_HH +SCM call_pure_function (SCM unpure, SCM args, int start, int end); +#endif /* GROB_HH */