RagTime5Parser.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2 
3 /* libmwaw
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33 
34 /*
35  * Main parser of RagTime 5-6 document
36  *
37  */
38 #ifndef RAGTIME_5_PARSER
39 # define RAGTIME_5_PARSER
40 
41 #include <set>
42 #include <string>
43 #include <vector>
44 
45 #include <librevenge/librevenge.h>
46 
47 #include "MWAWEntry.hxx"
48 #include "MWAWPosition.hxx"
49 
50 #include "MWAWParser.hxx"
51 
52 namespace RagTime5ParserInternal
53 {
54 struct State;
55 class SubDocument;
56 }
57 
58 class RagTime5Document;
59 
65 class RagTime5Parser final : public MWAWTextParser
66 {
68  friend class RagTime5Document;
69 
70 public:
72  RagTime5Parser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
74  ~RagTime5Parser() final;
75 
77  bool checkHeader(MWAWHeader *header, bool strict=false) final;
78 
79  // the main parse function
80  void parse(librevenge::RVNGTextInterface *documentInterface) final;
81 
82 protected:
84  void init();
85 
87  void createDocument(librevenge::RVNGTextInterface *documentInterface);
88 
90  void newPage(int number, bool softBreak);
91 
92  //
93  // interface with the text parser
94  //
95 
97  void sendFootnote(int zoneId);
98 
99 protected:
100 
101  //
102  // data
103  //
105  std::shared_ptr<RagTime5ParserInternal::State> m_state;
106 
108  std::shared_ptr<RagTime5Document> m_document;
109 };
110 #endif
111 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: RagTime5Parser.cxx:185
void init()
inits all internal variables
Definition: RagTime5Parser.cxx:143
Definition: MWAWDocument.hxx:56
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: RagTime5Parser.cxx:197
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: RagTime5Parser.cxx:229
std::shared_ptr< RagTime5ParserInternal::State > m_state
the state
Definition: RagTime5Parser.hxx:105
RagTime5Parser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: RagTime5Parser.cxx:131
Internal: the structures of a RagTime5Parser.
Definition: RagTime5Parser.cxx:55
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
void sendFootnote(int zoneId)
creates a document to send a footnote
Definition: RagTime5Parser.cxx:178
Internal: the subdocument of a RagTime5Parser.
Definition: RagTime5Parser.cxx:73
~RagTime5Parser() final
destructor
Definition: RagTime5Parser.cxx:139
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:298
the main class to parse a RagTime 5-6 file
Definition: RagTime5Parser.hxx:65
void newPage(int number, bool softBreak)
adds a new page
Definition: RagTime5Parser.cxx:159
std::shared_ptr< RagTime5Document > m_document
the main document manager
Definition: RagTime5Parser.hxx:108
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:76

Generated for libmwaw by doxygen 1.8.14