簡易Tailコマンド

リングバッファーを使った Tailコマンドです。

コマンドの書式は、
Tail [行数] [ファイル名]

というとても単純なものです。たとえば、sample.txtの最後の30行を表示したい場合は、
Tail 30 sample.txt

のように入力します。行数を省略した場合は、最後の10行が表示されます。

また、ファイル名を省略した場合は、標準入力からの入力となります。

自作のRingBufferクラスを利用し、Tailコマンドを実装しています。
RingBufferは、リング状に配置されたバッファーで、一定の量だけを保存するために利用するデータ構造です。

Wikipediaに説明がありますので、リングバッファとは何かという説明は割愛します。

wikipwdia:リングバッファ
http://ja.wikipedia.org/wiki/%E3%83%AA%E3%83%B3%E3%82%B0%E3%83%90%E3%83%83%E3%83%95%E3%82%A1

ここで作成した RingBufferクラスは、
public class RingBuffer<T> : IEnumerable<T> {

とジェネリッククラスにしているので、用途にあった型のデータを入れることができます。

また、IEnumerable<T> を実装していますので、foreachで簡単に要素を取り出すことができます。
なお、この実装では、取り出した要素は、バッファから削除していますので、同じ要素を複数回バッファーの中から取り出すことはできません。

RingBuffer の簡単な使い方を示します。
RingBuffer<string> rb = new RingBuffer<string>(4); // バッファサイズを4にする rb.Add("111111"); rb.Add("222222"); rb.Add("333333"); rb.Add("444444"); rb.Add("555555"); rb.Add("666666"); foreach (var s in rb) { Console.WriteLine(s); }

このコードを実行すると、以下のように最後に追加した４つの文字列が表示されます。
333333 444444 555555 666666

このプログラムの実質的なメイン部分は、DoTailメソッドです。(コードは最後に載せています）
見ていただければわかると思いますが、
「ファイルを１行ずつ読み込み、RingBufferに追加していき、
最後まで読み終わったら、RingBufferの中身をforeachで書き出す」
という、とてもシンプルなコードになっています。

シンプルなコードとなったのは、RingBufferクラスの存在が大きいですね。
こういったクラスがなかったら、かなり複雑なコードを書かないといけなくなってしまいますし、デバッグも大変です。

RingBufferクラスは、ある程度汎用性を持たせましたが、一般的なRingBufferのインターフェースが良くわからないので、私なりのインターフェースとしました。
他の用途で利用するには、機能不足のところもあるかもしれません。
特に、Get や foreachでデータを取り出した時に、バッファからデータを除去する仕様としましたが、除去したくない場合もあると思います。そのような場合は、新たなメソッドを追加する必要があります。

一方、Tailコマンドでの利用だけを考えた場合は、オーバースペックの部分があります。
こういった汎用クラスは、設計がなかなか難しいものです。

以下、C#のコードです。

■RingBuffer.cs

using System;
using System.Collections.Generic;
using System.Linq;

namespace Gushwell.Etude {
    public class RingBuffer<T> : IEnumerable<T> {
        private int _size;
        private T[] _buffer;
        private bool[] _existence;
        private int _writeIndex;    // 書き終わった位置
        private int _readIndex;     // これから読み込む位置

public RingBuffer(int size) {
            _size = size;
            _buffer = new T[size];
            _existence = new bool[size];
            _writeIndex = -1;
            _readIndex = 0;
        }

private int NextIndex(int ix) {
            return ++ix % _size;
        }

public void Add(T value) {
            _writeIndex = NextIndex(_writeIndex);
            _buffer[_writeIndex] = value;
            if (_existence[_readIndex] && _writeIndex == _readIndex)
                _readIndex = NextIndex(_readIndex);
            _existence[_writeIndex] = true;
        }

public T Get() {
            if (!Exists())
                throw new InvalidOperationException("バッファにデータはありません");
            T val = _buffer[_readIndex];
            _existence[_readIndex] = false;
            _readIndex = NextIndex(_readIndex);
            return val;
        }

public bool Exists() {
            return _existence.Any(b => b == true);
        }

public int Count {
            get {
                return _existence.Count(b => b == true);
            }
        }

public void Clear() {
            _writeIndex = -1;
            _readIndex = 0;
            for (int i = 0; i < _size; i++)
                _existence[i] = false;
        }

public IEnumerator<T> GetEnumerator() {
            while (Exists()) {
                yield return Get();
            }
        }

System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() {
            return this.GetEnumerator();
        }
    }
}

■Program.cs

using System;
using System.IO;

namespace Gushwell.Etude {
    class Program {
        static void Main(string[] args) {
            int count = 10;
            string filename = null; 
            if (args.Length > 0) {
                if (int.TryParse(args[0], out count) == false) {
                    count = 10;
                    filename = args[0];
                } else if (args.Length == 2)
                    filename = args[1];
            }
            DoTail(count, filename);
        }

private static void DoTail(int linecount, string filename) {
            TextReader tr = Console.In;
            if (!string.IsNullOrEmpty(filename))
                tr = new StreamReader(filename);
            try {
                RingBuffer<string> rb = new RingBuffer<string>(linecount);
                string line;
                while ((line = tr.ReadLine()) != null) {
                    rb.Add(line);
                }
                foreach (var s in rb)
                    Console.WriteLine(s);
            } finally {
                tr.Dispose();
            }
        }
    }
}

Gushwell's C# Programming Page

簡易Tailコマンド

簡易Tailコマンド