contexthandler2.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_OOX_CORE_CONTEXTHANDLER2_HXX
#define INCLUDED_OOX_CORE_CONTEXTHANDLER2_HXX
 
#include <cstddef>
#include <memory>
#include <vector>
 
#include <com/sun/star/uno/Reference.hxx>
#include <oox/core/contexthandler.hxx>
#include <oox/dllapi.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
 
namespace com::sun::star {
    namespace xml::sax { class XFastAttributeList; }
    namespace xml::sax { class XFastContextHandler; }
}
 
namespace oox {
    class AttributeList;
    class SequenceInputStream;
}
 
namespace oox::core {
 
const sal_Int32 XML_ROOT_CONTEXT    = SAL_MAX_INT32;
 
struct ElementInfo;
 
class OOX_DLLPUBLIC SAL_LOPLUGIN_ANNOTATE("crosscast") ContextHandler2Helper
{
public:
    explicit            ContextHandler2Helper( bool bEnableTrimSpace, XmlFilterBase& rFilter );
    explicit            ContextHandler2Helper( const ContextHandler2Helper& rParent );
    virtual             ~ContextHandler2Helper();
 
    // allow instances to be stored in ::rtl::Reference
    virtual void SAL_CALL acquire() noexcept = 0;
    virtual void SAL_CALL release() noexcept = 0;
 
    // interface --------------------------------------------------------------
 
    virtual ContextHandlerRef onCreateContext( sal_Int32 nElement, const AttributeList& rAttribs ) = 0;
 
    virtual void        onStartElement( const AttributeList& rAttribs ) = 0;
 
    virtual void        onCharacters( const OUString& rChars ) = 0;
 
    virtual void        onEndElement() = 0;
 
    virtual ContextHandlerRef onCreateRecordContext( sal_Int32 nRecId, SequenceInputStream& rStrm ) = 0;
 
    virtual void        onStartRecord( SequenceInputStream& rStrm ) = 0;
 
    virtual void        onEndRecord() = 0;
 
    // helpers ----------------------------------------------------------------
 
    sal_Int32           getCurrentElement() const;
 
    sal_Int32           getCurrentElementWithMce() const;
 
    bool         isCurrentElement( sal_Int32 nElement ) const
                            { return getCurrentElement() == nElement; }
 
    bool         isCurrentElement( sal_Int32 nElement1, sal_Int32 nElement2 ) const
                            { return isCurrentElement( nElement1 ) || isCurrentElement( nElement2 ); }
 
    sal_Int32           getParentElement( sal_Int32 nCountBack = 1 ) const;
 
    bool isParentElement( sal_Int32 nElement, sal_Int32 nCountBack = 1 ) const
                            { return getParentElement( nCountBack ) == nElement; }
 
    bool                isRootElement() const;
 
    // implementation ---------------------------------------------------------
 
protected:
    css::uno::Reference< css::xml::sax::XFastContextHandler >
                        implCreateChildContext(
                            sal_Int32 nElement,
                            const css::uno::Reference< css::xml::sax::XFastAttributeList >& rxAttribs );
 
    void                implStartElement(
                            sal_Int32 nElement,
                            const css::uno::Reference< css::xml::sax::XFastAttributeList >& rxAttribs );
 
    void                implCharacters( std::u16string_view rChars );
 
    void                implEndElement( sal_Int32 nElement );
 
    ContextHandlerRef   implCreateRecordContext( sal_Int32 nRecId, SequenceInputStream& rStrm );
 
    void                implStartRecord( sal_Int32 nRecId, SequenceInputStream& rStrm );
 
    void                implEndRecord( sal_Int32 nRecId );
 
    bool                prepareMceContext( sal_Int32 nElement, const AttributeList& rAttribs );
    XmlFilterBase&      getDocFilter() const { return mrFilter; }
 
    enum class MCE_STATE
    {
        Started,
        FoundChoice
    };
 
    MCE_STATE           getMCEState() const { return aMceState.back(); }
    void                setMCEState( MCE_STATE aState ) { aMceState.back() = aState; }
    void                addMCEState( MCE_STATE aState ) { aMceState.push_back( aState ); }
    void                removeMCEState() { aMceState.pop_back(); }
    bool                isMCEStateEmpty() const { return aMceState.empty(); }
 
private:
    ContextHandler2Helper& operator=( const ContextHandler2Helper& ) = delete;
 
    ElementInfo&        pushElementInfo( sal_Int32 nElement );
    void                popElementInfo();
    void                processCollectedChars();
 
private:
    typedef std::vector< ElementInfo >        ContextStack;
    typedef std::shared_ptr< ContextStack > ContextStackRef;
 
    ContextStackRef     mxContextStack;     
    size_t              mnRootStackSize;    
    std::vector<MCE_STATE> aMceState;
 
protected:
    bool                mbEnableTrimSpace;  
    XmlFilterBase&      mrFilter;
};
 
class OOX_DLLPUBLIC ContextHandler2 : public ContextHandler, public ContextHandler2Helper
{
public:
    explicit            ContextHandler2( ContextHandler2Helper const & rParent );
    virtual             ~ContextHandler2() override;
 
    ContextHandler2(ContextHandler2 const &) = default;
    ContextHandler2(ContextHandler2 &&) = default;
    ContextHandler2 & operator =(ContextHandler2 const &) = delete; // due to ContextHandler
    ContextHandler2 & operator =(ContextHandler2 &&) = delete; // due to ContextHandler
 
    // resolve ambiguity from base classes
    virtual void SAL_CALL acquire() noexcept override { ContextHandler::acquire(); }
    virtual void SAL_CALL release() noexcept override { ContextHandler::release(); }
 
    // com.sun.star.xml.sax.XFastContextHandler interface ---------------------
 
    virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL
                        createFastChildContext(
                            sal_Int32 nElement,
                            const css::uno::Reference< css::xml::sax::XFastAttributeList >& rxAttribs ) final override;
 
    virtual void SAL_CALL startFastElement(
                            sal_Int32 nElement,
                            const css::uno::Reference< css::xml::sax::XFastAttributeList >& rxAttribs ) final override;
 
    virtual void SAL_CALL characters( const OUString& rChars ) final override;
 
    virtual void SAL_CALL endFastElement( sal_Int32 nElement ) final override;
 
    // oox.core.ContextHandler interface --------------------------------------
 
    virtual ContextHandlerRef createRecordContext( sal_Int32 nRecId, SequenceInputStream& rStrm ) override;
    virtual void        startRecord( sal_Int32 nRecId, SequenceInputStream& rStrm ) override;
    virtual void        endRecord( sal_Int32 nRecId ) override;
 
    // oox.core.ContextHandler2Helper interface -------------------------------
 
    virtual ContextHandlerRef onCreateContext( sal_Int32 nElement, const AttributeList& rAttribs ) override;
    virtual void        onStartElement( const AttributeList& rAttribs ) override;
    virtual void        onCharacters( const OUString& rChars ) override;
    virtual void        onEndElement() override;
 
    virtual ContextHandlerRef onCreateRecordContext( sal_Int32 nRecId, SequenceInputStream& rStrm ) override;
    virtual void        onStartRecord( SequenceInputStream& rStrm ) override;
    virtual void        onEndRecord() override;
};
 
} // namespace oox::core
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */