utils/formats/json/reader.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_FORMATS_JSON_READER_H_
#define GENESIS_UTILS_FORMATS_JSON_READER_H_

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2017 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@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/

#include <iosfwd>
#include <string>

namespace genesis {
namespace utils {

// =================================================================================================
//     Forward declarations
// =================================================================================================

class InputStream;
class JsonDocument;

// =================================================================================================
//     Json Reader
// =================================================================================================

class JsonReader
{
public:

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

    JsonReader()  = default;
    ~JsonReader() = default;

    JsonReader( JsonReader const& ) = default;
    JsonReader( JsonReader&& )      = default;

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

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

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

    JsonDocument from_file   (const std::string& filename ) const;

    JsonDocument from_string (const std::string& json     ) const;

    // ---------------------------------------------------------------------
    //     Parsing Functions
    // ---------------------------------------------------------------------

    JsonDocument parse( InputStream& input_stream ) const;
    JsonDocument parse_value( InputStream& input_stream ) const;
    JsonDocument parse_array(  InputStream& input_stream ) const;
    JsonDocument parse_object( InputStream& input_stream ) const;
    JsonDocument parse_number( InputStream& input_stream ) const;

};

} // namespace utils
} // namespace genesis

#endif // include guard