2.15. Lua スクリプト

コンテンツ

1. はじめに

2. 必要なDLL

3. Double Commander ライブラリ

3.1. DC ライブラリ

3.1.1. DC.ExecuteCommand 使用例

3.2. システムライブラリ

3.2.1. SysUtils.FileGetAttr 戻り値詳細

3.2.2. SysUtils.FileGetAttr 使用例

3.2.3. FindFirst、FindNext、FindClose 使用例

3.3. クリップボードライブラリ

3.3.1. クリップボードライブラリ使用例

3.4. ダイアログライブラリ

3.4.1. Dialogs.MessageBox 表示ボタン

3.4.2. Dialogs.MessageBox ウィンドウスタイル

3.4.3. Dialogs.MessageBox デフォルトアクティブボタン

3.4.4. Dialogs.MessageBox 戻り値

3.4.5. Dialogs.MessageBox 使用例

3.4.6. Dialogs.InputQuery 使用例

3.5. UTF-8 ライブラリ

3.6. 文字ライブラリ

3.7. オペレーティングシステムライブラリ

4. インデックス

1. はじめに

Lua スクリプトプログラミング言語の詳細については、Lua Webサイトをご覧ください。

Double Commander は cm_ExecuteScript コマンドで Lua スクリプトを実行できます。
スクリプトパラメータはエスケープせずにそのまま渡す必要があります（引用符や「\」は不要）。このためには %"0 変数を使用する必要があります。例えば、カーソル下のファイルには %p0 ではなく %"0%p0 を、現在のディレクトリには %D ではなく %"0%D を使用します。そうしないと、Double Commander が自動的に引用符を追加し、それらがパラメータの一部として渡されてしまうため、その点を考慮する必要があります。
すべての選択されたファイルのリストを取得するには、変数（%LU、%FU、または %RU）または内部コマンド（cm_SaveSelectionToFile、cm_SaveFileDetailsToFile、cm_CopyFullNamesToClip、または cm_CopyFileDetailsToClip）を使用できます。 たとえば、%p を使用できます。この場合、Double Commander はすべての選択されたファイル名を1行にスペース区切りで渡します。

Lua スクリプトを使用してコンテンツプラグインを作成することも可能です。例はプログラムフォルダ内にあります（plugins/wdx/scripts）。 プラグイン作成専用のページが Wiki にあります。 制限事項：以下のデータ型のみサポートされています

• ft_numeric_32 (1) – 32ビット符号付き数値；
• ft_numeric_64 (2) – 64ビット符号付き数値；
• ft_numeric_floating (3) – 浮動小数点数；
• ft_boolean (6) – ブール型：true または false；
• ft_multiplechoice (7) – 限定的な選択肢の値；
• ft_string (8) – テキスト文字列；
• ft_fulltext (9) – 全文（複数のテキスト文字列）、プラグイン検索専用；
• ft_datetime (10) – 日付/時刻：返される日付は書式化された日付と時刻の文字列に変換されます（値はロケール設定によります）。
  日付は Windows 形式である必要がありますが、ファイル検索用に Lua および Double Commander が提供する関数は Unix 時間形式を使用します。変換には以下の式を使用できます：
  = UnixTime * 10000000 + 116444736000000000
  これは大きな数値であるため、64ビット版の Double Commander または Lua 5.3+ が必要です。

上記リストはヘッダーファイル内の名前を含んでおり、Lua スクリプトでは括弧内に指定された数値を使用する必要があります。

テキストエンコーディングについて

以下に記述されているすべての追加関数は、UTF-8 エンコードされた文字列パラメータを受け入れ、このエンコーディングの文字列を返します（LazUtf8.ConvertEncoding 関数を除く）。

いくつかの標準 Lua ライブラリの関数は、Double Commander または Free Pascal/Lazarus の関数に置き換えられている（または新しい関数が作成されている）ため、UTF-8 サポートが提供されます。

プラグインを作成する際には、テキストデータにも UTF-8 を使用すべきです（ft_multiplechoice、ft_string、および ft_fulltext）。

スクリプトを保存する際は、BOMなしの UTF-8 エンコーディングを使用してください。

注意事項

Lua を使用した自動化には大きな可能性がありますが、状況によっては注意すべき詳細があります。このセクションでそれらを集めてみましょう。

