svl/source/items/itemprop.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/any.hxx>
  23 #include <svl/itemprop.hxx>
  24 #include <svl/itempool.hxx>
  25 #include <svl/itemset.hxx>
  26 #include <com/sun/star/beans/PropertyAttribute.hpp>
  27 #include <memory>
  28 #include <unordered_map>
  29 /*
  30  * UNO III Implementation
  31  */
  32 using namespace com::sun::star;
  33 using namespace com::sun::star::beans;
  34 using namespace com::sun::star::lang;
  35 using namespace com::sun::star::uno;
  36
  37 typedef std::unordered_map< OUString,
  38                             SfxItemPropertySimpleEntry > SfxItemPropertyHashMap_t;
  39
  40 class SfxItemPropertyMap_Impl : public SfxItemPropertyHashMap_t
  41 {
  42 public:
  43     mutable uno::Sequence< beans::Property > m_aPropSeq;
  44
  45     SfxItemPropertyMap_Impl(){}
  46     explicit SfxItemPropertyMap_Impl( const SfxItemPropertyMap_Impl* pSource );
  47 };
  48
  49 SfxItemPropertyMap_Impl::SfxItemPropertyMap_Impl( const SfxItemPropertyMap_Impl* pSource )
  50 {
  51     SfxItemPropertyHashMap_t::operator=( *pSource );
  52     m_aPropSeq = pSource->m_aPropSeq;
  53 }
  54
  55 SfxItemPropertyMap::SfxItemPropertyMap( const SfxItemPropertyMapEntry* pEntries ) :
  56     m_pImpl( new SfxItemPropertyMap_Impl )
  57 {
  58     while( !pEntries->aName.isEmpty() )
  59     {
  60         (*m_pImpl) [ pEntries->aName ] = pEntries;
  61         ++pEntries;
  62     }
  63 }
  64
  65 SfxItemPropertyMap::SfxItemPropertyMap( const SfxItemPropertyMap& rSource ) :
  66     m_pImpl( new SfxItemPropertyMap_Impl( rSource.m_pImpl.get() ) )
  67 {
  68 }
  69
  70 SfxItemPropertyMap::~SfxItemPropertyMap()
  71 {
  72 }
  73
  74 const SfxItemPropertySimpleEntry* SfxItemPropertyMap::getByName( const OUString &rName ) const
  75 {
  76     SfxItemPropertyHashMap_t::const_iterator aIter = m_pImpl->find(rName);
  77     if( aIter == m_pImpl->end() )
  78         return nullptr;
  79     return &aIter->second;
  80 }
  81
  82 uno::Sequence<beans::Property> const & SfxItemPropertyMap::getProperties() const
  83 {
  84     if( !m_pImpl->m_aPropSeq.getLength() )
  85     {
  86         m_pImpl->m_aPropSeq.realloc( m_pImpl->size() );
  87         beans::Property* pPropArray = m_pImpl->m_aPropSeq.getArray();
  88         sal_uInt32 n = 0;
  89         for( const auto& rEntry : *m_pImpl )
  90         //for ( const SfxItemPropertyMap *pMap = _pMap; pMap->pName; ++pMap )
  91         {
  92             const SfxItemPropertySimpleEntry* pEntry = &rEntry.second;
  93             pPropArray[n].Name = rEntry.first;
  94             pPropArray[n].Handle = pEntry->nWID;
  95             pPropArray[n].Type = pEntry->aType;
  96             pPropArray[n].Attributes =
  97                 sal::static_int_cast< sal_Int16 >(pEntry->nFlags);
  98             n++;
  99         }
 100     }
 101
 102     return m_pImpl->m_aPropSeq;
 103 }
 104
 105 beans::Property SfxItemPropertyMap::getPropertyByName( const OUString & rName ) const
 106 {
 107     SfxItemPropertyHashMap_t::const_iterator aIter = m_pImpl->find(rName);
 108     if( aIter == m_pImpl->end() )
 109         throw UnknownPropertyException();
 110     const SfxItemPropertySimpleEntry* pEntry = &aIter->second;
 111     beans::Property aProp;
 112     aProp.Name = rName;
 113     aProp.Handle = pEntry->nWID;
 114     aProp.Type = pEntry->aType;
 115     aProp.Attributes = sal::static_int_cast< sal_Int16 >(pEntry->nFlags);
 116     return aProp;
 117 }
 118
 119 bool SfxItemPropertyMap::hasPropertyByName( const OUString& rName ) const
 120 {
 121     SfxItemPropertyHashMap_t::const_iterator aIter = m_pImpl->find(rName);
 122     return aIter != m_pImpl->end();
 123 }
 124
 125 void SfxItemPropertyMap::mergeProperties( const uno::Sequence< beans::Property >& rPropSeq )
 126 {
 127     const beans::Property* pPropArray = rPropSeq.getConstArray();
 128     sal_uInt32 nElements = rPropSeq.getLength();
 129     for( sal_uInt32 nElement = 0; nElement < nElements; ++nElement )
 130     {
 131         SfxItemPropertySimpleEntry aTemp(
 132             sal::static_int_cast< sal_Int16 >( pPropArray[nElement].Handle ), //nWID
 133             pPropArray[nElement].Type, //aType
 134             pPropArray[nElement].Attributes); //nFlags
 135         (*m_pImpl)[pPropArray[nElement].Name] = aTemp;
 136     }
 137 }
 138
 139 PropertyEntryVector_t SfxItemPropertyMap::getPropertyEntries() const
 140 {
 141     PropertyEntryVector_t aRet;
 142     aRet.reserve(m_pImpl->size());
 143
 144     for( const auto& rEntry : *m_pImpl )
 145     {
 146         const SfxItemPropertySimpleEntry* pEntry = &rEntry.second;
 147         aRet.emplace_back( rEntry.first, * pEntry );
 148     }
 149     return aRet;
 150 }
 151
 152 sal_uInt32 SfxItemPropertyMap::getSize() const
 153 {
 154     return m_pImpl->size();
 155 }
 156
 157 SfxItemPropertySet::~SfxItemPropertySet()
 158 {
 159 }
 160
 161 void SfxItemPropertySet::getPropertyValue( const SfxItemPropertySimpleEntry& rEntry,
 162             const SfxItemSet& rSet, Any& rAny ) const
 163 {
 164     // get the SfxPoolItem
 165     const SfxPoolItem* pItem = nullptr;
 166     SfxItemState eState = rSet.GetItemState( rEntry.nWID, true, &pItem );
 167     if (SfxItemState::SET != eState && SfxItemPool::IsWhich(rEntry.nWID) )
 168         pItem = &rSet.GetPool()->GetDefaultItem(rEntry.nWID);
 169     // return item values as uno::Any
 170     if(eState >= SfxItemState::DEFAULT && pItem)
 171     {
 172         pItem->QueryValue( rAny, rEntry.nMemberId );
 173     }
 174     else if(0 == (rEntry.nFlags & PropertyAttribute::MAYBEVOID))
 175     {
 176         throw RuntimeException(
 177             "Property not found in ItemSet but not MAYBEVOID?", nullptr);
 178     }
 179
 180     // convert general SfxEnumItem values to specific values
 181     if( rEntry.aType.getTypeClass() == TypeClass_ENUM &&
 182          rAny.getValueTypeClass() == TypeClass_LONG )
 183     {
 184         sal_Int32 nTmp = *o3tl::forceAccess<sal_Int32>(rAny);
 185         rAny.setValue( &nTmp, rEntry.aType );
 186     }
 187 }
 188
 189 void SfxItemPropertySet::getPropertyValue( const OUString &rName,
 190                                            const SfxItemSet& rSet, Any& rAny ) const
 191 {
 192     // detect which-id
 193     const SfxItemPropertySimpleEntry* pEntry = m_aMap.getByName( rName );
 194     if ( !pEntry )
 195         throw UnknownPropertyException();
 196     getPropertyValue( *pEntry,rSet, rAny );
 197 }
 198
 199 Any SfxItemPropertySet::getPropertyValue( const OUString &rName,
 200                                           const SfxItemSet& rSet ) const
 201 {
 202     Any aVal;
 203     getPropertyValue( rName,rSet, aVal );
 204     return aVal;
 205 }
 206
 207 void SfxItemPropertySet::setPropertyValue( const SfxItemPropertySimpleEntry& rEntry,
 208                                            const Any& aVal,
 209                                            SfxItemSet& rSet ) const
 210 {
 211     // get the SfxPoolItem
 212     const SfxPoolItem* pItem = nullptr;
 213     std::unique_ptr<SfxPoolItem> pNewItem;
 214     SfxItemState eState = rSet.GetItemState( rEntry.nWID, true, &pItem );
 215     if (SfxItemState::SET != eState && SfxItemPool::IsWhich(rEntry.nWID))
 216         pItem = &rSet.GetPool()->GetDefaultItem(rEntry.nWID);
 217     if (pItem)
 218     {
 219         pNewItem.reset(pItem->Clone());
 220     }
 221     if(pNewItem)
 222     {
 223         if( !pNewItem->PutValue( aVal, rEntry.nMemberId ) )
 224         {
 225             throw IllegalArgumentException();
 226         }
 227         // apply new item
 228         rSet.Put( *pNewItem );
 229     }
 230 }
 231
 232 void SfxItemPropertySet::setPropertyValue( const OUString &rName,
 233                                            const Any& aVal,
 234                                            SfxItemSet& rSet ) const
 235 {
 236     const SfxItemPropertySimpleEntry* pEntry = m_aMap.getByName( rName );
 237     if ( !pEntry )
 238     {
 239         throw UnknownPropertyException();
 240     }
 241     setPropertyValue(*pEntry, aVal, rSet);
 242 }
 243
 244 PropertyState SfxItemPropertySet::getPropertyState(const SfxItemPropertySimpleEntry& rEntry, const SfxItemSet& rSet) const
 245     throw()
 246 {
 247     PropertyState eRet = PropertyState_DIRECT_VALUE;
 248     sal_uInt16 nWhich = rEntry.nWID;
 249
 250     // Get item state
 251     SfxItemState eState = rSet.GetItemState( nWhich, false );
 252     // Return item value as UnoAny
 253     if(eState == SfxItemState::DEFAULT)
 254         eRet = PropertyState_DEFAULT_VALUE;
 255     else if(eState < SfxItemState::DEFAULT)
 256         eRet = PropertyState_AMBIGUOUS_VALUE;
 257     return eRet;
 258 }
 259
 260 PropertyState   SfxItemPropertySet::getPropertyState(const OUString& rName, const SfxItemSet& rSet) const
 261 {
 262     PropertyState eRet = PropertyState_DIRECT_VALUE;
 263
 264     // Get WhichId
 265     const SfxItemPropertySimpleEntry* pEntry = m_aMap.getByName( rName );
 266     if( !pEntry || !pEntry->nWID )
 267     {
 268         throw UnknownPropertyException();
 269     }
 270     sal_uInt16 nWhich = pEntry->nWID;
 271
 272     // Get item state
 273     SfxItemState eState = rSet.GetItemState(nWhich, false);
 274     // Return item value as UnoAny
 275     if(eState == SfxItemState::DEFAULT)
 276         eRet = PropertyState_DEFAULT_VALUE;
 277     else if(eState < SfxItemState::DEFAULT)
 278         eRet = PropertyState_AMBIGUOUS_VALUE;
 279     return eRet;
 280 }
 281
 282 Reference<XPropertySetInfo> const & SfxItemPropertySet::getPropertySetInfo() const
 283 {
 284     if( !m_xInfo.is() )
 285         m_xInfo = new SfxItemPropertySetInfo( m_aMap );
 286     return m_xInfo;
 287 }
 288
 289 SfxItemPropertySetInfo::SfxItemPropertySetInfo(const SfxItemPropertyMap &rMap )
 290     : m_aOwnMap( rMap )
 291 {
 292 }
 293
 294 SfxItemPropertySetInfo::SfxItemPropertySetInfo(const SfxItemPropertyMapEntry *pEntries )
 295     : m_aOwnMap( pEntries )
 296 {
 297 }
 298
 299 Sequence< Property > SAL_CALL SfxItemPropertySetInfo::getProperties(  )
 300 {
 301     return m_aOwnMap.getProperties();
 302 }
 303
 304 SfxItemPropertySetInfo::~SfxItemPropertySetInfo()
 305 {
 306 }
 307
 308 Property SAL_CALL SfxItemPropertySetInfo::getPropertyByName( const OUString& rName )
 309 {
 310     return m_aOwnMap.getPropertyByName( rName );
 311 }
 312
 313 sal_Bool SAL_CALL SfxItemPropertySetInfo::hasPropertyByName( const OUString& rName )
 314 {
 315     return m_aOwnMap.hasPropertyByName( rName );
 316 }
 317
 318 SfxExtItemPropertySetInfo::SfxExtItemPropertySetInfo( const SfxItemPropertyMapEntry *pMap,
 319                                                       const Sequence<Property>& rPropSeq )
 320     : aExtMap( pMap )
 321 {
 322     aExtMap.mergeProperties( rPropSeq );
 323 }
 324
 325 SfxExtItemPropertySetInfo::~SfxExtItemPropertySetInfo()
 326 {
 327 }
 328
 329 Sequence< Property > SAL_CALL SfxExtItemPropertySetInfo::getProperties(  )
 330 {
 331     return aExtMap.getProperties();
 332 }
 333
 334 Property SAL_CALL SfxExtItemPropertySetInfo::getPropertyByName( const OUString& rPropertyName )
 335 {
 336     return aExtMap.getPropertyByName( rPropertyName );
 337 }
 338
 339 sal_Bool SAL_CALL SfxExtItemPropertySetInfo::hasPropertyByName( const OUString& rPropertyName )
 340 {
 341     return aExtMap.hasPropertyByName( rPropertyName );
 342 }
 343
 344 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */