/*
- grob.hh -- declare Grob
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the LilyPond music typesetter
-
- (c) 1996--2004 Han-Wen Nienhuys
+ Copyright (C) 1996--2015 Han-Wen Nienhuys
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GROB_HH
#define GROB_HH
-#include "parray.hh"
+#include "box.hh"
#include "virtual-methods.hh"
-#include "lily-guile.hh"
-#include "lily-proto.hh"
-#include "smobs.hh"
#include "dimension-cache.hh"
#include "grob-interface.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
-};
+#include <set>
-typedef void (Grob::*Grob_method_pointer) (void);
+class Grob : public Smob<Grob>
+{
+public:
+ int print_smob (SCM, scm_print_state *);
+ SCM mark_smob ();
+ static const char type_p_name_[];
+ virtual ~Grob ();
+private:
+ DECLARE_CLASSNAME (Grob);
+ void init ();
-/* Basic G[raphical output] O[bject]. */
-class Grob
-{
protected:
- SCM immutable_property_alist_;
- SCM mutable_property_alist_;
- friend class Spanner;
-
- void substitute_mutable_properties(SCM,SCM);
- char status_;
-public:
+ /* data */
+ Dimension_cache dim_cache_[NO_AXES];
+ Output_def *layout_;
Grob *original_;
- /*
- TODO: junk this member.
- */
- Paper_score *pscore_;
- Dimension_cache dim_cache_[NO_AXES];
+ /* SCM data */
+ SCM immutable_property_alist_;
+ SCM mutable_property_alist_;
+ SCM object_alist_;
- Grob (SCM basic_props);
- Grob (Grob const&);
- VIRTUAL_COPY_CONSTRUCTOR(Grob,Grob);
-
- 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;
-
- void calculate_dependencies (int final, int busy, SCM funcname);
+ 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);
+ SCM try_callback_on_alist (SCM *, SCM, SCM);
+ void internal_set_value_on_alist (SCM *alist, SCM sym, SCM val);
- virtual void do_break_processing ();
- virtual Grob *find_broken_piece (System*) const;
- virtual void discretionary_processing ();
- virtual SCM do_derived_mark () const;
+public:
- Stencil * get_stencil () const;
- SCM get_uncached_stencil () const;
+ /* 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 (pure_stencil_height, (SCM smob, SCM, SCM));
+ DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (pure_simple_vertical_skylines_from_extents, (SCM smob, SCM, SCM));
+ DECLARE_SCHEME_CALLBACK (simple_vertical_skylines_from_extents, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (vertical_skylines_from_stencil, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (pure_vertical_skylines_from_element_stencils, (SCM smob, SCM, SCM));
+ DECLARE_SCHEME_CALLBACK (vertical_skylines_from_element_stencils, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (pure_simple_horizontal_skylines_from_extents, (SCM smob, SCM, SCM));
+ DECLARE_SCHEME_CALLBACK (simple_horizontal_skylines_from_extents, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (horizontal_skylines_from_stencil, (SCM smob));
+ DECLARE_SCHEME_CALLBACK (pure_horizontal_skylines_from_element_stencils, (SCM smob, SCM, SCM));
+ DECLARE_SCHEME_CALLBACK (horizontal_skylines_from_element_stencils, (SCM smob));
+
+ /* R/O access */
+ Output_def *layout () const { return layout_; }
+ Grob *original () const { return original_; }
+ SCM interfaces () const { return interfaces_; }
+
+ /* life & death */
+ Grob (SCM basic_props);
+ Grob (Grob const &);
+ virtual Grob *clone () const;
- SCM get_property_alist_chain (SCM) const;
+ /* forced death */
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);
+ /* naming. */
+ string name () const;
+ /* Properties */
+ SCM get_property_alist_chain (SCM) const;
+ SCM internal_get_property (SCM symbol) const;
+ SCM internal_get_property_data (SCM symbol) const;
+ SCM internal_get_pure_property (SCM symbol, int start, int end) const;
+ SCM internal_get_maybe_pure_property (SCM symbol, bool pure, int start, int end) const;
+ SCM internal_get_non_callback_marker_property_data (SCM symbol) const;
+ SCM internal_get_object (SCM symbol) const;
+ void internal_set_object (SCM sym, SCM val);
+ void internal_del_property (SCM symbol);
+ void instrumented_set_property (SCM, SCM, char const *, int, char const *);
+ void internal_set_property (SCM sym, SCM val);
+
+ /* messages */
+ void warning (const string&) const;
+ void programming_error (const string&) const;
+
+ /* class hierarchy */
+ virtual System *get_system () const;
+ static System *get_system (Grob *);
+ virtual void do_break_processing ();
+ virtual Grob *find_broken_piece (System *) const;
+ virtual void discretionary_processing ();
+ virtual void derived_mark () const;
virtual void handle_broken_dependencies ();
virtual void handle_prebroken_dependencies ();
- DECLARE_SMOBS (Grob,foo);
+ /* printing */
+ Stencil *get_stencil () const;
+ Stencil get_print_stencil () const;
- void init ();
-public:
- bool is_empty (Axis a) const;
+ /* interfaces */
+ bool internal_has_interface (SCM intf);
+ DECLARE_GROB_INTERFACE ();
- Interval extent (Grob * refpoint, Axis) const;
-
+ /* offsets */
void translate_axis (Real, Axis);
- 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;
- 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_; }
-
- DECLARE_SCHEME_CALLBACK (fixup_refpoint, (SCM));
+ Real relative_coordinate (Grob const *refp, Axis) const;
+ Real pure_relative_y_coordinate (Grob const *refp, int start, int end);
+ Real maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end);
+
+ /* extents */
+ Interval extent (Grob *refpoint, Axis) const;
+ void flush_extent_cache (Axis);
+ virtual Interval pure_height (Grob *refpoint, int start_col, int end_col);
+ Interval maybe_pure_extent (Grob *refpoint, Axis, bool pure, int start, int end);
+
+ /* 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 ();
+
+ /* vertical ordering */
+ static bool internal_vertical_less (Grob *g1, Grob *g2, bool pure);
+ static Grob *get_root_vertical_alignment (Grob *g);
+ static Grob *get_vertical_axis_group (Grob *g);
+ static bool vertical_less (Grob *g1, Grob *g2);
+ static bool pure_vertical_less (Grob *g1, Grob *g2);
+ static int get_vertical_axis_group_index (Grob *g);
+
+ /* skylines */
+ virtual Interval_t<int> spanned_rank_interval () const;
+ virtual bool pure_is_visible (int start, int end) const;
+ bool check_cross_staff (Grob *common);
+ static bool less (Grob *g1, Grob *g2);
+ static SCM maybe_pure_internal_simple_skylines_from_extents (Grob *, Axis, bool, int, int, bool, bool);
+ static SCM internal_skylines_from_element_stencils (Grob *me, Axis a, bool pure, int beg, int end);
+ static SCM internal_skylines_from_element_stencils (SCM, Axis);
};
-DECLARE_UNSMOB(Grob,grob);
-Spanner* unsmob_spanner (SCM );
-Item* unsmob_item (SCM );
+/* unification */
+void uniquify (vector <Grob *> &);
-Grob*common_refpoint_of_list (SCM elt_list, Grob * , Axis a);
-Grob*common_refpoint_of_array (Link_array<Grob> const&, Grob * , Axis a);
+/* refpoints */
+Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
+Grob *common_refpoint_of_array (vector<Grob *> const &, Grob *, Axis a);
+Grob *common_refpoint_of_array (set<Grob *> const &, Grob *, Axis a);
+System *get_root_system (Grob *me);
-void set_break_subsititution (SCM criterion);
-SCM substitute_mutable_property_alist (SCM alist);
+/* extents */
+Interval robust_relative_extent (Grob *, Grob *, Axis);
-Link_array<Grob> ly_scm2grobs (SCM l);
-SCM ly_grobs2scm (Link_array<Grob> a);
+/* offset/extent callbacks. */
+void add_offset_callback (Grob *g, SCM proc, Axis a);
+void chain_offset_callback (Grob *g, SCM proc, Axis a);
+void chain_callback (Grob *g, SCM proc, SCM sym);
+SCM axis_offset_symbol (Axis a);
+SCM axis_parent_positioning (Axis a);
-#endif /* GROB_HH */
+SCM call_pure_function (SCM unpure, SCM args, int start, int end);
+void set_nested_property (Grob *, SCM property_path, SCM value);
+
+#endif /* GROB_HH */