/*
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-proto.hh"
#include "smobs.hh"
#include "dimension-cache.hh"
+#include "grob-interface.hh"
/**
for administration of what was done already
Basic output object.
*/
class Grob {
-public:
+protected:
SCM immutable_property_alist_;
-
- // rename me to ``property_alist_''
SCM mutable_property_alist_;
+ friend class Spanner;
- Grob *original_l_;
+ void substitute_mutable_properties(SCM,SCM);
+public:
+ Grob *original_;
/**
Administration: Where are we?. This is mainly used by Super_element and
0 means ORPHAN,
*/
- char status_c_;
- String name () const;
+ char status_;
+
/*
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_;
+ Paper_score *pscore_;
+ Dimension_cache dim_cache_[NO_AXES];
Grob (SCM basic_props);
Grob (Grob const&);
-
+ String name () const;
+
/*
properties
*/
SCM internal_get_grob_property (SCM) const;
void internal_set_grob_property (SCM, SCM val);
-
-#if 0
- void set_immutable_grob_property (const char * , SCM val);
- void set_immutable_grob_property (SCM key, SCM val);
-#endif
-
- void warning (String);
+ 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.
- SCM remove_grob_property (const char* nm);
-
/*
related classes.
*/
- Paper_def *paper_l () const;
+ 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 Line_of_score * line_l () const;
+ virtual System * get_system () const;
bool linked_b () const;
/**
Recursively track all dependencies of this Grob. The
- status_c_ field is used as a mark-field. It is marked with
+ 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);
- static SCM handle_broken_grobs(SCM, SCM criterion);
+
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 ();
+ virtual SCM do_derived_mark () const;
- Molecule * get_molecule () const;
- SCM get_uncached_molecule () 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 (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));
-
+ DECLARE_SCHEME_CALLBACK (stencil_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);
+ bool internal_has_interface (SCM intf);
+ static bool has_interface (Grob*me);
virtual void handle_broken_dependencies ();
virtual void handle_prebroken_dependencies ();
-
DECLARE_SMOBS (Grob,foo);
void init ();
-
- Dimension_cache dim_cache_[NO_AXES];
-
public:
- bool empty_b (Axis a) const;
+ bool is_empty (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;
- 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;
-
-
- /**
- Invoke callbacks to get offset relative to parent.
- */
+ 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_; }
+ Grob *get_parent (Axis a) const { return dim_cache_[a].parent_; }
DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM));
};
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);
+
+void set_break_subsititution (SCM criterion);
+SCM substitute_mutable_property_alist (SCM alist);
+
+Link_array<Grob> ly_scm2grobs (SCM l);
+SCM ly_grobs2scm (Link_array<Grob> a);
-#endif // STAFFELEM_HH
+#endif /* GROB_HH */
projects / lilypond.git / blobdiff