It parses the regular content of a text document. More...

#include <ODi_TextContent_ListenerState.h>

Inheritance diagram for ODi_TextContent_ListenerState:

Public Member Functions
	ODi_TextContent_ListenerState (PD_Document pDocument, ODi_Office_Styles pStyles, ODi_ElementStack &rElementStack, ODi_Abi_Data &rAbiData)
	Constructor.
virtual	~ODi_TextContent_ListenerState ()
	Destructor.
void	startElement (const gchar pName, const gchar *ppAtts, ODi_ListenerStateAction &rAction)
	Called when the XML parser finds a start element tag.
void	endElement (const gchar *pName, ODi_ListenerStateAction &rAction)
	Called when an "end of element" tag is parsed (like <myElementName>).
void	charData (const gchar *pBuffer, int length)
Private Types
enum	ODi_CurrentODSection { ODI_SECTION_NONE, ODI_SECTION_MAPPED, ODI_SECTION_IGNORED, ODI_SECTION_UNDEFINED }
Private Member Functions
void	_insertBookmark (const gchar name, const gchar type, const gchar *xmlid=0)
void	_flush ()
void	_startParagraphElement (const gchar pName, const gchar *ppParagraphAtts, ODi_ListenerStateAction &rAction)
	Process <text:p> and <text:h> startElement calls.
void	_endParagraphElement (const gchar *pName, ODi_ListenerStateAction &rAction)
bool	_pushInlineFmt (const PP_PropertyVector &ppAtts)
void	_popInlineFmt (void)
void	_insureInBlock (const PP_PropertyVector &atts)
void	_insureInSection (const std::string *pMasterPageName=NULL)
	Makes sure that an AbiWord section have already been created.
void	_openAbiSection (const std::string &rProps, const std::string *pMasterPageName=NULL)
	Tries to open an abi <section> given its properties.
void	_defineAbiTOCHeadingStyles ()
	Defines all toc-source-style* propeties on Abi TOCs (<toc> struxs).
void	_flushPendingParagraphBreak ()
	For some reason AbiWord can't have a page break right before a new section.
void	_insertAnnotation (void)
	Inserts an <annotate> element into the document before inserting a paragraph or list item.
Private Attributes
PD_Document *	m_pAbiDocument
ODi_Office_Styles *	m_pStyles
bool	m_bAcceptingText
bool	m_bOpenedBlock
bool	m_inAbiSection
bool	m_openedFirstAbiSection
bool	m_bPendingSection
std::string	m_currentPageMarginLeft
std::string	m_currentPageMarginRight
std::string	m_pendingParagraphBreak
enum ODi_TextContent_ListenerState::ODi_CurrentODSection	m_currentODSection
PP_PropertyVector	m_vecInlineFmt
UT_NumberStack	m_stackFmtStartIndex
UT_sint8	m_elementParsingLevel
UT_UCS4String	m_charData
UT_GenericVector< pf_Frag_Strux * >	m_tablesOfContent
	In OpenDocument, <text:h> elements along the text defines the document chapter's structure.
UT_GenericVector< std::string * >	m_tablesOfContentProps
std::map< std::string, std::string >	m_headingStyles
ODi_TableOfContent_ListenerState *	m_pCurrentTOCParser
bool	m_bOnContentStream
ODi_Style_List *	m_pCurrentListStyle
UT_uint8	m_listLevel
bool	m_alreadyDefinedAbiParagraphForList
bool	m_bPendingNoteCitation
bool	m_pendingNoteAnchorInsertion
std::string	m_currentNoteId
std::string	m_noteCitation
bool	m_bPendingAnnotation
bool	m_bPendingAnnotationAuthor
bool	m_bPendingAnnotationDate
UT_uint32	m_iAnnotation
std::string	m_sAnnotationAuthor
std::string	m_sAnnotationDate
std::string	m_sAnnotationName
std::string	m_sAnnotationXMLID
std::set< std::string >	m_openAnnotationNames
std::list< std::string >	xmlidStackForTextMeta
std::map< std::string, std::string >	xmlidMapForBookmarks
bool	m_bPageReferencePending
UT_sint32	m_iPageNum
double	m_dXpos
double	m_dYpos
std::string	m_sProps
ODi_Abi_Data &	m_rAbiData
bool	m_bPendingTextbox
bool	m_bHeadingList
UT_sint32	m_prevLevel
bool	m_bContentWritten
UT_uint32	m_columnsCount
UT_uint32	m_columnIndex

Detailed Description

It parses the regular content of a text document.

It is used to parse the document text body itself (<office:text>) and the contents of headers (<style:header>) and footers (<style:footer>).

Regular text content may have the following main elements (that is, not mentioning their child elements): <text-h> <text-p> <text-list> <table-table> <text-section> <text-table-of-content> <text-illustration-index> <text-table-index> <text-object-index> <text-user-index> <text-alphabetical-index> <text-bibliography> <text-index-title> <change-marks>

Member Enumeration Documentation

enum ODi_TextContent_ListenerState::ODi_CurrentODSection [private]

Enumerator:

ODI_SECTION_NONE
ODI_SECTION_MAPPED
ODI_SECTION_IGNORED
ODI_SECTION_UNDEFINED

Constructor & Destructor Documentation

ODi_TextContent_ListenerState::ODi_TextContent_ListenerState	(	PD_Document *	pDocument,
		ODi_Office_Styles *	pStyles,
		ODi_ElementStack &	rElementStack,
		ODi_Abi_Data &	rAbiData
	)

Constructor.

References m_pAbiDocument, m_pStyles, and UT_ASSERT_HARMLESS.

ODi_TextContent_ListenerState::~ODi_TextContent_ListenerState ( ) [virtual]

Destructor.

References UT_GenericVector< T >::getItemCount(), m_tablesOfContentProps, UT_DEBUGMSG, and UT_VECTOR_PURGEALL.

Member Function Documentation

void ODi_TextContent_ListenerState::_defineAbiTOCHeadingStyles ( ) [private]

Defines all toc-source-style* propeties on Abi TOCs (<toc> struxs).

References PD_Document::changeStruxAttsNoUpdate(), UT_GenericVector< T >::getItemCount(), m_headingStyles, m_pAbiDocument, m_tablesOfContent, m_tablesOfContentProps, UT_ASSERT, and UT_std_string_sprintf().

Referenced by endElement().

void ODi_TextContent_ListenerState::_endParagraphElement	(	const gchar *	pName,
		ODi_ListenerStateAction &	rAction
	)			`[private]`

References _flush(), ODi_ListenerStateAction::bringUpMostRecentlyPostponedElement(), gchar, ODi_Style_Style::getBreakAfter(), ODi_Office_Styles::getDefaultParagraphStyle(), ODi_Office_Styles::getParagraphStyle(), ODi_ElementStack::getStartTag(), ODi_Office_Styles::getTextStyle(), ODi_ElementStack::hasElement(), m_bAcceptingText, m_bOnContentStream, m_pendingParagraphBreak, m_pStyles, and ODi_ListenerState::m_rElementStack.

Referenced by endElement().

void ODi_TextContent_ListenerState::_flush ( void ) [private]

References PD_Document::appendSpan(), UT_UCS4String::clear(), m_bAcceptingText, m_bContentWritten, m_charData, m_pAbiDocument, UT_UCS4String::size(), and UT_UCS4String::ucs4_str().

Referenced by _endParagraphElement(), _startParagraphElement(), endElement(), and startElement().

void ODi_TextContent_ListenerState::_flushPendingParagraphBreak ( ) [private]

For some reason AbiWord can't have a page break right before a new section.

In AbiWord, if you want to do that you have to first open the new section and then, inside this new section, do the page break.

That's the only reason for the existence of *pending* paragraph (column or page) breaks.

References PD_Document::appendSpan(), PD_Document::appendStrux(), m_bContentWritten, m_bOpenedBlock, m_pAbiDocument, m_pendingParagraphBreak, and PTX_Block.

Referenced by _openAbiSection(), and startElement().

void ODi_TextContent_ListenerState::_insertAnnotation ( void ) [private]

Inserts an <annotate> element into the document before inserting a paragraph or list item.

