Helper class that provides a context stack. More...

#include <contexthandler2.hxx>

Inheritance diagram for oox::core::ContextHandler2Helper:

Collaboration diagram for oox::core::ContextHandler2Helper:

Public Member Functions
	ContextHandler2Helper (bool bEnableTrimSpace, XmlFilterBase &rFilter)

	ContextHandler2Helper (const ContextHandler2Helper &rParent)

virtual	~ContextHandler2Helper ()

virtual void SAL_CALL	acquire () noexcept=0

virtual void SAL_CALL	release () noexcept=0

virtual ContextHandlerRef	onCreateContext (sal_Int32 nElement, const AttributeList &rAttribs)=0
	Will be called to create a context handler for the passed element. More...

virtual void	onStartElement (const AttributeList &rAttribs)=0
	Will be called when a new element has been started. More...

virtual void	onCharacters (const OUString &rChars)=0
	Will be called before a new child element starts, or if the current element is about to be left. More...

virtual void	onEndElement ()=0
	Will be called when the current element is about to be left. More...

virtual ContextHandlerRef	onCreateRecordContext (sal_Int32 nRecId, SequenceInputStream &rStrm)=0
	Will be called to create a context handler for the passed record. More...

virtual void	onStartRecord (SequenceInputStream &rStrm)=0
	Will be called when a new record block in a binary stream has been started. More...

virtual void	onEndRecord ()=0
	Will be called when the current record block is about to be left. More...

sal_Int32	getCurrentElement () const
	Returns the identifier of the currently processed element. More...

sal_Int32	getCurrentElementWithMce () const
	Returns the identifier of the currently processed element - Including MCE root elements. More...

bool	isCurrentElement (sal_Int32 nElement) const
	Returns true, if nElement contains the identifier of the currently processed element. More...

bool	isCurrentElement (sal_Int32 nElement1, sal_Int32 nElement2) const
	Returns true, if either nElement1 or nElement2 contain the identifier of the currently processed element. More...

sal_Int32	getParentElement (sal_Int32 nCountBack=1) const
	Returns the identifier of the specified parent element. More...

bool	isParentElement (sal_Int32 nElement, sal_Int32 nCountBack=1) const
	Returns true, if nElement contains the identifier of the specified parent element. More...

bool	isRootElement () const
	Returns true, if the element currently processed is the root element of the context or fragment handler. More...

Protected Types
enum	MCE_STATE { MCE_STATE::Started, MCE_STATE::FoundChoice }

Protected Member Functions
css::uno::Reference< css::xml::sax::XFastContextHandler >	implCreateChildContext (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &rxAttribs)
	Must be called from createFastChildContext() in derived classes. More...

void	implStartElement (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &rxAttribs)
	Must be called from startFastElement() in derived classes. More...

void	implCharacters (std::u16string_view rChars)
	Must be called from characters() in derived classes. More...

void	implEndElement (sal_Int32 nElement)
	Must be called from endFastElement() in derived classes. More...

ContextHandlerRef	implCreateRecordContext (sal_Int32 nRecId, SequenceInputStream &rStrm)
	Must be called from createRecordContext() in derived classes. More...

void	implStartRecord (sal_Int32 nRecId, SequenceInputStream &rStrm)
	Must be called from startRecord() in derived classes. More...

void	implEndRecord (sal_Int32 nRecId)
	Must be called from endRecord() in derived classes. More...

bool	prepareMceContext (sal_Int32 nElement, const AttributeList &rAttribs)

XmlFilterBase &	getDocFilter () const

MCE_STATE	getMCEState () const

void	setMCEState (MCE_STATE aState)

void	addMCEState (MCE_STATE aState)

void	removeMCEState ()

bool	isMCEStateEmpty ()

Protected Attributes
bool	mbEnableTrimSpace
	True = trim whitespace in characters(). More...

XmlFilterBase &	mrFilter

Private Types
typedef std::vector< ElementInfo >	ContextStack

typedef std::shared_ptr< ContextStack >	ContextStackRef

Private Member Functions
ContextHandler2Helper &	operator= (const ContextHandler2Helper &)=delete

ElementInfo &	pushElementInfo (sal_Int32 nElement)

void	popElementInfo ()

void	processCollectedChars ()

Private Attributes
ContextStackRef	mxContextStack
	Stack of all processed elements. More...

size_t	mnRootStackSize
	Stack size on construction time. More...

std::vector< MCE_STATE >	aMceState

Detailed Description

Helper class that provides a context stack.

