Differential D24684

Use ECMGenerateExportHeader to manage deprecated API better
ClosedPublic
Actions

Authored by kossebau on Oct 16 2019, 7:06 AM.

Details

Reviewers

dfaure

Group Reviewers

Frameworks

Commits

R241:aa5b0d89b2ed: Use ECMGenerateExportHeader to manage deprecated API better

Summary

Allows

projects linking to KIO to hide deprecated API up to a given version or silence deprecation warnings after a given version, using
- -DKIOCORE_DISABLE_DEPRECATED_BEFORE_AND_AT
- -DKIOCORE_NO_DEPRECATED
- -DKIOCORE_DEPRECATED_WARNINGS_SINCE
- -DKIOCORE_NO_DEPRECATED_WARNINGS
- -DKIOFILEWIDGETS_DISABLE_DEPRECATED_BEFORE_AND_AT
- -DKIOFILEWIDGETS_NO_DEPRECATED
- -DKIOFILEWIDGETS_DEPRECATED_WARNINGS_SINCE
- -DKIOFILEWIDGETS_NO_DEPRECATED_WARNINGS
- -DKIOWIDGETS_DISABLE_DEPRECATED_BEFORE_AND_AT
- -DKIOWIDGETS_NO_DEPRECATED
- -DKIOWIDGETS_DEPRECATED_WARNINGS_SINCE
- -DKIOWIDGETS_NO_DEPRECATED_WARNINGS
  
  or (once enabled when all KF modules are done)
- -DKF_DISABLE_DEPRECATED_BEFORE_AND_AT
- -DKF_NO_DEPRECATED
- -DKF_DEPRECATED_WARNINGS_SINCE
- -DKF_NO_DEPRECATED_WARNINGS

No support for "EXCLUDE_DEPRECATED_BEFORE_AND_AT" yet, some
undeprecated API is implemented by deprecated API still, at least for
some deprecation versions. This needs separate work.

Diff Detail

Repository

R241 KIO

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

kossebau created this revision.Oct 16 2019, 7:06 AM

Restricted Application added a project: Frameworks. · View Herald TranscriptOct 16 2019, 7:06 AM

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

kossebau requested review of this revision.Oct 16 2019, 7:06 AM

Harbormaster completed remote builds in B17737: Diff 68018.Oct 16 2019, 7:06 AM

No support for EXCLUDE_DEPRECATED_BEFORE_AND_AT here as well, that needs another round of work. Thus the removal of all the KIOWIDGETS_NO_DEPRECATED from the source files, no *_BUILD_DEPRECATED_SINCE there to properly replace them for now.

So patch solely concentrating on visibility of deprecated API to consumers of KIO.

update to latest master

Harbormaster completed remote builds in B17740: Diff 68021.Oct 16 2019, 7:31 AM

The commit log talks about KCalendarCore instead of KIO :)

kossebau edited the summary of this revision. (Show Details)Oct 16 2019, 1:48 PM

kossebau mentioned this in T11490: Control for visibility of symbols of deprecated API and compiler warnings.Oct 16 2019, 3:55 PM

dfaure mentioned this in D24675: Deprecate the KTcpSocket-based variant of SslUi::askIgnoreSslErrors.Oct 16 2019, 9:29 PM

update to latest master and new deprecated API

Harbormaster completed remote builds in B17840: Diff 68210.Oct 18 2019, 5:24 AM

Ping... would be happy if this one could get reviewed ASAP, so we have the patches for all of KF modules in and can enable the group KF_* macros, so people can conveniently use -DKF_DISABLE_DEPRECATED_BEFORE_AND_AT=0Xxxxxxx in their projects :)

The commit log says KIOKIOFILEWIDGETS with KIO duplicated, that's a typo in the commit log, but only there, right?

dfaure added inline comments.Oct 18 2019, 1:42 PM

src/core/global.cpp
99	Isn't some ifdef still needed for this deprecated method?
src/core/global.h
105	LOL 3.4 was long ago ;) good find :)
src/core/kfileitem.cpp
1242	I'm confused, isn't this what *_BUILD_DEPRECATED_SINCE is for? [repeats]

