xref: /freebsd/contrib/kyua/utils/stream.hpp (revision b0d29bc4)
1 // Copyright 2011 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/stream.hpp
30 /// Stream manipulation utilities.
31 ///
32 /// Note that file-manipulation utilities live in utils::fs instead.  The
33 /// utilities here deal with already-open streams.
34 
35 #if !defined(UTILS_STREAM_HPP)
36 #define UTILS_STREAM_HPP
37 
38 #include <cstddef>
39 #include <istream>
40 #include <memory>
41 #include <ostream>
42 #include <string>
43 
44 #include "utils/fs/path_fwd.hpp"
45 
46 namespace utils {
47 
48 
49 std::auto_ptr< std::ostream > open_ostream(const utils::fs::path&);
50 std::size_t stream_length(std::istream&);
51 std::string read_file(const utils::fs::path&);
52 std::string read_stream(std::istream&);
53 
54 
55 }  // namespace utils
56 
57 #endif  // !defined(UTILS_STREAM_HPP)
58