KDE Games/API cleanup: Difference between revisions

From KDE Community Wiki
Line 156: Line 156:
| colorproxy_p.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| colorproxy_p.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamerenderer  
| kgamerenderer  
|-
| digits/kgamesvgdigits.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/svgdigits
|-
|-
| highscore/kexthighscore.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| highscore/kexthighscore.<span style="color:green">cpp</span>/<span style="color:red">h</span>
Line 270: Line 267:
| kgame/kplayer.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame/kplayer.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
| kgame
|-
| 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
|-
|-
| kgamepopupitem.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamepopupitem.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/popupitem
| misc/popupitem
|-
| kgameprogress.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| misc/progress
|-
|-
| kgamerendereditem.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamerendereditem.<span style="color:green">cpp</span>/<span style="color:red">h</span>
Line 303: Line 291:
| kgamethemeselector.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgamethemeselector.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| theming
| theming
|-
| 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
|-
|-
| kstandardgameaction.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kstandardgameaction.<span style="color:green">cpp</span>/<span style="color:red">h</span>
Line 357: Line 303:
| tests/kgamepropertytest.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| tests/kgamepropertytest.<span style="color:green">cpp</span>/<span style="color:red">h</span>
| kgame
| kgame
|-
| 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/KCardCache
| includes/KCardCache
Line 459: Line 399:
| includes/KGame/KPlayer
| includes/KGame/KPlayer
| kgame
| kgame
|-
| includes/KGameLCD
| misc/lcd
|-
| includes/KGameMisc
| misc/randomname
|-
|-
| includes/KGamePopupItem
| includes/KGamePopupItem
| misc/popupitem
| misc/popupitem
|-
| includes/KGameProgress
| misc/progress
|-
|-
| includes/KGameRenderedItem
| includes/KGameRenderedItem
Line 483: Line 414:
| includes/KGameRendererClient
| includes/KGameRendererClient
| kgamerenderer
| kgamerenderer
|-
| includes/KGameSvgDigits
| misc/svgdigits
|-
|-
| includes/KGameSvgDocument
| includes/KGameSvgDocument
Line 495: Line 423:
| includes/KGameThemeSelector
| includes/KGameThemeSelector
| theming
| 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
| includes/KGGZRankingsDialog
Line 504: Line 521:
| includes/KGrid2D
| includes/KGrid2D
| misc/grid2d
| misc/grid2d
|-
| includes/KHighscore
| highscore
|-
| includes/KScoreDialog
| highscore
|-
| includes/KStandardGameAction
| misc/standardactions
|}
|}

Revision as of 18:13, 13 February 2012

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.

The fine print: The SO version for libkdegames v5 is actually 6.

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.

Component Short desc. Dependencies Move target
base Macros and API-less behavior. -
carddecks Carddeck theme loading and selection. -
highscore Highscore recording and GUI. -
kchat Chat widget. -
kgame General game framework. kchat ksirk
kgamecanvas Alternative to QGraphicsView. kgamerenderer (integration) libkgamecanvas_private
kgamerenderer Rendering of theme graphics. theming
misc/clock Game clock (second accuracy). -
misc/difficulty Track difficulty level. -
misc/popupitem Message popup for QGraphicsView. -
misc/standardactions Standard KActions for games. -
misc/svgdocument Transform SVG elements. - ksirk
theming Management of SVG themes. -

 

Color key Delete Make private Keep Undecided
Description Code and headers are removed from the source tree. Code is moved into the tree of the only application which uses it. Headers are not exported anymore. Code stays in libkdegames. API and implementation changes may still be necessary. To be discussed on kde-games-devel mailinglist.

Removed components

Component Short desc. Dependencies Move target
kggz Network-enabled multiplayer. -
misc/grid2d Coordinate calculations on 2D grids. -
misc/lcd Enhanced QLCDNumber. -
misc/progress A very old progress bar. -
misc/randomname Function to generate a random name. -
misc/svgdigits Digits rendered from SVG. -

List of files

