HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Commit - r1509:3eb0350f563b

Adds basic demo plugin to explain how to write custom plugins in C++...

jeandet -

r1509:3eb0350f563b

parent child

Context file:

r1509:3eb0350f563b

plugins/demo_plugin/DemoPlugin.cpp created 644 +7 0

@@ -0,0 +1,7
	1	#include "DemoPlugin.hpp"
	2	#include <iostream>
	3
	4	void DemoPlugin::initialize()
	5	{
	6	std::cout << "Loading DemoPlugin \\o/" << std::endl;
	7	}

plugins/demo_plugin/DemoPlugin.hpp created 644 +19 0

@@ -0,0 +1,19
	1	#ifndef SCIQLOP_DEMOPLUGIN_H
	2	#define SCIQLOP_DEMOPLUGIN_H
	3
	4	#include <IPlugin.h>
	5	#include <QtPlugin>
	6
	7	#define PLUGIN_JSON_FILE_PATH "DemoPlugin.json"
	8
	9
	10	class DemoPlugin : public QObject, public IPlugin {
	11	Q_OBJECT
	12	Q_INTERFACES(IPlugin)
	13	Q_PLUGIN_METADATA(IID "sciqlop.plugin.IPlugin" FILE PLUGIN_JSON_FILE_PATH)
	14	public:
	15	/// @sa IPlugin::initialize()
	16	void initialize() final;
	17	};
	18
	19	#endif // SCIQLOP_DEMOPLUGIN_H

plugins/demo_plugin/DemoPlugin.json created 644 +3 0

@@ -0,0 +1,3
	1	{
	2	"name" : "DemoPlugin"
	3	}

plugins/demo_plugin/meson.build created 644 +25 0

@@ -0,0 +1,25
	1	demoplugin_moc_headers = [
	2	'DemoPlugin.hpp'
	3	]
	4
	5	demoplugin_sources = [
	6	'DemoPlugin.cpp'
	7	]
	8
	9
	10	demoplugin_moc_files = qt5.preprocess(
	11	moc_headers: demoplugin_moc_headers,
	12	dependencies: sciqlop_core,
	13	include_directories: core_inc,
	14	moc_extra_arguments : ['-DQT_PLUGIN', '-DQT_STATICPLUGIN']
	15	)
	16
	17	demo_plugin = static_library('demo_plugin',
	18	'DemoPlugin.cpp',
	19	demoplugin_moc_files,
	20	extra_files: 'DemoPlugin.hpp',
	21	dependencies : [sciqlop_core],
	22	cpp_args : ['-DQT_PLUGIN', '-DQT_STATICPLUGIN']
	23	)
	24
	25	demo_plugin_dep = declare_dependency(link_with: demo_plugin, include_directories: '.')

app/include/MainWindow.h +1 -6

             /*------------------------------------------------------------------------------
             -- This file is a part of the SciQLop Software
             -- Copyright (C) 2017, Plasma Physics Laboratory - CNRS
             --
             -- This program is free software; you can redistribute it and/or modify
             -- it under the terms of the GNU General Public License as published by
             -- the Free Software Foundation; either version 2 of the License, or
             -- (at your option) any later version.
             --
             -- This program is distributed in the hope that it will be useful,
             -- but WITHOUT ANY WARRANTY; without even the implied warranty of
             -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
             -- GNU General Public License for more details.
             --
             -- You should have received a copy of the GNU General Public License
             -- along with this program; if not, write to the Free Software
             -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
             -------------------------------------------------------------------------------*/
             /*-- Author : Alexis Jeandet
             -- Mail : alexis.jeandet@member.fsf.org
             ----------------------------------------------------------------------------*/
             #ifndef SCIQLOP_MAINWINDOW_H
             #define SCIQLOP_MAINWINDOW_H
             #include <PluginManager/PluginManager.h>
             #include <QDir>
             #include <QLoggingCategory>
             #include <QMainWindow>
             #include <QProgressBar>
             #include <QProgressDialog>
             #include <QThread>
             #include <QVBoxLayout>
             #include <QWidget>
             #include <QtPlugin>
             #include <SqpApplication.h>
             #include <Common/spimpl.h>
             #include <memory>
             namespace Ui
             {
             class MainWindow;
             } // namespace Ui
             class MainWindow : public QMainWindow
             {
                 Q_OBJECT
             public:
                 explicit MainWindow(QWidget* parent = nullptr);
                 virtual ~MainWindow() override;
             public slots:
             protected:
                 void changeEvent(QEvent* e) override;
                 void closeEvent(QCloseEvent* event) override;
                 void keyPressEvent(QKeyEvent* event) override;
             private:
                 std::unique_ptr<Ui::MainWindow> m_Ui;
                 //    QWidget *m_progressWidget;
                 //    QVBoxLayout *m_progressLayout;
                 // QList<QLopService*> m_qlopServices;
                 class MainWindowPrivate;
                 spimpl::unique_impl_ptr<MainWindowPrivate> impl;
             };
             inline void init_resources()
             {
-            #ifdef QT_STATICPLUGIN
+                Q_IMPORT_PLUGIN(DemoPlugin);
-            #ifndef SQP_NO_PLUGINS
-                Q_IMPORT_PLUGIN(PythonProviders)
-                Q_INIT_RESOURCE(python_providers);
-            #endif
-            #endif
                 Q_INIT_RESOURCE(sqpguiresources);
                 SqpApplication::setOrganizationName("LPP");
                 SqpApplication::setOrganizationDomain("lpp.fr");
                 SqpApplication::setApplicationName("SciQLop");
                 QGuiApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
             }
             inline void load_plugins(const SqpApplication& a)
             {
                 // Loads plugins
                 auto pluginDir = QDir { a.applicationDirPath() };
                 auto pluginLookupPath = {
             #if _WIN32 || _WIN64
                     a.applicationDirPath() + "/SciQLop"
             #else
                     a.applicationDirPath() + "/../lib64/SciQLop",
                     a.applicationDirPath() + "/../lib64/sciqlop",
                     a.applicationDirPath() + "/../lib/SciQLop",
                     a.applicationDirPath() + "/../lib/sciqlop",
             #endif
                 };
             #if _WIN32 || _WIN64
                 pluginDir.mkdir(PLUGIN_DIRECTORY_NAME);
                 pluginDir.cd(PLUGIN_DIRECTORY_NAME);
             #endif
                 PluginManager pluginManager {};
                 for (auto&& path : pluginLookupPath)
                 {
                     QDir directory { path };
                     if (directory.exists())
                     {
                         pluginManager.loadPlugins(directory);
                     }
                 }
                 pluginManager.loadStaticPlugins();
             }
             #endif // SCIQLOP_MAINWINDOW_H

app/meson.build +2 -18

             app_moc_headers = [
               'include/MainWindow.h',
               'include/toolbar.h'
             ]
             app_ui_files = [
               'ui/MainWindow.ui'
             ]
             app_qresources = ['resources/qlopapp.qrc']
             app_moc_files = qt5.preprocess(moc_headers : app_moc_headers,
                                            ui_files : app_ui_files,
                                            qresources : app_qresources)
             app_sources = [
               'src/Main.cpp',
               'src/MainWindow.cpp',
               'src/toolbar.cpp'
             ]
             app_inc = include_directories(['include'])
             if host_machine.system()=='windows' or build_machine.system()=='windows'
               winmod = import('windows')
               rc = winmod.compile_resources('resources/qlopapp.rc')
             else
               rc = []
             endif
-            app_libs = []
+            cpp_args = ['-DQT_STATICPLUGIN']
-            cpp_args = []
-            if 'static' == get_option('default_library')
-              app_libs = [sciqlop_python_providers]
-              cpp_args += ['-DQT_STATICPLUGIN']
-            endif
-            #sciqlop_app = executable('sciqlop',
-            #                       app_sources,
-            #                       app_moc_files,
-            #                       rc,
-            #                       include_directories : [ app_inc],
-            #                       link_with: app_libs,
-            #                       cpp_args: cpp_args,
-            #                       dependencies : [sciqlop_gui, sciqlop_core],
-            #                       install : true
-            #                       )
             sciqlop_app_lib = library('sciqlop',
                                    app_sources,
                                    app_moc_files,
                                    rc,
                                    include_directories : [ app_inc],
-                                   link_with: app_libs,
                                    cpp_args: cpp_args,
-                                   dependencies : [sciqlop_gui, sciqlop_core],
+                                   dependencies : [sciqlop_gui, sciqlop_core, demo_plugin_dep],
                                    install : true
                                    )
             sciqlop_app_dep = declare_dependency(link_with : sciqlop_app_lib,
                                             include_directories : app_inc,
                                             dependencies : [sciqlop_gui, sciqlop_core])
             subdir('PySide2-bindings')

plugins/meson.build +2 0

@@ -0,0 +1,2
	1
	2	subdir('demo_plugin')

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages