MacDocParser Class Reference documentation

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MacDocParser Class Referencefinal

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

`#include <MacDocParser.hxx>`

Inheritance diagram for MacDocParser:

## Public Member Functions
| MacDocParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
| constructor
| ~MacDocParser () 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
MWAWHeader * | getHeader ()
| returns the header
MWAWInputStreamPtr & | getInput ()
| returns the actual input
MWAWListenerPtr | getMainListener ()
| returns the main listener
MWAWGraphicListenerPtr & | getGraphicListener ()
| returns the graphic listener
MWAWPresentationListenerPtr & | getPresentationListener ()
| returns the presentation listener
MWAWSpreadsheetListenerPtr & | getSpreadsheetListener ()
| returns the spreadsheet listener
MWAWTextListenerPtr & | getTextListener ()
| returns the text listener
MWAWFontConverterPtr & | getFontConverter ()
| returns the font converter
MWAWFontManagerPtr & | getFontManager ()
| returns the font manager
MWAWPageSpan const & | getPageSpan () const
| returns the actual page dimension
MWAWPageSpan & | getPageSpan ()
| 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 )
MWAWRSRCParserPtr & | getRSRCParser ()
| returns the rsrc parser
libmwaw::DebugFile & | ascii ()
| 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
void | newPage (int number)
| adds a new page
bool | createZones ()
| finds the different objects zones
bool | sendContents ()
| try to send the contents
bool | sendPicture (MWAWEntry const &entry)
| try to send a picture
bool | readFont (MWAWEntry const &entry)
| try to read a font index entry
bool | readIndex (MWAWEntry const &entry)
| try to read an index entry
int | updateIndex (int actIndex, int actLevel)
| try to set the index level and return the next index value (or -1)
bool | readBookmark (MWAWEntry const &entry)
| try to read a bookmark entry
bool | readFile (MWAWEntry const &entry)
| try to read a file entry
bool | readWP (MWAWEntry const &entry)
| try to read a MDwp entry (window pos?)
bool | sendIndex ()
| try to send the index
MWAWInputStreamPtr | rsrcInput ()
| return the input input
libmwaw::DebugFile & | rsrcAscii ()
| 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< MacDocParserInternal::State > | m_state
| the state

## Detailed Description

the main class to read a MacDoc file

## Constructor & Destructor Documentation

## ◆ MacDocParser()

MacDocParser::MacDocParser | ( | MWAWInputStreamPtr const & | input,
|  | MWAWRSRCParserPtr const & | rsrcParser,
|  | MWAWHeader * | header
| ) |  |

constructor

## ◆ ~MacDocParser()

MacDocParser::~MacDocParser | ( |  | ) |
| final

destructor

## Member Function Documentation

## ◆ checkHeader()

bool MacDocParser::checkHeader | ( | MWAWHeader * | header,
|  | bool | strict = `false`
| ) |  |
| finalvirtual

checks if the document header is correct (or not)

no data fork, may be ok, but this means that the file contains no text, so...

Implements MWAWParser.

Referenced by parse().

## ◆ createDocument()

void MacDocParser::createDocument | ( | librevenge::RVNGTextInterface * | documentInterface | ) |
| protected

creates the listener which will be associated to the document

Referenced by parse().

## ◆ createZones()

bool MacDocParser::createZones | ( |  | ) |
| protected

finds the different objects zones

Referenced by parse().

## ◆ init()

void MacDocParser::init | ( |  | ) |
| protected

inits all internal variables

Referenced by MacDocParser().

## ◆ newPage()

void MacDocParser::newPage | ( | int | number | ) |
| protected

adds a new page

Referenced by sendContents().

## ◆ parse()

void MacDocParser::parse | ( | librevenge::RVNGTextInterface * | documentInterface | ) |
| finalvirtual

virtual function used to parse the input

Implements MWAWTextParser.

## ◆ readBookmark()

bool MacDocParser::readBookmark | ( | MWAWEntry const & | entry | ) |
| protected

try to read a bookmark entry

Referenced by createZones().

## ◆ readFile()

bool MacDocParser::readFile | ( | MWAWEntry const & | entry | ) |
| protected

try to read a file entry

Referenced by createZones().

## ◆ readFont()

bool MacDocParser::readFont | ( | MWAWEntry const & | entry | ) |
| protected

try to read a font index entry

Referenced by createZones().

## ◆ readIndex()

bool MacDocParser::readIndex | ( | MWAWEntry const & | entry | ) |
| protected

try to read an index entry

Referenced by createZones().

## ◆ readWP()

bool MacDocParser::readWP | ( | MWAWEntry const & | entry | ) |
| protected

try to read a MDwp entry (window pos?)

Referenced by createZones().

## ◆ rsrcAscii()

libmwaw::DebugFile & MacDocParser::rsrcAscii | ( |  | ) |
| protected

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

Referenced by createZones(), readBookmark(), readFile(), readFont(), readIndex(), and readWP().

## ◆ rsrcInput()

MWAWInputStreamPtr MacDocParser::rsrcInput | ( |  | ) |
| protected

return the input input

Referenced by readBookmark(), readFile(), readFont(), readIndex(), readWP(), and sendIndex().

## ◆ sendContents()

bool MacDocParser::sendContents | ( |  | ) |
| protected

try to send the contents

Referenced by parse().

## ◆ sendIndex()

bool MacDocParser::sendIndex | ( |  | ) |
| protected

try to send the index

Referenced by sendContents().

## ◆ sendPicture()

bool MacDocParser::sendPicture | ( | MWAWEntry const & | entry | ) |
| protected

try to send a picture

Referenced by sendContents().

## ◆ updateIndex()

int MacDocParser::updateIndex | ( | int | actIndex,
|  | int | actLevel
| ) |  |
| protected

try to set the index level and return the next index value (or -1)

Referenced by sendIndex(), and updateIndex().

## Member Data Documentation

## ◆ m_state

std::shared_ptr<MacDocParserInternal::State> MacDocParser::m_state
| protected

the state

Referenced by checkHeader(), createDocument(), createZones(), init(), newPage(), readFont(), readIndex(), sendContents(), sendIndex(), and updateIndex().

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

- MacDocParser.hxx
- MacDocParser.cxx