https://github.com/Eliah-Lakhin/lady-deirdre

Compiler front-end foundation technology.
https://github.com/Eliah-Lakhin/lady-deirdre

compilers editors ide incremental parser

Last synced: 8 months ago
JSON representation

Compiler front-end foundation technology.

• Host: GitHub
• URL: https://github.com/Eliah-Lakhin/lady-deirdre
• Owner: Eliah-Lakhin
• Created: 2022-11-08T20:02:07.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-03-02T05:34:29.000Z (9 months ago)
• Last Synced: 2025-03-23T06:59:26.738Z (8 months ago)
• Topics: compilers, editors, ide, incremental, parser
• Language: Rust
• Homepage: http://lady-deirdre.lakhin.com/
• Size: 3.68 MB
• Stars: 448
• Watchers: 9
• Forks: 14
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-compilers - lady-deirdre - A framework for new programming languages and LSP servers. (Rust / Other dialects and variants)
• fucking-awesome-rust - Eliah-Lakhin/lady-deirdre - A framework for new programming languages and LSP servers. (Libraries / Parsing)
• awesome-rust - Eliah-Lakhin/lady-deirdre - A framework for new programming languages and LSP servers. (Libraries / Parsing)

README

          


# Lady Deirdre

[![Crate](https://img.shields.io/crates/v/lady-deirdre?label=Crate)](https://crates.io/crates/lady-deirdre)

[![API Docs](https://img.shields.io/docsrs/lady-deirdre?label=API%20Docs)](https://docs.rs/lady-deirdre)

[![User Guide](https://img.shields.io/badge/User_Guide-616161)](https://lady-deirdre.lakhin.com/)

[![Examples](https://img.shields.io/badge/Examples-616161)](https://github.com/Eliah-Lakhin/lady-deirdre/tree/master/work/crates/examples)



Lady Deirdre is a framework for incremental programming language compilers,

interpreters, and source code analyzers.

This framework helps you develop a hybrid program that acts as a language

compiler or interpreter and as a language server for a code editor's language

extension. It offers the necessary components to create an in-memory

representation of language files, including the source code, their lexis and

syntax, and the semantic model of the entire codebase. These components are

specifically designed to keep the in-memory representation in sync with file

changes as the codebase continuously evolves in real time.

Lady Deirdre is the perfect tool if you want to start a new programming language

project.

## Key Features

- **Parser Generator Using Macros**.

  Lexical and syntax grammar of the language are specified using derive macros

  on enum types, where the enum variants represent individual tokens and nodes

  with parsing rules.

- **Hand-Written Parsers**.

  The API enables the development of hand-written recursive-descent parsers with

  unlimited lookahead and their seamless integration with macro-generated parsers.

- **Error Resilience**.

  The resulting parser will be error-resistant and capable of building a syntax

  tree from incomplete source code.

- **Semantics Analysis Framework**.

  Lady Deirdre includes a built-in semantic analyzer that manages arbitrary

  on-demand computations on the syntax trees in terms of referential attributes.

- **Incremental Compilation**.

  These components continuously patch the in-memory representation of the

  codebase structures in response to the end user's incremental edits of the

  file texts. Processing of the changes is typically fast, even in large

  codebases.

- **Parallel Computations**.

  The API is specifically designed for both multi-threaded and single-threaded

  programs, according to your discretion.

- **Web-Assembly Compatibility**.

  This crate is compatible with wasm-targets and the browser environment in

  particular.

- **Source Code Formatters**.

  Lady Deirdre includes tools to develop code formatter programs that take into

  account code comments and blank lines.

- **Annotated Snippets**.

  The framework provides a configurable API to print source code snippets with

  syntax highlighting and annotations to the terminal, intended to display

  syntax and semantic errors in the codebase.

- **Self-Sufficient API**.

  The crate offers a self-sufficient, extendable, and highly configurable API

  for developing the front-end part of programming language compilers and code

  editor language extensions. As a foundation technology, Lady Deirdre does not

  have any third-party dependencies except for the Rust standard library and

  the macros crate.

## Performance

Lady Deirdre aims to provide development infrastructure with acceptable

computational performance suitable for production use.

The crate's API demonstrates solid benchmark test results, comparing individual

features of the framework with specialized solutions from the Rust ecosystem.

For detailed information, refer to the [Benchmarks page](https://github.com/Eliah-Lakhin/lady-deirdre/tree/master/work/crates/tests).

## Links

- [Source Code](https://github.com/Eliah-Lakhin/lady-deirdre)

- [Main Crate](https://crates.io/crates/lady-deirdre)

- [API Documentation](https://docs.rs/lady-deirdre)

- [User Guide](https://lady-deirdre.lakhin.com/)

- [Examples](https://github.com/Eliah-Lakhin/lady-deirdre/tree/master/work/crates/examples)

- [License Agreement](https://github.com/Eliah-Lakhin/lady-deirdre/blob/master/EULA.md)

## Copyright

This work is proprietary software with source-available code.

To copy, use, distribute, or contribute to this work, you must agree to the

terms and conditions of the [General License Agreement](https://github.com/Eliah-Lakhin/lady-deirdre/blob/master/EULA.md).

For an explanation of the licensing terms, see the

[F.A.Q.](https://github.com/Eliah-Lakhin/lady-deirdre/tree/master/FAQ.md)

Copyright (c) 2024 Ilya Lakhin (Илья Александрович Лахин). All rights reserved.