STLIO.h

Go to the documentation of this file.

// # STLIO.h: text output IO for any STL-like container
// # Copyright (C) 2011
// # Associated Universities, Inc. Washington DC, USA.
// #
// # This library is free software; you can redistribute it and/or modify it
// # under the terms of the GNU Library General Public License as published by
// # the Free Software Foundation; either version 2 of the License, or (at your
// # option) any later version.
// #
// # This library is distributed in the hope that it will be useful, but WITHOUT
// # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
// # License for more details.
// #
// # You should have received a copy of the GNU Library General Public License
// # along with this library; if not, write to the Free Software Foundation,
// # Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
// #
// # Correspondence concerning AIPS++ should be addressed as follows:
// #        Internet email: casa-feedback@nrao.edu.
// #        Postal address: AIPS++ Project Office
// #                        National Radio Astronomy Observatory
// #                        520 Edgemont Road
// #                        Charlottesville, VA 22903-2475 USA
 
#ifndef CASA_STLIO_H
#define CASA_STLIO_H
 
// # Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/iostream.h>
#include <casacore/casa/Logging/LogIO.h>
#include <vector>
#include <set>
#include <list>
#include <map>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
// # Forward Declarations
class AipsIO;
 
template <typename T, typename U>
inline ostream& operator<<(ostream& os, const std::pair<T, U>& p);
 
template <typename T>
inline ostream& operator<<(ostream& os, const std::vector<T>& v);
 
template <typename T>
inline ostream& operator<<(ostream& os, const std::set<T>& v);
 
template <typename T>
inline ostream& operator<<(ostream& os, const std::list<T>& v);
 
template <typename T, typename U>
inline ostream& operator<<(ostream& os, const std::map<T, U>& m);
 
// <summary>
//    Input/output operators for STL-like containers.
// </summary>
 
// <use visibility=export>
 
// <reviewed reviewer="Paul Shannon" date="1995/02/21" tests="" demos="">
// </reviewed>
 
// <prerequisite>
//   <li> STL container concept
// </prerequisite>
 
// <synopsis>
// The function <src>showContainer</src> makes it possible to show
// any STL-like container (having forward iterators) on an ostream.
// This include casacore classes like Array, IPosition, and Block, but
// also STL classes like vector. The separator, prefix, and postfix
// can be defined at will (they default to , [ ]).
//
// The function <src>showDataIter</src> is similar to
// <src>showContainer</src>, but uses iterators directly.
// </synopsis>
 
// <example>
// <srcblock>
// IPosition shape (3,10,10,3);
// showContainer (cout, shape);
// </srcblock>
//
// <motivation>
// Effortless input/output is clearly a big win.
// </motivation>
//
// <group name="Container IO">
 
// Write out an ascii representation of any container using the
// given begin and end iterator.
// An arbitrary separator, prefix, and postfix can be given.
// E.g. for separator ', ' the output looks like [1, 2, 3].
template <class ITER>
void showDataIter(ostream&, ITER begin, const ITER& end, const char* separator = ",",
                  const char* prefix = "[", const char* postfix = "]");
 
// Write out an ascii representation of any container having a
// forward iterator.
// Note that a multi-dimensional Array object is linearized.
// An arbitrary separator, prefix, and postfix can be given.
// E.g. for separator ', ' the output looks like [1, 2, 3].
template <class CONTAINER>
void showContainer(ostream& os, const CONTAINER& c, const char* separator = ",",
                   const char* prefix = "[", const char* postfix = "]") {
  showDataIter(os, c.begin(), c.end(), separator, prefix, postfix);
}
 
// Write a std::pair.
template <typename T, typename U>
inline ostream& operator<<(ostream& os, const std::pair<T, U>& p) {
  os << '<' << p.first << ',' << p.second << '>';
  return os;
}
 
// Write the contents of a vector enclosed in square brackets, using a comma
// as separator.
template <typename T>
inline ostream& operator<<(ostream& os, const std::vector<T>& v) {
  showContainer(os, v, ",", "[", "]");
  return os;
}
 
// Write the contents of a set enclosed in square brackets, using a comma
// as separator.
template <typename T>
inline ostream& operator<<(ostream& os, const std::set<T>& v) {
  showContainer(os, v, ",", "[", "]");
  return os;
}
 
// Write the contents of a list enclosed in square brackets, using a comma
// as separator.
template <typename T>
inline ostream& operator<<(ostream& os, const std::list<T>& v) {
  showContainer(os, v, ",", "[", "]");
  return os;
}
 
// Print the contents of a map enclosed in braces, using a comma
// as separator.
template <typename T, typename U>
inline ostream& operator<<(ostream& os, const std::map<T, U>& m) {
  showContainer(os, m, ", ", "{", "}");
  return os;
}
 
// Print the contents of a container on LogIO.
// <group>
template <typename T>
inline LogIO& operator<<(LogIO& os, const std::vector<T>& a) {
  os.output() << a;
  return os;
}
template <typename T>
inline LogIO& operator<<(LogIO& os, const std::set<T>& a) {
  os.output() << a;
  return os;
}
template <typename T>
inline LogIO& operator<<(LogIO& os, const std::list<T>& a) {
  os.output() << a;
  return os;
}
template <typename T, typename U>
inline LogIO& operator<<(LogIO& os, const std::map<T, U>& a) {
  os.output() << a;
  return os;
}
// </group>
 
// Read or write the contents of an STL vector from/to AipsIO.
// The container is written in the same way as Block,
// thus can be read back that way and vice-versa.
// <group>
template <typename T>
AipsIO& operator>>(AipsIO& ios, std::vector<T>&);
template <typename T>
AipsIO& operator<<(AipsIO& ios, const std::vector<T>&);
// </group>
 
// Read and write the contents of a map object from/to AipsIO.
// It is done in the same way as the old SimpleOrderedMap class, so
// persistent SimpleOrderedMap objects in CTDS can be read as std::map
// and vice-versa.
template <typename K, typename V>
AipsIO& operator>>(AipsIO& ios, std::map<K, V>&);
template <typename K, typename V>
AipsIO& operator<<(AipsIO& ios, const std::map<K, V>&);
// </group>
 
}  // namespace casacore
 
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/casa/BasicSL/STLIO.tcc>
#endif  // # CASACORE_NO_AUTO_TEMPLATES
#endif