NSText.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 NS_TEXT
39 # define NS_TEXT
40 
41 #include "libmwaw_internal.hxx"
42 #include "MWAWDebug.hxx"
43 
44 #include "NSStruct.hxx"
45 
47 typedef shared_ptr<MWAWInputStream> MWAWInputStreamPtr;
48 
49 class MWAWEntry;
50 
51 class MWAWFont;
53 typedef shared_ptr<MWAWParserState> MWAWParserStatePtr;
54 
55 class MWAWSubDocument;
56 
57 namespace NSTextInternal
58 {
59 class SubDocument;
60 struct Paragraph;
61 struct State;
62 }
63 
64 class NSParser;
65 
71 class NSText
72 {
74  friend class NSParser;
75 public:
77  NSText(NSParser &parser);
79  virtual ~NSText();
80 
82  int version() const;
83 
85  int numPages() const;
86 
87 protected:
88 
90  bool createZones();
91 
93  shared_ptr<MWAWSubDocument> getHeader(int page, int &numSimillar);
95  shared_ptr<MWAWSubDocument> getFooter(int page, int &numSimillar);
96 
98  bool sendMainText();
99 
101  void flushExtra();
102 
107 
109  bool sendFootnote(int footnoteId);
110 
112  bool sendHeaderFooter(int hfId);
113 
114  //
115  // intermediate level
116  //
117 
119  void computePositions();
120 
122  void setProperty(NSTextInternal::Paragraph const &ruler, int width);
123 
125  bool readFontsList(MWAWEntry const &entry);
127  bool readHeaderFooter(MWAWEntry const &entry);
129  bool readFootnotes(MWAWEntry const &entry);
130 
132  bool readFonts(MWAWEntry const &entry);
134  bool readPosToFont(MWAWEntry const &entry, NSStruct::ZoneType zoneId);
135 
137  bool readParagraphs(MWAWEntry const &entry, NSStruct::ZoneType zoneId);
138 
140  bool readPICD(MWAWEntry const &entry, NSStruct::ZoneType zoneId);
141 
142  //
143  // low level
144  //
145 
147  long findFilePos(NSStruct::ZoneType zoneId, NSStruct::Position const &pos);
148 private:
149  NSText(NSText const &orig);
150  NSText &operator=(NSText const &orig);
151 
152 protected:
153  //
154  // data
155  //
158 
160  shared_ptr<NSTextInternal::State> m_state;
161 
164 
165 };
166 #endif
167 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
bool sendFootnote(int footnoteId)
try to send the ith footnote
Definition: NSText.cxx:1489
bool readParagraphs(MWAWEntry const &entry, NSStruct::ZoneType zoneId)
read the RULE resource: a list of paragraphs
Definition: NSText.cxx:974
shared_ptr< MWAWParserState > MWAWParserStatePtr
Definition: ACText.hxx:49
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
Definition: ACText.hxx:44
bool readFonts(MWAWEntry const &entry)
read the FTAB/STYL resource: a list of fonts
Definition: NSText.cxx:757
shared_ptr< MWAWSubDocument > getHeader(int page, int &numSimillar)
return an header subdocument
Definition: NSText.cxx:458
NSText & operator=(NSText const &orig)
bool createZones()
finds the different text zones
Definition: NSText.cxx:568
void computePositions()
compute the positions
Definition: NSText.cxx:493
ZoneType
the different zone
Definition: NSStruct.hxx:50
void setProperty(NSTextInternal::Paragraph const &ruler, int width)
sends a paragraph property to the listener
Definition: NSText.cxx:962
NSParser * m_mainParser
the main parser;
Definition: NSText.hxx:163
long findFilePos(NSStruct::ZoneType zoneId, NSStruct::Position const &pos)
find the file pos which correspond to a pos
Definition: NSText.cxx:1409
bool sendText(MWAWEntry entry, NSStruct::Position fPos=NSStruct::Position())
read a text entry.
Definition: NSText.cxx:1522
int numPages() const
returns the number of pages
Definition: NSText.cxx:450
Internal class used to read the file stream Internal class used to read the file stream, this class adds some usefull functions to the basic WPXInputStream:
Definition: MWAWInputStream.hxx:59
shared_ptr< NSTextInternal::State > m_state
the state
Definition: NSText.hxx:160
Class to store font.
Definition: MWAWFont.hxx:47
bool sendMainText()
send a main zone
Definition: NSText.cxx:1791
bool readHeaderFooter(MWAWEntry const &entry)
read the header/footer main entry
Definition: NSText.cxx:1197
a class to define the parser state
Definition: MWAWParser.hxx:60
bool readPICD(MWAWEntry const &entry, NSStruct::ZoneType zoneId)
read the PICD resource: a list of pict link to the paragraph
Definition: NSText.cxx:1352
bool sendHeaderFooter(int hfId)
try to send the ith header footer
Definition: NSText.cxx:1457
virtual ~NSText()
destructor
Definition: NSText.cxx:440
bool readPosToFont(MWAWEntry const &entry, NSStruct::ZoneType zoneId)
read the FRMT resource: a list of filepos -&gt; fontId
Definition: NSText.cxx:912
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:49
int version() const
returns the file version
Definition: NSText.cxx:443
Internal: the subdocument of a NSText.
Definition: NSText.cxx:369
the main class to read a Nisus Writer file
Definition: NSParser.hxx:63
Internal: class to store the paragraph properties.
Definition: NSText.cxx:124
bool readFontsList(MWAWEntry const &entry)
read the list of fonts
Definition: NSText.cxx:703
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: NSText.cxx:1805
shared_ptr< MWAWSubDocument > getFooter(int page, int &numSimillar)
return a footer subdocument
Definition: NSText.cxx:475
bool readFootnotes(MWAWEntry const &entry)
read the footnote main entry
Definition: NSText.cxx:1277
the main class to read the text part of Nisus file
Definition: NSText.hxx:71
NSText(NSParser &parser)
constructor
Definition: NSText.cxx:435
a position
Definition: NSStruct.hxx:56
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWParserStatePtr m_parserState
the parser state
Definition: NSText.hxx:157

Generated for libmwaw by doxygen 1.8.5