1. 自動更新および別スレッドでファイルリストを読み込むオプションが有効になっている場合、更新機能は非同期で動作します。同時に、スクリプトは Double Commander のメインスレッドで実行されるため、場合によってはこれらすべてがスクリプトの実行に影響を与えることがあります。例えば、連続してナビゲーションコマンドを実行しても機能しないことがあります（大きなディレクトリや遅いディスクなど）。このような場合は、別スレッドでファイルリストを読み込むを無効にするか、代替案を探すことを試みてください。

スクリプトが現在のパネルで新しいファイルを作成したり既存のファイルを名前変更したりした後、いくつかの追加操作（ファイル選択やカーソル移動など）を完了せずに終了した場合、場合によってはこれらの操作が反映されません。すべてのファイルがパネルに表示されていない可能性があるため、まずcm_Refreshコマンドを呼び出す必要があります。前述の条件では、cm_Refreshも非同期で実行されるため、Double Commander が変更後にファイルリストを完全に更新する時間が足りないことがあります。

自動更新と別スレッドでのファイルリスト読み込みはファイルマネージャーにとって便利な機能ですが、安定した動作方法を見つけるために実験を行い、一時的にプログラムに制御を戻し、ファイルリストが完全に更新されるのを待つことが推奨されます：

DC.ExecuteCommand("cm_Refresh")
i = 10
while i > 0 do
  SysUtils.Sleep(10)
  DC.ExecuteCommand("")
  i = i - 1
end

2. Lua 関数 io.open は標準 C 関数 fopen を使用します。テキストモードでは、この関数は読み書き時に改行コードの種類（CRLF、LF、または CR）を変換する可能性があり、予期せぬ結果を招くことがあります。異なる改行コードを持つファイルを扱う場合やクロスプラットフォームスクリプトを書く場合は、これを考慮する必要があります。より現実的な解決策としては、バイナリモードを優先的に使用することです。

3. Linux および他の Unix 系オペレーティングシステムでは、ファイル属性ダイアログボックスにおいて、ContentGetValue 関数を呼び出す際に CONTENT_DELAYIFSLOW フラグ（第4引数、値は1）が設定されます。これによりウィンドウを開く際の遅延を回避できます。データ取得が遅い場合、単純にフラグ値チェックを追加し、これらのフィールドまたはプラグインに対して nil を返すことで、これらのデータを除外できます。

4. プラグインが空の文字列を返すべき場合、"" を渡すよりも nil を渡す方が高速です。

（トップに戻る）

2. 必要なDLL

Lua スクリプトファイルを解釈できるようにするには、Lua DLL ファイルが必要です。Double Commander はバージョン 5.1 - 5.4 をサポートしています。

LuaJIT プロジェクトからの DLL ファイルを使用できます。LuaJIT はアセンブリで書かれた高速インタープリターと高度な JIT コンパイラーを組み合わせています。さらに、FFI ライブラリも利用可能になり、純粋な Lua コードから外部 C 関数を呼び出し、C データ構造を使用できます。

Windows 版の DC にはデフォルトで Lua DLL が含まれています（DC 0.9.7 以降では LuaJIT プロジェクトからのもの）。その他の環境では、パッケージマネージャーで検索・インストールするか、自分でコンパイルする必要があります。64ビット版の DC を使用している場合、DLL も 64ビット版である必要があります。

デフォルトでは、DC はそのディレクトリとシステムディレクトリ内で lua5.1.dll（Windows）、liblua5.1.so.0（Unix または GNU/Linux）、または liblua5.1.dylib（macOS）という名前のファイルを探します。使用する Lua ライブラリファイルパラメータでファイル名（およびパス）を変更できます。

（トップに戻る）

3. Double Commander ライブラリ

Double Commander は Lua スクリプト用のいくつかのライブラリを提供します。

以下がそれらのライブラリのリストです。

（トップに戻る）

3.1. DC ライブラリ

このライブラリには Double Commander 固有の関数が含まれています。

すべての関数は DC テーブルで提供されます。

内部コマンドに加えて、スクリプトでは特別なコマンド cm_ExecuteToolBarItem を使用できます。このコマンドにより識別子を通じてツールバーボタンを呼び出すことができます（プログラム内では、この機能によりツールバーボタンにショートカットキーを使用できます）。このコマンドは通常の内部コマンドと同様に使用されます（以下の例を参照）が、以下のパラメータを持ちます：

一意の識別子は ID タグに保存されます。それを取得する方法はいくつかあります：doublecmd.xml ファイルやツールバーのバックアップファイルでボタンを見つけるか、またはボタンをクリップボードにコピーし、テキストエディタでそのコードを貼り付けることができます。

