Use ECMGenerateExportHeader to manage deprecated API better
ClosedPublic
Actions

Authored by kossebau on Oct 7 2019, 1:25 PM.

Details

Reviewers

dfaure
zzag

Group Reviewers

Frameworks
KWin

Commits

R278:7dc38306b5b6: Use ECMGenerateExportHeader to manage deprecated API better

Summary

Allows

projects linking to KWindowSystem to hide deprecated API up to a given version or silence deprecation warnings after a given version, using
- -DKWINDOWSYSTEM_DISABLE_DEPRECATED_BEFORE_AND_AT
- -DKWINDOWSYSTEM_NO_DEPRECATED
- -DKWINDOWSYSTEM_DEPRECATED_WARNINGS_SINCE
- -DKWINDOWSYSTEM_NO_DEPRECATED_WARNINGS
  
  or
- -DKF_DISABLE_DEPRECATED_BEFORE_AND_AT
- -DKF_NO_DEPRECATED
- -DKF_DEPRECATED_WARNINGS_SINCE
- -DKF_NO_DEPRECATED_WARNINGS
to build KWindowSystem optionally with deprecated API excluded from the build, using "EXCLUDE_DEPRECATED_BEFORE_AND_AT" cmake argument.

Setting KWINDOWSYSTEM_NO_WIDGETS ensures EXCLUDE_DEPRECATED_BEFORE_AND_AT
is at least at the version where QWidgets API was deprecated.

Test Plan

Builds with EXCLUDE_DEPRECATED_BEFORE_AND_AT set to 0, 5.0.0, 5.18.0,
5.38.0, 5.62.0, CURRENT as well as KWINDOWSYSTEM_NO_WIDGETS ON/OFF

Diff Detail

Repository

R278 KWindowSystem

Branch

useECMGenerateExportHeader

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 17570
Build 17588: arc lint + arc unit

kossebau created this revision.Oct 7 2019, 1:25 PM

Restricted Application added a project: Frameworks. · View Herald TranscriptOct 7 2019, 1:25 PM

Restricted Application added a subscriber: kde-frameworks-devel. · View Herald Transcript

kossebau requested review of this revision.Oct 7 2019, 1:25 PM

Harbormaster completed remote builds in B17394: Diff 67428.Oct 7 2019, 1:25 PM

kossebau mentioned this in T11490: Control for visibility of symbols of deprecated API and compiler warnings.Oct 7 2019, 1:30 PM

If no-one objects, would be pushing on Monday evening, Oct. 14th.

zzag added inline comments.Oct 10 2019, 9:35 PM

src/netwm_def.h
338–341	This one should be wrapped in `#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 0)`, right?

kossebau added inline comments.Oct 10 2019, 9:48 PM

src/netwm_def.h
338–341	Hmm... I should have checked the patch after uploading. IIRC I initially had this guarded here, same with the OverrideMask, but then found that too much code seems to rely on this, so I reverted things and added a TODO: Seemingly not the state here, and sadly nothing found in my stash. Sorry, I will have to recheck this.

fix incompleteness of patch WRT to NET::Override

While that flag is deprecated for clients, window managing code seems to
still need to handle that flag if set by old clients, so tagging it as
deprecated might result in premature removal of the support.
That needs a separate plan how to make sure it#s no longer used out in the
wild by clients. lxr.kde.org reports it still with some application code

Harbormaster completed remote builds in B17570: Diff 67718.Oct 11 2019, 4:05 PM

+1 from me

dfaure mentioned this in D24466: Use ECMGenerateExportHeader to manage deprecated API better.Oct 12 2019, 7:44 PM

zzag accepted this revision.Oct 14 2019, 8:59 AM

This revision is now accepted and ready to land.Oct 14 2019, 8:59 AM

Closed by commit R278:7dc38306b5b6: Use ECMGenerateExportHeader to manage deprecated API better (authored by kossebau). · Explain WhyOct 14 2019, 6:28 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			CMakeLists.txt (10 lines)
M			autotests/kstartupinfo_unittest.cpp (2 lines)
M			autotests/kwindowsystemx11test.cpp (4 lines)
M			autotests/kxmessages_unittest.cpp (8 lines)
M			autotests/netwininfotestclient.cpp (4 lines)
M			src/CMakeLists.txt (10 lines)
M			src/kstartupinfo.h (37 lines)
M			src/kstartupinfo.cpp (14 lines)
M			src/kwindoweffects.h (5 lines)
M			src/kwindoweffects.cpp (4 lines)
M			src/kwindowsystem.h (36 lines)
M			src/kwindowsystem.cpp (14 lines)
M			src/kwindowsystem_dummy_p.h (2 lines)
M			src/kwindowsystem_p.h (2 lines)
M			src/netwm_def.h (4 lines)
M			src/platforms/osx/kwindowsystem.cpp (2 lines)
M			src/platforms/wayland/kwindowsystem.cpp (2 lines)
M			src/platforms/wayland/kwindowsystem_p_wayland.h (2 lines)
M			src/platforms/windows/kwindowsystem.cpp (2 lines)
M			src/platforms/xcb/kkeyserver.cpp (2 lines)
M			src/platforms/xcb/kkeyserver_x11.h (5 lines)
M			src/platforms/xcb/kwindowsystem.cpp (8 lines)
M			src/platforms/xcb/kwindowsystem_p_x11.h (2 lines)
M			src/platforms/xcb/kxmessages.h (6 lines)
M			src/platforms/xcb/kxmessages.cpp (6 lines)
M			src/platforms/xcb/netwm.h (17 lines)
M			src/platforms/xcb/netwm.cpp (6 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	67428	c7c1d8e		Oct 7 2019, 1:25 PM	★	★
Diff 2	67718	c7c1d8e	fix incompleteness of patch WRT to NET::Override	Oct 11 2019, 4:05 PM	★	★
Diff 3	67921	0e3299d	R278:7dc38306b5b6a2e917d6ddde43d78b6d72e76e4a	Oct 14 2019, 6:28 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
ca5baf1636cf	beca3ef779ef	c7c1d8ee3c98	Friedrich W. H. Kossebau	Use ECMGenerateExportHeader to manage deprecated API better (Show More…)	Oct 7 2019, 12:52 PM

Use ECMGenerateExportHeader to manage deprecated API betterClosedPublicActions

Details

Diff Detail

Revision ContentsChangeset List

Diff 67718

CMakeLists.txt

autotests/kstartupinfo_unittest.cpp

autotests/kwindowsystemx11test.cpp

autotests/kxmessages_unittest.cpp

autotests/netwininfotestclient.cpp

src/CMakeLists.txt

src/kstartupinfo.h

src/kstartupinfo.cpp

src/kwindoweffects.h

src/kwindoweffects.cpp

src/kwindowsystem.h

src/kwindowsystem.cpp

src/kwindowsystem_dummy_p.h

src/kwindowsystem_p.h

src/netwm_def.h

src/platforms/osx/kwindowsystem.cpp

src/platforms/wayland/kwindowsystem.cpp

src/platforms/wayland/kwindowsystem_p_wayland.h

src/platforms/windows/kwindowsystem.cpp

src/platforms/xcb/kkeyserver.cpp

src/platforms/xcb/kkeyserver_x11.h

src/platforms/xcb/kwindowsystem.cpp

src/platforms/xcb/kwindowsystem_p_x11.h

src/platforms/xcb/kxmessages.h

src/platforms/xcb/kxmessages.cpp

src/platforms/xcb/netwm.h

src/platforms/xcb/netwm.cpp

Use ECMGenerateExportHeader to manage deprecated API better
ClosedPublic
Actions

Revision Contents
Changeset List