libresiprocate-1.9-dev 1.9.6-1 / usr / include / rutil / Inserter.hxx

#if !defined(RESIP_INSERTER_HXX)
#define RESIP_INSERTER_HXX 

#include <iostream>
#include <utility>
#include <map>
#include <set>
#include <list>
#include <vector>
#include <deque>
#include <cassert>

#include "HashMap.hxx"
#include "rutil/compat.hxx"
#include "rutil/resipfaststreams.hxx"

/* 
Example of use Inserter

int
main(int argc, char** argv)
{
   std::vector<std::string> v;
   
   v.push_back("foo");
   v.push_back("bar");
   v.push_back("baz");

   std::cerr << Inserter(v) << std::endl;
   std::cerr << Inserter("nnn") << std::endl; // though you wouldn't bother
}

Example of use InserterP
InserterP - allows processing of collections with pointers to items

int
main(int argc, char** argv)
{
   std::vector<std::string*> v;
   
   v.push_back(new std::string("foo"));
   v.push_back(new std::string("bar"));
   v.push_back(new std::string("baz"));

   std::cerr << InserterP(v) << std::endl;
}
*/

namespace resip
{

static const char* leftanglebracket("<");
static const char* rightanglebracket(">");
static const char* leftsqbracket("[");
static const char* rightsqbracket("]");
static const char* sparrowsp(" -> ");
static const char* commaspace(", ");

/// Completely generic insert function
#ifdef REASONABLE_TEMPLATES
template <class T>
EncodeStream&
insert(EncodeStream& s, const T& t)
{
   // use native <<
   s << t;
   return s;
}
#endif

// specific collections, sigh
template <class T>
EncodeStream&
insert(EncodeStream& s, const std::vector <T>& c)
{
   s << leftsqbracket;
   for (typename std::vector <T>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      // recurse
      insert(s, *i);
   }
   s << rightsqbracket;
   return s;
}

template <class T>
EncodeStream&
insert(EncodeStream& s, const std::deque<T>& c)
{
   s << leftsqbracket;
   for (typename std::deque <T>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      // recurse
      insert(s, *i);
   }
   s << rightsqbracket;
   return s;
}

template <class T>
EncodeStream&
insert(EncodeStream& s, const std::list <T>& c)
{
   s << leftsqbracket;
   for (typename std::list <T>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      // recurse
      insert(s, *i);
   }
   s << rightsqbracket;
   return s;
}

#if !defined(__INTEL_COMPILER)
template <class K, class C>
EncodeStream&
insert(EncodeStream& s, const std::set <K, C>& c)
{
   s << leftsqbracket;
   for (typename std::set <K, C>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, *i);
   }
   s << rightsqbracket;
   return s;
}
#endif

#if !defined(__INTEL_COMPILER)
template <class K, class C>
EncodeStream&
insert(EncodeStream& s, const std::multiset <K, C>& c)
{
   s << leftsqbracket;
   for (typename std::multiset <K, C>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, *i);
   }
   s << rightsqbracket;
   return s;
}
#endif

// HashMap
#if defined(HASH_MAP_NAMESPACE)
template <class K, class V, class H>
EncodeStream&
insert(EncodeStream& s, const HashMap<K,V,H>& c)
{
   s << leftsqbracket;
   for (typename HashMap<K,V,H>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, i->first);
      s << sparrowsp;
      insert(s, i->second);      
   }
   s << rightsqbracket;
   return s;
}
#endif

#if defined(HASH_MAP_NAMESPACE)
template <class V, class H>
EncodeStream&
insert(EncodeStream& s, const HashSet<V,H>& c)
{
   s << leftsqbracket;
   for (typename HashSet<V,H>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, *i);
   }
   s << rightsqbracket;
   return s;
}
#endif

// map
template <class K, class V, class H>
EncodeStream&
insert(EncodeStream& s, const std::map <K, V, H>& c)
{
   s << leftsqbracket;
   for (typename std::map<K,V, H>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, i->first);
      s << sparrowsp;
      insert(s, i->second);  
   }
   s << rightsqbracket;
   return s;
}

// special case for basic_string container
template <class T>
EncodeStream&
insert(EncodeStream& s, const std::basic_string<T>& str)
{
   // use native <<
   s << str;
   return s;
}

// special case for pair
template <class T, class U>
EncodeStream&
insert(EncodeStream& s, const std::pair<T, U>& p)
{
   // use native <<
   s << leftanglebracket << p.first << commaspace << p.second << rightanglebracket;
   return s;
}

/**
   @brief Allows a (possibly recursive) container of anything with operator<< to 
   be dumped to a stream.

   
   This is particularly useful within a Log call.
   e.g.
   @code
   void logNameAddrs(vector<resip::NameAddr>& contacts)
   {
      DebugLog(<< "Contacts: " << Inserter(contacts));
   }
   @endcode

   @see Inserter()
 */
template <class T>
class InserterClass
{
   public:
      InserterClass(const T& t)
         : _t(t)
      {}
      
      const T& _t;
};

/// Function to allow an Inserter to be used directly with a stream
template <class T>
EncodeStream&
operator<<(EncodeStream& s, const InserterClass<T>& inserter)
{
#if defined(WIN32) && defined(_MSC_VER) && (_MSC_VER < 1310)
	assert(0); // CJ - really need to fix this
	return s;
#else
   return insert(s, inserter._t);
#endif
}

/// Templatized function to construct an instance of InserterClass for a
/// container to be inserted. The function induces the template type, saving the
/// user from thinking about it.
template <class T>
InserterClass<T>
Inserter(const T& t)
{
   return InserterClass<T>(t);
}



///
///  The following functions are more or less the same as the above, but add P to the naming
///  and treat data items as pointers
///



/// Completely generic insert function
#ifdef REASONABLE_TEMPLATES
template <class T>
EncodeStream&
insertP(EncodeStream& s, const T& t)
{
   // use native <<
   s << *t;
   return s;
}
#endif

// specific collections, sigh
template <class T>
EncodeStream&
insertP(EncodeStream& s, const std::vector <T>& c)
{
   s << leftsqbracket;
   for (typename std::vector <T>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      // recurse
      insert(s, *(*i));
   }
   s << rightsqbracket;
   return s;
}

template <class T>
EncodeStream&
insertP(EncodeStream& s, const std::deque<T>& c)
{
   s << leftsqbracket;
   for (typename std::deque <T>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      // recurse
      insert(s, *(*i));
   }
   s << rightsqbracket;
   return s;
}

template <class T>
EncodeStream&
insertP(EncodeStream& s, const std::list <T>& c)
{
   s << leftsqbracket;
   for (typename std::list <T>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      // recurse
      insert(s, *(*i));
   }
   s << rightsqbracket;
   return s;
}

#if !defined(__INTEL_COMPILER)
template <class K, class C>
EncodeStream&
insertP(EncodeStream& s, const std::set <K, C>& c)
{
   s << leftsqbracket;
   for (typename std::set <K, C>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, *(*i));
   }
   s << rightsqbracket;
   return s;
}
#endif

#if !defined(__INTEL_COMPILER)
template <class K, class C>
EncodeStream&
insertP(EncodeStream& s, const std::multiset <K, C>& c)
{
   s << leftsqbracket;
   for (typename std::multiset <K, C>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, *(*i));
   }
   s << rightsqbracket;
   return s;
}
#endif

// HashMap
#if defined(HASH_MAP_NAMESPACE)
template <class K, class V, class H>
EncodeStream&
insertP(EncodeStream& s, const HashMap<K,V,H>& c)
{
   s << leftsqbracket;
   for (typename HashMap<K,V,H>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, i->first);
      s << sparrowsp;
      insert(s, *i->second);      
   }
   s << rightsqbracket;
   return s;
}
#endif

#if defined(HASH_MAP_NAMESPACE)
template <class V, class H>
EncodeStream&
insertP(EncodeStream& s, const HashSet<V,H>& c)
{
   s << leftsqbracket;
   for (typename HashSet<V,H>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, *(*i));
   }
   s << rightsqbracket;
   return s;
}
#endif

// map
template <class K, class V, class H>
EncodeStream&
insertP(EncodeStream& s, const std::map <K, V, H>& c)
{
   s << leftsqbracket;
   for (typename std::map<K,V, H>::const_iterator i = c.begin();
        i != c.end(); i++) 
   {
      if (i != c.begin()) 
      {
         s << commaspace;
      }
      insert(s, i->first);
      s << sparrowsp;
      insert(s, *i->second);  
   }
   s << rightsqbracket;
   return s;
}

// special case for basic_string container
template <class T>
EncodeStream&
insertP(EncodeStream& s, const std::basic_string<T>& str)
{
   // use native <<
   s << str;
   return s;
}

// special case for pair
template <class T, class U>
EncodeStream&
insertP(EncodeStream& s, const std::pair<T, U>& p)
{
   // use native <<
   s << leftanglebracket << *p.first << commaspace << *p.second << rightanglebracket;
   return s;
}

/**
   @brief Allows a (possibly recursive) container of anything with operator<< to 
   be dumped to a stream.

   
   This is particularly useful within a Log call.
   e.g.
   @code
   void logNameAddrs(vector<resip::NameAddr>& contacts)
   {
      DebugLog(<< "Contacts: " << Inserter(contacts));
   }
   @endcode

   @see Inserter()
 */
template <class T>
class InserterPClass
{
   public:
      InserterPClass(const T& t)
         : _t(t)
      {}
      
      const T& _t;
};

/// Function to allow an Inserter to be used directly with a stream
template <class T>
EncodeStream&
operator<<(EncodeStream& s, const InserterPClass<T>& inserter)
{
#if defined(WIN32) && defined(_MSC_VER) && (_MSC_VER < 1310)
	assert(0); // CJ - really need to fix this
	return s;
#else
   return insertP(s, inserter._t);
#endif
}

/// Templatized function to construct an instance of InserterClass for a
/// container to be inserted. The function induces the template type, saving the
/// user from thinking about it.
template <class T>
InserterPClass<T>
InserterP(const T& t)
{
   return InserterPClass<T>(t);
}
 
} // resip

#endif

/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */