oox/source/core/contexthandler2.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <oox/core/contexthandler2.hxx>
  21 #include <oox/helper/attributelist.hxx>
  22 #include <oox/token/namespaces.hxx>
  23 #include <oox/token/tokens.hxx>
  24 #include <rtl/ustrbuf.hxx>
  25 #include <osl/diagnose.h>
  26
  27 namespace oox {
  28 namespace core {
  29
  30 using namespace ::com::sun::star::uno;
  31 using namespace ::com::sun::star::xml::sax;
  32
  33 /** Information about a processed element. */
  34 struct ElementInfo
  35 {
  36     OUStringBuffer      maChars;            /// Collected element characters.
  37     sal_Int32           mnElement;          /// The element identifier.
  38     bool                mbTrimSpaces;       /// True = trims leading/trailing spaces from text data.
  39
  40     explicit     ElementInfo() : maChars( 0), mnElement( XML_TOKEN_INVALID ), mbTrimSpaces( false ) {}
  41 };
  42
  43 ContextHandler2Helper::ContextHandler2Helper( bool bEnableTrimSpace ) :
  44     mxContextStack( new ContextStack ),
  45     mnRootStackSize( 0 ),
  46     mbEnableTrimSpace( bEnableTrimSpace )
  47 {
  48     pushElementInfo( XML_ROOT_CONTEXT );
  49 }
  50
  51 ContextHandler2Helper::ContextHandler2Helper( const ContextHandler2Helper& rParent ) :
  52     mxContextStack( rParent.mxContextStack ),
  53     mnRootStackSize( rParent.mxContextStack->size() ),
  54     mbEnableTrimSpace( rParent.mbEnableTrimSpace )
  55 {
  56 }
  57
  58 ContextHandler2Helper::~ContextHandler2Helper()
  59 {
  60 }
  61
  62 sal_Int32 ContextHandler2Helper::getCurrentElementWithMce() const
  63 {
  64     return mxContextStack->empty() ? XML_ROOT_CONTEXT : mxContextStack->back().mnElement;
  65 }
  66
  67 sal_Int32 ContextHandler2Helper::getCurrentElement() const
  68 {
  69     auto It = std::find_if(mxContextStack->rbegin(), mxContextStack->rend(),
  70         [](const ElementInfo& rItem) { return getNamespace(rItem.mnElement) != NMSP_mce; });
  71     if (It != mxContextStack->rend())
  72         return It->mnElement;
  73     return XML_ROOT_CONTEXT;
  74 }
  75
  76 sal_Int32 ContextHandler2Helper::getParentElement( sal_Int32 nCountBack ) const
  77 {
  78     if( (nCountBack < 0) || (mxContextStack->size() < static_cast< size_t >( nCountBack )) )
  79         return XML_TOKEN_INVALID;
  80     return (mxContextStack->size() == static_cast< size_t >( nCountBack )) ?
  81         XML_ROOT_CONTEXT : (*mxContextStack)[ mxContextStack->size() - nCountBack - 1 ].mnElement;
  82 }
  83
  84 bool ContextHandler2Helper::isRootElement() const
  85 {
  86     return mxContextStack->size() == mnRootStackSize + 1;
  87 }
  88
  89 Reference< XFastContextHandler > ContextHandler2Helper::implCreateChildContext(
  90         sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs )
  91 {
  92     // #i76091# process collected characters (calls onCharacters() if needed)
  93     processCollectedChars();
  94     ContextHandlerRef xContext = onCreateContext( nElement, AttributeList( rxAttribs ) );
  95     return Reference< XFastContextHandler >( xContext.get() );
  96 }
  97
  98 void ContextHandler2Helper::implStartElement( sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs )
  99 {
 100     AttributeList aAttribs( rxAttribs );
 101     pushElementInfo( nElement ).mbTrimSpaces = aAttribs.getToken( XML_TOKEN( space ), XML_TOKEN_INVALID ) != XML_preserve;
 102     onStartElement( aAttribs );
 103 }
 104
 105 void ContextHandler2Helper::implCharacters( const OUString& rChars )
 106 {
 107     // #i76091# collect characters until new element starts or this element ends
 108     if( !mxContextStack->empty() )
 109         mxContextStack->back().maChars.append(rChars);
 110 }
 111
 112 void ContextHandler2Helper::implEndElement( sal_Int32 nElement )
 113 {
 114     OSL_ENSURE( getCurrentElementWithMce() == nElement, "ContextHandler2Helper::implEndElement - context stack broken" );
 115     if( !mxContextStack->empty() )
 116     {
 117         // #i76091# process collected characters (calls onCharacters() if needed)
 118         processCollectedChars();
 119         onEndElement();
 120         popElementInfo();
 121     }
 122 }
 123
 124 ContextHandlerRef ContextHandler2Helper::implCreateRecordContext( sal_Int32 nRecId, SequenceInputStream& rStrm )
 125 {
 126     return onCreateRecordContext( nRecId, rStrm );
 127 }
 128
 129 void ContextHandler2Helper::implStartRecord( sal_Int32 nRecId, SequenceInputStream& rStrm )
 130 {
 131     pushElementInfo( nRecId );
 132     onStartRecord( rStrm );
 133 }
 134
 135 void ContextHandler2Helper::implEndRecord( sal_Int32 nRecId )
 136 {
 137     OSL_ENSURE( getCurrentElementWithMce() == nRecId, "ContextHandler2Helper::implEndRecord - context stack broken" );
 138     if( !mxContextStack->empty() )
 139     {
 140         onEndRecord();
 141         popElementInfo();
 142     }
 143 }
 144
 145 ElementInfo& ContextHandler2Helper::pushElementInfo( sal_Int32 nElement )
 146 {
 147     mxContextStack->emplace_back();
 148     ElementInfo& rInfo = mxContextStack->back();
 149     rInfo.mnElement = nElement;
 150     return rInfo;
 151 }
 152
 153 void ContextHandler2Helper::popElementInfo()
 154 {
 155     OSL_ENSURE( !mxContextStack->empty(), "ContextHandler2Helper::popElementInfo - context stack broken" );
 156     if( !mxContextStack->empty() )
 157         mxContextStack->pop_back();
 158 }
 159
 160 void ContextHandler2Helper::processCollectedChars()
 161 {
 162     OSL_ENSURE( !mxContextStack->empty(), "ContextHandler2Helper::processCollectedChars - no context info" );
 163     if (mxContextStack->empty())
 164         return;
 165     ElementInfo& rInfo = mxContextStack->back();
 166     if( !rInfo.maChars.isEmpty() )
 167     {
 168         OUString aChars = rInfo.maChars.makeStringAndClear();
 169         if( mbEnableTrimSpace && rInfo.mbTrimSpaces )
 170             aChars = aChars.trim();
 171         if( !aChars.isEmpty() )
 172             onCharacters( aChars );
 173     }
 174 }
 175
 176 ContextHandler2::ContextHandler2( ContextHandler2Helper const & rParent ) :
 177     ContextHandler( dynamic_cast< ContextHandler const & >( rParent ) ),
 178     ContextHandler2Helper( rParent )
 179 {
 180 }
 181
 182 ContextHandler2::~ContextHandler2()
 183 {
 184 }
 185
 186 // com.sun.star.xml.sax.XFastContextHandler interface -------------------------
 187
 188 Reference< XFastContextHandler > SAL_CALL ContextHandler2::createFastChildContext(
 189         sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs )
 190 {
 191     return implCreateChildContext( nElement, rxAttribs );
 192 }
 193
 194 void SAL_CALL ContextHandler2::startFastElement(
 195         sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs )
 196 {
 197     implStartElement( nElement, rxAttribs );
 198 }
 199
 200 void SAL_CALL ContextHandler2::characters( const OUString& rChars )
 201 {
 202     implCharacters( rChars );
 203 }
 204
 205 void SAL_CALL ContextHandler2::endFastElement( sal_Int32 nElement )
 206 {
 207     implEndElement( nElement );
 208 }
 209
 210 // oox.core.RecordContext interface -------------------------------------------
 211
 212 ContextHandlerRef ContextHandler2::createRecordContext( sal_Int32 nRecId, SequenceInputStream& rStrm )
 213 {
 214     return implCreateRecordContext( nRecId, rStrm );
 215 }
 216
 217 void ContextHandler2::startRecord( sal_Int32 nRecId, SequenceInputStream& rStrm )
 218 {
 219     implStartRecord( nRecId, rStrm );
 220 }
 221
 222 void ContextHandler2::endRecord( sal_Int32 nRecId )
 223 {
 224     implEndRecord( nRecId );
 225 }
 226
 227 // oox.core.ContextHandler2Helper interface -----------------------------------
 228
 229 ContextHandlerRef ContextHandler2::onCreateContext( sal_Int32, const AttributeList& )
 230 {
 231     return nullptr;
 232 }
 233
 234 void ContextHandler2::onStartElement( const AttributeList& )
 235 {
 236 }
 237
 238 void ContextHandler2::onCharacters( const OUString& )
 239 {
 240 }
 241
 242 void ContextHandler2::onEndElement()
 243 {
 244 }
 245
 246 ContextHandlerRef ContextHandler2::onCreateRecordContext( sal_Int32, SequenceInputStream& )
 247 {
 248     return nullptr;
 249 }
 250
 251 void ContextHandler2::onStartRecord( SequenceInputStream& )
 252 {
 253 }
 254
 255 void ContextHandler2::onEndRecord()
 256 {
 257 }
 258
 259 } // namespace core
 260 } // namespace oox
 261
 262 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */