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