svl/source/items/poolitem.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
  21 #include <svl/poolitem.hxx>
  22 #include <tools/stream.hxx>
  23
  24 // STATIC DATA -----------------------------------------------------------
  25
  26 DBG_NAME(SfxPoolItem)
  27 DBG_NAME(SfxVoidItem)
  28 // @@@ DBG_NAME(SfxInvalidItem);
  29 DBG_NAME(SfxItemHandle)
  30
  31 // RTTI ------------------------------------------------------------------
  32
  33 TYPEINIT0(SfxPoolItem);
  34 TYPEINIT1(SfxVoidItem, SfxPoolItem);
  35 // @@@ TYPEINIT1(SfxInvalidItem, SfxPoolItem);
  36 TYPEINIT1(SfxSetItem, SfxPoolItem);
  37 // @@@ TYPEINIT1(SfxItemChangedHint, SfxHint);
  38
  39 // ------------------------------------------------------------------------
  40 #if OSL_DEBUG_LEVEL > 1
  41 static sal_uLong nItemCount = 0;
  42
  43 const char* pw1 = "Wow! 10.000 items!";
  44 const char* pw2 = "Wow! 100.000 items!";
  45 const char* pw3 = "Wow! 1.000.000 items!";
  46 const char* pw4 = "Wow! 50.000.000 items!";
  47 const char* pw5 = "Wow! 10.000.000 items!";
  48 #endif
  49
  50 IMPL_PTRHINT(SfxPoolItemHint,SfxPoolItem)
  51
  52 // SfxPoolItem -----------------------------------------------------------
  53 SfxPoolItem::SfxPoolItem(sal_uInt16 const nWhich)
  54     : m_nRefCount(0)
  55     , m_nWhich(nWhich)
  56     , m_nKind(0)
  57 {
  58     DBG_CTOR(SfxPoolItem, 0);
  59     DBG_ASSERT(nWhich <= SHRT_MAX, "invalid WhichId");
  60 #if OSL_DEBUG_LEVEL > 1
  61     ++nItemCount;
  62     if ( pw1 && nItemCount>=10000 )
  63     {
  64         DBG_WARNING( pw1 );
  65         pw1 = NULL;
  66     }
  67     if ( pw2 && nItemCount>=100000 )
  68     {
  69         DBG_WARNING( pw2 );
  70         pw2 = NULL;
  71     }
  72     if ( pw3 && nItemCount>=1000000 )
  73     {
  74         DBG_WARNING( pw3 );
  75         pw3 = NULL;
  76     }
  77     if ( pw4 && nItemCount>=5000000 )
  78     {
  79         DBG_WARNING( pw4 );
  80         pw4 = NULL;
  81     }
  82     if ( pw5 && nItemCount>=10000000 )
  83     {
  84         DBG_WARNING( pw5 );
  85         pw5 = NULL;
  86     }
  87 #endif
  88 }
  89
  90 // -----------------------------------------------------------------------
  91 SfxPoolItem::SfxPoolItem( const SfxPoolItem& rCpy )
  92     : m_nRefCount(0) // don't copy that
  93     , m_nWhich(rCpy.Which()) // call function because of ChkThis() (WTF does that mean?)
  94     , m_nKind( 0 )
  95 {
  96     DBG_CTOR(SfxPoolItem, 0);
  97 #if OSL_DEBUG_LEVEL > 1
  98     ++nItemCount;
  99     if ( pw1 && nItemCount>=10000 )
 100     {
 101         DBG_WARNING( pw1 );
 102         pw1 = NULL;
 103     }
 104     if ( pw2 && nItemCount>=100000 )
 105     {
 106         DBG_WARNING( pw2 );
 107         pw2 = NULL;
 108     }
 109     if ( pw3 && nItemCount>=1000000 )
 110     {
 111         DBG_WARNING( pw3 );
 112         pw3 = NULL;
 113     }
 114     if ( pw4 && nItemCount>=5000000 )
 115     {
 116         DBG_WARNING( pw4 );
 117         pw4 = NULL;
 118     }
 119     if ( pw5 && nItemCount>=10000000 )
 120     {
 121         DBG_WARNING( pw5 );
 122         pw5 = NULL;
 123     }
 124 #endif
 125 }
 126
 127 // ------------------------------------------------------------------------
 128 SfxPoolItem::~SfxPoolItem()
 129 {
 130     DBG_DTOR(SfxPoolItem, 0);
 131     DBG_ASSERT(m_nRefCount == 0 || m_nRefCount > SFX_ITEMS_MAXREF,
 132             "destroying item in use");
 133 #if OSL_DEBUG_LEVEL > 1
 134     --nItemCount;
 135 #endif
 136 }
 137
 138 // ------------------------------------------------------------------------
 139 int SfxPoolItem::Compare( const SfxPoolItem& ) const
 140 {
 141     return 0;
 142 }
 143
 144 // ------------------------------------------------------------------------
 145 int SfxPoolItem::Compare( const SfxPoolItem& rWith, const IntlWrapper& ) const
 146 {
 147     return Compare( rWith );
 148 }
 149
 150 // ------------------------------------------------------------------------
 151 int SfxPoolItem::operator==( const SfxPoolItem& rCmp ) const
 152 {
 153     DBG_CHKTHIS(SfxPoolItem, 0);
 154     return rCmp.Type() == Type();
 155 }
 156
 157 // -----------------------------------------------------------------------
 158 SfxPoolItem* SfxPoolItem::Create(SvStream &, sal_uInt16) const
 159 {
 160     DBG_CHKTHIS(SfxPoolItem, 0);
 161     return Clone(0);
 162 }
 163
 164 // -----------------------------------------------------------------------
 165 sal_uInt16 SfxPoolItem::GetVersion( sal_uInt16 ) const
 166 {
 167     DBG_CHKTHIS(SfxPoolItem, 0);
 168     return 0;
 169 }
 170
 171 // -----------------------------------------------------------------------
 172 SvStream& SfxPoolItem::Store(SvStream &rStream, sal_uInt16 ) const
 173 {
 174     DBG_CHKTHIS(SfxPoolItem, 0);
 175     return rStream;
 176 }
 177
 178 // static
 179 OUString SfxPoolItem::readByteString(SvStream& rStream)
 180 {
 181     return rStream.ReadUniOrByteString(rStream.GetStreamCharSet());
 182 }
 183
 184 // static
 185 void SfxPoolItem::writeByteString(SvStream & rStream, const OUString& rString)
 186 {
 187     rStream.WriteUniOrByteString(rString, rStream.GetStreamCharSet());
 188 }
 189
 190 // static
 191 OUString SfxPoolItem::readUnicodeString(SvStream & rStream, bool bUnicode)
 192 {
 193     return rStream.ReadUniOrByteString(bUnicode ? RTL_TEXTENCODING_UCS2 :
 194                                       rStream.GetStreamCharSet());
 195 }
 196
 197 // static
 198 void SfxPoolItem::writeUnicodeString(SvStream & rStream, const OUString& rString)
 199 {
 200     rStream.WriteUniOrByteString(rString, RTL_TEXTENCODING_UCS2);
 201 }
 202
 203 // ------------------------------------------------------------------------
 204 SfxItemPresentation SfxPoolItem::GetPresentation
 205 (
 206     SfxItemPresentation /*ePresentation*/,       // IN:  wie formatiert werden soll
 207     SfxMapUnit          /*eCoreMetric*/,         // IN:  Ma\seinheit des SfxPoolItems
 208     SfxMapUnit          /*ePresentationMetric*/, // IN:  Wunsch-Ma\einheit der Darstellung
 209     OUString&           /*rText*/,               // OUT: textuelle Darstellung
 210     const IntlWrapper *
 211 )   const
 212
 213 /*  [Beschreibung]
 214
 215     "Uber diese virtuelle Methode kann von den SfxPoolItem-Subklassen
 216     eine textuelle Datstellung des Wertes erhalten werden. Sie sollte
 217     von allen UI-relevanten SfxPoolItem-Subklassen "uberladen werden.
 218
 219     Da die Ma\seinheit des Wertes im SfxItemPool nur "uber
 220     <SfxItemPool::GetMetric(sal_uInt16)const> erfragbar ist, und nicht etwa
 221     in der SfxPoolItem-Instanz oder -Subklasse  verf"ugbar ist, wird die
 222     eigene Ma\seinheit als 'eCoreMetric' "ubergeben.
 223
 224     Die darzustellende Ma\seinheit wird als 'ePresentationMetric'
 225     "ubergeben.
 226
 227
 228     [R"uckgabewert]
 229
 230     SfxItemPresentation     SFX_ITEM_PRESENTATION_NONE
 231                             es konnte keine Text-Darstellung erzeugt werden
 232
 233                             SFX_ITEM_PRESENTATION_NAMELESS
 234                             es konnte eine Text-Darstellung (ggf. mit
 235                             Ma\seinheit) erzeugt werden, die jedoch keine
 236                             semantische Bedeutung enth"alt
 237
 238                             SFX_ITEM_PRESENTATION_COMPLETE
 239                             es konnte eine komplette Text-Darstellung mit
 240                             semantischer Bedeutung (und ggf. Ma\seinheit)
 241                             erzeugt werden
 242
 243
 244     [Beispiele]
 245
 246     pSvxFontItem->GetPresentation( SFX_PRESENTATION_NAMELESS, ... )
 247         "12pt" mit return SFX_ITEM_PRESENTATION_NAMELESS
 248
 249     pSvxColorItem->GetPresentation( SFX_PRESENTATION_COMPLETE, ... )
 250         "rot" mit return SFX_ITEM_PRESENTATION_NAMELESS
 251         (das das SvxColorItem nicht wei\s, was f"ur eine Farbe es darstellt,
 252         kann es keinen Namen angeben, was durch den Returnwert mitgeteilt wird.
 253
 254     pSvxBorderItem->GetPresentation( SFX_PRESENTATION_COMPLETE, ... )
 255         "1cm oberer Rand, 2cm linker Rand, 0,2cm unterer Rand, ..."
 256 */
 257
 258 {
 259     return SFX_ITEM_PRESENTATION_NONE;
 260 }
 261
 262 // SfxVoidItem ------------------------------------------------------------
 263 SfxVoidItem::SfxVoidItem( sal_uInt16 which ):
 264     SfxPoolItem(which)
 265 {
 266     DBG_CTOR(SfxVoidItem, 0);
 267 }
 268
 269 // SfxVoidItem ------------------------------------------------------------
 270 SfxVoidItem::SfxVoidItem( const SfxVoidItem& rCopy):
 271     SfxPoolItem(rCopy)
 272 {
 273     DBG_CTOR(SfxVoidItem, 0);
 274 }
 275
 276 // ------------------------------------------------------------------------
 277 int SfxVoidItem::operator==( const SfxPoolItem&
 278 #ifdef DBG_UTIL
 279 rCmp
 280 #endif
 281 ) const
 282 {
 283     DBG_CHKTHIS(SfxVoidItem, 0);
 284     DBG_ASSERT( SfxPoolItem::operator==( rCmp ), "unequal type" );
 285     return sal_True;
 286 }
 287
 288 // ------------------------------------------------------------------------
 289 SfxItemPresentation SfxVoidItem::GetPresentation
 290 (
 291     SfxItemPresentation     /*ePresentation*/,
 292     SfxMapUnit              /*eCoreMetric*/,
 293     SfxMapUnit              /*ePresentationMetric*/,
 294     OUString&               rText,
 295     const IntlWrapper *
 296 )   const
 297 {
 298     DBG_CHKTHIS(SfxVoidItem, 0);
 299     rText = "Void";
 300     return SFX_ITEM_PRESENTATION_NAMELESS;
 301 }
 302
 303 // ------------------------------------------------------------------------
 304 SfxPoolItem* SfxVoidItem::Clone(SfxItemPool *) const
 305 {
 306     DBG_CHKTHIS(SfxVoidItem, 0);
 307     return new SfxVoidItem(*this);
 308 }
 309
 310 // SfxInvalidItem ---------------------------------------------------------
 311
 312 // SfxItemHandle ----------------------------------------------------------
 313 SfxItemHandle::SfxItemHandle(SfxPoolItem &rItem):
 314     pRef(new sal_uInt16(1)),
 315     pItem(rItem.Clone(0))
 316 {
 317     DBG_CTOR(SfxItemHandle, 0);
 318 }
 319
 320 // ------------------------------------------------------------------------
 321 SfxItemHandle::SfxItemHandle(const SfxItemHandle &rCopy):
 322     pRef(rCopy.pRef),
 323     pItem(rCopy.pItem)
 324 {
 325     DBG_CTOR(SfxItemHandle, 0);
 326     ++(*pRef);
 327 }
 328
 329 // ------------------------------------------------------------------------
 330 const SfxItemHandle &SfxItemHandle::operator=(const SfxItemHandle &rCopy)
 331 {
 332     DBG_CHKTHIS(SfxItemHandle, 0);
 333     if(&rCopy == this || pItem == rCopy.pItem)
 334         return *this;
 335     --(*pRef);
 336     if(!(*pRef))
 337     {
 338         delete pItem;
 339         pItem = 0;
 340     }
 341     pRef = rCopy.pRef;
 342     ++(*pRef);
 343     pItem = rCopy.pItem;
 344     return *this;
 345 }
 346
 347 // ------------------------------------------------------------------------
 348 SfxItemHandle::~SfxItemHandle()
 349 {
 350     DBG_DTOR(SfxItemHandle, 0);
 351     --(*pRef);
 352     if(!(*pRef)) {
 353         delete pRef; pRef = 0;
 354         delete pItem; pItem = 0;
 355     }
 356 }
 357
 358 // ------------------------------------------------------------------------
 359 bool SfxPoolItem::ScaleMetrics( long /*lMult*/, long /*lDiv*/ )
 360 {
 361     return false;
 362 }
 363
 364 // ------------------------------------------------------------------------
 365 bool SfxPoolItem::HasMetrics() const
 366 {
 367     return false;
 368 }
 369
 370 // -----------------------------------------------------------------------
 371
 372 bool SfxPoolItem::QueryValue( com::sun::star::uno::Any&, sal_uInt8 ) const
 373 {
 374     OSL_FAIL("There is no implementation for QueryValue for this item!");
 375     return false;
 376 }
 377
 378 // -----------------------------------------------------------------------
 379
 380 bool SfxPoolItem::PutValue( const com::sun::star::uno::Any&, sal_uInt8 )
 381 {
 382     OSL_FAIL("There is no implementation for PutValue for this item!");
 383     return false;
 384 }
 385
 386 SfxVoidItem::~SfxVoidItem()
 387 {
 388     DBG_DTOR(SfxVoidItem, 0);
 389 }
 390
 391 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */