アマチュア・スタイル!

[lib 02] サブルーチン・ライブラリ(関数)
greg_calc.pl カレンダー計算ルーチン(グレゴリオ暦専用)

#01 能書き： greg_calc.pl とは

リニューアルされた foussin分室の topページには、次のような文章がある。

これは、『2000年10月28日 〜 本日』までの大まかな経過年月を greg_calc.pl を使って算出したものだ。このように、経過年月を求めたり、ある年月日の曜日を求めたりすることをカレンダー計算という。greg_calc.pl は、様々なカレンダー計算ルーチンを一つにまとめたサブルーチン・ライブラリだ。

Perl でカレンダー計算…といえば、time, gmtime, localtime などのお馴染みの関数の他に、標準モジュールの Time::local を使うのが定番だと思う。おそらく、greg_calc.pl の機能の一部は、Time::local と重複している部分もあると思うが、作者は Time::local を使ったことがないので、詳しいことは分からない(車輪の再発明をしているかもしれない)。

さて、greg_calc.pl の greg とは、Gregorian Calendar(グレゴリオ暦カレンダー) を略したものだ。グレゴリオ暦とは、現在、ほぼ世界中で採用されている現行歴(いわゆる西暦)のことだ。つまり greg_calc.pl は、『グレゴリオ暦』を基準スケールとしてカレンダー計算を行う。なので、サポート暦は『グレゴリオ暦(現行西暦)』のみで、現行歴以前のユリウス暦やローマ暦には未対応とする。当然、紀元前の計算も未対応となる。また、明治・大正・昭和・平成などの元号も未対応とする。

greg_calc.pl は、次の機能を実装している。

• 閏年判定(グレゴリオ暦専用)
• 始点日〜終点日までの『大まかな経過年月』を求める
• 始点日〜終点日までの『経過日数』を求める
• 指定年月日の『曜日』を求める
• 指定年月の『第n d曜日の日付』を算出(ハッピーマンデー対策)
• 基点日(0日目)〜『経過日数目の年月日』を求める
• ローカル時間の設定
• 日付から『エポック秒』を求める
• エポック秒から『日付』を求める
• 指定年月日の『西暦通算日』を求める

エポック秒関連の関数では、1970年以前や、2038年以降の日付にも対応している。上記機能の具体的な利用方法については、#03 greg_calc.pl の主要関数 で説明する。作者(foussin)は、greg_calc.pl の保守管理に長い年月をかけて取り組んできた。また、計算のアルゴリズムは単純明快なものばかりを採用している。そのため、計算ミスが発生することは、まず、ないと断言できる。なので、安心して活用してほしい。その代わり、実行効率は良いとは言えない…。

#02 日付の指定方法（&mold 関数）

カレンダー計算を行う関数には、引数として日付を指定する必要がある。日付の慣例表記は国によって違いがあるし、日本国内においても様々な表記が存在する。例えば――

• 2008.06.21 Sat 02:24:00
• 2008/6/21
• 2008年6月21日 土曜日 2時24分
• Sat Jun 21 02:24:00 2008
• June 21 2008

と、さまざまだ。greg_calc.pl では、上記の文字列を全て日付文字列として認識できる。具体的には、ymd形式(ISO 8601)、UNIX形式(POSTGRES)、mdy形式(ISO 8601) の 3種類に対応している。これらの形式については、説明書モドキ(greg_calc.pl.commentful.pl)で説明しているので、ここでは詳細を省くが、日本人ユーザーが慣例的に使っている表記のほとんどをカバーしているはずだ。

しかし実際のところ、演算処理系に漢字や特殊文字を含む引数を渡すと、"." を小数点やメタ文字と誤認したり、文字化けが発生したりと、様々な問題が起こる。それを回避するなら、引数文字列をいったん『単一の内部表現形式』に変換する…という方法が考えられる。そうすれば、個々の処理ルーチンは内部表現形式だけを対象としてコーディングするだけで済む。greg_calc.pl では、そのための関数として &mold という関数を実装している。

年月日・時刻を表す引数文字列は、最初に &mold という関数に渡して『内部表現形式』に変換する必要がある。&mold(mold: 型、鋳型)は、greg_calc.pl の諸関数を利用するにあたり『一番最初に実行しなければいけないプログラム』となっている。ymd形式、UNIX形式、mdy形式の文字列を、引数として &mold に渡すことで内部表現形式が生成される。これは、ユーザーが慣例的に使っている日付の文字列を使ってカレンダー計算ができるようにするため、ある程度、指定方法に自由度の幅を持たせたものだ。一方、個々の実行関数は、内部では常に単一の内部表現形式だけを使って演算処理を行う仕様となっている。

『&mold 関数』『内部表現形式』についての詳細は『説明書モドキ』で説明しているので、ここでは詳細を省く。

#03 greg_calc.pl の主要関数

greg_calc.pl を使うためには、まず最初に次の記述をする必要がある。

require "greg_calc.pl";

上記の記述は必須となる。もしくは、必要に応じて次のように記述する。

require "greg_calc.pl";
&greg_calc::init_outf($type);
&greg_calc::set_tzone($tz_str, $opt);

以下に主要関数の簡単(?)な書式を示す。

    >EXAMPLES: Example TZ variables and their timezone differences are given
    >          in the table below:
    >  -------------------
    >  TZ         timezone
    >  -------------------
    >  EST5EDT     5*60*60 (米大陸東部標準時:米国,カナダ)
    >  GMT0        0*60*60 (グリニッジ標準時)
    >  JST-9      -9*60*60 (日本標準時)
    >  MET-1MEST  -1*60*60
    >  MST7MDT     7*60*60
    >  PST8PDT     8*60*60
    >  ------------------- 

なお、greg_calc.pl の &mold 以外の諸関数は、引数が『実在しない日付』『年が紀元前(西暦0年)』の場合、全ての戻値は ""（空文字列）となる。

#04 greg_calc.pl の使用例

例） 指定年月日の曜日を求める

#!/usr/bin/perl

# "youbi_test.pl"

require "greg_calc.pl";

$date = '2008年6月24日 12:06';
$csv = &greg_calc::mold($date);

# 日本語表記の例
($wd, $wname) = &greg_calc::what_day($csv, "jp");
print $date, ' は ', $wname, '曜日', "\n";

# yyyy/mm/dd Xxx 表記の例
&greg_calc::init_outf("ymd/");
$date = &greg_calc::outf($csv);
print "$date\n";

__END__

youbi_test.pl の実行例↓

G:\lib\greg_calc\sample>youbi_test.pl
2008年6月24日 12:06 は 火曜日
2008/06/24 Tue 12:06:00

例） 2009年の成人の日(1月 第2月曜日)を求める

# "happy_mon_test.pl"

require "greg_calc.pl";

$ym = &greg_calc::mold("2009-1");
$mday = &greg_calc::happy_mon($ym, "2nd-mon");
print '2009年の成人の日は：1月', $mday, '日 (月)', "\n";

__END__

happy_mon_test.pl の実行例↓

G:\lib\greg_calc>happy_mon_test.pl
2009年の成人の日は：1月12日 (月)

例） &get_epoch_sec の動作チェック

# "get_epsec_test.pl"
# updated: 2008.06.25 Wed 00:00
# ----------------------------------------------------------------------
# 動作条件：事前に &mold を実行する(次の通り)
#        $date_csv = &greg_calc::mold($date);
# 書式1：$epoch_sec= &greg_calc::get_epoch_sec($date_csv);
# ----------------------------------------------------------------------

require "greg_calc.pl";
@date = ( "today"              , "1970-1-1 9:0:0"         ,
          "2038-1-19"          , "1969-12-31"             ,
          "2038-01-19 12:14:08", "2038-01-19 03:14:07 GMT",
          "1970-1-1 0:0:0" );

foreach (@date) {
    $csv = &greg_calc::mold($_);
    $epoch_sec = &greg_calc::get_epoch_sec($csv);
    print "元の引数: $_\n";
    print "epoch_sec: $epoch_sec";
    $local = localtime($epoch_sec);
    $local || ($local="");
    print " (localtime: $local)\n\n";
}
__END__

get_epsec_test.pl の実行結果↓

G:\usr\lib\greg_calc\sample>perl -w get_epsec_test.pl
元の引数: today
epoch_sec: 1214319652 (localtime: Wed Jun 25 00:00:52 2008)

元の引数: 1970-1-1 9:0:0
epoch_sec: 0 (localtime: Thu Jan  1 09:00:00 1970)

元の引数: 2038-1-19
epoch_sec: 2147439600 (localtime: Tue Jan 19 00:00:00 2038)

元の引数: 1969-12-31
epoch_sec: -118800 (localtime: )

元の引数: 2038-01-19 12:14:08
epoch_sec: 2147483648 (localtime: )

元の引数: 2038-01-19 03:14:07 GMT
epoch_sec: 2147483647 (localtime: Tue Jan 19 12:14:07 2038)

元の引数: 1970-1-1 0:0:0
epoch_sec: -32400 (localtime: )

例） &both_time の動作チェック

# "both_genesis.pl"
# 2008.06.25 Wed 00:25

require 'greg_calc.pl';
$local_genesis = -62_135_596_800;

@epoch = (     "-100,000,000,000",
        $local_genesis - (3600*9),
               " -62,135,596,800",
               "               0",
               ""  );

foreach (@epoch) {
    ($gmt_csv, $local_csv) = &greg_calc::both_time($_);
    print "epoch[$_]\n",
          "  gmt[$gmt_csv]\n",
          "local[$local_csv]\n\n";
}
__END__

both_genesis.pl の実行結果↓

G:\usr\lib\greg_calc\sample>perl -w both_genesis.pl
epoch[-100,000,000,000]
  gmt[]
local[]

epoch[-62135629200]
  gmt[]
local[0001-01-01,0,]

epoch[ -62,135,596,800]
  gmt[0001-01-01,0,GMT]
local[0001-01-01,09:00:00,]

epoch[               0]
  gmt[1970-01-01,0,GMT]
local[1970-01-01,09:00:00,]

epoch[]
  gmt[2008-06-24,15:46:18,GMT]
local[2008-06-25,00:46:18,]

#05 サンプル・スクリプト

#!/usr/local/bin/perl

# "ezcal.pl" (sample script)
=about "ezcal.pl"
    greg_calc.pl を利用したサンプル・スクリプト

   『グレゴリオ暦万年カレンダー』(ユリウス暦、ローマ暦、紀元前は未対応)
    2005.12.29 Thu 13:50 初版完成
    2006.02.12 Sun 15:07 第2版完成(greg_calc.pl のバージョンアップの都合)
    2008.05.03 Sat 08:14 第3版完成(greg_calc.pl のバージョンアップの都合)

    使用関数：mold, arg_chk("fix -ym"), what_day, short_or_full

    アクセスするグローバル変数：@misoka, @eng_m

    書式：perl ezcal.pl [西暦年月]
    引数：西暦年月は、yyyy-mm 形式で指定する。
          引数を省略すると『今月のカレンダー』を出力する。
    戻値：なし(標準出力するだけの単純なコマンド)。
    文例：perl ezcal.pl 2006-1
    文例：perl ezcal.pl 2008/2
    文例：perl ezcal.pl 2008年5月
=cut

#
# 準備(init)
#
    require "greg_calc.pl";

