Some refactoring and cleanup (#1806)

* Use clang-tidy `misc-include-cleaner` for IWYU `#include` cleanup

* Use `std::optional<size_t>` instead of `ssize_t`

* Rename some functions in linkdefs.hpp

* Fix header order

src/asm/actions.cpp

@@ -2,16 +2,30 @@
 
 #include "asm/actions.hpp"
 
+#include <errno.h>
+#include <inttypes.h>
+#include <optional>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <string>
+#include <string_view>
+#include <utility>
+#include <variant>
+#include <vector>
 
 #include "extern/utf8decoder.hpp"
 #include "helpers.hpp"
+#include "linkdefs.hpp"
 
 #include "asm/charmap.hpp"
 #include "asm/format.hpp"
 #include "asm/fstack.hpp"
+#include "asm/lexer.hpp"
+#include "asm/output.hpp"
+#include "asm/rpn.hpp" // Expression
+#include "asm/section.hpp"
 #include "asm/symbol.hpp"
 #include "asm/warning.hpp"
 

src/asm/charmap.cpp

@@ -4,12 +4,17 @@
 
 #include <deque>
 #include <map>
+#include <optional>
 #include <stack>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <string>
+#include <string_view>
 #include <unordered_map>
 #include <utility>
+#include <vector>
 
 #include "extern/utf8decoder.hpp"
 #include "helpers.hpp"

src/asm/fixpoint.cpp

@@ -6,6 +6,7 @@
 
 #include <math.h>
 #include <numbers>
+#include <stdint.h>
 
 static constexpr double tau = std::numbers::pi * 2;
 

src/asm/format.cpp

@@ -5,11 +5,12 @@
 #include <algorithm>
 #include <inttypes.h>
 #include <math.h>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <string>
 
-#include "asm/fixpoint.hpp"
 #include "asm/main.hpp" // options
 #include "asm/warning.hpp"
 

src/asm/fstack.cpp

@@ -7,15 +7,20 @@
 #include <errno.h>
 #include <inttypes.h>
 #include <memory>
+#include <optional>
 #include <stack>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
+#include <string>
+#include <utility>
+#include <variant>
+#include <vector>
 
 #include "backtrace.hpp"
-#include "diagnostics.hpp"
 #include "helpers.hpp"
 #include "linkdefs.hpp"
-#include "platform.hpp" // S_ISDIR (stat macro)
 #include "verbosity.hpp"
 
 #include "asm/lexer.hpp"

src/asm/lexer.cpp

@@ -2,27 +2,34 @@
 
 #include "asm/lexer.hpp"
 #include <sys/stat.h>
-#include <sys/types.h>
 
 #include <algorithm>
 #include <errno.h>
 #include <fcntl.h>
 #include <fstream>
 #include <inttypes.h>
+#include <ios>
 #include <limits.h>
 #include <math.h>
+#include <memory>
 #include <new> // nothrow
+#include <optional>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <string>
 #include <unordered_map>
+#include <utility>
+#include <variant>
+#include <vector>
 
 #include "helpers.hpp"
+#include "platform.hpp"
 #include "style.hpp"
 #include "util.hpp"
 #include "verbosity.hpp"
 
-#include "asm/fixpoint.hpp"
 #include "asm/format.hpp"
 #include "asm/fstack.hpp"
 #include "asm/macro.hpp"

src/asm/macro.cpp

@@ -2,6 +2,8 @@
 
 #include "asm/macro.hpp"
 
+#include <memory>
+#include <stdint.h>
 #include <stdio.h>
 #include <string.h>
 #include <string>

src/asm/main.cpp

@@ -4,18 +4,25 @@
 
 #include <algorithm>
 #include <errno.h>
-#include <limits.h>
+#include <inttypes.h>
 #include <memory>
 #include <stdarg.h>
+#include <stdint.h>
+#include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <string>
 #include <time.h>
+#include <unordered_map>
+#include <utility>
+#include <vector>
 
 #include "backtrace.hpp"
 #include "diagnostics.hpp"
 #include "extern/getopt.hpp"
 #include "helpers.hpp"
 #include "parser.hpp" // Generated from parser.y
+#include "platform.hpp"
 #include "style.hpp"
 #include "usage.hpp"
 #include "util.hpp" // UpperMap
@@ -26,6 +33,7 @@
 #include "asm/fstack.hpp"
 #include "asm/opt.hpp"
 #include "asm/output.hpp"
+#include "asm/section.hpp"
 #include "asm/symbol.hpp"
 #include "asm/warning.hpp"
 

src/asm/opt.cpp

@@ -1,19 +1,20 @@
 // SPDX-License-Identifier: MIT
 
 #include <errno.h>
+#include <iterator> // std::size
 #include <stack>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
+#include "diagnostics.hpp"
 #include "helpers.hpp" // assume
 #include "util.hpp"    // isBlankSpace
 
-#include "asm/fixpoint.hpp"
 #include "asm/fstack.hpp"
 #include "asm/lexer.hpp"
 #include "asm/main.hpp" // options
-#include "asm/section.hpp"
 #include "asm/warning.hpp"
 
 struct OptStackEntry {

src/asm/output.cpp

@@ -6,13 +6,16 @@
 #include <deque>
 #include <errno.h>
 #include <inttypes.h>
+#include <memory>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <string>
+#include <vector>
 
-#include "diagnostics.hpp"
 #include "helpers.hpp" // assume, Defer
+#include "linkdefs.hpp"
 #include "platform.hpp"
 
 #include "asm/charmap.hpp"
@@ -93,7 +96,7 @@ static void writeSection(Section const &sect, FILE *file) {
 	putc(sect.align, file);
 	putLong(sect.alignOfs, file);
 
-	if (sect_HasData(sect.type)) {
+	if (sectTypeHasData(sect.type)) {
 		fwrite(sect.data.data(), 1, sect.size, file);
 		putLong(sect.patches.size(), file);
 

src/asm/rpn.cpp

@@ -5,12 +5,16 @@
 #include <inttypes.h>
 #include <limits.h>
 #include <optional>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <string>
 #include <string_view>
+#include <utility>
 
 #include "helpers.hpp" // assume
+#include "linkdefs.hpp"
 #include "opmath.hpp"
 
 #include "asm/output.hpp"

src/asm/section.cpp

@@ -3,15 +3,23 @@
 #include "asm/section.hpp"
 
 #include <algorithm>
+#include <deque>
 #include <errno.h>
 #include <inttypes.h>
+#include <iterator>
+#include <optional>
 #include <stack>
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <string>
+#include <unordered_map>
 #include <utility>
+#include <vector>
 
 #include "helpers.hpp"
+#include "linkdefs.hpp"
 
 #include "asm/fstack.hpp"
 #include "asm/lexer.hpp"
@@ -67,7 +75,7 @@ static bool requireCodeSection() {
 		return false;
 	}
 
-	if (sect_HasData(currentSection->type)) {
+	if (sectTypeHasData(currentSection->type)) {
 		return true;
 	}
 
@@ -128,7 +136,7 @@ static unsigned int mergeSectUnion(
 
 	// Unionized sections only need "compatible" constraints, and they end up with the strictest
 	// combination of both.
-	if (sect_HasData(type)) {
+	if (sectTypeHasData(type)) {
 		sectError("Cannot declare ROM sections as `UNION`");
 	}
 
@@ -333,7 +341,7 @@ static Section *createSection(
 	out_RegisterNode(sect.src);
 
 	// It is only needed to allocate memory for ROM sections.
-	if (sect_HasData(type)) {
+	if (sectTypeHasData(type)) {
 		sect.data.resize(sectionTypeInfo[type].size);
 	}
 
@@ -359,7 +367,7 @@ static Section *createSectionFragmentLiteral(Section const &parent) {
 	out_RegisterNode(sect.src);
 
 	// Section fragment literals must be ROM sections.
-	assume(sect_HasData(sect.type));
+	assume(sectTypeHasData(sect.type));
 	sect.data.resize(sectionTypeInfo[sect.type].size);
 
 	return &sect;
@@ -396,7 +404,7 @@ static Section *getSection(
 			    sectionTypeInfo[type].lastBank
 			);
 		}
-	} else if (nbbanks(type) == 1) {
+	} else if (sectTypeBanks(type) == 1) {
 		// If the section type only has a single bank, implicitly force it
 		bank = sectionTypeInfo[type].firstBank;
 	}
@@ -411,14 +419,14 @@ static Section *getSection(
 	}
 
 	if (org != UINT32_MAX) {
-		if (org < sectionTypeInfo[type].startAddr || org > endaddr(type)) {
+		if (org < sectionTypeInfo[type].startAddr || org > sectTypeEndAddr(type)) {
 			error(
 			    "Section \"%s\"'s fixed address $%04" PRIx32 " is outside of range [$%04" PRIx16
 			    "; $%04" PRIx16 "]",
 			    name.c_str(),
 			    org,
 			    sectionTypeInfo[type].startAddr,
-			    endaddr(type)
+			    sectTypeEndAddr(type)
 			);
 		}
 	}
@@ -539,7 +547,7 @@ void sect_SetLoadSection(
 		return;
 	}
 
-	if (sect_HasData(type)) {
+	if (sectTypeHasData(type)) {
 		error("`LOAD` blocks cannot create a ROM section");
 		return;
 	}
@@ -715,7 +723,7 @@ void sect_StartUnion() {
 		error("`UNION`s must be inside a `SECTION`");
 		return;
 	}
-	if (sect_HasData(currentSection->type)) {
+	if (sectTypeHasData(currentSection->type)) {
 		error("Cannot use `UNION` inside of `ROM0` or `ROMX` sections");
 		return;
 	}
@@ -812,7 +820,7 @@ void sect_Skip(uint32_t skip, bool ds) {
 		return;
 	}
 
-	if (!sect_HasData(currentSection->type)) {
+	if (!sectTypeHasData(currentSection->type)) {
 		growSection(skip);
 	} else {
 		if (!ds) {
@@ -1110,7 +1118,7 @@ std::string sect_PushSectionFragmentLiteral() {
 	if (!currentSection) {
 		fatal("Cannot output fragment literals outside of a `SECTION`");
 	}
-	if (!sect_HasData(currentSection->type)) {
+	if (!sectTypeHasData(currentSection->type)) {
 		fatal(
 		    "Section \"%s\" cannot contain fragment literals (not `ROM0` or `ROMX`)",
 		    currentSection->name.c_str()

src/asm/symbol.cpp

@@ -5,9 +5,16 @@
 #include <algorithm>
 #include <errno.h>
 #include <inttypes.h>
+#include <memory>
+#include <stdint.h>
 #include <stdio.h>
+#include <string.h>
+#include <string>
+#include <time.h>
 #include <unordered_map>
 #include <unordered_set>
+#include <utility>
+#include <variant>
 
 #include "diagnostics.hpp"
 #include "helpers.hpp" // assume
@@ -19,6 +26,7 @@
 #include "asm/macro.hpp"
 #include "asm/main.hpp"
 #include "asm/output.hpp"
+#include "asm/section.hpp"
 #include "asm/warning.hpp"
 
 using namespace std::literals;

src/asm/warning.cpp

@@ -2,20 +2,16 @@
 
 #include "asm/warning.hpp"
 
+#include <functional>
 #include <inttypes.h>
 #include <stdarg.h>
-#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <string.h>
 
 #include "diagnostics.hpp"
-#include "helpers.hpp"
-#include "itertools.hpp"
 #include "style.hpp"
 
 #include "asm/fstack.hpp"
-#include "asm/lexer.hpp"
 #include "asm/main.hpp"
 
 // clang-format off: nested initializers