File: pluginDialog.C

package info (click to toggle)
ball 1.5.0%2Bgit20180813.37fc53c-6
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 239,888 kB
  • sloc: cpp: 326,149; ansic: 4,208; python: 2,303; yacc: 1,778; lex: 1,099; xml: 958; sh: 322; makefile: 95
file content (448 lines) | stat: -rw-r--r-- 12,230 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
#include <BALL/PLUGIN/pluginManager.h>
#include <BALL/PLUGIN/BALLPlugin.h>

#include <BALL/VIEW/WIDGETS/scene.h>
#include <BALL/VIEW/KERNEL/mainControl.h>
#include <BALL/VIEW/KERNEL/iconLoader.h>
#include <BALL/VIEW/DIALOGS/preferences.h>
#include <BALL/VIEW/DIALOGS/displayProperties.h>
#include <BALL/VIEW/DIALOGS/pluginDialog.h>
#include <BALL/VIEW/PLUGIN/VIEWPlugin.h>

#include <BALL/VIEW/UIC/ui_pluginDialog.h>

Q_DECLARE_METATYPE(BALL::VIEW::VIEWPlugin*)

#include <QtCore/QCoreApplication>
#include <QtCore/QLibraryInfo>
#include <QtWidgets/QFileDialog>

namespace BALL
{
	namespace VIEW
	{
		/*
		 * Implementation of PluginModel
		 */
		PluginModel::PluginModel(QObject* parent)
			: QAbstractListModel(parent),
			  num_rows_(0)
		{
		}

		int PluginModel::rowCount(const QModelIndex& /* parent */) const
		{
			return num_rows_;
		}

		void PluginModel::pluginsLoaded()
		{
			int nrow = num_rows_;
			num_rows_ = PluginManager::instance().getPluginCount();
			beginInsertRows(QModelIndex(), nrow, num_rows_);
			endInsertRows();
		}

		QVariant PluginModel::data(const QModelIndex& i, int role) const
		{
			if(!i.isValid())
			{
				return QVariant();
			}

			PluginManager& man = PluginManager::instance();

			if(i.row() >= num_rows_)
			{
				return QVariant();
			}

			switch(role)
			{
				case Qt::UserRole:
					return qVariantFromValue(man.getPluginInstance(i.row()));

				case Qt::DisplayRole:
				{
					BALLPlugin* ptr = qobject_cast<BALLPlugin *>(man.getPluginInstance(i.row()));

					// we *know* that this is a BALLPlugin (the loader takes care of that), so we don't need
					// to test if the cast succeeded
					return ptr->getName() + " (" + (ptr->isActive() ? tr("active") : tr("inactive")) + ")";
				}

				case Qt::DecorationRole:
				{
					VIEWPlugin* ptr = qobject_cast<VIEWPlugin *>(man.getPluginInstance(i.row()));
					return ptr ? *(ptr->getIcon()) : QVariant();
				}

				case Qt::ToolTipRole:
				{
					VIEWPlugin *ptr = qobject_cast<VIEWPlugin *>(man.getPluginInstance(i.row()));
					return ptr ? ptr->getDescription() : QVariant();
				}

				default:
					return QVariant();
			}
		}

		/*
		 * Implementation of PluginDirectoryModel
		 */

		PluginDirectoryModel::PluginDirectoryModel(QObject* parent)
			: QAbstractListModel(parent)
		{
		}

		int PluginDirectoryModel::rowCount(const QModelIndex& /* parent */) const
		{
			PluginManager& man = PluginManager::instance();
			return man.getPluginDirectories().size();
		}

		QVariant PluginDirectoryModel::data(const QModelIndex& i, int role) const
		{
			if(!i.isValid()) {
				return QVariant();
			}

			PluginManager& man = PluginManager::instance();

			if((size_t)i.row() >= man.getPluginDirectories().size())
			{
				return QVariant();
			}

			switch(role)
			{
				case Qt::DisplayRole:
				{
					return man.getPluginDirectories()[i.row()];
				}

				default:
					return QVariant();
			}
		}

		void PluginDirectoryModel::addDirectory(const QString& dir)
		{
			PluginManager& man = PluginManager::instance();

			if(man.addPluginDirectory(dir)) {
				int idx = man.getPluginDirectories().size() - 1;

				beginInsertRows(QModelIndex(), idx, idx);
				endInsertRows();
			}
		}

		void PluginDirectoryModel::removeDirectory(const QModelIndex& idx)
		{
			PluginManager& man = PluginManager::instance();

			if(man.removePluginDirectory(idx.data(Qt::DisplayRole).toString())) {
				beginRemoveRows(QModelIndex(), idx.row(), idx.row());
				endRemoveRows();
			}
		}

		/*
		 * Implementation of PluginDialog
		 */
		PluginDialog::PluginDialog(Preferences* preferences, QWidget* parent, const char* name)
			: QWidget(parent),
			  ModularWidget(name),
			  preferences_(preferences)
		{
			ui_ = new Ui::PluginDialogData;
			ui_->setupUi(this);

			// define the dialogs section name in the INIFile
			setINIFileSectionName("PLUGINS");
			stack_pages_.push_back(std::make_pair(this, tr("Plugins").toStdString()));

			preferences_->insertEntry(this);

			setObjectName(name);

			IconLoader& icon_loader = IconLoader::instance();

			ui_->plugin_dir_button_add->setIcon(icon_loader.getIcon("actions/list-add"));
			ui_->plugin_dir_button_remove->setIcon(icon_loader.getIcon("actions/edit-delete"));

			// register all visible childs
			registerWidgets_();

			ui_->plugin_view->setModel(&plugin_model_);
			ui_->plugin_directories_view->setModel(&plugin_dir_model_);

			plugin_model_.pluginsLoaded();

			setObjectName(name);
			ModularWidget::registerWidget(this);

			connect(ui_->plugin_dir_button_add, SIGNAL(clicked()), this, SLOT(addPluginDirectory()));
			connect(ui_->plugin_dir_button_remove, SIGNAL(clicked()), this, SLOT(removePluginDirectory()));
			connect(ui_->plugin_directories_view->selectionModel(), SIGNAL(currentChanged(const QModelIndex&, const QModelIndex&)), this, SLOT(directorySelectionChanged(const QModelIndex&, const QModelIndex&)));
			connect(ui_->plugin_view->selectionModel(), SIGNAL(currentChanged(const QModelIndex&, const QModelIndex&)), this, SLOT(pluginChanged(QModelIndex, const QModelIndex&)));
		}

		PluginDialog::~PluginDialog()
		{
			PluginManager::instance().unregisterHandler(this);
			delete ui_;
		}

		void PluginDialog::initializeWidget(MainControl&)
		{
			PreferencesEntry::restoreValues();
		}

		void PluginDialog::finalizeWidget(MainControl& mc)
		{
			ModularWidget::finalizeWidget(mc);
			PluginManager::instance().unloadAllPlugins();
		}

		void PluginDialog::writePreferenceEntries(INIFile& inifile)
		{
			PreferencesEntry::writePreferenceEntries(inifile);

			for (std::list<PreferencesEntry*>::iterator child_it = child_entries_.begin(); child_it != child_entries_.end(); ++child_it)
			{
				(*child_it)->writePreferenceEntries(inifile);
			}

			PluginManager& man = PluginManager::instance();

			if(!inifile.hasSection(getINIFileSectionName())) {
				inifile.appendSection(getINIFileSectionName());
			}

			String value;
			man.getPluginDirectories(value);

			inifile.insertValue(getINIFileSectionName(), "PluginDirectories", value);
			inifile.insertValue(getINIFileSectionName(), "ActivePlugins", man.getAutoActivatePlugins().toStdString());
		}

		void PluginDialog::readPreferenceEntries(const INIFile& inifile)
		{
			PreferencesEntry::readPreferenceEntries(inifile);

			plugin_model_.pluginsLoaded();

			for (std::list<PreferencesEntry*>::iterator child_it = child_entries_.begin(); 
					 child_it != child_entries_.end(); 
					 ++child_it)
			{
				(*child_it)->readPreferenceEntries(inifile);
			}

			PluginManager& man = PluginManager::instance();

			if (inifile.hasEntry(getINIFileSectionName(), "ActivePlugins"))
			{
				String active_plugins = inifile.getValue(getINIFileSectionName(), "ActivePlugins");
				man.setAutoActivatePlugins(active_plugins.c_str());
			}

			if (inifile.hasEntry(getINIFileSectionName(), "PluginDirectories"))
			{
				String plugin_directories = inifile.getValue(getINIFileSectionName(), "PluginDirectories");
				man.setPluginDirectories(plugin_directories);
			}
			else
			{
				setDefaultPluginDirectory();
			}
		}

		void PluginDialog::restoreDefaultValues(bool /* all */)
		{
			for (auto i = plugin_dir_model_.rowCount() - 1; i >= 0 ; --i)
			{
				plugin_dir_model_.removeDirectory(plugin_dir_model_.index(i));
			}
			setDefaultPluginDirectory();
		}

		void PluginDialog::pluginChanged(QModelIndex current, const QModelIndex& /* previous */)
		{
			//Cleanup the old config dialog
			active_index_ = current;
			QObject* active_object = qvariant_cast<QObject*>(plugin_model_.data(current, Qt::UserRole));

			BALLPlugin* active_plugin = qobject_cast<BALLPlugin*>(active_object);
			if (!active_plugin)
			{
				return;
			}

			ui_->plugin_toggle_button->setEnabled(true);
			if (active_plugin->isActive())
			{
				ui_->plugin_toggle_button->setText(tr("Deactivate"));
			}
			else
			{
				ui_->plugin_toggle_button->setText(tr("Activate"));
			}
		}

		void PluginDialog::addPluginDirectory()
		{
			QString dir = QFileDialog::getExistingDirectory(this, tr("Select a plugin directory"));
			if(!dir.isNull())
			{
				plugin_dir_model_.addDirectory(dir);
				plugin_model_.pluginsLoaded();
			}
		}

		void PluginDialog::removePluginDirectory()
		{
			// TODO: disable remove button if no item selected
			if (!ui_->plugin_directories_view->currentIndex().isValid())
			{
				return;
			}

			plugin_dir_model_.removeDirectory(ui_->plugin_directories_view->currentIndex());
			plugin_model_.pluginsLoaded();
		}

		void PluginDialog::directorySelectionChanged(const QModelIndex& current, const QModelIndex& /* previous */)
		{
			ui_->plugin_dir_button_remove->setEnabled(current.isValid());
		}

		void PluginDialog::togglePluginState()
		{
			if (!active_index_.isValid())
			{
				return;
			}

			QObject* active_object = qvariant_cast<QObject*>(plugin_model_.data(active_index_, Qt::UserRole));
			BALLPlugin* active_plugin = qobject_cast<BALLPlugin*>(active_object);
			if (active_plugin->isActive())
			{
				PluginManager::instance().doNotAutoActivatePlugin(active_plugin->getName());
				PluginManager::instance().stopPlugin(active_plugin);
				ui_->plugin_toggle_button->setText(tr("Activate"));
			}
			else
			{
				PluginManager::instance().autoActivatePlugin(active_plugin->getName());
				PluginManager::instance().startPlugin(active_plugin);
				ui_->plugin_toggle_button->setText(tr("Deactivate"));
			}

			ui_->plugin_view->update(active_index_);
		}

		void PluginDialog::registerChildEntry(PreferencesEntry* child)
		{
			if(!child) return;

			preferences_->insertChildEntry("PLUGINS", child);
			child_entries_.push_back(child);
		}

		void PluginDialog::unregisterChildEntry(PreferencesEntry* child)
		{
			if(!child) return;

			std::list<PreferencesEntry*>::iterator child_it = std::find(child_entries_.begin(), child_entries_.end(), child);
			child_entries_.erase(child_it);
			preferences_->removeEntry(child);
		}

		bool PluginDialog::canHandle(BALLPlugin* plugin) const
		{
			return dynamic_cast<VIEWPlugin*>(plugin) != 0;
		}

		bool PluginDialog::specificSetup_(BALLPlugin* plugin)
		{
			VIEWPlugin* view_plugin = dynamic_cast<VIEWPlugin*>(plugin);

			if(view_plugin->getConfigDialog() != 0 && preferences_ != 0)
			{
				registerChildEntry(view_plugin->getConfigDialog());
			}

			return true;
		}

		bool PluginDialog::specificShutdown_(BALLPlugin* plugin)
		{
			VIEWPlugin* view_plugin = dynamic_cast<VIEWPlugin*>(plugin);

			if(view_plugin->getConfigDialog() != 0 && preferences_ != 0)
			{
				unregisterChildEntry(view_plugin->getConfigDialog());
				view_plugin->getConfigDialog()->setParent(0);
			}

			return true;
		}

		void PluginDialog::setDefaultPluginDirectory()
		{
#ifdef BALL_OS_DARWIN

			// On macOS, we can locate potential default plugin directories relative
			// to the directory (absolute path) containing the BALLView binary.
			// The latter has the suffix BALLView.app/Contents/MacOS

			QDir app_dir = QDir(QCoreApplication::applicationDirPath());

			// Option 1: BALLView bundle installation
			// Plugins will reside in BALLView.app/Contents/plugins
			if(app_dir.cd("../plugins"))
			{
				plugin_dir_model_.addDirectory(app_dir.path());
			}
			else
			{
				// Option 2: BALLView build from source
				// Plugins will reside in <build_dir>/lib
				if (app_dir.cd("../../../../lib"))
				{
					plugin_dir_model_.addDirectory(app_dir.path());
				}
			}

#elif defined BALL_OS_LINUX

			// On Linux, we can locate the default plugin directory relative
			// to the directory (absolute path) containing the BALLView binary.

			QDir app_dir = QDir(QCoreApplication::applicationDirPath());

			// For installed BALLView binaries and source builds the folder hierarchy is identical.
			// BALLView will reside in <install_or_build_dir>/bin
			// Plugins will reside in  <install_or_build_dir>/lib
			if(app_dir.cd("../lib"))
			{
				plugin_dir_model_.addDirectory(app_dir.path());
			}

#elif defined BALL_OS_WINDOWS

			// On Windows, BALLView plugins reside in the same folder as the BALLView executable.
			// Thus, we simply can use this path as the default plugin directory.

			plugin_dir_model_.addDirectory(QCoreApplication::applicationDirPath());

#endif
			plugin_model_.pluginsLoaded();
		}
	}
}