language-rust: Parsing and pretty printing of Rust code

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

Language Rust is a library for the analysis of Rust code. It includes a complete, well tested parser and pretty printer.


[Skip to ReadMe]

Properties

Versions0.1.0.0, 0.1.0.0, 0.1.0.26, 0.1.1.26, 0.2.0.27
Change logChangeLog.md
Dependenciesarray (==0.5.*), base (>=4.8 && <5.0), bytestring (>=0.10), deepseq (>=1.1), prettyprinter (>=1.0), semigroups (>=0.18), template-haskell (>=2.10), transformers (>=0.4 && <0.6), utf8-string (>=1.0) [details]
LicenseBSD-3-Clause
Copyright(c) 2017-2018 Alec Theriault
AuthorAlec Theriault
Maintaineralec.theriault@gmail.com
CategoryLanguage
Home pagehttps://github.com/harpocrates/language-rust
Bug trackerhttps://github.com/harpocrates/language-rust/issues
Source repositoryhead: git clone https://github.com/harpocrates/language-rust.git
UploadedFri Mar 2 04:34:55 UTC 2018 by harpocrates

Modules

[Index]

Flags

NameDescriptionDefaultType
usebytestrings

Use ByteString instead of String as InputStream datatype

EnabledAutomatic
enablequasiquotes

Provide the experimental Language.Rust.Quote module

EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for language-rust-0.1.0.0

[back to package description]

Parser and pretty printer for Rust Build Status Windows build status

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 rustc uses itself. When language-rust and rustc have diverging AST, the divergence should be detailed in the documentation.

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 b

Building

Cabal

With Cabal and GHC, run

cabal install happy --constraint 'happy >= 1.19.8'
cabal install alex
cabal configure
cabal build

Stack

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.

Evolution of Rust

As Rust evolves, so will language-rust. We will make a best effort to support unstable features from nightly as they come out, but in general will only target compatibility with stable.

Bugs

Please report any bugs to the github issue tracker.

Parser

Any difference between what is accepted by the rustc parser and the language-rust parser indicates

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.

Pretty printer

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.