fasta_reader.hpp

Go to the documentation of this file.

#ifndef GENESIS_SEQUENCE_FORMATS_FASTA_READER_H_
#define GENESIS_SEQUENCE_FORMATS_FASTA_READER_H_

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2018 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/utils/tools/char_lookup.hpp"

#include <iosfwd>
#include <string>

namespace genesis {

// =================================================================================================
//     Forward Declarations
// =================================================================================================

namespace utils {
    class InputStream;
}

namespace sequence {
    class SequenceSet;
    class Sequence;
}

// =================================================================================================
//     Fasta Reader
// =================================================================================================

namespace sequence {

class FastaReader
{
public:

    // ---------------------------------------------------------------------
    //     Typedefs and Enums
    // ---------------------------------------------------------------------

    enum class ParsingMethod
    {
        kDefault,

        kPedantic
    };

    enum class SiteCasing
    {
        kUnchanged,

        kToUpper,

        kToLower
    };

    // ---------------------------------------------------------------------
    //     Constructor and Rule of Five
    // ---------------------------------------------------------------------

    FastaReader();
    ~FastaReader() = default;

    FastaReader( FastaReader const& ) = default;
    FastaReader( FastaReader&& )      = default;

    FastaReader& operator= ( FastaReader const& ) = default;
    FastaReader& operator= ( FastaReader&& )      = default;

    // ---------------------------------------------------------------------
    //     Reading
    // ---------------------------------------------------------------------

    void from_stream( std::istream& input_stream, SequenceSet& sequence_set ) const;

    SequenceSet from_stream( std::istream& input_stream ) const;

    void from_file( std::string const& file_name, SequenceSet& sequence_set ) const;

    SequenceSet from_file( std::string const& file_name ) const;

    void from_string( std::string const& input_string, SequenceSet& sequence_set ) const;

    SequenceSet from_string( std::string const& input_string ) const;

    // ---------------------------------------------------------------------
    //     Parsing
    // ---------------------------------------------------------------------

    void parse_document(
        utils::InputStream& input_stream,
        SequenceSet&        sequence_set
    ) const;

    bool parse_sequence(
        utils::InputStream& input_stream,
        Sequence&           sequence
    ) const;

    bool parse_sequence_pedantic(
        utils::InputStream& input_stream,
        Sequence&           sequence
    ) const;

    // ---------------------------------------------------------------------
    //     Properties
    // ---------------------------------------------------------------------

    FastaReader&  parsing_method( ParsingMethod value );

    ParsingMethod parsing_method() const;

    FastaReader& site_casing( SiteCasing value );

    SiteCasing site_casing() const;

    FastaReader& valid_chars( std::string const& chars );

    std::string  valid_chars() const;

    utils::CharLookup<bool>& valid_char_lookup();

    // ---------------------------------------------------------------------
    //     Members
    // ---------------------------------------------------------------------

private:

    ParsingMethod           parsing_method_ = ParsingMethod::kDefault;

    SiteCasing              site_casing_    = SiteCasing::kToUpper;
    bool                    use_validation_ = false;
    utils::CharLookup<bool> lookup_;

};

} // namespace sequence
} // namespace genesis

#endif // include guard