# bnf-mode - BNF ファイルを編集したりする

- Author: miyamuko <URL:mailto:miyamuko (at) mtb.biglobe.ne.jp>
- URL: <URL:http://miyamuko.s56.xrea.com/xyzzy/bnf-mode.html>
- Version: $Id: bnf-mode.l,v 1.9 2004/08/09 14:03:01 miyamuko Exp $

## 1 説明

BNF を読みために作ったモードです。書くことはあまり考慮していません。

- ABNF(Augmented BNF) と EBNF(Extended BNF) に大体対応
- 適当なインデント
- 適当な色づけ
- ルール名のタグジャンプ

## 2 インストール

NetInstaller でインストールした場合は 3 以降を、 NetInstaller + `ni-autoload` を使っている人は 4 以降で OK です。

1. アーカイブをダウンロードします。

   <URL:http://miyamuko.s56.xrea.com/xyzzy/archives/bnf-mode.zip>

2. アーカイブを展開して、$XYZZY/site-lisp 配下にファイルをコピーします。

3. 拡張子が bnf、abnf、ebnf のファイルを開いたときに自動的に bnf-mode になるように ~/.xyzzy または $XYZZY/site-lisp/siteinit.l に以下のコードを追加します。

       ;; bnf-mode
       (require "bnf-mode")
       (pushnew '("\\.[ae]?bnf$" . bnf-mode) *auto-mode-alist* :test 'equal)

4. 設定を反映させるため xyzzy を再起動してください。

   ※siteinit.l に記述した場合には再ダンプが必要です。

## 3 リファレンス

### 3.1 キー割り当て

`TAB`

  インデントします。

  - ルールを継続する文字があれば前の行とインデントをそろえます。
  - ルールを継続する文字がない場合、通常インデントしません。
  - 通常インデントしない行でも行頭にスペースが一文字以上あればインデントします。

  ルールを複数行にわたって書く場合は次のようにインデントします。

      TypeDeclaration = ClassDeclaration /
                        InterfaceDeclaration
                        / ";"

  ルール名の直後で改行した場合は次のようにインデントします。 (`*bnf-indent-level*` が 2 の場合)

      declaration-specifiers:
        (storage-class-specifier | type-specifier
        | type-qualifier)+

`RET`
  改行＋インデント付け。

### 3.2 変数

`*bnf-indent-level*`

インデントの幅を設定します。(下図の _ 部分, デフォルト 2)

    rule_name:
    __element

インデントの深さを 4 カラムに変更する場合。

    ;; インデントは 4
    (setq *bnf-indent-level* 4)

`*bnf-rule-separator-regexp*`

ルールのセパレータのパターンを設定します。(デフォルトは (::= or : or = or =/))

    ;; セパレータをコロンのみに設定
    (setq *bnf-rule-separator-regexp* ":")

## 4 これからやるかもしれないこと

1. ルール名の区切り文字のインデントを前のルールとあわせる。

       rule_name1    = foo ; 最初は手でインデント。
       rule_name2    = bar ; ここは自動的に前の行にあわせる。
       loooooooong_rule_name1 = baz ; これはしょうがない。
       rule_name3 = hoge ; ここも戻る。

2. へなちょこなので放置

## 5 関連するかもしれないページ

RFC2234 - Augmented BNF for Syntax Specifications: ABNF
  <URL:http://www.ietf.org/rfc/rfc2234.txt>

## 6 ライセンス

bnf-mode は修正 BSD ライセンスに基づいて利用可能です。

    Copyright (C) 2003-2004 MIYAMUKO Katsuyuki. All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are
    met:

    1 Redistributions of source code must retain the above copyright notice,
    this list of conditions and the following disclaimer as the first lines
    of this file unmodified.

    2 Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    SUCH DAMAGE.