NisusWrtText.hxx Source File documentation

NisusWrtText.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 * Parser to Nisus text document
36 *
37 */
38 #ifndef NISUS_WRT_TEXT
39 # define NISUS_WRT_TEXT
40
41 #include "libmwaw_internal.hxx"
42 #include "MWAWDebug.hxx"
43
44 #include "NisusWrtStruct.hxx"
45
46 namespace NisusWrtTextInternal
47 {
48 class SubDocument;
49 struct Paragraph;
50 struct State;
51 }
52
53 class NisusWrtParser;
54
60 class NisusWrtText
61 {
62 friend class NisusWrtTextInternal::SubDocument;
63 friend class NisusWrtParser;
64 public:
66 explicit NisusWrtText(NisusWrtParser &parser);
68 virtual ~NisusWrtText();
69
71 int version() const;
72
74 int numPages() const;
75
76 protected:
77
79 bool createZones();
80
82 std::shared_ptr<MWAWSubDocument> getHeader(int page, int &numSimillar);
84 std::shared_ptr<MWAWSubDocument> getFooter(int page, int &numSimillar);
85
87 bool sendMainText();
88
90 void flushExtra();
91
95 bool sendText(MWAWEntry const &entry, NisusWrtStruct::Position fPos=NisusWrtStruct::Position());
96
98 bool sendFootnote(int footnoteId);
99
101 bool sendHeaderFooter(int hfId);
102
103 //
104 // intermediate level
105 //
106
108 void computePositions();
109
111 void setProperty(NisusWrtTextInternal::Paragraph const &ruler, int width);
112
114 bool readFontsList(MWAWEntry const &entry);
116 bool readHeaderFooter(MWAWEntry const &entry);
118 bool readFootnotes(MWAWEntry const &entry);
119
121 bool readFonts(MWAWEntry const &entry);
123 bool readPosToFont(MWAWEntry const &entry, NisusWrtStruct::ZoneType zoneId);
124
126 bool readParagraphs(MWAWEntry const &entry, NisusWrtStruct::ZoneType zoneId);
127
129 bool readPICD(MWAWEntry const &entry, NisusWrtStruct::ZoneType zoneId);
130
131 //
132 // low level
133 //
134
136 long findFilePos(NisusWrtStruct::ZoneType zoneId, NisusWrtStruct::Position const &pos);
137 private:
138 NisusWrtText(NisusWrtText const &orig) = delete;
139 NisusWrtText &operator=(NisusWrtText const &orig) = delete;
140
141 protected:
142 //
143 // data
144 //
146 MWAWParserStatePtr m_parserState;
147
149 std::shared_ptr<NisusWrtTextInternal::State> m_state;
150
152 NisusWrtParser *m_mainParser;
153
154 };
155 #endif
156 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
NisusWrtText
the main class to read the text part of Nisus file
Definition: NisusWrtText.hxx:60
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
NisusWrtText::readPICD
bool readPICD(MWAWEntry const &entry, NisusWrtStruct::ZoneType zoneId)
read the PICD resource: a list of pict link to the paragraph
Definition: NisusWrtText.cxx:1424
libmwaw_internal.hxx
NisusWrtText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: NisusWrtText.cxx:1878
NisusWrtText::computePositions
void computePositions()
compute the positions
Definition: NisusWrtText.cxx:563
NisusWrtText::readPosToFont
bool readPosToFont(MWAWEntry const &entry, NisusWrtStruct::ZoneType zoneId)
read the FRMT resource: a list of filepos -> fontId
Definition: NisusWrtText.cxx:983
NisusWrtText::setProperty
void setProperty(NisusWrtTextInternal::Paragraph const &ruler, int width)
sends a paragraph property to the listener
Definition: NisusWrtText.cxx:1033
NisusWrtText::sendText
bool sendText(MWAWEntry const &entry, NisusWrtStruct::Position fPos=NisusWrtStruct::Position())
read a text entry.
Definition: NisusWrtText.cxx:1593
NisusWrtStruct::Position
a position
Definition: NisusWrtStruct.hxx:56
NisusWrtStruct.hxx
NisusWrtText::readFootnotes
bool readFootnotes(MWAWEntry const &entry)
read the footnote main entry
Definition: NisusWrtText.cxx:1349
NisusWrtText::sendHeaderFooter
bool sendHeaderFooter(int hfId)
try to send the ith header footer
Definition: NisusWrtText.cxx:1529
NisusWrtText::version
int version() const
returns the file version
Definition: NisusWrtText.cxx:507
NisusWrtText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: NisusWrtText.hxx:146
NisusWrtText::getFooter
std::shared_ptr< MWAWSubDocument > getFooter(int page, int &numSimillar)
return a footer subdocument
Definition: NisusWrtText.cxx:542
NisusWrtTextInternal::Paragraph
Internal: class to store the paragraph properties.
Definition: NisusWrtText.cxx:134
NisusWrtTextInternal
Internal: the structures of a NisusWrtText.
Definition: NisusWrtText.cxx:59
NisusWrtParser
the main class to read a Nisus Writer file
Definition: NisusWrtParser.hxx:59
NisusWrtText::~NisusWrtText
virtual ~NisusWrtText()
destructor
Definition: NisusWrtText.cxx:503
NisusWrtText::readParagraphs
bool readParagraphs(MWAWEntry const &entry, NisusWrtStruct::ZoneType zoneId)
read the RULE resource: a list of paragraphs
Definition: NisusWrtText.cxx:1045
NisusWrtText::findFilePos
long findFilePos(NisusWrtStruct::ZoneType zoneId, NisusWrtStruct::Position const &pos)
find the file pos which correspond to a pos
Definition: NisusWrtText.cxx:1481
NisusWrtText::numPages
int numPages() const
returns the number of pages
Definition: NisusWrtText.cxx:514
NisusWrtStruct::ZoneType
ZoneType
the different zone
Definition: NisusWrtStruct.hxx:50
MWAWDebug.hxx
NisusWrtText::m_mainParser
NisusWrtParser * m_mainParser
the main parser;
Definition: NisusWrtText.hxx:152
NisusWrtText::createZones
bool createZones()
finds the different text zones
Definition: NisusWrtText.cxx:640
NisusWrtTextInternal::SubDocument
Internal: the subdocument of a NisusWrtText.
Definition: NisusWrtText.cxx:427
NisusWrtText::sendMainText
bool sendMainText()
send a main zone
Definition: NisusWrtText.cxx:1864
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
NisusWrtText::readFontsList
bool readFontsList(MWAWEntry const &entry)
read the list of fonts
Definition: NisusWrtText.cxx:773
NisusWrtText::sendFootnote
bool sendFootnote(int footnoteId)
try to send the ith footnote
Definition: NisusWrtText.cxx:1561
NisusWrtText::getHeader
std::shared_ptr< MWAWSubDocument > getHeader(int page, int &numSimillar)
return an header subdocument
Definition: NisusWrtText.cxx:522
NisusWrtText::NisusWrtText
NisusWrtText(NisusWrtParser &parser)
constructor
Definition: NisusWrtText.cxx:496
NisusWrtText::operator=
NisusWrtText & operator=(NisusWrtText const &orig)=delete
NisusWrtText::readFonts
bool readFonts(MWAWEntry const &entry)
read the FTAB/STYL resource: a list of fonts
Definition: NisusWrtText.cxx:827
NisusWrtText::readHeaderFooter
bool readHeaderFooter(MWAWEntry const &entry)
read the header/footer main entry
Definition: NisusWrtText.cxx:1269
NisusWrtText::m_state
std::shared_ptr< NisusWrtTextInternal::State > m_state
the state
Definition: NisusWrtText.hxx:149