Update copyright to LGPL on all files
[dyninst.git] / dynutil / h / stl_utils.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31 #ifndef STL_UTILS
32 #define STL_UTILS
33 #include <utility>
34
35 ///
36 /// This file contains some utility functions for dealing with the STL.
37 /// In particular, this mostly contains functors and adaptors for dealing
38 /// with std::pair inside STL algorithms.
39 ///
40
41 namespace Dyninst {
42
43 /// Functor to get the first element of a pair.  Use with STL functions like transform().
44 struct get_first {
45   template <typename P>
46   typename P::first_type operator()(const P& pair) {
47     return pair.first;
48   }
49 };
50
51 /// Functor to get the second element of a pair.  Use with STL functions like transform().
52 struct get_second {
53   template <typename P>
54   typename P::second_type operator()(const P& pair) {
55     return pair.second;
56   }
57 };
58
59 /// Applies a ftor to the first element of a pair
60 template <typename Functor>
61 struct do_to_first_ftor {
62   Functor ftor;
63   do_to_first_ftor(const Functor& f) : ftor(f) { }
64   template <typename P>
65   void operator()(const P& pair) {
66     ftor(pair.first);
67   }
68 };
69
70 /// Type-inferring adapter function for do_to_first_ftor
71 template <typename Functor>
72 inline do_to_first_ftor<Functor> do_to_first(const Functor& f) {
73   return do_to_first_ftor<Functor>(f);
74 }
75
76 /// Applies a ftor to the second element of a pair
77 template <typename Functor>
78 struct do_to_second_ftor {
79   Functor ftor;
80   do_to_second_ftor(const Functor& f) : ftor(f) { }
81   template <typename P>
82   void operator()(const P& pair) {
83     ftor(pair.second);
84   }
85 };
86
87 /// Type-inferring adapter function for do_to_second_ftor
88 template <typename Functor>
89 inline do_to_second_ftor<Functor> do_to_second(const Functor& f) {
90   return do_to_second_ftor<Functor>(f);
91 }
92
93 } // namespace Dyninst
94
95 #endif // STL_UTILS