JazzWriterParser Class Referencefinal

the main class to read a Jazz(Lotus) word file More...

#include <JazzWriterParser.hxx>

Inheritance diagram for JazzWriterParser:
MWAWTextParser MWAWParser

Public Member Functions

 JazzWriterParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor
 
 ~JazzWriterParser () final
 destructor
 
bool checkHeader (MWAWHeader *header, bool strict=false) final
 checks if the document header is correct (or not)
 
void parse (librevenge::RVNGTextInterface *documentInterface) final
 virtual function used to parse the input
 
- Public Member Functions inherited from MWAWTextParser
 ~MWAWTextParser () override
 destructor
 
virtual void parse (librevenge::RVNGTextInterface *documentInterface)=0
 virtual function used to parse the input
 
- Public Member Functions inherited from MWAWParser
virtual ~MWAWParser ()
 virtual destructor
 
virtual bool checkHeader (MWAWHeader *header, bool strict=false)=0
 virtual function used to check if the document header is correct (or not)
 
int version () const
 returns the works version
 
MWAWParserStatePtr getParserState ()
 returns the parser state
 
MWAWHeadergetHeader ()
 returns the header
 
MWAWInputStreamPtrgetInput ()
 returns the actual input
 
MWAWListenerPtr getMainListener ()
 returns the main listener
 
MWAWGraphicListenerPtrgetGraphicListener ()
 returns the graphic listener
 
MWAWPresentationListenerPtrgetPresentationListener ()
 returns the presentation listener
 
MWAWSpreadsheetListenerPtrgetSpreadsheetListener ()
 returns the spreadsheet listener
 
MWAWTextListenerPtrgetTextListener ()
 returns the text listener
 
MWAWFontConverterPtrgetFontConverter ()
 returns the font converter
 
MWAWFontManagerPtrgetFontManager ()
 returns the font manager
 
MWAWPageSpan const & getPageSpan () const
 returns the actual page dimension
 
MWAWPageSpangetPageSpan ()
 returns the actual page dimension
 
double getFormLength () const
 returns the form length
 
double getFormWidth () const
 returns the form width
 
double getPageLength () const
 returns the page length (form length without margin )
 
double getPageWidth () const
 returns the page width (form width without margin )
 
MWAWRSRCParserPtrgetRSRCParser ()
 returns the rsrc parser
 
libmwaw::DebugFileascii ()
 a DebugFile used to write what we recognize when we parse the document
 

Protected Member Functions

void createDocument (librevenge::RVNGTextInterface *documentInterface)
 creates the listener which will be associated to the document
 
bool readParagraph (MWAWEntry const &entry)
 tries to read the WPPD zones
 
bool readPLC (MWAWEntry const &entry)
 tries to read the WSCR zones
 
bool readZone (MWAWEntry const &entry)
 tries to read the WDoc zones
 
bool sendZone (unsigned zId)
 try to send a zone
 
bool sendParagraph (unsigned pId)
 try to send a paragraph
 
bool sendPLC (unsigned pId)
 try to send a plc
 
bool getPicture (unsigned pId, MWAWEmbeddedObject &obj)
 try to retrieve a picture
 
bool createZones ()
 finds the different objects zones
 
bool checkZones ()
 checks that the main zone exists (and its potential header/footer) and that there are valid.
 
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 number of characters
 
bool countCharactersInPLC (unsigned plcId, long &n)
 retrieve the number of characters corresponding to a PLC
 
MWAWInputStreamPtr rsrcInput ()
 return the input input
 
libmwaw::DebugFilersrcAscii ()
 a DebugFile used to write what we recognize when we parse the document in rsrc
 
bool readString (MWAWInputStreamPtr input, librevenge::RVNGString &string, long endPos)
 try to read a C-string
 
- Protected Member Functions inherited from MWAWTextParser
 MWAWTextParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected)
 
 MWAWTextParser (MWAWParserStatePtr const &state)
 constructor using a state
 
- Protected Member Functions inherited from MWAWParser
 MWAWParser (MWAWParserState::Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected)
 
 MWAWParser (MWAWParserStatePtr const &state)
 constructor using a state
 
void setVersion (int vers)
 sets the document's version
 
void setGraphicListener (MWAWGraphicListenerPtr &listener)
 sets the graphic listener
 
void resetGraphicListener ()
 resets the listener
 
void setPresentationListener (MWAWPresentationListenerPtr &listener)
 sets the presentation listener
 
void resetPresentationListener ()
 resets the listener
 
