include/sax/fastattribs.hxx

   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 #ifndef INCLUDED_SAX_FASTATTRIBS_HXX
  21 #define INCLUDED_SAX_FASTATTRIBS_HXX
  22
  23 #include <com/sun/star/xml/sax/XFastAttributeList.hpp>
  24 #include <com/sun/star/xml/sax/XFastTokenHandler.hpp>
  25 #include <com/sun/star/xml/Attribute.hpp>
  26 #include <com/sun/star/xml/FastAttribute.hpp>
  27
  28 #include <cppuhelper/implbase.hxx>
  29 #include <sax/saxdllapi.h>
  30
  31 #include <map>
  32 #include <vector>
  33
  34 namespace sax_fastparser
  35 {
  36
  37 struct UnknownAttribute
  38 {
  39     OUString maNamespaceURL;
  40     OString maName;
  41     OString maValue;
  42
  43     UnknownAttribute( const OUString& rNamespaceURL, const OString& rName, const OString& value );
  44     UnknownAttribute( const OString& rName, const OString& value );
  45
  46     void FillAttribute( css::xml::Attribute* pAttrib ) const;
  47 };
  48
  49 typedef std::vector< UnknownAttribute > UnknownAttributeList;
  50
  51 /// A native C++ interface to tokenisation
  52 class SAX_DLLPUBLIC FastTokenHandlerBase
  53 {
  54  public:
  55     virtual ~FastTokenHandlerBase();
  56     virtual sal_Int32 getTokenDirect( const char *pToken, sal_Int32 nLength ) const = 0;
  57
  58     /**
  59      * Client method to attempt the use of this interface if possible.
  60      * @xTokenHandler - the UNO handle for the token lookup interface
  61      * @pTokenHandler - a dynamic_cast version of @xTokenHandler to this interface
  62      * @pStr - string buffer to lookup
  63      * @nLength - optional length of chars in that buffer
  64      *
  65      * @return Tokenized form of pStr
  66      */
  67     static sal_Int32 getTokenFromChars(
  68                          const css::uno::Reference<css::xml::sax::XFastTokenHandler > &xTokenHandler,
  69                          FastTokenHandlerBase *pTokenHandler /* can be NULL */,
  70                          const char *pStr, size_t nLength );
  71 };
  72
  73 class SAX_DLLPUBLIC FastAttributeList : public cppu::WeakImplHelper< css::xml::sax::XFastAttributeList >
  74 {
  75 public:
  76     FastAttributeList( const css::uno::Reference< css::xml::sax::XFastTokenHandler >& xTokenHandler,
  77                        FastTokenHandlerBase *pOptHandlerBase = nullptr );
  78     virtual ~FastAttributeList() override;
  79
  80     void clear();
  81     void add( sal_Int32 nToken, const sal_Char* pValue );
  82     void add( sal_Int32 nToken, const sal_Char* pValue, size_t nValueLength );
  83     void add( sal_Int32 nToken, const OString& rValue );
  84     void addNS( sal_Int32 nNamespaceToken, sal_Int32 nToken, const OString& rValue );
  85     void addUnknown( const OUString& rNamespaceURL, const OString& rName, const OString& value );
  86     void addUnknown( const OString& rName, const OString& value );
  87     const std::vector< sal_Int32 >&  getFastAttributeTokens() const { return maAttributeTokens; }
  88     const char* getFastAttributeValue(size_t nIndex) const { return mpChunk + maAttributeValues[nIndex]; }
  89     sal_Int32 AttributeValueLength(size_t i) const { return maAttributeValues[i + 1] - maAttributeValues[i] - 1; }
  90
  91     // performance sensitive shortcuts to avoid allocation ...
  92     bool getAsInteger( sal_Int32 nToken, sal_Int32 &rInt);
  93     bool getAsDouble( sal_Int32 nToken, double &rDouble);
  94     bool getAsChar( sal_Int32 nToken, const char*& rPos ) const;
  95
  96     // XFastAttributeList
  97     virtual sal_Bool SAL_CALL hasAttribute( ::sal_Int32 Token ) override;
  98     virtual ::sal_Int32 SAL_CALL getValueToken( ::sal_Int32 Token ) override;
  99     virtual ::sal_Int32 SAL_CALL getOptionalValueToken( ::sal_Int32 Token, ::sal_Int32 Default ) override;
 100     virtual OUString SAL_CALL getValue( ::sal_Int32 Token ) override;
 101     virtual OUString SAL_CALL getOptionalValue( ::sal_Int32 Token ) override;
 102     virtual css::uno::Sequence< css::xml::Attribute > SAL_CALL getUnknownAttributes(  ) override;
 103     virtual css::uno::Sequence< css::xml::FastAttribute > SAL_CALL getFastAttributes() override;
 104
 105     /// Use for fast iteration and conversion of attributes
 106     class FastAttributeIter {
 107         const FastAttributeList &mrList;
 108         size_t mnIdx;
 109
 110     public:
 111         FastAttributeIter(const FastAttributeList &rList, size_t nIdx)
 112             : mrList(rList), mnIdx(nIdx)
 113         {
 114         }
 115
 116         FastAttributeIter& operator++ ()
 117         {
 118             mnIdx++;
 119             return *this;
 120         }
 121         bool operator!=( const FastAttributeIter& rhs ) const
 122         {
 123             return mnIdx != rhs.mnIdx;
 124         }
 125
 126         sal_Int32 getToken()
 127         {
 128             assert(mnIdx < mrList.maAttributeTokens.size());
 129             return mrList.maAttributeTokens[mnIdx];
 130         }
 131         bool isEmpty()
 132         {
 133             assert(mnIdx < mrList.maAttributeTokens.size());
 134             return mrList.AttributeValueLength(mnIdx) < 1;
 135         }
 136         sal_Int32 toInt32()
 137         {
 138             assert(mnIdx < mrList.maAttributeTokens.size());
 139             return rtl_str_toInt32(mrList.getFastAttributeValue(mnIdx), 10);
 140         }
 141         OUString toString()
 142         {
 143             assert(mnIdx < mrList.maAttributeTokens.size());
 144             return OUString(mrList.getFastAttributeValue(mnIdx),
 145                             mrList.AttributeValueLength(mnIdx),
 146                             RTL_TEXTENCODING_UTF8);
 147         }
 148
 149         const char* toCString()
 150         {
 151             assert(mnIdx < mrList.maAttributeTokens.size());
 152             return mrList.getFastAttributeValue(mnIdx);
 153         }
 154         bool isString(const char *str)
 155         {
 156             assert(mnIdx < mrList.maAttributeTokens.size());
 157             return !strcmp(str, mrList.getFastAttributeValue(mnIdx));
 158         }
 159     };
 160     const FastAttributeIter begin() const { return FastAttributeIter(*this, 0); }
 161     const FastAttributeIter end() const { return FastAttributeIter(*this, maAttributeTokens.size()); }
 162
 163 private:
 164     sal_Char *mpChunk; ///< buffer to store all attribute values - null terminated strings
 165     sal_Int32 mnChunkLength; ///< size of allocated memory for mpChunk
 166     // maAttributeValues stores pointers, relative to mpChunk, for each attribute value string
 167     // length of the string is maAttributeValues[n+1] - maAttributeValues[n] - 1
 168     // maAttributeValues[0] == 0
 169     std::vector< sal_Int32 > maAttributeValues;
 170     std::vector< sal_Int32 > maAttributeTokens;
 171     UnknownAttributeList maUnknownAttributes;
 172     css::uno::Reference< css::xml::sax::XFastTokenHandler > mxTokenHandler;
 173     FastTokenHandlerBase *mpTokenHandler;
 174 };
 175
 176 }
 177
 178 #endif
 179
 180 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */