antlr4 README

The project's README from github.com/antlr/antlr4. As one markdown file: README.md.

ANTLR v4

Java 11+ License

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.

Dev branch build status

MacOSX, Windows, Linux (github actions)

Versioning

ANTLR 4 supports 10 target languages (Cpp, CSharp, Dart, Java, JavaScript, PHP, Python3, Swift, TypeScript, Go), and ensuring consistency across these targets is a unique and highly valuable feature. To ensure proper support of this feature, each release of ANTLR is a complete release of the tool and the 10 runtimes, all with the same version. As such, ANTLR versioning does not strictly follow semver semantics:

If you use a semver verifier in your CI, you probably want to apply special rules for ANTLR, such as treating minor change as a major change.

Repo branch structure

The default branch for this repo is master, which is the latest stable release and has tags for the various releases; e.g., see release tag 4.9.3. Branch dev is where development occurs between releases and all pull requests should be derived from that branch. The dev branch is merged back into master to cut a release and the release state is tagged (e.g., with 4.10-rc1 or 4.10.) Visually our process looks roughly like this:

The Go target now has its own dedicated repo:

$ go get github.com/antlr4-go/antlr

Note The dedicated Go repo is for go get and import only. Go runtime development is still performed in the main antlr/antlr4 repo.

Authors and major contributors

Useful information

You might also find the following pages useful, particularly if you want to mess around with the various target languages.

The Definitive ANTLR 4 Reference

Programmers run into parsing problems all the time. Whether it’s 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.

You can buy the book The Definitive ANTLR 4 Reference at amazon or an electronic version at the publisher's site.

You will find the Book source code useful.

Additional grammars

This repository 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...

antlr4 (antlr/antlr4)

Searching Database…

19K ·GitHub
Что это такое?Генератор парсеров: вы пишете грамматику для своего языка или формата файлов, а ANTLR генерирует парсер, который строит деревья разбора, плюс интерфейсы listener/visitor, чтобы реагировать на распознанные фрагменты. Широко используется для создания языков, инструментов и фреймворков.
Это инструмент, который я запускаю, или библиотека, которую я подключаю в свой код?И то и другое: генератор — это консольная утилита на Java, которую вы запускаете на файле грамматики, и она выдаёт исходный код парсера. Этот сгенерированный код работает вместе с рантайм-библиотекой для выбранного вами языка, которую вы подключаете к своему проекту.
Как превратить грамматику в работающий парсер?Напишите грамматику в файле .g4, запустите jar ANTLR через Java — и он сгенерирует парсер плюс код listener/visitor на выбранном вами целевом языке; затем добавьте в проект соответствующую рантайм-библиотеку ANTLR. Руководство Getting started with v4 разбирает первый пример по шагам.
Для каких языков он умеет генерировать парсеры?Десять целевых языков: Java, C#, Python 3, JavaScript, TypeScript, Go, C++, Swift, Dart и PHP. Вы выбираете один язык, генерируете парсер и подключаете к проекту соответствующую рантайм-библиотеку ANTLR.
Всегда ли безопасно обновляться на новую версию ANTLR?Не вслепую: ANTLR не следует правилам semver. Минорные релизы могут содержать ломающие изменения, обратная совместимость гарантируется только при обновлении патч-версий, а официальная рекомендация — перегенерировать ваши парсеры при каждом релизе.
Где он работает?Генератор работает везде, где работает Java, — Windows, macOS, Linux, — а сгенерированные парсеры работают там, где работает выбранный целевой язык: от серверов на JVM до браузеров (JavaScript, TypeScript) и мобильных устройств (Swift, Dart).
Парсеры, сгенерированные для разных языков, работают одинаково?Да — согласованность всех 10 целевых языков — это явная цель дизайна, которую команда называет уникальной и очень ценной. Каждый релиз — это полный релиз инструмента и всех рантаймов под одним общим номером версии.
Python 2 он ещё поддерживает?Нет. Начиная с версии 4.14 поддержка Python 2 прекращена: Python 2 официально закрыт ещё в 2020 году, и поддерживать одинаковое качество на всех целевых языках стало невозможно. Используйте цель Python 3.
Каждую грамматику придётся писать с нуля?Нет — есть отдельная коллекция готовых грамматик без действий, где корневая папка — это имя разбираемого языка в нижнем регистре, например java, cpp, csharp или c.
Как лучше всего его освоить?Книга The Definitive ANTLR 4 Reference — именно её рекомендует README: она объясняет, как разбирать форматы данных вроде JSON, сетевые протоколы вроде SMTP и конфигурационные файлы серверов. Исходный код книги тоже доступен онлайн.
Creator
antlr
Size
69 MB
Stars
19K
Age
16y
Commits · 90 Days