office-gobmx/svl
Armin Le Grand (allotropia) c351f920c4 ITEM: preparations for more/easier changes
This change is not about speed improvements but diverse
preparations to make changes/reading/understanding easier.
It does not change speed AFAIK.

Added a global static debug-only counter to allow getting
an overview over number of all allocated SfxPoolItem's
and the still alloated ones at office shutdown. The values
are used in Application::~Application to make a short info
statement. It allows to be able to quickly detect if an
error in future changes may lead to memory losses - these
would show in dramaitically higher numbers then (hopefully)
immediately.

Moved SfxVoidItem to own source/header.

Added container library interface support to SfxItemSet,
adapted already some methods to use it - not all possible,
I will commit & get status from gerrit 1st if all still works
and then continue.

Changed INVALID_POOL_ITEM from -1 to use a global unique
incarnation of an isolated derivation from SfxPoolItem. It
allows to avoid the (-1) pointer hack. Since still just
pointers are compared it's not worse. NOTE: That way, more
'special' SfxPoolItem's may be used for more States - a
candidate is e.g. SfxVoidItem(0) which represents ::DISABLED
state -- unfortunately not only, it is also used (mainly for
UI stuff) with 'real' WhichIDs - hard to sort out, will have
to stay that way for now AFAIK.

Changed INVALID_POOL_ITEM stuff to use a static extern
incarnated item in combination with a inline method
to return it, called GetGlobalStaticInvalidItemInstance().

Isolated create/cleanup of a SfxPoolItem entry in
SfxItemSet to further modularize/simplify that. It is
currently from constructor & destructor but already shows
that PoolDefaults are handled differently - probably an
error. Still, for now, do no change in behaviour (yet).

Got regular 'killed by the Kill-Wrapper' messages from
gerrit, seems to have to do with UITest_sw_findReplace.
That python/c++ scripting stuff is hard to debug, but
finally I identified the problem has to do with
the INVALID_POOL_ITEM change. It was in
SfxItemSet::InvalidateAllItems() where still a (-1)
was used -> chaos in detecting invalid items.

Change-Id: I595e1f25ab660c35c4f2d19c233d1dfadfe25214
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/155675
Tested-by: Jenkins
Reviewed-by: Armin Le Grand <Armin.Le.Grand@me.com>
2023-08-18 10:37:44 +02:00
..
inc/pch
qa ITEM: preparations for more/easier changes 2023-08-18 10:37:44 +02:00
source ITEM: preparations for more/easier changes 2023-08-18 10:37:44 +02:00
unx/source/svdde
util
AllLangMoTarget_svl.mk
CppunitTest_svl_adrparse.mk
CppunitTest_svl_inetcontenttype.mk
CppunitTest_svl_itempool.mk
CppunitTest_svl_items.mk
CppunitTest_svl_lngmisc.mk
CppunitTest_svl_lockfiles.mk
CppunitTest_svl_notify.mk
CppunitTest_svl_qa_cppunit.mk
CppunitTest_svl_urihelper.mk
IwyuFilter_svl.yaml
JunitTest_svl_complex.mk
Library_fsstorage.mk
Library_passwordcontainer.mk
Library_svl.mk ITEM: preparations for more/easier changes 2023-08-18 10:37:44 +02:00
Makefile
Module_svl.mk
README.md

Non-Graphical Helper Code (svtools light)

Contains non-graphical helper code for office applications.

Specifically this module does not depend on or use includes from module vcl. Originally all code in svtools that did not depend on vcl was split off into this svl ("svtools light") module.

In particular the SfxItemSet is a property-bag like container that stores arbitrary sets of properties for everything from text run formats, to Chart regression line properties.

There are lots of other useful helpers in here for various office tasks; much of this code was originally moved from svx/sfx2.

Items, Pools and Sets

SfxPoolItem

A small reference counted piece of data. Many subclasses, each with a unique integer to identify its type (WhichId). Can be compared for equality (operator==), Clone()d, and converted to/from uno::Any (QueryValue/PutValue).

A pool item may have value semantics ("poolable"), meaning that there will generally be only one instance that compares equal per item pool, or not, in which case the item will be Clone()d quite a bit.

SfxItemPool

Usually there is one item pool per document, with a range of valid WhichIds that is specific to the type of document.

The item pool owns all instances of SfxPoolItem or its subclasses that have ever been added to an item set. It also contains a default item for every WhichId, which will be (depending on parameters) returned from item sets if the set does not contain an item at this WhichId.

SfxItemSet

The item set can be created with a user-supplied range of WhichIds; it will accept SfxPoolItems with matching WhichIds and ignore attempts to insert items with non-matching WhichIds.

Items that are successfully inserted into the set will be stored in the set's SfxItemPool, and for poolable items only a single instance that compares equal under the predicate operator== will be stored in the pool, regardless of how many sets contain it, thus conserving memory.

There are members m_pWhichRanges for the valid ranges (as pairs of WhichIds), m_nCount for the number of items contained, and m_pItems for the pointers to the actual items.