Tclを対話的に実行する

tclshを引数なしで実行するとTclインタプリタが起動し、Tclコマンドの入力待ち状態になります。この状態でTclコマンドを入力する事で対話的にコマンドを実行する事ができます。

この機能はコマンド動作のちょっとした確認をする際に便利です。しかし、TclインタプリタにはBash(Unixシェル)のようなコマンド履歴機能がなかったり、左右の矢印キーでコマンドライン上を移動できないのでシェルとしては使いやすいとは言えません。

[実行例]

$ tclsh
% set x hello!
hello!
% puts $x
hello!
% ^[[A   ← 上矢印キーを押すとこのようになります。

上矢印キーを押すと実行例のように「 ^[[A 」が表示されコマンド履歴を表示する事ができません。

※WindowsのコマンドプロンプトやPowerShellでは上矢印キーでコマンド履歴を表示します。

Bash、tcsh、zshのようなUnixシェルにはコマンド履歴機能(ヒストリ機能)があり、カーソルキーで過去に入力したコマンドを呼び出す事ができます。

これと同じ機能がtclshを起動した時にも使えるようにする方法を紹介します。

[参考]

rlwrap

Tclers wiki

wiki.tcl-lang.org

tclshとrlwrapコマンドを組み合わせて使う

tclshとrlwrapコマンドを組み合わせる事により矢印キーでコマンド履歴を呼び出せます。

[実行例]

$ rlwrap tclsh
% set x hello!
hello!
% puts $x
hello!
% puts $x ←上矢印キーを押すと直前のコマンドを表示します。

環境設定ファイルに以下の設定を追加する事で、rlwrap を入力せずに済みます。

Bシェル系

alias tclsh='rlwrap tclsh'

Cシェル系

alias tclsh 'rlwrap tclsh'

環境設定ファイルは、.profile、.bashrc、.cshrcなど。自分の環境に合わせてください。

rlwrapの詳し使い方はman rlwrap などで調べてください。

rlwrapのインストール

rlwrapがない場合はインストールしてください。

[実行例]

$ rlwrap tclsh
bash: rlwrap: コマンドが見つかりませんでした...

[CentOS 7 の例]

$ sudo yum -y install rlwrap

[FreeBSDの例]

# pkg install rlwrap

CentOSの場合、EPEL(Extra Packages for Enterprise Linux)が使える環境でないとインストールできません。その場合、次の項目を参照してください。

EPELのインストール

$ sudo yum install epel-release

上記でインストールできな場合は、次のようにEPELのソースをダウンロードしてインストールしてください。

[EPELのダウンロード]

$ sudo wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

[EPELのインストール]

$ sudo rpm -ivh epel-release-latest-7.noarch.rpm

[EPELリポジトリを有効化する]

$ sudo yum-config-manager --enable epel

EPEが使えるようになったら次のコマンドでrlwrapをインストールします。

[rlwrapコマンドのインストール]

$ sudo yum -y install rlwrap

外部プログラムとのデータの受け渡し

外部プログラムの起動とデータの受け渡しはexecコマンドで説明しましたが、他の方法としてopenコマンドを使う方法があります。

execコマンドは、入出力のデータ量が少なくプログラムの実行時間が短い場合はいいですが、実行に時間がかかるプログラムでは以下の問題があります。

• execコマンドで起動したプログラムが終了するまで、処理を再開できない。
• execコマンドで起動したプログラムが終了した時に、プログラムの出力が一度に返って来る。

この問題を解決するにはopenコマンドでパイプを開いて送受信するようにします。

openコマンドはファイルだけでなくパイプを開くことができます。openコマンドを使用したデータの受け渡しは、開いたパイプを通して外部プロクラムとデータの受け渡しを行います。

この機能を使うとファイルの入出力と同じようにパイプをクローズするまで、起動したプログラムとデータの受け渡しができるようになります。

OSは起動したプログラムをプロセスという単位で管理しています。起動したプロセスからさらにプロセスを起動すると、起動元を親プロセス、起動したプロセスを子プロセスといいます。プロセス同士でデータの受け渡しをすることをプロセス間通信といいます。

Tclではopenコマンドを使ってプロセス間通信をする事ができます。

パイプの機能

パイプは、標準出力を次のコマンドの標準入力へ繋げる機能があります。

Unixでは、以下の例のようにコマンドの出力結果を次のコマンドの標準入力へ繋げて使うことがよくあります。Windowsでもコマンドプロンプト画面で使えますが、基本的にGUI操作がメインなので使ったことがない方もいるかも知れません。

[使用例]

# 各ファイルのディスク使用量を確認する

$ du -ah tcl-tk | more
4.0K	tcl-tk/hello.tcl
4.0K	tcl-tk/hello-w.tcl
4.0K	tcl-tk/input.tcl
　　　　　・
　　　　　・
4.0K	tcl-tk/swap.tcl
4.0K	tcl-tk/sum.tcl
--続ける--

# 行番号付で表示する。

$ cat hello-w.tcl | nl
     1	#!/bin/sh
     2	# the next line restarts using tclsh \
     3	exec wish "$0" "$@"
       
     4	# hello-w.tcl
       
     5	message .msg -width 200 -text {hello, world!}
     6	button .btn -text 終了 -command exit
     7	pack .msg .btn

# (3)小文字を大文字に変える。

$ echo "hello" | tr a-z A-Z
HELLO

Tclでパイプを開く

ファイルの入出力の記事でopenコマンドを紹介しましたが、このコマンドは、ファイル名の代わりに「|(pipe)」を指定することも出来ます。

パイプを使うと外部のプログラムとデータの受け渡しをすることができます。

openコマンドによるパイプの使い方をいくつか紹介します。

外部プログラムの標準出力からデータ受け取る

[書式]

set varName [open "| program" "r"]

アクセスモードに”r”を指定してパイプを開くとprogramの標準出力チャネルから出力されたデータをgetsコマンドまたはreadコマンドで受け取ることができます。

execコマンドと違い、closeコマンドでパイプを閉じる必要があります。varNameにはファイル識別子がセットされます。

[使用例]

set fid [open "| df -h" "r"]
set str [read -nonewline $fid]
puts $str

[出力]

ファイルシス        サイズ  使用  残り 使用% マウント位置
/dev/mapper/cl-root    17G  5.7G   12G   34% /
devtmpfs              903M     0  903M    0% /dev
tmpfs                 920M     0  920M    0% /dev/shm
tmpfs                 920M  9.5M  910M    2% /run
tmpfs                 920M     0  920M    0% /sys/fs/cgroup
/dev/sda1            1014M  386M  629M   38% /boot
vbox共有              356G  176G  180G   50% /media/sf_vbox共有
tmpfs                 184M   24K  184M    1% /run/user/1000
/dev/sr0               56M   56M     0  100% /run/media/xxxx/VBox_GAs_5.2.26
tmpfs                 184M  4.0K  184M    1% /run/user/42

外部プログラムの標準入力へデータを渡す

[書式]

set varName [open "| program" "w"]

アクセスモードに”w”を指定して開くと、putsコマンドでprogramの標準入力へデータを渡すことができます。

execコマンドと違い、closeコマンドでパイプを閉じる必要があります。varNameにはファイル識別子がセットされます。

[使用例]

set fid [open "| cat" "w"]
puts $fid "Hello! Hello!\nGood morning!"
flush $fid

[出力]

Hello! Hello!
Good morning!

上の例のように、putsコマンドで外部プログラムにデータ送る場合、バッファリングの問題があるのでflushコマンドで吐き出す必要があります。

※バッファリングについては「Tcl – 文字列の入力と出力について -標準入出力-」で紹介しています。

もう1つの方法としてfconfigureコマンドまたはchanコマンドで、バッファリングモードを変更しておくこともできます。

[書式]

fconfigure channelId -buffering newValue 
chan configure channelId -buffering newValue

newValueは次の値を指定できます。

[使用例：chanコマンドの例]

set fid [open "| cat" "w"]
chan configure $fid -buffering line
puts $fid "Hello! Hello!\nGood morning!"
close $fid

双方向にパイプを開く

[書式]

set varName [open "| program" "r+"]

アクセスモードに”r+”を指定して開くと、データの受け取り、受け渡しの双方向のパイプを開くことができます。

この方法は、起動したプログラム(子プロセス)側も出力をバッファリングしないようにしなければ上手く通信が出来ません。

送受信の都度、子プロセスを起動する場合

[使用例]

子プロセス側：strlen-s.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# n 文字数
# s 文字列

set n [gets stdin s]
puts $n

親プロセス側：strlen-m.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

puts "入力した文字列の文字数を表示します。"

while {1} {
    set fid [open "| tclsh strlen-s.tcl" "r+"]
    chan configure $fid -buffering line

    puts $fid [gets stdin]
    puts [gets $fid]
    close $fid

    puts -nonewline "終了？(y/n):"
    flush stdout

    if {[gets stdin] == y} {
        break
    }
}

[実行例]

$ ./strlen-m.tcl
入力した文字列の文字数を表示します。
hello!
6
終了？(y/n):n
Good morning!
13
終了？(y/n):y

putsコマンドのデフォルトでは、標準出力へ出力する際に改行がくると自動でフラッシュします。よって上の例では子プロセス側はflushコマンドやchanコマンドは不要です。

上の例では、子プロセス側は文字数を返すとすぐに終了します。親プロセス側のループ内で子プロセスの起動をその都度行っています。

次の例は、文字数の出力後も子プロセスを継続して起動させた状態にした場合の例です。

送受信後も子プロセスを継続して稼働させる場合

[使用例]

子プロセス側：strlen-s2.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# n 文字数
# s 文字列

while {1} {
    set n [gets stdin s]
    puts $n
}

親プロセス側：strlen-m2.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

puts "入力した文字列の文字数を表示します。"

set fid [open "| tclsh strlen-s2.tcl" "r+"]
chan configure $fid -buffering line

while {1} {
    puts $fid [gets stdin]
    puts [gets $fid]

    puts -nonewline "終了？(y/n):"
    flush stdout

    if {[gets stdin] == y} {
        break
    }
}
catch {close $fid}

この場合、親プロセス側の最後に記述しているcloseコマンドをcatchコマンドで捕捉するようにしないと、以下のエラーメッセージを表示して異常終了します。

error writing "stdout": broken pipe

closeコマンドのマニュアルに以下の説明が記載されています。

If channelId is a blocking channel for a command pipeline then close waits for the child processes to complete.

channelIdがコマンドパイプラインのブロッキングチャネルである場合、クローズは子プロセスが終了するのを待ちます。

http://www.tcl.tk/man/tcl8.6/TclCmd/close.htm

どうやらcloseコマンドでパイプラインを閉じる時は、子プロセスを終了させないとダメなようです。

継続稼働中の子プロセスを終了させるには

子プロセスを終了させる方法を２つ紹介します。

[使用例1]

子プロセス側：strlen-s3.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# n 文字数
# s 文字列

while {[set n [gets stdin s]] > 0} {
    puts $n
}

親プロセス側：strlen-m3.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

puts "入力した文字列の文字数を表示します。"

set fid [open "| tclsh strlen-s3.tcl" "r+"]
chan configure $fid -buffering line

while {1} {
    puts $fid [gets stdin]
    puts [gets $fid]

    puts -nonewline "終了？(y/n):"
    flush stdout

    if {[gets stdin] == y} {
        puts $fid ""    ;# 空行を送って子プロセスを終了させる。
        break
    }
}
close $fid

使用例1では、空の文字列(文字数0)を送ることで、子プロセスを終了するようにしてます。

空の文字列でなくても”quit”が来たら終了させるなど、子プロセスへ送る文字列のルールを決めることで終了させることができそうですよね。

子プロセスを終了させる方法をもう１つ紹介します。

[使用例2]

子プロセス側はstrlen-s2.tclを使います。

親プロセス側：strlen-m4.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

puts "入力した文字列の文字数を表示します。"

set fid [open "| tclsh strlen-s2.tcl" "r+"]
chan configure $fid -buffering line

while {1} {
    puts $fid [gets stdin]
    puts [gets $fid]

    puts -nonewline "終了？(y/n):"
    flush stdout

    if {[gets stdin] == y} {
        set pid [pid $fid] 
        exec kill $pid
        break
    }
}
catch {close $fid}

pidコマンドはopenコマンドで起動したプロセスのプロセスIDを返します。

例2では、OS標準のkillコマンドを使って子プロセスを終了させています。この場合もcloseコマンドをcatchコマンドで捕捉するようにしないと、以下のエラーメッセージを表示します。

child killed: software termination signal
    while executing
"close $fid"
    (file "./strlen-m4.tcl" line 23)

ネットで色々調べていると、クローズする時に、パイプラインプロセスの異常終了などにより、closeコマンドがエラーになることがあるので、catchコマンドを使うようにしたほうがいいようです。

参考：killing process in tcl

Windowsには、killコマンドがないので、Tclの標準機能だけで、この方法を使うことは出来ませんが、TclXという拡張ライブラリを使うと、拡張ライブラリのkillコマンドが使えます。

ActiveTclにインストールされていたので使用してみました。

[使用例2-2]

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

package require Tclx    ;# Tclxを追加

puts "入力した文字列の文字数を表示します。"

set fid [open "| tclsh strlen-s2.tcl" "r+"]
chan configure $fid -buffering line

while {1} {
    puts $fid [gets stdin]
    puts [gets $fid]

    puts -nonewline "終了？(y/n):"
    flush stdout

    if {[gets stdin] == y} {
        set pid [pid $fid] 
        kill $pid    ;# Tclxのkillコマンド
        break
    }
}
catch {close $fid}

package require xxxx で拡張ライブラリが使えます。
packageコマンドについては別途紹介しようと思います。

参考：
https://wiki.tcl-lang.org/page/kill
https://wiki.tcl-lang.org/page/chan+pipe

外部プログラムの実行

Tclシェルを起動して対話的に実行する場合、未定義のTclコマンドが入力されると、外部プログラムとして実行するように設定されています。

[使用例1]

$ tclsh

# 外部コマンドのdateを実行
% date
2019年  2月 13日 水曜日 15:36:02 JST

# 予期せぬ動作
% set d [date]
2019年  2月 13日 水曜日 15:36:35 JST

% puts $d

%

1つ目の例は、OS標準コマンドのdateコマンドを実行して現在の日時を表示しています。

2つ目の例は、dateコマンドを実行して現在の日時を変数dに格納しようとして失敗しています。

Tclシェルを起動して通常のシェルと同じようにOS標準コマンドが実行できるのは便利であるのですが、色々試していると、2つ目の例のように予期せぬ振る舞いに遭遇することもあります。

外部プログラムの実行をさせないようにするには、変数auto_noexecを定義します。

[使用例2]

$ tclsh
% set auto_noexec 1
1
% date
invalid command name "date"

execコマンド

[書式]

exec ?switches? arg ?arg ...? ?&?

execコマンドはサブプロセスを呼び出します。

Tclのスクリプトファイル内で外部プログラムを実行したり、実行した結果を利用するには、execコマンドを使います。Tclシェルを起動して対話的に実行する場合にも明示的にexecコマンドを実行することで、外部コマンドの出力結果を利用することができます。

[使用例1]

$ tclsh
% set d [exec date]
2019年  2月 13日 水曜日 16:45:10 JST
% puts $d
2019年  2月 13日 水曜日 16:45:10 JST

execコマンドはパイプラインやリダイレクトもサポートしています。以下の例はlsコマンドの出力結果をパイプラインを使ってgrepコマンドに渡しています。

$ tclsh

% set dir [exec ls | grep hello*]
hello-w.tcl
hello.tcl

% puts $dir
hello-w.tcl
hello.tcl

execコマンドのオプションや使用できるリダイレクションは以下のようなものがあります。

標準出力がリダイレクトされていない場合、“ 2> @ 1”が指定されていない限り、execコマンドはパイプラインの最後のコマンドから標準出力を返します。この場合、標準エラーも含まれます。

もし、パイプライン内のいずれかのコマンドが異常終了したり、強制終了されたり中断されたりした場合、execはエラーを返します。エラーメッセージにはパイプラインの出力とそれに続く異常終了を説明するエラーメッセージが含まれます。

グローバル変数のerrorcodeには、最後に発生した異常終了に関する追加情報が含まれます。

もし、いずれかのコマンドが標準エラーに出力して、その標準エラーがリダイレクトされずに、-ignorestderrも指定されていない場合にはexecはエラーを返します。 エラーメッセージには、パイプラインの標準出力と、それに続いて異常終了に関するメッセージ（もしあれば）を出力し、その後に標準エラーが出力されます。

execコマンドの使用例

execコマンドの使用例をいくつか紹介します。

UNIXでの使用例

[使用例1]

set n [exec cat str.txt | wc -l]
puts $n
=> 8

使用例1は、catコマンドのファイル指定で読み込んで、wcコマンドで行数の取得。結果を変数nに代入しています。

[使用例2]

(1) exec cat < str.txt | wc -l > str.line
(2) set fid [open str.line r]
    set line [exec cat <@ $fid]
    => 8

(1)は、ファイル名で指定したファイルの内容を標準入力からcatコマンドに渡して、wcコマンドで行数の取得。結果をファイル：str.lineへ出力しています。

(2)は、str.lineを開いてファイル識別子を指定してcatコマンドに渡しています。

[使用例3]

(1) exec date > ping.txt
(2) set pid [exec ping -i 5 192.168.11.1 >>& ping.txt &]
(3) exec kill $pid
    exit
 
    $ cat ping.txt
    2019年  2月 21日 木曜日 16:00:48 JST
    PING 192.168.11.1 (192.168.11.1) 56(84) bytes of data.
    64 bytes from 192.168.11.1: icmp_seq=2 ttl=64 time=0.678 ms
    64 bytes from 192.168.11.1: icmp_seq=3 ttl=64 time=0.743 ms
    64 bytes from 192.168.11.1: icmp_seq=4 ttl=64 time=0.662 ms
    64 bytes from 192.168.11.1: icmp_seq=5 ttl=64 time=0.751 ms

(1)は、日付をping.txtに書き込みしています。

(2)は、pingコマンドをバックグランドで起動し、標準出力と標準エラーの両方をping.txtに追加書き込みするようにしています。

ping -i 5 は、相手先に5秒間隔でパケットを送信します。

末尾の「&」がないとフォアグランドで子プロセス(pingコマンド)を起動するので、起動した子プロセスが終了するまで、Tcl(親プロセス側)で次のコマンドが実行できなくなります。その場合、Ctrl+Cなどでpingコマンドを強制終了する必要があります。

(2)のようにバックグランドで実行した場合、execコマンドの戻り値は、起動したpingコマンドのプロセスIDを返します。

(3)は、pingコマンドを終了させています。

Windowsでの使用例

[使用例1]

(1) exec notepad &
(2) exec c:/windows/system32/notepad.exe &
(3) exec {*}[auto_execok notepad] &

(1)(2)(3)は、いずれもメモ帳を起動します。

(1)は、notepad.exeがPATH環境変数内にあることを想定しています。

(2)は、プログラムへのパスを明示的に指定しています。

(3)は、auto_execokコマンドを使用している。

　　auto_execok cmd

auto_execokはTclライブラリのコマンドで、指定したコマンド(cmd)が実行可能ファイル(シェル組み込み含む)として存在するかどうか判別します。存在している場合は、execコマンドで実行可能ファイルを実行する為に引数リストをexecコマンドに渡します。存在しない場合は、空文字列を返します。

{*}の構文は、複数の引数に展開します。Tclはデフォルトで複数の引数に展開しないので、複数の引数が1つの文字列として扱われ、エラーになる可能性があります。{*}は8.5から使えるようになりました。それまでは、evalコマンドで以下のように記述していました。

　　eval exec [auto_execok notepad] &

Windowsの場合、拡張子にプログラムの関連付けがされているので以下のような使い方もできます。

[使用例2]

(1) exec {*}[auto_execok start] https://wiki.tcl-lang.org
(2) exec {*}[auto_execok start] hello-w.tcl &

(1)は、ブラウザを起動してTcler’s Wiki!のページを表示します。

(2)は、hello-w.tclのプログラムを起動します。

{*}やevalコマンドを使わなかった場合、以下のエラーになります。

couldn't execute "C:\Windows\System32\cmd.exe \c start": no such file or directory

evalコマンドと{*}構文は「Tcl – evalコマンドと{*}構文について」で紹介しています。

evalコマンド

[書式]

eval arg ?arg ...?

evalコマンドの引数はTclコマンドを１つ以上含むTclスクリプトを構成した引数をとります。

evalコマンドはconcatコマンドと同じ方法で引数を展開します。

[使用例1]

set a 10
set b {20 30 40}
set c 50

list $a $b $c
⇒ 10 {20 30 40} 50

concat $a $b $c
⇒ 10 20 30 40 50

eval list $a $b $c
⇒ 10 20 30 40 50

listコマンドでは$bを１つの値として展開します。

これをevalコマンドの引数で指定すると$bを３つの値として展開します。

Tclインタプリタは基本的に展開したものをさらに展開することはしませんが、evalコマンドを使うと展開した値をさらに展開することができます。

[使用例2]

set script {
    puts "hello! hello!"
    puts "Good morning!"
}

eval $script
⇒ hello! hello!
   Good morning!

上の例では変数scriptを展開した文字列をTclコマンドとして再評価しています。

[使用例3]

set prog "wish hello-w.tcl"

eval exec $prog &

execコマンドは外部プログラムを実行します。

上の例では「wish hello-w.tcl」を「wish」と「hello-w.tcl」の２つの値として展開しています。

execコマンドについては「外部プログラムの実行について」で説明します。

{*}構文について

{*}の構文は、concatコマンドと同じ方法でリストを複数の引数として展開します。

{*}は8.5から使えるようになりました。

[使用例1]

set a 10
set b {20 30 40}
set c 50

list $a $b $c
⇒ 10 {20 30 40} 50

eval list $a $b $c
⇒ 10 20 30 40 50

list $a {*}$b $c
⇒ 10 20 30 40 50

複数の引数をまとめた変数を展開する場合など、単なる文字列のリストを展開するだけであれば、evalコマンドよりも「{*}」を使用した方がシンプルで見やすいです。

[使用例2]

set prog "wish hello-w.tcl"

exec {*}$prog &

{*}構文を使った例は「外部プログラムの実行について Windowsでの使用例」でも紹介しています。

binary scan

[書式]

binary scan string formatString ?varName varName ...?

binary scanは、formatStringで指定した書式に従ってstringで指定したバイナリデータを文字列に変換を行い、変換した文字列をvarNameへ格納します。戻り値は変換した個数を返します。

stringは、1文字につき1バイト、1バイトとして表現できない文字の上位ビットは切り捨てられます。

formatStringの指定方法

例.

set bin [binary format a* abcdefghi]
=> abcdefghi 相当のバイナリ値が変数binに格納されます。

binary scan $bin HH2H4H6H* n1 n2 n3 n4 n5
=> 5 変換した個数を返します。

puts "$n1 $n2 $n3 $n4 $n5"
=> 6 62 6364 656667 6869
      b  c d  e f g  h i

フィールドは、H, H2, H4, H6 H* の5つあります。変換した値を格納するvarNameもフィールドの個数だけ必要になります。

フィールドの最初の単一文字は変換方法を示すタイプで、その後に続く数字は変換を繰り返す回数(count)を表します。数字の代わりに”*”を使うと、対応するargの文字列すべて変換します。

タイプ”H”は、変数binのバイナリデータをバイト内で、上位から下位の順番で16進数表記の文字列に変換します。countを省略すると、1桁だけ変換されます。

タイプに指定できる種類は以下のようなものがあります。

a
バイナリデータを文字列に変換します。

全てのバイトは、\u0000-\u00ffの範囲の文字として解釈される為、stringで指定したデータが、バイナリ文字列であっても、ISO 8859-1でエンコードされた文字列でもない場合は、encoding convertfromコマンドが必要になります。

例1.

binary scan \x48\x65\x6c\x6c\x6f\x21 a* str1
=> 1
puts $str1
=> Hello!

例2.

binary scan \xe3\x83\x90\xe3\x82\xa4\xe3\x83\x90\xe3\x82\xa4 a* str1
=> 1
puts $str1
=> 文字化けする。
puts [encoding convertfrom utf-8 $str1]
=> バイバイ

[参考]
＊ISO 8859-1(Latin-1)
ASCII文字コードに西ヨーロッパ諸国で使われるラテン文字を追加した文字集合。
https://ja.wikipedia.org/wiki/ISO/IEC_8859-1
http://e-words.jp/w/ISO-IEC_8859.html

A
aと同じですが、末尾の空白とNULLが変数に格納される前に削除されます。

例.

binary scan "\x61\x62\x63\x20\x64\x65  \x66  \x00" A* var1
=> 1
puts $var1
=> abc de  f 末尾の空白とNULL(\x00)は削除されます。

b
バイナリデータをlow-to-high順で2進数表記の文字列に変換します。

stringで指定したバイナリデータはバイト単位でfirst-to-lastの順番でスキャンされ、バイト内のビットはlow-to-high順でcountビット分、2進数表記の文字列で出力します。 countが*の場合、stringの残りのすべてのビットがスキャンされます。 countが省略された場合、1ビットがスキャンされます。

例.

binary scan \x07\x87\x05 b5b* var1 var2
=> 2
puts $var1
=> 11100
puts $var2
=> 1110000110100000

[参考]

     0x07        0x87       0x05
  0000 0111  10000 0111  0000 0101
    -------  ---------------------
      ↓               ↓
     var1             var2

var1
low-to-high順で5ビット分格納される。
var2
0x87,0x05の順でスキャンされ、バイト内のビットは、low-to-high順でvar2に格納される。

B
bと同じですが、各バイト内のビットを、high-to-lowの順で2進数表記の文字列で出力します。

例.

binary scan \x70\x87\x05 B5B* var1 var2
=>2
puts $var1
=> 01110
puts $var2
=>1000011100000101

[参考]

     0x70        0x87       0x05
  0111 000  10000 0111  0000 0101
  ------    ---------------------
    ↓                ↓
   var1              var2

h
バイナリデータをlow-to-high順で16進数表記の文字列に変換します。

stringで指定したバイナリデータはバイト単位でfirst-to-lastの順番でスキャンされ、バイト内のデータはlow-to-high順で16進数表記の文字列で出力します。 countが*の場合、stringの残りのすべてのデータがスキャンされます。 countが省略された場合、1桁(4bit)がスキャンされます。

例.

binary scan \x07\x86\x05\x12\x34 h3h* var1 var2
=> 2
puts $var1
=> 706
puts $var2
=> 502143

[参考]

    0x07       0x86       0x05       0x12       0x34
  0000 0111  1000 0110  0000 0101  0001 0010  0011 0100
  ---- ----       ----  ---- ----  ---- ----  ---- ----
    0    7          6     0    5     1    2     3    4
    ------------------   ------------------------------
             ↓                         ↓
　　　　var1 => 706　　　　　　　  var2 => 502143

H
hと同じですが、各バイト内のデータを、high-to-lowの順で16進数表記の文字列で出力します。

例.

binary scan \x07\xC6\x05\x1f\x34 H3H* var1 var2
=> 2
puts $var1
=> 07c
puts $var2
=>051f34

[参考]

    0x07       0xc6       0x05       0x1f       0x34
  0000 0111  1100 0110  0000 0101  0001 1111  0011 0100
  ---- ----  ----       ---- ----  ---- ----  ---- ----
    0    7     c          0    5     1    f     3    4
   --------------        ------------------------------
          ↓　                           ↓
　　　var1 => 07c                   var2 => 051f34

c
バイナリデータを8ビット符号付き整数に変換します。変換したデータはリストとして対応する変数に格納されます。

countが*の場合、バイナリデータの残りすべてのバイトがスキャンされます。countが省略された場合、1つの8ビット整数がスキャンされます。

例.

binary scan \x07\x86\x05 c2c* var1 var2
=> 2
puts $var1
=> 7 -122
puts $var2
=>5

変換したデータは符号付きの整数値ですが、以下のような式を使用して符号なし8ビット整数に変換できます。

expr {-122 & 0xff}
=> 134 は16進数で0x86です。

s
バイナリデータをリトルエンディアン（little-endian）のバイト順で表される16ビット符号付き整数に変換します。変換したデータはリストとして対応する変数に格納されます。

countが*の場合、バイナリデータの残りすべてのバイトがスキャンされます。countが省略された場合、1つの16ビット整数がスキャンされます。

例.

binary scan \x05\x00\x07\x00\xf0\xff s2s* var1 var2
=> 2
puts $var1
=> 5 7
puts $var2
=> -16

変換したデータは符号付きの整数値ですが、以下のような式を使用して符号なし16ビット整数に変換できます。

expr {-16 & 0xffff}
=> 65520 は16進数で0xfff0です。

S
バイナリデータをビッグエンディアン（big-endian）のバイト順で表される16ビット符号付き整数に変換します。それ以外は、sと同じです。

例.

binary scan \x00\x05\x00\x07\xff\xf0 S2S* var1 var2
=> 2
puts $var1
=> 5 7
puts $var2
=> -16

t
バイナリデータをTclスクリプトが実行されているマシンのネイティブのバイト順で表されるで16ビット符号付き整数として解釈されます。それ以外の点は、sおよびSと同じです。 マシンのネイティブのバイト順が何であるかを判断するには、tcl_platform配列のbyteOrder要素を参照してください。

例.

puts $tcl_platform(byteOrder)
=> littleEndian

i
バイナリデータをリトルエンディアン（little-endian）のバイト順で表される32ビット符号付き整数に変換します。変換したデータはリストとして対応する変数に格納されます。

countが*の場合、バイナリデータの残りすべてのバイトがスキャンされます。countが省略された場合、1つの32ビット整数がスキャンされます。

例.

set str \x05\x00\x00\x00\x07\x00\x00\x00\xf0\xff\xff\xff
=> ðÿÿÿ
binary scan $str i2i* var1 var2
=> 2
puts $var1
=> 5 7
puts $var2
=> -16

変換したデータは符号付きの整数値ですが、以下のような式を使用して符号なし16ビット整数に変換できます。

  expr {-16 & 0xffffffff}
  => 4294967280 は16進数で0xfffffff0です。

I
バイナリデータをビッグエンディアン（big-endian）のバイト順で表される32ビット符号付き整数に変換します。それ以外は、iと同じです。

例.

set str \x00\x00\x00\x05\x00\x00\x00\x07\xff\xff\xff\xf0
=> ÿÿÿð
binary scan $str I2I* var1 var2
=> 2
puts $var1
=> 5 7
puts $var2
=> -16

n
バイナリデータをTclスクリプトが実行されているマシンのネイティブのバイト順で表されるで32ビット符号付き整数として解釈されます。それ以外の点は、iおよびIと同じです。 マシンのネイティブのバイト順が何であるかを判断するには、tcl_platform配列のbyteOrder要素を参照してください。

例.

puts $tcl_platform(byteOrder)
=> littleEndian

w
バイナリデータをリトルエンディアン（little-endian）のバイト順で表される64ビット符号付き整数に変換します。変換したデータはリストとして対応する変数に格納されます。

countが*の場合、バイナリデータの残りすべてのバイトがスキャンされます。countが省略された場合、1つの64ビット整数がスキャンされます。

例.

set str \x05\x00\x00\x00\x07\x00\x00\x00\xf0\xff\xff\xff
=> ðÿÿÿ
binary scan $str wi* var1 var2
=> 2
puts $var1
=> 30064771077
puts $var2
=> -16

W
バイナリデータをビッグエンディアン（big-endian）のバイト順で表される64ビット符号付き整数に変換します。それ以外は、wと同じです。

例.

set str \x00\x00\x00\x05\x00\x00\x00\x07\xff\xff\xff\xf0
=> ÿÿÿð
binary scan $str WI* var1 var2
=> 2
puts $var1
=> 21474836487
puts $var2
=> -16

m
バイナリデータをTclスクリプトが実行されているマシンのネイティブのバイト順で表されるで64ビット符号付き整数として解釈されます。それ以外の点は、wおよびWと同じです。 マシンのネイティブのバイト順が何であるかを判断するには、tcl_platform配列のbyteOrder要素を参照してください。

例.

puts $tcl_platform(byteOrder)
=> littleEndian

f
バイナリデータをマシンのネイティブ表現における単精度浮動小数点数として解釈されます。浮動小数点数は対応する変数にリストとして格納されます。

countが*の場合、バイナリデータの残りすべてのバイトがスキャンされます。countが省略された場合、1つの単精度浮動小数点数がスキャンされます。

浮動小数点数のサイズはアーキテクチャによって異なりますので、スキャンされるバイト数は異なります。 データが有効な浮動小数点数を表していない場合、結果の値は未定義でコンパイラに依存します。

たとえば、Intel(R) Core(TM) i7-4770 CPU上で実行されているWindowsシステムでは、

binary scan \xcd\xcc\xcc\x3f f var1
=> 1
puts $var1
=> 1.600000023841858 を返します。

r
バイナリデータを単精度浮動小数点数としてリトルエンディアン（little-endian）順に解釈されることを除いてfと同じです。

この変換は、IEEE浮動小数点表現を使用しないシステムに移植することはできません。

R
バイナリデータを単精度浮動小数点数としてビッグエンディアン（big-endian）順に解釈されることを除いてfと同じです。

この変換は、IEEE浮動小数点表現を使用しないシステムに移植することはできません。

d
バイナリデータを倍精度浮動小数点数として解釈されることを除いてfと同じです。

たとえば、Intel(R) Core(TM) i7-4770 CPU上で実行されているWindowsシステムでは、

binary scan \x9a\x99\x99\x99\x99\x99\xf9\x3f d var1
=> 1
puts $var1
=> 1.6 を返します。

q
バイナリデータを倍精度浮動小数点数としてリトルエンディアン（little-endian）順に解釈されることを除いてdと同じです。

この変換は、IEEE浮動小数点表現を使用しないシステムに移植することはできません。

Q
バイナリデータを倍精度浮動小数点数としてビッグエンディアン（big-endian）順に解釈されることを除いてdと同じです。

この変換は、IEEE浮動小数点表現を使用しないシステムに移植することはできません。

x
指定したバイトデータのカーソル位置をcountバイトだけ進めます。countが*または現在のカーソル位置の後のバイト数より大きい場合、カーソルはバイトデータの最後のバイトの後に配置されます。countが省略された場合、カーソルは1バイト進められます。

この型は引数を消費しないことに注意してください。例えば、

binary scan \x01\x02\x03\x04 x2H* var1
=> 1
puts $var1
=> 0304 がvar1に格納されます。

X
指定したバイトデータのカーソル位置をcountバイトだけ後ろに移動します。countが*または現在のカーソル位置よりも大きい場合、カーソルは位置0に配置されるので、次にスキャンされるバイトは文字列の最初のバイトになります。 countが省略された場合、カーソルは1バイト戻ります。

この型は引数を消費しないことに注意してください。 例えば、

binary scan \x01\x02\x03\x04 c2XH* var1 var2
=> 2
puts $var1
=> 1 2 がvar1に格納されます。
puts $var2
=> 020304 がvar2に格納されます。

@
stringで指定されたバイナリデータ内のカーソル位置をcountで指定した絶対位置に移動する。位置0はstringの最初のバイトを表します。countが文字列の末尾を超えた位置を指す場合、カーソルは最後のバイトの後に配置されます。 countを省略すると、エラーが発生します。

例.

binary scan \x01\x02\x03\x04 c2@1H* var1 var2
=> 2
puts $var1
=> 1 2
puts $var2
=> 020304

16進ダンプ

以下のプログラムは、binary scanを使用した、16進ダンプのプログラムです。

[サンプル] hexdump.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# 16進ダンプ

proc hexdump {fname} {
    set addr 0    ;# アドレス
    set fid [open $fname {RDONLY BINARY}]
    while {![eof $fid]} {
        set str ""    ;# 16バイト毎に初期化
        for {set i 0} {$i < 16} {incr i} {
            set byte [read $fid 1]
            if {![eof $fid]} {
                binary scan $byte H* hex
                lappend str $hex
            } else {
                break    ;# forループから抜ける
            }
        }
        puts [format "%06X  %s" $addr $str]
        incr addr 16
    }
    close $fid
}

# main
set fname [lindex $argv 0]    ;# ファイル名の取得
hexdump $fname

[実行例]

$ ./hexdump.tcl str.txt
000000  48 65 6c 6c 6f 21 20 48 65 6c 6c 6f 21 0a 47 6f
000010  6f 64 20 6d 6f 72 6e 69 6e 67 21 0a 42 79 65 20
000020  62 79 65 21 0a 48 61 76 65 20 61 20 6e 69 63 65
000030  20 64 61 79 21 0a e3 81 93 e3 82 93 e3 81 ab e3
000040  81 a1 e3 82 8f 0a e3 81 8a e3 81 af e3 82 88 e3
000050  81 86 e3 81 94 e3 81 96 e3 81 84 e3 81 be e3 81
000060  99 e3 80 82 0a e3 83 90 e3 82 a4 e3 83 90 e3 82
000070  a4 0a e3 82 88 e3 81 84 31 e6 97 a5 e3 82 92 ef
000080  bc 81 0a

文字列操作など、色々説明していない事があるので、単純に１バイトずつ読み込んで16進表記で表示するようにしました。

16バイトずつ読み込んでから、文字列を整形したほうが効率がいいと思います。

[参考]
Dump a file in hex and ASCII

binary formatコマンドの使い方については以下の記事で紹介しています。

Tcl - バイナリデータの操作(2) -binary format-

Tclでバイナリデータを取り扱うにはbinaryコマンドを使います。この記事ではbinary formatの引数 formatString に指定できる値と使い方について紹介します。

blog.it-see.net

2019.10.31

バイナリデータの基本的な操作につては以下の記事で紹介しています。

Tcl - バイナリデータの操作(1)

Tclでバイナリデータを取り扱うにはbinaryコマンドを使います。binaryコマンドの操作を３回に分けて紹介します。この記事ではバイナリデータを読み書きする時の基本的な操作を紹介します。

blog.it-see.net

2019.10.29

[書式]

binary format formatString ?arg arg ...?

binary formatは、formatString で指定した書式に従って arg で指定した文字列をバイナリデータに変換を行い、変換したバイナリデータを返します。

formatStringの指定方法

例.

binary fomat a3a2  Good morning!
=> Goomo

formatString のフィールドは”a3″と”a2″の２つあります。それに対応する値も”Good”と”morning!”の２つあります

フィールドの最初の単一文字は変換方法を示すタイプです。その後に続く数字は変換を繰り返す回数(count)を表します。数字の代わりに”*”を使うと、対応するargの文字列すべて変換します。

タイプ”a”は、文字列ageのcount桁数のバイト列(バイナリデータ)に変換して返します。例の場合は、Gooの３文字とmoの２文字をバイト列にしたものが返されます。

Goomoの文字を16進数で表現すると以下のようになります。

47 6f 6f 6d 6f
G  o  o  m  o

よって、\x47\x6f\x6f\x6d\x6f に相当するバイナリ値を返します。

例では、アスキコードの範囲内の文字なので、変換後も文字として見えていますが、漢字などアスキコードの範囲外の文字であれば、返されたバイナリデータは文字化けします。

タイプに指定できる種類は以下のようなものがあります。

a
文字列argをcount桁分、バイナリ値で出力します。

argがcountより少ない場合、00で埋められます。countより多い場合は、切り捨てられます。countを省略した場合、１文字が変換されます。countが”*”の場合、全て変換されます。

例.

binary format a8  Hello!
=> Hello!

\x48\x65\x6c\x6c\x6f\x21\x00\x00 に相当するバイナリ値を返します。

\x48\x65\x6c\x6c\x6f\x21\x00\x00
  H   e   l   l   o   !  

※日本語を扱う場合、「binaryコマンドの日本語の扱いについて」を参照してください。

A
argがcountより少ない場合、スペースで埋められます。それ以外は、aと同じ。

例.

binary format a8  Hello!
=> Hello!

\x48\x65\x6c\x6c\x6f\x21\x20\x20 に相当するバイナリ値を返します。

\x48\x65\x6c\x6c\x6f\x21\x20\x20
  H   e   l   l   o   !  空白 空白

b
２進数表記の文字列(age)をcount桁分、バイト単位でlow-to-high順に出力します。

argは文字”1″と”0″で指定します。argがcountより少ない場合、残りのビットは、ゼロで埋められます。countより多い場合は、切り捨てられます。countを省略した場合、１ビットが出力されます。countが”*”の場合、全て出力されます。出力されたビット数がバイト境界で終了しない場合、残りのビットはゼロで埋められます。

例.

binary format b8b* 110010 011100110101
=> \x13\xce\x0a に相当するバイナリ値を返します。

[参考]
・ビット・桁の数え方

　　　　　　上位 下位
            7654 3210 ←bit ※計算機により異なります。
　　8桁目→ 1111 1110 ←1桁目
　　　　　　　F    E

・例の場合

　|-------|  |-------| |-------| ← バイト境界
　1100 1000  0111 0011 0101 0000 ←  2進数
    C    8     7    3    5    0  ← 16進数

バイト内でlow-to-high順なので通常とは逆に数えます。

　0001 0011  1100 1110  0000 1010 ←  2進数
    1    3     C    E    0    A   ← 16進数

赤線：不足分を0で埋められています。

※最上位ビット(MSB)を0とするか最下位ビット(LSB)を0とするかは計算機により違います。
最上位ビット
https://ja.wikipedia.org/wiki/最上位ビット
エンディアン
https://ja.wikipedia.org/wiki/エンディアン

B
ビットが各バイト内のhigh-to-lowの順番で出力されることを除いて、bと同じです。

例.

binary format B8B* 110010 011100110101
=> \xc8\x73\x50 に相当するバイナリ値を返します。

h
16進数表記の文字列(age)をcount桁分、バイト単位でlow-to-high順に出力します。

argは文字「0123456789abcdefABCDEF」で指定します。
変換されるバイナリ値は、argで指定した16進数表記の文字2つからバイト値を求め、バイト内で下位から上位(low-to-high)の順で出力されます。

argの桁数がcountより少ない場合は、残りの桁にゼロが使用されます。argが指定された桁数より多い場合、余分な桁は無視されます。countが*の場合、arg内のすべての数字が変換されます。

変換された桁数がバイト境界で終了しない場合、残りの4ビットはゼロになります。countが省略された場合、1桁が変換されます。

例1.

binary format h3h* AB def
=> \xba\x00\xed\x0f に相当するバイナリ値を返します。

例2.

binary format h AB
=> \x0a に相当するバイナリ値を返します。

[参考]

例1

上位 下位　　
1010 1011    　　→ 下位・上位順の為、BAのバイナリ値が出力される。
 A    B        　　countが3かつバイト境界でない為、残りの桁が00になる。

上位 下位 上位
1101 1110 1111　→ 下位・上位順の為、edのバイナリ値が出力される。
 d    e    f　　　最後の桁は、バイト境界でないので、f0になり、
　　　　　　　　　　 下位・上位順の為、0fのバイナリ値が出力される。

例2.

countが省略されている為、1桁の”A”のみ変換され、残りの桁”B”の4ビットは変換されずにゼロになります。

H
バイト内で上位から下位(high-to-low)の順で出力されることを除いて、hと同じです。

例.1

binary format h3h* AB def
=> \xab\x00\xde\xf0 に相当するバイナリ値を返します。

例2.

binary format h AB
=> \xa0 に相当するバイナリ値を返します。

c
1つ以上の8ビット整数値を変換します。

argは整数値で指定します。countが指定されていない場合、argは１つの整数値でなければなりません。countが指定されている場合、argは、その数のリストで指定します。各要素の下位8ビットが１バイトのバイナリ値として出力されます。

countが*の場合、全ての要素が変換されます。リスト内の要素数が、countより大きい場合、余分な要素は無視されます。リスト内の要素数が、countより少ない場合、エラーになります。

例.

binary format c3cc* {3 -3 128 1} 260 {2 5}
=> \x03\xfd\x80\x04\x02\x05 に相当するバイナリ値を返します。

以下はエラーになります。

binary format c {2 5}
=> expected integer but got "2 5"

binary fomat c3 {2 5}
=> number of elements in list does not match count

[参考]

　  3 : 0000 0011
   -3 : 1111 1101 参:ビットごとのNOT(1の補数)のメモを参照
　128 : 1000 0000 16進で80
　　1 : 0000 0001 countに3を指定しているので無視されます。
　260 : 0001 0000 0100 下位8ビットが変換対象の為、04を出力する。

s
1つ以上の16ビット整数値をリトルエンディアン（little-endian）順に出力します。

16ビット(2バイト)の内、最下位バイトを先に出力します。それ以外はcと同じです。

例.

binary format s3 {3 -3 258 1}
=> \x03\x00\xfd\xff\x02\x01 に相当するバイナリ値を返します。

[参考]

　258 : 0000 0001 0000 0010 16進で102
          0    1    0    2

S
1つ以上の16ビット整数値をビッグエンディアン（big-endian）順に出力します。

16ビット(2バイト)の内、最上位バイトを先に出力します。それ以外はsと同じです。

例.

binary format S3 {3 -3 258 1}
=> \x00\x03\xff\xfd\x01\x02 に相当するバイナリ値を返します。

t
Tclスクリプトが実行されているマシンのネイティブのバイト順で16ビット整数を出力することを除いて、sおよびSと同じです。

マシンのネイティブのバイト順が何であるかを判断するには、tcl_platform配列のbyteOrder要素を参照してください。

例.

puts $tcl_platform(byteOrder)
=> littleEndian

i
1つ以上の32ビット整数値をリトルエンディアン（little-endian）順に出力します。

32ビット(4バイト)の内、最下位バイトを先に出力します。それ以外はcと同じです。

例.

binary format i3 {3 -3 65536 1}
=> \x03\x00\x00\x00\xfd\xff\xff\xff\x00\x00\x01\x00
   に相当するバイナリ値を返します。

I
1つ以上の32ビット整数値をビッグエンディアン（big-endian）順に出力します。

32ビット(4バイト)の内、最上位バイトを先に出力します。それ以外はiと同じです。

例.

binary format I3 {3 -3 65536 1}
=> \x00\x00\x00\x03\xff\xff\xff\xfd\x00\x01\x00\x00
　 に相当するバイナリ値を返します。

n
Tclスクリプトが実行されているマシンのネイティブのバイト順で32ビット整数を出力することを除いて、iおよびIと同じです。

マシンのネイティブのバイト順が何であるかを判断するには、tcl_platform配列のbyteOrder要素を参照してください。

例.

puts $tcl_platform(byteOrder)
=> littleEndian

w
1つ以上の64ビット整数値をリトルエンディアン（little-endian）順に出力します。

64ビット(8バイト)の内、最下位バイトを先に出力します。それ以外はcと同じです。

例.

binary format w 7810179016327718216
=> HelloTcl に相当するバイナリ値を返します。

[参考]
・16進数に変換すると

puts [format %x 7810179016327718216]
=> 6c63546f6c6c6548 

16進 ：6c 63 54 6f 6c 6c 65 48 
ASCII： l  c  T  o  l  l  e  H　
=> 最下位バイトから出力すると HelloTcl

W
1つ以上の64ビット整数値をビッグエンディアン（big-endian）順に出力します。

64ビット(8バイト)の内、最上位バイトを先に出力します。それ以外はwと同じです。

例.

binary format Wc 4785469626960341345 110
=> BigEndian に相当するバイナリ値を返します。

[参考]
・16進数に変換すると

puts [format "%x %x" 4785469626960341345 110]
=> 426967456e646961 6e

16進 ：42 69 67 45 6e 64 69 61 6e
ASCII： B  i  g  E  n  d  i  a  n
=> 最上位バイトから出力すると BigEndian

m
Tclスクリプトが実行されているマシンのネイティブのバイト順で64ビット整数を出力することを除いて、wおよびWと同じです。

マシンのネイティブのバイト順が何であるかを判断するには、tcl_platform配列のbyteOrder要素を参照してください。

例.

puts $tcl_platform(byteOrder)
=> littleEndian

f
１つ以上の単精度浮動小数点数を、マシンのネイティブ表現で出力します。

この表現はアーキテクチャ間で移植性がないため、ネットワーク上で浮動小数点数を通信するために使用しないでください。

浮動小数点数のサイズはアーキテクチャによって異なりますので、生成されるバイト数は異なります。

値がマシンのネイティブ表現をオーバーフローすると、システムによって定義されたFLT_MAXの値が代わりに使用されます。 Tclは内部で倍精度浮動小数点数を使用しているため、単精度への変換では精度がいくらか低下する可能性があります。

たとえば、Intel(R) Core(TM) i7-4770 CPU上で実行されているWindowsシステムでは、

binary format f2 {1.6 3.4}
=> \xcd\xcc\xcc\x3f\x9a\x99\x59\x40
   に相当するバイナリ値を返します。

r
単精度浮動小数点数をリトルエンディアン順に格納することを除いて、fと同じです。

この変換は、IEEE浮動小数点表現を使用するマシンで使用された場合にのみ意味のある出力を生成します（非常に一般的ですが、ユニバーサルではありません）。

R
単精度浮動小数点数をビッグエンディアン順に格納すること以外はrと同じです。

d
１つ以上の倍精度浮動小数点数を、マシンのネイティブ表現で出力します。それ以外は、fと同じです。

たとえば、Intel Pentiumプロセッサ上で実行されているWindowsシステムでは、

binary format d1 {1.6}
=> \x9a\x99\x99\x99\x99\x99\xf9\x3f
   に相当するバイナリ値を返します。

q
倍精度浮動小数点数をリトルエンディアン順に格納することを除いて、dと同じです。

この変換は、IEEE浮動小数点表現を使用するマシンで使用された場合にのみ意味のある出力を生成します（非常に一般的ですが、ユニバーサルではありません）。

Q
倍精度浮動小数点数をビッグエンディアン順で格納することを除いてqと同じです。

x
count個のnullバイトを出力します。countが指定されていない場合は、1バイトのnullを出力します。countが*の場合、エラーが発生します。

このタイプは引数を消費しません。 例えば、

binary format a3xa3x2a3 abc def ghi
=> abc\000def\000\000ghi に相当するバイナリ値を返します。

X
出力データのカーソル位置をcountバイト後ろに戻します。

countが*または現在のカーソル位置よりも大きい場合、カ－ソル位置は0に配置され、出力されている次のバイト値が最初のバイト値になります。countが省略された場合、カーソル位置は１バイト戻ります。

このタイプは引数を消費しません。例えば

binary format a3X*a3X2a3 abc def ghi
=>  dghi に相当するバイナリ値を返します。

[参考]

a3 ---------> abc_ カーソル位置3
a3X* -------> abc  カーソル位置が0に戻る
a3X*a3 -----> def_ カーソル位置3
a3X*a3X2 ---> def  カーソル位置が1に戻る。２バイト(2文字分)戻る。
a3X*a3X2a3 -> dghi を返す。

@
countで指定された出力データの絶対位置にカーソルを移動します。

位置0は、出力ストリングの最初のバイトを表します。countがこれまでに格納された最後のバイトを超えた位置を参照している場合は、nullバイトが初期化されていない位置に配置され、カーソルは指定された位置に配置されます。

countが*の場合、カーソルは出力データの現在の末尾に移動します。 countを省略すると、エラーが発生します。

このタイプは引数を消費しません。 例えば、

binary format a5@2a1@*a3@10a1 abcde f ghi j
=> abfdeghi\000\000j に相当するバイナリ値を返します。

[参考]

a5 --------------> abcde_            カーソル位置5
a5@2 ------------> abcde             カーソル位置2
a5@2a1 ----------> abfde             カーソル位置3
a5@2a1@* --------> abfde_            カーソル位置5
a5@2a1@*a3 ------> abfdeghi_         カーソル位置8
a5@2a1@*a3@10 ---> abfdeghi\000\000_ カーソル位置10
a5@2a1@*a3@10a1 -> abfdeghi\000\000j を返す。

次ページは、「binaryコマンドの日本語の扱いについて」

バイナリデータを扱う

Tclは基本的に文字列データを操作するようになっています。Tcl8.0からバリナリデータを操作する為にbinaryコマンドが追加されました。

[書式]

binary format formatString ?arg arg ...?
binary scan string formatString ?varName varName ...?

binaryコマンドの第１引数にformatを指定すると、文字列をバイナリに変換します。第１引数にscanを指定した場合はバイナリデータを文字列に変換します。

binaryコマンドを使うと文字列とバリナリデータを相互に変換することができます。

binaryコマンドのオプションは多数あります。最初にオプションを１つ１つ説明するよりも、まずは、バイナリデータの操作例を見て頂いてから、オプションの説明をした方が理解しやすいと思うので、バイナリデータの操作方法を紹介します。

バイナリデータの操作方法の説明でわからない部分は、オプションの説明を見た後に、再度バイナリデータの操作方法を見て頂くと、意味がわかるのではないかと思います。

※ファイルは前回使用のstr.txtを使います。

Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

[注意]
str.txtはUTF-8でエンコードされた文字列が書き込まれたファイルです。この記事の説明は、Tclの内部コードがUnicode(U+xxxx相当)で符号化方式をUTF-8で使用している環境で説明しています。

バイナリデータのファイルを読み書きする

バイナリデータを読み書きする方法を紹介します。

バイナリデータのファイルを読み込む

以下の例はバイナリデータのファイルを読み込んだ例です。

[使用例]

$ tclsh

% set fid [open str.txt r]
file5
% fconfigure $fid -translation binary
% puts [read $fid]                  
Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちã‚
おはã‚ãã”ãã
                 ます。
ãƒ

str.txtを文字データではなくバリナリデータとして読み込むには読み込むチャネルの設定を以下のように、binary に変更します。

fconfigure $fid -translation binary

または

chan configure $fid -translation binary

-translation binary を指定すると、改行コードの変換や、ファイルの終端(null)、文字コードのエンコードが無効にされます。

よって、readコマンドやgetsコマンドで読み込んだデータはただのバイトデータとして扱われます。

バイトデータが英数字(asciiコード)の範囲内であれば、文字として画面へ出力されますが、範囲外のバイトデータはエンコードが無効の為、文字化けします。

以下は、str.txtをUNIXのhexdumpコマンドで出力したものです。

$ hexdump str.txt -C
00000000  48 65 6c 6c 6f 21 20 48  65 6c 6c 6f 21 0a 47 6f  |Hello! Hello!.Go|
00000010  6f 64 20 6d 6f 72 6e 69  6e 67 21 0a 42 79 65 20  |od morning!.Bye |
00000020  62 79 65 21 0a 48 61 76  65 20 61 20 6e 69 63 65  |bye!.Have a nice|
00000030  20 64 61 79 21 0a e3 81  93 e3 82 93 e3 81 ab e3  | day!...........|
00000040  81 a1 e3 82 8f 0a e3 81  8a e3 81 af e3 82 88 e3  |................|
00000050  81 86 e3 81 94 e3 81 96  e3 81 84 e3 81 be e3 81  |................|
00000060  99 e3 80 82 0a e3 83 90  e3 82 a4 e3 83 90 e3 82  |................|
00000070  a4 0a e3 82 88 e3 81 84  31 e6 97 a5 e3 82 92 ef  |........1.......|
00000080  bc 81 0a                                          |...|
00000083

0a:改行コード(\n)

str.txtの文字列「こんにちわ」は、10進で55バイト目(16進で36バイト目)の位置にあります。

UTF-8では１文字を、ASCIIコードの範囲内は1バイト、それ以外の文字は2～6バイドで符号化します。0a(改行)までが1行の文字列なので、「こんににわ」の5文字は、1文字3バイトで構成されており、合計15バイトあることがわかります。

e38193 e38293 e381ab e381a1 e3828f 0a
　こ　　 ん　　 に　　 ち　　 わ　 \n

特定箇所のバイナリデータを読み込む

binary scanを使ってバイナリデータを文字列に変換する。

以下の例は、str.txtの「こんにちわ」の部分をバイナリデータとして読み込んで、読み込んだバイナリデータを16進数の表記と文字に変換させています。

[使用例]

$ tclsh

% set fid [open str.txt r]
file5
% fconfigure $fid -translation binary

% seek $fid 54 start              ----(1) 現在位置を移動
% set str [read $fid 16]          ----(2) 16バイド分を読み込み
こんにちã‚

% binary scan $str H* tmp         ----(3.1) 16進数に変換
1
% puts $tmp                       ----(3.2) 16進数で表示
e38193e38293e381abe381a1e3828f0a

% puts [encoding convertfrom utf-8 $str] ----(4) 文字コードに変換
こんにちわ

% close $fid
% exit

(1) 現在位置を移動
hexdumpの出力結果から、「こんにちわ」は10進で55バイト目にあることがわかっています。よって、直前の54バイト目まで現在位置をseekコマンドで移動させます。

(2) 16バイド分を読み込み
通常readコマンドの引数には文字数で指定します。binaryの指定によりエンコード・改行変換が無効になり、ただのバイトデータとして扱われるので、１文字１バイト(1バイト文字)として指定する。「こんにちわ」+ 改行(0a)の16バイト読み込む。読み込んだデータは文字の扱いではないので画面へ出力すると文字化けします。

(3) 16進数に変換・表示
読み込んだバイナリデータをbinary scanコマンドを使って16進数表記に変えて出力しています。引数Hは、バイナリデータを16進数表記の文字列に変換します。

(4) utf-8 に変換
変数strはバイナリデータなので、そのまま画面に出力すると文字化けします。

encoding convertfrom ?encoding? data 

このコマンドは、data を指定した encoding からUnicode(U+xxxx相当)に変換します。例の場合、変数strがUTF-8でエンコードされているとみなすので、結果的に文字として出力されます。

例えば、

encoding convertfrom utf-8 \xe3\x81\x93
encoding convertfrom shiftjis \x82\xb1
encoding convertfrom euc-jp \xa4\xb3
=> こ

上の３つの引数detaの部分は、「こ」をそれぞれのエンコーディングで表した文字コードです。出力時は、システムの環境に合わせて出力されるのでUnix、Windows、Mac OS Xどの環境であっても、ひらがなの「こ」が表示されます。

Unicode(U+xxxx相当)のデータを、引数encodingで指定したエンコードのデータに変換するには、以下のようにします。

encoding convertto shiftjis \u3053
=> 0x82b1 相当のバイナリデータ

ただし、変換された結果はTcl上では文字ではなくバイナリデータとしての扱いです。Unicodeの\u3053とSJISの0x82b1は平仮名の「こ」の文字コードになります。

binary scan [encoding convertto shiftjis \u3053] H* str
=> 1
puts $str
=> 82b1

binary scanの引数formatStringに”H*”を指定すると、バイナリデータを16進コードの文字列に変換します。

バイナリデータの書き込み

binary formatを使って文字列をバイナリデータに変換する。

以下の例は、文字列と16進数の表記の文字列をバイナリデータに変換してファイルに書き込みしています。

[使用例]

$ tclsh

% set str abcdefg           ----(1) 文字列
abcdefg
% set hex 00fffeaa55aa55ff  ----(2) 16進数
00fffeaa55aa55ff

% set fid [open hex.bin w]
file5
% fconfigure $fid -translation binary

% puts -nonewline $fid [binary format a* $str]  ----(3)
% puts -nonewline $fid [binary format H* $hex]  ----(4)

% close $fid
% exit

$ cat hex.bin          ----(5)
abcdefg���U�U�

$ hexdump hex.bin -C   ----(6)
00000000  61 62 63 64 65 66 67 00  ff fe aa 55 aa 55 ff     |abcdefg....U.U.|
0000000f

(1)(2)
文字列と16進数表記のデータを準備。

(3)(4)
引数aは、文字列データをバイナリデータに変換します。引数Hは、16進数表記の文字列をバイナリデータに変換します。

(5)
バイナリデータを書き込んだファイルなので、画面に出力すると文字化けします。

(6)
UNIXのhexdumpコマンドで確認すると、文字ではなくバイトデータとして書き込まれていることが確認できます。
*ASCIIコードの55は大文字の”U”です。

binary formatコマンドの使い方については以下の記事で紹介しています。

Tcl - バイナリデータの操作(2) -binary format-

Tclでバイナリデータを取り扱うにはbinaryコマンドを使います。この記事ではbinary formatの引数 formatString に指定できる値と使い方について紹介します。

blog.it-see.net

2019.10.31

binary scanコマンドの使い方については以下の記事で紹介しています。

Tcl - バイナリデータの操作(3) -binary scan-

Tclでバイナリデータを取り扱うにはbinaryコマンドを使います。この記事ではbinary scanの引数 formatString に指定できる値と使い方について紹介します。

blog.it-see.net

2019.11.07

seekコマンドとtellコマンド

[書式]

seek channelId offset ?origin?

seekコマンドはchannelIdのアクセス位置を変更します。

offsetとoriginはchannelIdの次の読み書きを行う位置を指定します。offsetは整数でなければならず（負数でもよい）、originは次のいずれかでなければならない。

start
新しいアクセス位置は、ファイルの先頭からoffsetで指定したバイト位置になります。

current
新しいアクセス位置は、現在のアクセス位置からoffsetで指定したバイト位置になります。offsetに負数を指定すると、アクセス位置を後方に移動させます。

end
新しいアクセス位置は、ファイルの末尾からoffsetで指定したバイト位置になります。負数を指定すると、ファイルの終端の手前にアクセス位置を置き、正数を指定すると、ファイルの終端の後ろに置きます。

originのデフォルト値はstartです。このコマンドは空文字列を返します。

[書式]

tell channelId

tellコマンドは、channelIdの現在位置を返します。seekをサポートしないチャネルの場合、-1 を返します。このコマンドも、文字ではなくバイトの観点で動作します。

※ファイルは前回の、str.txt を使用します。

Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

[使用例]

$ tclsh

# open時。
% set fid [open str.txt r]
file5
% tell $fid
0

# 3バイト進めて出力する。
% seek $fid 3
% puts [gets $fid]
lo! Hello!
% tell $fid
14

# 残りを出力する。
% puts [read -nonewline $fid]
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

% tell $fid
131

上の例は、3バイト進めた位置から１行分の出力を行い、残りをreadコマンドで出力しています。

ファイルの入出力(3) のrw6a.tclで文字数の総数を数えるプログラムを紹介しましたが、最後のtellコマンドの結果は、文字数の総数より値が多く、文字ではなくバイトの観点で動作していることが分かります。

ファイルのエラー処理

これまでファイルの入出力(x)で紹介したファイルを開く操作はファイルオープンする際のエラーを考慮していませんでした。

ファイルを開く際に発生するエラー(ファイルの有無など)をcatchコマンドまたはfile existsコマンド使って捕捉し、エラー処理を行う方法を２つ紹介します。

※ファイルは前回の、str.txt を使用します。

[str.txt]

Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

ファイルの存在を確認する – file exists

ファイルを書き込みモードで開く方法として、これまで紹介したやり方は、openコマンドの引数に w または a を指定するものでした。

この指定方法では、存在しないファイルを指定すると新しいファイルを作成して処理を続行します。

ファイルが存在しない場合は処理を中止したり、存在しない為、新規で作成する旨の通知を行いたいこともあるかと思います。

また、ファイルを読み込む場合も、指定したファイルが存在しない場合には、メッセージを表示したいこともあると思います。

そういう時は、fileコマンドのexistsオプションでファイルの有無を確認できます。

[書式]

file exists name

ファイル名 name が存在し、現在のユーザーがそれに続くディレクトリに対する検索権限を持っている場合は1を返し、それ以外の場合は0を返します。

例えば、ファイルの入出力(3)で使用した、nl.tcl で、存在しないファイルを指定した場合、以下のエラーメッセージを画面に出力します。

$ ./nl.tcl aaa.txt
couldn't open "aaa.txt": no such file or directory
    while executing
"open $fname r"
    invoked from within
"set fid [open $fname r]"
    (file "./nl.tcl" line 10)

出力されたメッセージの内容を見るとエラーが発生したプログラムコードの箇所が表示されています。

Tclが出力するこのようなエラーメッセージを使用者には見せたくないという事もあると思います。

このエラーメッセージを画面に表示させなくするには次のサンプルのようにします。

以下のサンプルは file exists を使用して上記のエラーメッセージを表示させずに、「aaa.txt はありません」と表示するようにしています。

[サンプル] nl2.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# 各行の先頭に行番号を付加して画面に出力する。

set fname [lindex $argv 0]    ;# ファイル名の取得

# ファイルの有無を確認後に読み込む。

if {[file exists $fname] == 1} {
    set fid [open $fname r]
    while {[gets $fid line] >= 0} {
        lappend strlst $line
    }
    close $fid

} else {
    puts "$fname はありません"
    exit  ;# プログラムの終了
}

# 各行の先頭に行番号を付ける。

set n 1    ;# 行番号
foreach tmp $strlst {
    puts [format "%03d : %s" $n $tmp]
    incr n
}

[実行例]

$ ./nl2.tcl aaa.txt
aaa.txt はありません

$ ./nl2.tcl str.txt
001 : Hello! Hello!
002 : Good morning!
003 : Bye bye!
004 : Have a nice day!
005 : こんにちわ
006 : おはようございます。
007 : バイバイ
008 : よい1日を！

エラーを捕捉する – catch

catchコマンドは、引数の数が違っていたり、Tclコマンドやプロシージャを実行した際に発生するエラーを捕捉する為に使います。

エラーを捕捉する事で、プログラムの異常終了や中断するのを防ぎます。

[書式]

catch script ?resultVarName? ?optionsVarName?

第１引数のscriptは、Tclコマンドやプロシージャを指定します。
第２引数のresultVarNameはscriptの実行結果を保存する変数名を指定します。

scriptでエラーが発生すると、catchコマンドは、例外的なリターンコードを示す0以外の整数値を返します。正常時は、0 (TCL_OK)を返します。

例外的なリターンコードとして以下が定義されています。

1. TCL_ERROR
2. TCL_RETURN
3. TCL_BREAK
4. TCL_CONTINUE

resultVarNameが指定されている場合、scriptでエラーが発生すると、resultVarNameには、エラーメッセージが格納されます。正常時は、scriptから返された値が格納されます。

※optionsVarNameの使い方については、catch, return のマニュアルを参照してください。

catchコマンドを使用してエラーを捕捉するには以下のようにします。

[サンプル]] nl3.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# 各行の先頭に行番号を付加して画面に出力する。

set fname [lindex $argv 0]    ;# ファイル名の取得

# ファイルの読み込み。

if {[catch {open $fname r} fid]} {
    puts stderr "$fname がオープンできません"
    exit  ;# プログラムの終了
} else {
    while {[gets $fid line] >= 0} {
        lappend strlst $line
    }
    close $fid
}

# 各行の先頭に行番号を付ける。

set n 1    ;# 行番号
foreach tmp $strlst {
    puts [format "%03d : %s" $n $tmp]
    incr n
}

[実行例]

$ ./nl3.tcl aaa.txt
aaa.txt がオープンできません

$ ./nl3.tcl str.txt
001 : Hello! Hello!
002 : Good morning!
003 : Bye bye!
004 : Have a nice day!
005 : こんにちわ
006 : おはようございます。
007 : バイバイ
008 : よい1日を！

上のサンプルはTclのエラーを出力させずに「aaa.txt がオープンできません」と表示するようにしています。

catch {open $fname r} fid

エラー発生時、第２引数の fid には、エラーメッセージが格納されますが、正常時は、ファイル識別子が格納されます。

上のサンプルでは、正常時のみ変数fidを使用しています。

puts stderr "$fname がオープンできません"

標準出力ではなく標準エラーに出力するようにしています。

これには理由がありまして、例えば、ファイルの内容や処理結果を標準出力へ出力するようなプログラムがあるとします。これをリダイレクションの機能を使って別のファイルへコピーしたとします。

例.

$ ./xxxxx.tcl > tmp.txt

エラーメッセージを標準出力へ出力するようにしていると、コピー中にエラーが発生した場合、そのメッセージも一緒にコピーされてしまいます。

エラーメッセージを標準エラーに出力するようにしていると、エラーメッセージは画面に出力されるので、一緒にコピーされることを防ぐことができます。

catchコマンド及びTclで捕捉したエラーについて

catchコマンドで捕捉したエラーは第２引数に格納されます。Tclで捕捉したエラーはTclのグロ－バル変数のerrorInfoとerrorCodeに格納されています。

メッセージの違いを確認する為に、nl3.tcl のメッセージを出力する部分を以下のように書き換えて実行してみます。

puts stderr "$fname がオープンできません"
puts stderr "fid  : $fid"
puts stderr "info : $errorInfo"
puts stderr "code : $errorCode"

[実行例]

$ ./nl3.tcl aaa.txt
aaa.txt がオープンできません
fid  : couldn't open "aaa.txt": no such file or directory
info : couldn't open "aaa.txt": no such file or directory
    while executing
"open $fname r"
code : POSIX ENOENT {no such file or directory}

「aaa.txt がオープンできません」だけでは分からないので以下のように出力するようにしてもいいかも知れません。

puts stderr "$fname がオープンできません\n$fid"

[実行例]

$ ./nl3.tcl aaa.txt
aaa.txt がオープンできません
couldn't open "aaa.txt": no such file or directory

chanコマンドについて

Tcl8.5で入出力関係のコマンドが、chanコマンドに集約されました。

以下の表の# xxxxx のコマンドが左側のchanコマンドに追加されています。

      chan blocked    ; # fblocked
      chan close      ; # close
      chan configure  ; # fconfigure
      chan copy       ; # fcopy
      chan eof        ; # eof
      chan event      ; # fileevent
      chan flush      ; # flush
      chan gets       ; # gets
      chan names      ; # file channels
      chan puts       ; # puts
      chan read       ; # read
      chan seek       ; # seek
      chan tell       ; # tell
      chan truncate   ; # ftruncate

[非推奨]
      fblocked
      fconfigure
      fcopy
      fileevent
      file channels

非推奨になっているコマンドは今後、廃止になる可能性がある為、chanコマンドで書き換えができるよう選り分けることが勧められています。

[参考]

Tcl Improvement Proposals: TIP 208: Add a ’chan’ Command

core.tcl.tk

ファイルのコピー

ファイルをコピーするプログラムを２つ紹介します。

※ファイルは前回の、str.txt を使用します。

[str.txt]

Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

readコマンドを使う方法

[サンプル] copy1.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# ファイルをコピーする

set fid1 [open str.txt r]
set fid2 [open str.cp1.txt w]

puts $fid2 [read -nonewline $fid1]

close $fid1
close $fid2

[実行例]

$ ls str*
str.txt

$ ./copy1.tcl
$ ls str*
str.cp1.txt  str.txt

$ cat str.cp1.txt
Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

fcopy(chan copy)コマンドを使う方法

[書式]

fcopy inChan outCchan ?-size size? ?-command callback?
chan copy inChan outChan ?-size size? ?-command callback?

fcopyコマンドは、inChanから別のoutChanにデータをコピーします。

-sizeを指定しない場合、コピーはファイルの最後まで行われます。-sizeに指定するサイズは、2つのチャンネルが同じエンコーディングを使用している場合、サイズはバイトで、それ以外の場合は文字数です。

-commandを指定しない場合、fcopyはコピーが完了するまでブロックされ、outChanに書き込まれたバイト数または文字数を返します。

-commandを指定すると、fcopyはバックグラウンドで動作します。この場合、即座に戻り、callbackはコピーの完了後に呼び出されます。

callbackは、outChanに書き込まれたバイト数を示す1つまたは2つの追加の引数で呼び出されます。バックグラウンド・コピー中にエラーが発生した場合、2番目の引数はエラーに関連するエラー文字列です。

※ -size, -commandを使用した例はここでは紹介しません。

[サンプル] copy2.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# ファイルをコピーする その２

set fid1 [open str.txt r]
set fid2 [open str.cp2.txt w]

fcopy $fid1 $fid2

close $fid1
close $fid2

[実行例]

$ ./copy2.tcl
$ ls str*
str.cp1.txt  str.cp2.txt  str.txt

$ cat str.cp2.txt
Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

fcopyコマンドの代わりにchanコマンドを使う場合は以下のようにします。

chan copy $fid1 $fid2

文字コードと改行コード

tclの内部では文字コードにUTF-8、改行コードはLFを採用していますが、入出力処理においての文字コードと改行コードは使用環境に自動的に合わせてくれます。

※ファイルの文字コードを自動的に変換してくれるという意味ではないです。

以下は主な環境で使われているパターンです。

Windows
文字コード：シフトJIS、改行コード：CR+LF(\r\n)
※正確には文字コード：CP932

UNIXライクなOS
文字コード：UTF-8、改行コード：LF(\n)
※古い環境では文字コード：EUCが使われている場合もあります。

Mac OS X
文字コード：UTF-8、改行コード：LF(\n)

旧Mac(OS 9 以前)
文字コード：シフトJIS、改行コード：CR(\r)
※正確には文字コード：MacJapanese

[補足]

CP932
マイクロソフトがShift_JISを独自に拡張した文字コード。よってCP932の文字コードで作成されたファイルの入出力にShift_JISを指定するとローマ数字など一部の文字で文字化けが発生します。

MacJapanese
アップルがShift_JISを独自に拡張した文字コード。よってCP932の文字コードで作成されたファイルの入出力にShift_JISを指定するとローマ数字など一部の文字で文字化けが発生します。

LF : Line Feed(改行:0x0a)
CR : Carriage Return(復帰:0x0d)

Tclで使用できる主なエンコードの名前

　　iso2022-jp: JIS
　　shiftjis  : SJIS
　　euc-jp    : EUC
　　utf-8     : Unicode(UTF-8)
　　cp932     : MS-SJIS
　　macJapan  : 旧MACのSJIS

Tclで使用できるエンコードの名前は以下のコマンドで確認できます。

$ tclsh
% encoding names
cp860 cp861 cp862 cp863 tis-620 cp864 cp865 cp866 gb12345 gb2312-raw cp949 cp950
cp869 dingbats ksc5601 macCentEuro cp874 macUkraine jis0201 gb2312 euc-cn 
euc-jp macThai iso8859-10 jis0208 iso2022-jp macIceland iso2022 iso8859-13
iso8859-14 jis0212 iso8859-15 cp737 iso8859-16 big5 euc-kr macRomania macTurkish
iso2022-kr gb1988 macGreek ascii cp437 macRoman iso8859-1 iso8859-2 iso8859-3 
macCroatian iso8859-4 koi8-r ebcdic iso8859-5 cp1250 macCyrillic iso8859-6 cp1251
macDingbats iso8859-7 koi8-u cp1252 iso8859-8 cp1253 iso8859-9 cp1254 cp1255 
cp850 cp1256 cp932 identity cp1257 cp852 macJapan cp1258 shiftjis utf-8 cp855 
cp936 symbol cp775 unicode cp857

Tclでは、文字コードと改行コードを使用環境に合わせてくれるので同じ環境で使用する限りは気にする必要はありませんが、他の環境へファイルを持っていったり、他の環境で使われていたファイルを読み込む場合は、文字コードを変換する必要が生じる事があります。

以下のサンプルは文字コードをUTF8→CP932に変更した新しいファイルを作るプログラムです。

[サンプル] enc.tcl

#!/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"

# utf-8 -> shiftjis(cp932) へ変更してコピーする

set fid1 [open str.txt r]
set fid2 [open str.sjis.txt w]

fconfigure $fid2 -translation crlf -encoding cp932

puts $fid2 [read -nonewline $fid1]

close $fid1
close $fid2

[実行例]

$ ./enc.tcl
$ ls str*
str.cp1.txt  str.cp2.txt  str.sjis.txt  str.txt

# そのまま表示させると文字化けする。
$ cat str.sjis.txt
Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
�����ɂ���
���͂悤�������܂��B
�o�C�o�C
�悢1�����I


# 改行コードがCRLFで保存されていることを確認。
$ file str.sjis.txt
str.sjis.txt: Non-ISO extended-ASCII text, with CRLF line terminators

# iconvで文字コードを変換して表示させる。
$ iconv -f CP932 -t UTF-8 str.sjis.txt
Hello! Hello!
Good morning!
Bye bye!
Have a nice day!
こんにちわ
おはようございます。
バイバイ
よい1日を！

上のサンプルでは、str.sjis.txtへ出力する際に使用する文字コードと改行コードをfconfigureコマンドで変更しています。

これも、fconfigureコマンドの代わりにchanコマンドを使う場合は以下のようにします。

chan configure $fid2 -translation crlf -encoding cp932

iconvは比較的に新しいUNIXライクなOSであれば標準でインストールされていると思います。

次回は、ファイルを開く時のエラー処理について紹介します。