KDevelop5/LanguagePlugin

From KDE TechBase
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.desktop file

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

  • X-KDE-Library=... this must be the same as the name of your library, i.e. look into the CMakeLists.txt for your kde4_add_plugin line and use the same name
  • X-KDE-PluginInfo-Name=... 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 K_EXPORT_PLUGIN line, more exactly the first argument to the KAboutData.

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

the plugin

A basic plugin's header looks like this:

#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 KDevTestLangPlugin( QObject* parent, const QVariantList& args = QVariantList() );
        
        virtual KDevelop::ParseJob* createParseJob(const KUrl& url);
        virtual QString name() const;
};

An implementation could look like this:


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

#include "testlangparsejob.h"

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

KDevTestLangPlugin::KDevTestLangPlugin(QObject* parent, const QVariantList& )
     : KDevelop::IPlugin( KDevTestLangSupportFactory::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";
}