language-rust aspires to efficiently and accurately parse and pretty print the Rust language.
The underlying AST structures are also intended to be as similar as possible to the libsyntax AST
that rustc itself uses.
A typical use looks like:
>>> :set -XTypeApplications +t
>>> import Language.Rust.Syntax
>>> -- Sample use of the parser
>>> import Language.Rust.Parser
>>> let inp = inputStreamFromString "fn main () { println!(\"Hello world!\"); }"
inp :: InputStream
>>> let sourceFile = parse' @(SourceFile Span) inp
sourceFile :: SourceFile Span
>>> -- Sample use of the pretty printer
>>> import Language.Rust.Pretty
>>> pretty' sourceFile
fn main() {
println!("Hello world!");
}
it :: Doc bWith Cabal and GHC, run
cabal install happy --constraint 'happy >= 1.19.8'
cabal install alex
cabal configure
cabal build
With the Stack tool installed, run
stack init
stack build
The second command is responsible for pulling in all of the dependencies (including executable
tools like Alex, Happy, and GHC itself) and then compiling everything. If Stack complains
about the version of Happy installed, you can explicitly install a recent one with stack install happy-1.19.8.
As Rust evolves, so will language-rust. A best effort will be made to support unstable features
from nightly as they come out, but only compatibility with stable is guaranteed. The last component
of the version number indicates the nightly Rust compiler version against which tests were run. For
example, 0.1.0.26 is tested against rustc 1.26.0-nightly.
Please report any bugs to the github issue tracker.
Any difference between what is accepted by the rustc parser and the language-rust parser
indicates one of
- a bug in
language-rust(this is almost always the case) - a bug in
rustc - that there is a newer version of
rustcwhich made a breaking change to this syntax
If the AST/parser of rustc changes, the rustc-tests test suite should start failing - it
compares the JSON AST debug output of rustc to our parsed AST.
For the pretty printer, bugs are a bit tougher to list exhaustively. Suggestions for better layout
algorithms are most welcome! The fmt-rfcs repo is loosely used as the reference for "correct"
pretty printing.