lily/include/grob.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2012 Han-Wen Nienhuys
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef GROB_HH
  21 #define GROB_HH
  22
  23 #include "box.hh"
  24 #include "virtual-methods.hh"
  25 #include "dimension-cache.hh"
  26 #include "grob-interface.hh"
  27
  28 class Grob
  29 {
  30 private:
  31   DECLARE_SMOBS (Grob);
  32   DECLARE_CLASSNAME (Grob);
  33
  34   void init ();
  35
  36 protected:
  37   /* data */
  38   Dimension_cache dim_cache_[NO_AXES];
  39   Output_def *layout_;
  40   Grob *original_;
  41
  42   /* SCM data */
  43   SCM immutable_property_alist_;
  44   SCM mutable_property_alist_;
  45   SCM object_alist_;
  46
  47   /*
  48     If this is a property, it accounts for 25% of the property
  49     lookups.
  50   */
  51   SCM interfaces_;
  52
  53   void substitute_object_links (SCM, SCM);
  54   Real get_offset (Axis a) const;
  55   SCM try_callback (SCM, SCM);
  56   SCM try_callback_on_alist (SCM *, SCM, SCM);
  57   void internal_set_value_on_alist (SCM *alist, SCM sym, SCM val);
  58
  59 public:
  60
  61   /* friends */
  62   friend class Spanner;
  63   friend class System;
  64   friend SCM ly_grob_properties (SCM);
  65   friend SCM ly_grob_basic_properties (SCM);
  66
  67   /* standard callbacks */
  68   DECLARE_SCHEME_CALLBACK (x_parent_positioning, (SCM));
  69   DECLARE_SCHEME_CALLBACK (y_parent_positioning, (SCM));
  70   DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob));
  71   DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob));
  72   DECLARE_SCHEME_CALLBACK (simple_vertical_skylines_from_stencil, (SCM smob));
  73   DECLARE_SCHEME_CALLBACK (vertical_skylines_from_stencil, (SCM smob));
  74   DECLARE_SCHEME_CALLBACK (vertical_skylines_from_element_stencils, (SCM smob));
  75   DECLARE_SCHEME_CALLBACK (simple_horizontal_skylines_from_stencil, (SCM smob));
  76   DECLARE_SCHEME_CALLBACK (horizontal_skylines_from_stencil, (SCM smob));
  77   DECLARE_SCHEME_CALLBACK (horizontal_skylines_from_element_stencils, (SCM smob));
  78
  79   /* R/O access */
  80   Output_def *layout () const { return layout_; }
  81   Grob *original () const { return original_; }
  82   SCM interfaces () const { return interfaces_; }
  83
  84   /* life & death */
  85   Grob (SCM basic_props);
  86   Grob (Grob const &);
  87   virtual Grob *clone () const;
  88
  89   /* forced death */
  90   void suicide ();
  91   bool is_live () const;
  92
  93   /* naming. */
  94   string name () const;
  95
  96   /* Properties */
  97   SCM get_property_alist_chain (SCM) const;
  98   SCM internal_get_property (SCM symbol) const;
  99   SCM internal_get_property_data (SCM symbol) const;
 100   SCM internal_get_pure_property (SCM symbol, int start, int end) const;
 101   SCM internal_get_maybe_pure_property (SCM symbol, bool pure, int start, int end) const;
 102   SCM internal_get_non_callback_marker_property_data (SCM symbol) const;
 103   SCM internal_get_object (SCM symbol) const;
 104   void internal_set_object (SCM sym, SCM val);
 105   void internal_del_property (SCM symbol);
 106   void instrumented_set_property (SCM, SCM, char const *, int, char const *);
 107   void internal_set_property (SCM sym, SCM val);
 108
 109   /* messages */
 110   void warning (string) const;
 111   void programming_error (string) const;
 112
 113   /* class hierarchy */
 114   virtual System *get_system () const;
 115   static System *get_system (Grob *);
 116   virtual void do_break_processing ();
 117   virtual Grob *find_broken_piece (System *) const;
 118   virtual void discretionary_processing ();
 119   virtual void derived_mark () const;
 120   virtual void handle_broken_dependencies ();
 121   virtual void handle_prebroken_dependencies ();
 122
 123   /* printing */
 124   Stencil *get_stencil () const;
 125   Stencil get_print_stencil () const;
 126
 127   /* interfaces */
 128   bool internal_has_interface (SCM intf);
 129   DECLARE_GROB_INTERFACE ();
 130
 131   /* offsets */
 132   void translate_axis (Real, Axis);
 133   Real relative_coordinate (Grob const *refp, Axis) const;
 134   Real pure_relative_y_coordinate (Grob const *refp, int start, int end);
 135   Real maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end);
 136
 137   /* extents */
 138   Interval extent (Grob *refpoint, Axis) const;
 139   void flush_extent_cache (Axis);
 140   virtual Interval pure_height (Grob *refpoint, int start_col, int end_col);
 141   Interval maybe_pure_extent (Grob *refpoint, Axis, bool pure, int start, int end);
 142
 143   /* refpoints */
 144   Grob *common_refpoint (Grob const *s, Axis a) const;
 145   void set_parent (Grob *e, Axis);
 146   Grob *get_parent (Axis a) const;
 147   void fixup_refpoint ();
 148
 149   /* vertical ordering */
 150   static bool internal_vertical_less (Grob *g1, Grob *g2, bool pure);
 151   static Grob *get_root_vertical_alignment (Grob *g);
 152   static Grob *get_vertical_axis_group (Grob *g);
 153   static bool vertical_less (Grob *g1, Grob *g2);
 154   static bool pure_vertical_less (Grob *g1, Grob *g2);
 155   static int get_vertical_axis_group_index (Grob *g);
 156
 157   /* skylines */
 158   virtual Interval_t<int> spanned_rank_interval () const;
 159   virtual bool pure_is_visible (int start, int end) const;
 160   bool check_cross_staff (Grob *common);
 161   static bool less (Grob *g1, Grob *g2);
 162   static SCM internal_simple_skylines_from_stencil (SCM, Axis);
 163   static SCM internal_skylines_from_element_stencils (SCM, Axis);
 164 };
 165
 166 /* smob utilities */
 167 DECLARE_UNSMOB (Grob, grob);
 168 Spanner *unsmob_spanner (SCM);
 169 Item *unsmob_item (SCM);
 170
 171 /* refpoints */
 172 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
 173 Grob *common_refpoint_of_array (vector<Grob *> const &, Grob *, Axis a);
 174 System *get_root_system (Grob *me);
 175
 176 /* extents */
 177 Interval robust_relative_extent (Grob *, Grob *, Axis);
 178
 179 /* offset/extent callbacks. */
 180 void add_offset_callback (Grob *g, SCM proc, Axis a);
 181 void chain_offset_callback (Grob *g, SCM proc, Axis a);
 182 void chain_callback (Grob *g, SCM proc, SCM sym);
 183 SCM axis_offset_symbol (Axis a);
 184 SCM axis_parent_positioning (Axis a);
 185
 186 SCM call_pure_function (SCM unpure, SCM args, int start, int end);
 187
 188 void set_nested_property (Grob *, SCM property_path, SCM value);
 189
 190 #endif /* GROB_HH */