create_iterator.hh

00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2007, 2009 Ciaran McCreesh
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_PALUDIS_UTIL_CREATE_ITERATOR_HH
00021 #define PALUDIS_GUARD_PALUDIS_UTIL_CREATE_ITERATOR_HH 1
00022 
00023 #include <iterator>
00024 #include <paludis/util/create_iterator-fwd.hh>
00025 
00026 namespace paludis
00027 {
00028     /**
00029      * A CreateInsertIterator creates a value of type Value_ from the assigned value
00030      * and inserts it into Iter_.
00031      *
00032      * \ingroup g_iterator
00033      */
00034     template <typename Value_, typename Iter_>
00035     class CreateInsertIterator
00036     {
00037         private:
00038             Iter_ _iter;
00039 
00040         public:
00041             ///\name Basic operations
00042             ///\{
00043 
00044             CreateInsertIterator();
00045             ~CreateInsertIterator();
00046             CreateInsertIterator(const CreateInsertIterator &);
00047             CreateInsertIterator(const Iter_ &);
00048 
00049             CreateInsertIterator & operator= (const CreateInsertIterator &);
00050 
00051             template <typename T_>
00052             CreateInsertIterator & operator= (const T_ &);
00053 
00054             ///\}
00055 
00056             ///\name Standard library typedefs
00057             ///\{
00058 
00059             typedef CreateInsertIterator value_type;
00060             typedef CreateInsertIterator & reference;
00061             typedef CreateInsertIterator * pointer;
00062             typedef std::ptrdiff_t difference_type;
00063             typedef std::output_iterator_tag iterator_category;
00064 
00065             ///\}
00066 
00067             ///\name Increment
00068             ///\{
00069 
00070             CreateInsertIterator & operator++ ();
00071             CreateInsertIterator operator++ (int);
00072 
00073             ///\}
00074 
00075             ///\name Dereference
00076             ///\{
00077 
00078             pointer operator-> ();
00079             reference operator* ();
00080 
00081             ///\}
00082     };
00083 }
00084 
00085 #endif

Generated on Mon Sep 21 10:36:08 2009 for paludis by  doxygen 1.5.4