output_stream.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_IO_OUTPUT_STREAM_H_
#define GENESIS_UTILS_IO_OUTPUT_STREAM_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2023 Lucas Czech
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include "genesis/utils/core/exception.hpp"
#include "genesis/utils/core/fs.hpp"
#include "genesis/utils/core/options.hpp"
 
#include <cerrno>
#include <cstdio>
#include <cstring>
#include <fstream>
#include <sstream>
#include <stdexcept>
#include <string>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Output Stream
// =================================================================================================
 
inline void file_output_stream(
    std::string const&      file_name,
    std::ofstream&          out_stream,
    std::ios_base::openmode mode = std::ios_base::out,
    bool                    create_dirs = true
) {
    // Make sure that we are only overwriting if we are allowed to.
    if( ! Options::get().allow_file_overwriting() && utils::path_exists( file_name ) ) {
        throw ExistingFileError(
            "Output path '" + file_name + "' already exists. If you want to allow overwriting of "
            "existing files, activate genesis::utils::Options::get().allow_file_overwriting() first.",
            file_name
        );
    }
 
    // Create all parent dirs, if needed.
    if( create_dirs ) {
        auto const path = file_path( file_name );
        dir_create( path );
    }
 
    // Now prepare the stream and check that this worked.
    errno = 0;
    out_stream.open( file_name, mode );
    if( !out_stream.is_open() || out_stream.fail() ) {
        throw std::runtime_error(
            "Cannot open output file '" + file_name + "': " + std::string( strerror( errno ))
        );
    }
}
 
} // namespace utils
} // namespace genesis
 
#endif // include guard