タツノオトシゴのブログ

主にJavaに関するものです。

Velocityの簡易エディタを求めて

システム導入時などにVelocityのテンプレートをいじる機会があった。

EclipseとかのIDEだと重く、また、プロジェクト形式にする必要があるので、気軽には使えない。

ネットで探したり、Velocityの公式サイトにあるエディタ一覧を参考にして、「jEdit」にした。


jEditはJava製のエディタで、Windows、Linuxなどで動作が可能で、プラグインも充実しています。
しかし、プラグインを入れないと使い勝手が悪いといものもあります。


また、大学生時代の研究で、独自システムの専用言語のエディタとして、自分でカスタマイズして使っていたというのもあり、これにしました。


jEditは標準で、Velosityのシンタクス表示、コード補完も対応しています。。

しかし、マクロや変数などのアウトライン表示は、ctagsを使ったプラグイン「CtagsSideKicker」が必要です。

設定ファイルで簡易的なアウトライン表示にも対応可能です。


jEditのVelocityの設定「CtagsSideKicker（旧CodeBrowser）」

  1. 前提のプラグインに「ErrorList」が必要なので、先にインストールしておく。
    • 先にErrorListをインストールしないとエラーが出る。
  2. 続いて、プラグインマネージャから「CtagsSideKicker」をインストールする。
  3. インストール後、「CtagsSideKicker」のプラグインオプションの項目「ctags Path」で「ctags.exe」のパスを指定する。
  4. 環境変数「HOME」に、設定ファイル「.ctags」を次の内容で配置する。
    • Windowsではファイル名の先頭が「.〜」から始まる場合は標準では作成できないので、コマンドプロンプトの「rename」「copy」コマンドでフィル名を変更する必要がある。
    • この設定は、行の先頭がマクロ定義用の「#macro」、変数定義用の「#set」から始まる場合に、マクロ名、変数名を抽出する。
--langdef=velocity
--langmap=velocity:.vm
--regex-velocity=/^#macro[ ]*\([ ]*([a-zA-Z0-9_]+)/#macro \1/m,macro/i
--regex-velocity=/^#set[ ]*\([ ]*(\$[a-zA-Z0-9_]+)/#set \1/m,macro/i
    • Windowsでは環境変数HOMEがない場合、Windowsユーザのフォルダに配置してもよい。
    • 設定ファイルの改行コードはLFにする。
  1. 設定ファイルを設置後、プラグイン「SideKick」のプラグインオプション「Parsers」で、モードに対するパーサとして「ctags」を指定する。
    • モード「velocity」に対して、パーサ「ctags」を指定する。


注意事項として、設定ファイルいよるアウトラインは正規表現で定義するため、複数行にわたるコメント（#*〜*#）中に、定義対象の文字が見つかった場合は誤検出する。

誤検出を許したくない場合は、自分でctagsにパーサを追加する必要がある。
c言語で比較的、簡単にできるが、ctagsを再ビルドする必要がある。

自分で、ctagsを拡張したい場合は、次のサイトを参考にするとよい。

jEditのお薦めプラグイン

「Column Ruler」

エディタ上で列番号を表示するプラグイン。

  • インストール後は、プラグインのメニューからチェックを入れて有効化する必要がある。
  • さらに、起動時にも有効にするために、プラグインのオプションから、「Active by Default」にチェックを入れる。
「BufferTabs」

複数開いている場合にタブ表示する。

  • インストール後は、プラグインのメニューからチェックを入れて有効化する必要がある。
「WhiteSpace」

タブ文字や空白を可視化する。

  • インストール後は、プラグインのオプション「Tabs」の「Show tabs by default」「Show leading tabs by default」などのチェックを入れないと、起動時に有効化されないので注意。
  • 全角の空白を可視化する場合は、プラグインオプション「Other whitespace」のチェックを有効化する。

jEditのその他の設定

jEditの設定は、メニュー「ユーティリティ」−「グローバルオプション」から変更できる。

よく設定する値
  • ラップマージン：「編集」の「ラップマージン」から設定する。100または120くらいにする。
  • タブの表示幅：「編集」の「タブ幅」から設定する。値は、4にする。
  • インデント幅：「編集」の「インデント幅」を4にする。
  • エディタのフォント：「テキストエリア」の「テキストフォント」から設定可能。「MS ゴシック」など等幅かつ日本語対応のフォントにする。
  • 現在のカーソル行の表示：「テキストエリア」の「行列マーカー」にチェックを入れる。
バックアップファイルを作りたくない場合

jEditは標準で、「sample.txt~」というように、バックアップファイルが作られる。

これを作りたくない場合は、メニュー「ユーティリティ」−「グローバルオプション」の「保存＆バックアップ」から変更できる。

  • 「保存＆バックアップ」の項目「バックアップの最大数」を“1”→”（空）”にクリアする。
  • 「保存＆バックアップ」の項目「バックアップファイル名サフィクス」を“~”→”（空）”にクリアする。