BeagleWksParser Class Referencefinal

the main class to read a BeagleWorks file More...

#include <BeagleWksParser.hxx>

Inheritance diagram for BeagleWksParser:
MWAWTextParser MWAWParser

Public Member Functions

 BeagleWksParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor
 
 ~BeagleWksParser () 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 init ()
 inits all internal variables
 
void createDocument (librevenge::RVNGTextInterface *documentInterface)
 creates the listener which will be associated to the document
 
MWAWVec2f getPageLeftTop () const
 returns the page left top point ( in inches)
 
void newPage (int number)
 adds a new page
 
bool sendFrame (int pId)
 try to insert the pId picture (as char)
 
bool createZones ()
 finds the different objects zones
 
bool readRSRCZones ()
 read the resource fork zone
 
bool sendPageFrames ()
 try to send the page graphic
 
bool sendFrame (BeagleWksStructManager::Frame const &frame)
 try to send a frame
 
bool sendPicture (int pId, MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle())
 try to send a picture
 
bool readPrintInfo ()
 read the print info zone
 
bool readLastZone ()
 read the last zone
 
MWAWInputStreamPtr rsrcInput ()
 return the input input
 
libmwaw::DebugFilersrcAscii ()
 a DebugFile used to write what we recognize when we parse the document in rsrc
 
- 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< BeagleWksParserInternal::Statem_state
 the state
 
std::shared_ptr< BeagleWksStructManagerm_structureManager
 the structure manager
 
std::shared_ptr< BeagleWksTextm_textParser
 the text parser
 

Friends

class BeagleWksText
 

Detailed Description

the main class to read a BeagleWorks file

Constructor & Destructor Documentation

◆ BeagleWksParser()

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

constructor

◆ ~BeagleWksParser()

BeagleWksParser::~BeagleWksParser ( )
final

destructor

Member Function Documentation

◆ checkHeader()

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

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse().

◆ createDocument()

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

creates the listener which will be associated to the document

Referenced by parse().

◆ createZones()

bool BeagleWksParser::createZones ( )
protected

finds the different objects zones

Referenced by parse().

◆ getPageLeftTop()

MWAWVec2f BeagleWksParser::getPageLeftTop ( ) const
protected

returns the page left top point ( in inches)

◆ init()

void BeagleWksParser::init ( )
protected

inits all internal variables

Referenced by BeagleWksParser().

◆ newPage()

void BeagleWksParser::newPage ( int  number)
protected

adds a new page

Referenced by BeagleWksText::sendText().

◆ parse()

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

virtual function used to parse the input

Implements MWAWTextParser.

◆ readLastZone()

bool BeagleWksParser::readLastZone ( )
protected

read the last zone

Referenced by createZones().

◆ readPrintInfo()

bool BeagleWksParser::readPrintInfo ( )
protected

read the print info zone

Referenced by checkHeader(), and createZones().

◆ readRSRCZones()

bool BeagleWksParser::readRSRCZones ( )
protected

read the resource fork zone

Referenced by createZones().

◆ rsrcAscii()

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

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

◆ rsrcInput()

MWAWInputStreamPtr BeagleWksParser::rsrcInput ( )
protected

return the input input

◆ sendFrame() [1/2]

bool BeagleWksParser::sendFrame ( BeagleWksStructManager::Frame const &  frame)
protected

try to send a frame

◆ sendFrame() [2/2]

bool BeagleWksParser::sendFrame ( int  pId)
protected

try to insert the pId picture (as char)

Referenced by sendFrame(), sendPageFrames(), and BeagleWksText::sendText().

◆ sendPageFrames()

bool BeagleWksParser::sendPageFrames ( )
protected

try to send the page graphic

Referenced by parse().

◆ sendPicture()

bool BeagleWksParser::sendPicture ( int  pId,
MWAWPosition const &  pos,
MWAWGraphicStyle const &  style = MWAWGraphicStyle::emptyStyle() 
)
protected

try to send a picture

Referenced by sendFrame().

Friends And Related Function Documentation

◆ BeagleWksText

friend class BeagleWksText
friend

Referenced by init().

Member Data Documentation

◆ m_state

std::shared_ptr<BeagleWksParserInternal::State> BeagleWksParser::m_state
protected

◆ m_structureManager

std::shared_ptr<BeagleWksStructManager> BeagleWksParser::m_structureManager
protected

the structure manager

Referenced by createZones(), init(), readRSRCZones(), sendFrame(), sendPageFrames(), and sendPicture().

◆ m_textParser

std::shared_ptr<BeagleWksText> BeagleWksParser::m_textParser
protected

the text parser

Referenced by createDocument(), createZones(), init(), and parse().


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