Merge branch 'master' of /home/jcharles/GIT/Lily/. into translation

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

diff --git a/lily/include/grob-array.hh b/lily/include/grob-array.hh
index 80b6b373cddddc0c0198ec6d53074933fca83c86..ca925b42917621842afd3ce2fc5512a21662ff5d 100644 (file)
--- a/lily/include/grob-array.hh
+++ b/lily/include/grob-array.hh
@@ -1,9 +1,20 @@
 /*
-  grob-array.hh -- declare Grob_array
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  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_ARRAY_HH
@@ -13,12 +24,16 @@
 #include "smobs.hh"
 #include "std-vector.hh"
 
-class Grob_array
+class Grob_array : public Simple_smob<Grob_array>
 {
-  vector<Grob*> grobs_;
+public:
+  int print_smob (SCM, scm_print_state *) const;
+  SCM mark_smob () const;
+  static const char * const type_p_name_;
+private:
+  vector<Grob *> grobs_;
   bool ordered_;
 
-  DECLARE_SIMPLE_SMOBS (Grob_array);
 
   Grob_array ();
 public:
@@ -26,22 +41,34 @@ public:
   void set_ordered (bool b) { ordered_ = b; }
   Item *item (vsize i);
   Spanner *spanner (vsize i);
-  Grob *grob (vsize i) { return grobs_.at (i); }
+  Grob *grob (vsize i) const { return grobs_.at (i); }
   vsize size () const { return grobs_.size (); }
-  bool empty () const;
+  bool empty () const { return grobs_.empty (); }
   void remove_duplicates ();
-  void clear ();
+  void clear () { grobs_.clear (); }
   void add (Grob *x) { grobs_.push_back (x); }
-  void set_array (vector<Grob*> const &src);
-  vector<Grob*> &array_reference ();
-  vector<Grob*> const &array () const;
+  void set_array (vector<Grob *> const &src) { grobs_ = src; }
+  vector<Grob *> &array_reference () { return grobs_; }
+  vector<Grob *> const &array () const { return grobs_; }
   static SCM make_array ();
+
+  // Remove grobs that do not satisfy the predicate, leaving the order
+  // unchanged.
+  void filter (bool (*predicate) (const Grob *));
+
+  // Run a function on all grobs in this array.  If the function returns null,
+  // remove the original grob, reducing the size of the array.  If the function
+  // returns a Grob, replace the original grob with the returned Grob.
+  void filter_map (Grob * (*map_fun) (Grob *));
+
+  // Like src.filter_map (f), but store the result in this array instead of
+  // mutating the input.
+  void filter_map_assign (const Grob_array &src, Grob * (*map_fun) (Grob *));
 };
 
-DECLARE_UNSMOB (Grob_array, grob_array);
 
-vector<Grob*> const &ly_scm2link_array (SCM x);
+vector<Grob *> const &ly_scm2link_array (SCM x);
 SCM grob_list_to_grob_array (SCM lst);
+SCM grob_array_to_list (Grob_array *array);
 
 #endif /* GROB_ARRAY_HH */
-