void setSpreadsheetListener (MWAWSpreadsheetListenerPtr &listener)
 sets the spreadsheet listener
 
void resetSpreadsheetListener ()
 resets the listener
 
void setTextListener (MWAWTextListenerPtr &listener)
 sets the text listener
 
void resetTextListener ()
 resets the listener
 
void setAsciiName (char const *name)
 Debugging: change the default ascii file.
 
std::string const & asciiName () const
 return the ascii file name
 

Protected Attributes

std::shared_ptr< JazzWriterParserInternal::Statem_state
 the state
 

Friends

class JazzWriterParserInternal::SubDocument
 

Detailed Description

the main class to read a Jazz(Lotus) word file

Constructor & Destructor Documentation

◆ JazzWriterParser()

JazzWriterParser::JazzWriterParser ( MWAWInputStreamPtr const &  input,
MWAWRSRCParserPtr const &  rsrcParser,
MWAWHeader header 
)

constructor

◆ ~JazzWriterParser()

JazzWriterParser::~JazzWriterParser ( )
final

destructor

Member Function Documentation

◆ checkHeader()

bool JazzWriterParser::checkHeader ( MWAWHeader header,
bool  strict = false 
)
finalvirtual

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse().

◆ checkParagraphs()

bool JazzWriterParser::checkParagraphs ( unsigned  id,
long &  num,
std::set< unsigned > &  seens 
) const
protected

check that a paragraph, its style and its followings exist (and do not create loops) and update the number of characters

Referenced by checkParagraphs(), and checkZones().

◆ checkZones()

bool JazzWriterParser::checkZones ( )
protected

checks that the main zone exists (and its potential header/footer) and that there are valid.

Enumerates also the number of characters in each zones and check that the data fork contains enough characters.

Referenced by createZones().

◆ countCharactersInPLC()

bool JazzWriterParser::countCharactersInPLC ( unsigned  plcId,
long &  n 
)
protected

retrieve the number of characters corresponding to a PLC

Referenced by checkParagraphs().

◆ createDocument()

void JazzWriterParser::createDocument ( librevenge::RVNGTextInterface *  documentInterface)
protected

creates the listener which will be associated to the document

Referenced by parse().

◆ createZones()

bool JazzWriterParser::createZones ( )
protected

finds the different objects zones

Referenced by parse().

◆ getPicture()

bool JazzWriterParser::getPicture ( unsigned  pId,
MWAWEmbeddedObject obj 
)
protected

try to retrieve a picture

Referenced by sendPLC().

◆ parse()

void JazzWriterParser::parse ( librevenge::RVNGTextInterface *  documentInterface)
finalvirtual

virtual function used to parse the input

Implements MWAWTextParser.

◆ readParagraph()

bool JazzWriterParser::readParagraph ( MWAWEntry const &  entry)
protected

tries to read the WPPD zones

Referenced by createZones().

◆ readPLC()

bool JazzWriterParser::readPLC ( MWAWEntry const &  entry)
protected

tries to read the WSCR zones

◆ readString()

bool JazzWriterParser::readString ( MWAWInputStreamPtr  input,
librevenge::RVNGString &  string,
long  endPos 
)
protected

try to read a C-string

Referenced by createZones().

◆ readZone()

bool JazzWriterParser::readZone ( MWAWEntry const &  entry)
protected

tries to read the WDoc zones

Referenced by createZones().

◆ rsrcAscii()

libmwaw::DebugFile & JazzWriterParser::rsrcAscii ( )
protected

a DebugFile used to write what we recognize when we parse the document in rsrc

Referenced by createZones(), getPicture(), readParagraph(), readZone(), and sendPLC().

◆ rsrcInput()

MWAWInputStreamPtr JazzWriterParser::rsrcInput ( )
protected

◆ sendParagraph()

bool JazzWriterParser::sendParagraph ( unsigned  pId)
protected

try to send a paragraph

Referenced by sendParagraph(), and sendZone().

◆ sendPLC()

bool JazzWriterParser::sendPLC ( unsigned  pId)
protected

try to send a plc

Referenced by sendParagraph().

◆ sendZone()

bool JazzWriterParser::sendZone ( unsigned  zId)
protected

try to send a zone

Referenced by parse().

Friends And Related Function Documentation

◆ JazzWriterParserInternal::SubDocument

Member Data Documentation

◆ m_state

std::shared_ptr<JazzWriterParserInternal::State> JazzWriterParser::m_state
protected

The documentation for this class was generated from the following files:

Generated on Wed May 3 2023 07:18:29 for libmwaw by doxygen 1.9.6