スキップしてメイン コンテンツに移動

SelectSaver の話

筆者の好きな Perl 5 標準モジュールの話をする。実用性は特にない。

SelectSaver というモジュールを知っているだろうか。 なにしろラクダ本にも載っている天下の標準モジュールである。ちょっとでも Perl 5 をかじったことのあるプログラマなら知っているだろう。1

それでこれは何かというと、オブジェクト生成時にファイルハンドルを select し、破棄時に元のファイルハンドルを再び select するガードオブジェクト、要するに select 専用 Scope::Guard である。

このモジュールの意義を知るためにはまず select を知る必要がある。 ニワカでなければ誰でも知っていることだが2、Perl 5 の select は無ないし一引数版 (以下 Prolog 風に select/1 と書く) と三ないし四引数版 (同 select/4) でセマンティクスが丸っきり違う。実質オーバーロードされていると言って良い。 select/4 は単にシステムコール select(2) の Perl 版だが、select/1print / say / write / $| (AUTOFLUSH) などが使うデフォルトのファイルハンドルを選択するという全く無関係な機能を提供する。 標準出力をリダイレクトするわけではない。STDOUT はそのままで print みたいな標準関数や $| みたいな特殊変数が指定されたファイルハンドルを使うようになるだけである。また戻り値は直前に select されていたファイルハンドルを返す。ちなみに引数なしで呼び出すと現在の設定を変更せずに同じ値を返す。

プロセスのグローバルな状態を書き換えるなんとも C っぽい関数だが、例えば一つのファイルにひたすら書き出すときにファイルハンドルを省略できて便利である:

sub print_batch {
  my ($fh) = @_;
  my $old_fh = select $fh;

  print ...;
  print ... if ...;
  print ... for 1 .. 10;
  failable_instruction(...);  # XXX: 失敗し得る関数呼出し
  ...
  
  select $old_fh;
}

しかし上記の関数には問題がある。例外安全でないことだ。 もし failable_instructiondie すると select $old_fh が呼ばれないまま関数から脱出してしまい、$old_fh が何だったのか復元する方法はない。

このようなシナリオで活躍するのが SelectSaver である。C++ でお馴染みの RAII で自分が生まれたときに select されていたファイルハンドルを死ぬときに返してくれる:

sub print_batch {
  my ($fh) = @_;
  # 生成時に渡した $fh が select される。元のファイルハンドルは $saver が覚えている
  my $saver = SelectSaver->new($fh);

  print ...;
  print ... if ...;
  print ... for 1 .. 10;
  failable_instruction(...);
  ...

  # failable_instruction が死んでも関数が末尾に到達しても $saver のスコープを抜けるので元のファイルハンドルを `select` し直す
}

自分が死んでも約束を果たす、今どきこんな義理堅い奴はちょっといないだろう。いや実際は「死んだら約束を果たす」なので保険がかけられた借金オヤジかも知らんが。

実装は非常に簡潔である:

use Carp;
use Symbol;

sub new {
    @_ >= 1 && @_ <= 2 or croak 'usage: SelectSaver->new( [FILEHANDLE] )';
    my $fh = select;
    my $self = bless \$fh, $_[0];
    select qualify($_[1], caller) if @_ > 1;
    $self;
}
 
sub DESTROY {
    my $self = $_[0];
    select $$self;
}

コンストラクタで元のファイルハンドルへのリファレンス自身を bless しておき、デストラクタはそれをもう一度 select するだけ。SV 一個で済んで実にエコ。

少しややこしいのは select qualify($_[1], caller) の箇所だろうか。ここにはファイルハンドルを裸のワードとして扱ってきた歴史的経緯が見える。 qualify は Symbol モジュールが提供する関数で、第一引数が文字列かつそれが識別子の修飾名でなければ第二引数のパッケージに存在する識別子として修飾名を返す。 裸のワードは同名の関数がなければ文字列として扱われるので、呼出し元パッケージ (caller の戻り値; qualify のプロトタイプが $;$ なのでスカラコンテキストで呼ばれる) のグローバルなファイルハンドル識別子が得られる訳である。 ちなみに裸のワードでなく近頃 (i.e., 90年代中頃から) の流儀に沿ってグロブへのリファレンスを渡した場合は qualify が第一引数自身を返すので結局問題ない。

以上、Perl 5 の標準モジュールで筆者が最も好きな SelectSaver を紹介した。その魅力は

  • 名前の格好良さ
  • 実装の簡潔さ
  • 馬鹿馬鹿しいほど単機能にも関らず標準モジュールという事実

に尽きると思われる。たまに商用のプログラムに使ってみるのも一興である。


  1. 単なる煽り。ラクダ本が今手元にないのでうろ覚えだが「この本を頭から読んでいる人 (あなたは勇者である!) 云々」という記述からして著者たちさえ全部読むとは想定していない。

  2. これは本当。

コメント

このブログの人気の投稿

C の時間操作関数は tm 構造体の BSD 拡張を無視するという話

久しぶりに C++ (as better C) で真面目なプログラムを書いていて引っかかったので備忘録。 「拡張なんだから標準関数の挙動に影響するわけねえだろ」という常識人は読む必要はない。 要旨 time_t の表現は環境依存 サポートしている時刻は UTC とプロセスグローバルなシステム時刻 (local time) のみで、任意のタイムゾーン間の時刻変換を行う標準的な方法はない BSD / GNU libc は tm 構造体にタイムゾーン情報を含むが、tm -> time_t の変換 ( timegm / mktime ) においてその情報は無視される 事前知識 C 標準ライブラリにおいて時刻の操作に関係するものは time.h (C++ では ctime) ヘッダに定義されている。ここで時刻を表現するデータ型は2つある: time_t と tm である。time_t が第一義的な型であり、それを人間が扱い易いように分解した副次的な構造体が tm という関係になっている。なので標準ライブラリには現在時刻を time_t として取得する関数 ( time_t time(time_t *) ) が先ずあり、そこから time_t と tm を相互に変換する関数が定義されている。 ここで time_t の定義は処理系依存である。C / C++ 標準はそれが算術型であることを求めているのみで (C11 からは実数型に厳格化された)、その実体は任意である。POSIX においては UNIX epoch (1970-01-01T00:00:00Z) からのうるう秒を除いた経過秒数であることが保証されており Linux や BSD の子孫も同様だが、この事実に依存するのは移植性のある方法ではない。 一方で tm は構造体であり、最低限必要なデータメンバが規定されている: int tm_year : 1900 年からの年数 int tm_mon : 月 (0-based; 即ち [0, 11]) int tm_mday : 月初からの日数 (1-based) int tm_hour : 時 (Military clock; 即ち [0, 23]) int tm_min : 分 int tm_sec : 秒 (うるう秒を含み得るので [0...

Perl のサブルーチンシグネチャ早見表

Perl のサブルーチン引数といえば実引数への参照を保持する特殊配列 @_ を手続き的に分解するのが長らくの伝統だった。これはシェルの特殊変数 $@ に由来する意味論で、おそらく JavaScript の arguments 変数にも影響を与えている。 すべての Perl サブルーチンはプロトタイプ宣言がない限りリスト演算子なので、この流儀は一種合理的でもあるのだが、実用的にそれで良いかというとまったくそうではないという問題があった; 結局大多数のサブルーチンは定数個の引数を取るので、それを参照する形式的パラメータが宣言できる方が都合が良いのである。 そういうわけで実験的に導入されたサブルーチンシグネチャ機能により形式的パラメータが宣言できるようになったのは Perl 5.20 からである。その後 Perl 5.28 において出現位置がサブルーチン属性の後に移動したことを除けば Perl 5.34 リリース前夜の今まで基本的に変わっておらず、未だに実験的機能のままである。 おまじない シグネチャは前方互換性を持たない (構文的にプロトタイプと衝突している) 実験的機能なのでデフォルトでは無効になっている。 そのため明示的にプラグマで利用を宣言しなければならない: use feature qw/signatures/; no warnings qw/experimental::signatures/; どの途みんな say 関数のために使うので feature プラグマは問題ないだろう。実験的機能を断りなしに使うと怒られるので、 no warnings で確信犯であることをアピールする必要がある。 これでプラグマのスコープにおいてサブルーチンシグネチャ (と :prototype 属性; 後述) が利用可能になり、 従来のプロトタイプ構文が無効になる。 使い方 対訳を載せておく。シグネチャの方は実行時に引数チェックを行うので厳密には等価でないことに注意: # Old School use feature qw/signatures/ 1 sub f { my ($x) = @_; ... } sub f($x) { ... } 2 sub f { my ($x, undef, $y) = @_...

BuckleScript が ReScript に改称し独自言語を導入した

Via: BuckleScript Good and Bad News - Psellos OCaml / ReasonML 文法と標準ライブラリを採用した JavaScript トランスパイラである BuckleScript が ReScript に改称した。 公式サイトによると改称の理由は、 Unifying the tools in one coherent platform and core team allows us to build features that wouldn’t be possible in the original BuckleScript + Reason setup. (単一のプラットフォームとコアチームにツールを統合することで従来の BuckleScript + Reason 体制では不可能であった機能開発が可能になる) とのこと。要は Facebook が主導する外部プロジェクトである ReasonML に依存せずに開発を進めていくためにフォークするという話で、Chromium のレンダリングエンジンが Apple の WebKit から Google 主導の Blink に切り替わったのと似た動機である (プログラミング言語の分野でも Object Pascal が Pascal を逸脱して Delphi Language になったとか PLT Scheme (の第一言語) が RnRS とは別路線に舵を切って Racket になったとか、割とよくある話である。) 公式ブログの Q&A によると OCaml / ReasonML 文法のサポートは継続され、既存の BuckleScript プロジェクトは問題なくビルドできるとのこと。ただし現時点で公式ドキュメントは ReScript 文法のみに言及しているなど、サポート水準のティアを分けて ReScript 文法を優遇することで移行を推進していく方針である。 上流である OCaml の更新は取り込み、AST の互換性も維持される。将来 ReScript から言語機能が削除されることは有り得るが、OCaml / ReasonML からは今日の BuckleScript が提供する機能すべてにアクセスできる。 現時点における ReScript の ...

開発環境の構築に asdf が便利なので anyenv から移行した

プロジェクト毎に異なるバージョンの言語処理系やツールを管理するために、pyenv や nodenv など *env の利用はほとんど必須となっている。 これらはほとんど一貫したコマンド体系を提供しており、同じ要領で様々な環境構築ができる非常に便利なソフトウェアだが、それを使うことで別の問題が出てくる: *env 自身の管理である。 無数の *env をインストールし、シェルを設定し、場合によりプラグインを導入し、アップデートに追従するのは非常に面倒な作業だ。 幸いなことにこれをワンストップで解決してくれるソリューションとして anyenv がある。これは各種 *env のパッケージマネージャというべきもので、一度 anyenv をインストールすれば複数の *env を簡単にインストールして利用できる。さらに anyenv-update プラグインを導入すればアップデートまでコマンド一発で完了する。素晴らしい。 そういうわけでもう長いこと anyenv を使ってきた。それで十分だった。 ——のだが、 ここにもう一つ、対抗馬となるツールがある。 asdf である。anyenv に対する asdf の優位性は大きく2つある: 一貫性と多様性だ。 一貫性 “Manage multiple runtime versions with a single CLI tool” という触れ込み通り、asdf は様々な言語やツールの管理について一貫したインタフェースを提供している。対して anyenv は *env をインストールするのみで、各 *env はそれぞれ個別のインタフェースを持っている。 基本的なコマンド体系は元祖である rbenv から大きく外れないにしても、例えば jenv のように単体で処理系を導入する機能を持たないものもある。それらの差異はユーザが把握し対応する必要がある。 多様性 asdf はプラグインシステムを持っている。というより asdf 本体はインタフェースを規定するだけで、環境構築の実務はすべてプラグイン任せである。 そのプラグインの数は本稿を書いている時点でおよそ 300 を数える。これは言語処理系ばかりでなく jq などのユーティリティや MySQL のようなミドルウェアも含むが、いずれにしても膨大なツールが asdf を使えば...

macOS で GUI 版 Emacs を使う設定

macOS であっても端末エミュレータ上で CLI 版 Emacs を使っているプログラマは多いと思うが、端末側に修飾キーを取られたり東アジア文字の文字幅判定が狂ってウィンドウ描画が崩れたりなどしてあまり良いことがない。 それなら GUI 版の Emacs.app を使った方がマウスも使える上に treemacs などはアイコンも表示されてリッチな UI になる。 しかし何事も完璧とはいかないもので、CLI だと問題なかったものが GUI だと面倒になることがある。その最大の原因はシェルの子プロセスではないという点である。つまり macOS の GUI アプリケーションは launchd が起動しその環境変数やワーキングディレクトリを引き継ぐので、ファイルを開こうとしたらホームディレクトリ ( ~/ ) でなくルートディレクトリ ( / ) を見に行くし、ホームディレクトリなり /opt/local なりに好き勝手にインストールしたツールを run-* 関数やら shell やら flycheck やらで実行しようとしてもパスが通っていない。 ワーキングディレクトリに関しては簡単な解決策があり、 default-directory という変数をホームディレクトリに設定すれば良い。ただし起動時にスプラッシュスクリーンを表示する設定の場合、このバッファのワーキングディレクトリは command-line-default-directory で設定されており、デフォルト値が解決される前に適用されてしまうので併せて明示的に初期化する必要がある: (setq default-directory "~/") (setq command-line-default-directory "~/") 次にパスの問題だが、まさにこの問題を解決するために exec-path-from-shell というパッケージがある。これを使うとユーザのシェル設定を推定し、ログインシェルとして起動した場合の環境変数 PATH と MANPATH を取得して Emacs 上で同じ値を setenv する、という処理をやってくれる。MELPA にあるので package-install するだけで使えるようになる。 このパッケージは GUI ...