antlr/README.md

65 lines
4.9 KiB
Markdown
Raw Normal View History

2013-12-23 12:44:16 +08:00
# ANTLR v4
2012-02-01 11:28:15 +08:00
2021-01-27 01:30:53 +08:00
[![Java 7+](https://img.shields.io/badge/java-7+-4c7e9f.svg)](http://java.oracle.com)
[![License](https://img.shields.io/badge/license-BSD-blue.svg)](https://raw.githubusercontent.com/antlr/antlr4/master/LICENSE.txt)
**Build status**
Circleci project setup (#3055) * Add .circleci/config.yml * setup config * use jdk8 image * Updated config.yml * Updated config.yml * Updated config.yml * more targets * Updated config.yml * update config * update config * update config * update config * update config * Updated config.yml * Updated config.yml * Updated config.yml * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update runtime version * update config * update config * python3 config * update config * align Python2 and Python3 test hierarchy * update runtime version * update config * update config * update config * update config * explore dart issue * update dart installer * update config * update dart installer * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * use sudo on circle ci * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * Fix NPE * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * update config * more consistent badges * do not parallelize tests on circle-ci
2021-01-26 12:56:16 +08:00
[![Github CI Build Status (MacOSX)](https://img.shields.io/github/workflow/status/antlr/antlr4/MacOSX?label=MacOSX)](https://github.com/antlr/antlr4/actions)
[![AppVeyor CI Build Status (Windows)](https://img.shields.io/appveyor/build/parrt/antlr4?label=Windows)](https://ci.appveyor.com/project/parrt/antlr4)
[![Circle CI Build Status (Linux)](https://img.shields.io/circleci/build/gh/antlr/antlr4/master?label=Linux)](https://app.circleci.com/pipelines/github/antlr/antlr4)
2021-01-27 01:30:53 +08:00
[![Travis-CI Build Status (Swift-Linux)](https://img.shields.io/travis/antlr/antlr4.svg?label=Linux-Swift&branch=master)](https://travis-ci.com/github/antlr/antlr4)
2016-11-20 06:33:33 +08:00
2014-03-26 00:46:58 +08:00
**ANTLR** (ANother Tool for Language Recognition) is a powerful parser generator for reading, processing, executing, or translating structured text or binary files. It's widely used to build languages, tools, and frameworks. From a grammar, ANTLR generates a parser that can build parse trees and also generates a listener interface (or visitor) that makes it easy to respond to the recognition of phrases of interest.
2012-02-01 11:28:15 +08:00
2015-08-20 02:38:52 +08:00
*Given day-job constraints, my time working on this project is limited so I'll have to focus first on fixing bugs rather than changing/improving the feature set. Likely I'll do it in bursts every few months. Please do not be offended if your bug or pull request does not yield a response! --parrt*
2015-08-20 02:37:57 +08:00
2016-12-15 02:48:59 +08:00
[![Donate](https://www.paypal.com/en_US/i/btn/x-click-butcc-donate.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BF92STRXT8F8Q)
2016-12-15 02:38:42 +08:00
2015-01-23 09:52:07 +08:00
## Authors and major contributors
* [Terence Parr](http://www.cs.usfca.edu/~parrt/), parrt@cs.usfca.edu
ANTLR project lead and supreme dictator for life
[University of San Francisco](http://www.usfca.edu/)
2021-01-27 01:30:53 +08:00
* [Sam Harwell](http://tunnelvisionlabs.com/) (Tool co-author, Java and original C# target)
* [Eric Vergnaud](https://github.com/ericvergnaud) (Javascript, Python2, Python3 targets and maintenance of C# target)
2016-11-06 06:15:22 +08:00
* [Peter Boyer](https://github.com/pboyer) (Go target)
2016-08-05 23:20:33 +08:00
* [Mike Lischke](http://www.soft-gems.net/) (C++ completed target)
* Dan McLaughlin (C++ initial target)
* David Sisson (C++ initial target and test)
2016-11-24 06:51:19 +08:00
* [Janyou](https://github.com/janyou) (Swift target)
* [Ewan Mellor](https://github.com/ewanmellor), [Hanzhou Shi](https://github.com/hanjoes) (Swift target merging)
2017-03-31 00:47:06 +08:00
* [Ben Hamilton](https://github.com/bhamiltoncx) (Full Unicode support in serialized ATN and all languages' runtimes for code points > U+FFFF)
2019-09-14 20:36:37 +08:00
* [Marcos Passos](https://github.com/marcospassos) (PHP target)
2020-05-30 22:35:07 +08:00
* [Lingyu Li](https://github.com/lingyv-li) (Dart target)
2016-08-05 23:20:33 +08:00
2015-01-23 09:52:07 +08:00
## Useful information
* [Release notes](https://github.com/antlr/antlr4/releases)
2016-09-24 04:19:44 +08:00
* [Getting started with v4](https://github.com/antlr/antlr4/blob/master/doc/getting-started.md)
2013-12-31 03:47:47 +08:00
* [Official site](http://www.antlr.org/)
2016-09-24 04:19:44 +08:00
* [Documentation](https://github.com/antlr/antlr4/blob/master/doc/index.md)
* [FAQ](https://github.com/antlr/antlr4/blob/master/doc/faq/index.md)
2021-02-14 00:41:43 +08:00
* [ANTLR code generation targets](https://github.com/antlr/antlr4/blob/master/doc/targets.md)<br>(Currently: Java, C#, Python2|3, JavaScript, Go, C++, Swift, Dart, PHP)
2016-11-06 06:15:22 +08:00
* [Java API](http://www.antlr.org/api/Java/index.html)
2013-12-23 12:46:35 +08:00
* [ANTLR v3](http://www.antlr3.org/)
2016-09-24 04:19:44 +08:00
* [v3 to v4 Migration, differences](https://github.com/antlr/antlr4/blob/master/doc/faq/general.md)
2013-12-23 12:44:16 +08:00
2015-11-24 08:19:45 +08:00
You might also find the following pages useful, particularly if you want to mess around with the various target languages.
2015-01-23 09:52:07 +08:00
2016-09-24 04:19:44 +08:00
* [How to build ANTLR itself](https://github.com/antlr/antlr4/blob/master/doc/building-antlr.md)
* [How we create and deploy an ANTLR release](https://github.com/antlr/antlr4/blob/master/doc/releasing-antlr.md)
2013-12-23 12:44:16 +08:00
## The Definitive ANTLR 4 Reference
2013-12-23 12:47:53 +08:00
2013-12-23 12:44:16 +08:00
Programmers run into parsing problems all the time. Whether its a data format like JSON, a network protocol like SMTP, a server configuration file for Apache, a PostScript/PDF file, or a simple spreadsheet macro language—ANTLR v4 and this book will demystify the process. ANTLR v4 has been rewritten from scratch to make it easier than ever to build parsers and the language applications built on top. This completely rewritten new edition of the bestselling Definitive ANTLR Reference shows you how to take advantage of these new features.
2015-01-23 09:52:07 +08:00
You can buy the book [The Definitive ANTLR 4 Reference](http://amzn.com/1934356999) at amazon or an [electronic version at the publisher's site](https://pragprog.com/book/tpantlr2/the-definitive-antlr-4-reference).
You will find the [Book source code](http://pragprog.com/titles/tpantlr2/source_code) useful.
2014-01-07 20:24:38 +08:00
## Additional grammars
2013-12-23 12:44:16 +08:00
[This repository](https://github.com/antlr/grammars-v4) is a collection of grammars without actions where the
root directory name is the all-lowercase name of the language parsed
by the grammar. For example, java, cpp, csharp, c, etc...