ARCHITECTURE.md

   1 # Architecture
   2
   3 This document describes high-level architecture of rust-analyzer.
   4 If you want to familiarize yourself with the code base, you are just
   5 in the right place!
   6
   7 ## The Big Picture
   8
   9 ![](https://user-images.githubusercontent.com/1711539/50114578-e8a34280-0255-11e9-902c-7cfc70747966.png)
  10
  11 On the highest level, rust-analyzer is a thing which accepts input source code
  12 from the client and produces a structured semantic model of the code.
  13
  14 More specifically, input data consists of a set of test files (`(PathBuf,
  15 String)` pairs) and an information about project structure, the so called
  16 `CrateGraph`. Crate graph specifies which files are crate roots, which cfg flags
  17 are specified for each crate (TODO: actually implement this) and what are
  18 dependencies between the crates. The analyzer keeps all these input data in
  19 memory and never does any IO. Because the input data is source code, which
  20 typically measures in tens of megabytes at most, keeping all input data in
  21 memory is OK.
  22
  23 A "structured semantic model" is basically an object-oriented representation of
  24 modules, functions and types which appear in the source code. This representation
  25 is fully "resolved": all expressions have types, all references are bound to
  26 declarations, etc.
  27
  28 The client can submit a small delta of input data (typically, a change to a
  29 single file) and get a fresh code model which accounts for changes.
  30
  31 Underlying engine makes sure that model is computed lazily (on-demand) and can
  32 be quickly updated for small modifications.
  33
  34
  35 ## Code generation
  36
  37 Some of the components of this repository are generated through automatic
  38 processes. These are outlined below:
  39
  40 - `gen-syntax`: The kinds of tokens are reused in several places, so a generator
  41   is used. We use tera templates to generate the files listed below, based on
  42   the grammar described in [grammar.ron]:
  43   - [ast/generated.rs][ast generated] in `ra_syntax` based on
  44     [ast/generated.tera.rs][ast source]
  45   - [syntax_kinds/generated.rs][syntax_kinds generated] in `ra_syntax` based on
  46     [syntax_kinds/generated.tera.rs][syntax_kinds source]
  47
  48 [tera]: https://tera.netlify.com/
  49 [grammar.ron]: ./crates/ra_syntax/src/grammar.ron
  50 [ast generated]: ./crates/ra_syntax/src/ast/generated.rs
  51 [ast source]: ./crates/ra_syntax/src/ast/generated.rs.tera
  52 [syntax_kinds generated]: ./crates/ra_syntax/src/syntax_kinds/generated.rs
  53 [syntax_kinds source]: ./crates/ra_syntax/src/syntax_kinds/generated.rs.tera
  54
  55
  56 ## Code Walk-Through
  57
  58 ### `crates/ra_syntax`
  59
  60 Rust syntax tree structure and parser. See
  61 [RFC](https://github.com/rust-lang/rfcs/pull/2256) for some design
  62 notes.
  63
  64 - [rowan](https://github.com/rust-analyzer/rowan) library is used for constructing syntax trees.
  65 - `grammar` module is the actual parser. It is a hand-written recursive descent parsers, which
  66   produces a sequence of events like "start node X", "finish not Y". It works similarly to  [kotlin parser](https://github.com/JetBrains/kotlin/blob/4d951de616b20feca92f3e9cc9679b2de9e65195/compiler/frontend/src/org/jetbrains/kotlin/parsing/KotlinParsing.java),
  67   which is a good source for inspiration for dealing with syntax errors and incomplete input. Original [libsyntax parser](https://github.com/rust-lang/rust/blob/6b99adeb11313197f409b4f7c4083c2ceca8a4fe/src/libsyntax/parse/parser.rs)
  68   is what we use for the definition of the Rust language.
  69 - `parser_api/parser_impl` bridges the tree-agnostic parser from `grammar` with `rowan` trees.
  70   This is the thing that turns a flat list of events into a tree (see `EventProcessor`)
  71 - `ast` a type safe API on top of the raw `rowan` tree.
  72 - `grammar.ron` RON description of the grammar, which is used to
  73   generate `syntax_kinds` and `ast` modules, using `cargo gen-syntax` command.
  74 - `algo`: generic tree algorithms, including `walk` for O(1) stack
  75   space tree traversal (this is cool) and `visit` for type-driven
  76   visiting the nodes (this is double plus cool, if you understand how
  77   `Visitor` works, you understand the design of syntax trees).
  78
  79 Tests for ra_syntax are mostly data-driven: `tests/data/parser` contains a bunch of `.rs`
  80 (test vectors) and `.txt` files with corresponding syntax trees. During testing, we check
  81 `.rs` against `.txt`. If the `.txt` file is missing, it is created (this is how you update
  82 tests). Additionally, running `cargo gen-tests` will walk the grammar module and collect
  83 all `//test test_name` comments into files inside `tests/data` directory.
  84
  85 See [#93](https://github.com/rust-analyzer/rust-analyzer/pull/93) for an example PR which
  86 fixes a bug in the grammar.
  87
  88 ### `crates/ra_db`
  89
  90 We use the [salsa](https://github.com/salsa-rs/salsa) crate for incremental and
  91 on-demand computation. Roughly, you can think of salsa as a key-value store, but
  92 it also can compute derived values using specified functions. The `ra_db` crate
  93 provides a basic infrastructure for interacting with salsa. Crucially, it
  94 defines most of the "input" queries: facts supplied by the client of the
  95 analyzer. Reading the docs of the `ra_db::input` module should be useful:
  96 everything else is strictly derived from those inputs.
  97
  98 ### `crates/ra_hir`
  99
 100 HIR provides high-level "object oriented" access to Rust code.
 101
 102 The principal difference between HIR and syntax trees is that HIR is bound to a
 103 particular crate instance. That is, it has cfg flags and features applied (in
 104 theory, in practice this is to be implemented). So, the relation between
 105 syntax and HIR is many-to-one. The `source_binder` modules is responsible for
 106 guessing a HIR for a particular source position.
 107
 108 Underneath, HIR works on top of salsa, using a `HirDatabase` trait.
 109
 110 ### `crates/ra_ide_api`
 111
 112 A stateful library for analyzing many Rust files as they change. `AnalysisHost`
 113 is a mutable entity (clojure's atom) which holds the current state, incorporates
 114 changes and handles out `Analysis` --- an immutable and consistent snapshot of
 115 world state at a point in time, which actually powers analysis.
 116
 117 One interesting aspect of analysis is its support for cancellation. When a
 118 change is applied to `AnalysisHost`, first all currently active snapshots are
 119 cancelled. Only after all snapshots are dropped the change actually affects the
 120 database.
 121
 122 APIs in this crate are IDE centric: they take text offsets as input and produce
 123 offsets and strings as output. This works on top of rich code model powered by
 124 `hir`.
 125
 126 ### `crates/ra_ide_api_light`
 127
 128 All IDE features which can be implemented if you only have access to a single
 129 file. `ra_ide_api_light` could be used to enhance editing of Rust code without
 130 the need to fiddle with build-systems, file synchronization and such.
 131
 132 In a sense, `ra_ide_api_light` is just a bunch of pure functions which take a
 133 syntax tree as input.
 134
 135 The tests for `ra_ide_api_light` are `#[cfg(test)] mod tests` unit-tests spread
 136 throughout its modules.
 137
 138
 139 ### `crates/ra_lsp_server`
 140
 141 An LSP implementation which wraps `ra_ide_api` into a langauge server protocol.
 142
 143 ### `crates/ra_vfs`
 144
 145 Although `hir` and `ra_ide_api` don't do any io, we need to be able to read
 146 files from disk at the end of the day. This is what `ra_vfs` does. It also
 147 manages overlays: "dirty" files in the editor, whose "true" contents is
 148 different from data on disk.
 149
 150 ### `crates/gen_lsp_server`
 151
 152 A language server scaffold, exposing a synchronous crossbeam-channel based API.
 153 This crate handles protocol handshaking and parsing messages, while you
 154 control the message dispatch loop yourself.
 155
 156 Run with `RUST_LOG=sync_lsp_server=debug` to see all the messages.
 157
 158 ### `crates/ra_cli`
 159
 160 A CLI interface to rust-analyzer.
 161
 162 ### `crate/tools`
 163
 164 Custom Cargo tasks used to develop rust-analyzer:
 165
 166 - `cargo gen-syntax` -- generate `ast` and `syntax_kinds`
 167 - `cargo gen-tests` -- collect inline tests from grammar
 168 - `cargo install-code` -- build and install VS Code extension and server
 169
 170 ### `editors/code`
 171
 172 VS Code plugin
 173
 174
 175 ## Common workflows
 176
 177 To try out VS Code extensions, run `cargo install-code`.  This installs both the
 178 `ra_lsp_server` binary and VS Code extension. To install only the binary, use
 179 `cargo install --path crates/ra_lsp_server --force`
 180
 181 To see logs from the language server, set `RUST_LOG=info` env variable. To see
 182 all communication between the server and the client, use
 183 `RUST_LOG=gen_lsp_server=debug` (will print quite a bit of stuff).
 184
 185 To run tests, just `cargo test`.
 186
 187 To work on VS Code extension, launch code inside `editors/code` and use `F5` to
 188 launch/debug. To automatically apply formatter and linter suggestions, use `npm
 189 run fix`.
 190