秀丸エディタverilog入力支援設定

ツリー定義用ファイル†

以下の内容を verilog-tree.highlight と言う名前で、 C:\Users\<user>\AppData\Roaming\Hidemaruo\Hidemaru\Setting\ フォルダに保存します。

/<TreeWord>
/0000,0002,0000,00000000,00010113,"^[ \\t]*(end)?module",""
/0000,0002,0000,00000000,00012111,"^\\);",""
/0001,0002,0000,00000000,00010111,"^[ \\t]*/////[^/]",""
/0002,0002,0000,00000000,00010111,"^[ \\t]*////[^/]",""
/0003,0002,0000,00000000,00010111,"^[ \\t]*///[^/]",""
/0004,0002,0000,00000000,00010111,"^[ \\t]*(end)?(task|function)",""

メニューの [その他(O)]-[ファイルタイプ別の設定(C)]-[アウトライン]-[解析] から、 [読み込み(O)...] の一覧にこのファイル名が表示されるので、それを選べばＯＫです。

通常 // で始める行末までのコメントを、

/// と３つ重ねて始めることでアウトライン上の区切りとして使っています。

//// のように４つ重ねるとさらに強い区切りに、５つならその上、 というように階層化が可能になっています。

マクロソースファイル†

一番上が最新版です：

• VERILOG-MAC-20110224a.zip
• VERILOG-MAC-20110224.zip
• VERILOG-MAC-20110223.zip

VERILOG-JUMP.MAC: 定義へ移動†

このマクロは、呼び出された際のキャレット位置によって、

• `include 文から参照先ファイルを開く
  `include 文の含まれる行で呼び出された場合
• モジュール名から定義行に飛ぶ
  モジュール名っぽい文字列の上で呼び出された場合
• 飛んだ先から元の位置に戻る
  それ以外で呼び出された場合

のいずれかの動作をします。

VERILOG-INSTANTIATE-MODULE.MAC: ひな形を生成する†

モジュール名を書いてマクロを起動すると、 インスタンシエーションのひな形を生成します。

例えば、以下のような定義が serial_flash_rom.v にあるとき、

LANG:verilog
module serial_flash_rom #(
    parameter DATA_BITS = 32,
    parameter ADDR_BITS = 10,
    parameter ADDR_OFFSET = 0
) (
    // implement 時には最適化で失われるダミーの非同期リセット （シミュレーション用）
    input wire GSR_in,

    input wire clk,  // 100 MHz

    input wire  [DATA_BITS-1:0] idata,
    output wire [DATA_BITS-1:0] odata,
    input wire  [ADDR_BITS-1:0] addr,
    input wire  we,
    
    output wire spi_seln,
    output wire spi_clk,
    input wire spi_miso,
    output wire spi_mosi
);

main.v 上で、

LANG:verilog
serial_flash_rom

とだけタイプして上記マクロを起動すると、ひな形として

LANG:verilog
 serial_flash_rom #(
	.DATA_BITS(),
	.ADDR_BITS(),
	.ADDR_OFFSET()
) serial_flash_rom_inst (
	.GSR_in(GSR_in),
	.clk(clk),
	.idata(idata),
	.odata(odata),
	.addr(addr),
	.we(we),
	.spi_seln(spi_seln),
	.spi_clk(spi_clk),
	.spi_miso(spi_miso),
	.spi_mosi(spi_mosi)
);

を生成します。

起動時に信号線に接頭辞を付けるかどうか聞くメニューが出るので、 適当な接頭辞を与えることで

LANG:verilog
 serial_flash_rom #(
	.DATA_BITS(),
	.ADDR_BITS(),
	.ADDR_OFFSET()
) serial_flash_rom_inst (
	.GSR_in(flash_GSR_in),
	.clk(flash_clk),
	.idata(flash_idata),
	.odata(flash_odata),
	.addr(flash_addr),
	.we(flash_we),
	.spi_seln(flash_spi_seln),
	.spi_clk(flash_spi_clk),
	.spi_miso(flash_spi_miso),
	.spi_mosi(flash_spi_mosi)
);

のようにもできます。

デフォルトではモジュール名が接頭辞になりますが、 モジュール名が長い場合などは、接頭辞を手動で入力すれば どんな接頭辞でも自由に付けられます。

できたらいいと思っている内容†

秀丸マクロに手を染めると、何でもできそうに思えてきます、が、 マクロ記述にかまけていると本業が進まないのもまた事実（−−；

マクロの構成について†

秀丸マクロには、

• マクロはそれぞれ別ファイルに保存される。
• マクロからは同じファイルに書かれたサブルーチンしか呼び出せない。

という条件があるので、複数のマクロで同じサブルーチンを使い回すには、 それぞれのマクロファイルにサブルーチンコードのコピーを置かなければなりません。

それはあまりに無様なので、

• マクロから別のマクロを呼び出せる

を利用して、再利用可能な機能は独立したマクロとして記述するのが良さそう。

という考えで、以下のような構成になっています。

• VERILOG-JUMP.MAC
  • 状況により適切な飛び先へ移動する
    • `include 行であれば VERILOG-OPEN-INCLUDE.MAC を呼ぶ
    • モジュール名っぽい物の上であれば VERILOG-FIND-MODULE.MAC を呼ぶ
    • それ以外では VERILOG-RESTORE-POSITION.MAC を呼ぶ
  • "try" が指定されていれば何もせず状況判断結果を返す
• VERILOG-OPEN-INCLUDE.MAC
  • `include ファイルを開く
  • ファイルを見つけられなければ VERILOG-FILE-NOT-FOUND.MAC を呼ぶ
• VERILOG-FIND-MODULE.MAC
  • モジュール定義へ飛ぶ
  • モジュール定義を見つけられなければ VERILOG-FILE-NOT-FOUND.MAC を呼ぶ
• VERILOG-FILE-NOT-FOUND.MAC
  • エラーを表示すると共に 検索パス や 検索ワイルドカード を指定し直すメニューを表示する
• VERILOG-SAVE-POSITIONS.MAC
  • 現在位置あるいは指定位置を記憶する/記憶した位置へ飛ぶ
  • 履歴は５つまで。それ以降は古い物から忘れる。
  • "VERILOG_POSITIONS" というスタティック変数に格納される
• VERILOG-SETUP-SEARCH-PATH.MAC
  • モジュール定義ファイルの検索開始フォルダを設定する/読み出す
  • "VERILOG_PATH" というスタティック変数に格納される
• VERILOG-SETUP-SEARCH-MASK.MAC
  
  • モジュール定義ファイルの検索に使うワイルドカードを設定する/読み出す
  • "VERILOG_MASK" というスタティック変数に格納される
• VERILOG-INSTANTIATE-MODULE.MAC
  • キャレット位置のモジュール名から実体化のひな形を作成する
  • モジュール定義を見つけられなければ VERILOG-FILE-NOT-FOUND.MAC を呼ぶ

ユーザーが直接呼び出す可能性があるのは VERILOG-JUMP.MAC と VERILOG-INSTANTIATE-MODULE.MAC だけ。その他は内部でのみ使われます。

ファイル数が増えたかわりに、コードの重複を避けられました。

検索条件にこだわる人へ†

むむむ ( 2019-05-21 (火) 14:10:25)

かゆいところに手が届く有用なマクロ有り難く使わせていただいています。
このマクロをCtrl-1に割り当てて使いまくっていますが、ひとつ気になっていたのは、マクロを実行すると検索条件がこのマクロに設定されている内容に差し替わってしまう点でした。例えば、私は正規表現とヒットした検索後にマークする、の2点はこだわっていましたので、ちょっときぃぃぃ！となっていました。

本題に戻ります。公表いただいてるマクロの中にある setcompatiblemode の引数を 0x2030 → 0x00022030 にするとこの問題が解決するようです。

無題†

[きゅい] (2011-03-09 (水) 18:24:42)

verilogを記述するエディタを探していて、このページにたどり着きました。こちらのマクロが便利そうなので秀丸を使ってみようかと思います。ありがとうございます。以下、一つだけ気付いた点を、
モジュールの定義箇所(module モジュール名...)で、moduleとモジュール名の間がスペース1つの場合は良いのですが、複数のスペースやタブを使用しているとgrep検索に引っかからないようです。

• ご指摘ありがとうございます、確かにそうでした。VERILOG-FIND-MODULE.MAC の 31 行目 grep "module " + $$module, の部分を grep "module\\s+" + $$module, とすれば改善されると思います。お試し下さい。後で直しておきます。 -- [武内（管理人）] 2011-03-09 (水) 20:27:28

感謝感激!†

[アプロ] (2011-02-24 (木) 08:53:50)

モジュール名からインスタンシエーションのひな形 は感動しました
使わせてください！！　いつも、困ってましたし(^^ゞ

• まだうまくいかない場合もあるみたいで、徐々につぶしていこうと思ってます。失敗する例があったら教えて下さい。すでに昨晩１つ見つけたので直してたり（＾＾； -- [武内(管理人)] 2011-02-24 (木) 09:09:27