Tree @master (Download .tar.gz)
Tamsin
Tamsin is an oddball little language that can't decide if it's a meta-language, a programming language, or a rubbish lister.
Its primary goal is to allow the rapid development of parsers, static analyzers, interpreters, and compilers, and to allow them to be expressed compactly. Golf your grammar! (Or write it like a decent human being, if you must.)
The current released version of Tamsin is 0.5-2026.0806. As indicated by the 0.x version number, it is a work in progress, with the usual caveat that things may change rapidly (and that version 0.6 might look completely different.) See HISTORY for a list of major changes.
Code Examples
Make a story more exciting in 1 line of code:
main = ("." & '!' | "?" & '?!' | any)/''.
Parse an algebraic expression for syntactic correctness in 4 lines of code:
main = (expr0 & eof & 'ok').
expr0 = expr1 & {"+" & expr1}.
expr1 = term & {"*" & term}.
term = "x" | "y" | "z" | "(" & expr0 & ")".
Translate an algebraic expression to RPN (Reverse Polish Notation) in 7 lines of code:
main = expr0 → E & walk(E).
expr0 = expr1 → E1 & {"+" & expr1 → E2 & E1 ← add(E1,E2)} & E1.
expr1 = term → E1 & {"*" & term → E2 & E1 ← mul(E1,E2)} & E1.
term = "x" | "y" | "z" | "(" & expr0 → E & ")" & E.
walk(add(L,R)) = walk(L) → LS & walk(R) → RS & return LS+RS+' +'.
walk(mul(L,R)) = walk(L) → LS & walk(R) → RS & return LS+RS+' *'.
walk(X) = return ' '+X.
Parse a CSV file (handling quoted commas and quotes correctly) and write out the 2nd-last field of each record — in 11 lines of code:
main = line → L & L ← lines(nil, L) &
{"\n" & line → M & L ← lines(L, M)} & extract(L) & ''.
line = field → F & {"," & field → G & F ← fields(G, F)} & F.
field = strings | bare.
strings = string → T & {string → S & T ← T + '"' + S} & T.
string = "\"" & (!"\"" & any)/'' → T & "\"" & T.
bare = (!(","|"\n") & any)/''.
extract(lines(Ls, L)) = extract(Ls) & extract_field(L).
extract(L) = L.
extract_field(fields(L, fields(T, X))) = print T.
extract_field(X) = X.
Evaluate an (admittedly trivial) S-expression based language in 15 lines of code:
main = sexp → S using scanner & reverse(S, nil) → SR & eval(SR).
scanner = ({" "} & ("(" | ")" | $:alnum/'')) using $:utf8.
sexp = $:alnum | list.
list = "(" & sexp/nil/pair → L & ")" & L.
head(pair(A, B)) = A.
tail(pair(A, B)) = B.
cons(A, B) = return pair(A, B).
eval(pair(head, pair(X, nil))) = eval(X) → R & head(R).
eval(pair(tail, pair(X, nil))) = eval(X) → R & tail(R).
eval(pair(cons, pair(A, pair(B, nil)))) =
eval(A) → AE & eval(B) → BE & return pair(AE, BE).
eval(X) = X.
reverse(pair(H, T), A) = reverse(H, nil) → HR & reverse(T, pair(HR, A)).
reverse(nil, A) = A.
reverse(X, A) = X.
Interpret a small subset of Tamsin in 30 lines of code (not counting the included batteries.)
Compile Tamsin to C in 563 lines of code (again, not counting the included batteries.)
For more information
If the above has piqued your curiosity, you may want to read the specification, which contains many more small examples written to demonstrate (and test) the syntax and behavior of Tamsin:
Note that this is the current development version of the specification, and it may differ from the examples in this document.
Quick Start
The Tamsin reference repository is hosted on Codeberg.
This repository contains the reference implementation of Tamsin, called
tamsin, written in Python 3.x (tested with 3.8.10). It can both interpret
a Tamsin program and compile a program written in Tamsin to C.
The distribution also contains a Tamsin-to-C compiler written in Tamsin. It passes all the tests, and can compile itself.
While the interpreter is fine for prototyping, note that some informal benchmarking revealed the compiled C programs to be about 30x faster. Note however that while the compiler passes all the tests, it is still largely unproven (e.g. its UTF-8 support is not RFC 3629-compliant), so it should be considered a proof of concept.
To start using tamsin,
- Clone the repository —
git clone https://codeberg.org/catseye/Tamsin - Either:
- Put the repo's
bindirectory on your$PATH, or - Make a symbolic link to
bin/tamsinsomewhere already on your$PATH.
- Put the repo's
- Errr... that's it.
Then you can run tamsin like so:
tamsin eg/csv_parse.tamsin < eg/names.csv
To use the compiler, you'll need GNU make and gcc installed. Type
make
to build the runtime library. You can then compile to C and compile the C to an executable and run the executable all in one step, like so:
tamsin loadngo eg/csv_extract.tamsin < eg/names.csv
Design Goals
- Allow parsers, static analyzers, interpreters, and compilers to be quickly prototyped. (And in the future, processor simulators and VM's and such things too.)
- Allow writing these things very compactly.
- Allow writing anything using only recursive-descent parsing techniques (insofar as this is possible.)
- Allow writing parsers that look very similar to the grammar of the language being parsed, so that the structure of the language can be clearly seen.
- Provide means to solve practical problems.
- Keep the language simple — the grammar should fit on a page, ideally.
- Recognize that the preceding two goals are in tension.
- Have a relatively simple reference implementation (currently less than 5 KLoC, including everything — debugging support and the C runtime used by the compiler and the Tamsin modules and implementations.)
License
BSD-style license; see the file LICENSE.
Related work
Commit History
@master
git clone https://git.catseye.tc/Tamsin/
- Final (probably) tweaks before release of version 0.1. Cat's Eye Technologies 12 years ago
- Rework documentation in anticipation of a 0.1 release. Cat's Eye Technologies 12 years ago
- Tweak README. Cat's Eye Technologies 12 years ago
- Massage documentation. Add sexpr-eval as standalone example. Cat's Eye Technologies 12 years ago
- Have `tamsin` itself support `loadngo`. Cat's Eye Technologies 12 years ago
- Absolute links in README, for the benefit of Github pages. Cat's Eye Technologies 12 years ago
- Compiler passes the "advanced use of `using`" tests. Cat's Eye Technologies 12 years ago
- Tweak README. Cat's Eye Technologies 12 years ago
- Split up README. Cat's Eye Technologies 12 years ago
- Refactor to make Terms slightly more elegant. Cat's Eye Technologies 12 years ago
- EOF is now a kind of Term. interpret() always yields a term. Cat's Eye Technologies 12 years ago
- Sort out some EOF issues with scanner. Get rid of enc(). Cat's Eye Technologies 12 years ago
- Fix bugs in compiler, so tamsin-ast.tamsin compiles (at least). Cat's Eye Technologies 12 years ago
- Disable $.tamsin. Use scanners-in-Tamsin where needed. Cat's Eye Technologies 12 years ago
- Move Advanced Scanning to Tamsin doc. All tests pass (except...) Cat's Eye Technologies 12 years ago
- A little logic seems to fix it right up. Cat's Eye Technologies 12 years ago
- Well, that passes a surprising number of tests. However... Cat's Eye Technologies 12 years ago
- scan() in the compiled code returns a term now. Cat's Eye Technologies 12 years ago
- Teaching, teaching. Now comes the hard(er) part. Cat's Eye Technologies 12 years ago
- Gonna try teach old dog (compiler) new trick (using). Cat's Eye Technologies 12 years ago
- Implement startswith, unquote, mkterm in the compiler. Cat's Eye Technologies 12 years ago
- Tests for unquote, mkterm, startswith. Cat's Eye Technologies 12 years ago
- tamsin-ast.tamsin can now ASTify itself! All tests pass! Woo! Cat's Eye Technologies 12 years ago
- Parse th CSV extract program into an AST, in Tamsin... Cat's Eye Technologies 12 years ago
- AST parser passes a few more tests. Cat's Eye Technologies 12 years ago
- Another bodge, to pass another test! Cat's Eye Technologies 12 years ago
- A little further on the Tamsin-syntax-tree-parser-in-Tamsin. Cat's Eye Technologies 12 years ago
- Partial parser to AST written in Tamsin. Passes one test... Cat's Eye Technologies 12 years ago
- Make AST stringification look even more like Tamsin terms. Cat's Eye Technologies 12 years ago
- Give AST nodes __unicode__ methods. Cat's Eye Technologies 12 years ago