src/util.h

   1 /*
   2     Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/util.h
  21  *  @brief Utility methods.
  22  */
  23
  24 #include <boost/optional.hpp>
  25 #include <memory>
  26 #include <string>
  27
  28 #define LIBSUB_UNUSED(x) (void)(x)
  29
  30 namespace sub {
  31
  32 class Reader;
  33
  34 extern bool empty_or_white_space (std::string s);
  35 extern void remove_unicode_bom (boost::optional<std::string>& line);
  36 extern boost::optional<std::string> get_line_file (FILE* f);
  37 extern boost::optional<std::string> get_line_string (std::string* s);
  38 extern void dump (std::shared_ptr<const Reader> read, std::ostream& os);
  39
  40 }