kossebau edited the summary of this revision. (Show Details)Oct 18 2019, 2:00 PM

In D24684#549785, @dfaure wrote:

The commit log says KIOKIOFILEWIDGETS with KIO duplicated, that's a typo in the commit log, but only there, right?

Typo indeed, fixed.

src/core/global.cpp
99	I forgot to explicitly mention this in the commit message: no support for EXCLUDE_DEPRECATED_BEFORE_AND_AT for KIO here yet, as version-level-based disabling of API needs some work first, as some undeprecated API is implemented in terms of deprecated still, as I found when testing that support. The currently existing `#ifndef KIOCORE_NO_DEPRECATED` in the source files thus got only removed. Gzess that should get an explicit TODO comment, e.g. near the ecm_generate_export_header marcos?
src/core/kfileitem.cpp
1242	See other comment.

kossebau edited the summary of this revision. (Show Details)Oct 18 2019, 2:18 PM

kossebau added inline comments.Oct 18 2019, 2:26 PM

src/core/global.h
105	Thankfully phabricator and its locate-file, go-to-version-before-commit & tags listing for commit was helpful here to good degrees, so that usually tool < 1 min to find where the deprecation happened. So the temptation to just say "since 5.0" and spare the digging work was not big enough compared to effort needed to be able to have correct history notes :) https://phabricator.kde.org/source/kdelibs/repository/frameworks/ is currently still highranked by my firefox ;)

OK it's very likely that KIOCORE_NO_DEPRECATED didn't work anyway, as I found out in other frameworks where I tried enabling this kind of thing.

This revision is now accepted and ready to land.Oct 18 2019, 3:14 PM

Closed by commit R241:aa5b0d89b2ed: Use ECMGenerateExportHeader to manage deprecated API better (authored by kossebau). · Explain WhyOct 18 2019, 4:51 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			CMakeLists.txt (4 lines)
M			src/core/CMakeLists.txt (10 lines)
M			src/core/copyjob.h (4 lines)
M			src/core/global.h (76 lines)
M			src/core/global.cpp (4 lines)
M			src/core/job_base.h (16 lines)
M			src/core/jobuidelegateextension.h (9 lines)
M			src/core/kcoredirlister.h (4 lines)
M			src/core/kfileitem.h (30 lines)
M			src/core/kfileitem.cpp (6 lines)
M			src/core/krecentdocument.h (7 lines)
M			src/core/ksambashare.h (7 lines)
M			src/core/ksambashare.cpp (2 lines)
M			src/core/ksslcertificatemanager.h (36 lines)
M			src/core/ktcpsocket.h (6 lines)
M			src/core/scheduler.h (6 lines)
M			src/core/scheduler.cpp (6 lines)
M			src/core/slavebase.h (34 lines)
M			src/core/slavebase.cpp (4 lines)
M			src/core/slaveinterface.h (29 lines)
M			src/core/statjob.h (16 lines)
M			src/core/statjob.cpp (4 lines)
M			src/core/transferjob.h (10 lines)
M			src/core/transferjob.cpp (4 lines)
M			src/core/udsentry.h (15 lines)
M			src/core/udsentry.cpp (6 lines)
M			src/filewidgets/CMakeLists.txt (10 lines)
M			src/filewidgets/kfilepreviewgenerator.h (5 lines)
M			src/filewidgets/kfilewidget.h (5 lines)
M			src/filewidgets/kfilewidget.cpp (2 lines)
M			src/filewidgets/knewfilemenu.h (3 lines)
M			src/filewidgets/kurlnavigator.h (63 lines)
M			src/filewidgets/kurlnavigator.cpp (20 lines)
M			src/widgets/CMakeLists.txt (10 lines)
M			src/widgets/accessmanager.h (14 lines)
M			src/widgets/accessmanager.cpp (4 lines)
M			src/widgets/kdirmodel.h (7 lines)
M			src/widgets/kdirmodel.cpp (2 lines)
M			src/widgets/kpropertiesdialog.h (18 lines)
M			src/widgets/kpropertiesdialog.cpp (2 lines)
M			src/widgets/krun.h (75 lines)
M			src/widgets/krun.cpp (20 lines)
M			src/widgets/kurifilter.h (14 lines)
M			src/widgets/kurifilter.cpp (2 lines)
M			src/widgets/kurlrequester.h (29 lines)
M			src/widgets/kurlrequester.cpp (8 lines)
M			src/widgets/kurlrequesterdialog.h (5 lines)
M			src/widgets/kurlrequesterdialog.cpp (2 lines)
M			src/widgets/paste.h (15 lines)
M			src/widgets/paste.cpp (3 lines)
M			src/widgets/previewjob.h (32 lines)
M			src/widgets/previewjob.cpp (6 lines)
M			src/widgets/renamedialog.h (7 lines)
M			src/widgets/renamedialog.cpp (2 lines)
M			src/widgets/sslui.h (11 lines)
M			src/widgets/thumbcreator.h (7 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	68018	c2bd18f		Oct 16 2019, 7:06 AM	★	★
Diff 2	68021	0911763	update to latest master	Oct 16 2019, 7:31 AM	★	★
Diff 3	68210	b294302	update to latest master and new deprecated API	Oct 18 2019, 5:24 AM	★	★
Diff 4	68257	3c3b21d	R241:aa5b0d89b2ed8d871bfec5be16bc1d2a2c36cf0b	Oct 18 2019, 4:50 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
5bb3984f26fe	fd07a280445f	b2943029dda1	Friedrich W. H. Kossebau	Use ECMGenerateExportHeader to manage deprecated API better (Show More…)	Oct 16 2019, 7:06 AM

Use ECMGenerateExportHeader to manage deprecated API betterClosedPublicActions

Details

Diff Detail

Revision ContentsChangeset List

Diff 68257

CMakeLists.txt

src/core/CMakeLists.txt

src/core/copyjob.h

src/core/global.h

src/core/global.cpp

src/core/job_base.h

src/core/jobuidelegateextension.h

src/core/kcoredirlister.h

src/core/kfileitem.h

src/core/kfileitem.cpp

src/core/krecentdocument.h

src/core/ksambashare.h

src/core/ksambashare.cpp

src/core/ksslcertificatemanager.h

src/core/ktcpsocket.h

src/core/scheduler.h

src/core/scheduler.cpp

src/core/slavebase.h

src/core/slavebase.cpp

src/core/slaveinterface.h

src/core/statjob.h

src/core/statjob.cpp

src/core/transferjob.h

src/core/transferjob.cpp

src/core/udsentry.h

src/core/udsentry.cpp

src/filewidgets/CMakeLists.txt

src/filewidgets/kfilepreviewgenerator.h

src/filewidgets/kfilewidget.h

src/filewidgets/kfilewidget.cpp

src/filewidgets/knewfilemenu.h

src/filewidgets/kurlnavigator.h

src/filewidgets/kurlnavigator.cpp

src/widgets/CMakeLists.txt

src/widgets/accessmanager.h

src/widgets/accessmanager.cpp

src/widgets/kdirmodel.h

src/widgets/kdirmodel.cpp

src/widgets/kpropertiesdialog.h

src/widgets/kpropertiesdialog.cpp

src/widgets/krun.h

src/widgets/krun.cpp

src/widgets/kurifilter.h

src/widgets/kurifilter.cpp

src/widgets/kurlrequester.h

src/widgets/kurlrequester.cpp

src/widgets/kurlrequesterdialog.h

src/widgets/kurlrequesterdialog.cpp

src/widgets/paste.h

src/widgets/paste.cpp

src/widgets/previewjob.h

src/widgets/previewjob.cpp

src/widgets/renamedialog.h

src/widgets/renamedialog.cpp

src/widgets/sslui.h

src/widgets/thumbcreator.h

Use ECMGenerateExportHeader to manage deprecated API better
ClosedPublic
Actions

Revision Contents
Changeset List