トップ > Script-Fuスクリプトの制作 >
ファイルからスクリプトを読み込ませて実行する(バージョン 3)

前の記事では、Script-Fu コンソールからスクリプトを打ち込みました。 この記事ではファイルにスクリプトを保存し、それをGIMPに読み込ませることで実行させます。 スクリプトの内容は前の記事と同じで、

1. GIMPを終了させる

というだけです。

では、ファイルからスクリプトを読み込ませて実行してみましょう。 ファイルにスクリプトを保存し、それをGIMPに読み込ませることでプルダウンメニューにメニュー項目が追加されます。 追加されたプルダウンメニューのメニュー項目からスクリプトを実行し、GIMPを終了させます。

なお、メニュー項目を追加する場所は、プルダウンメニューの"フィルター(R)"の中です。

まずは、スクリプトファイルを作成します。 メモ帳などのテキストファイルを編集できるアプリケーションを開いてください。

1. '(gimp-quit TRUE)'と記述

上図のようにメモ帳を開き、

と記述します。 前の記事でScript-Fu コンソールに打ち込んだものと同じ内容です。

では、ファイルへ保存しましょう。

2. ファイル(F) -> 上書き保存(S)を実行

上図のようにプルダウンメニューの"ファイル(F) -> 上書き保存(S)"を実行します(またはキーボードのCTRL+Sを押します)。

3. 名前を付けて保存ダイアログ

上図のように『名前を付けて保存』ダイアログが開きますので、(1)のファイル名(N)に "myscript.scm" を指定し、(2)の文字コード(E)に UTF-8 を選択し、(3)の[保存(S)]ボタンを押します。

ファイルへ保存したらメモ帳は閉じて終了し、エクスプローラを開いて保存されたファイルを確認してみましょう。

4. テキストファイルとして保存されている

上図のように "テキスト ドキュメント" として保存されています。 拡張子を ".scm" にして保存したのにテキストファイルとして保存されてしまいました。

これは、メモ帳が "myscript.scm.txt" というファイル名で文書を保存してしまったためです。 つまり、".txt" が自動的に足されたということです。

というわけですので、次の作業はファイル名を "myscript.scm.txt" から "myscript.scm" に変更する作業です。

ただし、Windowsの標準設定では利用者が拡張子を操作することはできません。 まずは、拡張子を操作できるようにする必要があります。

5. 表示タブ -> オプションを実行

上図のようにエクスプローラを開き、上部のメニューにある"表示タブ -> オプション"を実行します。

6. フォルダーオプション

上図のようにフォルダーオプションが開きます。 この画面で、フォルダやファイルの表示に関する設定を調整することができます。

7. 登録されている拡張子も表示させる

上図のように(1)の表示タブに切り替え、(2)の "登録されている拡張子は表示しない" のチェックを外し、(3)の[OK]ボタンを押します。

8. 拡張子を含んだファイル名が表示される

上図のように拡張子も含めたファイル名が表示されるようになりました。 これで、拡張子を操作することができます。

では、ファイル名を "myscript.scm.txt" から "myscript.scm" に変更してください。

9. 拡張子を変更しようとすると警告が表示されるが問題ない

上図のように拡張子を変更しようとすると警告が表示されます。 問題はありませんので[はい(Y)]ボタンを押して続行してください。

10. 拡張子が ".scm" になった

上図のように拡張子が ".scm" になりました。 これで、GIMPがスクリプトファイルとして認識してくれるようになります。

では、この "myscript.scm" ファイルをスクリプトファイル置き場に移動させましょう。 まずは、スクリプトファイル置き場がどこなのか、つまり、GIMPがどのフォルダにスクリプトファイルを探しに行くのかを調べましょう。

GIMPの設定ウィンドウを開きます。

11. 編集(E) -> 設定(P)を実行

上図のようにプルダウンメニューの"編集(E) -> 設定(P)"を実行します。

12. GIMPの設定

上図のようにGIMPの設定ウィンドウが表示されます。 なお、ウィンドウの左側の一覧が設定項目の分類です。

ウィンドウの左側の一覧からフォルダー -> スクリプトを選択します。

13. スクリプト用フォルダを確認する

上図のようにスクリプト用フォルダの一覧が表示されます。 今回の例では2行が表示されていますが、それぞれの意味は以下の通りです。

では、作成したスクリプトファイル "myscript.scm" を調査したフォルダに配置してください。

14. "myscript.scm" を(1)の自分専用のスクリプトファイル置き場へ移動する

上図のように(1)の自分専用のスクリプトファイル置き場へ "myscript.scm" を移動します。

スクリプトを配置したら、GIMPを再起動しましょう。 起動したら、プルダウンメニューの"フィルター(R)"の中のメニュー項目を見てみましょう。

15. メニュー項目には変化がない

上図のようにプルダウンメニューの"フィルター(R)"の中のメニュー項目には変化ありません。 理由はもちろん、スクリプトファイルの記述に間違いがあるからです。

この記事の最初で解説したように、ファイルからスクリプトを読み込ませるとプルダウンメニューにメニュー項目が追加されます。 プルダウンメニューにメニュー項目が追加されるということは、

1. プルダウンメニューのどの位置にメニュー項目を表示させるか
2. メニュー項目のラベルに何と表記するのか

などの情報も必要になります。 しかし、現状ではスクリプトファイルには、

(gimp-quit TRUE)

としか書かれていません。 これでは情報が足りていません。 ファイルからスクリプトを読み込ませる場合は、もっと色々と記述をしなくてはならないのです。

