JazzWriterParser.hxx Source File documentation

JazzWriterParser.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 JAZZ_WRITER_PARSER
35# define JAZZ_WRITER_PARSER
36
37#include <set>
38#include <string>
39#include <vector>
40
41#include <librevenge/librevenge.h>
42
43#include "MWAWDebug.hxx"
44#include "MWAWInputStream.hxx"
45
46#include "MWAWParser.hxx"
47
48namespace JazzWriterParserInternal
49{
50class SubDocument;
51struct State;
52}
53
56 class JazzWriterParser final : public MWAWTextParser
57{
58 friend class JazzWriterParserInternal::SubDocument;
59public:
61 JazzWriterParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
63 ~JazzWriterParser() final;
64
66 bool checkHeader(MWAWHeader *header, bool strict=false) final;
67
68 // the main parse function
69 void parse(librevenge::RVNGTextInterface *documentInterface) final;
70
71protected:
73 void createDocument(librevenge::RVNGTextInterface *documentInterface);
74
76 bool readParagraph(MWAWEntry const &entry);
78 bool readPLC(MWAWEntry const &entry);
80 bool readZone(MWAWEntry const &entry);
81
83 bool sendZone(unsigned zId);
85 bool sendParagraph(unsigned pId);
87 bool sendPLC(unsigned pId);
89 bool getPicture(unsigned pId, MWAWEmbeddedObject &obj);
90
91protected:
93 bool createZones();
98 bool checkZones();
100 bool checkParagraphs(unsigned id, long &num, std::set<unsigned> &seens) const;
102 bool countCharactersInPLC(unsigned plcId, long &n);
103
105 MWAWInputStreamPtr rsrcInput();
107 libmwaw::DebugFile &rsrcAscii();
108
109 //
110 // data
111 //
112
114 bool readString(MWAWInputStreamPtr input, librevenge::RVNGString &string, long endPos);
115
117 std::shared_ptr<JazzWriterParserInternal::State> m_state;
118};
119#endif
120// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWParser.hxx
JazzWriterParserInternal::SubDocument
Internal: the subdocument of a JazzWriterParser.
Definition: JazzWriterParser.cxx:116
JazzWriterParser
the main class to read a Jazz(Lotus) word file
Definition: JazzWriterParser.hxx:57
JazzWriterParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: JazzWriterParser.cxx:692
JazzWriterParser::getPicture
bool getPicture(unsigned pId, MWAWEmbeddedObject &obj)
try to retrieve a picture
Definition: JazzWriterParser.cxx:929
JazzWriterParser::sendZone
bool sendZone(unsigned zId)
try to send a zone
Definition: JazzWriterParser.cxx:717
JazzWriterParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: JazzWriterParser.cxx:232
JazzWriterParser::readString
bool readString(MWAWInputStreamPtr input, librevenge::RVNGString &string, long endPos)
try to read a C-string
Definition: JazzWriterParser.cxx:662
JazzWriterParser::~JazzWriterParser
~JazzWriterParser() final
destructor
Definition: JazzWriterParser.cxx:185
JazzWriterParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: JazzWriterParser.cxx:194
JazzWriterParser::sendParagraph
bool sendParagraph(unsigned pId)
try to send a paragraph
Definition: JazzWriterParser.cxx:735
JazzWriterParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: JazzWriterParser.cxx:189
JazzWriterParser::m_state
std::shared_ptr< JazzWriterParserInternal::State > m_state
the state
Definition: JazzWriterParser.hxx:117
JazzWriterParser::readParagraph
bool readParagraph(MWAWEntry const &entry)
tries to read the WPPD zones
Definition: JazzWriterParser.cxx:454
JazzWriterParser::readPLC
bool readPLC(MWAWEntry const &entry)
tries to read the WSCR zones
JazzWriterParser::readZone
bool readZone(MWAWEntry const &entry)
tries to read the WDoc zones
Definition: JazzWriterParser.cxx:599
JazzWriterParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: JazzWriterParser.cxx:202
JazzWriterParser::checkZones
bool checkZones()
checks that the main zone exists (and its potential header/footer) and that there are valid.
Definition: JazzWriterParser.cxx:360
JazzWriterParser::checkParagraphs
bool checkParagraphs(unsigned id, long &num, std::set< unsigned > &seens) const
check that a paragraph, its style and its followings exist (and do not create loops) and update the n...
Definition: JazzWriterParser.cxx:394
JazzWriterParser::sendPLC
bool sendPLC(unsigned pId)
try to send a plc
Definition: JazzWriterParser.cxx:750
JazzWriterParser::countCharactersInPLC
bool countCharactersInPLC(unsigned plcId, long &n)
retrieve the number of characters corresponding to a PLC
Definition: JazzWriterParser.cxx:416
JazzWriterParser::createZones
bool createZones()
finds the different objects zones
Definition: JazzWriterParser.cxx:278
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
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
JazzWriterParserInternal
Internal: the structures of a JazzWriterParser.
Definition: JazzWriterParser.cxx:56
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
MWAWEmbeddedObject
small class use to define a embedded object
Definition: libmwaw_internal.hxx:467