プラグイン¶

quardCRT は V0.4.0 からプラグインに対応しています。プラグインは Qt プラグインとして実装され、動的ライブラリとして読み込まれます。

このページでは、プラグインを利用するユーザー向けの説明と、プラグインを開発する方向けの説明の両方を扱います。

ユーザー向け¶

プラグインは、その実装内容に応じて quardCRT を次のように拡張できます。

メイン画面にアクションやメニューを追加する
ターミナルのコンテキストメニューに項目を追加する
サイドバー領域に独自のプラグインウィジェットを追加する
SSH、シリアル、Raw Socket、VNC などの接続関連アクションを起動する

quardCRT には、プラグインの状態、互換性情報、初期化エラーを確認できるプラグイン情報ウィンドウも用意されています。

プラグインの読み込み動作¶

起動時に quardCRT はプラグインディレクトリ内の同梱プラグインを読み込みます。アプリ設定で任意のプラグインディレクトリを指定している場合は、その場所からも追加で読み込めます。

プラグインを読み込めない場合、quardCRT はそれを黙って成功扱いにせず、プラグイン情報ダイアログに失敗理由を記録します。

よくある失敗理由は次のとおりです。

プラグインのメタデータ不足
未対応のプラグイン API バージョン
初期化失敗
quardCRT が期待するメニューまたはウィジェットのエントリポイント不足

プラグインの有効化と無効化¶

プラグインの有効状態はアプリ設定に保存されます。対応プラグインはプラグイン情報ダイアログから有効化または無効化できます。

これは次のような場面で便利です。

ファイルを削除せずに一時的にプラグインを無効化したい
新しいプラグインを試し、簡単に元へ戻したい
マシンごとに異なるプラグイン構成を使い分けたい

開発者向け¶

プラグイン開発¶

API¶

プラグイン API 仕様は plugininterface リポジトリで管理されています。

カスタムプラグインの一般的な開発手順は次のとおりです。

plugininterface.h ヘッダをインクルードする
プラグインクラスを定義し、PluginInterface を継承する
PluginInterface が要求するメソッドを実装する
対象プラットフォーム向けに dll、so、dylib などのネイティブプラグインライブラリをビルドする
quardCRT が読み込める場所にビルド済みプラグインを配置する

実用的なプラグインは、たとえば次のような機能を持つことが多いです。

メインメニューのアクションまたはメニュー
サイドバーのウィジェット
ターミナルコンテキストメニュー項目
プラグイン用設定の読み書きフック
setLanguage() や retranslateUi() による多言語対応

以下は最小構成の例です。

#include "plugininterface.h"

#include <QMap>
#include <QMessageBox>
#include <QDebug>

#define PLUGIN_NAME    "Hello World"
#define PLUGIN_VERSION "0.0.1"

class HelloWorld : public PluginInterface
{
	Q_OBJECT
	Q_PLUGIN_METADATA(IID "org.quardCRT.PluginInterface" FILE "../plugininterface.json")
	Q_INTERFACES(PluginInterface)

public:
	HelloWorld() : m_action(nullptr) {}
	virtual ~HelloWorld() {}

	int init(QMap<QString, QString> params, QWidget *parent) {
		foreach (QString key, params.keys()) {
			qDebug() << key << " : " << params[key];
		}
		qDebug() << "Hello World init";
		m_action = new QAction("Hello World", parent);
		connect(m_action, &QAction::triggered, [parent](){
			QMessageBox::information(parent, "Hello World", "Hello World");
		});

		return 0;
	}

	void setLanguage(const QLocale &language,QApplication *app) {Q_UNUSED(language);Q_UNUSED(app);}
	void retranslateUi() {}
	QString name() { return PLUGIN_NAME; }
	QString version() { return PLUGIN_VERSION; }

	QMap<QString,void *> metaObject() {
		QMap<QString,void *> ret;
		ret.insert("QAction", (void *)m_action);
		return ret;
	}

	QMenu *terminalContextMenu(QString selectedText, QString workingDirectory, QMenu *parentMenu) {Q_UNUSED(selectedText);Q_UNUSED(workingDirectory);Q_UNUSED(parentMenu); return nullptr;}
	QList<QAction *> terminalContextAction(QString selectedText, QString workingDirectory, QMenu *parentMenu) {Q_UNUSED(selectedText);Q_UNUSED(workingDirectory);Q_UNUSED(parentMenu); return QList<QAction *>();}

private:
	QAction *m_action;
};