X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fgrob.hh;h=db082f8665f7d2e3abf33ef1678d9d3b7cf6eec8;hb=ffdee1080342bdf4042993775f685986f1a5a77b;hp=792cdf8f9e36375db413d0431e91bc1ef02bc7a6;hpb=95692a1ccc0f222354e08743ef3271f24528b2bf;p=lilypond.git diff --git a/lily/include/grob.hh b/lily/include/grob.hh index 792cdf8f9e..db082f8665 100644 --- a/lily/include/grob.hh +++ b/lily/include/grob.hh @@ -1,26 +1,24 @@ /* grob.hh -- declare Grob - (c) 1996-1999--2002 Han-Wen Nienhuys + source file of the LilyPond music typesetter + + (c) 1996--2004 Han-Wen Nienhuys */ -#ifndef STAFFELEM_HH -#define STAFFELEM_HH +#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 - */ + for administration of what was done already +*/ enum Grob_status { - ORPHAN=0, // not yet added to Paper_score - VIRGIN, + ORPHAN = 0, // not yet added to Paper_score PRECALCING, PRECALCED, // calcs before spacing done POSTCALCING, // busy calculating. This is used to trap cyclic deps. @@ -29,161 +27,121 @@ enum Grob_status { typedef void (Grob::*Grob_method_pointer) (void); +// looking at gtk+/pango docstrings .. WIP -#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) - -/* - Basic output object. -*/ -class Grob { -public: +/** + * 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_; - Grob *original_l_; - - /** - Administration: Where are we?. This is mainly used by Super_element and - Grob::calcalute_dependencies () - - 0 means ORPHAN, - */ - char status_c_; + /* BARF */ + friend class Spanner; + 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_; + /* TODO: junk this member. */ + Paper_score *pscore_; - /* - 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_; Dimension_cache dim_cache_[NO_AXES]; - Grob (SCM basic_props); - Grob (Grob const&); + Grob (SCM basic_props, Object_key const *); + Grob (Grob const&, int copy_count); + + virtual Grob *clone (int count) const; + DECLARE_SCHEME_CALLBACK (stencil_extent, (SCM smob, SCM axis)); + String name () const; - /* - properties + Properties */ - SCM internal_get_grob_property (SCM) const; - void internal_set_grob_property (SCM, SCM val); - - void warning (String)const; - void programming_error (String)const; - - void set_elt_pointer (const char*, SCM val); - friend class Property_engraver; // UGHUGHUGH. - SCM remove_grob_property (const char* nm); + SCM internal_get_property (SCM) const; + void internal_set_property (SCM, SCM val); + void add_to_list_property (SCM, SCM); - /* - related classes. - */ - Paper_def *paper_l () const; + SCM get_property_alist_chain (SCM) const; + static SCM ly_grob_set_property (SCM, SCM,SCM); + static SCM ly_grob_property (SCM, SCM); - /** - add a dependency. It may be the 0 pointer, in which case, it is ignored. - */ + void warning (String) const; + void programming_error (String) const; + + Output_def *get_layout () const; void add_dependency (Grob*); - virtual System * line_l () const; - bool linked_b () const; - + virtual System *get_system () 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 (); + virtual SCM do_derived_mark () const; + + Stencil *get_stencil () const; + SCM get_uncached_stencil () const; - Molecule * get_molecule () const; - SCM get_uncached_molecule () const; - void suicide (); + bool is_live () const; + bool is_empty (Axis a) 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); + static bool has_interface (Grob *me); virtual void handle_broken_dependencies (); virtual void handle_prebroken_dependencies (); - - DECLARE_SMOBS (Grob,foo); - - void init (); - - -public: - - bool empty_b (Axis a) const; - Interval extent (Grob * refpoint, Axis) const; - /** - translate in one direction - */ - void translate_axis (Real, Axis); - - /** - 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; - + 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_b (SCM callback, Axis)const; + bool has_offset_callback (SCM callback, Axis) const; void add_offset_callback (SCM callback, Axis); - bool has_extent_callback_b (SCM, Axis)const; - void set_extent (SCM , Axis); - - - /** - Invoke callbacks to get offset relative to parent. - */ + bool has_extent_callback (SCM, Axis) const; + void set_extent (SCM, Axis); 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_; } + 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); + +void set_break_subsititution (SCM criterion); +SCM substitute_mutable_property_alist (SCM alist); -Grob*common_refpoint_of_list (SCM elt_list, Grob * , Axis a); -Grob*common_refpoint_of_array (Link_array const&, Grob * , Axis a); +Link_array ly_scm2grobs (SCM ell); +SCM ly_grobs2scm (Link_array a); -#endif // STAFFELEM_HH +Interval robust_relative_extent (Grob*, Grob*, Axis); +#endif /* GROB_HH */