#
# 入力(input) --引数の解釈--
#
  # 引数が省略されると、デフォルトとして『今日の日付』がセットされる
  # 必要なのは『年月』のみ(yyyy-mm-dd の dd が実在しない日付でも構わない)
    $csv = &greg_calc::mold($ARGV[0]);
    ($ym_csv, $err, $type, $bad_arg) =
     &greg_calc::arg_chk("fix -ym", $csv);
  # $err が真値ならば実行中止する
    if ($err) {
      # $err：エラー・コードを返す
      #  値   ：値の意味
      #  0(偽)：戻り値($err)が 0 ならば『引数は正常』であることを示す
      #  1(真)：月の指定が 1-12 以外になっている
      #  2(真)：実在しない日付になっている(2005-11-31, 2006-2-29 など)
      #         -ymオプションが指定されているので、日付のチェックはしない
      #       ※このプログラムでは『コード2』を返すことは絶対にない
      #  3(真)：年の指定が紀元前(西暦0年以下)になっている
      #         (これは greg_calc.pl の仕様…紀元前には未対応)
        print "$type error!: ", '引数', $bad_arg, 'の指定が変。', "\n";
        ($err==1) && (print '1: 月の指定が 1-12 以外になっている。',
        "\n");
        ($err==2) && (print '2: 実在しない日付になっている。'  ,
        "\n");
        ($err==3) && (print '3: 年の指定が紀元前になっている。',
        "\n");
        die;
    }
  # yyyy-mm 形式の文字列を yyyy-mm-1 に置換
    $ym      = ( split(/,/, $ym_csv) )[0];
    $ymd     = "$ym-1";
    $ymd_csv = "$ymd,0,"; # 内部表現のリビルド
  # $year, $mon を抽出
    ($year, $mon, $mday) = split(/-/, $ymd);

#
# 演算(exp)
#
  # 指定月の1日(ついたち)は何曜日か(曜日番号)を調べる
    $wd       = &greg_calc::what_day($ymd_csv);
  # その月の末日は何日かを調べる
    $misoka   = $greg_calc::misoka[$mon];
    if ($mon == 2) {       # 2月の時は閏年判定も行う
        $leap = &greg_calc::leap_year($year);
        $misoka += $leap;
    }
  # 月番号から英語月名を求める
    $month = $greg_calc::eng_m[$mon];
    $month = &greg_calc::short_or_full($month, "Xxxx");
  # 指定月の日数(1 .. $misoka)のリストを作成し、@mdays に格納する
  # (1 .. 9) までは " 1", " 2" のように半角スペースで補完し、2桁にする
    @mdays = ( " 1", " 2", " 3", " 4", " 5", " 6", " 7", " 8", " 9" );
    @mdays = ( @mdays, 10 .. $misoka );
  # 指定月の1日(ついたち)の曜日番号($wd)が 0以外ならば、曜日番号と同じ個数
  # の『空白文字だけの文字列要素』を用意し、それを配列 @spc に格納する
    if ($wd) { # $wd が 0 以外ならば…
        for ($j=0; $j<$wd; ++$j) {
            @spc = (@spc, "  "); # 半角スペース2個("  "=="\x20\x20")
        }
    }
    @mdays = (@spc, @mdays);

#
# 出力(output)
#
  # @mdays の要素を forループを使って 1つずつ出力する
  # その直後、1つ出力する毎にループカウンタ値を 7で割って剰余を調べる
  # その剰余が 6ならば、\n(改行)を出力する
  # 剰余が 6以外ならば、"  "(半角スペース2個)を出力する
    print "\n[ $year $month ]\n\n";
    print "Su  Mo  Tu  We  Th  Fr  Sa\n";
    $num = @mdays;
    for ($j=0; $j<$num; ++$j) {
        print $mdays[$j];
        if ($j == $num-1) { print "\n"; } # 最後の要素を出力したら改行する
        else {
            ($j % 7 == 6) && ( print "\n" );
            ($j % 7 == 6) || ( print "  " );
        }
    }

#
# 終了(end)
#
__END__

ezcal.pl の実行例↓

G:\bat>ezcal.pl 2008-7

[ 2008 July ]

Su  Mo  Tu  We  Th  Fr  Sa
         1   2   3   4   5
 6   7   8   9  10  11  12
13  14  15  16  17  18  19
20  21  22  23  24  25  26
27  28  29  30  31

以下は、&get_passdays, &outf 等のサンプル

# "ct_down.pl"

# 2009.02.23 Mon 11:00
# Windows の場合、[Ctrl]-c で実行中止（ UNIX系は [Ctrl]-d ）

require 'greg_calc.pl';

$to     = '2101年1月1日';  # 22世紀の始まりの日
$to_csv = &greg_calc::mold($to);
$to_date= &greg_calc::outf($to_csv);

