RagTime5Parser.hxx Source File documentation

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 {
67 friend class RagTime5ParserInternal::SubDocument;
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:
RagTime5ParserInternal::State::State
State()
constructor
Definition: RagTime5Parser.cxx:62
MWAWTextListenerPtr
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:567
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:298
RagTime5ParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: RagTime5Parser.cxx:68
RagTime5ParserInternal::SubDocument::parse
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: RagTime5Parser.cxx:104
MWAWNote
a note
Definition: libmwaw_internal.hxx:445
MWAWDocument::MWAW_K_SPREADSHEET
@ MWAW_K_SPREADSHEET
spreadsheet
Definition: MWAWDocument.hxx:86
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
RagTime5ParserInternal::SubDocument::operator!=
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: RagTime5Parser.cxx:85
RagTime5Parser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: RagTime5Parser.cxx:185
RagTime5ParserInternal::SubDocument::m_id
int m_id
the subdocument id
Definition: RagTime5Parser.cxx:99
RagTime5Parser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: RagTime5Parser.cxx:229
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:64
RagTime5StructManager.hxx
RagTime5Parser
the main class to parse a RagTime 5-6 file
Definition: RagTime5Parser.hxx:65
libmwaw::DebugFile::open
bool open(std::string const &filename)
opens/creates a file to store a result
Definition: MWAWDebug.cxx:46
MWAWEntry.hxx
RagTime5ParserInternal::SubDocument
Internal: the subdocument of a RagTime5Parser.
Definition: RagTime5Parser.cxx:73
RagTime5Document::NewPage
void(MWAWParser::* NewPage)(int page, bool softBreak)
callback used to send a page break
Definition: RagTime5Document.hxx:307
MWAWSubDocumentPtr
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:565
RagTime5Document.hxx
RagTime5ParserInternal::SubDocument::~SubDocument
~SubDocument() final
destructor
Definition: RagTime5Parser.cxx:82
MWAWParser::getTextListener
MWAWTextListenerPtr & getTextListener()
returns the text listener
Definition: MWAWParser.hxx:145
RagTime5Parser::m_document
std::shared_ptr< RagTime5Document > m_document
the main document manager
Definition: RagTime5Parser.hxx:108
MWAWSubDocument
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:41
RagTime5ParserInternal
Internal: the structures of a RagTime5Parser.
Definition: RagTime5Parser.cxx:55
MWAWParser::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:195
RagTime5Parser::newPage
void newPage(int number, bool softBreak)
adds a new page
Definition: RagTime5Parser.cxx:159
MWAWListener::SoftPageBreak
@ SoftPageBreak
Definition: MWAWListener.hxx:58
MWAWSubDocument.hxx
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:76
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:188
libmwaw::DebugFile::reset
void reset()
writes the current file and reset to zero
Definition: MWAWDebug.hxx:93
MWAWParser::getMainListener
MWAWListenerPtr getMainListener()
returns the main listener
Definition: MWAWParser.cxx:120
MWAWParser::setTextListener
void setTextListener(MWAWTextListenerPtr &listener)
sets the text listener
Definition: MWAWParser.cxx:158
MWAWParser::setAsciiName
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: MWAWParser.hxx:227
RagTime5Document::SendFootnote
void(MWAWParser::* SendFootnote)(int zoneId)
callback used to send a footnote
Definition: RagTime5Document.hxx:309
MWAWParser::getPageSpan
const MWAWPageSpan & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
RagTime5Parser::sendFootnote
void sendFootnote(int zoneId)
creates a document to send a footnote
Definition: RagTime5Parser.cxx:178
MWAWPosition.hxx
MWAWDocument::MWAW_K_TEXT
@ MWAW_K_TEXT
word processing file
Definition: MWAWDocument.hxx:82
RagTime5Parser::RagTime5Document
friend class RagTime5Document
Definition: RagTime5Parser.hxx:68
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:47
MWAWParser::asciiName
const std::string & asciiName() const
return the ascii file name
Definition: MWAWParser.hxx:232
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
MWAWListener::PageBreak
@ PageBreak
Definition: MWAWListener.hxx:58
RagTime5Parser::m_state
std::shared_ptr< RagTime5ParserInternal::State > m_state
the state
Definition: RagTime5Parser.hxx:105
libmwaw::DebugFile::setStream
void setStream(MWAWInputStreamPtr const &ip)
resets the input
Definition: MWAWDebug.hxx:81
RagTime5ParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: RagTime5Parser.cxx:68
libmwaw::ParseException
Definition: libmwaw_internal.hxx:143
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
RagTime5Parser::init
void init()
inits all internal variables
Definition: RagTime5Parser.cxx:143
RagTime5ParserInternal::State
Internal: the state of a RagTime5Parser.
Definition: RagTime5Parser.cxx:60
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWHeader.hxx
RagTime5Parser::RagTime5Parser
RagTime5Parser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: RagTime5Parser.cxx:131
RagTime5ParserInternal::SubDocument::m_position
MWAWPosition m_position
the subdocument position if defined
Definition: RagTime5Parser.cxx:101
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123
MWAWTextListener.hxx
MWAWSubDocument::m_parser
MWAWParser * m_parser
the main zone parser
Definition: MWAWSubDocument.hxx:75
RagTime5Parser::~RagTime5Parser
~RagTime5Parser() final
destructor
Definition: RagTime5Parser.cxx:139
MWAWNote::FootNote
@ FootNote
Definition: libmwaw_internal.hxx:447
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
librevenge
Definition: MWAWDocument.hxx:56
MWAWPageSpan::setMargins
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
MWAWParser.hxx
RagTime5Parser.hxx
MWAWParser::resetTextListener
void resetTextListener()
resets the listener
Definition: MWAWParser.cxx:163
RagTime5ParserInternal::SubDocument::SubDocument
SubDocument(RagTime5Parser &pars, MWAWInputStreamPtr const &input, int zoneId, MWAWPosition const &pos=MWAWPosition())
Definition: RagTime5Parser.cxx:76
RagTime5Parser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: RagTime5Parser.cxx:197