Small doc fixes. Move IrLabel and BlockVarPair into ir_builder.d

Author: MrSmith33

example/libvox.d

@@ -1,6 +1,8 @@
 /// Copyright: Copyright (c) 2022 Andrey Penechko.
 /// License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
 /// Authors: Andrey Penechko.
+
+/// C API bindings
 module libvox;
 
 // SliceString that are passed to Vox compiler must remain valid until vox_free

readme.md

@@ -3,7 +3,7 @@
 [![CI](https://github.com/MrSmith33/vox/workflows/CI/badge.svg?branch=master&event=push)](https://github.com/MrSmith33/tiny_jit/releases/tag/CI)
 
 * [Latest CI build](https://github.com/MrSmith33/tiny_jit/releases/tag/CI)
-* [Channel on /r/ProgrammingLanguages discord](https://discord.gg/HpYYhH4) - Projects P-Y -> Vox
+* [Channel on /r/ProgrammingLanguages discord](https://discord.gg/HpYYhH4) - Projects Q-Y -> Vox
 
 # Vox programming language
 
@@ -217,8 +217,9 @@ All `.vx` files will be highlighted and classified as D.
 
 ## Stats
 
-- Impl size: 36k LoC of D, 3MB exe
+- Impl size: 40k LoC of D, 3MB exe
 - Time to compile: 4s debug / 45s release
-- Test suite: 75ms for 302 tests
+- Test suite: 95ms for 361 tests
+- Time to compile 10MLoC of fibonacci: 8s on Windows, 7.5s on Linux
 
 For more in detail description of implementation see [internals.md](internals.md)

source/c_api.d

@@ -45,8 +45,8 @@ void vox_begin_compilation(VoxCompiler* compiler) {
 	compiler.driver.beginCompilation();
 }
 
-Identifier vox_id_get_or_reg(VoxCompiler* compiler, SliceString hostModuleName) {
-	return compiler.driver.context.idMap.getOrRegFqn(&compiler.driver.context, cast(string)hostModuleName);
+Identifier vox_id_get_or_reg(VoxCompiler* compiler, SliceString str) {
+	return compiler.driver.context.idMap.getOrRegFqn(&compiler.driver.context, cast(string)str);
 }
 
 // String is owned by the library

source/vox/ir/ir_builder.d

@@ -57,6 +57,34 @@ struct ExtraInstrArgs
 	IrIndex type;
 }
 
+struct IrLabel
+{
+	/// If isAllocated
+	///   blockIndex points to new block
+	/// else
+	///   If numPredecessors == 0, blockIndex points to currentBlock at
+	//      scope start
+	///   If numPredecessors == 1, blockIndex points to first predecessor
+	/// If numPredecessors > 1, blockIndex points to a new block and isAllocated must be true
+	IrIndex blockIndex;
+	///
+	bool isAllocated;
+	///
+	uint numPredecessors;
+}
+
+struct BlockVarPair
+{
+	IrIndex blockId;
+	IrIndex var;
+
+	void toString()(scope void delegate(const(char)[]) sink) const {
+		import std.format : formattedWrite;
+		sink.formattedWrite("(%s %s)", blockId, var);
+	}
+}
+
+
 // papers:
 // 1. Simple and Efficient Construction of Static Single Assignment Form
 struct IrBuilder
@@ -808,9 +836,6 @@ struct IrBuilder
 		label.numPredecessors += newPredecessors;
 	}
 
-	private void incBlockRefcount(IrIndex basicBlock) { assert(false); }
-	private void decBlockRefcount(IrIndex basicBlock) { assert(false); }
-
 	/// Creates virtual register to represent result of phi/instruction
 	/// `definition` is phi/instruction that produces a value
 	IrIndex addVirtualRegister(IrIndex definition, IrIndex type)

source/vox/ir/package.d

@@ -29,33 +29,3 @@ public import vox.ir.ir_value_kind;
 public import vox.ir.ir_variable;
 public import vox.ir.ir_virt_reg;
 public import vox.ir.ir_vm;
-
-import vox.all;
-
-
-struct IrLabel
-{
-	/// If isAllocated
-	///   blockIndex points to new block
-	/// else
-	///   If numPredecessors == 0, blockIndex points to currentBlock at
-	//      scope start
-	///   If numPredecessors == 1, blockIndex points to first predecessor
-	/// If numPredecessors > 1, blockIndex points to a new block and isAllocated must be true
-	IrIndex blockIndex;
-	///
-	bool isAllocated;
-	///
-	uint numPredecessors;
-}
-
-struct BlockVarPair
-{
-	IrIndex blockId;
-	IrIndex var;
-
-	void toString()(scope void delegate(const(char)[]) sink) const {
-		import std.format : formattedWrite;
-		sink.formattedWrite("(%s %s)", blockId, var);
-	}
-}

todo.txt

@@ -195,6 +195,11 @@
 	- ref parameters
 	- ref in foreach
 	- this is ref in methods (it is ptr atm)
++ enum
+	- enum with bigger than i32 values doesn't compile
+	- autoincrementing enum member values
+	- enum type
+	- Decide if enums should implicitly convert to bool. There are cases where you don't want that
 
 - context format/writefln
 + pipeline ordering (run all passes per function) will allow to release temporary memory (worse perf if no memory is released)
@@ -225,10 +230,6 @@ o dll linking
 		cons: simple passing allows all module externals to be searched for in passed .dll/.def
 		pros: --optname=modulename:.dll/.def allows for benefit of above options
 	- custom .def-like format (binary, combine all libs description in a single file)
-+ enum
-	- enum with bigger than i32 values doesn't compile
-	- autoincrementing enum member values
-	- enum type
 - constant folding << >> >>> shifts needs to know type of left operand to mask the shift size
 - Check that constants on either side of every instruction is correctly lowered to mov/load when needed