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