MsWrd1Parser.hxx Source File documentation

MsWrd1Parser.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#ifndef MS_WRD1_PARSER
35# define MS_WRD1_PARSER
36
37#include <vector>
38
39#include "MWAWDebug.hxx"
40#include "MWAWInputStream.hxx"
41
42#include "MWAWParser.hxx"
43
44namespace MsWrd1ParserInternal
45{
46struct Font;
47struct Paragraph;
48struct State;
49class SubDocument;
50}
51
57 class MsWrd1Parser final : public MWAWTextParser
58{
59 friend class MsWrd1ParserInternal::SubDocument;
60public:
62 MsWrd1Parser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
64 ~MsWrd1Parser() final;
65
67 bool checkHeader(MWAWHeader *header, bool strict=false) final;
68
69 // the main parse function
70 void parse(librevenge::RVNGTextInterface *documentInterface) final;
71
72protected:
74 void init();
75
77 void createDocument(librevenge::RVNGTextInterface *documentInterface);
78
80 void sendMain();
81
83 void newPage(int number);
84
86 bool createZones();
87
89 bool sendText(MWAWEntry const &entry, bool main=false);
90
91 //
92 // internal level
93 //
94
96 bool readFont(long fPos, MsWrd1ParserInternal::Font &font);
97
99 bool readParagraph(long fPos, MsWrd1ParserInternal::Paragraph &para);
100
102 bool readFootnoteCorrespondance(MWAWVec2i limit);
103
105 bool readDocInfo(MWAWVec2i limit);
107 bool readZones(MWAWVec2i limit);
109 bool readPageBreak(MWAWVec2i limit);
110
112 bool prepareTextZones();
113
114 //
115 // low level
116 //
117
119 void removeLastCharIfEOL(MWAWEntry &entry);
121 bool readPLC(MWAWVec2i limits, int wh);
122
124 void setProperty(MsWrd1ParserInternal::Paragraph const &para);
125
126
127protected:
128 //
129 // data
130 //
132 std::shared_ptr<MsWrd1ParserInternal::State> m_state;
133};
134#endif
135// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWParser.hxx
MWAWEntry
basic class to store an entry in a file This contained :
Definition MWAWEntry.hxx:47
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition MWAWHeader.hxx:57
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition MWAWParser.hxx:299
MWAWVec2< int >
MsWrd1ParserInternal::SubDocument
Internal: the subdocument of a MsWrdParser.
Definition MsWrd1Parser.cxx:248
MsWrd1Parser
the main class to read a Microsoft Word 1 file
Definition MsWrd1Parser.hxx:58
MsWrd1Parser::MsWrd1Parser
MsWrd1Parser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition MsWrd1Parser.cxx:297
MsWrd1Parser::readFootnoteCorrespondance
bool readFootnoteCorrespondance(MWAWVec2i limit)
try to read the footnote correspondance ( zone2 )
Definition MsWrd1Parser.cxx:874
MsWrd1Parser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition MsWrd1Parser.cxx:395
MsWrd1Parser::m_state
std::shared_ptr< MsWrd1ParserInternal::State > m_state
the state
Definition MsWrd1Parser.hxx:132
MsWrd1Parser::init
void init()
inits all internal variables
Definition MsWrd1Parser.cxx:308
MsWrd1Parser::prepareTextZones
bool prepareTextZones()
prepare the data: separate header/footer zones to the main stream...
Definition MsWrd1Parser.cxx:532
MsWrd1Parser::sendMain
void sendMain()
try to send the main zone
Definition MsWrd1Parser.cxx:377
MsWrd1Parser::readPLC
bool readPLC(MWAWVec2i limits, int wh)
read the two first zones (char and paragraph)
Definition MsWrd1Parser.cxx:1119
MsWrd1Parser::removeLastCharIfEOL
void removeLastCharIfEOL(MWAWEntry &entry)
shorten an entry if the last character is EOL
Definition MsWrd1Parser.cxx:335
MsWrd1Parser::readZones
bool readZones(MWAWVec2i limit)
try to read the list of zones: separator between text and footnote? (zone 4)
Definition MsWrd1Parser.cxx:935
MsWrd1Parser::readFont
bool readFont(long fPos, MsWrd1ParserInternal::Font &font)
try to read a char property
Definition MsWrd1Parser.cxx:634
MsWrd1Parser::readDocInfo
bool readDocInfo(MWAWVec2i limit)
try to read the document info (zone 3)
Definition MsWrd1Parser.cxx:982
MsWrd1Parser::sendText
bool sendText(MWAWEntry const &entry, bool main=false)
send the text structure to the listener
Definition MsWrd1Parser.cxx:1222
MsWrd1Parser::createZones
bool createZones()
finds the different zones
Definition MsWrd1Parser.cxx:471
MsWrd1Parser::readPageBreak
bool readPageBreak(MWAWVec2i limit)
try to read the page break (zone 5)
Definition MsWrd1Parser.cxx:829
MsWrd1Parser::readParagraph
bool readParagraph(long fPos, MsWrd1ParserInternal::Paragraph &para)
try to read a paragraph property
Definition MsWrd1Parser.cxx:698
MsWrd1Parser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition MsWrd1Parser.cxx:1363
MsWrd1Parser::~MsWrd1Parser
~MsWrd1Parser() final
destructor
Definition MsWrd1Parser.cxx:304
MsWrd1Parser::newPage
void newPage(int number)
adds a new page
Definition MsWrd1Parser.cxx:322
MsWrd1Parser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition MsWrd1Parser.cxx:348
MsWrd1Parser::setProperty
void setProperty(MsWrd1ParserInternal::Paragraph const &para)
send the ruler properties
Definition MsWrd1Parser.cxx:1352
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition libmwaw_internal.hxx:561
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition libmwaw_internal.hxx:551
MsWrd1ParserInternal
Internal: the structures of a MsWrd1Parser.
Definition MsWrd1Parser.cxx:56
librevenge
Definition MWAWDocument.hxx:57