extended_io.h

Go to the documentation of this file.

/** @file
 *  @author Bram de Greve (bramz@users.sourceforge.net)
 *  @author Tom De Muer (tomdemuer@users.sourceforge.net)
 *
 *  *** BEGIN LICENSE INFORMATION ***
 *  
 *  The contents of this file are subject to the Common Public Attribution License 
 *  Version 1.0 (the "License"); you may not use this file except in compliance with 
 *  the License. You may obtain a copy of the License at 
 *  http://lass.sourceforge.net/cpal-license. The License is based on the 
 *  Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover 
 *  use of software over a computer network and provide for limited attribution for 
 *  the Original Developer. In addition, Exhibit A has been modified to be consistent 
 *  with Exhibit B.
 *  
 *  Software distributed under the License is distributed on an "AS IS" basis, WITHOUT 
 *  WARRANTY OF ANY KIND, either express or implied. See the License for the specific 
 *  language governing rights and limitations under the License.
 *  
 *  The Original Code is LASS - Library of Assembled Shared Sources.
 *  
 *  The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
 *  The Original Developer is the Initial Developer.
 *  
 *  All portions of the code written by the Initial Developer are:
 *  Copyright (C) 2004-2007 the Initial Developer.
 *  All Rights Reserved.
 *  
 *  Contributor(s):
 *
 *  Alternatively, the contents of this file may be used under the terms of the 
 *  GNU General Public License Version 2 or later (the GPL), in which case the 
 *  provisions of GPL are applicable instead of those above.  If you wish to allow use
 *  of your version of this file only under the terms of the GPL and not to allow 
 *  others to use your version of this file under the CPAL, indicate your decision by 
 *  deleting the provisions above and replace them with the notice and other 
 *  provisions required by the GPL License. If you do not delete the provisions above,
 *  a recipient may use your version of this file under either the CPAL or the GPL.
 *  
 *  *** END LICENSE INFORMATION ***
 */



/** @defgroup extended_io
 *  @brief extra insertors and extractors.
 *  @author Bram de Greve [BdG]
 *
 *  ExtendedIo groups additional stream operators for @c std::pair and standard containers like
 *  @c std::vector, @c std::list, ...  By including this header, it will possible to output
 *  these types to a stream, just like a regular float.
 *
 *  Currently, the containers only have output operators, only std::pair has both the output
 *  and input operator.  This will probably change in the future when there's a need for it.
 *
 *  The supported standard containers are @c std::vector, @c std::list, @c std::deque,
 *  @c std::map, @c std::multimap, @c std::set, @c std::multiset.
 *
 *  STLport specific: in case @c std::slist is detected as included, it is supported as well.
 *
 *  @code
 *  std::pair<int, std::string> a(5, "hello");
 *  std::cout << a; // (5, hello)
 *  std::cin >> a;
 *
 *  std::vector<int> b;
 *  b.push_back(1);
 *  b.push_back(2);
 *  b.push_back(3);
 *  std::cout << b; // [1, 2, 3]
 *
 *  std::map<std::string, int> c;
 *  c["foo"] = 1;
 *  c["bar"] = 2;
 *  c["spam"] = 3;
 *  c << map; // {bar: 2, foo: 1, spam: 3}
 *
 *  std::set<std::string> d;
 *  d.insert("foo");
 *  d.insert("bar");
 *  d.insert("spam");
 *  stream << d; // {bar, foo, spam}
 *  @endcode
 *
 *  @note we need to inject all this stuff in the std namespace for the look up thingies to work.
 */

#ifndef LASS_GUARDIAN_OF_INCLUSION_STDE_EXTENDED_IO_H
#define LASS_GUARDIAN_OF_INCLUSION_STDE_EXTENDED_IO_H

#include "stde_common.h"

namespace std
{

// output

template <typename T1, typename T2, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::pair<T1, T2>& x);

template <typename T, typename Alloc, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::vector<T, Alloc>& x);

template <typename T, typename Alloc, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::list<T, Alloc>& x);

template <typename T, typename Alloc, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::deque<T, Alloc>& x);

template <typename Key, typename Data, typename Comp, typename Alloc, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::map<Key, Data, Comp, Alloc>& x);

template <typename Key, typename Data, typename Comp, typename Alloc, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::multimap<Key, Data, Comp, Alloc>& x);

template <typename Key, typename Comp, typename Alloc, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::set<Key, Comp, Alloc>& x);

template <typename Key, typename Comp, typename Alloc, typename Char, typename Traits>
std::basic_ostream<Char, Traits>&
operator<<(std::basic_ostream<Char, Traits>& stream, const std::multiset<Key, Comp, Alloc>& x);



// input
/*
template <typename T1, typename T2, typename Char, typename Traits>
std::basic_istream<Char, Traits>&
operator>>(std::basic_istream<Char, Traits>& stream, std::pair<T1, T2>& x);

template <typename T, typename Alloc, typename Char, typename Traits>
std::basic_istream<Char, Traits>&
operator>>(std::basic_istream<Char, Traits>& stream, std::vector<T, Alloc>& x);

template <typename T, typename Alloc, typename Char, typename Traits>
std::basic_istream<Char, Traits>&
operator>>(std::basic_istream<Char, Traits>& stream, std::list<T, Alloc>& x);

template <typename T, typename Alloc, typename Char, typename Traits>
std::basic_istream<Char, Traits>&
operator>>(std::basic_istream<Char, Traits>& stream, std::deque<T, Alloc>& x);
*/
}

#include "extended_io.inl"

#endif

// EOF