https://github.com/xymostech/xymostex

A re-implementation of TeX in Rust to help me understand how it works and to eventually provide a debugging interface
https://github.com/xymostech/xymostex

parsing rust tex

Last synced: 7 days ago
JSON representation

A re-implementation of TeX in Rust to help me understand how it works and to eventually provide a debugging interface

• Host: GitHub
• URL: https://github.com/xymostech/xymostex
• Owner: xymostech
• License: mit
• Created: 2019-01-24T05:30:09.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-12T02:55:21.000Z (4 months ago)
• Last Synced: 2025-01-07T08:09:56.683Z (14 days ago)
• Topics: parsing, rust, tex
• Language: Rust
• Homepage:
• Size: 582 KB
• Stars: 104
• Watchers: 15
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# XymosTeX [![Build Status](https://travis-ci.com/xymostech/XymosTeX.svg?branch=master)](https://travis-ci.com/xymostech/XymosTeX) [![Coverage Status](https://coveralls.io/repos/github/xymostech/XymosTeX/badge.svg?branch=master)](https://coveralls.io/github/xymostech/XymosTeX?branch=master)

This project is an attempt to build an implementation of TeX in Rust. The overall goals of this project are:

1. Be a complete TeX implementation (see [more info about the goals](goals.md) for a detailed discussion of what this means)

2. Personally, to learn more intrinsically how TeX works by reading the TeXbook and trying things instead of by just reading the TeX source

3. Allow for better debugging of TeX (especially w.r.t. macro expansion) to provide helpful information for other TeX-like projects like [KaTeX](https://github.com/KaTeX/KaTeX).

## Status

Currently, XymosTeX has reached the point where is it Turing complete (that is, it implements things like macro expansion, conditionals, assignments), can interpret basic horizontal and vertical boxes, can interpret basic math experssions, and can generate a DVI file with the result.

The next body of work will be performing paragraph breaking and page breaking.

## Trying it

Because XymosTeX is under development, the best way to try it is to clone the repo and build it from in there.

XymosTeX produces [DVI files](https://en.wikipedia.org/wiki/Device_independent_file_format) as output, so something like dvipdf from another TeX system is needed to actually view the result.

```

$ git clone https://github.com/xymostech/XymosTeX.git

$ cd XymosTeX

$ cargo run

\def\hello #1{Hello, #1!}

\hello{World}

\end

$ dvipdf texput.dvi

$ open texput.pdf

```

![Image of Hello World!](readme-images/hello-world.png)

One fun and impressive thing that XymosTeX can do is calculate primes for you:

```

$ cargo run --release < examples/primes.tex

$ dvipdf texput.dvi

$ open texput.pdf

```

![Image of the first 10 primes](readme-images/primes.png)

XymosTeX can also render some math expressions, with a little help defining the

symbols:

```

$ cargo run --release < examples/basicmath.tex

$ dvipdf texput.dvi

$ open texput.pdf

```

![Image of the pythagorean theorem, a squared plus b squared equals c squared, and Euler's Identity, e raised to the power of i times pi plus 1 equals 0](readme-images/math.png)

## Contributing

I'm not currently taking feature contributions to XymosTeX since the goal is really for me to learn how TeX works for myself. However, since I am a Rust newbie, I am welcome to feedback about my Rust style and any suggestions about how to improve the code or repo structure.

## License

XymosTeX is licensed under the [MIT License](LICENSE)