/*
- spanner.hh -- part of GNU LilyPond
+ This file is part of LilyPond, the GNU music typesetter.
- (c) 1996,97 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 SPANNER_HH
#define SPANNER_HH
-#include "lily-proto.hh"
-#include "score-elem.hh"
+#include "grob.hh"
+#include "rod.hh"
+/** A symbol which is attached between two columns. A spanner is a
+ symbol which spans across several columns, so its final appearance
+ can only be calculated after the breaking problem is solved.
-#define SPANNER_CLONE(T) VIRTUAL_COPY_CONS(T, Spanner)
+ Examples
-/** a symbol which is attached between two columns. A spanner is a
- symbol which spans across several columns, so its final appearance
- can only be calculated after the breaking problem is solved.
+ * (de)crescendo
+ * slur
+ * beam
+ * bracket
- Examples
-
- \begin{itemize}
- \item (de)crescendo
- \item slur
- \item beam
- \item bracket
- \end{itemize}
-
+ Spanner should know about the items which it should consider:
+ e.g. slurs should be steep enough to "enclose" all those items. This
+ is absolutely necessary for beams, since they have to adjust the
+ length of stems of notes they encompass.
+*/
+class Spanner : public Grob
+{
+ Drul_array<Item *> spanned_drul_;
+ vsize break_index_;
- Spanner should know about the items which it should consider:
- e.g. slurs should be steep enough to "enclose" all those items. This
- is absolutely necessary for beams, since they have to adjust the
- length of stems of notes they encompass.
+ DECLARE_CLASSNAME (Spanner);
- */
-class Spanner:public virtual Score_elem {
public:
- PCol *left_col_l_, *right_col_l_;
-
- /* *************** */
- NAME_MEMBERS(Spanner);
- virtual Spanner* spanner() { return this; }
- Spanner();
- bool broken_b() const;
- Spanner* find_broken_piece(Line_of_score*)const;
+ DECLARE_SCHEME_CALLBACK (set_spacing_rods, (SCM));
+ DECLARE_SCHEME_CALLBACK (calc_normalized_endpoints, (SCM));
+ DECLARE_SCHEME_CALLBACK (bounds_width, (SCM));
+ DECLARE_SCHEME_CALLBACK (kill_zero_spanned_time, (SCM));
+
+ static Spanner *unsmob (SCM s) {
+ return dynamic_cast <Spanner *> (Grob::unsmob (s));
+ }
+ static bool is_smob (SCM s) {
+ return Grob::is_smob (s) && unsmob (s);
+ }
+
+ vector<Spanner *> broken_intos_;
+
+ vsize get_break_index () const;
+ Spanner *broken_neighbor (Direction d) const;
+
+ // todo: move to somewhere else.
+ Real get_broken_left_end_align () const;
+ void substitute_one_mutable_property (SCM sym, SCM val);
+
+ Interval_t<Moment> spanned_time () const;
+ virtual Interval_t<int> spanned_rank_interval () const;
+ void set_bound (Direction d, Grob *);
+ Item *get_bound (Direction d) const;
+
+ Spanner (SCM);
+ Spanner (Spanner const &);
+ bool is_broken () const;
+ void do_break ();
+ Real spanner_length () const;
+
+ static int compare (Spanner *const &, Spanner *const &);
+ static bool less (Spanner *const &, Spanner *const &);
+ virtual Grob *find_broken_piece (System *) const;
+ virtual void derived_mark () const;
+ DECLARE_GROB_INTERFACE ();
+ virtual System *get_system () const;
+
+ SCM get_cached_pure_property (SCM sym, int start, int end);
+ void cache_pure_property (SCM sym, int start, int end, SCM value);
+
protected:
- SPANNER_CLONE(Spanner)
- virtual void break_into_pieces();
-
- Link_array<Spanner> broken_into_l_arr_;
-
- virtual void do_break_processing();
- virtual Interval do_width()const;
- virtual void do_print()const;
- virtual Line_of_score*line_l()const;
+ SCM pure_property_cache_;
+
+ void set_my_columns ();
+ virtual Grob *clone () const;
+ virtual void do_break_processing ();
+ bool fast_substitute_grob_array (SCM sym, Grob_array *);
};
+
+void add_bound_item (Spanner *, Grob *);
+
+bool spanner_less (Spanner *s1, Spanner *s2);
#endif