NisusWrtParser.hxx Source File documentation

NisusWrtParser.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 NISUS_WRT_PARSER
35# define NISUS_WRT_PARSER
36
37#include <string>
38#include <vector>
39
40#include <librevenge/librevenge.h>
41
42#include "MWAWDebug.hxx"
43#include "MWAWInputStream.hxx"
44
45#include "NisusWrtStruct.hxx"
46
47#include "MWAWParser.hxx"
48
49namespace NisusWrtParserInternal
50{
51struct State;
52}
53
54class NisusWrtGraph;
55class NisusWrtText;
56
59 class NisusWrtParser final : public MWAWTextParser
60{
61 friend struct NisusWrtStruct::RecursifData;
62 friend class NisusWrtGraph;
63 friend class NisusWrtText;
64public:
66 NisusWrtParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
68 ~NisusWrtParser() final;
69
71 bool checkHeader(MWAWHeader *header, bool strict=false) final;
72
73 // the main parse function
74 void parse(librevenge::RVNGTextInterface *documentInterface) final;
75
76protected:
78 void init();
79
81 void createDocument(librevenge::RVNGTextInterface *documentInterface);
82
84 MWAWVec2f getPageLeftTop() const;
86 void getColumnInfo(int &numColumns, float &colSep) const;
88 void getFootnoteInfo(NisusWrtStruct::FootnoteInfo &fInfo) const;
89
91 void newPage(int number);
92
93 // variable access
94
96 std::string getDateFormat(NisusWrtStruct::ZoneType zoneId, int vId) const;
97
99 bool getReferenceData(NisusWrtStruct::ZoneType zoneId, int vId,
100 MWAWField::Type &fType,
101 std::string &content,
102 std::vector<int> &number) const;
103
104 // interface with the graph parser
105
107 bool sendPicture(int pictId, MWAWPosition const &pictPos);
108
109protected:
111 bool createZones();
112
114 bool readPrintInfo(MWAWEntry const &entry);
116 bool readCPRC(MWAWEntry const &entry);
118 bool readPageLimit(MWAWEntry const &entry);
119
121 bool readStringsList(MWAWEntry const &entry, std::vector<std::string> &list, bool simpleList);
122
124 bool readINFO(MWAWEntry const &entry);
125
127 bool readReference(NisusWrtStruct::RecursifData const &data);
129 bool readVariable(NisusWrtStruct::RecursifData const &data);
131 bool readCNTR(MWAWEntry const &entry, int zoneId);
133 bool readNumberingReset(MWAWEntry const &entry, int zoneId);
134
136 bool readSGP1(NisusWrtStruct::RecursifData const &data);
138 bool readABBR(MWAWEntry const &entry);
140 bool readFTA2(MWAWEntry const &entry);
142 bool readFnSc(MWAWEntry const &entry);
143
145 MWAWInputStreamPtr rsrcInput();
146
148 libmwaw::DebugFile &rsrcAscii();
149
150 //
151 // data
152 //
154 std::shared_ptr<NisusWrtParserInternal::State> m_state;
155
157 std::shared_ptr<NisusWrtGraph> m_graphParser;
158
160 std::shared_ptr<NisusWrtText> m_textParser;
161};
162#endif
163// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWParser.hxx
NisusWrtStruct.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
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:299
MWAWVec2< float >
NisusWrtGraph
the main class to read the graphic part of a Nisus file
Definition: NisusWrtGraph.hxx:68
NisusWrtParser
the main class to read a Nisus Writer file
Definition: NisusWrtParser.hxx:60
NisusWrtParser::readStringsList
bool readStringsList(MWAWEntry const &entry, std::vector< std::string > &list, bool simpleList)
read a list of strings
Definition: NisusWrtParser.cxx:845
NisusWrtParser::getPageLeftTop
MWAWVec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition: NisusWrtParser.cxx:380
NisusWrtParser::readNumberingReset
bool readNumberingReset(MWAWEntry const &entry, int zoneId)
parse the DPND resource: numbering reset ( one by zone ) : related to CNTR and VRS ?
Definition: NisusWrtParser.cxx:1207
NisusWrtParser::readCNTR
bool readCNTR(MWAWEntry const &entry, int zoneId)
read the CNTR resource: a list of version controler ?
Definition: NisusWrtParser.cxx:1886
NisusWrtParser::readSGP1
bool readSGP1(NisusWrtStruct::RecursifData const &data)
parse the SGP1 resource: a unknown resource
Definition: NisusWrtParser.cxx:1441
NisusWrtParser::readFnSc
bool readFnSc(MWAWEntry const &entry)
parse the FnSc resource: a unknown resource, find in v6 document
Definition: NisusWrtParser.cxx:2031
NisusWrtParser::getReferenceData
bool getReferenceData(NisusWrtStruct::ZoneType zoneId, int vId, MWAWField::Type &fType, std::string &content, std::vector< int > &number) const
returns the fieldtype or a string corresponding to a variable
Definition: NisusWrtParser.cxx:431
NisusWrtParser::newPage
void newPage(int number)
adds a new page
Definition: NisusWrtParser.cxx:517
NisusWrtParser::readReference
bool readReference(NisusWrtStruct::RecursifData const &data)
parse the MRK7 resource
Definition: NisusWrtParser.cxx:1245
NisusWrtParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: NisusWrtParser.cxx:367
NisusWrtParser::getColumnInfo
void getColumnInfo(int &numColumns, float &colSep) const
returns the columns information
Definition: NisusWrtParser.cxx:386
NisusWrtParser::m_state
std::shared_ptr< NisusWrtParserInternal::State > m_state
the state
Definition: NisusWrtParser.hxx:154
NisusWrtParser::getFootnoteInfo
void getFootnoteInfo(NisusWrtStruct::FootnoteInfo &fInfo) const
returns the footnote information
Definition: NisusWrtParser.cxx:392
NisusWrtParser::readINFO
bool readINFO(MWAWEntry const &entry)
read the INFO info zone, an unknown zone of size 0x23a: to doo
Definition: NisusWrtParser.cxx:2068
NisusWrtParser::readFTA2
bool readFTA2(MWAWEntry const &entry)
parse the FTA2 resource: a list of ? find in v6 document
Definition: NisusWrtParser.cxx:1981
NisusWrtParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: NisusWrtParser.cxx:566
NisusWrtParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: NisusWrtParser.cxx:533
NisusWrtParser::m_graphParser
std::shared_ptr< NisusWrtGraph > m_graphParser
the graph parser
Definition: NisusWrtParser.hxx:157
NisusWrtParser::sendPicture
bool sendPicture(int pictId, MWAWPosition const &pictPos)
try to send a picture
Definition: NisusWrtParser.cxx:400
NisusWrtParser::m_textParser
std::shared_ptr< NisusWrtText > m_textParser
the text parser
Definition: NisusWrtParser.hxx:160
NisusWrtParser::~NisusWrtParser
~NisusWrtParser() final
destructor
Definition: NisusWrtParser.cxx:349
NisusWrtParser::readPageLimit
bool readPageLimit(MWAWEntry const &entry)
read the PGLY info zone ( id=128 )
Definition: NisusWrtParser.cxx:1647
NisusWrtParser::readABBR
bool readABBR(MWAWEntry const &entry)
parse the ABBR resource: a list of abreviation?
Definition: NisusWrtParser.cxx:1928
NisusWrtParser::createZones
bool createZones()
finds the different objects zones
Definition: NisusWrtParser.cxx:621
NisusWrtParser::getDateFormat
std::string getDateFormat(NisusWrtStruct::ZoneType zoneId, int vId) const
returns the date format corresponding to a variable id or ""
Definition: NisusWrtParser.cxx:412
NisusWrtParser::readPrintInfo
bool readPrintInfo(MWAWEntry const &entry)
read the print info zone ( id=128 )
Definition: NisusWrtParser.cxx:1580
NisusWrtParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: NisusWrtParser.cxx:803
NisusWrtParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: NisusWrtParser.cxx:372
NisusWrtParser::readCPRC
bool readCPRC(MWAWEntry const &entry)
read the CPRC info zone ( id=128 ), an unknown zone
Definition: NisusWrtParser.cxx:1848
NisusWrtParser::NisusWrtParser
NisusWrtParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: NisusWrtParser.cxx:340
NisusWrtParser::init
void init()
inits all internal variables
Definition: NisusWrtParser.cxx:353
NisusWrtParser::readVariable
bool readVariable(NisusWrtStruct::RecursifData const &data)
parse the DSPL/VARI/VRS resource: numbering definition, variable or variable ?
Definition: NisusWrtParser.cxx:927
NisusWrtText
the main class to read the text part of Nisus file
Definition: NisusWrtText.hxx:61
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
FreeHandParserInternal::ZoneType
ZoneType
the different zone type
Definition: FreeHandParser.cxx:65
NisusWrtParserInternal
Internal: the structures of a NisusWrtParser.
Definition: NisusWrtParser.cxx:58
NisusWrtStruct
a namespace used to regroup the different structure used to parse a Nisus File
Definition: NisusWrtStruct.cxx:42
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:51
librevenge
Definition: MWAWDocument.hxx:57
MWAWField
a field
Definition: libmwaw_internal.hxx:399
NisusWrtStruct::RecursifData
Internal: low level a structure helping to read recursifList.
Definition: NisusWrtStruct.hxx:145