注意：識別子は自動生成されるため、プログラムの別のコピーにある類似のボタンの識別子と一致する必要はありません。しかし、必要に応じて独自の値を手動で設定できます。

（トップに戻る）

3.1.1. DC.ExecuteCommand 使用例

この例では、以下の操作を行う簡単なスクリプトを作成します：

1. 右パネルにフォーカスを当てる
2. すべての開いているタブを閉じる
3. 特定のフォルダに移動
4. 左パネルにフォーカスを当てる
5. すべての開いているタブを閉じる
6. 特定のフォルダに移動
7. 新しいタブを開く
8. 特定のフォルダに移動

-- 1. 右パネルにフォーカスを当てる。
DC.ExecuteCommand("cm_FocusSwap", "side=right")

-- 2. すべてのタブを閉じる。
DC.ExecuteCommand("cm_CloseAllTabs")

-- 3. 特定のディレクトリに移動。
DC.ExecuteCommand("cm_ChangeDir", "E:\\FakeKey\\Documents\\Music")

-- 4. 左パネルにフォーカスを当てる。
DC.ExecuteCommand("cm_FocusSwap", "side=left")

-- 5. すべてのタブを閉じる。
DC.ExecuteCommand("cm_CloseAllTabs")

-- 6. 特定のディレクトリに移動。
DC.ExecuteCommand("cm_ChangeDir", "C:\\Users\\Public\\Music")

-- 7. 新しいタブを開く。
DC.ExecuteCommand("cm_NewTab")

-- 8. 特定のディレクトリに移動。
DC.ExecuteCommand("cm_ChangeDir", "E:\\VirtualMachines\\ShareFolder")

内部コマンド cm_ExecuteScript を使用することで、ツールバーボタンを設定してスクリプトを実行できます。

このスクリプトファイルが E:\scripts\lua\music.lua であると仮定すると、次のようにボタンを設定できます：

さらに、Double Commander 内蔵エディタを使用してスクリプトを編集できます。ファイル名が .lua 拡張子を持っている場合、内蔵エディタはそれを認識し、Lua 言語用の構文ハイライトを提供します：

（トップに戻る）

3.2. システムライブラリ

このライブラリには各種システム関数が含まれています。

すべての関数は SysUtils テーブルで提供されます。

（トップに戻る）

3.2.1. SysUtils.FileGetAttr 戻り値の詳細

FileGetAttr はファイル sFileName の属性設定を返します。

属性は以下の定数の OR 組み合わせです：

次のセクションの例をご参照ください。

（トップに戻る）

3.2.2. SysUtils.FileGetAttr 使用例

以下のスクリプトは SysUtils.FileGetAttr の使用例です。

引数がディレクトリであることを検出した場合、アクティブパネルで新しいタブを開き、そのディレクトリに移動します。

local params = {...}
local iAttr

if #params == 1 then -- 最低でも一つの引数を受け取ったか？
  iAttr = SysUtils.FileGetAttr(params[1])
  if iAttr > 0 then -- 有効な属性を取得できたか？
    if math.floor(iAttr / 0x00000010) % 2 ~= 0 then
      -- 4番目のビットがセットされているか？つまりディレクトリである。
      DC.ExecuteCommand("cm_NewTab")
      DC.ExecuteCommand("cm_ChangeDir", params[1])
    end
  end
end

上記の例では、params[1] はスクリプトに渡される最初の引数です。

内部コマンド cm_ExecuteScript を使用する際、これはスクリプトファイル名の後に渡される最初の引数となります。

そのため、この例では以下のようにツールバーボタンを設定できます：

この例では、引数 %"0%p がスクリプトに渡されます。これは現在のアクティブパネルで選択されたアイテムのファイル名を引用符なしで表します。

（トップに戻る）

3.2.3. FindFirst、FindNext、FindClose の使用例

以下のスクリプト例では、引数で受け取ったディレクトリの内容をスキャンし、結果データを第二引数で渡されたファイル名のテキストファイルに保存します。

これにより、FindFirst、FindNext、FindClose の使い方をよく理解できます。

local params = {...}

if #params == 2 then -- 二つの引数を受け取ったか？
  local Result = nil
  local hOutputFile = nil

  hOutputFile = io.output(params[2])

  local Handle, FindData = SysUtils.FindFirst(params[1] .. "\\*")
  if Handle ~= nil then
    repeat
      io.write(FindData.Name .. "\r")
      io.write(FindData.Size .. "\r")
      io.write("---------------\r")

      Result, FindData = SysUtils.FindNext(Handle)
    until Result == nil

    SysUtils.FindClose(Handle)
    io.close(hOutputFile)
  end
