lyx-devel.diff

[lyx.git] / src / support / lyxfunctional.h

diff --git a/src/support/lyxfunctional.h b/src/support/lyxfunctional.h
index ae65cc8a597245623b616d8bfc69bae0d7c8fe21..55382cc0818c4b6bbf46067bbfe539d65daa6475 100644 (file)
--- a/src/support/lyxfunctional.h
+++ b/src/support/lyxfunctional.h
@@ -3,8 +3,18 @@
 #ifndef LYX_FUNCTIONAL_H
 #define LYX_FUNCTIONAL_H
 
+/** \file lyxfunctional.h
+    \brief Convenient function objects for use with LyX
+    
+    This is currently a small collection of small function objects for use
+    together with std::algorithms.
+**/
+
+#include <iterator>
+
 //namespace lyx {
 
+
 template<class R, class C, class A>
 class class_fun_t {
 public:
@@ -25,14 +35,23 @@ public:
        void_class_fun_t(C & ct, void(C::*p)(A))
                : c(ct), cmf(p) {}
        void operator()(A & a) const {
-               return (c.*cmf)(a);
+               (c.*cmf)(a);
        }
 private:
        C & c;
        void(C::*cmf)(A);
 };
 
-       
+
+/// Use to call a class method with a container element.
+/** Most easily used as a functor to std::algoritms.
+    Small example:
+    \verbatim
+    A a; // class that have a int print(string const &) method
+    vector<string> vs;
+    for_each(vs.begin(), vs.end(), class_fun(int, vs, &A::print);
+    \endverbatim
+**/
 template <class R, class C, class A> class_fun_t<R, C, A>
 class_fun(C & c, R(C::*f)(A))
 {
@@ -50,21 +69,28 @@ class_fun(C & c, void(C::*f)(A))
 template <class Cont, class Type, class MemRet>
 class back_insert_fun_iterator {
 protected:
-       Cont & container;
+       Cont * container;
        MemRet(Type::*pmf)();
 public:
+       typedef Cont container_type;
+       typedef std::output_iterator_tag iterator_category;
+       typedef void value_type;
+       typedef void difference_type;
+       typedef void pointer;
+       typedef void reference;
+       
        back_insert_fun_iterator(Cont & x, MemRet(Type::*p)())
-               : container(x), pmf(p) {}
+               : container(&x), pmf(p) {}
 
        back_insert_fun_iterator &
        operator=(Type * val) {
-               container.push_back((val->*pmf)());
+               container->push_back((val->*pmf)());
                return *this;
        }
 
        back_insert_fun_iterator &
        operator=(Type & val) {
-               container.push_back((val.*pmf)());
+               container->push_back((val.*pmf)());
                return *this;
        }
 
@@ -83,21 +109,30 @@ public:
 template <class Cont, class Type, class MemRet>
 class const_back_insert_fun_iterator {
 protected:
-       Cont & container;
+       Cont * container;
        MemRet(Type::*pmf)() const;
 public:
+       typedef Cont container_type;
+       typedef std::output_iterator_tag iterator_category;
+       typedef void value_type;
+       typedef void difference_type;
+       typedef void pointer;
+       typedef void reference;
+       
        const_back_insert_fun_iterator(Cont & x, MemRet(Type::*p)() const)
-               : container(x), pmf(p) {}
-
+               : container(&x), pmf(p) {}
+       
+       ~const_back_insert_fun_iterator() {}
+      
        const_back_insert_fun_iterator &
        operator=(Type const * val) {
-               container.push_back((val->*pmf)());
+               container->push_back((val->*pmf)());
                return *this;
        }
 
        const_back_insert_fun_iterator &
        operator=(Type const & val) {
-               container.push_back((val.*pmf)());
+               container->push_back((val.*pmf)());
                return *this;
        }
 
@@ -122,7 +157,7 @@ back_inserter_fun(Cont & cont, MemRet(Type::*p)())
 
 
 template <class Cont, class Type, class MemRet>
-back_insert_fun_iterator<Cont, Type, MemRet>
+const_back_insert_fun_iterator<Cont, Type, MemRet>
 back_inserter_fun(Cont & cont, MemRet(Type::*p)() const)
 {
        return const_back_insert_fun_iterator<Cont, Type, MemRet>(cont, p);