MsWrdParser Class Referencefinal

the main class to read a Microsoft Word file More...

#include <MsWrdParser.hxx>

Inheritance diagram for MsWrdParser:
MWAWTextParser MWAWParser

Public Member Functions

 MsWrdParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor
 
 ~MsWrdParser () 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
 the main parse function
 
- 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
 
bool createZones ()
 finds the different zones
 
bool readHeaderEndV3 ()
 finish reading the header (v3)
 
bool readZoneList ()
 read the list of zones
 
bool readPrintInfo (MsWrdEntry &entry)
 read the print info zone
 
bool readPrinter (MsWrdEntry &entry)
 read the printer name
 
bool readDocSum (MsWrdEntry &entry)
 read the document sumary
 
bool readStringsZone (MsWrdEntry &entry, std::vector< std::string > &list)
 read a zone which consists in a list of string
 
bool readObjects ()
 read the objects
 
bool readObjectList (MsWrdEntry &entry)
 read the object list
 
bool readObjectFlags (MsWrdEntry &entry)
 read the object flags
 
bool readObject (MsWrdParserInternal::Object &obj)
 read an object
 
bool readDocumentInfo (MsWrdEntry &entry)
 read the page dimensions + ?
 
bool readZone17 (MsWrdEntry &entry)
 read the zone 17( some bdbox + text position ?)
 
bool checkPicturePos (long pos, int type)
 check if a position corresponds or not to a picture entry
 
bool readPicture (MsWrdEntry &entry)
 read a picture data
 
void sendPicture (long fPos, int cPos, MWAWPosition::AnchorTo anchor=MWAWPosition::Char)
 send a picture
 
bool getColor (int id, MWAWColor &col) const
 returns the color corresponding to an id
 
void newPage (int number)
 adds a new page
 
void sendFootnote (int id)
 try to send a footnote id
 
void sendFieldComment (int id)
 try to send a bookmark field id
 
void send (int id, libmwaw::SubDocumentType type)
 try to send a footnote, a field to the textParser
 
void send (MWAWEntry const &entry)
 try to send a text to the textParser
 
void sendSimpleTextZone (MWAWListenerPtr &listener, MWAWEntry const &entry)
 try to send a simple text zone(ie. a comment)
 
MsWrdEntry readEntry (std::string type, int id=-1)
 read a file entry
 
- 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< MsWrdParserInternal::Statem_state
 the state
 
std::multimap< std::string, MsWrdEntrym_entryMap
 the list of entries
 
std::shared_ptr< MsWrdTextm_textParser
 the text parser
 

Friends

class MsWrdText
 
class MsWrdTextStyles
 
class MsWrdParserInternal::SubDocument
 

Detailed Description

the main class to read a Microsoft Word file

Constructor & Destructor Documentation

◆ MsWrdParser()

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

constructor

◆ ~MsWrdParser()

MsWrdParser::~MsWrdParser ( )
final

destructor

Member Function Documentation

◆ checkHeader()

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

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse().

◆ checkPicturePos()

bool MsWrdParser::checkPicturePos ( long  pos,
int  type 
)
protected

check if a position corresponds or not to a picture entry

Referenced by MsWrdTextStyles::readFont().

◆ createDocument()

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

creates the listener which will be associated to the document

Referenced by parse().

◆ createZones()

bool MsWrdParser::createZones ( )
protected

finds the different zones

Referenced by parse().

◆ getColor()

bool MsWrdParser::getColor ( int  id,
MWAWColor col 
) const
protected

returns the color corresponding to an id

Referenced by MsWrdTextStyles::readFont().

◆ init()

void MsWrdParser::init ( )
protected

inits all internal variables

Referenced by MsWrdParser().

◆ newPage()

void MsWrdParser::newPage ( int  number)
protected

adds a new page

Referenced by MsWrdText::sendText().

◆ parse()

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

the main parse function

Implements MWAWTextParser.

◆ readDocSum()

