JazzSSParser Class Referencefinal

the main class to read a Jazz spreadsheet v1 (Lotus) document and some databases. More...

#include <JazzSSParser.hxx>

Inheritance diagram for JazzSSParser:
MWAWSpreadsheetParser MWAWParser

Public Member Functions

 JazzSSParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor
 
 ~JazzSSParser () final
 destructor
 
bool checkHeader (MWAWHeader *header, bool strict=false) final
 checks if the document header is correct (or not)
 
void parse (librevenge::RVNGSpreadsheetInterface *documentInterface) final
 the main parse function
 
- Public Member Functions inherited from MWAWSpreadsheetParser
 ~MWAWSpreadsheetParser () override
 destructor
 
virtual void parse (librevenge::RVNGSpreadsheetInterface *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::RVNGSpreadsheetInterface *documentInterface)
 creates the listener which will be associated to the document
 
bool createZones ()
 finds the different objects zones
 
bool sendSpreadsheet ()
 sends the spreadsheet
 
bool readZone11 (long endPos)
 reads a query/name/range... data (zone 11)
 
bool readCell (int id, long endPos)
 reads a cell content data
 
bool readSheetSize (long endPos)
 reads sheet size
 
bool readDocument (long endPos)
 read the basic document zones (zone 15): selection, columns' width, default font, preferences...
 
bool readCell (MWAWVec2i actPos, MWAWCellContent::FormulaInstruction &instr)
 
bool readFormula (long endPos, MWAWVec2i const &pos, std::vector< MWAWCellContent::FormulaInstruction > &formula, std::string &error)
 
- Protected Member Functions inherited from MWAWSpreadsheetParser
 MWAWSpreadsheetParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected)
 
 MWAWSpreadsheetParser (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< JazzSSParserInternal::Statem_state
 the state
 

Friends

class JazzSSParserInternal::SubDocument
 

Detailed Description

the main class to read a Jazz spreadsheet v1 (Lotus) document and some databases.

Note
need more files to be sure to treat all documents
a database is stored as a spreadsheet in the form [A][B] [C][empty] where [B] corresponds to the report's definitions and [C] corresponds to the database's contents

Constructor & Destructor Documentation

◆ JazzSSParser()

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

constructor

◆ ~JazzSSParser()

JazzSSParser::~JazzSSParser ( )
final

destructor

Member Function Documentation

◆ checkHeader()

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

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse().

◆ createDocument()

void JazzSSParser::createDocument ( librevenge::RVNGSpreadsheetInterface *  documentInterface)
protected

creates the listener which will be associated to the document

Referenced by parse().

◆ createZones()

bool JazzSSParser::createZones ( )
protected

finds the different objects zones

Referenced by parse().

◆ parse()

void JazzSSParser::parse ( librevenge::RVNGSpreadsheetInterface *  documentInterface)
finalvirtual

the main parse function

Implements MWAWSpreadsheetParser.

◆ readCell() [1/2]

bool JazzSSParser::readCell ( int  id,
long  endPos 
)
protected

reads a cell content data

Referenced by createZones(), and readFormula().

◆ readCell() [2/2]

bool JazzSSParser::readCell ( MWAWVec2i  actPos,
MWAWCellContent::FormulaInstruction instr 
)
protected

◆ readDocument()

bool JazzSSParser::readDocument ( long  endPos)
protected

read the basic document zones (zone 15): selection, columns' width, default font, preferences...

Referenced by createZones().

◆ readFormula()

bool JazzSSParser::readFormula ( long  endPos,
MWAWVec2i const &  pos,
std::vector< MWAWCellContent::FormulaInstruction > &  formula,
std::string &  error 
)
protected

Referenced by readCell().

◆ readSheetSize()

bool JazzSSParser::readSheetSize ( long  endPos)
protected

reads sheet size

Referenced by createZones().

◆ readZone11()

bool JazzSSParser::readZone11 ( long  endPos)
protected

reads a query/name/range... data (zone 11)

Referenced by createZones().

◆ sendSpreadsheet()

bool JazzSSParser::sendSpreadsheet ( )
protected

sends the spreadsheet

Referenced by parse().

Friends And Related Function Documentation

◆ JazzSSParserInternal::SubDocument

friend class JazzSSParserInternal::SubDocument
friend

Member Data Documentation

◆ m_state

std::shared_ptr<JazzSSParserInternal::State> JazzSSParser::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