summaryrefslogtreecommitdiff
path: root/Compiler in a Day.page
diff options
context:
space:
mode:
authornathan <>2023-11-01 15:11:18 -0500
committernathan <>2023-11-01 15:11:18 -0500
commitadd21fde6df48428fb0a33a852beb33fe619c784 (patch)
treeb9eb0bfdf8aaee47a4d9ff129756dd3d51e2b42b /Compiler in a Day.page
parentc33dc81d26eb5b77faf0108502ec7588a13ebad6 (diff)
Start of a CIAD single page article.
Diffstat (limited to 'Compiler in a Day.page')
-rw-r--r--Compiler in a Day.page24
1 files changed, 24 insertions, 0 deletions
diff --git a/Compiler in a Day.page b/Compiler in a Day.page
new file mode 100644
index 0000000..2a5c60b
--- /dev/null
+++ b/Compiler in a Day.page
@@ -0,0 +1,24 @@
+# Overview
+
+This is intended to be a walkthrough of a complete compiler for a simple language that can be read and understood in a single day.
+In order to achieve this, we're going to be cutting a lot of corners, mostly around code generation.
+The assembly we'll be producing will run correctly, but it will be very inefficient.
+
+Our compiler will accept a file written in our programming language and output x86_64 assembly, which can be assembled and linked by [GNU Binutils](https://www.gnu.org/software/binutils/), intended to be run on Linux.
+It should also run on the [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/) or on FreeBSD with its [Linux ABI support](https://man.freebsd.org/cgi/man.cgi?query=linux&sektion=4&format=html).
+We'll also have a small runtime, written in C, and using [the Boehm-Demers-Weiser garbage collector](https://en.wikipedia.org/wiki/Boehm_garbage_collector).
+
+The source code we'll show for the compiler is in Ruby, but nothing Ruby-specific will be used.
+In fact, a previous version of this compiler was written in C11.
+
+Our compiler will have four parts.
+They are, in the order they get run:
+
+- [Lexing](https://en.wikipedia.org/wiki/Lexical_analysis): the process of breaking up the strings of source code into lexical units known as "tokens." This simplifies parsing.
+- [Parsing](https://en.wikipedia.org/wiki/Parsing): the process of building a tree representing the program from the tokens.
+- Frame layout: the process of assigning slots in each function's [stack frame](https://en.wikipedia.org/wiki/Call_stack#Structure) to its local variables.
+- Code generation: the process of generating actual assembly code from the program.
+
+TODO: pictures!
+
+Before we can start looking at these steps, however, we should look at the language we'll be compiling. \ No newline at end of file