lily/include/grob.hh

   1 /*
   2   grob.hh -- declare Grob
   3
   4   source file of the LilyPond music typesetter
   5
   6   (c) 1996--2005 Han-Wen Nienhuys
   7 */
   8
   9 #ifndef GROB_HH
  10 #define GROB_HH
  11
  12 #include "virtual-methods.hh"
  13 #include "dimension-cache.hh"
  14 #include "grob-interface.hh"
  15 #include "object-key.hh"
  16
  17 typedef void (Grob:: *Grob_method_pointer) (void);
  18
  19 class Grob
  20 {
  21 private:
  22   DECLARE_SMOBS (Grob, foo);
  23   void init ();
  24
  25 protected:
  26   Object_key const *key_;
  27   SCM immutable_property_alist_;
  28   SCM mutable_property_alist_;
  29   SCM object_alist_;
  30
  31   /*
  32     If this is a property, it accounts for 25% of the property
  33     lookups.
  34   */
  35   SCM interfaces_;
  36
  37   /* BARF */
  38   friend class Spanner;
  39   friend SCM ly_grob_properties (SCM);
  40   friend SCM ly_grob_basic_properties (SCM);
  41   friend void check_interfaces_for_property (Grob const *, SCM);
  42   void substitute_object_links (SCM, SCM);
  43
  44   DECLARE_CLASSNAME(Grob);
  45   Real get_offset (Axis a) const;
  46 public:
  47   DECLARE_SCHEME_CALLBACK(same_axis_parent_positioning, (SCM, SCM));
  48   DECLARE_SCHEME_CALLBACK(other_axis_parent_positioning, (SCM, SCM));
  49
  50   Object_key const *get_key () const;
  51
  52   Grob *original_;
  53
  54   /* TODO: junk this member. */
  55   Paper_score *pscore_;
  56
  57   Dimension_cache dim_cache_[NO_AXES];
  58
  59   Grob (SCM basic_props, Object_key const *);
  60   Grob (Grob const &, int copy_count);
  61
  62   virtual Grob *clone (int count) const;
  63   static SCM stencil_extent (Grob*, Axis);
  64   DECLARE_SCHEME_CALLBACK (stencil_height, (SCM smob));
  65   DECLARE_SCHEME_CALLBACK (stencil_width, (SCM smob));
  66
  67
  68   String name () const;
  69   /*
  70     Properties
  71   */
  72   SCM internal_get_property (SCM symbol) const;
  73   SCM get_property_data (SCM symbol) const;
  74   SCM internal_get_object (SCM symbol) const;
  75
  76   void del_property (SCM symbol);
  77   void internal_set_property (SCM sym, SCM val);
  78   void internal_set_object (SCM sym, SCM val);
  79
  80   SCM try_callback (SCM, SCM);
  81
  82   SCM get_property_alist_chain (SCM) const;
  83   static SCM ly_grob_set_property (SCM, SCM, SCM);
  84   static SCM ly_grob_property (SCM, SCM);
  85
  86   void warning (String) const;
  87   void programming_error (String) const;
  88
  89   Output_def *get_layout () const;
  90   virtual System *get_system () const;
  91   virtual void do_break_processing ();
  92   virtual Grob *find_broken_piece (System *) const;
  93   virtual void discretionary_processing ();
  94   virtual void derived_mark () const;
  95
  96   Stencil *get_stencil () const;
  97   Stencil get_print_stencil () const;
  98
  99   void suicide ();
 100   bool is_live () const;
 101
 102   bool internal_has_interface (SCM intf);
 103   static bool has_interface (Grob *me);
 104   SCM get_interfaces () const;
 105
 106   virtual void handle_broken_dependencies ();
 107   virtual void handle_prebroken_dependencies ();
 108
 109   Interval extent (Grob *refpoint, Axis) const;
 110
 111   void translate_axis (Real, Axis);
 112   Real relative_coordinate (Grob const *refp, Axis) const;
 113   Grob *common_refpoint (Grob const *s, Axis a) const;
 114
 115   // duh. slim down interface here. (todo)
 116   bool has_offset_callback (SCM callback, Axis) const;
 117   void add_offset_callback (SCM callback, Axis);
 118   void flush_extent_cache (Axis);
 119
 120   void set_parent (Grob *e, Axis);
 121
 122   // URG
 123   Grob *get_parent (Axis a) const;
 124   void fixup_refpoint ();
 125 };
 126
 127 DECLARE_UNSMOB (Grob, grob);
 128 Spanner *unsmob_spanner (SCM);
 129 Item *unsmob_item (SCM);
 130
 131 Grob *common_refpoint_of_list (SCM elt_list, Grob *, Axis a);
 132 Grob *common_refpoint_of_array (Link_array<Grob> const &, Grob *, Axis a);
 133
 134 void set_break_subsititution (SCM criterion);
 135 SCM substitute_object_alist (SCM alist, SCM dest);
 136
 137 Link_array<Grob> ly_scm2grobs (SCM ell);
 138 SCM ly_grobs2scm (Link_array<Grob> a);
 139
 140 Interval robust_relative_extent (Grob *, Grob *, Axis);
 141
 142 bool is_callback_chain (SCM s);
 143 SCM callback_chain_extract_procedures (SCM chain_smob);
 144
 145 #endif /* GROB_HH */