tree/formats/newick/input_iterator.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_FORMATS_NEWICK_INPUT_ITERATOR_H_
#define GENESIS_TREE_FORMATS_NEWICK_INPUT_ITERATOR_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2020 Lucas Czech and HITS gGmbH
 
    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@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/
 
#include "genesis/tree/tree.hpp"
#include "genesis/tree/formats/newick/reader.hpp"
#include "genesis/utils/io/input_source.hpp"
#include "genesis/utils/io/input_stream.hpp"
 
#include <iterator>
 
namespace genesis {
namespace tree {
 
// =================================================================================================
//     Newick Input Iterator
// =================================================================================================
 
class NewickInputIterator
{
public:
 
    // -------------------------------------------------------------------------
    //     Member Types
    // -------------------------------------------------------------------------
 
    using self_type         = NewickInputIterator;
    using iterator_category = std::input_iterator_tag;
 
    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------
 
    NewickInputIterator()
        : input_stream_( nullptr )
        , reader_()
        , tree_()
    {}
 
    explicit NewickInputIterator( std::shared_ptr<utils::BaseInputSource> source )
        : input_stream_( std::make_shared<utils::InputStream>( source ))
        , reader_()
        , tree_()
    {
        // Setting so that we only read one tree at a time.
        reader_.stop_after_semicolon( true );
 
        // Read first tree.
        increment();
    }
 
    NewickInputIterator( std::shared_ptr<utils::BaseInputSource> source, NewickReader const& settings )
        : input_stream_( std::make_shared<utils::InputStream>( source ))
        , reader_( settings )
        , tree_()
    {
        // Setting so that we only read one tree at a time.
        reader_.stop_after_semicolon( true );
 
        // Read first tree.
        increment();
    }
 
    ~NewickInputIterator() = default;
 
    NewickInputIterator( self_type const& ) = delete;
    NewickInputIterator( self_type&& )      = default;
 
    self_type& operator= ( self_type const& ) = delete;
    self_type& operator= ( self_type&& )      = default;
 
    // -------------------------------------------------------------------------
    //     Comparators
    // -------------------------------------------------------------------------
 
    bool operator == ( self_type const& other ) const
    {
        return input_stream_ == other.input_stream_;
    }
 
    bool operator != ( self_type const& other ) const
    {
        return !( *this == other );
    }
 
    explicit operator bool() const
    {
        return good_;
    }
 
    // -------------------------------------------------------------------------
    //     Accessors
    // -------------------------------------------------------------------------
 
    Tree const& operator * () const
    {
        return dereference();
    }
 
    Tree const* operator -> () const
    {
        return &dereference();
    }
 
    Tree const& dereference() const
    {
        return tree_;
    }
 
    // -------------------------------------------------------------------------
    //     Iteration
    // -------------------------------------------------------------------------
 
    self_type& begin()
    {
        return *this;
    }
 
    self_type end()
    {
        return self_type();
    }
 
    self_type& operator ++ ()
    {
        increment();
        return *this;
    }
 
    void increment()
    {
        // Check whether the input stream is good (not end-of-stream) and can be read from.
        // If not, we reached its end, so we stop reading in the next iteration.
        if( ! input_stream_ || ! *input_stream_ ) {
            good_ = false;
            return;
        }
 
        // Read the next tree.
        tree_ = reader_.parse_single_tree( *input_stream_ );
 
        // Check whether we actually got a tree. We use empty as marker for this,
        // which is valid, as we can never read an actual empty tree from any input
        // (it always consists of at least the root node).
        if( tree_.empty() ) {
            good_ = false;
        }
    }
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
private:
 
    std::shared_ptr<utils::InputStream> input_stream_;
 
    bool                good_ = true;
    NewickReader        reader_;
    Tree                tree_;
};
 
} // namespace tree
} // namespace genesis
 
#endif // include guard