xref: /aoo4110/main/svl/source/items/poolitem.cxx (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_svl.hxx"

#include <svl/poolitem.hxx>
#include <tools/stream.hxx>

// STATIC DATA -----------------------------------------------------------

DBG_NAME(SfxPoolItem)
DBG_NAME(SfxVoidItem)
// @@@ DBG_NAME(SfxInvalidItem);
DBG_NAME(SfxItemHandle)

sal_uInt8 nSfxFlag8Val[8] =
{
	1, 2, 4, 8, 16, 32, 64, 128
};

sal_uInt16 nSfxFlag16Val[16] =
{
	1, 2, 4, 8, 16, 32, 64, 128, 256, 512,
	1024, 2048, 4096, 8192, 16384, 32768
};

sal_uLong nSfxFlag32Val[32] =
{
	0x1L, 0x2L, 0x4L, 0x8L,
	0x10L, 0x20L, 0x40L, 0x80L,
	0x100L, 0x200L, 0x400L, 0x800L,
	0x1000L, 0x2000L, 0x40000L, 0x8000L,
	0x10000L, 0x20000L, 0x40000L, 0x80000L,
	0x100000L, 0x200000L, 0x400000L, 0x800000L,
	0x1000000L, 0x2000000L, 0x4000000L, 0x8000000L,
	0x10000000L, 0x20000000L, 0x40000000L, 0x80000000L
};

// RTTI ------------------------------------------------------------------

TYPEINIT0(SfxPoolItem);
TYPEINIT1(SfxVoidItem, SfxPoolItem);
// @@@ TYPEINIT1(SfxInvalidItem, SfxPoolItem);
TYPEINIT1(SfxSetItem, SfxPoolItem);
// @@@ TYPEINIT1(SfxItemChangedHint, SfxHint);

// ------------------------------------------------------------------------
#if OSL_DEBUG_LEVEL > 1
static sal_uLong nItemCount = 0;

const char* pw1 = "Wow! 10.000 items!";
const char* pw2 = "Wow! 100.000 items!";
const char* pw3 = "Wow! 1.000.000 items!";
const char* pw4 = "Wow! 50.000.000 items!";
const char* pw5 = "Wow! 10.000.000 items!";
#endif

IMPL_PTRHINT(SfxPoolItemHint,SfxPoolItem)

// SfxPoolItem -----------------------------------------------------------
SfxPoolItem::SfxPoolItem( sal_uInt16 nW )
	: nRefCount( 0 ),
	  nWhich( nW )
	  , nKind( 0 )
{
	DBG_CTOR(SfxPoolItem, 0);
	DBG_ASSERT(nW <= SHRT_MAX, "Which Bereich ueberschritten");
#if OSL_DEBUG_LEVEL > 1
	++nItemCount;
	if ( pw1 && nItemCount>=10000 )
	{
		DBG_WARNING( pw1 );
		pw1 = NULL;
	}
	if ( pw2 && nItemCount>=100000 )
	{
		DBG_WARNING( pw2 );
		pw2 = NULL;
	}
	if ( pw3 && nItemCount>=1000000 )
	{
		DBG_WARNING( pw3 );
		pw3 = NULL;
	}
	if ( pw4 && nItemCount>=5000000 )
	{
		DBG_WARNING( pw4 );
		pw4 = NULL;
	}
	if ( pw5 && nItemCount>=10000000 )
	{
		DBG_WARNING( pw5 );
		pw5 = NULL;
	}
#endif
}

// -----------------------------------------------------------------------
SfxPoolItem::SfxPoolItem( const SfxPoolItem& rCpy )
	: nRefCount( 0 ),				// wird ja ein neues Object!
	  nWhich( rCpy.Which() )	// Funktion rufen wg. ChkThis()
	  , nKind( 0 )
{
	DBG_CTOR(SfxPoolItem, 0);
#if OSL_DEBUG_LEVEL > 1
	++nItemCount;
	if ( pw1 && nItemCount>=10000 )
	{
		DBG_WARNING( pw1 );
		pw1 = NULL;
	}
	if ( pw2 && nItemCount>=100000 )
	{
		DBG_WARNING( pw2 );
		pw2 = NULL;
	}
	if ( pw3 && nItemCount>=1000000 )
	{
		DBG_WARNING( pw3 );
		pw3 = NULL;
	}
	if ( pw4 && nItemCount>=5000000 )
	{
		DBG_WARNING( pw4 );
		pw4 = NULL;
	}
	if ( pw5 && nItemCount>=10000000 )
	{
		DBG_WARNING( pw5 );
		pw5 = NULL;
	}
#endif
}

// ------------------------------------------------------------------------
SfxPoolItem::~SfxPoolItem()
{
	DBG_DTOR(SfxPoolItem, 0);
	DBG_ASSERT(nRefCount == 0 || nRefCount > SFX_ITEMS_MAXREF, "destroying item in use" );
#if OSL_DEBUG_LEVEL > 1
	--nItemCount;
#endif
}

// ------------------------------------------------------------------------
int SfxPoolItem::Compare( const SfxPoolItem& ) const
{
	return 0;
}

// ------------------------------------------------------------------------
int SfxPoolItem::Compare( const SfxPoolItem& rWith, const IntlWrapper& ) const
{
	return Compare( rWith );
}

// ------------------------------------------------------------------------
int SfxPoolItem::operator==( const SfxPoolItem& rCmp ) const
{
	DBG_CHKTHIS(SfxPoolItem, 0);
	return rCmp.Type() == Type();
}

// -----------------------------------------------------------------------
#ifndef TF_POOLABLE

int SfxPoolItem::IsPoolable() const
{
	DBG_CHKTHIS(SfxPoolItem, 0);
	return sal_True;
}
#endif

// -----------------------------------------------------------------------
SfxPoolItem* SfxPoolItem::Create(SvStream &, sal_uInt16) const
{
	DBG_CHKTHIS(SfxPoolItem, 0);
	return Clone(0);
}

// -----------------------------------------------------------------------
sal_uInt16 SfxPoolItem::GetVersion( sal_uInt16 ) const
{
	DBG_CHKTHIS(SfxPoolItem, 0);
	return 0;
}

// -----------------------------------------------------------------------
SvStream& SfxPoolItem::Store(SvStream &rStream, sal_uInt16 ) const
{
	DBG_CHKTHIS(SfxPoolItem, 0);
	return rStream;
}

//============================================================================
// static
bool SfxPoolItem::readByteString(SvStream & rStream, UniString & rString)
{
	rStream.ReadByteString(rString);
	return rStream.GetError() == ERRCODE_NONE;
}

//============================================================================
// static
void SfxPoolItem::writeByteString(SvStream & rStream,
								  UniString const & rString)
{
	rStream.WriteByteString(rString);
}

//============================================================================
// static
bool SfxPoolItem::readUnicodeString(SvStream & rStream, UniString & rString,
									bool bUnicode)
{
	rStream.ReadByteString(rString,
						   bUnicode ? RTL_TEXTENCODING_UCS2 :
						              rStream.GetStreamCharSet());
	return rStream.GetError() == ERRCODE_NONE;
}

//============================================================================
// static
void SfxPoolItem::writeUnicodeString(SvStream & rStream,
									 UniString const & rString)
{
	rStream.WriteByteString(rString, RTL_TEXTENCODING_UCS2);
}

// ------------------------------------------------------------------------
SfxItemPresentation SfxPoolItem::GetPresentation
(
	SfxItemPresentation	/*ePresentation*/,       // IN:  wie formatiert werden soll
	SfxMapUnit			/*eCoreMetric*/,		 // IN:  Ma\seinheit des SfxPoolItems
	SfxMapUnit			/*ePresentationMetric*/, // IN:  Wunsch-Ma\einheit der Darstellung
	XubString&			/*rText*/,				 // OUT: textuelle Darstellung
    const IntlWrapper *
) 	const

/*	[Beschreibung]

	"Uber diese virtuelle Methode kann von den SfxPoolItem-Subklassen
	eine textuelle Datstellung des Wertes erhalten werden. Sie sollte
	von allen UI-relevanten SfxPoolItem-Subklassen "uberladen werden.

	Da die Ma\seinheit des Wertes im SfxItemPool nur "uber
	<SfxItemPool::GetMetric(sal_uInt16)const> erfragbar ist, und nicht etwa
	in der SfxPoolItem-Instanz oder -Subklasse  verf"ugbar ist, wird die
	eigene Ma\seinheit als 'eCoreMetric' "ubergeben.

	Die darzustellende Ma\seinheit wird als 'ePresentationMetric'
	"ubergeben.


	[R"uckgabewert]

	SfxItemPresentation		SFX_ITEM_PRESENTATION_NONE
							es konnte keine Text-Darstellung erzeugt werden

							SFX_ITEM_PRESENTATION_NAMELESS
							es konnte eine Text-Darstellung (ggf. mit
							Ma\seinheit) erzeugt werden, die jedoch keine
							semantische Bedeutung enth"alt

							SFX_ITEM_PRESENTATION_COMPLETE
							es konnte eine komplette Text-Darstellung mit
							semantischer Bedeutung (und ggf. Ma\seinheit)
							erzeugt werden


	[Beispiele]

	pSvxFontItem->GetPresentation( SFX_PRESENTATION_NAMELESS, ... )
		"12pt" mit return SFX_ITEM_PRESENTATION_NAMELESS

	pSvxColorItem->GetPresentation( SFX_PRESENTATION_COMPLETE, ... )
		"rot" mit return SFX_ITEM_PRESENTATION_NAMELESS
		(das das SvxColorItem nicht wei\s, was f"ur eine Farbe es darstellt,
		kann es keinen Namen angeben, was durch den Returnwert mitgeteilt wird.

	pSvxBorderItem->GetPresentation( SFX_PRESENTATION_COMPLETE, ... )
		"1cm oberer Rand, 2cm linker Rand, 0,2cm unterer Rand, ..."
*/

{
	return SFX_ITEM_PRESENTATION_NONE;
}

// SfxVoidItem ------------------------------------------------------------
SfxVoidItem::SfxVoidItem( sal_uInt16 which ):
	SfxPoolItem(which)
{
	DBG_CTOR(SfxVoidItem, 0);
}

// SfxVoidItem ------------------------------------------------------------
SfxVoidItem::SfxVoidItem( const SfxVoidItem& rCopy):
	SfxPoolItem(rCopy)
{
	DBG_CTOR(SfxVoidItem, 0);
}

// ------------------------------------------------------------------------
int SfxVoidItem::operator==( const SfxPoolItem&
#ifdef DBG_UTIL
rCmp
#endif
) const
{
	DBG_CHKTHIS(SfxVoidItem, 0);
	DBG_ASSERT( SfxPoolItem::operator==( rCmp ), "unequal type" );
	return sal_True;
}

// ------------------------------------------------------------------------
SfxItemPresentation SfxVoidItem::GetPresentation
(
	SfxItemPresentation 	/*ePresentation*/,
	SfxMapUnit				/*eCoreMetric*/,
	SfxMapUnit				/*ePresentationMetric*/,
	XubString& 				rText,
    const IntlWrapper *
)	const
{
	DBG_CHKTHIS(SfxVoidItem, 0);
	rText.AssignAscii(RTL_CONSTASCII_STRINGPARAM("Void"));
	return SFX_ITEM_PRESENTATION_NAMELESS;
}

// ------------------------------------------------------------------------
SfxPoolItem* SfxVoidItem::Clone(SfxItemPool *) const
{
	DBG_CHKTHIS(SfxVoidItem, 0);
	return new SfxVoidItem(*this);
}

// SfxInvalidItem ---------------------------------------------------------
#if 0  /* @@@ NOT USED @@@ */
SfxInvalidItem::SfxInvalidItem( sal_uInt16 nWhich, const SfxPoolItem &rDefault ):
	SfxPoolItem(nWhich),
	pDefaultItem(&rDefault)
{
	DBG_CTOR(SfxInvalidItem, 0);
}

// ------------------------------------------------------------------------
SfxInvalidItem::SfxInvalidItem( const SfxInvalidItem& rCopy):
	SfxPoolItem(rCopy),
	pDefaultItem(rCopy.pDefaultItem)
{
	DBG_CTOR(SfxInvalidItem, 0);
	//! pDefaultItem->ReleaseRef?
}

// ------------------------------------------------------------------------
SfxInvalidItem::~SfxInvalidItem()
{
	DBG_DTOR(SfxInvalidItem, 0);
}

// ------------------------------------------------------------------------
int SfxInvalidItem::operator==( const SfxPoolItem& rCmp) const
{
	DBG_CHKTHIS(SfxInvalidItem, 0);
	DBG_ASSERT( SfxPoolItem::operator==(rCmp), "unequal type" );
	return *pDefaultItem == *((SfxInvalidItem&)rCmp).pDefaultItem;
}

// ------------------------------------------------------------------------
SfxItemPresentation SfxInvalidItem::GetPresentation
(
	SfxItemPresentation 	ePresentation,
	SfxMapUnit				eCoreMetric,
	SfxMapUnit				ePresentationMetric,
	XubString& 				rText,
    const IntlWrapper *
)	const
{
	DBG_CHKTHIS(SfxInvalidItem, 0);
	rText.AssignAscii(RTL_CONSTASCII_STRINGPARAM("Invalid"));
	return SFX_ITEM_PRESENTATION_NAMELESS;
}

// ------------------------------------------------------------------------
SfxPoolItem* SfxInvalidItem::Clone(SfxItemPool *) const
{
	DBG_CHKTHIS(SfxInvalidItem, 0);
	return new SfxInvalidItem(*this);
}

// ------------------------------------------------------------------------
SfxPoolItem* SfxInvalidItem::Create(SvStream &, sal_uInt16 nVersion) const
{
	DBG_CHKTHIS(SfxInvalidItem, 0);
	DBG_ERROR("SfxInvalidItem::Create() ist sinnlos");
	return Clone();
}

// ------------------------------------------------------------------------
SvStream& SfxInvalidItem::Store(SvStream &rStream, sal_uInt16 nItemVersion ) const
{
	DBG_CHKTHIS(SfxInvalidItem, 0);
	DBG_ERROR("SfxInvalidItem::Store() ist sinnlos");
	return rStream;
}
#endif /* @@@ NOT USED @@@ */

// SfxItemHandle ----------------------------------------------------------
SfxItemHandle::SfxItemHandle(SfxPoolItem &rItem):
	pRef(new sal_uInt16(1)),
	pItem(rItem.Clone(0))
{
	DBG_CTOR(SfxItemHandle, 0);
}

// ------------------------------------------------------------------------
SfxItemHandle::SfxItemHandle(const SfxItemHandle &rCopy):
	pRef(rCopy.pRef),
	pItem(rCopy.pItem)
{
	DBG_CTOR(SfxItemHandle, 0);
	++(*pRef);
}

// ------------------------------------------------------------------------
const SfxItemHandle &SfxItemHandle::operator=(const SfxItemHandle &rCopy)
{
	DBG_CHKTHIS(SfxItemHandle, 0);
	if(&rCopy == this || pItem == rCopy.pItem)
		return *this;
	--(*pRef);
	if(!(*pRef))
	{
		delete pItem;
		pItem = 0;
	}
	pRef = rCopy.pRef;
	++(*pRef);
	pItem = rCopy.pItem;
	return *this;
}

// ------------------------------------------------------------------------
SfxItemHandle::~SfxItemHandle()
{
	DBG_DTOR(SfxItemHandle, 0);
	--(*pRef);
	if(!(*pRef)) {
		delete pRef; pRef = 0;
		delete pItem; pItem = 0;
	}
}

// ------------------------------------------------------------------------
int SfxPoolItem::ScaleMetrics( long /*lMult*/, long /*lDiv*/ )
{
	return 0;
}

// ------------------------------------------------------------------------
int SfxPoolItem::HasMetrics() const
{
	return 0;
}

// -----------------------------------------------------------------------
#if 0  /* @@@ NOT USED @@@ */
void SfxPoolItem::GetVersion() const
{
	DBG_ERROR( "dummy called" );
}

// -----------------------------------------------------------------------
void SfxPoolItem::Store(SvStream &rStream) const
{
	DBG_ERROR( "dummy called" );
}
#endif /* @@@ NOT USED @@@ */

// -----------------------------------------------------------------------

sal_Bool SfxPoolItem::QueryValue( com::sun::star::uno::Any&, sal_uInt8 ) const
{
	DBG_ERROR("There is no implementation for QueryValue for this item!");
	return sal_False;
}

// -----------------------------------------------------------------------

sal_Bool SfxPoolItem::PutValue( const com::sun::star::uno::Any&, sal_uInt8 )
{
	DBG_ERROR("There is no implementation for PutValue for this item!");
	return sal_False;
}

SfxVoidItem::~SfxVoidItem()
{
	DBG_DTOR(SfxVoidItem, 0);
}