References PD_Document::appendStrux(), d, PD_RDFQuery::executeQuery(), PD_Document::getDocumentRDF(), m_bPendingAnnotation, m_iAnnotation, m_pAbiDocument, m_sAnnotationAuthor, m_sAnnotationDate, m_sAnnotationXMLID, ODc_reorderDate(), PTX_SectionAnnotation, UT_DEBUGMSG, UT_return_if_fail, and UT_std_string_sprintf().

Referenced by endElement(), and startElement().

void ODi_TextContent_ListenerState::_insertBookmark	(	const gchar *	name,
		const gchar *	type,
		const gchar *	xmlid = `0`
	)			`[private]`

References PD_Document::appendObject(), m_pAbiDocument, PT_XMLID, PTO_Bookmark, and UT_return_if_fail.

Referenced by startElement().

void ODi_TextContent_ListenerState::_insureInBlock ( const PP_PropertyVector & atts ) [private]

References _insureInSection(), PD_Document::appendStrux(), m_bAcceptingText, m_bOpenedBlock, m_pAbiDocument, and PTX_Block.

Referenced by startElement().

void ODi_TextContent_ListenerState::_insureInSection ( const std::string * pMasterPageName = NULL ) [private]

Makes sure that an AbiWord section have already been created.

Unlike OpenDocument, AbiWord can't have paragraphs without a section to hold them.

Parameters:

pMasterPageName

The name of the master page to be used. i.e.: The name of the master page which will have its properties used in this section.

References _openAbiSection(), gchar, ODi_Style_Style::getAbiPropsAttrString(), ODi_StartTag::getAttributeValue(), ODi_ElementStack::getClosestElement(), ODi_Office_Styles::getSectionStyle(), m_bOnContentStream, m_bPendingSection, m_columnIndex, m_columnsCount, m_currentODSection, m_inAbiSection, m_pStyles, ODi_ListenerState::m_rElementStack, UT_ASSERT, UT_getAttribute(), and UT_splitPropsToArray().

Referenced by _insureInBlock(), _startParagraphElement(), and startElement().

void ODi_TextContent_ListenerState::_openAbiSection	(	const std::string &	rProps,
		const std::string *	pMasterPageName = `NULL`
	)			`[private]`

Tries to open an abi <section> given its properties.

Parameters:

pProps

The properties of the abi <section> to be opened.

References _flushPendingParagraphBreak(), PD_Document::appendStrux(), ODi_Style_MasterPage::getAWEvenFooterSectionID(), ODi_Style_MasterPage::getAWEvenHeaderSectionID(), ODi_Style_MasterPage::getAWFooterSectionID(), ODi_Style_MasterPage::getAWHeaderSectionID(), ODi_Style_PageLayout::getMarginLeft(), ODi_Style_PageLayout::getMarginRight(), ODi_Office_Styles::getMasterPageStyle(), ODi_Style_MasterPage::getPageLayout(), ODi_Style_MasterPage::getSectionDataID(), ODi_Style_MasterPage::getSectionProps(), m_bAcceptingText, m_bOpenedBlock, m_bPendingSection, m_currentPageMarginLeft, m_currentPageMarginRight, m_inAbiSection, m_openedFirstAbiSection, m_pAbiDocument, m_pStyles, PTX_Section, PD_Document::setPageSizeFromFile(), UT_ASSERT, UT_determineDimension(), UT_dimensionName(), and UT_std_string_getPropVal().

Referenced by _insureInSection().

void ODi_TextContent_ListenerState::_popInlineFmt ( void ) [private]

References m_stackFmtStartIndex, m_vecInlineFmt, and UT_NumberStack::pop().

Referenced by endElement(), and startElement().

bool ODi_TextContent_ListenerState::_pushInlineFmt ( const PP_PropertyVector & ppAtts ) [private]

References m_stackFmtStartIndex, m_vecInlineFmt, and UT_NumberStack::push().

Referenced by startElement().

void ODi_TextContent_ListenerState::_startParagraphElement	(	const gchar *	pName,
		const gchar **	ppParagraphAtts,
		ODi_ListenerStateAction &	rAction
	)			`[private]`