bool MsWrdParser::readDocSum ( MsWrdEntry entry)
protected

read the document sumary

Referenced by createZones().

◆ readDocumentInfo()

bool MsWrdParser::readDocumentInfo ( MsWrdEntry entry)
protected

read the page dimensions + ?

Referenced by createZones().

◆ readEntry()

MsWrdEntry MsWrdParser::readEntry ( std::string  type,
int  id = -1 
)
protected

read a file entry

Referenced by readZoneList().

◆ readHeaderEndV3()

bool MsWrdParser::readHeaderEndV3 ( )
protected

finish reading the header (v3)

Referenced by checkHeader().

◆ readObject()

bool MsWrdParser::readObject ( MsWrdParserInternal::Object obj)
protected

read an object

Referenced by readObjects().

◆ readObjectFlags()

bool MsWrdParser::readObjectFlags ( MsWrdEntry entry)
protected

read the object flags

Referenced by readObjects().

◆ readObjectList()

bool MsWrdParser::readObjectList ( MsWrdEntry entry)
protected

read the object list

Referenced by readObjects().

◆ readObjects()

bool MsWrdParser::readObjects ( )
protected

read the objects

Referenced by createZones().

◆ readPicture()

bool MsWrdParser::readPicture ( MsWrdEntry entry)
protected

read a picture data

Referenced by createZones().

◆ readPrinter()

bool MsWrdParser::readPrinter ( MsWrdEntry entry)
protected

read the printer name

Referenced by createZones().

◆ readPrintInfo()

bool MsWrdParser::readPrintInfo ( MsWrdEntry entry)
protected

read the print info zone

Referenced by createZones().

◆ readStringsZone()

bool MsWrdParser::readStringsZone ( MsWrdEntry entry,
std::vector< std::string > &  list 
)
protected

read a zone which consists in a list of string

Referenced by readObjects().

◆ readZone17()

bool MsWrdParser::readZone17 ( MsWrdEntry entry)
protected

read the zone 17( some bdbox + text position ?)

Referenced by createZones().

◆ readZoneList()

bool MsWrdParser::readZoneList ( )
protected

read the list of zones

Referenced by createZones().

◆ send() [1/2]

void MsWrdParser::send ( int  id,
libmwaw::SubDocumentType  type 
)
protected

try to send a footnote, a field to the textParser

◆ send() [2/2]

void MsWrdParser::send ( MWAWEntry const &  entry)
protected

try to send a text to the textParser

◆ sendFieldComment()

void MsWrdParser::sendFieldComment ( int  id)
protected

try to send a bookmark field id

Referenced by MsWrdText::sendText().

◆ sendFootnote()

void MsWrdParser::sendFootnote ( int  id)
protected

try to send a footnote id

Referenced by MsWrdText::sendText().

◆ sendPicture()

void MsWrdParser::sendPicture ( long  fPos,
int  cPos,
MWAWPosition::AnchorTo  anchor = MWAWPosition::Char 
)
protected

send a picture

Referenced by MsWrdText::sendText().

◆ sendSimpleTextZone()

void MsWrdParser::sendSimpleTextZone ( MWAWListenerPtr listener,
MWAWEntry const &  entry 
)
protected

try to send a simple text zone(ie. a comment)

Friends And Related Function Documentation

◆ MsWrdParserInternal::SubDocument

friend class MsWrdParserInternal::SubDocument
friend

◆ MsWrdText

friend class MsWrdText
friend

Referenced by init().

◆ MsWrdTextStyles

friend class MsWrdTextStyles
friend

Member Data Documentation

◆ m_entryMap

std::multimap<std::string, MsWrdEntry> MsWrdParser::m_entryMap
protected

◆ m_state

◆ m_textParser

std::shared_ptr<MsWrdText> MsWrdParser::m_textParser
protected

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

Generated on Thu Jan 19 2023 00:00:00 for libmwaw by doxygen 1.9.6