Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jflex-de/jflex
The fast scanner generator for Java™ with full Unicode support
https://github.com/jflex-de/jflex
bazel-rules cup dfa dfa-minimization flex grammar java lexer lexer-generator lexical-analyzer maven-plugin nfa parsing regexp scanner scanner-generator tokenizer yacc
Last synced: 7 days ago
JSON representation
The fast scanner generator for Java™ with full Unicode support
- Host: GitHub
- URL: https://github.com/jflex-de/jflex
- Owner: jflex-de
- License: other
- Created: 2015-02-15T05:33:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-12T09:47:35.000Z (about 1 year ago)
- Last Synced: 2024-10-02T20:47:01.426Z (about 1 month ago)
- Topics: bazel-rules, cup, dfa, dfa-minimization, flex, grammar, java, lexer, lexer-generator, lexical-analyzer, maven-plugin, nfa, parsing, regexp, scanner, scanner-generator, tokenizer, yacc
- Language: Java
- Homepage: http://jflex.de
- Size: 22.1 MB
- Stars: 582
- Watchers: 23
- Forks: 114
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/jflex-de/jflex/actions/workflows/build.yml)
# JFlex
[JFlex][jflex] is a lexical analyzer generator (also known as scanner generator) for Java.
JFlex takes as input a specification with a set of regular expressions and corresponding actions.
It generates Java source of a lexer that reads input, matches the input against the regular
expressions in the spec file, and runs the corresponding action if a regular expression
matched. Lexers usually are the first front-end step in compilers, matching keywords, comments,
operators, etc, and generating an input token stream for parsers.
JFlex lexers are based on deterministic finite automata (DFAs).
They are fast, without expensive backtracking.
## Usage
For documentation and more information see the [JFlex documentation][jflex-doc]
and the [wiki][wiki].
### Usage with Maven
[](https://search.maven.org/artifact/de.jflex/jflex/)
You need [Maven][maven] 3.5.2 or later, and JDK 8 or later.
1. Place grammar files in `src/main/flex/` directory.
2. Extend the project [POM build section][pom-build] with the `maven-jflex-plugin`
```xml
de.jflex
jflex-maven-plugin
1.9.0
generate
```
3. Voilà: Java code is produced in `target/generated-sources/` during the `generate-sources` phase
(which happens before the `compile` phase) and included in the compilation scope.
### Usage with ant
You need ant, the binary JFlex jar and JDK 8 or later.
1. Define ant task
```xml
```
2. Use it
```xml
```
### Usage with Bazel
We provide a [jflex rule](https://jflex-de.github.io/bazel_rules/)
```bazel
load("@jflex_rules//jflex:jflex.bzl", "jflex")
jflex(
name = "", # Choose a rule name
srcs = [], # Add input lex specifications
outputs = [], # List expected generated files
)
```
See the sample [simple BUILD](https://github.com/jflex-de/jflex/blob/master/jflex/examples/simple/BUILD.bazel)
file.
### Usage in CLI
You need the binary jflex jar and JDK 8 or later.
You can also use JFlex directly from the command line:
```sh
jflex/bin/jflex src/grammar/parser.flex
```
Or:
```sh
java -jar jflex-full-1.9.0.jar -d output src/grammar/parser.flex
```
### Other build tools
See [Build tool plugins](https://github.com/jflex-de/jflex/wiki/Build-tool-integration).
## Examples
Have a look at the sample project: [simple][example-simple] and other [examples].
## Contributing
[](https://javadoc.io/doc/de.jflex/jflex)
JFlex is free software, contributions are welcome.
See the [Contributing][contrib] page for instructions.
### Source layout
The top level directory of the JFLex git repository contains:
- **cup** A copy of the CUP runtime
- **cup-maven-plugin** A simple Maven plugin to generate a parser with CUP.
- **docs** the Markdown sources for the user manual
- **java** Java sources [WIP, Bazel]
- **javatests** Java sources of test [WIP, Bazel]
- **jflex** JFlex, the scanner/lexer generator for Java
- **jflex-maven-plugin** the JFlex maven plugin, that helps to integrate JFlex in your project
- **jflex-unicode-plugin** the JFlex unicode maven plugin, used for compiling JFlex
- **testsuite** the regression test suite for JFlex,
- **third_party** third-party libraries used by examples of the [Bazel build system][bazel]
### Build from source
#### Build with Bazel
JFlex can be built with Bazel.
[Migration to Bazel][migration-bazel] is still work in progress, concerning the test suite, for instance.
You need [Bazel][bazel].
```sh
bazel build //jflex:jflex_bin
```
This builds `bazel-bin/jflex/jflex_bin`, that you can use
```sh
bazel-bin/jflex/jflex_bin --info
```
Or:
```sh
bazel run //jflex:jflex_bin -- --info
```
Build uberjar (aka fatjar aka deploy jar)
```sh
bazel build jflex/jflex_bin_deploy.jar
```
#### Build with Maven
You need JDK 8 or later.
```sh
./mvnw install
```
This generates `jflex/target/jflex-full-1.9.1-SNAPSHOT.jar` that you can use, e.g.
```sh
java -jar jflex-full-1.9.1-SNAPSHOT.jar --info
```
[jflex]: http://jflex.de/
[jflex-doc]: http://jflex.de/manual.html
[wiki]: https://github.com/jflex-de/jflex/wiki
[pom-build]: https://maven.apache.org/pom.html#Build_Settings
[example-simple]: https://github.com/jflex-de/jflex/tree/master/jflex/examples/simple
[examples]: https://github.com/jflex-de/jflex/tree/master/jflex/examples/
[contrib]: https://github.com/jflex-de/jflex/wiki/Contributing
[bazel]: https://bazel.build/
[maven]: https://maven.apache.org/
[migration-bazel]: https://github.com/jflex-de/jflex/wiki/Migration-to-Bazel