itsscb/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-10-01 11:31:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a section on entry points

Browse Source
This commit is contained in:
Aleksey Kladov 2021-02-07 10:49:45 +03:00
parent a423a5196c
commit cbebb70313
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/dev/architecture.md
View File

@ -39,6 +39,14 @@ The client can submit a small delta of input data (typically, a change to a sing
The underlying engine makes sure that model is computed lazily (on-demand) and can be quickly updated for small modifications.
## Entry Points
`crates/rust-analyzer/src/bin/main.rs` contains the main function which spawns LSP.
This is *the* entry point, but it front-loads a lot of complexity, so its fine to just skim through it.
`crates/rust-analyzer/src/handlers.rs` implements all LSP requests and is a great place to start if you are already familiar with LSP.
`Analysis` and `AnalysisHost` types define the main API.
## Code Map
@ -265,7 +273,7 @@ And the client (`proc_macro_api`) provides an interface to talk to that server s
And then token trees are passed from client, and the server will load the corresponding dynamic library (which built by `cargo`).
And due to the fact the api for getting result from proc macro are always unstable in `rustc`,
we maintain our own copy (and paste) of that part of code to allow us to build the whole thing in stable rust.
**Architecture Invariant:**
Bad proc macros may panic or segfault accidentally. So we run it in another process and recover it from fatal error.
And they may be non-deterministic which conflict how `salsa` works, so special attention is required.