end

上記の例では、スクリプトに二つの引数を渡す必要があります：

1. params[1] - 内容を取得したいディレクトリ
2. params[2] - 結果を保存する出力ファイル名

したがって、内部コマンド cm_ExecuteScript を使用してツールバーボタンを設定し、引数を渡すことで簡単に実行できます。

この例では、引数 %"0%Ds がスクリプトの第一引数として渡されます。これはアクティブパネルに表示されているディレクトリを引用符なしで表します。

（トップに戻る）

3.3. クリップボードライブラリ

Double Commander は、Lua スクリプトに外部クリップボード機能を提供できます。

関連する関数は以下の表の通りです:

（トップに戻る）

3.3.1. クリップボードライブラリ使用例

以下の例では、クリップボードに関連する3つの関数：Clear、GetAsText、および SetAsText を使用しています。

これは比較的長いスクリプトですが、上で見たいくつかの関数をうまく組み合わせています。

これは、アクティブパネルが多数のソーステキストファイルを含むディレクトリにあることを前提としています。

また、現在クリップボードに単語があり、現在のアクティブフォルダを単一の引数として受け取ることを前提としています。

スクリプトは現在のディレクトリレベルのファイルをスキャンし、それぞれの内容を1行ずつ読み込んで、クリップボード内の単語を含むテキスト行を検出します。

その後、少なくとも1行その単語を含むファイル名がクリップボードに配置されます。

そして、スクリプトは内部コマンド cm_LoadSelectionFromClip を使用し、その単語を含むファイルが選択されます。

さらに最後に、検索が必要な元の単語をクリップボードに戻します。

local params = {...}
local Result = nil
local iAttr
local bFound = false
local sCompleteFilename = ""
local hInputFile = nil
local sLine = ""
local iPosS
local iPosE
local sFileToSelect = ""
local sSearchString = ""

if #params == 1 then -- 引数を受け取ったか？
  sSearchString = Clipbrd.GetAsText() -- 検索する表現を取得。
  Clipbrd.Clear() -- クリップボードに何も残っていないことを確認。
  DC.ExecuteCommand("cm_MarkUnmarkAll") -- 何も選択されていないことを確認。

  -- ディレクトリ内のすべてのファイルを1つずつスキャンしましょう。
  local Handle, FindData = SysUtils.FindFirst(params[1] .. "\\*")
  if Handle ~= nil then
    repeat
      sCompleteFilename = params[1] .. "\\" .. FindData.Name
      iAttr = SysUtils.FileGetAttr(sCompleteFilename)
      if iAttr > 0 then -- 有効な属性を取得したか？
        -- ディレクトリではなくファイルが必要です！
        if math.floor(iAttr / 0x00000010) % 2 == 0 then

          -- 今度はファイルを1行ずつ読み込んで、終了または見つかるまで続けます。
          hInputFile = io.open(sCompleteFilename, "r")
          bFound = false

          while bFound == false do
            sLine = hInputFile:read()
            if sLine == nil then break end
            iPosS, iPosE = string.find(sLine, sSearchString)
            if iPosS ~= nil then bFound = true end
          end

          if bFound == true then
            sFileToSelect = sFileToSelect .. FindData.Name .. "\n"
          end

          io.close(hInputFile)
        end
      end
      Result, FindData = SysUtils.FindNext(Handle)
    until Result == nil

    SysUtils.FindClose(Handle)
  end

  -- 何か見つけたら、それを選択しましょう！
  if sFileToSelect ~= "" then
    Clipbrd.SetAsText(sFileToSelect)
    DC.ExecuteCommand("cm_LoadSelectionFromClip")
  end

  Clipbrd.SetAsText(sSearchString) -- クリップボードの内容を復元。
end

（トップに戻る）

3.4. ダイアログライブラリ

このライブラリにより、スクリプトはユーザーと対話でき、メッセージを表示し、回答の入力を求めることができます。

関連する関数は以下の表にリストされています:

（トップに戻る）

3.4.1. Dialogs.MessageBoxに表示されるボタン

Dialogs.MessageBox関数に表示されるボタンは、以下の定数のビット単位のOR値で制御されます：

Dialogs.MessageBoxボタン表示のButFlags定数
定数値	表示されるボタン（左から右へ）
0x0000 MB_OK
0x0001 MB_OKCANCEL
0x0002 MB_ABORTRETRYIGNORE
0x0003 MB_YESNOCANCEL
0x0004 MB_YESNO
0x0005 MB_RETRYCANCEL

