nDiki : perltidy

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

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

 perltidy source.pl

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

 ppm install Perl-Tidy

Emacs プリント コーディング規約 Perl モジュール ソースコードフォーマッタ 命名規則 C++ ビルド コードレビュー パッケージ名 インデント幅 Module::Install h2xs レビュー NEWS WiKicker コードリーディング 社長 ゴールデンウィーク Perl テストスクリプトの書き方 ファイル名 Perl v5.6.0 ChangeLog 初めてのPerl 第3版 正規表現 CPAN アクセサ 識別子 バージョン管理システム 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)
• Perl 用の doxygen のようなツールはないのかな (2006-07-25)
• 第2回 社内 Perl 勉強会 (2006-04-28)
• emacs-wiki の中の Perl ソースコードを整形できるように (2002-06-08)
• 第1回 社内 Perl 勉強会 (2006-04-21)

■ 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 トレーニングコース用ブックに選定 (2006-04-18)
• Plagger で Twitter のあれこれをメールで通知 (2008-12-25)
• Web 日誌 / Web 日記を書き始めてから10年 (2009-01-19)
• 私的10大ニュース2004 [ comp ] (2004-12-31)
• 第2回 社内 Perl 勉強会 (2006-04-28)

■ 第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)
• Perl プリティプリンタの定番 perltidy (2006-04-23)
• Emacs でお好きな言語のソースコードを色付き HTML テキストに変換 (2006-04-21)
• Perl 用の doxygen のようなツールはないのかな (2006-07-25)
• 第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 に変換するスクリプトだけは書いて、一気に変換だけはできるようにしておいた。

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

• Perl プリティプリンタの定番 perltidy (2006-04-23)
• 第2回 社内 Perl 勉強会 (2006-04-28)
• Emacs でお好きな言語のソースコードを色付き HTML テキストに変換 (2006-04-21)
• Rubric でプライベート SBS を立てるも 0.140 では日本語に不具合 (2006-07-22)
• 今日のさえずり - 「チューペットみたいな何か」いっぱいあった (2009-08-28)

■ C++ 用ソースコードフォーマッタ Uncrustify

私が Perl が好きな理由の一つとして perltidy が存在しているという点がある。 perltidy のソースコード整形は柔軟にカスタマイズができて、自分の好みの整形設定を作っておける。 このツールおかげで後で整形できるので、荒々しくコードを書いてガンガンリファクタリングしていくことできる。

久しぶりに C++ の開発をするにあたって、C++ の同様のツールを探してみた。 perltidy のように長い式の折り返しを適切に調整してくれる整形ツールはあまり見つからない。いくつか試したところ Uncrustify にたどりついた。

• http://uncrustify.sourceforge.net/

@ 設定

 uncrustify -c /dev/null --update-config-with-doc -o ~/.uncrustify.cfg

するとデフォルトの設定が書き込まれた設定ファイルができる。 これを好みの設定に書き換えていく。

@ ソースコード整形する

 uncrustify source.cpp

とすると整形されたソースコードが source.cpp.uncrustify に出力される。

 uncrustify --replace source.cpp

とすると source.cpp 自体を整形されたソースコードで置き換えてくれる。

@ Emacs からの呼び出し

perltidy の時の設定(記事)で OK。 shell-command-on-region では

  uncrustify -l CPP -q

を実行するようにする。Uncrustify は標準入力からソースコードを渡す際にはどのプログラミング言語が指定してあげる必要がある。

好みの設定は現在模索中。 長い式の中の、引数なしの関数呼び出しの開き括弧と閉じ括弧の間で折り返されることがあってそれが気持ち悪いのだが、それ以外は好みの設定になりつつある。 もうちょっと設定いじってみて確定するつもり。

• Perl プリティプリンタの定番 perltidy (2006-04-23)
• Linux で使えるデスクトップ検索ツール Beagle でローカルファイ... (2006-08-08)
• スクラッチから書き直したくなるプログラマは、書き直したプログラムもまたスク... (2008-06-14)
• 今日のさえずり - 京都の小学校のコンピュータ室にいったら、Squeak が (2008-03-06)
• 今日のさえずり - これ Emacs なのよね (2010-01-26)