src/reader.h

   1 /*
   2     Copyright (C) 2014 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 #ifndef LIBSUB_READER_H
  21 #define LIBSUB_READER_H
  22
  23 #include "raw_subtitle.h"
  24 #include <list>
  25 #include <map>
  26 #include <string>
  27
  28 struct subrip_reader_convert_line_test;
  29
  30 namespace sub {
  31
  32 /** @class Reader
  33  *  @brief Parent for classes which can read particular subtitle formats.
  34  */
  35 class Reader
  36 {
  37 public:
  38         std::list<RawSubtitle> subtitles () const {
  39                 return _subs;
  40         }
  41
  42         virtual std::map<std::string, std::string> metadata () const {
  43                 return std::map<std::string, std::string> ();
  44         }
  45
  46 protected:
  47         friend struct ::subrip_reader_convert_line_test;
  48
  49         void warn (std::string) const;
  50
  51         std::list<RawSubtitle> _subs;
  52 };
  53
  54 }
  55
  56 #endif