svl/source/items/macitem.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 <sal/config.h>
  21
  22 #include <o3tl/safeint.hxx>
  23 #include <sal/log.hxx>
  24 #include <comphelper/fileformat.h>
  25 #include <tools/stream.hxx>
  26
  27 #include <svl/macitem.hxx>
  28 #include <stringio.hxx>
  29 #include <algorithm>
  30
  31 SvxMacro::SvxMacro( const OUString &rMacName, const OUString &rLanguage)
  32     : aMacName( rMacName ), aLibName( rLanguage),
  33       eType( EXTENDED_STYPE)
  34 {
  35     if ( rLanguage == SVX_MACRO_LANGUAGE_STARBASIC )
  36         eType=STARBASIC;
  37     else if ( rLanguage == SVX_MACRO_LANGUAGE_JAVASCRIPT )
  38         eType=JAVASCRIPT;
  39 }
  40
  41 OUString SvxMacro::GetLanguage()const
  42 {
  43     if(eType==STARBASIC)
  44     {
  45         return SVX_MACRO_LANGUAGE_STARBASIC;
  46     }
  47     else if(eType==JAVASCRIPT)
  48     {
  49         return SVX_MACRO_LANGUAGE_JAVASCRIPT;
  50     }
  51     else if(eType==EXTENDED_STYPE)
  52     {
  53         return SVX_MACRO_LANGUAGE_SF;
  54
  55     }
  56     return aLibName;
  57 }
  58
  59 SvxMacroTableDtor& SvxMacroTableDtor::operator=( const SvxMacroTableDtor& rTbl )
  60 {
  61     if (this != &rTbl)
  62     {
  63         aSvxMacroTable.clear();
  64         aSvxMacroTable.insert(rTbl.aSvxMacroTable.begin(), rTbl.aSvxMacroTable.end());
  65     }
  66     return *this;
  67 }
  68
  69 bool SvxMacroTableDtor::operator==( const SvxMacroTableDtor& rOther ) const
  70 {
  71     // Count different => odd in any case
  72     // Compare single ones; the sequence matters due to performance reasons
  73     return std::equal(aSvxMacroTable.begin(), aSvxMacroTable.end(),
  74         rOther.aSvxMacroTable.begin(), rOther.aSvxMacroTable.end(),
  75         [](const SvxMacroTable::value_type& rOwnEntry, const SvxMacroTable::value_type& rOtherEntry) {
  76             const SvxMacro& rOwnMac = rOwnEntry.second;
  77             const SvxMacro& rOtherMac = rOtherEntry.second;
  78             return rOwnEntry.first == rOtherEntry.first
  79                 && rOwnMac.GetLibName() == rOtherMac.GetLibName()
  80                 && rOwnMac.GetMacName() == rOtherMac.GetMacName();
  81         });
  82 }
  83
  84 void SvxMacroTableDtor::Read( SvStream& rStrm )
  85 {
  86     sal_uInt16 nVersion;
  87     rStrm.ReadUInt16( nVersion );
  88
  89     short nReadMacro(0);
  90     rStrm.ReadInt16(nReadMacro);
  91     if (nReadMacro < 0)
  92     {
  93         SAL_WARN("editeng", "Parsing error: negative value " << nReadMacro);
  94         return;
  95     }
  96
  97     auto nMacro = o3tl::make_unsigned(nReadMacro);
  98
  99     const size_t nMinStringSize = rStrm.GetStreamCharSet() == RTL_TEXTENCODING_UNICODE ? 4 : 2;
 100     size_t nMinRecordSize = 2 + 2*nMinStringSize;
 101     if( SVX_MACROTBL_VERSION40 <= nVersion )
 102         nMinRecordSize+=2;
 103
 104     const size_t nMaxRecords = rStrm.remainingSize() / nMinRecordSize;
 105     if (nMacro > nMaxRecords)
 106     {
 107         SAL_WARN("editeng", "Parsing error: " << nMaxRecords <<
 108                  " max possible entries, but " << nMacro<< " claimed, truncating");
 109         nMacro = nMaxRecords;
 110     }
 111
 112     for (decltype(nMacro) i = 0; i < nMacro; ++i)
 113     {
 114         sal_uInt16 nCurKey, eType = STARBASIC;
 115         OUString aLibName, aMacName;
 116         rStrm.ReadUInt16( nCurKey );
 117         aLibName = readByteString(rStrm);
 118         aMacName = readByteString(rStrm);
 119
 120         if( SVX_MACROTBL_VERSION40 <= nVersion )
 121             rStrm.ReadUInt16( eType );
 122
 123         aSvxMacroTable.emplace( SvMacroItemId(nCurKey), SvxMacro( aMacName, aLibName, static_cast<ScriptType>(eType) ) );
 124     }
 125 }
 126
 127 SvStream& SvxMacroTableDtor::Write( SvStream& rStream ) const
 128 {
 129     sal_uInt16 nVersion = SOFFICE_FILEFORMAT_31 == rStream.GetVersion()
 130                                     ? SVX_MACROTBL_VERSION31
 131                                     : SVX_MACROTBL_VERSION40;
 132
 133     if( SVX_MACROTBL_VERSION40 <= nVersion )
 134         rStream.WriteUInt16( nVersion );
 135
 136     rStream.WriteUInt16( aSvxMacroTable.size() );
 137
 138     for( const auto& rEntry : aSvxMacroTable )
 139     {
 140         if (rStream.GetError() != ERRCODE_NONE)
 141             break;
 142         const SvxMacro& rMac = rEntry.second;
 143         rStream.WriteUInt16( static_cast<sal_uInt16>(rEntry.first) );
 144         writeByteString(rStream, rMac.GetLibName());
 145         writeByteString(rStream, rMac.GetMacName());
 146
 147         if( SVX_MACROTBL_VERSION40 <= nVersion )
 148             rStream.WriteUInt16( rMac.GetScriptType() );
 149     }
 150     return rStream;
 151 }
 152
 153 // returns NULL if no entry exists, or a pointer to the internal value
 154 const SvxMacro* SvxMacroTableDtor::Get(SvMacroItemId nEvent) const
 155 {
 156     SvxMacroTable::const_iterator it = aSvxMacroTable.find(nEvent);
 157     return it == aSvxMacroTable.end() ? nullptr : &(it->second);
 158 }
 159
 160 // returns NULL if no entry exists, or a pointer to the internal value
 161 SvxMacro* SvxMacroTableDtor::Get(SvMacroItemId nEvent)
 162 {
 163     SvxMacroTable::iterator it = aSvxMacroTable.find(nEvent);
 164     return it == aSvxMacroTable.end() ? nullptr : &(it->second);
 165 }
 166
 167 // return true if the key exists
 168 bool SvxMacroTableDtor::IsKeyValid(SvMacroItemId nEvent) const
 169 {
 170     SvxMacroTable::const_iterator it = aSvxMacroTable.find(nEvent);
 171     return it != aSvxMacroTable.end();
 172 }
 173
 174 // This stores a copy of the rMacro parameter
 175 SvxMacro& SvxMacroTableDtor::Insert(SvMacroItemId nEvent, const SvxMacro& rMacro)
 176 {
 177     return aSvxMacroTable.emplace( nEvent, rMacro ).first->second;
 178 }
 179
 180 // If the entry exists, remove it from the map and release it's storage
 181 void SvxMacroTableDtor::Erase(SvMacroItemId nEvent)
 182 {
 183     SvxMacroTable::iterator it = aSvxMacroTable.find(nEvent);
 184     if ( it != aSvxMacroTable.end())
 185     {
 186         aSvxMacroTable.erase(it);
 187     }
 188 }
 189
 190 bool SvxMacroItem::operator==( const SfxPoolItem& rAttr ) const
 191 {
 192     assert(SfxPoolItem::operator==(rAttr));
 193
 194     const SvxMacroTableDtor& rOwn = aMacroTable;
 195     const SvxMacroTableDtor& rOther = static_cast<const SvxMacroItem&>(rAttr).aMacroTable;
 196
 197     return rOwn == rOther;
 198 }
 199
 200 SvxMacroItem* SvxMacroItem::Clone( SfxItemPool* ) const
 201 {
 202     return new SvxMacroItem( *this );
 203 }
 204
 205 bool SvxMacroItem::GetPresentation
 206 (
 207     SfxItemPresentation /*ePres*/,
 208     MapUnit             /*eCoreUnit*/,
 209     MapUnit             /*ePresUnit*/,
 210     OUString&           rText,
 211     const IntlWrapper&
 212 )   const
 213 {
 214 /*!!!
 215     SvxMacroTableDtor& rTbl = (SvxMacroTableDtor&)GetMacroTable();
 216     SvxMacro* pMac = rTbl.First();
 217
 218     while ( pMac )
 219     {
 220         rText += pMac->GetLibName();
 221         rText += cpDelim;
 222         rText += pMac->GetMacName();
 223         pMac = rTbl.Next();
 224         if ( pMac )
 225             rText += cpDelim;
 226     }
 227 */
 228     rText.clear();
 229     return false;
 230 }
 231
 232
 233 void SvxMacroItem::SetMacro( SvMacroItemId nEvent, const SvxMacro& rMacro )
 234 {
 235     aMacroTable.Insert( nEvent, rMacro);
 236 }
 237
 238 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */