工藤探偵事務所

Resarch and Investigation

秀丸エディタのRuby プログラミング用 強調表示定義ファイルを作りました。

kudo-shunsaku2008-01-11



あけおめ。ことよろ。ども、探偵の工藤です。

唐突ですが、作ってみました。秀丸エディタの強調定義ファイル*1です。

今回は Ruby 用の定義ファイルを、5日間*2掛けてつくりました、大作です。勉強のためにも様々な組み込みの名前を羅列するという、力業で作ったものです。
かなり、Rubyソースコードが見やすくなってる、と自分では思ってます。

皆さんにも使って貰おうと「秀丸」本家の頁にアップロードしてあります。まだ公開してくれてませんが、もし無事公開してくれたらダウンロードしてみて下さいませ。。。

追記:無事に公開されました。宜しければお試し下さいませ。

Ruby プログラミング用 強調表示定義ファイル Ver1.8.6


ファイル名は、

Ruby プログラミング用 強調表示定義ファイル Ver1.8.6

としました。

秀丸ユーザの方はお使いになってみて下さい。
御贔屓の程、宜しくお願い致します。
乾燥の芋など頂けると幸いです。




また、Java プログラミング言語をお使いの方はコチラをどうぞ。

Java プログラミング用 強調表示定義ファイル Ver1.5

Java プログラミング用 強調表示定義ファイル Ver1.1

Java プログラミング用 強調表示定義ファイル Ver1.0

他にも有志の方々がアップロードされた色々な定義ファイルもあります。

秀丸エディタの強調表示定義ファイルライブラリ

秀丸エディタ強調表示定義ファイルライブラリ:ダウンロードランキング

下記に添付した README ファイルの内容を掲載します。

Ruby プログラミング用 強調表示定義ファイル Ver1.8.6(秀丸エディタ Ver6.14 で実行しています)
フジエ カズヒロ

(A) Introduction
(B) How to
(C) Features
(D) Caution

A. Introduction

[Jan 08, 2008]

拝啓。

最近、周囲の流れに巻き込まれ Ruby の勉強をはじめております。
そこで Ruby の文法をより良く理解するために、
Ruby用の強調表示ファイルを作成してみました。

参考にしたのは、下記の「Ruby リファレンスマニュアル」です。

オブジェクト指向スクリプト言語 Ruby リファレンスマニュアル

http://www.ruby-lang.org/ja/man/


ここでは、標準で使用される組み込み関数や組み込みクラスを網羅する
という試みであります。

以前より、有志の方により Ruby の強調表示定義などが公開されており、
広く利用されている様子ですが、
本作では、なるたけ丁寧に一つ一つ頻繁に出るような重要単語を
ハイライトするように設定してみました。

特にRuby言語の場合、見慣れない組み込みの関数や変数などが多く、
しかも簡易に記述させるため、唐突にその名前が登場してくるので
読む側としては、とても理解しづらいという側面があったりします。

そういった単語を強調させて該当プログラムの理解を即すのが目的です。


またこのファイルでのキーワード登録方法は、
後で簡易に変更可能にするため、単純に単語を登録する方法で行っています。
ですから、ご自分でお好みに変更も出来るかと想います。

必要であれば貴殿が多用されるプログラムの種類や用途に合わせて、
語句の追記や消去など、カスタマイズしてご利用下さいませ。

しかしながら、あまり多くを強調表示に追加しても誤解を招くだけなので、
ご自分でよく使われるパッケージを追加して使いやすくするのが
得策かとも思われます。

(標準のキーワードだけでも多数を登録してしまいましたけども。。。)


尚、このバージョン番号ですが、
現在使用しているRubyのバージョンが1.8.6なので、
これ対応を謳うためにこの強調定義ファイルも1.8.6
というバージョンにしてみました。
それだけの理由です。

以前、Java版の強調表示定義ファイルをアップロードしましたが、
有難いことに、多くの方々に使って頂いているようにお見受けできます。
これも皆さんの何かの足しになってくれれば本懐という想いであります。


宜しければどうぞ。

敬具。


B. How to

0. 設定手順

設定方法の手順(例)についてご紹介させて頂きます。

(1) Ruby強調表示定義ファイルを所定の位置に配置する。
(2) Ruby言語用の設定リストをつくる。
(3) 背景の配色を黒バックにする。
(4) Ruby用の初期設定を行う。
(5) Ruby強調表示定義ファイルを設定する。
(6) 強調表示の色を変えてみる。

といった手順です。

以下でご説明します。


1. コピー

 まず、解凍してできた、強調表示定義ファイル "Ruby186-kfujie.hilight" を、
秀丸ディレクトリにコピーします。

これで下準備はオーケーです。


2. 設定のリスト

 その後に、Rubyのソースファイルを選んで、
(もしなければ、拡張子が「.rb」というファイルを作って)秀丸で開きます。

ファイルが開きましたら、ウィンドウ上部のメニューから、

「その他」→「ファイルタイプ別の設定」から「設定のリスト」ボタンを押して、
「設定のリスト」ダイアログを開きます。

「C言語ソースファイル」を選んだのち、「コピー」ボタンを押します。
ダイアログが出てきて新しい名前を聴かれますので、名前を「Ruby言語ソースファイル」」
など名前をつけましょう。

これで Ruby用の設定項目の雛形が出来ました。


この後、これを変更していき Ruby 用の設定にします。


3. 背景の配色

これはあくまでお好みですが、配色の設定です。

通常は、白い背景で操作していると想いますが、
私自身が使用するときは、背景が黒い色の方が、
見やすいです。

(黒の画面に緑とかオレンジなどの文字とか。もしかして古い人ですか?ね。)

これを行うには、

先ほどと同様に、「その他」→「ファイルタイプ別の設定」から

「その他」→「ファイルタイプ別の設定」でダイアログが表示されます。
この中の「表示とカラー」項目を選択します。
秀丸エディタ Ver7.X ですと「デザイン」という名前になってたりします。)

そこにあるボタンの

「リセット/統一」→「黒い背景の配色にリセットする」

を選択します。

これを行うと画面の配色を一度に変更できます。


これで設定の第壱段階終了です。


4. Ruby 用の設定

 秀丸の標準で「複数行コメント」などの区別をしてくれる設定が
Ruby用も用意されています。まずはそれを設定しましょう。

先ほどと同様に、「その他」→「ファイルタイプ別の設定」から
「表示とカラー」の項目の下にある「複数行コメント」を選択します。

表示上方に「複数行コメント(C):」というトグル・スイッチがありますので、
「言語指定」というのを選んで●(チェック)を入れて下さい。

そうすると表示下方では、様々な言語が選べるようになりますので、
無論、此処で "Ruby" を選びます。

これで、文字列やコメントなどが自動で認識されて、色がハイライトされます。

最後に画面最下部の左にある「OK」設定を保存します。
(この動作は以降の設定後も逐次行って下さい。)


これで設定の第弐段階終了です。


5. 定義ファイルを読み込み

そして肝心の強調表示ファイルを読み込んで設定をします。

先ほどと同様に、「その他」→「ファイルタイプ別の設定」から
「表示とカラー」の項目の下にある「強調表示」を選択します。

「強調表示」のチェックボックスが選択されている筈です。
(されていない場合は、「強調表示」のチェックを入れます。)

画面右下にある「読込み」ボタンを押して、強調表示用の定義ファイルを
読み込む指定をします。

ここで事前に用意していた "Ruby186-kfujie.hilight" が選べる筈ですので、
これを選択して「OK」ボタンを押して読み込みます。

ここで現在開いているご自分のファイルにRubyソースコードが記述してあれば、
綺麗に色分けされている筈です。ご確認下さい。


これで設定の第参段階終了です。


6. 強調表示の色

また、標準の色の割り当てが好みでない時は、
「表示とカラー」で表示される「場所の一覧(P):」から
下記の項目をを選んで、好きな色を設定出来ます。


