Remove ncc, update docs to point to uvclang

Author: maximecb

.github/workflows/test.yml

@@ -33,21 +33,6 @@ jobs:
       working-directory: ./vm
       run: RUST_BACKTRACE=1 cargo test
 
-    - name: Test NCC
-      working-directory: ./ncc
-      run: |
-        pwd
-        ls -al
-        RUST_BACKTRACE=1 cargo test
-
-    - name: Test NCC command-line arguments
-      working-directory: ./ncc
-      run: |
-        cargo run examples/chess.c
-        cargo run -- -o output_file.asm examples/chess.c
-        cargo run -- -E examples/crc32.c > /dev/null
-        cargo run -- -DTEST tests/test_macro.c
-
     - name: Test uvclang
       working-directory: ./uvclang
       run: RUST_BACKTRACE=1 cargo test

README.md

@@ -106,43 +106,44 @@ To run an [asm file](vm/examples) with UVM:
 cargo run examples/fizzbuzz.asm
 ```
 
-There is also a toy C compiler in the `ncc` directory, along with many [example C programs](ncc/examples) that run on UVM:
+There is also a C compiler, [uvclang](uvclang/README.md), in the `uvclang` directory, along with many [example C programs](uvclang/examples) that run on UVM:
 ```sh
-cd ncc
+cd uvclang
 ./build_and_run.sh examples/snake.c
 ```
+uvclang uses clang as a front end, so it needs a working clang/LLVM installation. See the [uvclang README](uvclang/README.md) for details.
 
 ### Running the Test Suite
 
-Run `cargo test` from the `vm`, and `ncc` directories.
+Run `cargo test` from the `vm` and `uvclang` directories. uvclang also has shell-based end-to-end test harnesses; see the [uvclang README](uvclang/README.md).
 
 ## Codebase Organization
 
 The repository is organized into a 3 different subprojects, each of which is a Rust codebase which can be compiled with `cargo`:
 
 - `/vm` : The implementation of the UVM virtual machine itself
   - [`/vm/examples/*`](vm/examples): Example assembly programs that can be run by UVM
-- `/ncc`: An implementation of a toy C compiler that outputs UVM assembly
-  - [`/ncc/README.md`](ncc/README.md): documentation for the NCC compiler.
-  - [`/ncc/examples/*`](ncc/examples): Example C source files that can be compiled by NCC
+- `/uvclang`: A C/C++ compiler that outputs UVM assembly, using clang as a front end
+  - [`/uvclang/README.md`](uvclang/README.md): documentation for the uvclang compiler
+  - [`/uvclang/examples/*`](uvclang/examples): Example C source files that can be compiled by uvclang
 - `/spec`: A system to document and automatically export bindings for UVM system calls and constants.
   - `/spec/syscalls.json`: Declarative list of system calls exposed by UVM.
 - `/docs`: Markdown documentation for UVM
   - [`/docs/syscalls.md`](docs/syscalls.md): List of system calls and constants accessible to UVM programs
 
-The `ncc` compiler is, at the time of this writing, incomplete in that it lacks some C features and the error messages need improvement. This compiler
-was implemented to serve as an example of how to write a compiler that targets UVM, and to write some library code to be used by other programs. Over
-time, the `ncc` compiler will be improved. Despite its limitations, it is still usable to write small programs. Contributions to it are welcome.
+The `uvclang` compiler drives clang to lower C/C++ to LLVM IR and then compiles that IR to UVM assembly. Because clang handles parsing, it supports the
+full C/C++ language; the work in progress is in the LLVM IR to UVM back end, which does not yet cover every construct clang can emit. It is already usable
+to write real programs, and ships with a set of UVM bindings and standard-library headers. Contributions are welcome.
 
 The `spec` directory contains JSON files that represent a declarative list of system calls, constants and the permission system that UVM exposes
 to programs running on it. This is helpful for documentation purposes, or if you want to build a compiler that targets UVM. The directory also contains
-code that automatically generates [markdown documentation](docs/syscalls.md), Rust constants and [C definitions](ncc/include/uvm/syscalls.h) for system calls.
+code that automatically generates [markdown documentation](docs/syscalls.md), Rust constants and [C definitions](uvclang/include/uvm/syscalls.h) for system calls.
 
 ## Open Source License
 
-The code for UVM, NCC and associated tools is shared under the [Apache-2.0 license](https://github.com/maximecb/uvm/blob/main/LICENSE).
+The code for UVM, uvclang and associated tools is shared under the [Apache-2.0 license](https://github.com/maximecb/uvm/blob/main/LICENSE).
 
-The examples under the `vm/examples` and `ncc/examples` directories are shared under the [Creative Commons CC0](https://creativecommons.org/publicdomain/zero/1.0/) license.
+The examples under the `vm/examples` and `uvclang/examples` directories are shared under the [Creative Commons CC0](https://creativecommons.org/publicdomain/zero/1.0/) license.
 
 ## Contributing
 

docs/design.md

@@ -24,7 +24,7 @@ These files can be written by hand, or generated by a compiler.
 The syntax is inspired by yasm/nasm and designed to be easy to read, and you can find some simple
 examples under [vm/examples](/vm/examples). The assembler supports both Python-style single-line
 comments and C-style multiline comments for convenience.
-This repo also contains a toy C compiler (ncc) that emits
+This repo also contains a C compiler ([uvclang](/uvclang/README.md)) that emits
 UVM asm files as its output.
 
 There is a plan for UVM to eventually support a binary image format to store programs as well, but
@@ -85,9 +85,9 @@ calls you for the next event. UVM has different opcodes, `ret` and `exit`, such
 return to the external event loop without terminating execution, whereas `exit` means the program
 is completely done running and wants to stop.
 
-In the case of C programs compiled with `ncc`, the `main()` function can act as an initialization
+In the case of C programs compiled with `uvclang`, the `main()` function can act as an initialization
 function, register callbacks and return to the VM without exiting. To get a better idea of how this
-works, you can look at the [paint example](/ncc/examples/paint.c) program.
+works, you can look at the [paint example](/uvclang/examples/paint.c) program.
 
 ## Design Goals
 

docs/planning.md

@@ -13,14 +13,11 @@ because it's easier to refactor, which allows us to quickly make design changes.
 
 ## C Compiler Development
 
-This repository includes [ncc](/ncc/README.md), which is a toy C compiler that targets UVM.
-This compiler is currently incomplete, but still able to compile useful code.
-Eventually, we're probably going to want to have an LLVM backend targeting UVM,
-but it seems useful to have a small compiler that people can easily wrap their
-head around so that they can understand how they could build their own.
-The plan is to put some amount of development effort into ncc to smooth out
-the rough edges, improve error messages and get it to the point where it
-supports most C features.
+This repository includes [uvclang](/uvclang/README.md), a C/C++ compiler that
+targets UVM. It uses clang as a front end to lower C/C++ to LLVM IR, then
+compiles that IR down to UVM assembly. Because clang does the parsing, uvclang
+gets full C/C++ language coverage for free; the ongoing work is in the LLVM IR
+to UVM back end, which does not yet support every construct clang can emit.
 
 ## Binary Image Format