base_input_source.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_IO_BASE_INPUT_SOURCE_H_
#define GENESIS_UTILS_IO_BASE_INPUT_SOURCE_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2024 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 <lucas.czech@sund.ku.dk>
    University of Copenhagen, Globe Institute, Section for GeoGenetics
    Oster Voldgade 5-7, 1350 Copenhagen K, Denmark
*/
 
#include "genesis/utils/core/fs.hpp"
 
#include <string>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Base Input Source
// =================================================================================================
 
class BaseInputSource
{
public:
 
    // -------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------
 
    BaseInputSource() = default;
 
    BaseInputSource( BaseInputSource const& ) = default;
    BaseInputSource( BaseInputSource&& )      = default;
 
    BaseInputSource& operator= ( BaseInputSource const& ) = default;
    BaseInputSource& operator= ( BaseInputSource&& )      = default;
 
    virtual ~BaseInputSource()
    {}
 
    // -------------------------------------------------------------
    //     Members
    // -------------------------------------------------------------
 
    size_t read( char* buffer, size_t size )
    {
        // Non-virtual interface.
        return read_( buffer, size );
    }
 
    std::string source_name() const
    {
        // Non-virtual interface.
        return source_name_();
    }
 
    std::string source_string() const
    {
        // Non-virtual interface.
        return source_string_();
    }
 
    bool is_trivial() const
    {
        // Non-virtual interface.
        return is_trivial_();
    }
 
    // -------------------------------------------------------------
    //     Internal Members
    // -------------------------------------------------------------
 
private:
 
    virtual size_t read_( char* buffer, size_t size ) = 0;
 
    virtual std::string source_name_() const = 0;
    virtual std::string source_string_() const = 0;
 
    // By default, we just assume trivial reading unless the derived class overrides this.
    virtual bool is_trivial_() const
    {
        return true;
    }
 
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard