Skip to content

ホストが提供する各種サービス

Lertaro.PluginSdk.Services 名前空間では、ホスト内部のアルゴリズム、キャッシュ、プラットフォーム機能をプラグインから直接利用できる高性能な静的サービス群を提供しています。

1. 主要な静的サービス一覧

サービス名主要メソッドとシグネチャ機能説明
FuzzyMatchServicebool IsMatch(string pattern, string text)
bool[]? GetHighlightMask(string text, string query)
double GetMatchScore(string text, string query)
ホストと同一の fzf あいまい一致エンジンを実行し、文字単位のハイライトマスク(ピンイン多階層フォールバック対応)を計算し、結果の一貫した並べ替えに使える一致品質スコアを提供。
TranslationServicestring Get(string key)
string Format(string key, params object[] args)
void LoadEmbeddedTranslations(...)
string GetCurrentCulture()
event Action<string>? CultureChanged
多言語動的解決と実行時言語変更ブロードキャスト。GetCurrentCulture() は OS の言語ではなく設定画面で明示的に選択されている言語コード(例: "ja-JP")を返却;CultureChanged を購読することで UI 言語変更時に内部状態の更新や辞書の再読み込みが可能。
IconServiceImageSource? GetIcon(string path, bool isDir)
ImageSource? GetThumbnail(string path, int size)
メモリおよびディスクキャッシュ付きの Windows Shell ファイルアイコン・サムネイル抽出。
FavoritesServiceIReadOnlyList<FavoriteItem> GetFavorites()
bool IsFavorite(string path)
bool TryAddFavorite(FavoriteItem favorite)
お気に入り一覧の取得、パスの登録済み確認、ホストブリッジ経由でのお気に入り追加を提供。
HistoryServiceIEnumerable<HistoryEntry> GetHistoryEntries()最近のアクセス順に並んだ履歴項目(検索キーワード、ファイル種別、項目ごとの使用回数を含む)を読み取ります。同じ物理パスは、最後に開いたときのキーワードの下に最大 1 件だけ表示されます。
FileMetadataServiceTask<IReadOnlyDictionary<string, FileMetadata>> GetMetadataAsync(IEnumerable<string> paths)検索結果セットに含まれない外部パスのファイルサイズやタイムスタンプを一括取得。
DirectoryIndexerServicevoid RegisterDirectory(string pluginId, string path, bool recursive, string? filterPattern)
IDisposable WatchDirectories(string pluginId, Action onChanged)
IDisposable WatchDirectories(string pluginId, Action<IReadOnlyList<string>> onChanged)
IAsyncEnumerable<ISearchResult> EnumerateDirectoryAsync(...)
ホスト側のインデックス検索と変更監視のためにカスタムディレクトリを登録します。列挙はホストのファイルインデックスだけを読み取り、ストリームで返します。対象となるインデックスがないディレクトリは空のシーケンスになるため、ローカルドライブ、ネットワーク、またはフォルダーインデックスで対象にする必要があります。ホストはファイルシステムを直接スキャンしません。監視通知はデバウンスされ、影響を受けたディレクトリを含められます。空のリストは、より狭い範囲を特定できなかったことを示します。
MemoryMaintenanceServicevoid RequestTrim()一時メモリを大量に使用するバックグラウンド処理の完了後、ホストに遅延したワーキングセット整理を要求します。要求はまとめられるか無視される場合があり、使用中のキャッシュは解放しません。
RecentFilesServiceTask<IReadOnlyList<ISearchResult>> GetRecentFilesAsync(IEnumerable<string> directories, int limit, int maxAgeMinutes, CancellationToken token)インメモリインデックスから指定フォルダー群の最新更新ファイルをミリ秒単位で集約抽出。
ExplorerPathServicestring? GetLastActivePath()エクスプローラーや各アプリのファイルダイアログで最後に開かれた作業ディレクトリパスを取得。
PluginSettingsServiceT GetSetting<T>(string pluginId, string key, T defaultValue)
bool IsComponentEnabled(string dllName, string componentType, string componentName)
event Action<string, string>? SettingChanged
event Action? ComponentEnablementChanged
プラグイン設定と、ホストが保存するコンポーネント単位の有効状態を読み取ります。
SettingsSearchServiceIReadOnlyList<SettingsSearchEntryInfo> GetEntries()
void Invalidate()
ホストが現在提供している検索可能な設定項目を取得し、動的な項目が変化したときにホストのキャッシュ済みスナップショットを更新可能。
SettingsWindowServicebool ShowWindow(string? targetSection = null)
bool ShowEntry(SettingsSearchEntryInfo? entry)
テーマ対応の設定画面を表示するか、検索可能な設定項目へ直接移動するようホストに要求。URI や別プロセスは起動しません。
SearchRefreshServicevoid RefreshIfMatches(Func<string, bool> queryMatches)非同期処理の完了後に、一致するアクティブな検索結果の再評価とビューの即時更新をホストへ通知。
UserDataServicestring GetUserDataDirectory()
string GetSharedDataDirectory()
ユーザー専用データフォルダー(個別設定用)およびマシン共通データフォルダー(Python/Node ランタイム等)を取得。
Loggervoid Log(string message, LogLevel level = LogLevel.Info)app.log にログを出力し、設定画面のログビューアーにリアルタイム同期。
PluginPromptServiceTask<Dictionary<string, object?>?> Prompt(string title, IEnumerable<PluginConfigField> fields, ...)スキーマに基づいて自動生成される軽量なモーダル入力ダイアログを表示。
PluginMessageBoxServiceMessageBoxResult Show(string messageBoxText, string caption, MessageBoxButton button, MessageBoxImage icon, MessageBoxResult defaultResult)ホスト管理のメッセージボックスを表示し、プラグインがホストのテーマ UI を利用できるようにします;ホストのハンドラーが未登録の場合はシステムのメッセージボックスへフォールバックします。
ExplorerServicevoid OpenDirectory(string directoryPath, string? fileNameOrFilePath = null)指定されたディレクトリを開くかファイルを特定し、ホスト設定のサードパーティ製ファイルマネージャー(またはエクスプローラーのタブ)を尊重します。未設定時はシステムのエクスプローラーにフォールバックします。

SettingsSearchService.GetEntries() が返す項目のインデックスは、現在のホストプロセス内でのみ有効です。項目をそのまま SettingsWindowService.ShowEntry(...) に渡すと、SDK はホストのコールバックを呼び出し、lertaro:// URI の生成や起動は行いません。

HistoryEntryKeywordPathKindTime(Unix 秒)、Count(項目を開いた回数)を公開します。HistoryService.GetHistoryEntries() は最後に開いた項目から順に返します。

コンポーネントの有効状態と高コストなランタイム状態

PluginSettingsService.IsComponentEnabled(...) はホストが管理するコンポーネント単位のスイッチを読み取ります。ディレクトリ監視、バックグラウンドワーカー、外部ランタイム、その他の高コストな状態を所有するコンポーネントは、その状態を初期化する前にスイッチを確認し、ComponentEnablementChanged を購読してユーザーがスイッチを変更したときに対応するランタイムを開始または停止してください。ホストのコールバックが登録されていない場合、またはコールバックが失敗した場合、このメソッドは true を返すため、完全なホストの外でもプラグインを利用できます。

2. Windows Shell ファイル操作ヘルパー

Lertaro.PluginSdk.Shell.FileOperations は Windows Shell の IFileOperation COM インターフェイスをラップしており、進捗ダイアログ、上書き確認、Ctrl+Z 元に戻す操作をネイティブにサポートします。

csharp
namespace Lertaro.PluginSdk.Shell.FileOperations;

// 複数ファイルの一括貼り付け・移動
public static class ShellPasteHelper
{
    public static void PasteAsync(
        IEnumerable<string> sourcePaths,
        string destinationFolder,
        bool move = false,
        Action? onCompleted = null);
}

// ごみ箱への安全な削除または完全削除
public static class ShellDeleteHelper
{
    public static void DeleteAsync(IEnumerable<string> paths, bool permanent = false);
}

// 存在するファイルまたはフォルダー 1 件の名前を変更
public static class ShellRenameHelper
{
    public static void RenameAsync(string path, string newName);
}

// ドラッグ&ドロップされた仮想ファイルストリームの抽出
public static class VirtualFileExtractor
{
    public static bool HasVirtualFiles(IDataObject dataObject);
    public static Task<IReadOnlyList<string>> Extract(IDataObject dataObject, string targetFolder);
    public static string ResolveDestination(string folder, string name); // 重複時の (2) 自動付与
}

TIP

上記の Shell ヘルパーは SDK 内部の専用 STA スレッド(ShellOperationStaWorker)で非同期実行されるため、呼び出し元で COM アパートメントスレッドを意識する必要はありません。

3. アプリケーションのライフサイクルとテーマ対応プラグインウィンドウ

AppLifecycleService.RequestRestart() はホストに正常な再起動を要求します。ホストは後継プロセスを起動し、現在のインスタンスが通常の終了処理を完了してから終了するため、プラグインが実行ファイルを起動したりホストを終了したりする必要はありません。ホストが要求を受け付けた場合は true を返します。

プラグイン独自の WPF コンテンツには、Lertaro.PluginSdk.Windows.PluginWindow がホストと同じ角丸テーマのウィンドウフレームを提供します。ContentHostControl.Content にプラグインのビューを設定し、Footer から下部ボタンを追加できます。通常のタスクバーウィンドウには PluginWindowMode.Window、最前面に表示し Alt+Tab から隠すダイアログには PluginWindowMode.Dialog を使用します。アイコンを省略するとホストの既定のアプリアイコンが使われます。

csharp
var window = new PluginWindow("ツール", 720, 470, PluginWindowMode.Dialog);
window.ContentHostControl.Content = new MyView();
window.Footer.Children.Add(new Button { Content = "OK", IsDefault = true });
window.ShowDialog();