Delete accidental file; fix up documentation

Author: pschachte

DIFF

@@ -86,7 +86,8 @@ doc:	src/README.md
 
 
 # Assemble README markdown source file automatically
-src/README.md: src/*.hs Makefile src/README.md.intro src/README.md.outro
+src/README.md: src/*.hs Makefile src/README.md.intro src/README.md.outro \
+		src/Compiler.png src/Detail.png
 	cat src/README.md.intro > "$@"
 
 	printf "The source files in this directory and their purposes are:\n\n" >> "$@"

Makefile

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE ipe SYSTEM "ipe.dtd">
-<ipe version="70218" creator="Ipe 7.2.20">
-<info created="D:20210204114132" modified="D:20210204143205"/>
+<ipe version="70218" creator="Ipe 7.2.24">
+<info created="D:20210204114132" modified="D:20241018183341"/>
 <ipestyle name="basic">
 <symbol name="arrow/arc(spx)">
 <path stroke="sym-stroke" fill="sym-stroke" pen="sym-pen">
@@ -238,74 +238,74 @@ h
 h
 </path>
 </symbol>
-<pen name="heavier" value="0.8"/>
-<pen name="fat" value="1.2"/>
-<pen name="ultrafat" value="2"/>
-<symbolsize name="large" value="5"/>
-<symbolsize name="small" value="2"/>
-<symbolsize name="tiny" value="1.1"/>
+<anglesize name="22.5 deg" value="22.5"/>
+<anglesize name="30 deg" value="30"/>
+<anglesize name="45 deg" value="45"/>
+<anglesize name="60 deg" value="60"/>
+<anglesize name="90 deg" value="90"/>
 <arrowsize name="large" value="10"/>
 <arrowsize name="small" value="5"/>
 <arrowsize name="tiny" value="3"/>
-<color name="red" value="1 0 0"/>
 <color name="blue" value="0 0 1"/>
-<color name="green" value="0 1 0"/>
-<color name="yellow" value="1 1 0"/>
-<color name="orange" value="1 0.647 0"/>
-<color name="gold" value="1 0.843 0"/>
-<color name="purple" value="0.627 0.125 0.941"/>
-<color name="gray" value="0.745"/>
 <color name="brown" value="0.647 0.165 0.165"/>
-<color name="navy" value="0 0 0.502"/>
-<color name="pink" value="1 0.753 0.796"/>
-<color name="seagreen" value="0.18 0.545 0.341"/>
-<color name="turquoise" value="0.251 0.878 0.816"/>
-<color name="violet" value="0.933 0.51 0.933"/>
 <color name="darkblue" value="0 0 0.545"/>
 <color name="darkcyan" value="0 0.545 0.545"/>
 <color name="darkgray" value="0.663"/>
 <color name="darkgreen" value="0 0.392 0"/>
 <color name="darkmagenta" value="0.545 0 0.545"/>
 <color name="darkorange" value="1 0.549 0"/>
 <color name="darkred" value="0.545 0 0"/>
+<color name="gold" value="1 0.843 0"/>
+<color name="gray" value="0.745"/>
+<color name="green" value="0 1 0"/>
 <color name="lightblue" value="0.678 0.847 0.902"/>
 <color name="lightcyan" value="0.878 1 1"/>
 <color name="lightgray" value="0.827"/>
 <color name="lightgreen" value="0.565 0.933 0.565"/>
 <color name="lightyellow" value="1 1 0.878"/>
-<dashstyle name="dotted" value="[1 3] 0"/>
-<dashstyle name="dashed" value="[4] 0"/>
-<dashstyle name="dash dotted" value="[4 2 1 2] 0"/>
+<color name="navy" value="0 0 0.502"/>
+<color name="orange" value="1 0.647 0"/>
+<color name="pink" value="1 0.753 0.796"/>
+<color name="purple" value="0.627 0.125 0.941"/>
+<color name="red" value="1 0 0"/>
+<color name="seagreen" value="0.18 0.545 0.341"/>
+<color name="turquoise" value="0.251 0.878 0.816"/>
+<color name="violet" value="0.933 0.51 0.933"/>
+<color name="yellow" value="1 1 0"/>
 <dashstyle name="dash dot dotted" value="[4 2 1 2 1 2] 0"/>
-<textsize name="large" value="\large"/>
-<textsize name="Large" value="\Large"/>
-<textsize name="LARGE" value="\LARGE"/>
-<textsize name="huge" value="\huge"/>
-<textsize name="Huge" value="\Huge"/>
-<textsize name="small" value="\small"/>
-<textsize name="footnote" value="\footnotesize"/>
-<textsize name="tiny" value="\tiny"/>
-<textstyle name="center" begin="\begin{center}" end="\end{center}"/>
-<textstyle name="itemize" begin="\begin{itemize}" end="\end{itemize}"/>
-<textstyle name="item" begin="\begin{itemize}\item{}" end="\end{itemize}"/>
-<gridsize name="4 pts" value="4"/>
-<gridsize name="8 pts (~3 mm)" value="8"/>
-<gridsize name="16 pts (~6 mm)" value="16"/>
-<gridsize name="32 pts (~12 mm)" value="32"/>
+<dashstyle name="dash dotted" value="[4 2 1 2] 0"/>
+<dashstyle name="dashed" value="[4] 0"/>
+<dashstyle name="dotted" value="[1 3] 0"/>
 <gridsize name="10 pts (~3.5 mm)" value="10"/>
-<gridsize name="20 pts (~7 mm)" value="20"/>
 <gridsize name="14 pts (~5 mm)" value="14"/>
+<gridsize name="16 pts (~6 mm)" value="16"/>
+<gridsize name="20 pts (~7 mm)" value="20"/>
 <gridsize name="28 pts (~10 mm)" value="28"/>
+<gridsize name="32 pts (~12 mm)" value="32"/>
+<gridsize name="4 pts" value="4"/>
 <gridsize name="56 pts (~20 mm)" value="56"/>
-<anglesize name="90 deg" value="90"/>
-<anglesize name="60 deg" value="60"/>
-<anglesize name="45 deg" value="45"/>
-<anglesize name="30 deg" value="30"/>
-<anglesize name="22.5 deg" value="22.5"/>
+<gridsize name="8 pts (~3 mm)" value="8"/>
 <opacity name="10%" value="0.1"/>
 <opacity name="30%" value="0.3"/>
 <opacity name="50%" value="0.5"/>
 <opacity name="75%" value="0.75"/>
+<pen name="fat" value="1.2"/>
+<pen name="heavier" value="0.8"/>
+<pen name="ultrafat" value="2"/>
+<symbolsize name="large" value="5"/>
+<symbolsize name="small" value="2"/>
+<symbolsize name="tiny" value="1.1"/>
+<textsize name="Huge" value="\Huge"/>
+<textsize name="LARGE" value="\LARGE"/>
+<textsize name="Large" value="\Large"/>
+<textsize name="footnote" value="\footnotesize"/>
+<textsize name="huge" value="\huge"/>
+<textsize name="large" value="\large"/>
+<textsize name="small" value="\small"/>
+<textsize name="tiny" value="\tiny"/>
+<textstyle name="center" begin="\begin{center}" end="\end{center}"/>
+<textstyle name="item" begin="\begin{itemize}\item{}" end="\end{itemize}"/>
+<textstyle name="itemize" begin="\begin{itemize}" end="\end{itemize}"/>
 <tiling name="falling" angle="-60" step="4" width="1"/>
 <tiling name="rising" angle="30" step="4" width="1"/>
 </ipestyle>
@@ -384,17 +384,8 @@ h
 320 672 m
 352 672 l
 </path>
-<path matrix="1 0 0 1 96 0" stroke="black" pen="fat">
-352 720 m
-352 624 l
-416 624 l
-416 720 l
-h
-</path>
 <text transformations="translations" pos="480 704" stroke="black" type="label" width="19.649" height="6.918" depth="0" halign="center" valign="center">code</text>
 <text transformations="translations" pos="480 688" stroke="black" type="label" width="45.413" height="6.661" depth="1.93" halign="center" valign="center">generation</text>
-<text transformations="translations" pos="480 672" stroke="black" type="label" width="40.653" height="6.918" depth="0" halign="center" valign="center">Blocks.hs</text>
-<text transformations="translations" pos="480 656" stroke="black" type="label" width="49.592" height="6.926" depth="1.93" halign="center" valign="center">Codegen.hs</text>
 <text transformations="translations" pos="480 640" stroke="black" type="label" width="68.439" height="6.23" depth="1.74" halign="center" valign="center" size="small">BinaryFactory.hs</text>
 <path matrix="1 0 0 1 0 160" stroke="black" pen="fat">
 64 608 m
@@ -416,5 +407,20 @@ h
 <text transformations="translations" pos="432 688" stroke="black" type="label" width="29.611" height="6.808" depth="0" halign="center" valign="center">LPVM</text>
 <text transformations="translations" pos="384 672" stroke="black" type="label" width="53.688" height="6.926" depth="1.93" halign="center" valign="center">Compilation</text>
 <text transformations="translations" pos="384 640" stroke="black" type="label" width="57.064" height="6.815" depth="1.93" halign="center" valign="center">Optimisation</text>
+<text transformations="translations" pos="464 672" stroke="black" type="label" width="40.183" height="6.918" depth="0" valign="baseline">LLVM.hs</text>
+<path stroke="white">
+448 720 m
+448 624 l
+512 624 l
+512 720 l
+h
+</path>
+<path stroke="black" pen="0.4">
+448 720 m
+448 624 l
+512 624 l
+512 720 l
+h
+</path>
 </page>
 </ipe>

src/Compiler.ipe

@@ -43,7 +43,7 @@ import Distribution.TestSuite (TestInstance(name))
 -- # Generating LLVM code
 -- 
 -- We generate a `.ll` text file directly for each Wybe `.wybe` file, compiling
--- this as necessary to build `.o`, `.bc` or executable files.  For each
+-- this as necessary to build `.o`, `.bc` `.s`, or executable files.  For each
 -- generated `.ll` file, we produce the following, in order:
 -- 
 --  * **Prologue** — contains an introductory comment and any configuration info

src/Compiler.png

@@ -25,13 +25,11 @@ The source files in this directory and their purposes are:
 | [AliasAnalysis.hs](#AliasAnalysis) | Alias analysis for a single module |
 | [Analysis.hs](#Analysis) | Entry point of all kinds of analysis for a single module |
 | [BinaryFactory.hs](#BinaryFactory) | Deriving AST Types to be Binary instances |
-| [Blocks.hs](#Blocks) | Transform a clausal form (LPVM) module to LLVM |
 | [BodyBuilder.hs](#BodyBuilder) | A monad to build up a procedure Body, with copy propagation |
 | [Builder.hs](#Builder) | Handles compilation at the module level. |
-| [CConfig.hs](#CConfig) |  |
+| [CConfig.hs](#CConfig) | Relate C types to Wybe types for foreign interface |
 | [Callers.hs](#Callers) | Find all callers for each proc and count static calls per caller |
 | [Clause.hs](#Clause) | Convert Wybe code to clausal (LPVM) form |
-| [Codegen.hs](#Codegen) | Generate and emit LLVM from basic blocks of a module |
 | [Config.hs](#Config) | Configuration for wybe compiler |
 | [Emit.hs](#Emit)     | Emit LLVM code |
 | [Expansion.hs](#Expansion) | Replace certain procedure calls with others |
@@ -69,8 +67,6 @@ The source files in this directory and their purposes are:
 
 ## BinaryFactory <a id=BinaryFactory></a>
 
-## Blocks <a id=Blocks></a>
-
 ## BodyBuilder <a id=BodyBuilder></a>
 
 ## Builder <a id=Builder></a>
@@ -258,8 +254,6 @@ order, we call compileModSCC, which does the following:
 
 ## Clause <a id=Clause></a>
 
-## Codegen <a id=Codegen></a>
-
 ## Config <a id=Config></a>
 
 ## Emit <a id=Emit></a>
@@ -297,27 +291,27 @@ transformed to f(x,y,?t); p(!t,z); f(!x,y,t).
 # Generating LLVM code
 
 We generate a `.ll` text file directly for each Wybe `.wybe` file, compiling
-this as necessary to build `.o`, `.bc` or executable files.  For each
+this as necessary to build `.o`, `.bc` `.s`, or executable files.  For each
 generated `.ll` file, we produce the following, in order:
 
 * **Prologue** — contains an introductory comment and any configuration info
-   needed for LLVM.
+  needed for LLVM.
 
 * **Constants** — LLVM definitions of the manifest constants used in this
-    module; mostly used for strings.
+  module; mostly used for strings.
 
 * **Global variables** —  LLVM declarations of the global variables used to
-   implement the resources defined in this module.
+  implement the resources defined in this module.
 
-* **Externs** — Extern declarations for all symbols used, but not defined, in
- this module; this includes imported Wybe procedures, C functions,  and
-   global variables.
+* **Externs** — Extern declarations for all symbols used, but not defined,
+  in this module; this includes imported Wybe procedures, C functions,  and
+  global variables.
 
 * **Definitions** — Definitions of the procs of this module.
 
 * **Exports** — Everything needed by the Wybe compiler to compile users of
- this module; currently this is represented as a serialisation of the Module
- data structure, placed in the LLVM section.
+  this module; currently this is represented as a serialisation of the
+  Module data structure, placed in the LLVM section.
 
 
 ## LastCallAnalysis <a id=LastCallAnalysis></a>

src/LLVM.hs

@@ -21,6 +21,7 @@ int main() {
     char c;
     void *p;
     printf("-- AUTOMATICALLY GENERATED BY c_config.c\n-- DO NOT EDIT!\n\n");
+    printf("-- Purpose : Relate C types to Wybe types for foreign interface\n\n");
     printf("module CConfig (cTypeRepresentation, cPointerSize) where\n");
     printf("\nimport AST (TypeRepresentation(..))\n\n");
     printf("cTypeRepresentation :: String -> Maybe TypeRepresentation\n");