というわけで、スクリプトファイルには修正が必要です。 さっそく、修正しましょう。

16. ファイル(F) -> 開く(O)...を実行

上図のように再度メモ帳を開き、プルダウンメニューの"ファイル(F) -> 開く(O)"を実行します(またはキーボードのCTRL+Oを押します)。

17. スクリプトファイルが表示されない

上図のように "myscript.scm" を配置した場所へ移動してもファイルは見つかりません。 先ほど拡張子を ".scm" に変更したためです。

では、テキストファイルだけでなく、全てのファイルをメモ帳で開けるようにしましょう。

18. ファイルの種類を "すべてのファイル (*.*)" に変更する

上図のようにファイルの種類を "すべてのファイル (*.*)" に変更します。

19. スクリプトファイルも表示されるようになる

上図のようにスクリプトファイル "myscript.scm" も表示されるようになりましたので開きましょう。

20. ファイルが開かれて編集可能な状態になる

上図のようにスクリプトファイルが読み込まれ、編集可能な状態になります。 では、このスクリプトファイルを以下のように書き換えましょう。

変更したらファイルへ保存し、GIMPを起動してください。 起動したら、プルダウンメニューの"フィルター(R)"の中のメニュー項目を確認します。

21. 新たなメニュー項目が増えている

上図のようにプルダウンメニューの "フィルター(R)" の最下部に "My Script" というメニュー項目が追加されています。

メニュー項目がプルダウンメニューの "フィルター(R)" の下に追加されたのはスクリプトの15行目の、

"<Image>/Filters"

という記述によるものです。

また、メニュー項目のラベルの "My Script" という名前はスクリプトの7行目の、

"My Script"

という記述によるものです。

ではここで、増えたメニュー項目の "My Script" にマウスカーソルを乗せ、しばらく乗せたままにしてください。

22. メニュー項目の説明を見ることができる

上図のようにメニュー項目の説明が表示されます。 これは、スクリプトの8行目に、

"自作の練習用スクリプトです"

と記述した結果です。

では、さっそく追加されたメニュー項目 "My Script" を実行してみましょう。

23. フィルター(R) -> My Scriptを実行

上図のようにプルダウンメニューの"フィルター(R) -> My Script"を実行します。 実行した直後に、GIMPが終了したはずです。

やりました、ファイルからスクリプトを読み込ませて実行することができました。

ではここで、今回のスクリプトについて解説します。

まず、このスクリプトには3つの命令があることがわかります。 手続き defineから成る命令と、手続き script-fu-register-procedureから成る命令と、手続き script-fu-menu-registerから成る命令です。 それぞれの手続きの詳細は以下の通りです。

(define (myscript)
    (gimp-quit TRUE)
)

(define (myscript)(gimp-quit TRUE))

(define (myscript)
(gimp-quit TRUE)
)

(define (myscript)
    (gimp-message "こんにちは!!")
    (gimp-quit TRUE)
)

(script-fu-register-procedure
    "myscript"
    "My Script"
    "自作の練習用スクリプトです"
    "My Name"
    "January 1, 2023"
)

(script-fu-register-procedure
    "myscript" "My Script" "自作の練習用スクリプトです" "My Name" "January 1, 2023"
)

(script-fu-register-procedure
    "myscript" "My Script" "自作の練習用スクリプトです"
"My Name" "January 1, 2023"
)

(script-fu-menu-register
    "myscript"
    "<Image>/Filters"
)

GIMP起動時と追加されたメニュー項目の実行時に何が行われているのかを解説しておきます。

(define (myscript)
    (gimp-quit TRUE)
)

(script-fu-register-procedure
    "myscript"
    "My Script"
    "自作の練習用スクリプトです"
    "My Name"
    "January 1, 2023"
)

(script-fu-menu-register
    "myscript"
    "<Image>/Filters"
)

すでに書いたように、手続き script-fu-register-procedureと手続き script-fu-menu-registerの引数は、

(script-fu-register-procedure
    "myscript"
    "My Script"
    "自作の練習用スクリプトです"
    "My Name"
    "January 1, 2023"
)

や、

(script-fu-menu-register
    "myscript"
    "<Image>/Filters"
)

のように引数の全てが二重引用符 (") で囲まれています。 二重引用符で囲まれていることには重要な意味があります。

ただし、今はまだその理由を知る必要はありません。 詳細については別の記事で後ほど説明しますので、今は、

1. 手続き script-fu-register-procedureの引数は " で囲む必要がある
2. 手続き script-fu-menu-registerの引数も " で囲む必要がある

とだけ覚えておいてください。

ファイルからスクリプトを読み込ませて実行する場合には、スクリプトファイル置き場にスクリプトファイルを配置します。 スクリプトファイル置き場は、GIMPの設定ウィンドウで確認することができます。

GIMP起動時にスクリプトファイル置き場からスクリプトファイルが読み込まれ、プルダウンメニューのメニュー項目に追加されます。

スクリプトファイルは文字コード UTF-8 で記述されている必要があり、拡張子は ".scm" でなければなりません。

また、スクリプトファイルは3つの命令から構成されている必要があります。 手続き defineから成る命令と、手続き script-fu-register-procedureから成る命令と、手続き script-fu-menu-registerから成る命令です。

手続き defineで独自の関数を定義し、手続き script-fu-register-procedureでScript-Fuスクリプトとして登録し、手続き script-fu-menu-registerでプルダウンメニューのメニュー項目に追加します。