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
  29 #ifndef __BASE_STL_HELPERS_HH__
  30 #define __BASE_STL_HELPERS_HH__
  31
  32 #include <algorithm>
  33 #include <iostream>
  34
  35 namespace m5 {
  36 namespace stl_helpers {
  37
  38 template <class T>
  39 class ContainerPrint
  40 {
  41   private:
  42     std::ostream &out;
  43     bool first;
  44
  45   public:
  46     /**
  47      * @ingroup api_base_utils
  48      */
  49     ContainerPrint(std::ostream &out)
  50         : out(out), first(true)
  51     {}
  52
  53     /**
  54      * @ingroup api_base_utils
  55      */
  56     void
  57     operator()(const T &elem)
  58     {
  59         // First one doesn't get a space before it.  The rest do.
  60         if (first)
  61             first = false;
  62         else
  63             out << " ";
  64
  65         out << elem;
  66     }
  67 };
  68
  69 /**
  70  * Write out all elements in an stl container as a space separated
  71  * list enclosed in square brackets
  72  *
  73  * @ingroup api_base_utils
  74  */
  75 template <template <typename T, typename A> class C, typename T, typename A>
  76 std::ostream &
  77 operator<<(std::ostream& out, const C<T,A> &vec)
  78 {
  79     out << "[ ";
  80     std::for_each(vec.begin(), vec.end(), ContainerPrint<T>(out));
  81     out << " ]";
  82     out << std::flush;
  83     return out;
  84 }
  85
  86 } // namespace stl_helpers
  87 } // namespace m5
  88
  89 #endif // __BASE_STL_HELPERS_HH__