View source for KDE Games/API cleanup

libkdegames v5 is the new iteration of libkdegames which is intended to ship with KDE Development Platform 4.9. The aim for this new iteration of the library is to '''remove most of the API that is obsolete, unused or in a state of bad quality''', in order to improve maintainability and relevance of the remaining API. Also, QtWidgets-specific parts need to be separated to prepare for QML-based games.

<small>The fine print: The SO version for libkdegames v5 is actually 6.</small>

== List of components ==

libkdegames consists of multiple (possibly interdependent) components, as defined by this list. The "Dependencies" column records only dependencies to other libkdegames components. See the table below for which file belongs to which component.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
|- style="background: #ececec; white-space:nowrap;"
! Component
! Short desc.
! Dependencies
! Move target
|- style="background-color:#EEFFFF"
| style="background-color:#ABFFFF" | audio
| Simple sound playback.
| -
|
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | base
| Macros and API-less behavior.
| -
|
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | carddecks
| SVG card deck files used by KPat and LSkat.
| -
| 
|- style="background-color:#FFFFCD"
| style="background-color:#FFFFA0" | cardloading
| Carddeck theme loading and selection.
| -
| lskat
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | highscore
| Highscore recording and GUI.
| -
| 
|- style="background-color:#EEEEFF"
| style="background-color:#ABABFF" | kchat
| Chat widget.
| -
|
|- style="background-color:#FFFFCD"
| style="background-color:#FFFFA0" | kgame
| General game framework.
| kchat
| ksirk
|- style="background-color:#FFFFCD"
| style="background-color:#FFFFA0" | kgamecanvas
| Alternative to QGraphicsView.
| kgamerenderer (integration)
| libkgamecanvas_private
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | kgamerenderer
| Rendering of theme graphics.
| theming
| 
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | misc/clock
| Game clock (second accuracy). 
| -
| 
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | misc/difficulty
| Track difficulty level.
| -
| 
|- style="background-color:#EEEEFF"
| style="background-color:#ABABFF" | misc/popupitem
| Message popup for QGraphicsView.
| -
| 
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | misc/standardactions
| Standard KActions for games.
| -
| 
|- style="background-color:#FFFFCD"
| style="background-color:#FFFFA0" | misc/svgdocument
| Transform SVG elements.
| -
| ksirk
|- style="background-color:#EEFFEE"
| style="background-color:#ABFFAB" | theming
| Management of SVG themes.
| -
| 
|}

&nbsp;

{| border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
|- style="white-space:nowrap;"
! Color key
| style="background-color:#FFABAB" | Delete
| style="background-color:#FFFFA0" | Make private
| style="background-color:#ABFFAB" | Keep
| style="background-color:#ABFFFF" width="100" | New
| style="background-color:#ABABFF" | Undecided
|-
! Description
| style="background-color:#FFEEEE" | Code and headers are removed from the source tree.
| style="background-color:#FFFFCD" | Code is moved into the tree of the only application which uses it. Headers are not exported anymore.
| style="background-color:#EEFFEE" | Code stays in libkdegames. API and implementation changes may still be necessary. 
| style="background-color:#EEFFFF" | New code and API (e.g. coming from Project Tagaro).
| style="background-color:#EEEEFF" | To be discussed on kde-games-devel mailinglist. 
|}

=== Removed components ===

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
|- style="background: #ececec; white-space:nowrap;"
! Component
! Short desc.
! Dependencies
! Move target
|- style="background-color:#FFEEEE"
| style="background-color:#FFABAB" | kggz
| Network-enabled multiplayer.
| -
| 
|- style="background-color:#FFEEEE"
| style="background-color:#FFABAB" | misc/grid2d
| Coordinate calculations on 2D grids.
| -
| 
|- style="background-color:#FFEEEE"
| style="background-color:#FFABAB" | misc/lcd
| Enhanced QLCDNumber.
| -
| 
|- style="background-color:#FFEEEE"
| style="background-color:#FFABAB" | misc/progress
| A very old progress bar.
| -
| 
|- style="background-color:#FFEEEE"
| style="background-color:#FFABAB" | misc/randomname
| Function to generate a random name.
| -
| 
|- style="background-color:#FFEEEE"
| style="background-color:#FFABAB" | misc/svgdigits
| Digits rendered from SVG.
| -
| 
|}

== List of files ==


{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
|- style="background: #ececec; white-space:nowrap;"
! Source file
! Belongs to component
|-
| cardcache.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| cardloading
|-
| carddeckinfo.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| cardloading
|-
| chooserastergraphicssystem.<span style="color:green">cpp</span>
| base
|-
| colorproxy_p.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamerenderer 
|-
| highscore/kexthighscore.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore
|-
| highscore/kexthighscore_gui.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore
|-
| highscore/kexthighscore_internal.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore
|-
| highscore/kexthighscore_item.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore
|-
| highscore/kexthighscore_tab.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore
|-
| highscore/khighscore.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore
|-
| highscore/kscoredialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore
|-
| kcarddialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| cardloading
|-
| kchatbase.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kchat
|-
| kchatbaseitemdelegate.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kchat
|-
| kchatbasemodel.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kchat
|-
| kchat.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kchat
|-
| kchatdialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kchat
|-
| kgamecanvas.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamecanvas
|-
| kgameclock.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/clock
|-
| kgame/dialogs/kgameconnectdialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/dialogs/kgamedebugdialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/dialogs/kgamedialogconfig.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/dialogs/kgamedialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/dialogs/kgameerrordialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgamedifficulty.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/difficulty
|-
| kgame/kgamechat.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgame.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgameerror.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgameio.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgamemessage.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgamenetwork.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgameprocess.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgamepropertyarray.<span style="color:red">h</span>
| kgame
|-
| kgame/kgameproperty.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgamepropertyhandler.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgamesequence.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kgameversion.<span style="color:red">h</span>
| kgame
|-
| kgame/kmessageclient.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kmessageio.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgame/kmessageserver.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| kgame
|-
| kgame/kplayer.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| kgamepopupitem.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/popupitem
|-
| kgamerendereditem.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamerenderer
|-
| kgamerenderedobjectitem.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamerenderer
|-
| kgamerendererclient.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamerenderer
|-
| kgamerenderer.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| kgamerenderer
|-
| kgamesvgdocument.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| misc/svgdocument
|-
| kgametheme.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| theming
|-
| kgamethemeselector.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| theming
|-
| kstandardgameaction.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/standardactions
|-
| libkdegames_export.<span style="color:red">h</span>
| base
|-
| tests/kgamepopupitemtest.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/popupitem
|-
| tests/kgamepropertytest.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
|-
| includes/KCardCache
| cardloading
|-
| includes/KCardDeckInfo
| cardloading
|-
| includes/KCardDialog
| cardloading
|-
| includes/KChat
| kchat
|-
| includes/KChatBase
| kchat
|-
| includes/KChatBaseItemDelegate
| kchat
|-
| includes/KChatDialog
| kchat
|-
| includes/KExtHighscore
| highscore
|-
| includes/KGameCanvas
| kgamecanvas
|-
| includes/KGameClock
| misc/clock
|-
| includes/KGameDifficulty
| misc/difficulty
|-
| includes/KGame/KGame
| kgame
|-
| includes/KGame/KGameChat
| kgame
|-
| includes/KGame/KGameConnectDialog
| kgame
|-
| includes/KGame/KGameDebugDialog
| kgame
|-
| includes/KGame/KGameDialog
| kgame
|-
| includes/KGame/KGameDialogConfig
| kgame
|-
| includes/KGame/KGameError
| kgame
|-
| includes/KGame/KGameErrorDialog
| kgame
|-
| includes/KGame/KGameIO
| kgame
|-
| includes/KGame/KGameMessage
| kgame
|-
| includes/KGame/KGameNetwork
| kgame
|-
| includes/KGame/KGameProcess
| kgame
|-
| includes/KGame/KGameProperty
| kgame
|-
| includes/KGame/KGamePropertyArray
| kgame
|-
| includes/KGame/KGamePropertyHandler
| kgame
|-
| includes/KGame/KGameSequence
| kgame
|-
| includes/KGame/KGameVersion
| kgame
|-
| includes/KGame/KMessageClient
| kgame
|-
| includes/KGame/KMessageIO
| kgame
|-
| includes/KGame/KMessageServer
| kgame
|-
| includes/KGame/KPlayer
| kgame
|-
| includes/KGamePopupItem
| misc/popupitem
|-
| includes/KGameRenderedItem
| kgamerenderer
|-
| includes/KGameRenderedObjectItem
| kgamerenderer
|-
| includes/KGameRenderer
| kgamerenderer
|-
| includes/KGameRendererClient
| kgamerenderer
|-
| includes/KGameSvgDocument
| misc/svgdocument
|-
| includes/KGameTheme
| theming
|-
| includes/KGameThemeSelector
| theming
|-
| includes/KHighscore
| highscore
|-
| includes/KScoreDialog
| highscore
|-
| includes/KStandardGameAction
| misc/standardactions
|}

=== Removed files ===

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
|- style="background: #ececec; white-space:nowrap;"
! Source file
! Belongs to component
|-
| digits/kgamesvgdigits.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/svgdigits 
|-
| kgamelcd.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/lcd
|-
| kgamemisc.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/randomname
|-
| kgameprogress.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/progress
|-
| kggzgames/kggzgames_export.<span style="color:red">h</span>
| kggz
|-
| kggzgames/kggzrankingsdialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kggz
|-
| kggzgames/kggzseatsdialog.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kggz
|-
| kggzmod/event.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kggz
|-
| kggzmod/kggzmod_export.<span style="color:red">h</span>
| kggz
|-
| kggzmod/misc_private.<span style="color:red">h</span>
| kggz
|-
| kggzmod/module.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| kggz
|-
| kggzmod/player.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| kggz
|-
| kggzmod/request.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kggz
|-
| kggzmod/statistics.<span style="color:green">cpp</span>/<span style="color:red">h</span>/<span style="color:blue">ph</span>
| kggz
|-
| kggznet/kggznet_export.<span style="color:red">h</span>
| kggz
|-
| kggznet/kggzpacket.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kggz
|-
| kggznet/kggzraw.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kggz
|-
| kgrid2d.<span style="color:red">h</span>
| misc/grid2d
|-
| tests/kgamesvgdigitstest.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/svgdigits
|-
| tests/kgamesvgdocumenttest.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/svgdocument
|-
| includes/KGameLCD
| misc/lcd
|-
| includes/KGameMisc
| misc/randomname
|-
| includes/KGameProgress
| misc/progress
|-
| includes/KGameSvgDigits
| misc/svgdigits
|-
| includes/KGGZRankingsDialog
| kggz
|-
| includes/KGGZSeatsDialog
| kggz
|-
| includes/KGrid2D
| misc/grid2d
|}