A toolkit for working with phylogenetic data.
v0.20.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
output_stream.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_IO_OUTPUT_STREAM_H_
2 #define GENESIS_UTILS_IO_OUTPUT_STREAM_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2017 Lucas Czech
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
36 
37 #include <fstream>
38 #include <sstream>
39 #include <stdexcept>
40 #include <string>
41 
42 namespace genesis {
43 namespace utils {
44 
45 // =================================================================================================
46 // Output Stream
47 // =================================================================================================
48 
67 inline void file_output_stream(
68  std::string const& filename,
69  std::ofstream& out_stream,
70  std::ios_base::openmode mode = std::ios_base::out
71 ) {
72  if( ! Options::get().allow_file_overwriting() && utils::file_exists( filename ) ) {
73  throw std::runtime_error(
74  "File '" + filename + "' already exists. If you want to allow overwriting of existing "
75  "files, activate Options::allow_file_overwriting() first."
76  );
77  }
78 
79  out_stream.open( filename, mode );
80  if( out_stream.fail() ) {
81  throw std::runtime_error( "Cannot write to file '" + filename + "'." );
82  }
83 }
84 
85 } // namespace utils
86 } // namespace genesis
87 
88 #endif // include guard
void file_output_stream(std::string const &filename, std::ofstream &out_stream, std::ios_base::openmode mode=std::ios_base::out)
Helper function to obtain an output stream to a file.
bool file_exists(std::string const &filename)
Return true iff the file exists.
Definition: fs.cpp:66
Provides functions for accessing the file system.
static Options & get()
Returns a single instance of this class.
Definition: options.hpp:60