/*
grob.hh -- declare Grob
- (c) 1996-1999--2000 Han-Wen Nienhuys
+ source file of the LilyPond music typesetter
+
+ (c) 1996--2006 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"
+
+class Grob
+{
+private:
+ DECLARE_SMOBS (Grob, foo);
+ DECLARE_CLASSNAME(Grob);
+
+ void init ();
-/**
- 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);
+protected:
+ /* data */
+ Dimension_cache dim_cache_[NO_AXES];
+ Output_def *layout_;
+ Grob *original_;
+ Object_key const *key_;
-/*
- 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_i_;
- 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_;
+ If this is a property, it accounts for 25% of the property
+ lookups.
+ */
+ SCM interfaces_;
+
+ void substitute_object_links (SCM, SCM);
+ Real get_offset (Axis a) const;
+ SCM try_callback (SCM, SCM);
+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_; }
+ 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;
- Grob (SCM basic_props);
- Grob (Grob const&);
+ /* naming. */
+ string name () const;
- /*
- properties
- */
- SCM get_grob_property (const char*) const;
- SCM get_grob_property (SCM) const;
- void set_grob_property (const char * , SCM val);
- void set_immutable_grob_property (const char * , SCM val);
- void set_immutable_grob_property (SCM key, SCM val);
- void set_grob_property (SCM , SCM val);
- void set_elt_pointer (const char*, SCM val);
- friend class Property_engraver; // UGHUGHUGH.
- SCM remove_grob_property (const char* nm);
+ /* 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);
- /*
- 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 Line_of_score * line_l () const;
- bool linked_b () const;
-
-
- VIRTUAL_COPY_CONS(Grob);
-
- /**
- Recursively track all dependencies of this Grob. The
- status_i_ 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_smobs (SCM, SCM criterion);
+ /* 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 (Line_of_score*) const;
+ virtual Grob *find_broken_piece (System *) const;
virtual void discretionary_processing ();
- virtual SCM do_derived_mark ();
-
- Molecule * get_molecule () const;
- 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));
-
-
- static SCM ly_set_grob_property (SCM, SCM,SCM);
- static SCM ly_get_grob_property (SCM, SCM);
-
- bool has_interface (SCM intf);
- void set_interface (SCM intf);
-
+ 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 ();
+ /* interfaces */
+ bool internal_has_interface (SCM intf);
+ static bool has_interface (Grob *me);
- Dimension_cache dim_cache_[NO_AXES];
-
-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;
- /**
- 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;
- Grob*common_refpoint (SCM elt_list, 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_callback (SCM , Axis);
- bool has_extent_callback_b (Axis) const;
+ /* extents */
+ Interval extent (Grob *refpoint, Axis) const;
+ void flush_extent_cache (Axis);
-
- /**
- 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 *parent_l (Axis a) const;
- 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 ();
};
-Grob * unsmob_element (SCM);
+/* smob utilities */
+DECLARE_UNSMOB (Grob, grob);
+Spanner *unsmob_spanner (SCM);
+Item *unsmob_item (SCM);
+
+/* refpoints */
+Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
+Grob *common_refpoint_of_array (vector<Grob*> const &, Grob *, Axis a);
+System *get_root_system (Grob *me);
+
+/* extents */
+Interval robust_relative_extent (Grob *, Grob *, Axis);
+
+/* 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
+#endif /* GROB_HH */
projects / lilypond.git / blobdiff