トップ > Script-Fuスクリプトの制作 >
Script-Fuプログラミングの基礎を学ぶ(その2)

では、利用者に2つの数値を入力させ、それを合計して表示するスクリプトを作成してみましょう。 スクリプトファイル myscript.scm を以下のように書き換えてください。

では、スクリプトを実行しましょう。 プルダウンメニューの"フィルター(R) -> My Script"を実行します。

1. 入力ダイアログが表示される

上図のように入力ダイアログが表示されます。 "Enter Number 1" と "Enter Number 2" という見出しの項目があり、それぞれ 2 と 7 が初期表示されています。

2. 数値を変更する

上図のように "Enter Number 1" と "Enter Number 2" の数値を変更します。 上の例では、 11 と 47 に変更しています。 変更したら[OK(O)]ボタンを押します。

3. メッセージダイアログが出現し "Number is 58" と表示される

上図のようにメッセージダイアログが出現し "Number is 58" と表示されます。 入力した2つの数値が加算されています。

それでは、今回のスクリプトを詳しく見ていきましょう。 最初に注目すべき点は、1行目の、

(define (myscript innumber1 innumber2)

という部分です。 利用者が入力した2つの数値を受け取るための引数 innumber1 と innumber2 が定義されています。

なお、引数に画像番号は受け取っていません。 このスクリプトは画像にはアクセスしないからです。

次の注目点は、25・26行目の、

SF-VALUE    "Enter Number 1"    "2" ; 入力ダイアログからの入力値その1
SF-VALUE    "Enter Number 2"    "7" ; 入力ダイアログからの入力値その2

という2行です。 手続き script-fu-registerに渡している引数の一部になります。

前の記事でも説明したように、手続き script-fu-registerに渡す引数は最小で7つ(7行)です。 つまり、今回のスクリプトでは引数が2行ほど多いです。 引数の数でいえば、

1. SF-VALUE
2. "Enter Value 1"
3. "2"
4. SF-VALUE
5. "Enter Value 2"
6. "7"

のように6つ増えています。

これも前の記事で解説しましたが、手続き script-fu-registerに渡す引数は3ずつ増えます。

今回のスクリプトは利用者が入力した2つの数値を受け取りますから、2 x 3で6個の引数が増えたというわけです。 増えた6つの引数の意味は以下の通りです。

なお、スクリプトが受け取る引数の型 SF-VALUE の意味は以下の通りです。

スクリプトの記述で注目すべきは以上です。 それ以外で目新しいものはありません。

SF-VALUE    "Enter Number 1"    "2" ; 入力ダイアログからの入力値その1
SF-VALUE    "Enter Number 2"    "7" ; 入力ダイアログからの入力値その2

続いては、利用者にファイルを選択させてみましょう。 ファイルが選択されればファイル名を表示し、選択されなければ選択を促す警告を表示します。

では、スクリプトファイル myscript.scm を以下のように書き換えてください。

では、スクリプトを実行しましょう。 プルダウンメニューの"フィルター(R) -> My Script"を実行します。

1. 入力ダイアログが表示される

上図のように入力ダイアログが表示されます。 ファイル名を選択・確認するための入力欄 "Open File" が表示されています。

現状、"(なし)" となっており、まだ何のファイルも選択されていないことがわかります。 では、何もファイルを選択せずに[OK(O)]ボタンを押してください。

2. メッセージダイアログに "読み込むファイルを指定してください。" と表示される

上図のようにメッセージダイアログに "読み込むファイルを指定してください。" と表示されます。 ファイルを選択しなかったため、警告が表示されました。

では、もう一度スクリプトを実行してみましょう。 プルダウンメニューの"フィルター(R) -> My Script"を実行します。

3. 任意のファイルを選択する

上図のように何でもいいので任意のファイルを選択します。 選択したら[OK(O)]ボタンを押してください。

4. メッセージダイアログに選択したファイルが表示される

上図のようにメッセージダイアログに選択したファイルが表示されます。

それでは、今回のスクリプトを詳しく見ていきましょう。 まず目を引くのが20行目の、

SF-FILENAME "Open File" "/dummy"    ; 入力ダイアログで選択されたファイル名

の部分です。 新たな引数の型である SF-FILENAME が登場しています。 名前からもわかるように、これはファイル名を受け渡すための型です。

なお、SF-FILENAME に続く引数の "Open File" は、入力ダイアログでのラベルです。 さらに続く "/dummy" はファイル名の初期値です。

なぜ、ファイル名の初期値が空文字である "" ではダメなのか、なぜ先頭に "/" (スラッシュ) が付いているのかについては後ほど解説します。

続いて注目すべきは2行目の、

(if (or (string=? openfile "/dummy") (string=? openfile "\\dummy"))

という制御文です。 引数 openfile(つまり利用者が選択したファイル名)が "/dummy" または "\\dummy" かどうかを判断しています。

ファイル名の初期値は "/dummy" ですので、渡された引数が "/dummy" であれば利用者はファイルを選択していないことになります。

ファイルは未選択だとみなされると、

(gimp-message "読み込むファイルを指定してください。")

が実行されます。 条件を満たさなかった場合(つまり、ファイルが選択されている場合)は、

(gimp-message (string-append "読み込むファイルは" openfile "です。"))

が実行されます。

スクリプトの解説は以上になります。 20行目の、

SF-FILENAME "Open File" "/dummy"    ; 入力ダイアログで選択されたファイル名

の3つ目の引数が "/dummy" となっていること以外は難しいことはありません。

ではここで、スクリプト実行時の流れを見てみましょう。 スクリプト実行時に何が起きているのでしょうか。

スクリプトが実行されると、まずは入力ダイアログが表示されます。 入力ダイアログが表示されるのは、手続き script-fu-registerに、

SF-FILENAME "Open File" "/dummy"    ; 入力ダイアログで選択されたファイル名

という3つの引数が渡されているためです。

最初の引数の SF-FILENAME により、ファイルを選択するための入力欄が作られます。 2つ目の引数によりラベルは "Open FIle" になります。 問題は、ファイルを選択するための入力欄に表示されるファイル名です。

3つ目の引数に "/dummy" と記述していますが、ここで指定したものがそのままファイル名として表示されるわけではありません。 なぜなら最上位フォルダに "dummy" というファイルは存在しないからです。 存在しないファイル名を渡すと、"(なし)" と表示されます。

なお、入力ダイアログの表示上で "(なし)" と表示されているだけで、GIMPは "/dummy" というファイル名を保持しています。 利用者への表示上で "(なし)" となっているだけです。

この状態、つまりファイルは選択しないまま[OK(O)]ボタンを押したものとして話を進めます。

[OK(O)]ボタンが押されると、GIMPは保持しているファイル名にフォルダの区切り文字が含まれているかどうかを調べます。 フォルダの区切り文字は /(スラッシュ) または \(円マーク) です。 UNIX系OSかWindowsかは考慮せずに判断します。

フォルダの区切り文字が含まれているなら、保持しているファイル名をそのままスクリプトに渡します。 なお、Windows上で実行されているなら /(スラッシュ) を \(円マーク) に変換して渡します。

つまり、UNIX系OSなら "/dummy" が渡され、Windowsなら、"\\dummy" が渡されます。 これにより2行目の、

(if (or (string=? openfile "/dummy") (string=? openfile "\\dummy"))

という制御文で、利用者がファイルを選択していないことがわかるのです。

では、利用者がファイルを選択した場合の流れも見ておきましょう。 利用者がファイルを選択してから[OK(O)]ボタンを押したとします。

この場合も同じように、GIMPは保持しているファイル名にフォルダの区切り文字が含まれているかどうかを調べます。

利用者がファイルを選択した場合は、フォルダの区切り文字は必ず含まれます。 GIMPの『ファイルの選択(Script-Fu)』ダイアログがそのように作られているからです。

フォルダの区切り文字が含まれているので、保持しているファイル名がそのままスクリプトに渡されます。 なお、Windows上で実行されているなら /(スラッシュ) が \(円マーク) に変換されてから渡されます。

SF-FILENAME "Open File" "/dummy"    ; 入力ダイアログで選択されたファイル名

(if (or (string=? openfile "/dummy") (string=? openfile "\\dummy"))

続いては、利用者にフォルダを選択させてみましょう。 加えて、選択されたフォルダに置かれているXCFファイルを探し、ファイル名を列挙します。

では、スクリプトファイル myscript.scm を以下のように書き換えてください。

では、スクリプトを試してみましょう。

このスクリプトは、指定されたフォルダに置かれているXCFファイルを探してファイル名を列挙するためのものです。 よって、最初にテスト用のXCFファイルを準備しておく必要があります。

1. XCFファイルを準備する

上図のように任意のフォルダに複数のXCFファイルを準備します。 今回の例では "夏祭り.xcf" / "花火大会.xcf" / "満月.xcf" の3ファイルです。

では、スクリプトを実行しましょう。 プルダウンメニューの"フィルター(R) -> My Script"を実行します。

2. 入力ダイアログが表示される

上図のように入力ダイアログが表示されます。 フォルダ名を選択・確認するための入力欄 "Load from" が表示されています。

なお、"On Window?" はWindowsで実行しているかどうかをスクリプトに伝えるためのものです。

3. 任意のフォルダを選択する

上図のようにテスト用のXCFファイルを配置したフォルダを選択します。 選択したら[OK(O)]ボタンを押してください。

4. メッセージダイアログに見つかったXCFファイルが列挙される

上図のように指定されたフォルダに置かれているXCFファイルが列挙されました。 やりました、成功です。

それでは、今回のスクリプトを詳しく見ていきましょう。 まず目を引くのが52・53行目の、

SF-DIRNAME  "Load from"     ""      ; 入力ダイアログで選択されたフォルダ名
SF-TOGGLE   "On Windows?"   FALSE   ; 入力ダイアログでオン・オフされた値

の部分です。 新たな引数の型である SF-DIRNAME と SF-TOGGLE が登場しています。 SF-DIRNAME はフォルダ名を受け渡すための型で、SF-TOGGLEはオン・オフ状態を受け渡すための型、つまりチェックボックスです。

続いて注目すべきは11行目から18行目の、

(if (= runonwindows TRUE)
    (begin
        (set! filepattern (string-append loadfrom "\\*.xcf"))
    )
    (begin
        (set! filepattern (string-append loadfrom "/*.xcf"))
    )
)

という制御文です。 検索するファイルのパタンとなる文字列を生成しています。

入力ダイアログの "On Windows?" のチェックボックスがオンなら、

(set! filepattern (string-append loadfrom "\\*.xcf"))

の行が実行され、

(set! filepattern (string-append loadfrom "/*.xcf"))

の行が実行されます。 つまり、Windowsかどうかで処理を分けています。

すでに説明したように、UNIX系OSとWindowsではフォルダの区切り文字が異なります。 OSによってフォルダの区切り文字を変えるため、制御文で処理を分けています。

生成したパタン(変数 filepattern)と一致するファイルを検索しているのが、20行目の、

(set! matchedfilelist (cadr (file-glob filepattern 1)))

という行です。 手続き file-globがファイルを検索するための手続きになります。

手続き file-globにファイルのパタン(変数 filepattern)を渡し、2つ目の戻り値を変数 matchedfilelistに格納しています。

手続き file-globからの戻り値は、1つ目が見つかったファイル件数で2つ目がファイル名の一覧です。

なお、2つ目の戻り値(ファイル名の一覧)はベクタではなくリストです。

今回の例の場合には、手続き file-globからの戻り値を入れ子のコンスセルで表現すると、

となります。

つまり、変数 matchedfilelistに格納したデータはリスト、というわけです。 変数 matchedfilelistの内容を入れ子のコンスセルで表現すると、

となります。

変数 matchedfilelistに格納したファイル名の一覧を処理しているのが、24行目から38行目の、

(while (not (null? matchedfilelist))
    (set! matchedfilename (car matchedfilelist))

    (if (> matchedfilecount 0)
        (begin
            (set! message (string-append message "\n"))
        )
    )

    (set! message (string-append message matchedfilename))

    (set! matchedfilecount (+ matchedfilecount 1))

    (set! matchedfilelist (cdr matchedfilelist))
)

の部分です。 繰り返しの条件が、

(not (null? matchedfilelist))

となっていますが、これは『リストが空でない間は繰り返す』という意味になります。

繰り返しの内側では、25行目で、

(set! matchedfilename (car matchedfilelist))

という命令によって、検索されたファイル名のリストから最初の情報が取り出されます。 正確に表現すれば、最初のコンスセルのcar部が取り出されます。 繰り返しの1回目であれば、

が取り出されます。

同じく繰り返しの内側となる27行目から31行目の、

(if (> matchedfilecount 0)
    (begin
        (set! message (string-append message "\n"))
    )
)

は、メッセージに改行を足しているだけです。

同じく繰り返しの内側の37行目の、

(set! matchedfilelist (cdr matchedfilelist))

は、とても重要な命令になります。 変数 matchedfilelistの最初のコンスセルのcdr部を取り出し、自分自身に代入しているのです。

実行前の変数 matchedfilelistの内容が、

だとすると、実行後は、

となります。 次の繰り返しで再度実行されると、

となるのです。 つまり、実行される度にリストの先頭の情報が1つずつ消えていくのです。

リストの内容を1件ずつ処理するには、このように自分自身に手続き cdr部を実行するのが手軽で便利です。

(if (= runonwindows TRUE)

(if (= (car (file-glob "/etc/hosts" 1)) 0)