強調表示の番号 (黒い背景色の場合の)最初の色


強調表示 1 白色
強調表示 2 黄色
強調表示 3 若草色
強調表示 4 桃色
強調表示 5 赤色(但し、赤色はリテラル及び正規表現でも使用済)
強調表示 6 緑色(但し、緑色はコメントでも使用済)
強調表示 7 青色
強調表示 8 灰色




上記の設定色をそれぞれお好きな色に設定しましょう。


これで設定はお仕舞いです。

どういう様に表示されるかソースコードのファイルを開いてみましょう。
あまりお気に召さない場合は、上記の手順を繰り返し行い、
色々な設定を試みて下さいませ。



こんな感じで使います。お楽しみ下さいませ。


C. Features

この「Ruby プログラミング用 強調表示定義ファイル Ver1.8.6」は、

秀丸エディタ Ver6.14」にて使用しています。
秀丸エディタ Ver7.07」の最新版でも問題なく動作します。

また、これより以前のバージョンの秀丸をお使いの方でも、Ver3.0以降であれば
強調表示機能を持っていますので、「秀丸エディタ」で使用することができます。


この強調表示定義ファイルの中身は、下記のの様に定義してあります。




// Ruby言語のソースコードのための強調表示定義ファイル
//
// 強調表示番号 プログラム中で表示する箇所
// 強調表示 1 キーワード(予約語) + α(文法的意味を持つ重要語句)
// 強調表示 2 未定義
// 強調表示 3 クラス名、モジュール名 + 添付ライブラリ クラス、モジュール名(一部のみ)
// 強調表示 4 変数 = 組み込み変数
// 強調表示 5 例外クラス + 添付ライブラリの例外クラス(一部のみ)
// 強調表示 6 未定義
// 強調表示 7 メソッド(関数)= 組み込み関数 + 組み込みクラス、モジュールのメソッド + 添付ライブラリのメソッド(一部のみ)
// 強調表示 8 定数 = 組み込み定数 + 組み込みクラス、モジュールの定数 + 添付ライブラリの定数(一部のみ)
// 参考:
// オブジェクト指向スクリプト言語 Ruby リファレンスマニュアル
// url:http://www.ruby-lang.org/ja/man/

http://www.ruby-lang.org/ja/man/


但し、クラスやモジュールなどで同名のメソッドが存在する場合には、
特に意味が無い限り数字が少ない番号の強調表示を優先するようにしています。

これとは逆にあるクラスのメソッドの実装がモジュールをインクルードしていることに
因るなど意味がある場合は、オリジナルである方を優先するようにします。

但し、3つ以上の複数一致する場合など、必ずしもそうでない場合もあります。

(強調定義ファイルの中では、後から定義した方が有効になる様子ですので
 基本的に後方の定義をコメントアウトしてあります。ご確認下さいませ。)

気に入らなければ、お好きなように変更してください。

それぞれの強調表示される色を自分好み変えておくことにより、
可也、見やすくなると想います。

尚、表示色を変更するには、「その他」→「ファイルタイプ別の設定」から
「表示とカラー」の項目で「強調表示色[1-8]」でそれぞれに変更できます。


D. Caution

但し書き:

本文書の作成には万全を期しますが、明示、暗黙を問わず
この文書の内容に関してはいかなる保証も適用しません。
内容に誤りがあり、またこの文書 によって、不利益を被っても、
作者は一切関知いたしません。

これが皆さんの何某かのお役に立てば幸いです。


尚、Ruby は作者である「まつもと ゆきひろ」氏によって
作成、公開されているプログラミング言語です。
Ruby は、オープンソース・ソフトウェアです。
詳細は以下をご参照下さい。

Rubyとは - Rubyコミュニティ
http://www.ruby-lang.org/ja/about/

ver1.8.6 [January 08, 2008]

@author Kazuhiro Fujie

*1:-以前にもJava版を作っておりますが。-

*2:-本日を入れて5日間。-