/*
    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>

    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 2 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, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

/** @file  src/util.h
 *  @brief Utility methods.
 */

#include <boost/optional.hpp>
#include <boost/shared_ptr.hpp>
#include <string>

class locked_stringstream;

namespace sub {

class Reader;

extern bool empty_or_white_space (std::string s);
extern void remove_unicode_bom (boost::optional<std::string>& line);
extern boost::optional<std::string> get_line_stringstream (locked_stringstream* str);
extern boost::optional<std::string> get_line_file (FILE* f);
extern boost::optional<std::string> get_line_string (std::string* s);
extern void dump (boost::shared_ptr<const Reader> read, std::ostream& os);

}