oox/source/core/contexthandler2.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: contexthandler2.cxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #include "oox/core/contexthandler2.hxx"
  32 #include <rtl/ustrbuf.hxx>
  33
  34 using ::rtl::OUString;
  35 using ::rtl::OUStringBuffer;
  36 using ::com::sun::star::uno::Reference;
  37 using ::com::sun::star::uno::RuntimeException;
  38 using ::com::sun::star::xml::sax::SAXException;
  39 using ::com::sun::star::xml::sax::XFastAttributeList;
  40 using ::com::sun::star::xml::sax::XFastContextHandler;
  41
  42 namespace oox {
  43 namespace core {
  44
  45 // ============================================================================
  46
  47 /** Information about a processed context element. */
  48 struct ContextInfo
  49 {
  50     OUStringBuffer      maCurrChars;        /// Collected characters from context.
  51     OUStringBuffer      maFinalChars;       /// Finalized (stipped) characters.
  52     sal_Int32           mnElement;          /// The element identifier.
  53     bool                mbTrimSpaces;       /// True = trims leading/trailing spaces from text data.
  54
  55     explicit            ContextInfo();
  56 };
  57
  58 ContextInfo::ContextInfo() :
  59     mnElement( XML_TOKEN_INVALID ),
  60     mbTrimSpaces( false )
  61 {
  62 }
  63
  64 // ============================================================================
  65
  66 ContextHandler2Helper::ContextHandler2Helper( bool bEnableTrimSpace ) :
  67     mxContextStack( new ContextStack ),
  68     mnRootStackSize( 0 ),
  69     mbEnableTrimSpace( bEnableTrimSpace )
  70 {
  71     pushContextInfo( XML_ROOT_CONTEXT );
  72 }
  73
  74 ContextHandler2Helper::ContextHandler2Helper( const ContextHandler2Helper& rParent ) :
  75     mxContextStack( rParent.mxContextStack ),
  76     mnRootStackSize( rParent.mxContextStack->size() ),
  77     mbEnableTrimSpace( rParent.mbEnableTrimSpace )
  78 {
  79 }
  80
  81 ContextHandler2Helper::~ContextHandler2Helper()
  82 {
  83 }
  84
  85 sal_Int32 ContextHandler2Helper::getCurrentElement() const
  86 {
  87     return mxContextStack->empty() ? XML_ROOT_CONTEXT : mxContextStack->back().mnElement;
  88 }
  89
  90 sal_Int32 ContextHandler2Helper::getPreviousElement( sal_Int32 nCountBack ) const
  91 {
  92     if( (nCountBack < 0) || (mxContextStack->size() < static_cast< size_t >( nCountBack )) )
  93         return XML_TOKEN_INVALID;
  94     return (mxContextStack->size() == static_cast< size_t >( nCountBack )) ?
  95         XML_ROOT_CONTEXT : (*mxContextStack)[ mxContextStack->size() - nCountBack - 1 ].mnElement;
  96 }
  97
  98 bool ContextHandler2Helper::isRootElement() const
  99 {
 100     return mxContextStack->size() == mnRootStackSize + 1;
 101 }
 102
 103 Reference< XFastContextHandler > ContextHandler2Helper::implCreateChildContext( sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs )
 104 {
 105     appendCollectedChars();
 106     ContextHandlerRef xContext = onCreateContext( nElement, AttributeList( rxAttribs ) );
 107     return Reference< XFastContextHandler >( xContext.get() );
 108 }
 109
 110 void ContextHandler2Helper::implStartCurrentContext( sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs )
 111 {
 112     AttributeList aAttribs( rxAttribs );
 113     pushContextInfo( nElement ).mbTrimSpaces = aAttribs.getToken( NMSP_XML | XML_space, XML_TOKEN_INVALID ) != XML_preserve;
 114     onStartElement( aAttribs );
 115 }
 116
 117 void ContextHandler2Helper::implCharacters( const OUString& rChars )
 118 {
 119     // #i76091# collect characters until context ends
 120     if( !mxContextStack->empty() )
 121         mxContextStack->back().maCurrChars.append( rChars );
 122 }
 123
 124 void ContextHandler2Helper::implEndCurrentContext( sal_Int32 nElement )
 125 {
 126     (void)nElement;     // prevent "unused parameter" warning in product build
 127     OSL_ENSURE( getCurrentElement() == nElement, "ContextHandler2Helper::implEndCurrentContext - context stack broken" );
 128     if( !mxContextStack->empty() )
 129     {
 130         // #i76091# process collected characters
 131         appendCollectedChars();
 132         // finalize the current context and pop context info from stack
 133         onEndElement( mxContextStack->back().maFinalChars.makeStringAndClear() );
 134         popContextInfo();
 135     }
 136 }
 137
 138 ContextHandlerRef ContextHandler2Helper::implCreateRecordContext( sal_Int32 nRecId, RecordInputStream& rStrm )
 139 {
 140     return onCreateRecordContext( nRecId, rStrm );
 141 }
 142
 143 void ContextHandler2Helper::implStartRecord( sal_Int32 nRecId, RecordInputStream& rStrm )
 144 {
 145     pushContextInfo( nRecId );
 146     onStartRecord( rStrm );
 147 }
 148
 149 void ContextHandler2Helper::implEndRecord( sal_Int32 nRecId )
 150 {
 151     (void)nRecId;   // prevent "unused parameter" warning in product build
 152     OSL_ENSURE( getCurrentElement() == nRecId, "ContextHandler2Helper::implEndRecord - context stack broken" );
 153     if( !mxContextStack->empty() )
 154     {
 155         // finalize the current context and pop context info from stack
 156         onEndRecord();
 157         popContextInfo();
 158     }
 159 }
 160
 161 ContextInfo& ContextHandler2Helper::pushContextInfo( sal_Int32 nElement )
 162 {
 163     mxContextStack->resize( mxContextStack->size() + 1 );
 164     ContextInfo& rInfo = mxContextStack->back();
 165     rInfo.mnElement = nElement;
 166     return rInfo;
 167 }
 168
 169 void ContextHandler2Helper::popContextInfo()
 170 {
 171     OSL_ENSURE( !mxContextStack->empty(), "ContextHandler2Helper::popContextInfo - context stack broken" );
 172     if( !mxContextStack->empty() )
 173         mxContextStack->pop_back();
 174 }
 175
 176 void ContextHandler2Helper::appendCollectedChars()
 177 {
 178     OSL_ENSURE( !mxContextStack->empty(), "ContextHandler2Helper::appendCollectedChars - no context info" );
 179     ContextInfo& rInfo = mxContextStack->back();
 180     if( rInfo.maCurrChars.getLength() > 0 )
 181     {
 182         OUString aChars = rInfo.maCurrChars.makeStringAndClear();
 183         rInfo.maFinalChars.append( (mbEnableTrimSpace && rInfo.mbTrimSpaces) ? aChars.trim() : aChars );
 184     }
 185 }
 186
 187 // ============================================================================
 188
 189 ContextHandler2::ContextHandler2( ContextHandler2Helper& rParent ) :
 190     ContextHandler( rParent.queryContextHandler() ),
 191     ContextHandler2Helper( rParent )
 192 {
 193 }
 194
 195 ContextHandler2::~ContextHandler2()
 196 {
 197 }
 198
 199 ContextHandler& ContextHandler2::queryContextHandler()
 200 {
 201     return *this;
 202 }
 203
 204 // com.sun.star.xml.sax.XFastContextHandler interface -------------------------
 205
 206 Reference< XFastContextHandler > SAL_CALL ContextHandler2::createFastChildContext(
 207         sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs ) throw( SAXException, RuntimeException )
 208 {
 209     return implCreateChildContext( nElement, rxAttribs );
 210 }
 211
 212 void SAL_CALL ContextHandler2::startFastElement(
 213         sal_Int32 nElement, const Reference< XFastAttributeList >& rxAttribs ) throw( SAXException, RuntimeException )
 214 {
 215     implStartCurrentContext( nElement, rxAttribs );
 216 }
 217
 218 void SAL_CALL ContextHandler2::characters( const OUString& rChars ) throw( SAXException, RuntimeException )
 219 {
 220     implCharacters( rChars );
 221 }
 222
 223 void SAL_CALL ContextHandler2::endFastElement( sal_Int32 nElement ) throw( SAXException, RuntimeException )
 224 {
 225     implEndCurrentContext( nElement );
 226 }
 227
 228 // oox.core.RecordContext interface -------------------------------------------
 229
 230 ContextHandlerRef ContextHandler2::createRecordContext( sal_Int32 nRecId, RecordInputStream& rStrm )
 231 {
 232     return implCreateRecordContext( nRecId, rStrm );
 233 }
 234
 235 void ContextHandler2::startRecord( sal_Int32 nRecId, RecordInputStream& rStrm )
 236 {
 237     implStartRecord( nRecId, rStrm );
 238 }
 239
 240 void ContextHandler2::endRecord( sal_Int32 nRecId )
 241 {
 242     implEndRecord( nRecId );
 243 }
 244
 245 // oox.core.ContextHandler2Helper interface -----------------------------------
 246
 247 ContextHandlerRef ContextHandler2::onCreateContext( sal_Int32, const AttributeList& )
 248 {
 249     return 0;
 250 }
 251
 252 void ContextHandler2::onStartElement( const AttributeList& )
 253 {
 254 }
 255
 256 void ContextHandler2::onEndElement( const OUString& )
 257 {
 258 }
 259
 260 ContextHandlerRef ContextHandler2::onCreateRecordContext( sal_Int32, RecordInputStream& )
 261 {
 262     return 0;
 263 }
 264
 265 void ContextHandler2::onStartRecord( RecordInputStream& )
 266 {
 267 }
 268
 269 void ContextHandler2::onEndRecord()
 270 {
 271 }
 272
 273 // ============================================================================
 274
 275 } // namespace core
 276 } // namespace oox
 277