while (1) {
    $since_csv = ( &greg_calc::both_time() )[1]; # today
    $pass_days = &greg_calc::get_passdays($since_csv, $to_csv);
    ($int_day, $float) = split(/\./, $pass_days);
    $float = "0.$float";
    $sec = int($float * 24*60*60 + 0.5);
    $hms = &greg_calc::sec2hours($sec);
    if ($cache ne $hms) {
        $cache = $hms;
        #↓Windows 専用
        system("cls");
        #↓Linux 等の場合
        # print "\e[2J"; # ← ESCシーケンスで CLS する
        $since_date = &greg_calc::outf($since_csv);
        print "\n";
        print '  ', '  22世紀：', " $to_date\n";
        print '  ', '現在時刻：', " $since_date\n";
        print '  ', '  22世紀まで あと ';
        printf("%3d", $int_day);
        print '日', " $hms ($pass_days", '日)', "\n";
    }
}
__END__

ct_down.pl の実行例（1秒ずつカウントダウンする）↓

    22世紀： 2101-01-01 Sat 00:00:00
  現在時刻： 2009-02-23 Mon 11:12:32
    22世紀まで あと 33548日 12:47:28 (33548.532962963日)

#06 ダウンロード

greg_calc.pl (最新版)

$VERSION= '1.63';
$UPDATE = '2010.07.31 Sat 01:26 JST-9';
$AUTHOR = 'pablo foussin(japan)';

ソース本体を見る： （39.4 KB / sjis テキスト）
説明書モドキ(?) を見る： (179 KB / sjis テキスト）

ダウンロード： [ ソース本体( greg_calc.pl )と 説明書モドキ( greg_calc.pl.commentful.pl )のアーカイブ ]
日本語 Windows 用(sjis/crlf)： greg_calc_1.63_sjis.zip (66.0 KB)
日本語 UNIX 用(eucjp/lf)： greg_calc_1.63_eucjp.zip (65.4 KB)
Linux 用(utf8n/lf)： greg_calc_1.63_utf8n.zip (70.2 KB)

#07 今後の課題

(2010/08/04 Wed 23:55 追記)

　&mold 関数の機能拡張を検討している。現状での &mold には 2種類の書式が
ある。↓


# 書式1： $ymd_hms             = &greg_calc::mold($date);
# 書式2：($ymd_hms, $ymd_hms2) = &greg_calc::mold($date, $date2);


　さらに、書式3 を追加したい…と考えている。↓


# 書式1： $date_csv            = &greg_calc::mold($date);
# 書式2：($since_csv, $to_csv) = &greg_calc::mold($since, $to);
# 書式3： @date_csv            = &greg_calc::mold($line);


　例えば、次のようなテキストがあるとする。

    $line = '1936年2月26日、二・ニ六事件。… 1945/8/15、敗戦。';

　従来の &mold では、書式1 を使って "1936-02-26,0," は抽出できるが、敗戦
の年月日を抽出することはできない。これをどうにかしたい、と考えている。書
式3 のサポートによって、CGI 支援ツールとしての利用価値が、さらに増すこと
になるはず。これはなるべく早く実装したほうが良いだろう。

　書式の特定は、引数の数と戻値のコンテキストに着目すれば何とかなる。この
機能拡張には、大幅なソースの変更、追加が予想される。これを v1.70 とする。
…しかし、よく考えたら、これはかなり面倒なことになりそうだ。やっぱ、しば
らくは保留にしておく…。

　ところで、『二・ニ六事件』を『2.26事件』のように記述すると、書式3 では
次のようなリスト値(内部表現形式)が返されるはず。

    ("1936-02-26,0,", "0002-26,0,", "1945-08-15,0,")

　y-m-d 形式ではなく、y-m 形式と判断される。つまり、西暦2年26月(26月は存
在しないのでエラーとなる)。この点は、要注意かもしれない。たぶん、当時の作
者(＝筆者＝foussin)は、これを嫌って、スカラー値から複数の年月日を抽出する
のを躊躇したんだと思う。自分のことなのに、なんか他人事だな…。