office-gobmx/svl
Armin Le Grand (allotropia) 5dd814f13d ITEM: Remove Direct(Put|Remove)Item(In|From)Pool
After some experiments I now can remove
DirectPutItemInPool and DirectRemoveItemFromPool.
With the changes done before it is now possible to
get rid of this 'compromize'. Now there are no
more Items held at the 'Pool' which now can be
developed in the direction of ssth like
'SfxItemSupport' - what it really is.

Some of the last usages of DirectPutItemInPool were
in SvxAreaTabDialog::SavePalettes(), so I tried to
trigger those cases with using LO and calling that
Dialog in all situations I could possibly think
about, but it was never used.

Then I added asserts and run a UnitTests in the apps,
also no luck. Thus I would guess these are not used.
These put changed stuff from the Dialog 'directly' to
the Pool (what is not really supported and is a hint
for a 'compromize' that some functionality did not
find/want to use the right spot in the model to save
and hold that data). Thus it *would* be accessible
using the SurrogateMechanism at the Pool (which is
also a 'compromize', see some of my other commits),
but I also found no hints at places where that is
done.

Thus I decided to create this change and let's see
if that asserts ever get triggered in the builds
or tests.

Indeed did not trigger. I checked what other places
do which use SfxObjectShell::Current() when they get
no DocShell: Most avoid doing something, but none
puts stuff to the Pool, so I go one step further
and do what other places do: warn and return. Also
simplified SvxAreaTabDialog::SavePalettes() as then
feasible.

Change-Id: I1c351eac4ada26288a56a69d57008a09f2d19121
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/162340
Tested-by: Jenkins
Reviewed-by: Armin Le Grand <Armin.Le.Grand@me.com>
2024-01-21 20:34:08 +01:00
..
inc/pch
qa ITEM: Move Shareable ItemFlag to SfxPolItem 2024-01-14 21:02:46 +01:00
source ITEM: Remove Direct(Put|Remove)Item(In|From)Pool 2024-01-21 20:34:08 +01:00
unx/source/svdde
util
AllLangMoTarget_svl.mk
CppunitTest_svl_adrparse.mk
CppunitTest_svl_inetcontenttype.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
Makefile
Module_svl.mk ITEM: No longer register Items at Pool 2024-01-12 12:15:54 +01:00
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.