src/base/stl_helpers.hh

   1 /*
   2  * Copyright (c) 2010 The Hewlett-Packard Development Company
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  */
  30
  31 #ifndef __BASE_STL_HELPERS_HH__
  32 #define __BASE_STL_HELPERS_HH__
  33
  34 #include <algorithm>
  35 #include <iostream>
  36
  37 namespace m5 {
  38 namespace stl_helpers {
  39
  40 template <typename T>
  41 void
  42 deletePointer(T &ptr)
  43 {
  44     delete ptr;
  45     ptr = NULL;
  46 }
  47
  48 template <class T>
  49 class ContainerPrint
  50 {
  51   private:
  52     std::ostream &out;
  53     bool first;
  54
  55   public:
  56     ContainerPrint(std::ostream &out)
  57         : out(out), first(true)
  58     {}
  59
  60     void
  61     operator()(const T &elem)
  62     {
  63         // First one doesn't get a space before it.  The rest do.
  64         if (first)
  65             first = false;
  66         else
  67             out << " ";
  68
  69         out << elem;
  70     }
  71 };
  72
  73 // Treat all objects in an stl container as pointers to heap objects,
  74 // calling delete on each one and zeroing the pointers along the way
  75 template <template <typename T, typename A> class C, typename T, typename A>
  76 void
  77 deletePointers(C<T,A> &container)
  78 {
  79     std::for_each(container.begin(), container.end(), deletePointer<T>);
  80 }
  81
  82 // Write out all elements in an stl container as a space separated
  83 // list enclosed in square brackets
  84 template <template <typename T, typename A> class C, typename T, typename A>
  85 std::ostream &
  86 operator<<(std::ostream& out, const C<T,A> &vec)
  87 {
  88     out << "[ ";
  89     std::for_each(vec.begin(), vec.end(), ContainerPrint<T>(out));
  90     out << " ]";
  91     out << std::flush;
  92     return out;
  93 }
  94
  95 } // namespace stl_helpers
  96 } // namespace m5
  97
  98 #endif // __BASE_STL_HELPERS_HH__