X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fgrob.hh;h=9f46a06e1d87d2903bdc15696017ddbaa675a32b;hb=26380ed75fbd7b32781715c043dfa5dd96dfbe4a;hp=fba4a8eaad15bb0f311b6edff9a70afaeea38fab;hpb=3af3f5e7d2e061c90556e7ec056dbb141d64e2ae;p=lilypond.git diff --git a/lily/include/grob.hh b/lily/include/grob.hh index fba4a8eaad..9f46a06e1d 100644 --- a/lily/include/grob.hh +++ b/lily/include/grob.hh @@ -2,166 +2,148 @@ grob.hh -- declare Grob source file of the LilyPond music typesetter - - (c) 1996--2004 Han-Wen Nienhuys + + (c) 1996--2005 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 -}; + 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); +typedef void (Grob:: *Grob_method_pointer) (void); +// looking at gtk+/pango docstrings .. WIP -/* Basic G[raphical output] O[bject]. */ +/** + * Grob: + * @internal_get_property: get property #NAME. + * + * Class structure for #Grob. + **/ class Grob { +private: + DECLARE_SMOBS (Grob, foo); + void init (); protected: + Object_key const *key_; SCM immutable_property_alist_; SCM mutable_property_alist_; + + /* BARF */ friend class Spanner; - - void substitute_mutable_properties(SCM,SCM); + friend SCM ly_grob_properties (SCM); + friend SCM ly_grob_basic_properties (SCM); + + void substitute_mutable_properties (SCM, SCM); + char status_; public: + Object_key const *get_key () const; + Grob *original_; - /** - Administration: Where are we?. This is mainly used by Super_element and - Grob::calcalute_dependencies () + /* TODO: junk this member. */ + Paper_score *pscore_; - 0 means ORPHAN, - */ - char status_; + Dimension_cache dim_cache_[NO_AXES]; + Grob (SCM basic_props, Object_key const *); + Grob (Grob const &, int copy_count); - /* - 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]; + virtual Grob *clone (int count) const; + DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis)); - Grob (SCM basic_props); - Grob (Grob const&); - VIRTUAL_COPY_CONSTRUCTOR(Grob,Grob); - String name () const; - /* - properties - */ + 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; - - 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; - - /** - 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. - - #funcptr# is the function to call to update this element. - */ - void calculate_dependencies (int final, int busy, SCM funcname); + 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; + + void calculate_dependencies (int final, int busy, SCM funcname); 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; + 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 is_live () const; + bool is_empty (Axis a) const; bool internal_has_interface (SCM intf); - static bool has_interface (Grob*me); + static bool has_interface (Grob *me); virtual void handle_broken_dependencies (); virtual void handle_prebroken_dependencies (); - DECLARE_SMOBS (Grob,foo); + Interval extent (Grob *refpoint, Axis) const; - void init (); -public: - bool is_empty (Axis a) const; - - Interval extent (Grob * refpoint, Axis) const; - 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; + Grob *common_refpoint (Grob const *s, Axis a) const; // duh. slim down interface here. (todo) - bool has_offset_callback (SCM callback, Axis)const; + 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); + bool has_extent_callback (SCM, Axis) const; + void flush_extent_cache (Axis); + void set_extent (SCM, Axis); + void set_extent_callback (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_; } + + void set_parent (Grob *e, Axis); + + // URG + Grob *get_parent (Axis a) const; DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM)); }; -DECLARE_UNSMOB(Grob,grob); -Spanner* unsmob_spanner (SCM ); -Item* unsmob_item (SCM ); +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); +Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a); +Grob *common_refpoint_of_array (Link_array const &, Grob *, Axis a); void set_break_subsititution (SCM criterion); SCM substitute_mutable_property_alist (SCM alist); -Link_array ly_scm2grobs (SCM l); +Link_array ly_scm2grobs (SCM ell); SCM ly_grobs2scm (Link_array a); -#endif /* GROB_HH */ +Interval robust_relative_extent (Grob *, Grob *, Axis); +#endif /* GROB_HH */