工藤探偵事務所

Resarch and Investigation

秀丸エディタのRuby1.9プログラミング用 強調表示定義ファイルを改良しました。

kudo-shunsaku2012-07-01


Ruby プログラミング用 強調表示定義ファイルは、秀丸エディタにてRubyソースコードが見やすくする、という目的で利用出来るものです。今回は、Ruby version 1.9.X で見やすい表示できるようなものを作りましたので公開させて頂きます。

WindowsRuby をとお考えの方は、宜しければお試し下さいませ。

秀丸エディタRuby用強調定義ファイルですが、Ruby1.9ソースコードで使おうと修正していましたが、そのついでに更にソースコードを見やすくしようと想いまして、少し改良しました。この改良が幸いしまして、かなり見やすくなったと想います。変更の差分は以下のREADMEをご参照下さいませ。*1

宜しければですが、皆さんにも是非使って貰おうと「秀丸」本家の頁にアップロードしてあります。現在公開して頂いておりますのでダウンロードしてお使い下さいませ

ファイル名は、

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

としました。

秀丸ユーザの方は、お試しにお使いになってみて下さい。
もし宜しければ、乾燥の芋など頂けると幸いです。

README

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

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

	(秀丸エディタ Ver8.13 で実行しています)


				フジエ カズヒロ
				June 15, 2012

拝啓。

Rubyでのメインストリームとなるバージョンが、1.8.x から 1.9.x へ
と移りつつある様子ですので、今更ながらではありますが、
以前公開したものを改修して1.9用に対応させてみました。
(現行リリース "Ruby 1.9.3-p194" をベースに作成したものです。)

また今回は、コーディングの際での更なる利便性を図るために、
シンボルやインスタンス変数、クラス変数、定数などを見やすくする
ための工夫も加えてあります。これでかなり見やすくなりました。

1.9で追加されましたハッシュでのシンボルでの簡易表記方法も
ハイライトするようにしてありますので、ご心配なくどうぞ。

ex. {a: 1, b: 2}

宜しければお試し下さいませ。

敬具。

How To Setting of Hidemaru

0. 設定手順

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

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

といった手順です。

以下でご説明します。

1. コピー

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

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

2. 設定のリスト

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

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

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

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

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


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

3. 背景の配色

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

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

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

これを行うには、

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

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

そこにあるボタンの

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

を選択します。

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

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

補足:

この「デザイン」項目の「場所の一覧」の中で使用するスタイルを
チェックボックスで選択できます。
「数値」が選択できますので、数値リテラルを色づけできますので
是非、選択しておきましょう。


4. Ruby 用の設定

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

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

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

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

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

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


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


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

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

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

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

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

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

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


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

6. 強調表示の色

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

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

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

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

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

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



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

Features

この「Ruby プログラミング用 強調表示定義ファイル Ver1.9.3」は、
現行最新版である「秀丸エディタ Ver8.13」にて使用しています。

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

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


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

// ---------------------------------------------------------------------


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

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

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

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

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

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

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


*1:-この強調表示定義ファイルの使い方は実際にダウンロードして頂きますと、そのアーカイブ・ファイルの中にREADMEを含んであります。その中に設定手順を書いておきましたので、お使いの際には是非ご覧下さいませ。-