Source file Belongs to component
cardcache.cpp/h/ph carddecks
carddeckinfo.cpp/h/ph carddecks
chooserastergraphicssystem.cpp base
colorproxy_p.cpp/h kgamerenderer
highscore/kexthighscore.cpp/h highscore
highscore/kexthighscore_gui.cpp/h highscore
highscore/kexthighscore_internal.cpp/h highscore
highscore/kexthighscore_item.cpp/h highscore
highscore/kexthighscore_tab.cpp/h highscore
highscore/khighscore.cpp/h highscore
highscore/kscoredialog.cpp/h highscore
kcarddialog.cpp/h carddecks
kchatbase.cpp/h kchat
kchatbaseitemdelegate.cpp/h kchat
kchatbasemodel.cpp/h kchat
kchat.cpp/h kchat
kchatdialog.cpp/h kchat
kgamecanvas.cpp/h kgamecanvas
kgameclock.cpp/h misc/clock
kgame/dialogs/kgameconnectdialog.cpp/h kgame
kgame/dialogs/kgamedebugdialog.cpp/h kgame
kgame/dialogs/kgamedialogconfig.cpp/h kgame
kgame/dialogs/kgamedialog.cpp/h kgame
kgame/dialogs/kgameerrordialog.cpp/h kgame
kgamedifficulty.cpp/h misc/difficulty
kgame/kgamechat.cpp/h kgame
kgame/kgame.cpp/h kgame
kgame/kgameerror.cpp/h kgame
kgame/kgameio.cpp/h kgame
kgame/kgamemessage.cpp/h kgame
kgame/kgamenetwork.cpp/h kgame
kgame/kgameprocess.cpp/h kgame
kgame/kgamepropertyarray.h kgame
kgame/kgameproperty.cpp/h kgame
kgame/kgamepropertyhandler.cpp/h kgame
kgame/kgamesequence.cpp/h kgame
kgame/kgameversion.h kgame
kgame/kmessageclient.cpp/h kgame
kgame/kmessageio.cpp/h kgame
kgame/kmessageserver.cpp/h/ph kgame
kgame/kplayer.cpp/h kgame
kgamepopupitem.cpp/h misc/popupitem
kgamerendereditem.cpp/h kgamerenderer
kgamerenderedobjectitem.cpp/h kgamerenderer
kgamerendererclient.cpp/h kgamerenderer
kgamerenderer.cpp/h/ph kgamerenderer
kgamesvgdocument.cpp/h/ph misc/svgdocument
kgametheme.cpp/h theming
kgamethemeselector.cpp/h theming
kstandardgameaction.cpp/h misc/standardactions
libkdegames_export.h base
tests/kgamepopupitemtest.cpp/h misc/popupitem
tests/kgamepropertytest.cpp/h kgame
includes/KCardCache carddecks
includes/KCardDeckInfo carddecks
includes/KCardDialog carddecks
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

Source file Belongs to component
digits/kgamesvgdigits.cpp/h misc/svgdigits
kgamelcd.cpp/h misc/lcd
kgamemisc.cpp/h misc/randomname
kgameprogress.cpp/h misc/progress
kggzgames/kggzgames_export.h kggz
kggzgames/kggzrankingsdialog.cpp/h kggz
kggzgames/kggzseatsdialog.cpp/h kggz
kggzmod/event.cpp/h kggz
kggzmod/kggzmod_export.h kggz
kggzmod/misc_private.h kggz
kggzmod/module.cpp/h/ph kggz
kggzmod/player.cpp/h/ph kggz
kggzmod/request.cpp/h kggz
kggzmod/statistics.cpp/h/ph kggz
kggznet/kggznet_export.h kggz
kggznet/kggzpacket.cpp/h kggz
kggznet/kggzraw.cpp/h kggz
kgrid2d.h misc/grid2d
tests/kgamesvgdigitstest.cpp/h misc/svgdigits
tests/kgamesvgdocumenttest.cpp/h 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
Retrieved from "https://community.kde.org/index.php?title=KDE_Games/API_cleanup&oldid=17974"