taxopath_parser.hpp

Go to the documentation of this file.

#ifndef GENESIS_TAXONOMY_FORMATS_TAXOPATH_PARSER_H_
#define GENESIS_TAXONOMY_FORMATS_TAXOPATH_PARSER_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 <string>
#include <vector>
 
namespace genesis {
namespace taxonomy {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class Taxon;
class Taxopath;
 
// =================================================================================================
//     Taxopath Parser
// =================================================================================================
 
class TaxopathParser
{
public:
 
    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------
 
    TaxopathParser()  = default;
    ~TaxopathParser() = default;
 
    TaxopathParser( TaxopathParser const& ) = default;
    TaxopathParser( TaxopathParser&& )      = default;
 
    TaxopathParser& operator= ( TaxopathParser const& ) = default;
    TaxopathParser& operator= ( TaxopathParser&& )      = default;
 
    // -------------------------------------------------------------------------
    //     Parsing
    // -------------------------------------------------------------------------
 
    Taxopath parse( std::string const& taxopath ) const;
 
    Taxopath parse(  Taxon const& taxon ) const;
 
    // -------------------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------------------
 
    TaxopathParser& delimiters( std::string const& value )
    {
        delimiters_ = value;
        return *this;
    }
 
    std::string     delimiters() const
    {
        return delimiters_;
    }
 
    TaxopathParser& trim_whitespaces( bool value )
    {
        trim_whitespaces_ = value;
        return *this;
    }
 
    bool            trim_whitespaces() const
    {
        return trim_whitespaces_;
    }
 
    TaxopathParser& remove_trailing_delimiter( bool value )
    {
        remove_trailing_delimiter_ = value;
        return *this;
    }
 
    bool            remove_trailing_delimiter() const
    {
        return remove_trailing_delimiter_;
    }
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
private:
 
    std::string delimiters_                = ";";
    bool        trim_whitespaces_          = true;
    bool        remove_trailing_delimiter_ = true;
 
};
 
} // namespace taxonomy
} // namespace genesis
 
#endif // include guard