（トップに戻る）

3.4.2. Dialogs.MessageBoxのウィンドウスタイル

Dialogs.MessageBox関数に表示されるウィンドウスタイルは、以下の定数のビット単位のOR値で制御されます：

Dialogs.MessageBoxアイコンとスタイルのButFlags定数
定数値	ウィンドウスタイル
0x0040 MB_ICONINFORMATION	情報ウィンドウ
0x0030 MB_ICONWARNING	警告ウィンドウ
0x0020 MB_ICONQUESTION	確認ウィンドウ
0x0010 MB_ICONERROR	エラーウィンドウ

（トップに戻る）

3.4.3. Dialogs.MessageBoxのデフォルトアクティブボタン

Dialogs.MessageBox関数に表示されるデフォルトアクティブボタンは、以下の定数のビット単位のOR値で制御されます：

（トップに戻る）

3.4.4. Dialogs.MessageBoxの戻り値

Dialogs.MessageBox関数が返す数値は、ユーザーが押したボタンを示します：

Dialogs.MessageBoxボタン押下時のButPressed戻り値
定数値	押されたボタン
0x0000 mrNone	ボタンが押されていない
0x0001 mrOK
0x0002 mrCancel
0x0003 mrAbort
0x0004 mrRetry
0x0005 mrIgnore
0x0006 mrYes
0x0007 mrNo

注意：右上の「×」をクリックするか、Escキーでウィンドウを閉じた場合、「キャンセル」ボタンの値が返されます。

（トップに戻る）

3.4.5. Dialogs.MessageBox 使用例

以下は Dialogs.MessageBox を使用した小さなスクリプトと、表示される結果ウィンドウの例です：

-- 表示ボタン
MB_OK = 0x0000
MB_OKCANCEL = 0x0001
MB_ABORTRETRYIGNORE = 0x0002
MB_YESNOCANCEL = 0x0003
MB_YESNO = 0x0004
MB_RETRYCANCEL = 0x0005

-- ウィンドウスタイル
MB_ICONINFORMATION = 0x0040
MB_ICONWARNING = 0x0030
MB_ICONQUESTION = 0x0020
MB_ICONERROR = 0x0010

-- デフォルトボタン
MB_DEFBUTTON1 = 0x0000
MB_DEFBUTTON2 = 0x0100
MB_DEFBUTTON3 = 0x0200

-- 押されたボタンの戻り値
mrNone = 0x0000
mrOK = 0x0001
mrCancel = 0x0002
mrAbort = 0x0003
mrRetry = 0x0004
mrIgnore = 0x0005
mrYes = 0x0006
mrNo = 0x0007

iFlags = MB_YESNO + MB_ICONQUESTION + MB_DEFBUTTON2
iButton = Dialogs.MessageBox("終了しますか？", "質問", iFlags)

if iButton == mrYes then
  DC.ExecuteCommand("cm_Exit")
end

（トップに戻る）

3.4.6. Dialogs.InputQuery 使用例

以下は Dialogs.InputQuery を使用した小さなスクリプトと、表示される結果ウィンドウの例です：

bResult, sAnswer = Dialogs.InputQuery("認証", "お名前を入力してください：", false, "ジョン")

if bResult == true then
  Dialogs.MessageBox("こんにちは " .. sAnswer .. "さん！", "ようこそ！", 0x0040)
end

（トップに戻る）

3.5. UTF-8 ライブラリ

このライブラリは UTF-8 エンコーディングの基本的なサポートを提供します。

すべての関数は LazUtf8 テーブルで提供されます。

-- "位置 : 文字" の形式で値のペアを出力
for iPos, sChar in LazUtf8.Next(String) do
  DC.LogWrite(iPos .. " : " .. sChar)
end

（トップに戻る）

3.6. 文字ライブラリ

このライブラリには、文字が特定の Unicode カテゴリに属するかどうかをチェックする関数と、文字のカテゴリを取得する関数が含まれています。

このライブラリで利用可能な関数の一覧です：

さらに、これらの関数は2つの引数を使用することもできます：単一の文字ではなく、文字列とその文字列内の文字の位置を指定できます。

（トップに戻る）

3.7. オペレーティングシステムライブラリ

このライブラリには、Double Commander が実行されているオペレーティングシステムに関連する関数が含まれています。

このライブラリで利用可能な関数の一覧です：

（トップに戻る）

4. インデックス

（トップに戻る）   it365ツールボックス