bnf-mode-0.4.5/ 0000755 0001752 0001753 00000000000 14024613422 011636 5 ustar elpa elpa bnf-mode-0.4.5/README.org 0000644 0001752 0001753 00000010120 14024613421 013275 0 ustar elpa elpa * BNF Mode for GNU Emacs
[[https://www.gnu.org/licenses/gpl-3.0.txt][https://img.shields.io/badge/license-GPL_3-green.svg]]
[[https://github.com/sergeyklay/bnf-mode/actions][https://github.com/sergeyklay/bnf-mode/workflows/build/badge.svg]]
[[https://codecov.io/gh/sergeyklay/bnf-mode][https://codecov.io/gh/sergeyklay/bnf-mode/branch/master/graph/badge.svg]]
[[https://melpa.org/#/bnf-mode][https://melpa.org/packages/bnf-mode-badge.svg]]
[[https://stable.melpa.org/#/bnf-mode][https://stable.melpa.org/packages/bnf-mode-badge.svg]]
A GNU Emacs major mode for editing BNF grammars.
#+begin_quote
“Precise language is not the problem. Clear language is the problem.”
Richard Feynman
#+end_quote
Currently provides basic syntax and font-locking for BNF files. BNF notation is
supported exactly form as it was first announced in the ALGOL 60 report.
EBNF and ABNF are not supported but their implementation is planned in the near
future.
When developing this mode, the following documents were taken into account:
- [[https://www.masswerk.at/algol60/report.htm][Revised Report on the Algorithmic Language Algol 60]]
- [[https://tools.ietf.org/html/rfc822][RFC822]]: Standard for ARPA Internet Text Messages
- [[https://tools.ietf.org/html/rfc5234][RFC5234]]: Augmented BNF for Syntax Specifications: ABNF
- [[https://tools.ietf.org/html/rfc7405][RFC7405]]: Case-Sensitive String Support in ABNF
** Features
- Basic syntax definition
- Syntax highlighting
** Installation
Known to work with GNU Emacs 24.3 and later. BNF Mode may work with
older versions of Emacs, or with other flavors of Emacs (e.g. XEmacs)
but this is /not/ guaranteed. Bug reports for problems related to using
BNF Mode with older versions of Emacs will most like not be addressed.
The master of all the material is the Git repository at
https://github.com/sergeyklay/bnf-mode .
NOTE: The ~master~ branch will always contain the latest unstable version.
If you wish to check older versions or formal, tagged release, please switch
to the relevant [[https://github.com/sergeyklay/bnf-mode/tags][tag]].
The recommended way is to use [[https://elpa.gnu.org/][ELPA]], [[https://stable.melpa.org/][MELPA Stable]] or [[https://melpa.org/][MELPA]]. If either is in your
=package-archives=, do:
#+begin_src
M-x package-install RET bnf-mode RET
#+end_src
To learn on how to use any other installation methods refer to relevant
documentation.
** Usage
*** Interactive Commands
| Command (For the ~M-x~ prompt.) | Description |
|---------------------------------+----------------------------------|
| ~bnf-mode~ | Switches to BNF Mode. |
By default any file that matches the glob ~*.bnf~ is automatically opened
in ~bnf-mode~.
** Customization
To customize various options, use command as follows:
#+begin_src
M-x customize-group RET bnf RET
#+end_src
** Support
Feel free to ask question or make suggestions in our [[https://github.com/sergeyklay/bnf-mode/issues][issue tracker]] .
** Changes
To see what has changed in recent versions of BNF Mode see:
https://github.com/sergeyklay/bnf-mode/blob/master/NEWS .
** External Links
- [[https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form][Wikipedia: Backus–Naur form]]
- [[https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form][Wikipedia: Extended Backus–Naur form]]
- [[https://en.wikipedia.org/wiki/Augmented_Backus%E2%80%93Naur_form][Wikipedia: Augmented Backus–Naur form]]
- [[https://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf][ISO/IEC 14977: EBNF]]
- [[https://www.ics.uci.edu/~pattis/ICS-33/lectures/ebnf.pdf][EBNF: A Notation to Describe Syntax]]
** License
BNF Mode is open source software licensed under the [[https://github.com/sergeyklay/bnf-mode/blob/master/LICENSE][GNU General Public Licence version 3]].
Copyright © 2019, 2020, Free Software Foundation, Inc.
*** Note On Copyright Years
In copyright notices where the copyright holder is the Free Software Foundation,
then where a range of years appears, this is an inclusive range that applies to
every year in the range. For example: 2005-2008 represents the years 2005,
2006, 2007, and 2008.
bnf-mode-0.4.5/bnf-mode.texi 0000644 0001752 0001753 00000021361 14024613422 014223 0 ustar elpa elpa \input texinfo @c -*- texinfo -*-
@c %**start of header
@setfilename bnf-mode.info
@settitle BNF Mode User Manual
@documentencoding UTF-8
@documentlanguage en_US
@c %**end of header
@copying
@ifnottex
BNF Mode is a GNU Emacs major mode for editing BNF grammars.
Presently it provides basic syntax and font-locking for BNF files.
BNF notation is supported exactly form as it was first announced in
the ALGOL 60 report.
@noindent
This manual is for BNF Mode version 0.4.5.
@end ifnottex
Copyright @copyright{} 2019-2020 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover Texts being “A GNU Manual,”
and with the Back-Cover Texts as in (a) below. A copy of the license
is included in the section entitled “GNU Free Documentation License.”
(a) The FSF's Back-Cover Text is: “You have the freedom to copy and
modify this GNU manual.”
@end quotation
@end copying
@dircategory Emacs
@direntry
* BNF Mode: (bnf-mode). Major mode for editing BNF grammars.
@end direntry
@finalout
@titlepage
@title BNF Mode User Manual
@subtitle for version 0.4.5
@author Serghei Iakovlev
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@contents
@ifnottex
@node Top
@top BNF Mode User Manual
@end ifnottex
@menu
* Introduction:: The mode description and concepts.
* Installation:: The ways of instalation BNF Mode.
* Usage:: BNF Mode usage.
* Customizing:: Customizing BNF Mode.
* Project Links:: Some important project links.
* Bibliography:: External resources used in the project.
* Index:: Complete index.
* Variable Index:: Variable index.
@detailmenu
--- The Detailed Node Listing ---
Installation
* Installing from Elpa or Melpa::
* Installing using El-get::
* Installing from the Git Repository::
Project Links
* Bugs Tracker::
* Change Log::
@end detailmenu
@end menu
@node Introduction
@chapter Introduction
BNF Mode is a GNU Emacs major mode for editing BNF grammars.
Presently it provides basic syntax and font-locking for BNF files.
BNF notation is supported exactly form as it was first announced in
the ALGOL 60 report.
@node Installation
@chapter Installation
@cindex Installation
BNF Mode known to work with GNU Emacs 24.3 and later. BNF Mode may
work with older versions of Emacs, or with other flavors of Emacs
(e.g. XEmacs) but this is @i{not} guaranteed. Bug reports for problems
related to using BNF Mode with older versions of Emacs will most like
not be addressed.
@menu
* Installing from Elpa or Melpa::
* Installing using El-get::
* Installing from the Git Repository::
@end menu
@node Installing from Elpa or Melpa
@section Installing from Elpa or Melpa
BNF Mode is available from Elpa, Melpa and Melpa-Stable. If you
haven't used Emacs' package manager before, then it is high time you
familiarize yourself with it by reading the documentation in the Emacs
manual, see @ref{Packages,,,emacs,}. Then add one of the archives to
@code{package-archives}:
@cindex Elpa, installation
@itemize
@item
To use Elpa:
@end itemize
@lisp
(require 'package)
(package-initialize)
@end lisp
@cindex Melpa, installation
@itemize
@item
For those who want only formal, tagged releases use Melpa Stable:
@end itemize
@lisp
(require 'package)
(add-to-list 'package-archives
'("melpa-stable" . "https://stable.melpa.org/packages/") t)
(package-initialize)
@end lisp
@itemize
@item
For those who want rolling releases as they happen use Melpa:
@end itemize
@lisp
(require 'package)
(add-to-list 'package-archives
'("melpa" . "https://melpa.org/packages/") t)
(package-initialize)
@end lisp
Melpa tracks BNF Mode's Git repository and updates relatively soon
after each commit or formal release. For more detail on setting up
see @uref{https://melpa.org/#/getting-started, MELPA Getting Started}.
Once you have added your preferred archive, you need to update the
local package list using @kbd{M-x} @code{package-refresh-contents}
@kbd{RET}. Finally, use @kbd{M-x} @code{package-list-packages}
@kbd{RET} to get to the package listing and install @code{bnf-mode}
from there.
There are several ways to install @code{bnf-mode} after package
initialization:
@itemize
@item
You can install @code{bnf-mode} manually by adding following to your
init file:
@end itemize
@lisp
(unless (package-installed-p 'bnf-mode)
(package-refresh-contents)
(package-install 'bnf-mode))
@end lisp
@cindex Cask, installation
@itemize
@item
To use @uref{https://cask.github.io/, Cask} add following to your
@code{Cask} file:
@end itemize
@lisp
(source melpa)
(depends-on "bnf-mode")
@end lisp
@itemize
@item
To install @code{bnf-mode} using @code{use-package} add following to
your init file:
@end itemize
@lisp
(use-package bnf-mode
:ensure t
;; To use MELPA Stable use ":pin mepla-stable",
;; to use ELPA remove ":pin" line
:pin melpa
:mode "\\.bnf\\'")
@end lisp
@node Installing using El-get
@section Installing using El-get
If you use el-get, just create a recipe file @code{bnf.rcp}:
@lisp
(:name bnf-mode
:website "https://github.com/sergeyklay/bnf-mode"
:description "BNF Mode: A major mode for editing BNF grammars"
:type github
:pkgname "sergeyklay/bnf-mode")
@end lisp
Then add it to a directory present in @code{el-get-recipe-path}.
Then, use @kbd{M-x} @code{el-get-install} @kbd{RET} @code{bnf-mode}
@kbd{RET} or add to your init file:
@lisp
(el-get-bundle bnf-mode)
@end lisp
@node Installing from the Git Repository
@section Installing from the Git Repository
BNF Mode depends only on the @code{cl-lib}, which is bundled with GNU
Emacs. Thus you don't have to install any additional library to
satisfy BNF Mode dependencies. Below are simple steps to install BNF
Mode using manual approach:
Clone the BNF Mode repository:
@example
$ git clone https://github.com/sergeyklay/bnf-mode.git \
~/.emacs.d/site-lisp/bnf-mode
@end example
Add this to your init file:
@lisp
(add-to-list 'load-path "~/.emacs.d/site-lisp/bnf-mode")
@end lisp
Add @i{either} of the two following lines to your initialization file.
The first only loads BNF Mode when necessary, the 2nd always during
startup of GNU Emacs:
@lisp
(autoload 'bnf-mode "bnf-mode" nil t)
;; OR
(require 'bnf-mode)
@end lisp
@node Usage
@chapter Usage
By default any file that matches the glob @code{*.bnf} is
automatically opened in @code{bnf-mode}. To toggle the mode in the
current buffer use @kbd{M-x} @code{bnf-mode} @kbd{RET}.
@node Customizing
@chapter Customizing
@cindex Customizing
There are not so much customization options yet.
To customize @code{abbrev-mode} for @code{bnf-mode}, simple add preffered
abbreviations to @code{bnf-mode-abbrev-table}.
If you want, you can go without any customizations at all. The above
settings are the most bang for the buck in terms of customization. So
users that typically don't like customize a lot are advised to look at
these settings first. To customize BNF Mode options using textual GUI
system, use the following command: @kbd{M-x} @code{customize-group}
@kbd{RET} @code{bnf} @kbd{RET}.
@node Project Links
@chapter Project Links
@menu
* Bugs Tracker::
* Change Log::
@end menu
@node Bugs Tracker
@section Bugs Tracker
Bug tracking is currently handled using the GitHub
@uref{https://github.com/sergeyklay/bnf-mode/issues, issue tracker}.
@node Change Log
@section Change Log
History is tracked in the
@uref{https://github.com/sergeyklay/bnf-mode/blob/master/NEWS, Git
repository} rather than in this documentation.
@node Bibliography
@chapter Bibliography
Below are some links to external resources used when developed BNF Mode:
@itemize @bullet
@item
RFC822: Standard for ARPA Internet Text Messages.
@url{https://www.ietf.org/rfc/rfc822.txt}
@item
RFC5234: Augmented BNF for Syntax Specifications ABNF.
@url{https://www.ietf.org/rfc/rfc5234.txt}
@item
RFC7405: Case-Sensitive String Support in ABNF.
@url{https://www.ietf.org/rfc/rfc7405.txt}
@item
Revised Report on the Algorithmic Language Algol 60.
@url{https://www.masswerk.at/algol60/report.htm}
@item
Wikipedia: Backus–Naur form.
@url{https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form}
@item
Wikipedia: Extended Backus–Naur form.
@url{https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form}
@item
Wikipedia: Augmented Backus–Naur form.
@url{https://en.wikipedia.org/wiki/Augmented_Backus%E2%80%93Naur_form}
@item
ISO/IEC 14977: 1996(E).
@url{https://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf}
@item
EBNF: A Notation to Describe Syntax.
@url{https://www.ics.uci.edu/~pattis/ICS-33/lectures/ebnf.pdf}
@end itemize
@node Index
@unnumbered Index
@printindex cp
@node Variable Index
@unnumbered Variable Index
@printindex vr
@bye
bnf-mode-0.4.5/LICENSE 0000644 0001752 0001753 00000104514 14024613421 012647 0 ustar elpa elpa GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
. bnf-mode-0.4.5/dir 0000644 0001752 0001753 00000001151 13627551740 012351 0 ustar elpa elpa This is the file .../info/dir, which contains the
topmost node of the Info hierarchy, called (dir)Top.
The first time you invoke Info you start off looking at this node.
File: dir, Node: Top This is the top of the INFO tree
This (the Directory node) gives a menu of major topics.
Typing "q" exits, "H" lists all Info commands, "d" returns here,
"h" gives a primer for first-timers,
"mEmacs" visits the Emacs manual, etc.
In Emacs, you can click mouse button 2 on a menu item or cross reference
to select it.
* Menu:
Emacs
* BNF Mode: (bnf-mode). Major mode for editing BNF grammars.
bnf-mode-0.4.5/bnf-mode.el 0000644 0001752 0001753 00000014210 14024613421 013644 0 ustar elpa elpa ;;; bnf-mode.el --- Major mode for editing BNF grammars. -*- lexical-binding: t; -*-
;; Copyright (C) 2019-2020 Free Software Foundation, Inc
;; Author: Serghei Iakovlev
;; Maintainer: Serghei Iakovlev
;; Version: 0.4.5
;; URL: https://github.com/sergeyklay/bnf-mode
;; Keywords: languages
;; Package-Requires: ((cl-lib "0.5") (emacs "24.3"))
;; Revision: $Format:%h (%cD %d)$
;;;; License
;; This file is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 3
;; of the License, or (at your option) any later version.
;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this file. If not, see .
;;; Commentary:
;; BNF Mode is a GNU Emacs major mode for editing BNF grammars. Presently it
;; provides basic syntax and font-locking for BNF files. BNF notation is
;; supported exactly form as it was first announced in the ALGOL 60 report.
;;; Code:
;;;; Requirements
(eval-when-compile
(require 'rx)) ; `rx'
;;;; Customization
;;;###autoload
(defgroup bnf nil
"Major mode for editing BNF grammars."
:tag "BNF"
:prefix "bnf-"
:group 'languages
:link '(url-link :tag "GitHub Page" "https://github.com/sergeyklay/bnf-mode")
:link '(emacs-commentary-link :tag "Commentary" "bnf-mode"))
;;;; Specialized rx
(eval-when-compile
(defconst bnf-rx-constituents
`((bnf-rule-name . ,(rx (and
(1+ (or alnum digit))
(0+ (or alnum digit
(in "!\"#$%&'()*+,-./:;=?@[]^_`{|}~")
(in " \t"))))))
"Additional special sexps for `bnf-rx'."))
(defmacro bnf-rx (&rest sexps)
"BNF-specific replacement for `rx'.
In addition to the standard forms of `rx', the following forms
are available:
`bnf-rule-name'
Any valid BNF rule name. This rule was obtained by studying
ALGOL 60 report, where the BNF was officially announced.
Please note: This rule is not suitable for ABNF or EBNF
(see URL `https://www.masswerk.at/algol60/report.htm').
See `rx' documentation for more information about REGEXPS param."
(let ((rx-constituents (append bnf-rx-constituents rx-constituents)))
(rx-to-string (cond ((null sexps) (error "No regexp is provided"))
((cdr sexps) `(and ,@sexps))
(t (car sexps)))
t))))
;;;; Font Locking
(defvar bnf-font-lock-keywords
`(
;; LHS nonterminals may be preceded
;; by an unlimited number of spaces
(,(bnf-rx (and line-start
(0+ space)
"<"
(group bnf-rule-name)
">"
(0+ space)
"::="))
1 font-lock-function-name-face)
;; Other nonterminals
(,(bnf-rx (and (0+ space)
"<"
(group bnf-rule-name)
">"
(0+ space)))
1 font-lock-builtin-face)
;; “may expand into” symbol
(,(bnf-rx (and symbol-start
(group "::=")
symbol-end))
1 font-lock-constant-face)
;; Alternatives
(,(bnf-rx (and (0+ space)
symbol-start
(group "|")
symbol-end
(0+ space)))
1 font-lock-warning-face))
"Font lock BNF keywords for BNF Mode.")
;;;; Syntax
(defvar bnf-mode-syntax-table
(let ((table (make-syntax-table)))
;; FIXME: "_" doesn't mean "symbol" but "symbol constituent".
;; I.e. the settings below mean that Emacs will consider "a:b=(c" as one
;; symbol (aka "identifier") which can be seen if you try to C-M-f and
;; C-M-b to move by sexps.
;; Treat ::= as sequence of symbols
(modify-syntax-entry ?\: "_" table)
(modify-syntax-entry ?\= "_" table)
;; Treat | as a symbol
(modify-syntax-entry ?\| "_" table)
;; In BNF there are no strings
;; so treat ' and " as a symbols
(modify-syntax-entry ?\" "_" table)
(modify-syntax-entry ?\' "_" table)
;; In BNF there are no grouping
;; brackets except angle ones
(modify-syntax-entry ?\( "_" table)
(modify-syntax-entry ?\) "_" table)
(modify-syntax-entry ?\{ "_" table)
(modify-syntax-entry ?\} "_" table)
(modify-syntax-entry ?\[ "_" table)
(modify-syntax-entry ?\] "_" table)
;; Group angle brackets
(modify-syntax-entry ?\< "(>" table)
(modify-syntax-entry ?\> ")<" table)
;; Comments are begins with “;” and ends with “\n”
(modify-syntax-entry ?\; "<" table)
(modify-syntax-entry ?\n ">" table)
table)
"Syntax table in use in `bnf-mode' buffers.")
;;;; Initialization
;;;###autoload
(define-derived-mode bnf-mode prog-mode "BNF"
"A major mode for editing BNF grammars.
\\{bnf-mode-map}
Turning on BNF Mode calls the value of `prog-mode-hook' and then of
`bnf-mode-hook', if they are non-nil."
:syntax-table bnf-mode-syntax-table
;; Comments setup
(setq-local comment-use-syntax nil)
(setq-local comment-start "; ")
(setq-local comment-end "")
(setq-local comment-start-skip "\\(?:\\(\\W\\|^\\);+\\)\\s-+")
;; Font locking
(setq font-lock-defaults
'(
;; Keywords
bnf-font-lock-keywords
;; keywords-only
nil
;; According to RFC5234 rule names are case insensitive.
;; The names , , , and
;; all refer to the same rule. As far as is known, this doesn't
;; conflict with original BNF version
;; (see URL `https://tools.ietf.org/html/rfc5234')
t)))
;; Invoke bnf-mode when appropriate
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.bnf\\'" . bnf-mode))
(provide 'bnf-mode)
;;; bnf-mode.el ends here
bnf-mode-0.4.5/bnf-mode-pkg.el 0000644 0001752 0001753 00000000564 14024613422 014433 0 ustar elpa elpa ;; Generated package description from bnf-mode.el -*- no-byte-compile: t -*-
(define-package "bnf-mode" "0.4.5" "Major mode for editing BNF grammars." '((cl-lib "0.5") (emacs "24.3")) :keywords '("languages") :authors '(("Serghei Iakovlev" . "egrep@protonmail.ch")) :maintainer '("Serghei Iakovlev" . "egrep@protonmail.ch") :url "https://github.com/sergeyklay/bnf-mode")
bnf-mode-0.4.5/bnf-mode.info 0000644 0001752 0001753 00000024350 14024613422 014206 0 ustar elpa elpa This is bnf-mode.info, produced by makeinfo version 6.5 from
bnf-mode.texi.
BNF Mode is a GNU Emacs major mode for editing BNF grammars. Presently
it provides basic syntax and font-locking for BNF files. BNF notation
is supported exactly form as it was first announced in the ALGOL 60
report.
This manual is for BNF Mode version 0.4.5.
Copyright © 2019-2020 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, with the Front-Cover Texts
being “A GNU Manual,” and with the Back-Cover Texts as in (a)
below. A copy of the license is included in the section entitled
“GNU Free Documentation License.”
(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
modify this GNU manual.”
INFO-DIR-SECTION Emacs
START-INFO-DIR-ENTRY
* BNF Mode: (bnf-mode). Major mode for editing BNF grammars.
END-INFO-DIR-ENTRY
File: bnf-mode.info, Node: Top, Next: Introduction, Up: (dir)
BNF Mode User Manual
********************
* Menu:
* Introduction:: The mode description and concepts.
* Installation:: The ways of instalation BNF Mode.
* Usage:: BNF Mode usage.
* Customizing:: Customizing BNF Mode.
* Project Links:: Some important project links.
* Bibliography:: External resources used in the project.
* Index:: Complete index.
* Variable Index:: Variable index.
— The Detailed Node Listing —
Installation
* Installing from Elpa or Melpa::
* Installing using El-get::
* Installing from the Git Repository::
Project Links
* Bugs Tracker::
* Change Log::
File: bnf-mode.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
1 Introduction
**************
BNF Mode is a GNU Emacs major mode for editing BNF grammars. Presently
it provides basic syntax and font-locking for BNF files. BNF notation
is supported exactly form as it was first announced in the ALGOL 60
report.
File: bnf-mode.info, Node: Installation, Next: Usage, Prev: Introduction, Up: Top
2 Installation
**************
BNF Mode known to work with GNU Emacs 24.3 and later. BNF Mode may work
with older versions of Emacs, or with other flavors of Emacs (e.g.
XEmacs) but this is not guaranteed. Bug reports for problems related to
using BNF Mode with older versions of Emacs will most like not be
addressed.
* Menu:
* Installing from Elpa or Melpa::
* Installing using El-get::
* Installing from the Git Repository::
File: bnf-mode.info, Node: Installing from Elpa or Melpa, Next: Installing using El-get, Up: Installation
2.1 Installing from Elpa or Melpa
=================================
BNF Mode is available from Elpa, Melpa and Melpa-Stable. If you haven’t
used Emacs’ package manager before, then it is high time you familiarize
yourself with it by reading the documentation in the Emacs manual, see
*note (emacs)Packages::. Then add one of the archives to
‘package-archives’:
• To use Elpa:
(require 'package)
(package-initialize)
• For those who want only formal, tagged releases use Melpa Stable:
(require 'package)
(add-to-list 'package-archives
'("melpa-stable" . "https://stable.melpa.org/packages/") t)
(package-initialize)
• For those who want rolling releases as they happen use Melpa:
(require 'package)
(add-to-list 'package-archives
'("melpa" . "https://melpa.org/packages/") t)
(package-initialize)
Melpa tracks BNF Mode’s Git repository and updates relatively soon
after each commit or formal release. For more detail on setting up see
MELPA Getting Started (https://melpa.org/#/getting-started).
Once you have added your preferred archive, you need to update the
local package list using ‘M-x’ ‘package-refresh-contents’ ‘RET’.
Finally, use ‘M-x’ ‘package-list-packages’ ‘RET’ to get to the package
listing and install ‘bnf-mode’ from there.
There are several ways to install ‘bnf-mode’ after package
initialization:
• You can install ‘bnf-mode’ manually by adding following to your
init file:
(unless (package-installed-p 'bnf-mode)
(package-refresh-contents)
(package-install 'bnf-mode))
• To use Cask (https://cask.github.io/) add following to your ‘Cask’
file:
(source melpa)
(depends-on "bnf-mode")
• To install ‘bnf-mode’ using ‘use-package’ add following to your
init file:
(use-package bnf-mode
:ensure t
;; To use MELPA Stable use ":pin mepla-stable",
;; to use ELPA remove ":pin" line
:pin melpa
:mode "\\.bnf\\'")
File: bnf-mode.info, Node: Installing using El-get, Next: Installing from the Git Repository, Prev: Installing from Elpa or Melpa, Up: Installation
2.2 Installing using El-get
===========================
If you use el-get, just create a recipe file ‘bnf.rcp’:
(:name bnf-mode
:website "https://github.com/sergeyklay/bnf-mode"
:description "BNF Mode: A major mode for editing BNF grammars"
:type github
:pkgname "sergeyklay/bnf-mode")
Then add it to a directory present in ‘el-get-recipe-path’. Then,
use ‘M-x’ ‘el-get-install’ ‘RET’ ‘bnf-mode’ ‘RET’ or add to your init
file:
(el-get-bundle bnf-mode)
File: bnf-mode.info, Node: Installing from the Git Repository, Prev: Installing using El-get, Up: Installation
2.3 Installing from the Git Repository
======================================
BNF Mode depends only on the ‘cl-lib’, which is bundled with GNU Emacs.
Thus you don’t have to install any additional library to satisfy BNF
Mode dependencies. Below are simple steps to install BNF Mode using
manual approach:
Clone the BNF Mode repository:
$ git clone https://github.com/sergeyklay/bnf-mode.git \
~/.emacs.d/site-lisp/bnf-mode
Add this to your init file:
(add-to-list 'load-path "~/.emacs.d/site-lisp/bnf-mode")
Add either of the two following lines to your initialization file.
The first only loads BNF Mode when necessary, the 2nd always during
startup of GNU Emacs:
(autoload 'bnf-mode "bnf-mode" nil t)
;; OR
(require 'bnf-mode)
File: bnf-mode.info, Node: Usage, Next: Customizing, Prev: Installation, Up: Top
3 Usage
*******
By default any file that matches the glob ‘*.bnf’ is automatically
opened in ‘bnf-mode’. To toggle the mode in the current buffer use
‘M-x’ ‘bnf-mode’ ‘RET’.
File: bnf-mode.info, Node: Customizing, Next: Project Links, Prev: Usage, Up: Top
4 Customizing
*************
There are not so much customization options yet.
To customize ‘abbrev-mode’ for ‘bnf-mode’, simple add preffered
abbreviations to ‘bnf-mode-abbrev-table’.
If you want, you can go without any customizations at all. The above
settings are the most bang for the buck in terms of customization. So
users that typically don’t like customize a lot are advised to look at
these settings first. To customize BNF Mode options using textual GUI
system, use the following command: ‘M-x’ ‘customize-group’ ‘RET’ ‘bnf’
‘RET’.
File: bnf-mode.info, Node: Project Links, Next: Bibliography, Prev: Customizing, Up: Top
5 Project Links
***************
* Menu:
* Bugs Tracker::
* Change Log::
File: bnf-mode.info, Node: Bugs Tracker, Next: Change Log, Up: Project Links
5.1 Bugs Tracker
================
Bug tracking is currently handled using the GitHub issue tracker
(https://github.com/sergeyklay/bnf-mode/issues).
File: bnf-mode.info, Node: Change Log, Prev: Bugs Tracker, Up: Project Links
5.2 Change Log
==============
History is tracked in the Git repository
(https://github.com/sergeyklay/bnf-mode/blob/master/NEWS) rather than in
this documentation.
File: bnf-mode.info, Node: Bibliography, Next: Index, Prev: Project Links, Up: Top
6 Bibliography
**************
Below are some links to external resources used when developed BNF Mode:
• RFC822: Standard for ARPA Internet Text Messages.
• RFC5234: Augmented BNF for Syntax Specifications ABNF.
• RFC7405: Case-Sensitive String Support in ABNF.
• Revised Report on the Algorithmic Language Algol 60.
• Wikipedia: Backus–Naur form.
• Wikipedia: Extended Backus–Naur form.
• Wikipedia: Augmented Backus–Naur form.
• ISO/IEC 14977: 1996(E).
• EBNF: A Notation to Describe Syntax.
File: bnf-mode.info, Node: Index, Next: Variable Index, Prev: Bibliography, Up: Top
Index
*****
[index ]
* Menu:
* Cask, installation: Installing from Elpa or Melpa.
(line 50)
* Customizing: Customizing. (line 6)
* Elpa, installation: Installing from Elpa or Melpa.
(line 12)
* Installation: Installation. (line 6)
* Melpa, installation: Installing from Elpa or Melpa.
(line 17)
File: bnf-mode.info, Node: Variable Index, Prev: Index, Up: Top
Variable Index
**************
Tag Table:
Node: Top1103
Node: Introduction1802
Node: Installation2140
Node: Installing from Elpa or Melpa2662
Node: Installing using El-get4879
Node: Installing from the Git Repository5558
Node: Usage6459
Node: Customizing6744
Node: Project Links7421
Node: Bugs Tracker7592
Node: Change Log7825
Node: Bibliography8074
Node: Index9232
Node: Variable Index9939
End Tag Table
Local Variables:
coding: utf-8
End:
bnf-mode-0.4.5/NEWS 0000644 0001752 0001753 00000006555 14024613421 012347 0 ustar elpa elpa bnf-mode NEWS -- history of user-visible changes.
Copyright (C) 2019-2020 Free Software Foundation, Inc.
See the end of the file for license conditions.
This file is about changes in BNF Mode.
* BNF Mode 0.4.5
** Tests were migrated from ert-runner to buttercup.
Previously BNF Mode used `ert' through `ert-runner' for testing
purposes. However, it seems `ert-runner' is semi-abandoned. Thus,
tests were migrated to use more aggressively maintained test
framework calles `buttercup'.
** Removed support of ALGOL 60 style comments.
Actually, this syntax was never part of the BNF and was mistakenly
interpreted as an alternative way of commenting BNF grammars
introduced by Peter Naur.
* BNF Mode 0.4.4
** Rework documentation and provide Info-file.
Previous releases of BNF Mode were bundled with incorrect “dir” file
that contained an invalid link to documentation. This was
resolved. All documentation now lives in “info bnf-mode”.
* BNF Mode 0.4.3
** Fixed dependency list in the Cask file.
Dependency list was fixed by specifying `cl-lib' version as well as
removing `rx' (`rx' is part of GNU Emacs actually). This fixed the
issue reported in .
The issue is related to installation from the TAR file.
** CI/CD process was moved on GitHub Actions.
* BNF Mode 0.4.2
** First release in ELPA.
** Introduced ALGOL 60 comments style. Disabled by default.
** Use semicolons as a comments.
Only setting `bnf-mode-algol-comments-style' to non-nil will allow use
semicolons as a regular terminal symbols.
* BNF Mode 0.4.1
** Minor fix related to build & deploy BNF Mode on Travis CI.
* BNF Mode 0.4.0
** Added comment-start-skip to improve recognize comments.
** Return back comment-start and comment-end.
** Use more intelligent terminal syntax recognition.
Added support of ";" character as an extra character used in terminals.
** Provided ability to build installation package.
See make help for more.
* BNF Mode 0.3.2
** First release in MELPA.
** Treat ' and " as a regular symbols.
** Removed no longer needed comment-* variables.
** In the BNF there are no grouping brackets except angle ones.
** Removed the bnf-mode-version function.
Users can easily call describe-package or pkg-info-package-version
interactively if they want to get this information.
* BNF Mode 0.3.1
** Fixed BNF rule name definition to follow ALGOL 60 report.
* BNF Mode 0.3.0
** Nonterminals may be preceded by an unlimited number of spaces.
* BNF Mode 0.2.0
** Comments are no longer use syntax table.
** Changed comment syntax from "#" to ";" to follow RFC822#2.8.
* BNF Mode 0.1.0
** Initial stable release.
----------------------------------------------------------------------
GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Emacs. If not, see .
Local variables:
coding: utf-8
mode: outline
paragraph-separate: "[ ]*$"
end: