Add comments and pragmas

36 files changed, 68 insertions, 15 deletions

diff --git a/src/compile/assignments.c b/src/compile/assignments.c
index 0f4c8835..a31aee56 100644
--- a/src/compile/assignments.c
+++ b/src/compile/assignments.c
@@ -1,3 +1,4 @@
+// This file defines how to compile assignments
 #include "assignments.h"
 #include "../ast.h"
 #include "../compile.h"
diff --git a/src/compile/assignments.h b/src/compile/assignments.h
index a906db33..1a162623 100644
--- a/src/compile/assignments.h
+++ b/src/compile/assignments.h
@@ -1,3 +1,5 @@
+// This file defines how to compile assignments
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/binops.c b/src/compile/binops.c
index 14416407..ec30f0c8 100644
--- a/src/compile/binops.c
+++ b/src/compile/binops.c
@@ -1,3 +1,4 @@
+// This file defines how to compile binary operations
 
 #include "../ast.h"
 #include "../compile.h"
diff --git a/src/compile/binops.h b/src/compile/binops.h
index 0184c8a3..c19df06a 100644
--- a/src/compile/binops.h
+++ b/src/compile/binops.h
@@ -1,3 +1,5 @@
+// This file defines how to compile binary operations
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/blocks.c b/src/compile/blocks.c
index 1aa25531..eea73562 100644
--- a/src/compile/blocks.c
+++ b/src/compile/blocks.c
@@ -1,3 +1,4 @@
+// This file defines how to compile blocks
 
 #include "blocks.h"
 #include "../ast.h"
diff --git a/src/compile/blocks.h b/src/compile/blocks.h
index a964bcf0..59d85b6c 100644
--- a/src/compile/blocks.h
+++ b/src/compile/blocks.h
@@ -1,3 +1,5 @@
+// This file defines how to compile blocks
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/cli.c b/src/compile/cli.c
index 868e9075..48504207 100644
--- a/src/compile/cli.c
+++ b/src/compile/cli.c
@@ -1,3 +1,5 @@
+// This file defines how to compile CLI argument parsing
+
 #include "../compile.h"
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
@@ -7,7 +9,6 @@
 #include "../types.h"
 #include "assignments.h"
 #include "optionals.h"
-#include "promotions.h"
 #include "text.h"
 #include "types.h"
 
diff --git a/src/compile/cli.h b/src/compile/cli.h
index dc18fd3c..fa8f0915 100644
--- a/src/compile/cli.h
+++ b/src/compile/cli.h
@@ -1,3 +1,6 @@
+// This file defines how to compile CLI argument parsing
+#pragma once
+
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
 #include "../types.h"
diff --git a/src/compile/enums.c b/src/compile/enums.c
index 1e20f5bf..d2b4d9a1 100644
--- a/src/compile/enums.c
+++ b/src/compile/enums.c
@@ -1,6 +1,4 @@
-// Logic for compiling tagged unions (enums)
-#include <gc.h>
-#include <stdio.h>
+// This file defines how to compile enums
 
 #include "../ast.h"
 #include "../compile.h"
diff --git a/src/compile/enums.h b/src/compile/enums.h
index 21235532..bcb34ddc 100644
--- a/src/compile/enums.h
+++ b/src/compile/enums.h
@@ -1,7 +1,6 @@
+// This file defines how to compile enums
 #pragma once
 
-// Compilation of tagged unions (enums)
-
 #include "../ast.h"
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
diff --git a/src/compile/files.c b/src/compile/files.c
index 9a4ff434..f221201b 100644
--- a/src/compile/files.c
+++ b/src/compile/files.c
@@ -1,7 +1,8 @@
+// This file defines how to compile files
+
 #include <glob.h>
 
 #include "../ast.h"
-#include "../compile.h"
 #include "../config.h"
 #include "../environment.h"
 #include "../modules.h"
diff --git a/src/compile/files.h b/src/compile/files.h
index c9086f53..e2a6e98b 100644
--- a/src/compile/files.h
+++ b/src/compile/files.h
@@ -1,3 +1,6 @@
+// This file defines how to compile files
+#pragma once
+
 #include "../ast.h"
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
diff --git a/src/compile/functions.c b/src/compile/functions.c
index d0235c66..b01f599b 100644
--- a/src/compile/functions.c
+++ b/src/compile/functions.c
@@ -1,3 +1,5 @@
+// This file defines how to compile functions
+
 #include "functions.h"
 #include "../ast.h"
 #include "../compile.h"
diff --git a/src/compile/functions.h b/src/compile/functions.h
index 736662af..3632cd77 100644
--- a/src/compile/functions.h
+++ b/src/compile/functions.h
@@ -1,3 +1,5 @@
+// This file defines how to compile functions
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/integers.c b/src/compile/integers.c
index 23d3830c..40351afa 100644
--- a/src/compile/integers.c
+++ b/src/compile/integers.c
@@ -1,3 +1,5 @@
+// This file defines how to compile integers
+
 #include <gmp.h>
 
 #include "../ast.h"
diff --git a/src/compile/integers.h b/src/compile/integers.h
index 06b47413..667c5221 100644
--- a/src/compile/integers.h
+++ b/src/compile/integers.h
@@ -1,3 +1,5 @@
+// This file defines how to compile integers
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/lists.c b/src/compile/lists.c
index a7667634..515613cb 100644
--- a/src/compile/lists.c
+++ b/src/compile/lists.c
@@ -1,4 +1,4 @@
-// Compilation logic for lists
+// This file defines how to compile lists
 
 #include <gc.h>
 #include <glob.h>
diff --git a/src/compile/lists.h b/src/compile/lists.h
index 4f39b392..e9b72b12 100644
--- a/src/compile/lists.h
+++ b/src/compile/lists.h
@@ -1,3 +1,6 @@
+// This file defines how to compile lists
+#pragma once
+
 #include "../ast.h"
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
diff --git a/src/compile/optionals.c b/src/compile/optionals.c
index 6dad725c..3113ee49 100644
--- a/src/compile/optionals.c
+++ b/src/compile/optionals.c
@@ -1,3 +1,5 @@
+// This file defines how to compile optionals and null
+
 #include "../compile.h"
 #include "../environment.h"
 #include "../naming.h"
diff --git a/src/compile/optionals.h b/src/compile/optionals.h
index 2a93d53e..ddacba63 100644
--- a/src/compile/optionals.h
+++ b/src/compile/optionals.h
@@ -1,3 +1,6 @@
+// This file defines how to compile optionals and null
+#pragma once
+
 #include "../ast.h"
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
diff --git a/src/compile/pointers.c b/src/compile/pointers.c
index b9486899..317863af 100644
--- a/src/compile/pointers.c
+++ b/src/compile/pointers.c
@@ -1,4 +1,5 @@
-// Compilation logic
+// This file defines how to compile pointers and allocated memory
+
 #include <gc.h>
 #include <glob.h>
 #include <gmp.h>
diff --git a/src/compile/pointers.h b/src/compile/pointers.h
index 49e73c1c..8a4c921a 100644
--- a/src/compile/pointers.h
+++ b/src/compile/pointers.h
@@ -1,3 +1,6 @@
+// This file defines how to compile pointers and allocated memory
+#pragma once
+
 #include <stdbool.h>
 
 #include "../ast.h"
diff --git a/src/compile/promotions.c b/src/compile/promotions.c
index febbbd1f..c3d7eddc 100644
--- a/src/compile/promotions.c
+++ b/src/compile/promotions.c
@@ -1,3 +1,5 @@
+// This file defines how to do type promotions during compilation
+
 #include "promotions.h"
 #include "../ast.h"
 #include "../compile.h"
diff --git a/src/compile/promotions.h b/src/compile/promotions.h
index 2cfe0cbf..49e649eb 100644
--- a/src/compile/promotions.h
+++ b/src/compile/promotions.h
@@ -1,3 +1,5 @@
+// This file defines how to do type promotions during compilation
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/sets.c b/src/compile/sets.c
index bfa21db7..b6144662 100644
--- a/src/compile/sets.c
+++ b/src/compile/sets.c
@@ -1,3 +1,4 @@
+// This file defines how to compile sets
 
 #include "../ast.h"
 #include "../compile.h"
@@ -7,7 +8,6 @@
 #include "../typecheck.h"
 #include "../types.h"
 #include "functions.h"
