Imported Upstream version 2.14.2

[lilypond.git] / lily / include / grob.hh

diff --git a/lily/include/grob.hh b/lily/include/grob.hh
index c5413c5e74a206327f547f9cdc0e96ceaa8ca928..eda94b6d5888b1778897658c683c7c20c5c57944 100644 (file)
--- a/lily/include/grob.hh
+++ b/lily/include/grob.hh
@@ -1,23 +1,34 @@
 /*
-  grob.hh -- declare Grob
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the LilyPond music typesetter
+  Copyright (C) 1996--2011 Han-Wen Nienhuys
 
-  (c) 1996--2006 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 "box.hh"
 #include "virtual-methods.hh"
 #include "dimension-cache.hh"
 #include "grob-interface.hh"
-#include "object-key.hh"
 
 class Grob
 {
 private:
-  DECLARE_SMOBS (Grob, foo);
+  DECLARE_SMOBS (Grob);
   DECLARE_CLASSNAME(Grob);
   
   void init ();
@@ -27,7 +38,6 @@ protected:
   Dimension_cache dim_cache_[NO_AXES];
   Output_def *layout_;
   Grob *original_;
-  Object_key const *key_;
 
   /* SCM data */
   SCM immutable_property_alist_;
@@ -43,6 +53,9 @@ protected:
   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);
+
 public:
   
   /* friends */
@@ -52,8 +65,8 @@ public:
   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 (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));
 
@@ -61,36 +74,40 @@ public:
   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;
+  Grob (SCM basic_props);
+  Grob (Grob const &);
+  virtual Grob *clone () const;
 
   /* forced death */
   void suicide ();
   bool is_live () const;
 
   /* naming. */
-  String name () const;
+  string name () const;
 
   /* 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_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 del_property (SCM symbol); 
-  void internal_set_property (SCM sym, SCM val);
   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 (String) const;
-  void programming_error (String) const;
+  void warning (string) const;
+  void programming_error (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 ();
@@ -104,21 +121,30 @@ public:
 
   /* interfaces */
   bool internal_has_interface (SCM intf);
-  static bool has_interface (Grob *me);
+  DECLARE_GROB_INTERFACE();
 
   /* offsets */
   void translate_axis (Real, Axis);
   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 ();
+
+  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);
 };
 
 /* smob utilities */
@@ -128,7 +154,7 @@ Item *unsmob_item (SCM);
 
 /* refpoints */
 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_array (vector<Grob*> const &, Grob *, Axis a);
 System *get_root_system (Grob *me);
 
 /* extents */ 
@@ -137,8 +163,12 @@ 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);
+void chain_callback (Grob *g, SCM proc, SCM sym);
 SCM axis_offset_symbol (Axis a);
 SCM axis_parent_positioning (Axis a);
 
+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 */