2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
23 #include "lily-proto.hh"
25 #include "std-vector.hh"
27 class Grob_array : public Simple_smob<Grob_array>
30 int print_smob (SCM, scm_print_state *) const;
31 SCM mark_smob () const;
32 static const char type_p_name_[];
34 vector<Grob *> grobs_;
40 bool ordered () const { return ordered_; }
41 void set_ordered (bool b) { ordered_ = b; }
43 Spanner *spanner (vsize i);
44 Grob *grob (vsize i) const { return grobs_.at (i); }
45 vsize size () const { return grobs_.size (); }
46 bool empty () const { return grobs_.empty (); }
47 void remove_duplicates ();
48 void clear () { grobs_.clear (); }
49 void add (Grob *x) { grobs_.push_back (x); }
50 void set_array (vector<Grob *> const &src) { grobs_ = src; }
51 vector<Grob *> &array_reference () { return grobs_; }
52 vector<Grob *> const &array () const { return grobs_; }
53 static SCM make_array ();
55 // Remove grobs that do not satisfy the predicate, leaving the order
57 void filter (bool (*predicate) (const Grob *));
59 // Run a function on all grobs in this array. If the function returns null,
60 // remove the original grob, reducing the size of the array. If the function
61 // returns a Grob, replace the original grob with the returned Grob.
62 void filter_map (Grob * (*map_fun) (Grob *));
64 // Like src.filter_map (f), but store the result in this array instead of
65 // mutating the input.
66 void filter_map_assign (const Grob_array &src, Grob * (*map_fun) (Grob *));
70 vector<Grob *> const &ly_scm2link_array (SCM x);
71 SCM grob_list_to_grob_array (SCM lst);
72 SCM grob_array_to_list (Grob_array *array);
74 #endif /* GROB_ARRAY_HH */