base_output_target.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_IO_BASE_OUTPUT_TARGET_H_
#define GENESIS_UTILS_IO_BASE_OUTPUT_TARGET_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/fs.hpp"
 
#include <ostream>
#include <string>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Base Output Target
// =================================================================================================
 
class BaseOutputTarget
{
public:
 
    // -------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------
 
    BaseOutputTarget() = default;
 
    BaseOutputTarget( BaseOutputTarget const& ) = default;
    BaseOutputTarget( BaseOutputTarget&& )      = default;
 
    BaseOutputTarget& operator= ( BaseOutputTarget const& ) = default;
    BaseOutputTarget& operator= ( BaseOutputTarget&& )      = default;
 
    virtual ~BaseOutputTarget()
    {}
 
    // -------------------------------------------------------------
    //     Members
    // -------------------------------------------------------------
 
    template<typename T>
    BaseOutputTarget& operator << ( T const& content )
    {
        out_stream_() << content;
        return *this;
    }
 
    std::ostream& ostream()
    {
        // Non-virtual interface.
        return out_stream_();
    }
 
    std::ostream& flush()
    {
        return out_stream_().flush();
    }
 
    std::string target_name() const
    {
        // Non-virtual interface.
        return target_name_();
    }
 
    std::string target_string() const
    {
        // Non-virtual interface.
        return target_string_();
    }
 
    // -------------------------------------------------------------
    //     Internal Members
    // -------------------------------------------------------------
 
private:
 
    // Non-virtual interface.
    virtual std::ostream& out_stream_() = 0;
    virtual std::string target_name_() const = 0;
    virtual std::string target_string_() const = 0;
 
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard