rcsview のページ

これは何?

RCS ファイルをながめるためのツールです。 C で記述されたバックエンドと、 emacs lisp によるフロントエンドから構成されます。

バックエンドプログラムは単独で起動することも可能で、 RCS ファイルに対して "cvs annotate" 相当の内容を出力する機能をおまけとして持っています。

emacs 上で動作するフロントエンドは、バッファ中での「ドット」位置を保存したまま、リビジョンを前後に移動する機能があります。というか、それだけで、今のところ実用性はありません。もう少し機能を加えると多少使いものになるかもしれません。 emacs 上のスクリーンダンプ例黄色の部分は、そのリビジョンで新規に追加された行を意味しています。

配布とライセンス

tar ball をダウンロードして下さい。ちなみに、フロントエンドのソースコードと、バックエンドのソースコードも置いてありますが、 tar ball 中に入っています。 (google キャッシュによる分散バックアップ期待)

ライセンスは次の通りです(修正BSDライセンス)。

Copyright (c) 2002 Atsushi Furuta.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ただし、配布の都合上、将来のバージョンについては別のライセンス (自由に利用可能であって、再配布が自由なもの)を付与したものも公開する可能性があります。しかしながら今後、少くとも修正BSDライセンスのものはリリースを続けるつもりではあります。

もしこの配布方針に賛成できなければ、どうかパッチを送ってこないでください。

コンパイルとインストール

tar ball を展開して、自力でコンパイルしてください。

バックエンド

バックエンドは ANSI-C 準拠で書いてあるつもりでいます。大抵の UNIX 系 OS では、修正なしでそのまま cc でコンパイルできると期待しています。 Makefile を添付してあるので、*BSD 系の OS であれば make だけでバックエンドバイナリを生成してくれるかもしれません。

フロントエンド

フロントエンドは、ファイルの先頭の

(defvar *rcsview-backend-command* "~/work/rcs/rcsview")

の行をバックエンドのパス名に書換えてから、 emacs を手で起動して M-x byte-compile-file して下さい。バイトコンパイルせずに load しても動作してくれるとは思います。

この説明でワカランという人は、とりあえず諦めてください。

環境

NetBSD-current (1.5X) + emacs-20.7 という環境で開発しています。 OS 依存性はあまりないと思いますが、emacs のバージョンが違えば動かない可能性が高いです。

フロントエンドは、バックエンドの他に rlog を必要としていますので、 rcs がインストールされている必要があります。

使い方

バックエンド

    rcsview -u <rcsfile>
    rcsview -a <revision> <rcsfile>
    rcsview [-p] <revision> <rcsfile>

-u は emacs のバックエンドとして起動するためのオプションです。
-a は cvs annotate 相当の出力を得るオプションです。
-p は co -p 相当の出力を得るオプションです。

フロントエンド

  M-x rcsview-rcs-file

で、適当な RCS ファイルを指定してやると、RCS-Log バッファと RCS-Text バッファという二つのバッファがウィンドウ上に生成されます。どちらのバッファでも "p" でリビジョンを遡り、"n" でリビジョンを下ります。

RCS-Text バッファで "a" を打つと、annotation header の表示を ON/OFF できます。(これはかなり重いみたいです)

バグ

バックエンド

引数に指定する RCS ファイルは、"*,v" ファイルそのものへのパス名を明示しなくてはなりません。対応する作業ファイル名で指定したり、"RCS" ディレクトリを省略したりできません。

引数に指定するリビジョンは、タグ等 symbolic なものは使えず、digit と "." だけで表記したリビジョン番号だけしか使えません。日付指定もできません。

(RCS 5.7 の rcsfile(5) に記述された) RCS ファイル以外のフォーマットのファイルを指定した場合、動作は未定義です。一応、構文エラーを検出して終了するようにはしようとしているみたいですが、多分不完全でしょう。

コメントの英語はきっとダメダメです。

フロントエンド

使いものになりません。

変な動きをします。重要なファイルを編集中の emacs で、セーブせずにフロントエンドを使うのは、きっと自殺行為です。

目標の割に圧倒的に機能が足りていません。

コメントの英語はきっとダメダメです。

プログラムの実装について

適当な RCS ファイルを指定して、-u オプション付きでバックエンドを起動してみると、バックエンドの出力形式を見ることができます。

この出力には、 RCS ファイル中のあるリビジョンで一度でも存在したことがある行全てが入っています。加えて、各々の行の「生存範囲」を示す情報も入っています。一部抜き出すと

1 1.1,1.2  ………(1)
rcs_revision_create(char *rev)
1 1.2      ………(2)
rcsnum_create(char *rev)
45 1.1     ………(3)
{
   : 以下続く

(1),(2),(3)が「生存範囲」情報です。
(1) は 1.1 ～ 1.2 まで生存していた行が、この後に1行続くことを示しています。厳密には、リビジョン 1.2 ではこの行は生存していません。
(2) は 1.2 以降ずっと生存している行が、この後に1行続くことを示しています。
(3) は 1.1 以降ずっと生存している行が、この後に45行続くことを示しています。

ブランチのある場合、3つ以上のリビジョンが並ぶこともあります。"," で区切られた最初のリビジョンが、その行が出現したリビジョンで、以降のリビジョンはその行が削除されたリビジョンです。

これらは、ファイル中での出現順序で並んでいます。この出力を頭から読んで、あるリビジョンで生存している行だけを出力すれば、そのリビジョンの内容がそのまま得られるようになっています。

フロントエンドでは emacs の overlay 機能を使って、生存していない行に invisible overlay を設定することで、バッファの内容を変更せずに特定のリビジョンの内容を表示しています。

バックエンド

-u 出力を得るためにちょっと構造を工夫している以外は、とりたてて言うところはありません。独立したツールとするために、自前で RCS のパーザーとレキシカルアナライザーを実装しています。

RCS ファイルは、メイントランクの最新版の内容と、メイントランク上の逆方向の差分情報、ブランチ上の正方向の差分情報を保持しています。特定のリビジョンの内容を得るには、メイントランク最新版から開始して、次々と差分を適用することになります。差分は、その時点での「行番号」ベースでの行挿入操作、と行削除操作で表現されています。そのため、行単位での (穴あき)配列構造を作成して、次々と挿入、削除操作を行えば目的のリビジョンが得られます。

バックエンドでは、-u 出力を得るために、この「行」構造を穴あき配列で編集するだけではなく、行構造をリストで結んでいます。差分適用前は穴あき配列とリストは同じ行の列です。編集操作で削除が行われると、穴あき配列からその行は削除されますが、リストからは削除されません。編集操作で挿入が行われると、穴あき配列への挿入と同時に、挿入位置でリストへも連結されます。

この編集操作を特定のリビジョンを得るべく行うのではなく、全ての差分についてリビジョン木に従って適用してやると、全ての出現行のリストが得られることになります。と同時に、全ての行についてその出現リビジョンと削除リビジョン (もし削除されていれば)が確定します。その情報を出力しています。

-a 出力は、特定のリビジョンにの行 + その行の出現リビジョンから構成されています。これは、上記の -u の操作のサブセット(必要な差分しか適用しない)によって簡単に得られます。

フロントエンド

作者は emacs lisp に関して万年ど素人であるというか、どうもダメダメなコードあると思っているようです。

設計しなおして再度書いた方がいいものが書けるような気もしますが、どうも根性が足りてないので、いまのところこれ以上ドキュメントを書くこともないでしょう。

TODO

作者はへたれているので、今のところ TODO はありません。

反応(称賛、罵倒、おごり、などなど)があると、増えるかもしれません。

Copyright(C) 2002 Atsushi Furuta <furuta@bsdclub.org> All rights reserved.