Some Doxygen comments.
[libsub.git] / src / dcp_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 #include "reader.h"
21 #include <boost/shared_ptr.hpp>
22
23 namespace cxml {
24         class Node;
25 }
26
27 namespace sub {
28
29 class DCPFont;  
30 class DCPText;
31 class DCPSubtitle;
32 class DCPLoadFont;
33
34 /** @class DCPReader
35  *  @brief A class which reads DCP subtitles.
36  */
37 class DCPReader : public Reader
38 {
39 public:
40         DCPReader (std::istream &);
41
42 private:
43
44         struct ParseState;
45         
46         void maybe_add_subtitle (std::string text, ParseState& parse_state);
47         
48         void examine_font_nodes (
49                 boost::shared_ptr<const cxml::Node> xml,
50                 std::list<boost::shared_ptr<DCPFont> > const & font_nodes,
51                 ParseState& parse_state
52                 );
53         
54         void examine_text_nodes (
55                 boost::shared_ptr<const cxml::Node> xml,
56                 std::list<boost::shared_ptr<DCPText> > const & text_nodes,
57                 ParseState& parse_state
58                 );
59
60         std::string font_id_to_name (std::string id) const;
61
62         std::list<boost::shared_ptr<DCPLoadFont> > _load_font_nodes;
63 };
64
65 }