Fragment handlers and context handlers derived from this helper class will track the identifiers of the visited elements in a stack. The idea is to use the same instance of a fragment handler or context handler to process several nested elements in an XML stream. For that, the abstract function onCreateContext() has to return 'this' for the passed element.

Derived classes have to implement the createFastChildContext(), startFastElement(), characters(), and endFastElement() functions from the com.sun.star.xml.sax.XFastContextHandler interface by simply forwarding them to the respective implCreateChildContext(), implStartElement(), implCharacters(), and implEndElement() functions of this helper. This is implemented already in the classes ContextHandler2 and FragmentHandler2. The new abstract functions have to be implemented according to the elements to be processed.

Similarly, for binary import, derived classes have to forward the createRecordContext(), startRecord(), and endRecord() functions from the ContextHandler class to the implCreateRecordContext(), implStartRecord(), and implEndRecord() functions of this helper. Again, this is implemented already in the classes ContextHandler2 and FragmentHandler2.

Definition at line 72 of file contexthandler2.hxx.

Member Typedef Documentation

typedef std::vector< ElementInfo > oox::core::ContextHandler2Helper::ContextStack

private

Definition at line 227 of file contexthandler2.hxx.

typedef std::shared_ptr< ContextStack > oox::core::ContextHandler2Helper::ContextStackRef

private

Definition at line 228 of file contexthandler2.hxx.

Member Enumeration Documentation

enum oox::core::ContextHandler2Helper::MCE_STATE

strongprotected

Enumerator
Started
FoundChoice

Definition at line 207 of file contexthandler2.hxx.

Constructor & Destructor Documentation

oox::core::ContextHandler2Helper::ContextHandler2Helper	(	bool	bEnableTrimSpace,
		XmlFilterBase &	rFilter
	)

explicit

Definition at line 47 of file contexthandler2.cxx.

References make_shared(), pushElementInfo(), and oox::core::XML_ROOT_CONTEXT.

oox::core::ContextHandler2Helper::ContextHandler2Helper ( const ContextHandler2Helper & rParent )

explicit

Definition at line 56 of file contexthandler2.cxx.

References size.

oox::core::ContextHandler2Helper::~ContextHandler2Helper ( )

virtual

Definition at line 64 of file contexthandler2.cxx.

Member Function Documentation

virtual void SAL_CALL oox::core::ContextHandler2Helper::acquire ( )

pure virtualnoexcept

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

void oox::core::ContextHandler2Helper::addMCEState ( MCE_STATE aState )

inlineprotected

Definition at line 215 of file contexthandler2.hxx.

Referenced by prepareMceContext().

sal_Int32 oox::core::ContextHandler2Helper::getCurrentElement ( ) const

Returns the identifier of the currently processed element.

Ignores MCE elements in stack

Definition at line 73 of file contexthandler2.cxx.

References mxContextStack, and oox::core::XML_ROOT_CONTEXT.

sal_Int32 oox::core::ContextHandler2Helper::getCurrentElementWithMce ( ) const

Returns the identifier of the currently processed element - Including MCE root elements.

Definition at line 68 of file contexthandler2.cxx.

References mxContextStack, and oox::core::XML_ROOT_CONTEXT.

Referenced by implEndElement(), and implEndRecord().

XmlFilterBase& oox::core::ContextHandler2Helper::getDocFilter ( ) const

inlineprotected

Definition at line 205 of file contexthandler2.hxx.

References mrFilter.

Referenced by prepareMceContext().

MCE_STATE oox::core::ContextHandler2Helper::getMCEState ( ) const

inlineprotected

Definition at line 213 of file contexthandler2.hxx.

Referenced by oox::drawingml::OleObjectGraphicDataContext::onEndElement(), and prepareMceContext().

sal_Int32 oox::core::ContextHandler2Helper::getParentElement ( sal_Int32 nCountBack = 1 ) const

Returns the identifier of the specified parent element.

Definition at line 82 of file contexthandler2.cxx.

References o3tl::make_unsigned(), mxContextStack, oox::core::XML_ROOT_CONTEXT, and XML_TOKEN_INVALID.

Referenced by oox::drawingml::chart::ChartDrawingFragment::onCharacters(), and oox::vml::ShapeContext::onCreateContext().

void oox::core::ContextHandler2Helper::implCharacters ( std::u16string_view rChars )

protected

Must be called from characters() in derived classes.

Definition at line 111 of file contexthandler2.cxx.

References mxContextStack.

Referenced by oox::core::FragmentHandler2::characters(), and oox::core::ContextHandler2::characters().

Reference< XFastContextHandler > oox::core::ContextHandler2Helper::implCreateChildContext	(	sal_Int32	nElement,
		const css::uno::Reference< css::xml::sax::XFastAttributeList > &	rxAttribs
	)

protected

Must be called from createFastChildContext() in derived classes.

Definition at line 95 of file contexthandler2.cxx.

References onCreateContext(), and processCollectedChars().

Referenced by oox::core::FragmentHandler2::createFastChildContext(), and oox::core::ContextHandler2::createFastChildContext().

ContextHandlerRef oox::core::ContextHandler2Helper::implCreateRecordContext	(	sal_Int32	nRecId,
		SequenceInputStream &	rStrm
	)

protected

Must be called from createRecordContext() in derived classes.

Definition at line 130 of file contexthandler2.cxx.

References onCreateRecordContext().

Referenced by oox::core::FragmentHandler2::createRecordContext(), and oox::core::ContextHandler2::createRecordContext().

void oox::core::ContextHandler2Helper::implEndElement ( sal_Int32 nElement )

protected

Must be called from endFastElement() in derived classes.

Definition at line 118 of file contexthandler2.cxx.

References getCurrentElementWithMce(), mxContextStack, onEndElement(), popElementInfo(), and processCollectedChars().

Referenced by oox::core::FragmentHandler2::endFastElement(), and oox::core::ContextHandler2::endFastElement().

void oox::core::ContextHandler2Helper::implEndRecord ( sal_Int32 nRecId )

protected

Must be called from endRecord() in derived classes.

Definition at line 141 of file contexthandler2.cxx.

References getCurrentElementWithMce(), mxContextStack, onEndRecord(), and popElementInfo().

Referenced by oox::core::FragmentHandler2::endRecord(), and oox::core::ContextHandler2::endRecord().

void oox::core::ContextHandler2Helper::implStartElement	(	sal_Int32	nElement,
		const css::uno::Reference< css::xml::sax::XFastAttributeList > &	rxAttribs
	)

protected

Must be called from startFastElement() in derived classes.

Definition at line 104 of file contexthandler2.cxx.

References oox::AttributeList::getToken(), oox::core::ElementInfo::mbTrimSpaces, onStartElement(), pushElementInfo(), and XML_TOKEN_INVALID.

Referenced by oox::core::FragmentHandler2::startFastElement(), and oox::core::ContextHandler2::startFastElement().

void oox::core::ContextHandler2Helper::implStartRecord	(	sal_Int32	nRecId,
		SequenceInputStream &	rStrm
	)

protected

Must be called from startRecord() in derived classes.

Definition at line 135 of file contexthandler2.cxx.

References onStartRecord(), and pushElementInfo().

Referenced by oox::core::FragmentHandler2::startRecord(), and oox::core::ContextHandler2::startRecord().

bool oox::core::ContextHandler2Helper::isCurrentElement ( sal_Int32 nElement ) const

inline

Returns true, if nElement contains the identifier of the currently processed element.

Definition at line 155 of file contexthandler2.hxx.

Referenced by oox::drawingml::chart::TextContext::onCharacters(), oox::drawingml::chart::ChartDrawingFragment::onCharacters(), oox::drawingml::chart::TrendlineContext::onCharacters(), oox::drawingml::chart::TextContext::onCreateContext(), oox::ppt::CommonTimeNodeContext::onEndElement(), oox::ppt::AnimVariantContext::onEndElement(), oox::ppt::TimeAnimValueListContext::onEndElement(), oox::ppt::SoundActionContext::onEndElement(), oox::ppt::SlideTransitionContext::onEndElement(), and oox::drawingml::chart::ChartDrawingFragment::onEndElement().

bool oox::core::ContextHandler2Helper::isCurrentElement	(	sal_Int32	nElement1,
		sal_Int32	nElement2
	)		const

inline

Returns true, if either nElement1 or nElement2 contain the identifier of the currently processed element.

Definition at line 160 of file contexthandler2.hxx.

bool oox::core::ContextHandler2Helper::isMCEStateEmpty ( )

inlineprotected

Definition at line 217 of file contexthandler2.hxx.

Referenced by oox::drawingml::OleObjectGraphicDataContext::onEndElement(), and prepareMceContext().

bool oox::core::ContextHandler2Helper::isParentElement	(	sal_Int32	nElement,
		sal_Int32	nCountBack = `1`
	)		const

inline

Returns true, if nElement contains the identifier of the specified parent element.

Definition at line 168 of file contexthandler2.hxx.