-#include "optionals.h"
 #include "pointers.h"
 #include "promotions.h"
 #include "statements.h"
diff --git a/src/compile/sets.h b/src/compile/sets.h
index 21c96b07..7f34c482 100644
--- a/src/compile/sets.h
+++ b/src/compile/sets.h
@@ -1,3 +1,5 @@
+// This file defines how to compile sets
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/statements.c b/src/compile/statements.c
index 30972a9b..03505691 100644
--- a/src/compile/statements.c
+++ b/src/compile/statements.c
@@ -1,3 +1,5 @@
+// This file defines how to compile statements
+
 #include <glob.h>
 
 #include "../ast.h"
diff --git a/src/compile/statements.h b/src/compile/statements.h
index ed0234a2..41b1d8f4 100644
--- a/src/compile/statements.h
+++ b/src/compile/statements.h
@@ -1,3 +1,6 @@
+// This file defines how to compile statements
+#pragma once
+
 #include "../ast.h"
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
diff --git a/src/compile/structs.c b/src/compile/structs.c
index 3244f6f3..266977a0 100644
--- a/src/compile/structs.c
+++ b/src/compile/structs.c
@@ -1,4 +1,5 @@
-// Logic for compiling new struct types defined in code
+// This file defines how to compile structs
+
 #include <gc.h>
 
 #include "../ast.h"
diff --git a/src/compile/structs.h b/src/compile/structs.h
index 42c95003..94c6f94a 100644
--- a/src/compile/structs.h
+++ b/src/compile/structs.h
@@ -1,7 +1,6 @@
+// This file defines how to compile structs
 #pragma once
 
-// Compilation of user-defined structs
-
 #include "../ast.h"
 #include "../environment.h"
 #include "../types.h"
@@ -12,5 +11,3 @@ Text_t compile_struct_typeinfo(env_t *env, type_t *t, const char *name, arg_ast_
 Text_t compile_struct_header(env_t *env, ast_t *ast);
 Text_t compile_struct_field_access(env_t *env, ast_t *ast);
 Text_t compile_struct_literal(env_t *env, ast_t *ast, type_t *t, arg_ast_t *args);
-
-// vim: ts=4 sw=0 et cino=L2,l1,(0,W4,m1,\:0
diff --git a/src/compile/tables.c b/src/compile/tables.c
index c99ac1b1..8ea86a27 100644
--- a/src/compile/tables.c
+++ b/src/compile/tables.c
@@ -1,3 +1,4 @@
+// This file defines how to compile tables
 
 #include "../ast.h"
 #include "../compile.h"
diff --git a/src/compile/tables.h b/src/compile/tables.h
index 579c313f..7e29a926 100644
--- a/src/compile/tables.h
+++ b/src/compile/tables.h
@@ -1,3 +1,6 @@
+// This file defines how to compile tables
+#pragma once
+
 #include "../ast.h"
 #include "../environment.h"
 #include "../stdlib/datatypes.h"
diff --git a/src/compile/text.c b/src/compile/text.c
index 9a95fd4d..a6d739ad 100644
--- a/src/compile/text.c
+++ b/src/compile/text.c
@@ -1,3 +1,4 @@
+// This file defines how to compile text
 #include <ctype.h>
 
 #include "../ast.h"
diff --git a/src/compile/text.h b/src/compile/text.h
index 80502971..fcabc8b4 100644
--- a/src/compile/text.h
+++ b/src/compile/text.h
@@ -1,3 +1,5 @@
+// This file defines how to compile text
+#pragma once
 
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/types.c b/src/compile/types.c
index e3786c99..607daad2 100644
--- a/src/compile/types.c
+++ b/src/compile/types.c
@@ -1,3 +1,4 @@
+// This file defines how to compile types and type info values
 #include "../types.h"
 #include "../ast.h"
 #include "../environment.h"
diff --git a/src/compile/types.h b/src/compile/types.h
index 81bce10d..35394f5d 100644
--- a/src/compile/types.h
+++ b/src/compile/types.h
@@ -1,3 +1,5 @@
+// This file defines how to compile types and type info values
+#pragma once
 
 #include "../stdlib/datatypes.h"
 #include "../types.h"