class used to defined the ancestor of parser which manages the text data More...

#include <WPSTextParser.h>

Inheritance diagram for WPSTextParser:

Classes
struct	DataFOD
	structure which retrieves data information which correspond to a text position More...

Public Member Functions
virtual	~WPSTextParser ()
	virtual destructor
int	version () const
	returns the file version
RVNGInputStreamPtr &	getInput ()
	returns the actual input

Protected Types
typedef bool(WPSTextParser::*	FDPParser) (long endPos, int &id, std::string &mess)
	callback when a new attribute is found in an FDPP/FDPC entry

Protected Member Functions
	WPSTextParser (WPSParser &parser, RVNGInputStreamPtr &input)
	constructor
std::multimap< std::string, WPSEntry > &	getNameEntryMap ()
	returns the map type->entry
std::multimap< std::string, WPSEntry > const &	getNameEntryMap () const
	returns the map type->entry
std::vector< DataFOD >	mergeSortedFODLists (std::vector< DataFOD > const &lst1, std::vector< DataFOD > const &lst2) const
	function which takes two sorted list of attribute (by text position).
bool	readFDP (WPSEntry const &entry, std::vector< DataFOD > &fods, FDPParser parser)
	parses a FDPP or a FDPC entry (which contains a list of ATTR_TEXT/ATTR_PARAG with their definition ) and adds found data in listFODs
libwps::DebugFile &	ascii ()
	a DebugFile used to write what we recognize when we parse the document

Protected Attributes
int	m_version
	the file version
RVNGInputStreamPtr	m_input
	the main input
WPSParser &	m_mainParser
	pointer to the main zone parser;
WPSEntry	m_textPositions
	an entry which corresponds to the complete text zone
std::vector< DataFOD >	m_FODList
	the list of a FOD
libwps::DebugFile &	m_asciiFile
	the ascii file

Private Member Functions
	WPSTextParser (WPSTextParser const &parser)=delete
	private copy constructor: forbidden
WPSTextParser &	operator= (WPSTextParser const &parser)=delete
	private copy operator: forbidden

Detailed Description

class used to defined the ancestor of parser which manages the text data

Member Typedef Documentation

◆ FDPParser

typedef bool(WPSTextParser::* WPSTextParser::FDPParser) (long endPos, int &id, std::string &mess)

protected

callback when a new attribute is found in an FDPP/FDPC entry

Parameters

endPos	define the end of the data's zone
mess	can be used to add a message in debugFile

Returns: true and filled id if this attribute can be parsed

Constructor & Destructor Documentation

◆ ~WPSTextParser()

WPSTextParser::~WPSTextParser ( )

virtual

virtual destructor

◆ WPSTextParser() [1/2]

WPSTextParser::WPSTextParser	(	WPSParser &	parser,
		RVNGInputStreamPtr &	input )

protected

constructor

Referenced by operator=(), WPS4Text::WPS4Text(), WPS8Text::WPS8Text(), and WPSTextParser().

◆ WPSTextParser() [2/2]

WPSTextParser::WPSTextParser ( WPSTextParser const & parser )

privatedelete

private copy constructor: forbidden

Member Function Documentation

◆ ascii()

libwps::DebugFile & WPSTextParser::ascii ( )

inlineprotected

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

Referenced by WPS8Text::bmktEndDataParser(), WPS4Text::readDosLink(), WPS4Text::readEntries(), readFDP(), WPS4Text::readFontNames(), WPS8Text::readNotes(), WPS4Text::readPLC(), WPS8Text::readPLC(), WPS8Text::readStructures(), WPS4Text::readText(), WPS8Text::readText(), WPS8Text::tokenEndDataParser(), and WPSTextParser().

◆ getInput()

RVNGInputStreamPtr & WPSTextParser::getInput ( )

inline

returns the actual input

Referenced by WPS8Text::bmktEndDataParser(), WPS8Text::getFooterEntry(), WPS8Text::getHeaderEntry(), readFDP(), WPS8Text::readNotes(), WPS8Text::readPLC(), WPS8Text::readText(), WPS8Text::tokenEndDataParser(), and WPS8Text::WPS8Text().

◆ getNameEntryMap() [1/2]

WPSParser::NameMultiMap & WPSTextParser::getNameEntryMap ( )

protected

returns the map type->entry

Referenced by WPS4Text::findFDPStructures(), WPS4Text::getFooterEntry(), WPS4Text::getHeaderEntry(), WPS4Text::readEntries(), WPS4Text::readStructures(), and WPS8Text::readStructures().

◆ getNameEntryMap() [2/2]

WPSParser::NameMultiMap const & WPSTextParser::getNameEntryMap ( ) const

protected

returns the map type->entry

◆ mergeSortedFODLists()

std::vector< WPSTextParser::DataFOD > WPSTextParser::mergeSortedFODLists	(	std::vector< DataFOD > const &	lst1,
		std::vector< DataFOD > const &	lst2 ) const

protected

function which takes two sorted list of attribute (by text position).

Returns: a list of attribute

Referenced by WPS8Text::bmktEndDataParser(), WPS4Text::readPLC(), WPS8Text::readPLC(), WPS4Text::readStructures(), and WPS8Text::tokenEndDataParser().

◆ operator=()

WPSTextParser & WPSTextParser::operator= ( WPSTextParser const & parser )

privatedelete

private copy operator: forbidden

◆ readFDP()

bool WPSTextParser::readFDP	(	WPSEntry const &	entry,
		std::vector< DataFOD > &	fods,
		WPSTextParser::FDPParser	parser )

protected

parses a FDPP or a FDPC entry (which contains a list of ATTR_TEXT/ATTR_PARAG with their definition ) and adds found data in listFODs

Referenced by WPS4Text::readStructures().

◆ version()

int WPSTextParser::version ( ) const

returns the file version

Referenced by WPS4Text::getDefaultFont(), readFDP(), WPS4Text::readFont(), WPS4Text::readParagraph(), and WPS4Text::readText().

Member Data Documentation

◆ m_asciiFile

libwps::DebugFile& WPSTextParser::m_asciiFile

protected

the ascii file

Referenced by ascii(), and WPSTextParser().

◆ m_FODList

std::vector<DataFOD> WPSTextParser::m_FODList

protected

the list of a FOD

Referenced by WPS8Text::bmktEndDataParser(), WPS4Text::readPLC(), WPS8Text::readPLC(), WPS4Text::readStructures(), WPS4Text::readText(), WPS8Text::readText(), WPS8Text::tokenEndDataParser(), and WPSTextParser().

◆ m_input

RVNGInputStreamPtr WPSTextParser::m_input

protected

the main input

Referenced by WPS4Text::bkmkDataParser(), WPS4Text::defDataParser(), WPS4Text::dttmDataParser(), WPS4Text::findFDPStructuresByHand(), WPS4Text::footNotesDataParser(), getInput(), WPS4Text::numPages(), WPS8Text::numPages(), WPS4Text::objectDataParser(), WPS4Text::readDosLink(), WPS4Text::readEntries(), readFDP(), WPS4Text::readFont(), WPS4Text::readFontNames(), WPS4Text::readParagraph(), WPS4Text::readPLC(), WPS4Text::readText(), and WPSTextParser().

◆ m_mainParser

WPSParser& WPSTextParser::m_mainParser

protected

pointer to the main zone parser;

Referenced by getNameEntryMap(), getNameEntryMap(), WPS4Text::mainParser(), WPS4Text::mainParser(), WPS8Text::mainParser(), WPS8Text::mainParser(), version(), and WPSTextParser().

◆ m_textPositions

WPSEntry WPSTextParser::m_textPositions

protected

an entry which corresponds to the complete text zone

Referenced by WPS4Text::findFDPStructuresByHand(), mergeSortedFODLists(), WPS4Text::numPages(), WPS8Text::numPages(), WPS4Text::readEntries(), readFDP(), WPS8Text::readNotes(), WPS4Text::readPLC(), WPS8Text::readPLC(), WPS8Text::readStructures(), WPS8Text::textZonesDataParser(), and WPSTextParser().

◆ m_version

int WPSTextParser::m_version

mutableprotected

the file version

Referenced by version(), and WPSTextParser().

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ FDPParser

Constructor & Destructor Documentation

◆ ~WPSTextParser()

◆ WPSTextParser() [1/2]

◆ WPSTextParser() [2/2]

Member Function Documentation

◆ ascii()

◆ getInput()

◆ getNameEntryMap() [1/2]

◆ getNameEntryMap() [2/2]

◆ mergeSortedFODLists()

◆ operator=()

◆ readFDP()

◆ version()

Member Data Documentation

◆ m_asciiFile

◆ m_FODList

◆ m_input

◆ m_mainParser

◆ m_textPositions

◆ m_version