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
- 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);
-/* Basic G[raphical output] O[bject]. */
class Grob
{
+private:
+ DECLARE_SMOBS (Grob, foo);
+ void init ();
+
protected:
+ Object_key const *key_;
SCM immutable_property_alist_;
SCM mutable_property_alist_;
- friend class Spanner;
+ SCM object_alist_;
- void substitute_mutable_properties(SCM,SCM);
- char status_;
+ /*
+ If this is a property, it accounts for 25% of the property
+ lookups.
+ */
+ SCM interfaces_;
+
+ /* BARF */
+ friend class Spanner;
+ friend SCM ly_grob_properties (SCM);
+ friend SCM ly_grob_basic_properties (SCM);
+ friend void check_interfaces_for_property (Grob const *, SCM);
+ void substitute_object_links (SCM, SCM);
+
+ DECLARE_CLASSNAME(Grob);
+ Real get_offset (Axis a) const;
public:
+ DECLARE_SCHEME_CALLBACK(same_axis_parent_positioning, (SCM, SCM));
+ DECLARE_SCHEME_CALLBACK(other_axis_parent_positioning, (SCM, SCM));
+
+ Object_key const *get_key () const;
+
Grob *original_;
- /*
- TODO: junk this member.
- */
+ /* TODO: junk this member. */
Paper_score *pscore_;
+
Dimension_cache dim_cache_[NO_AXES];
- Grob (SCM basic_props);
- Grob (Grob const&);
- VIRTUAL_COPY_CONSTRUCTOR(Grob,Grob);
-
- String name () const;
+ Grob (SCM basic_props, Object_key const *);
+ Grob (Grob const &, int copy_count);
+
+ virtual Grob *clone (int count) const;
+ static SCM stencil_extent (Grob*, Axis);
+ DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob));
+
+ String name () const;
/*
- 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;
-
- Output_def *get_paper () const;
- void add_dependency (Grob*);
- virtual System *get_system () const;
+ Properties
+ */
+ 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);
- void calculate_dependencies (int final, int busy, SCM funcname);
+ SCM try_callback (SCM, SCM);
+
+ 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;
+ 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;
+ virtual void derived_mark () const;
- Stencil * get_stencil () const;
- SCM get_uncached_stencil () const;
+ Stencil *get_stencil () const;
+ Stencil get_print_stencil () const;
- SCM get_property_alist_chain (SCM) const;
void suicide ();
bool is_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 internal_has_interface (SCM intf);
- static bool has_interface (Grob*me);
-
+ static bool has_interface (Grob *me);
+ SCM get_interfaces () const;
+
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);
- Real get_offset (Axis a) const;
-
- void set_parent (Grob* e, Axis);
- Grob *get_parent (Axis a) const { return dim_cache_[a].parent_; }
+ void flush_extent_cache (Axis);
+
+ void set_parent (Grob *e, Axis);
- DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM));
+ // URG
+ Grob *get_parent (Axis a) const;
+ void fixup_refpoint ();
};
-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<Grob> const&, Grob * , Axis a);
+Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
+Grob *common_refpoint_of_array (Link_array<Grob> const &, Grob *, Axis a);
void set_break_subsititution (SCM criterion);
-SCM substitute_mutable_property_alist (SCM alist);
+SCM substitute_object_alist (SCM alist, SCM dest);
-Link_array<Grob> ly_scm2grobs (SCM l);
+Link_array<Grob> ly_scm2grobs (SCM ell);
SCM ly_grobs2scm (Link_array<Grob> a);
-#endif /* GROB_HH */
+Interval robust_relative_extent (Grob *, Grob *, Axis);
+bool is_callback_chain (SCM s);
+SCM callback_chain_extract_procedures (SCM chain_smob);
+
+#endif /* GROB_HH */