Fix no newlines warnings. Patch by Peter Oberndorfer

[kdevelopdvcssupport.git] / Architecture.dox

/** \file  Architecture.dox
  * \brief KDevelop architecture
  */

/** \page architecture KDevelop 4 Architecture

\section source_overview Platform Source Overview

\subsection what_is_platform Platform VS Others

The idea is that kdevplatform contains:
- everything to create platform plugins
- everything to create platform applications
- commonly used/important plugins
.

\subsection platform_code Platform Code Layout

Platform consists of
- interfaces
  -  interfaces that expose everything necessary for plugins
  .
- shell
  -  implements interfaces and basically provides a ready-to-use and extend application.
  .
- sublime
  -  the user interface library
  .
- project and language
  -  additional libraries for project managers and language supports (usable for other plugins as well)
  .
- plugins
  -  common plugins, ie those that could be useful for other applications than just KDevelop
  .
- outputview
  -  allows plugins to easily implement toolviews that show line-by-line output. for example make build output.
  .
- vcs
  -  central & distributed version control library
  .
- veritas
  -  generic unit test runner library
.

\subsection platform_for_plugins What to Use in Plugins

- plugins need to link to interfaces
- plugins shall never link to shell
- plugins need not to link to sublime library
- plugins can optionally link to other helper libraries in platform when necessary
.

\subsection platform_coding_conventions Current Platform Coding Conventions

- preferred coding style is http://www.kdevelop.org/mediawiki/index.php/Coding_Guidelines
- all platform classes shall be in KDevelop namespace
- all files have to be named without kdev* prefix
- all files have to be installed in subdirectories under ${INCLUDE_INSTALL_DIR}/kdevplatform/
- all interfaces are named KDevelop::IFoo and their files ifoo.h/cpp
- all interface implementations are named KDevelop::Foo and their files foo.h/cpp
.


\section code_overview Platform Code Overview

\subsection core ICore/Core

Core is the central class, it provides access to all shell functionality.
There's a KDevelop::ICore interface and KDevelop::Core implementation. KDevelop::ICore interface gives
access to all controllers exposed via interfaces. Each plugin is initialized with ICore pointer so it
always has access to core via \ref KDevelop::IPlugin::core method. There's no need for something like KDevelop3's
KDevAPI class anymore.

Core is a singleton that needs to be manually initialized by platform application using
\ref KDevelop::Core::initialize right after the KApplication object is created and ShellExtension is initialized.
KDevelop::ShellExtension is the same thing as in KDevelop3 - the way to platform application to tell
which UI configuration files are used and what is the default profile. KDevelop4 shell extension's
only difference is defaultArea() method which shall return the name of default UI area
(see below for more information about areas).

\subsection plugin IPlugin

All concrete plugins must inherit from KDevelop::IPlugin.
Extension Interfaces can be used to handle groups of similar plugins in a generic fashion, see below.
Each plugin must have an associated .desktop file, as described in KPluginInfo class documentation.

\subsection extensions Extension Interfaces and Plugins

The idea behind extension interfaces is to provide following features:
- To allow plugins to expose their functionality via abstract interfaces
  and at the same time do not care about BC and do not force other plugins to link with them.\n
  Documentation plugin would be a good example of non-core but still sometimes useful functionality
  that might be exported via IDocumentation extension interface with methods like
  lookupInDocumentation(const QString &) and others.
  KDevelop4's outputview plugin with IOutputView interface is also a good and actually working
  example of such use-case.

- To have implementations of important functionality not in a shell, but in plugins.\n
  Good examples are buildsystem managers, builders and language supports in KDevelop4.
  When a project is opened, a buildsystem manager plugin (that implements either
  IBuildSystemManager interface or IProjectFileManager) is looked for by the shell an loaded.

- To forget about BC issues of dependent plugins. In case the plugin has something new to expose,
  the new version of extension interface has to be defined. All other plugins will either
  continue using old interface or ask for the new one.
.

The extension interfaces framework is implemented with QExtensionManager and Co. See the Qt
documentation for reference.

KDevelop::IBuildSystemManager is an example of an extension interface.
Plugins that implement this provide build and/or compile functionality.
An other example is KDevelop::ILanguageSupport which abstracts away language specific details from shell.


\subsubsection declare_extension To declare extension interface:
- Create an abstract class
- Include <iextension.h>
- Add following macros to the header file with a class (if you use namespace):
    \code
    KDEV_DECLARE_EXTENSION_INTERFACE_NS( KDevelop, IMyInterface, "org.kdevelop.IMyInterface")
    Q_DECLARE_INTERFACE( KDevelop::IMyInterface, "org.kdevelop.IMyInterface" )
    \endcode
- Or use (when the interface is not in namespace)
    \code
    KDEV_DECLARE_EXTENSION_INTERFACE( IMyInterface, "org.kdevelop.IMyInterface" )
    Q_DECLARE_INTERFACE( IMyInterface, "org.kdevelop.IMyInterface" )
    \endcode
.

\subsubsection implement_extension To implement extension interface:
- Create a plugin as usual
- Subclass it from your interface
- Use Q_INTERFACES macro in class declaration
- use KDEV_USE_EXTENSION_INTERFACE macro in the constructor of the plugin:
    \code
    KDEV_USE_EXTENSION_INTERFACE( IMyInterface )
    \endcode
- declare in plugin's .desktop file:
    \code
    X-KDevelop-Interfaces=IMyInterface
    \endcode
  Code Example:
    \code
    class MyPlugin: public KDevelop::IPlugin, public KDevelop::IMyInterface {
        Q_OBJECT
        Q_INTERFACES(KDevelop::IMyInterface)
    public:
        MyPlugin(QObject* parent) : IPlugin( parent )
        {
            KDEV_USE_EXTENSION_INTERFACE( KDevelop::IMyInterface )
        }
    };
    \endcode
.

\subsubsection load_extension To load a plugin that supports extension interface:
- Use \ref KDevelop::IPluginController::pluginForExtension method if you have only one possible
  plugin implementing the extension interface
- Or use \ref KDevelop::IPluginController::allPluginsForExtension method to return a list of plugins.\n
  Note, that those methods will load plugins if they are not yet loaded
- Once IPlugin pointer is returned by one of two methods above, it can be asked for an
  extension using \ref KDevelop::IPlugin::extension method ( like plugin->extension<IMyInterface>() )

\subsubsection interplugin_dependency To set a dependency between plugins:
- Set the list of required interfaces in plugin's .desktop file
    \code
    X-KDevelop-IRequired=IMyInterface,IMyOtherInterface
    \endcode
It is not possible to set direct inter-plugin dependencies. The plugin shall never depend on another
plugin, it shall only depend on something that implements the interface.


\subsection project IProject, IProjectController and Project Management Infrastructure

KDevelop4 can have multiple projects open at any given time.

project management structure:
\code
                                        |--------------------|       |-------------------------------|
                                  |---->| KDevelop::IProject |------>| KDevelop::IProjectFileManager |
                                  |     |--------------------|       |-------------------------------|
                                  |                 |
|------------------------------|  |     |------------------------|
| KDevelop::IProjectController |------->| KDevelop::ProjectModel |
|------------------------------|  |     |------------------------|
                                  |                 |
                                  |     |--------------------|       |-------------------------------|
                                  |---->| KDevelop::IProject |------>| KDevelop::IBuildSystemManager |
                                        |--------------------|       |-------------------------------|
\endcode
ProjectController is a container for projects (\ref KDevelop::IProject interface). Each project contributes
its contents (files, folders, targets, etc.) to the \ref KDevelop::ProjectModel. Each project also has
a file manager plugin associated with it.\n
Project file manager is the plugin which implements either KDevelop::IProjectFileManager or
\ref KDevelop::IBuildSystemManager and provides all actual project management facilities.\n
This way KDevelop4 is able to load as many projects as desired and each of the project can
have different build system. Plugins access project contents through classes defined in 
\ref KDevelop::ProjectModel. Examples include ProjectFolderItem, ProjectFileItem, ProjectTargetItem etc.

%KDevelop currently supports the notion of "current project" (the one which is currently selected) in the
project management view). But plugins are encouraged to not depend on it. The selection might be
empty or project management view might be closed at any time.

%KDevelop Platform provides by default "GenericProjectManager" which just threats all files and
subdirectories under project directory as project items and currently provides no building facilities.

The project file (&lt;projectname&gt.kdev4) controls which project file manager will be loaded.
For example, this .kdev4 file will load Generic manager:
\code
    [General Options]
    Manager=KDevGenericManager
\endcode


\subsection language ILanguage, ILanguageController and Language Support Infrastructure

The language support infrastructure is designed to be similar to project management.
Its goals are:
- use as many language supports as necessary at the same time
- be able to load several language supports for one source file
  good examples are mixed-source files like .php (php+html), .rhtml (ruby + html)
- be not dependent on projects
.

language support structure:
\code
                                                                          |----------------------------|
                                                                    |---->| KDevelop::ILanguageSupport |
                                         |---------------------|    |     |----------------------------|
                                   |---->| KDevelop::ILanguage |----|
                                   |     |---------------------|    |     |----------------------------|
                                   |                                |---->| KDevelop::BackgroundParser |
|-------------------------------|  |                                      |----------------------------|
| KDevelop::ILanguageController |--|
|-------------------------------|  |                                      |----------------------------|
                                   |                                |---->| KDevelop::ILanguageSupport |
                                   |     |---------------------|    |     |----------------------------|
                                   |---->| KDevelop::ILanguage |----|
                                         |---------------------|    |     |----------------------------|
                                                                    |---->| KDevelop::BackgroundParser |
                                                                          |----------------------------|
\endcode
Language controller holds the set of already loaded languages and provides means to load more.
For each language (defined by its "name") Language object exists. Each such language has
a background parser and a actual support plugin that implements KDevelop::ILanguageSupport.
This way the basic shell functionality (like language loading algorithm and background parser)
is separated from language-specific stuff (like parsing).

Unlike KDevelop3, language support plugin is loaded not among with a project. Instead, when the
source file is opened, the language controller asks plugin controller whether there are
any language plugins (those that implement KDevelop::ILanguageSupport) that support a mime type
of the file (those who set X-KDevelop-SupportedMimeTypes=...).

For each language support plugin found, the KDevelop::Language object (that implements KDevelop::ILanguage interface)
is created and language support plugin is associated with it. Then each language is asked to return
a KDevelop::ParseJob to process the file. This way several language supports are able to parse one file.

If KDevelop::Language object for given mimetype already exists, it is used and no plugin loading is performed.


\subsection uicontroller IUiController

KDevelop::UiController is closely connected to the Sublime UI and basically is an subclass of
\ref Sublime::Controller which will be explained later.

The main job of UiController is to allow plugins to manager their views and toolviews. Currently only
toolviews can be added and removed.

Sublime UI wants plugins to add and remove not actual toolviews, but factories to create them.
This is because user can request from Sublime UI to show a new toolview at any time. For example,
it is possible to have more than one Konsole toolviews. The user just have to ask for them.
Automatically factory will be used only once, when UI controller is asked to add a toolview.
This means for example that only one Konsole toolview will be opened automatically.

To create a factory, a plugin needs to subclass KDevelop::IToolViewFactory and implement two methods:
- virtual QWidget* KDevelop::IToolViewFactory::create(QWidget *parent = 0)
  where the actual toolview widget will be created
- virtual Qt::DockWidgetArea KDevelop::IToolViewFactory::defaultPosition(const QString &areaName)
  which will give the UI a hint on where to place the toolview
.

Once the factory is ready, it has to be added to the UiController using IUiController::addToolView() method.
It is not absolutely necessary for a plugin to remove or delete toolview factory. UiController will
delete them all upon unload.

NOTE: temporarily IUiController has KDevelop::IUiController::openUrl() method which is the only
way to open files in KDevelop until DocumentController is ported.



\section sublime Sublime UI

\subsection sublime_operation Modus Operandi

- UI provides support for "areas" (alike Eclipse's perspectives)
- The basic set of areas is:
  - code editing area with splitted editor windows \n
    (with kate/konqueror-like splitting)
  - debugging area \n
    (Xcode-like debugger window with only one editor view by default but with possiblility to show more)
  - profiling area \n
    (like KCacheGrind)
  - user interface design area \n
    (like Qt designer)
- Area configuration includes code editor windows (unlike eclipse)
- Each area can be displayed in usual Qt mainwindow with toolviews in dockwidgets
- Areas are shown in separate mainwindows so that multiple-monitor setups become the best supported
- One area can be shown in two and more mainwindows by "cloning" the area \n
  (unlike Eclipse that pretends that two mainwindows show the same area)
- Optionally areas can be switched inside the same mainwindow without opening new ones
  (like in Eclipse), but this mode of operation is currently not implemented. \n
  Also Sublime was not optimized for this use-case. See wiki pages for a detailed discussion and
  explanation of possible problems.
- It is possible to open as many similar toolviews as necessary (for example, several konsole's)
- It is possible to open several views for the same file in code editor view (unlike KDevelop 3.x)
- Instead of tabs for editor windows a "switcher" is provided. \n
  Currently the switcher is a combobox but that will change for sure.
.

\subsection sublime_architecture Brief Architecture Overview

Sublime::Controller is the central point of the whole Sublime infrastructure. It contains areas,
documents and controlls mainwindows. \n
Sublime::Controller::showArea() is the only way to show an area in the mainwindow.

Sublime::MainWindow is just a KParts::MainWindow which just knows how to "reconstruct" the area,
react on area changes. Additionally it knows which view and toolview is "active" (i.e. last focused).

Sublime::Area is the object that controls views, toolviews and defines their placement
inside the mainwindow. Provides varous view management (e.g. add/remove/etc.) methods and signals.
Also Area is responsible to store/restore view layout (on-disk storage is not implemented currently).

Area is identified by its name. Each KDevelop platform application, for example, has to define
a concept of "default area" in ShellExtension so that UiController can load it by default.

While areas operate on views, the Sublime Controller deals with \ref Sublime::Document 's only.
Sublime::View is only a thin wrapper around actual QWidget.

Document is what provides views. Sublime::Document::createView() is the only way to get a view.
When createView() is called, the protected Sublime::Document::createViewWidget() is called to
return the actual widget for a view.

There is an abstract Sublime::Document class with no createViewWidget() implementation and
there's a convenience class Sublime::ToolDocument that can create widgets of user-specified type.

KDevelop currently uses Sublime::PartDocument which is subclassed by KDevelop::PartDocument.
This PartDocument creates a view by loading a part and then asking a part about its widget.



*/