Need help with oak?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ptal
130 Stars 12 Forks Apache License 2.0 458 Commits 18 Opened issues

Description

A typed parser generator embedded in Rust code for Parsing Expression Grammars

Services available

!
?

Need anything else?

Contributors list

# 455,525
Rust
monad
c-plus-...
419 commits
# 350,463
Rust
Shell
vst-plu...
audio-p...
2 commits
# 138,725
Rust
Shell
microke...
regex
2 commits
# 341,002
macro
gtk
Haskell
D
1 commit
# 80,120
sublime...
Visual ...
rpi4
fbx
1 commit
# 36,705
Rust
Neovim
cpluspl...
binding...
1 commit

Oak

ptal on Travis CI

Compiled on the nightly channel of Rust. Use rustup for managing compiler channels. You can download and set up the exact same version of the compiler used with

rustup override add 2021-01-06
.

Please consult the Oak manual.

Features

  • Easy to install: PEG grammar description as a Rust procedural macro.
  • User-friendly: most of the types are automatically inferred from the parsing expressions.
  • Safe: Well-formedness analysis guarantees termination.
  • Modular: External parser rules can be called at any time.
  • Fast: Generation of both recognizer and parser functions for each rule.

Build local documentation

You might want to build the manual or code documentation from the repository because you need it to be synchronized with a specific version of Oak or simply for offline usage. Here how to do it!

Build the manual

You need the utility mdbook:

cargo install mdbook

Once installed, go inside

oak/doc
and execute
mdbook build -o
. The manual is generated inside a local folder named
book
and directly opened in your browser.

Build the code documentation

As a user of Oak, you will be interested by the runtime documentation.

cd oak/runtime
cargo doc

The documentation is then available in

oak/runtime/target/doc
.

To build the internal documentation of Oak, you can type this command at the root of the project:

cd oak
rustdoc --document-private-items --output=target/dev-doc src/liboak/lib.rs

The documentation will be available inside

oak/target/dev-doc
. It is useful to work on Oak :-)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.