View source for KDevelop5/LanguagePlugin

= .desktop file =

In order to find your language support plugin, KDE needs a .desktop file with some meta information.

* <code>X-KDE-Library=...</code> this must be the same as the name of your library, i.e. look into the <code>CMakeLists.txt</code> for your <code>kde4_add_plugin</code> line and use the same name
* <code>X-KDE-PluginInfo-Name=...</code> this must be the same as the name of your plugin in the code, i.e. look into your main plugin .cpp file and find the <code>K_EXPORT_PLUGIN</code> line, more exactly the first argument to the <code>KAboutData</code>.

After installing your plugin, make sure to run <code>kbuildsycoca4</code>. For testing, try duchainify or ktraderclient.

= the plugin =

A basic plugin's header looks like this:

<pre>
#include <interfaces/iplugin.h>
#include <language/interfaces/ilanguagesupport.h>

class KDevTestLangPlugin : public KDevelop::IPlugin, public KDevelop::ILanguageSupport
{
    Q_OBJECT
    Q_INTERFACES( KDevelop::ILanguageSupport )
    public:
        explicit KDevQmlJsPlugin( QObject* parent, const QVariantList& args = QVariantList() );
        
        virtual KDevelop::ParseJob* createParseJob(const KUrl& url);
        virtual QString name() const;
};
</pre>

An implementation could look like this:

<pre>

#include "kdevqmljsplugin.h"
#include <KPluginFactory>
#include <KAboutData>

#include "qmljsparsejob.h"

K_PLUGIN_FACTORY(KDevQmlJsSupportFactory, registerPlugin<KDevQmlJsPlugin>(); )
// note: "kdevtestlangsupport" must be the same as you used in X-KDE-PluginInfo-Name!
K_EXPORT_PLUGIN(KDevQmlJsSupportFactory(KAboutData("kdevtestlangsupport","kdevtestlang", ki18n("TestLanguage Support"), "0.1", ki18n("Support for Some Test Language"), KAboutData::License_GPL)))

KDevQmlJsPlugin::KDevQmlJsPlugin(QObject* parent, const QVariantList& )
     : KDevelop::IPlugin( KDevQmlJsSupportFactory::componentData(), parent )
     , KDevelop::ILanguageSupport()
{
    // NOTE: this is important!
    KDEV_USE_EXTENSION_INTERFACE(KDevelop::ILanguageSupport)
}

KDevelop::ParseJob* KDevTestLangPlugin::createParseJob(const KUrl& url)
{
    return new TestLangParseJob(url, this);
}

QString KDevTestLangPlugin::name() const
{
    // some unique id for your language
    return "testlang";
}
</pre>