Referenced by oox::drawingml::chart::DoubleSequenceContext::onCharacters().

bool oox::core::ContextHandler2Helper::isRootElement ( ) const

Returns true, if the element currently processed is the root element of the context or fragment handler.

Definition at line 90 of file contexthandler2.cxx.

References mnRootStackSize, and mxContextStack.

virtual void oox::core::ContextHandler2Helper::onCharacters ( const OUString & rChars )

pure virtual

Will be called before a new child element starts, or if the current element is about to be left.

This helper function collects all text fragments received by the characters() function (such as encoded characters which are passed in separate calls to the characters() function), and passes the concatenated and trimmed string.

The current element identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by OOXML import only.

Implemented in oox::core::ContextHandler2, oox::drawingml::chart::TrendlineContext, oox::core::FragmentHandler2, oox::drawingml::chart::ChartDrawingFragment, oox::vml::ClientDataContext, oox::drawingml::chart::StringSequenceContext, oox::drawingml::chart::DataLabelsContext, oox::vml::TextPortionContext, oox::drawingml::RegularTextRunContext, oox::ppt::CommonBehaviorContext, oox::ppt::SlideFragmentHandler, oox::drawingml::chart::DoubleSequenceContext, oox::drawingml::chart::DataLabelContext, oox::drawingml::chart::TextContext, oox::drawingml::TextFieldContext, and oox::drawingml::GuidContext.

Referenced by processCollectedChars().

virtual ContextHandlerRef oox::core::ContextHandler2Helper::onCreateContext	(	sal_Int32	nElement,
		const AttributeList &	rAttribs
	)

pure virtual

Will be called to create a context handler for the passed element.

Usually 'this' can be returned to improve performance by reusing the same instance to process several elements. Used by OOXML import only.

Referenced by implCreateChildContext().

virtual ContextHandlerRef oox::core::ContextHandler2Helper::onCreateRecordContext	(	sal_Int32	nRecId,
		SequenceInputStream &	rStrm
	)

pure virtual

Will be called to create a context handler for the passed record.

Usually 'this' can be returned to improve performance by reusing the same instance to process several records. Used by BIFF import only.

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

Referenced by implCreateRecordContext().

virtual void oox::core::ContextHandler2Helper::onEndElement ( )

pure virtual

Will be called when the current element is about to be left.

The current element identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by OOXML import only.

Implemented in oox::core::ContextHandler2, oox::core::FragmentHandler2, oox::drawingml::ColorFragmentHandler, oox::drawingml::chart::ChartDrawingFragment, oox::vml::TextBoxContext, oox::vml::ClientDataContext, oox::drawingml::DiagramQStylesFragmentHandler, oox::drawingml::OleObjectGraphicDataContext, oox::vml::TextPortionContext, oox::drawingml::GraphicalObjectFrameContext, oox::drawingml::RegularTextRunContext, oox::ppt::CommonBehaviorContext, oox::ppt::SlideTransitionContext, oox::ppt::SoundActionContext, oox::ppt::TimeAnimValueListContext, oox::ppt::AnimVariantContext, oox::ppt::BuildListContext, oox::ppt::CommonTimeNodeContext, oox::drawingml::TextFieldContext, and oox::drawingml::TextEffectsContext.

Referenced by implEndElement().

virtual void oox::core::ContextHandler2Helper::onEndRecord ( )

pure virtual

Will be called when the current record block is about to be left.

The current record identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by BIFF import only.

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

Referenced by implEndRecord().

virtual void oox::core::ContextHandler2Helper::onStartElement ( const AttributeList & rAttribs )

pure virtual

Will be called when a new element has been started.

This function is called at the context handler returned from onCreateContext(), or, for root elements of an XML stream, at the fragment handler itself.

The current element identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by OOXML import only.

Implemented in oox::core::ContextHandler2, oox::core::FragmentHandler2, oox::drawingml::ColorFragmentHandler, oox::vml::TextBoxContext, oox::drawingml::DiagramQStylesFragmentHandler, oox::vml::TextPortionContext, and oox::drawingml::TextEffectsContext.

Referenced by implStartElement().

virtual void oox::core::ContextHandler2Helper::onStartRecord ( SequenceInputStream & rStrm )

pure virtual

Will be called when a new record block in a binary stream has been started.

The current record identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by BIFF import only.

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

Referenced by implStartRecord().

ContextHandler2Helper& oox::core::ContextHandler2Helper::operator= ( const ContextHandler2Helper & )

privatedelete

void oox::core::ContextHandler2Helper::popElementInfo ( )