src/io/basic_teebuf.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, 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.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#ifndef UTILS_MULTISTREAMBUF_HPP
#define UTILS_MULTISTREAMBUF_HPP
#include <streambuf>
#include <vector>
namespace OpenMD {

  /**
   * @class basic_teebuf basic_teebuf.hpp "utils/basic_teebuf.hpp"
   * @brief As a subclass of basic_streambuf,  basic_teebuf can operate on multiple stream simultaneously.
   * @code
   *    std::ofstream file1("file1");
   *    std::ofstream file2("file22");
   *    std::vector<std::streambuf*> buffers;
   *    buffers.push_back(file1.rdbuf());
   *    buffers.push_back(file2.rdbuf());
   *    teebuf tmp(buffers.begin(), buffers.end());
   *    std::ostream myOs(&tmp);
   *    myOs << "hello world";
   * @endcode
   */

  template <class CharT, class Traits = std::char_traits<CharT> > 
  class basic_teebuf: public std::basic_streambuf<CharT, Traits> { 
  public: 
    typedef std::basic_streambuf<CharT, Traits> streambuf_type; 
    typedef Traits traits_type; 
    typedef CharT char_type; 
    typedef typename traits_type::int_type int_type; 

    template <typename ForwardIterator>
    basic_teebuf(ForwardIterator begin, ForwardIterator end) : buffers_(begin, end){

    }

  protected:
    int_type overflow(int_type c = traits_type::eof()) {

      //avoid writing eof to stream
      if (c == traits_type::eof()) {
        return traits_type::eof();
      }
            
      typename std::vector<streambuf_type*>::iterator iter; //typename is needed since it's a dependant name
      for (iter = buffers_.begin(); iter != buffers_.end(); ++iter) {
        if ((*iter)->sputc(c) ==  traits_type::eof()) {
          return  traits_type::eof();
        }
      }

      return traits_type::not_eof(c); 
    }

    int sync() { 

      //flush buffer, checking return for eof. 
      if (traits_type::eq_int_type(overflow(traits_type::eof()), traits_type::eof())) { 
        return -1; 
      } 

      //flush streams
      typename std::vector<streambuf_type*>::iterator iter;
      for (iter = buffers_.begin(); iter != buffers_.end(); ++iter) {
        if ((*iter)->pubsync() == -1) {
          return -1;
        }
      }
            
      return 0; 
    } 
   
  private:
    std::vector<streambuf_type*> buffers_;
  };

  typedef basic_teebuf<char> TeeBuf; 

}
#endif
Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	4352 byte(s)
Log Message:	updated copyright notices
#	User	Rev	Content
1	gezelter	507	/*
2	tim	376	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	tim	376	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	tim	376	* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31	gezelter	1390	*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	tim	376	*/
42
43			#ifndef UTILS_MULTISTREAMBUF_HPP
44			#define UTILS_MULTISTREAMBUF_HPP
45			#include <streambuf>
46			#include <vector>
47	gezelter	1390	namespace OpenMD {
48	tim	376
49	gezelter	507	/**
50			* @class basic_teebuf basic_teebuf.hpp "utils/basic_teebuf.hpp"
51			* @brief As a subclass of basic_streambuf, basic_teebuf can operate on multiple stream simultaneously.
52			* @code
53			* std::ofstream file1("file1");
54			* std::ofstream file2("file22");
55			* std::vector<std::streambuf*> buffers;
56			* buffers.push_back(file1.rdbuf());
57			* buffers.push_back(file2.rdbuf());
58			* teebuf tmp(buffers.begin(), buffers.end());
59			* std::ostream myOs(&tmp);
60			* myOs << "hello world";
61			* @endcode
62			*/
63	tim	376
64	gezelter	507	template <class CharT, class Traits = std::char_traits<CharT> >
65			class basic_teebuf: public std::basic_streambuf<CharT, Traits> {
66			public:
67			typedef std::basic_streambuf<CharT, Traits> streambuf_type;
68			typedef Traits traits_type;
69			typedef CharT char_type;
70			typedef typename traits_type::int_type int_type;
71	tim	376
72	gezelter	507	template <typename ForwardIterator>
73			basic_teebuf(ForwardIterator begin, ForwardIterator end) : buffers_(begin, end){
74	tim	376
75	gezelter	507	}
76	tim	376
77	gezelter	507	protected:
78			int_type overflow(int_type c = traits_type::eof()) {
79	tim	376
80	gezelter	507	//avoid writing eof to stream
81			if (c == traits_type::eof()) {
82			return traits_type::eof();
83			}
84	tim	376
85	gezelter	507	typename std::vector<streambuf_type*>::iterator iter; //typename is needed since it's a dependant name
86			for (iter = buffers_.begin(); iter != buffers_.end(); ++iter) {
87			if ((*iter)->sputc(c) == traits_type::eof()) {
88			return traits_type::eof();
89			}
90			}
91	tim	376
92	gezelter	507	return traits_type::not_eof(c);
93			}
94	tim	376
95	gezelter	507	int sync() {
96	tim	376
97	gezelter	507	//flush buffer, checking return for eof.
98			if (traits_type::eq_int_type(overflow(traits_type::eof()), traits_type::eof())) {
99			return -1;
100			}
101	tim	376
102	gezelter	507	//flush streams
103			typename std::vector<streambuf_type*>::iterator iter;
104			for (iter = buffers_.begin(); iter != buffers_.end(); ++iter) {
105			if ((*iter)->pubsync() == -1) {
106			return -1;
107			}
108			}
109	tim	376
110	gezelter	507	return 0;
111			}
112	tim	376
113	gezelter	507	private:
114			std::vector<streambuf_type*> buffers_;
115			};
116	tim	376
117	gezelter	507	typedef basic_teebuf<char> TeeBuf;
118	tim	376
119			}
120			#endif