Skip to content

A small, purely functional programming language. For learning.

Notifications You must be signed in to change notification settings

mitchellvitez/doldrums

Repository files navigation

Doldrums

“You can swim all day in the Sea of Knowledge and not get wet.”

– Norton Juster, The Phantom Tollbooth

About

Doldrums is a small, purely functional programming language with an emphasis on ease of top-to-bottom understanding. I've been meaning to play with a language like this ever since making Pixll. This is a great way for me to learn. It's probably not very useful for anything in practice.

The compiler is written in Haskell. Run stack run test.dol to see an example.

Structure

Compilation is split into several stages, and the code is split as well. The AST definition of the language lives in the Language module. Parsing happens in Parse, that syntax tree is fixed by FixAst and typechecking happens in Typecheck. The Interpret module actually evaluates the program.

The runBase function in Lib performs each stage of the compilation pipeline. In order, it parses a small prelude (written in Doldrums), reads an input file, parses, typechecks, evaluates, and shows the program's result.

The Doldrums language

Doldrums is purely functional, which means that all values are immutable. It's also non-strict, tiny, and pretty useless in the real world.

Comments

-- Line comments look like this
/* Block comments
   look like this */

Writing a program

A program is a list of functions. A function has a name, a list of arguments, and a body.

id x = x
const x y = x

You can define constants using a "function" with no arguments.

seven = 7

Every program has a main function. This is what runs when the program starts.

main = const 6 7

The $ operator

Because it has the lowest precedence, you can use $ to replace parentheses in certain situations, for cleaner code. For example,

main = f (g (h x))

is equivalent to

main = f $ g $ h x

Let expressions

You can define variables to be used in an expression with let...in

let
  n = 0
in n

Multiple definitions are allowed (via syntactic sugar that parses into nested let expressions)

let
  a = 1
  b = 2
  c = 3
in
  a * b * c

Parsing

The parser uses Megaparsec and makeExprParser from parser-combinators.

Here's a simplified call graph of the parsing code, showing its structure:

SVG showing parsing graph

Typechecking

The list of Doldrums types is short: Bool, Int, Double, String, Tagged (for user-defined types), TypeVariable, and :-> (the function type).

Doldrums uses Hindley-Milner style type inference to ensure that certain kinds of invalid programs aren't allowed. For example, this program will fail to typecheck:

func x = x + 7
main = func "hello"

So will this one, since you can't apply literals:

main = 1 2 3

Operator Fixities

Higher numbers mean higher precedence.

Precedence Associativity Operator
7 left function application
6 unary ~
6 unary !
5 left *
5 left *.
5 left /
5 left /.
4 left +
4 left +.
4 left -
4 left -.
3 none ==
3 none !=
3 none >
3 none >=
3 none <
3 none <=
2 right &&
1 right ||
0 right $

How can I do this?

I'd recommend using Megaparsec or another parsing library to make that part easier to write. I learned a lot of this from Implementing Functional Languages: a tutorial. The talk Statically Typed Interpreters was helpful when figuring out how to add the initial typechecking. Some issues were debugged more quickly thanks to help from friends. Algorithm W Step by Step helped me upgrade the typechecking to Hindley-Milner style inference.

About

A small, purely functional programming language. For learning.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published