nDiki : perltidy

Perl ソースコードを読み込んで、インデントの修正などを行い整形されたソースコードを出力するツール。GNU GPL のもと公開されている。

このツールを用いることで、スタイルの統一された見やすいソースコードにすることができる。 また、ソースコードをハイライトした HTML ファイルを作成することもできる。

 perltidy source.pl

 perltidy -html -nnn --nohtml-entities source.pl

 ppm install Perl-Tidy

プリント パッケージ名 インデント幅 命名規則 ビルド Emacs Module::Install ポイント Build.PL ExtUtils::MakeMaker Naney インストーラ WiKicker テストファースト開発 コーディング規約 ファイル名 Perl モジュールリリースチェックリスト ExtUtils README CPAN Pod 標準 Perl ライブラリ Naney Perl Coding Standards ソースパッケージ Perl モジュールの作り方 UNIX プリン NEWS Perl テストスクリプトの書き方 Perl モジュール

■ Perl プリティプリンタの定番 perltidy

一昨日は時間がなかったので、Perl プログラムの色付きプリントアウト作成に Emacs の htmlize.el を使用したのだが、残念ながらこれだと Emacs を使っていない人には薦めることができない。

ということで調べたところどうやら perltidy が定番の様子。 Perl Best Practices でも紹介されているらしい。

@ HTML テキスト出力

ソースコードをハイライトして行番号付きの HTML テキストを生成する場合は

 perltidy -html -nnn --nohtml-entities source.pl

とする。

@ Emacs からの perltidy の呼び出し

perltidy の真価はソースのリフォーマットにある。 これを使用するとソースコードを統一のとれたスタイルに整えることができる。

Emacs からはリージョン選択して

 M-1 M-| perltidy

するか、http://www.emacswiki.org/.../CPerlMode で紹介されている

 (defun perltidy-region ()
   "Run perltidy on the current region."
   (interactive)
   (save-excursion
     (shell-command-on-region (point) (mark) "perltidy -q" nil t)))
 (defun perltidy-defun ()
   "Run perltidy on the current defun."
   (interactive)
   (save-excursion (mark-defun)
                   (perltidy-region)))

を .emacs などに書いておいて M-x perltidy-region することで整形することができる。

今までは CPerl mode 頼りだったけれど、これからはリポジトリにコミットする前に perltidy を通すようにしようかな。

まずは自分好みにあわせた、.perltidyrc を作成せねば。

• Emacs でお好きな言語のソースコードを色付き HTML テキストに変換 (2006-04-21)
• 第2回 社内 Perl 勉強会 (2006-04-28)
• Perl 用の doxygen のようなツールはないのかな (2006-07-25)
• 第1回 社内 Perl 勉強会 (2006-04-21)
• emacs-wiki の中の Perl ソースコードを整形できるように (2002-06-08)

■ perltidy のコマンドファイルでデフォルト設定

perltidy をいろいろいじった結果、今のところ自分好みの設定は以下:

 # Basic Options
 --maximum-line-length=78       # default is 80
 --indent-columns=2             # (!= perlstyle) default is 4
 --preserve-line-endings

 # Conde Indentation Control
 --line-up-parentheses          #
 --nooutdent-long-lines         # default is --outdent-long-lines

 # Whitespace Control
 --paren-tightness=2            # default is 1
 --square-bracket-tightness=2   # default is 1
 --brace-tightness=2            # default is 1
 --nospace-for-semicolon        # default is --space-for-semicolon

 # Line Break Control
 --vertical-tightness=2         # default is 0
 --vertical-tightness-closing=1 # default is 0
 --want-break-before="% + - * / x != == >= <= =~ !~ < > | & >= < = **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
                                # default is ". << >> -> && ||"

 # HTML Options
 -nnn
 --nohtml-entities

一応 Perl Best Practices (は持っていないので Web で公開されているサンプルファイル)の perltidyrc や perlstyle などを参考にしつつ作成。

インデント幅その他、比較的タイトがお好き。

• Perl 用の doxygen のようなツールはないのかな (2006-07-25)
• Perl プリティプリンタの定番 perltidy (2006-04-23)
• Perl CGI プログラムのテストには WWW::Mechanize::... (2006-02-18)
• 第2回 社内 Perl 勉強会 (2006-04-28)
• PostgreSQL を使いはじめる (1999-12-17)

■ 第2回 社内 Perl 勉強会

リャマ本を使用した社内 Perl 勉強会の2回目を開催。 今回は7人。直前に社長につかまって約20分遅れのスタート (スミマセン)。

進行方法はほぼ前回と同じで、事前に練習問題を解いておき、勉強会では互いにコードレビューをしながら進行役の私がポイントを説明していく形式。

今日は「初めてのPerl 第3版」第3章が範囲で、リストと配列がテーマ。

@ 今回の変更点と反省点

• 解答のソースコードは全員 perltidy で色付き HTML に変換してプリントアウトして持ってくるようにしてもらった。前回より見易さアップ。
• 前回は1人1解答につき1枚プリントして持参してもらったが、今回は各自出席者分プリントアウトし持ち寄ってもらうことにした。これによって、それぞれ配られたプログラムをゆっくりレビューできる。書き込みもできるし、持ち帰ることもできるので効果あり。
  • 反省点はプリントの枚数が多くなって混乱したこと(「第2問の○○さんの解答プリントはどれだっけ?」)。次回は、冒頭で全員のものを集めて問題番号ごとに整理してステープラーでまとめるという形にしよう。
• ソースコードの先頭にコメントとして問題番号と作成者名を入れてもらうようにしたのだが、それだけだと誰のものか区別しにくいとの意見。
  • perltidy のオプションで HTML 化した時にタイトルをいじれればいいのだが、そのような機能はなさそうだ。
  • それこそ誰か、練習として H1 要素を書き換えるスクリプトとか書いてくれないかなぁ。

今のところ、全員ついてこれている様子。 スカラーコンテキストとリストコンテキストは、Perl 初心者にとってとっつきにくい部分の一つだと思うので、これが理解できれば結構いけそうな気もする。

今回はトータル80分ぐらい。7人だと1時間半ぐらい確保しておいた方がいいかもしれないな。

次回はゴールデンウィークを挟んで2週間後。

• 第1回 社内 Perl 勉強会 (2006-04-21)
• Emacs でお好きな言語のソースコードを色付き HTML テキストに変換 (2006-04-21)
• Perl 用の doxygen のようなツールはないのかな (2006-07-25)
• Perl プリティプリンタの定番 perltidy (2006-04-23)
• 第3回 社内 Perl 勉強会 (2006-05-12)

■ Perl 用の doxygen のようなツールはないのかな

WiKicker のソースコードを人に説明するのにプリントアウトして説明するのに、doxygen のようなツールが欲しいのだけれど Perl 用のものはないのかな。

1. ソースコードを色付けした HTML に変換してくれる
2. Pod とコード本体を混在してドキュメント化してくれる
3. ソースツリー内のファイルをそれぞれ処理してくれて、インデックスファイルも生成してくれる。
4. できれば識別子がリンクになってくれる

というのが希望。1 だけなら結構いろいろなツールがあり、1 + 2 なら perltidy で実現できる。 しかし 3、4 までしてくれるツールが見つけられない。

とりあえず perltidy の Perl::Tidy と File::Find で再帰的にまとめて HTML に変換するスクリプトだけは書いて、一気に変換だけはできるようにしておいた。

インデックスの作成までは面倒なので未着手。

• 第2回 社内 Perl 勉強会 (2006-04-28)
• Perl プリティプリンタの定番 perltidy (2006-04-23)
• Emacs でお好きな言語のソースコードを色付き HTML テキストに変換 (2006-04-21)
• 定型書式で内容を記述していくのに便利な形式は? (2005-11-21)
• WiKicker に JSON でのページ出力機能を追加 (2007-04-03)