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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */

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

  /**
   * @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:	2204
Committed:	Fri Apr 15 22:04:00 2005 UTC (19 years, 2 months ago) by gezelter
File size:	4244 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	Content
1	/*
2	* 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	* 1. Acknowledgement of the program authors must be made in any
10	* publication of scientific results based in part on use of the
11	* program. An acceptable form of acknowledgement is citation of
12	* the article in which the program was described (Matthew
13	* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14	* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15	* Parallel Simulation Engine for Molecular Dynamics,"
16	* J. Comput. Chem. 26, pp. 252-271 (2005))
17	*
18	* 2. Redistributions of source code must retain the above copyright
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
41
42	#ifndef UTILS_MULTISTREAMBUF_HPP
43	#define UTILS_MULTISTREAMBUF_HPP
44	#include <streambuf>
45	#include <vector>
46	namespace oopse {
47
48	/**
49	* @class basic_teebuf basic_teebuf.hpp "utils/basic_teebuf.hpp"
50	* @brief As a subclass of basic_streambuf, basic_teebuf can operate on multiple stream simultaneously.
51	* @code
52	* std::ofstream file1("file1");
53	* std::ofstream file2("file22");
54	* std::vector<std::streambuf*> buffers;
55	* buffers.push_back(file1.rdbuf());
56	* buffers.push_back(file2.rdbuf());
57	* teebuf tmp(buffers.begin(), buffers.end());
58	* std::ostream myOs(&tmp);
59	* myOs << "hello world";
60	* @endcode
61	*/
62
63	template <class CharT, class Traits = std::char_traits<CharT> >
64	class basic_teebuf: public std::basic_streambuf<CharT, Traits> {
65	public:
66	typedef std::basic_streambuf<CharT, Traits> streambuf_type;
67	typedef Traits traits_type;
68	typedef CharT char_type;
69	typedef typename traits_type::int_type int_type;
70
71	template <typename ForwardIterator>
72	basic_teebuf(ForwardIterator begin, ForwardIterator end) : buffers_(begin, end){
73
74	}
75
76	protected:
77	int_type overflow(int_type c = traits_type::eof()) {
78
79	//avoid writing eof to stream
80	if (c == traits_type::eof()) {
81	return traits_type::eof();
82	}
83
84	typename std::vector<streambuf_type*>::iterator iter; //typename is needed since it's a dependant name
85	for (iter = buffers_.begin(); iter != buffers_.end(); ++iter) {
86	if ((*iter)->sputc(c) == traits_type::eof()) {
87	return traits_type::eof();
88	}
89	}
90
91	return traits_type::not_eof(c);
92	}
93
94	int sync() {
95
96	//flush buffer, checking return for eof.
97	if (traits_type::eq_int_type(overflow(traits_type::eof()), traits_type::eof())) {
98	return -1;
99	}
100
101	//flush streams
102	typename std::vector<streambuf_type*>::iterator iter;
103	for (iter = buffers_.begin(); iter != buffers_.end(); ++iter) {
104	if ((*iter)->pubsync() == -1) {
105	return -1;
106	}
107	}
108
109	return 0;
110	}
111
112	private:
113	std::vector<streambuf_type*> buffers_;
114	};
115
116	typedef basic_teebuf<char> TeeBuf;
117
118	}
119	#endif