Web上での「文芸的プログラミング」

文芸的プログラミングとは

WEBシステムは 文芸的プログラミングを支援するためにKnuthが開発したシステムである。 WEBシステムはもともとKnuthのTeXシステムを記述するために開発 されたものなのでPascalとTeXが対象になっているが、 Cが使えるようにしたCWEBシステム Cとtroffとの組み合わせが使えるcwebシステム、 任意のプログラミング言語に対応させることのできる Spiderといったシステムも開発されている。

WEBの処理

図1: WEBの処理

WEB文書は複数のプログラムモジュールの集合という形になっており、 各モジュールはその解説部分とプログラム部分とで構成される。 WEB文書をtangleというプログラムに通すと プログラム部だけが抽出されてひとつのPascalプログラムになり、 weaveというプログラムに通すと解説部とプログラム部の 両方が融合したTeXの文書になる。 ここではプログラム部は美しくフォーマットされ、 モジュール毎に章立てが行なわれ、 目次や索引も完備した完全なドキュメントが生成される。 このように、ひとつのWEBファイルからプログラムと そのドキュメントの両方を生成することができるのが特長である。

WEB on Web

WEB文書のかわりに普通のHTMLファイルを使うようにすれば このような問題は解決すると考えられる。 プログラムをHTMLファイルの中に記述するという形式で 文芸的プログラミングを行なうことにすれば、 tangleに相当するプログラムは必要であるが、 weave関連プログラムはすべて省略して 直接HTMLファイルをブラウザで眺めることができる。 HTMLファイルに対して tangleに相当する処理を行なう wtangleプログラムを開発した。

wtangleプログラム

プログラム

#!/usr/bin/env perl
#
# wtangle - Web Tangle
#
&prologue;
&main;
&epilogue;

sub prologue {
  require 'cacheout.pl'; # 複数ファイル出力ライブラリ
  if($#ARGV < 0){
    print STDERR "wtangle --- Web Tangle\n";
    print STDERR "Usage: wtangle documentfiles\n";
    exit 0;
  }
  $SIG{'INT'} = $SIG{'TERM'} =
  $SIG{'QUIT'} = $SIG{'HUP'} = 'finish';
}

メインルーチン

sub main {
  while($file = shift(@ARGV)){
    unless(open(f,$file)){
      print STDERR "Can't open <$file>\n";
      &finish;
    }
    while(){
      if(m#^${lt}/pre>$#){
        @tmpfiles = ();
      }
      elsif(m#^${lt}pre\s*file=(.*)>$#){
        @files = split(/,/,$1);
        @tmpfiles = ();
        foreach $file (@files){
          $allfiles{$file} = 1;
          push(@tmpfiles,&tmpname($file));
        }
      }
      else {  # cachout()を使って現在行を各ファイルに書き出す
        foreach $tmpfile (@tmpfiles){
          &cacheout($tmpfile);
          $taghead = pack(c,60);
          s/&.{0}lt;/$taghead/g;
          print $tmpfile $_;
        }
      }
    }
    close(f);
  }
}

sub epilogue {
  foreach $file (keys %allfiles){
    $tmpfile = &tmpname($file);
    close($tmpfile);
    if(! -e $file || &diff($tmpfile,$file)){
      push(@newfiles,$file);
      &move($tmpfile,$file);
      chmod 0555,$file; # 書込み禁止/実行可能にする
    }
  }
  sort @newfiles;
  $n = $#newfiles + 1;
  print STDERR 
    $n == 0 ? "No file is updated.\n" :
    $n == 1 ? "File '$newfiles[0]' is updated.\n" :
      "Files '".join("', '",@newfiles[0..$n-2]).
      "' and '".$newfiles[$n-1]."' are updated.\n";
  &finish;
}

サブルーチン

sub tmpname { local($_) = @_; s#/#_#g; "/tmp/stangle$_$$"; }	テンポラリに使用されるファイル名を計算する。
sub finish { foreach $file (keys %allfiles){ $tmpfile = &tmpname($file); # unlink($tmpfile) if -e $tmpfile; } exit; }	テンポラリに使用されたファイルを全て削除してから プログラムを終了する。
sub move { local($from,$to) = @_; return if $from eq $to; system "/bin/mv -f $from $to"; if($?){ # mv実行エラー print STDERR "Can't move $from to $to\n"; &finish; } }	ファイル移動を行なう。 簡単のためmvコマンドを使用している。
sub diff { local($file1,$file2) = @_; system "/usr/bin/diff $file1 $file2 > /dev/null"; $? >> 8; # コマンドステータス }	ファイル比較を行なう。 簡単のためdiffコマンドを使用している。

感想など

更新履歴