Implement new instructions

"Who are you? What are you doing in my commit history?"
~ https://xkcd.com/163/

.checkpatch.conf

@@ -28,6 +28,9 @@
 # There's no BIT macro
 --ignore BIT_MACRO
 
+# Don't complain when bools are used in structs
+--ignore BOOL_MEMBER
+
 # Allow CamelCase
 --ignore CAMELCASE
 
@@ -40,9 +43,19 @@
 # Don't complain about structs not being const
 --ignore CONST_STRUCT
 
+# Don't complain about printing "warning:" without the function name, as warning
+# printing is relevant to the code being parsed, not RGBDS' code
+--ignore EMBEDDED_FUNCTION_NAME
+
 # Do not check the format of commit messages
 --ignore GIT_COMMIT_ID
 
+# Do not check for global initializers (this is specific to the kernel)
+--ignore GLOBAL_INITIALISERS
+
+# Don't complain about initializing statics (this is specific to the kernel)
+--ignore INITIALISED_STATIC
+
 # We don't have a MAINTAINERS file, don't complain about it.
 --ignore FILE_PATH_CHANGES
 
@@ -53,9 +66,15 @@
 # have a really long line that can be found with grep.
 --ignore LONG_LINE_STRING
 
+# Don't complain when files are modified in 'include/asm'
+--ignore MODIFIED_INCLUDE_ASM
+
 # Allow new typedefs
 --ignore NEW_TYPEDEFS
 
+# We allow lines ending with parentheses for the usage prints
+--ignore OPEN_ENDED_LINE
+
 # Prefer stdint.h types over kernel types
 --ignore PREFER_KERNEL_TYPES
 
@@ -65,11 +84,5 @@
 # Parentheses can make the code clearer
 --ignore UNNECESSARY_PARENTHESES
 
-# Don't complain when files are modified in 'include/asm'
---ignore MODIFIED_INCLUDE_ASM
-
-# Don't complain when bools are used in structs
---ignore BOOL_MEMBER
-
-# Don't complain about initializing statics (this is specific to the kernel)
---ignore INITIALISED_STATIC
+# We don't have `fallthrough;` */
+--ignore PREFER_FALLTHROUGH

.clang-format

@@ -0,0 +1,99 @@
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: Left
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: Consecutive
+AlignConsecutiveDeclarations: None
+AlignConsecutiveMacros: Consecutive
+AlignEscapedNewlines: Left
+AlignOperands: Align
+AlignTrailingComments: false
+AllowShortBlocksOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: InlineOnly
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+AttributeMacros:
+  - format_
+  - attr_
+BinPackArguments: true
+BinPackParameters: true
+BitFieldColonSpacing: Both
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Attach
+BreakBeforeConceptDeclarations: true
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: AfterComma
+BreakStringLiterals: true
+ColumnLimit: 100
+CompactNamespaces: false
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+EmptyLineBeforeAccessModifier: Leave
+FixNamespaceComments: false
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex: '^<sys/'
+    Priority: 0
+  - Regex: '^<'
+    Priority: 1
+  - Regex: '^"extern/'
+    Priority: 2
+  - Regex: '^"(asm|link|fix|gfx)/'
+    Priority: 3
+  - Regex: '^"'
+    Priority: 2
+IndentAccessModifiers: false
+IndentCaseBlocks: false
+IndentCaseLabels: false
+IndentExternBlock: NoIndent
+IndentGotoLabels: false
+IndentPPDirectives: BeforeHash
+IndentRequires: true
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+# Only support for Javascript as of clang-format 13...
+# InsertTrailingCommas: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+LambdaBodyIndentation: Signature
+Language: Cpp
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+PPIndentWidth: -1
+PointerAlignment: Right
+ReflowComments: true
+SortIncludes: CaseSensitive
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+SpaceAroundPointerQualifiers: Both
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard: c++20
+TabWidth: 4
+UseCRLF: false
+UseTab: AlignWithSpaces

.editorconfig

@@ -0,0 +1,9 @@
+[*]
+root = true
+indent_style = tab
+indent_size = tab
+tab_width = 8
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf

.gitattributes

@@ -0,0 +1,2 @@
+# Shell scripts need Unix line endings (see https://github.com/gbdev/rgbds/issues/841)
+*.sh text eol=lf

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: avivace
+patreon: gbdev01
+open_collective: gbdev

.github/actions/doc_postproc.awk

@@ -0,0 +1,56 @@
+#!/usr/bin/awk -f
+
+/^\s+<td><b class="Sy">.+<\/b><\/td>$/ {
+	# Assuming that all cells whose contents are bold are heading cells,
+	# use the HTML tag for those
+	sub(/td><b class="Sy"/, "th");
+	sub(/b><\/td/, "th");
+}
+
+# The whole page is being generated, so it's not meant to contain any Liquid
+BEGIN {
+	print "{% raw %}"
+}
+END {
+	print "{% endraw %}"
+}
+
+BEGIN {
+	in_synopsis = 0
+}
+/<table class="Nm">/ {
+	in_synopsis = 1
+}
+/<\/table>/ {
+	# Resets synopsis state even when already reset, but whatever
+	in_synopsis = 0
+}
+/<code class="Fl">-[a-zA-Z]/ {
+	# Add links to arg descr in synopsis section
+	if (in_synopsis) {
+		while (match($0, /<code class="Fl">-[a-zA-Z]+/)) {
+			#         123456789012345678 -> 18 chars
+			optchars = substr($0, RSTART + 18, RLENGTH - 18)
+			i = length(optchars)
+			while (i) {
+				end = RSTART + 18 + i
+				i -= 1
+				len = i ? 1 : 2
+				$0 = sprintf("%s<a href=\"#%s\">%s</a>%s",
+				             substr($0, 0, end - len - 1),
+				             substr($0, end - 1, 1),
+				             substr($0, end - len, len),
+				             substr($0, end))
+			}
+		}
+	}
+}
+
+{
+	# Make long opts (defined using `Fl Fl`) into a single tag
+	gsub(/<code class="Fl">-<\/code>\s*<code class="Fl">/, "<code class=\"Fl\">-")
+}
+
+{
+	print
+}

.github/actions/get-pages.sh

@@ -0,0 +1,113 @@
+#!/bin/bash
+
+usage() {
+	cat <<EOF
+Usage: $0 [-h] [-r] <rgbds-www> <version>
+Copy renders from RGBDS repository to rgbds-www documentation
+Execute from the root folder of the RGBDS repo, checked out at the desired tag
+<rgbds-www> : Path to the rgbds-www repository
+<version>   : Version to be copied, such as 'v0.4.1' or 'master'
+
+    -h  Display this help message
+    -r  Update "latest stable" redirection pages and add a new entry to the index
+        (use for releases, not master)
+EOF
+}
+
+is_release=0
+bad_usage=0
+while getopts ":hr" opt; do
+	case $opt in
+		r)
+			is_release=1
+			;;
+		h)
+			usage
+			exit 0
+			;;
+		\?)
+			echo "Unknown option '$OPTARG'"
+			bad_usage=1
+			;;
+	esac
+done
+if [ $bad_usage -ne 0 ]; then
+	usage
+	exit 1
+fi
+shift $(($OPTIND - 1))
+
+
+declare -A PAGES
+PAGES=(
+	[rgbasm.1.html]=src/asm/rgbasm.1
+	[rgbasm.5.html]=src/asm/rgbasm.5
+	[rgblink.1.html]=src/link/rgblink.1
+	[rgblink.5.html]=src/link/rgblink.5
+	[rgbfix.1.html]=src/fix/rgbfix.1
+	[rgbgfx.1.html]=src/gfx/rgbgfx.1
+	[rgbds.5.html]=src/rgbds.5
+	[rgbds.7.html]=src/rgbds.7
+	[gbz80.7.html]=src/gbz80.7
+)
+WWWPATH="/docs"
+mkdir -p "$1/_documentation/$2"
+
+# `mandoc` uses a different format for referring to man pages present in the **current** directory.
+# We want that format for RGBDS man pages, and the other one for the rest;
+# we thus need to copy all pages to a temporary directory, and process them there.
+
+# Copy all pages to current dir
+cp "${PAGES[@]}" .
+
+for page in "${!PAGES[@]}"; do
+stem="${page%.html}"
+manpage="${stem%.?}(${stem#*.})"
+descr="$(awk -v 'FS=.Nd ' '/.Nd/ { print $2; }' "${PAGES[$page]}")"
+
+	cat >"$1/_documentation/$2/$page" <<EOF
+---
+layout: doc
+title: $manpage [$2]
+description: RGBDS $2 — $descr
+---
+EOF
+	options=fragment,man='%N.%S;https://linux.die.net/man/%S/%N'
+	if [ $stem = rgbasm.5 ]; then
+		options+=,toc
+	fi
+	mandoc -Thtml -I os=Linux -O$options "${PAGES[$page]##*/}" | .github/actions/doc_postproc.awk >> "$1/_documentation/$2/$page"
+	groff -Tpdf -mdoc -wall "${PAGES[$page]##*/}" >"$1/_documentation/$2/$stem.pdf"
+	if [ $is_release -ne 0 ]; then
+		cat - >"$1/_documentation/$page" <<EOF
+---
+redirect_to: $WWWPATH/$2/${page%.html}
+permalink: $WWWPATH/${page%.html}/
+title: $manpage [latest stable]
+description: RGBDS latest stable — $descr
+---
+EOF
+	fi
+done
+
+cat - >"$1/_documentation/$2/index.html" <<EOF
+---
+layout: doc_index
+permalink: /docs/$2/
+title: RGBDS online manual [$2]
+description: RGBDS $2 - Online manual
+---
+EOF
+
+
+# If making a release, add a new entry right after `master`
+if [ $is_release -ne 0 ]; then
+	awk '{ print }
+/"name": "master"/ { print "\t\t{\"name\": \"'$2'\",  \"text\": \"'$2'\" }," }
+' "$1/_data/doc.json" >"$1/_data/doc.json.tmp"
+	mv "$1/_data/doc.json"{.tmp,}
+fi
+
+
+# Clean up
+rm "${PAGES[@]##*/}"

.github/actions/install_deps.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+set -e
+
+case "${1%-*}" in
+	ubuntu)
+		sudo apt-get -qq update
+		sudo apt-get install -yq bison libpng-dev pkg-config
+		;;
+	macos)
+		brew install bison libpng pkg-config md5sha1sum
+		# For the version check below exclusively, re-do this before building
+		export PATH="/usr/local/opt/bison/bin:$PATH"
+		;;
+	*)
+		echo "WARNING: Cannot install deps for OS '$1'"
+		;;
+esac
+
+bison --version
+make --version
+cmake --version

.github/actions/mingw-configure.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+source mingw-env @TRIPLE@
+echo LAST IS: $last
+
+# check if last arg is a path to configure, else use parent
+for last; do true; done
+if test -x "${last}/configure"; then
+  config_path="$last"
+else
+  config_path=".."
+fi
+
+${config_path}/configure \
+  --host=@TRIPLE@ --target=@TRIPLE@ --build="$CHOST" \
+  --prefix=/usr/@TRIPLE@ --libdir=/usr/@TRIPLE@/lib --includedir=/usr/@TRIPLE@/include \
+  --enable-shared --enable-static "$@"

.github/actions/mingw-env.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+_arch=$1
+
+default_mingw_pp_flags="-D_FORTIFY_SOURCE=2"
+default_mingw_compiler_flags="$default_mingw_pp_flags -O2 -pipe -fno-plt -fexceptions --param=ssp-buffer-size=4"
+default_mingw_linker_flags="-Wl,-O1,--sort-common,--as-needed -fstack-protector"
+
+export CPPFLAGS="${MINGW_CPPFLAGS:-$default_mingw_pp_flags $CPPFLAGS}"
+export CFLAGS="${MINGW_CFLAGS:-$default_mingw_compiler_flags $CFLAGS}"
+export CXXFLAGS="${MINGW_CXXFLAGS:-$default_mingw_compiler_flags $CXXFLAGS}"
+export LDFLAGS="${MINGW_LDFLAGS:-$default_mingw_linker_flags $LDFLAGS}"
+
+mingw_prefix=/usr/${_arch}
+export PKG_CONFIG_SYSROOT_DIR="${mingw_prefix}"
+export PKG_CONFIG_LIBDIR="${mingw_prefix}/lib/pkgconfig:${mingw_prefix}/share/pkgconfig"

.github/actions/mingw-w64-libpng-dev.sh

@@ -0,0 +1,44 @@
+#!/bin/sh
+
+# This script was written by ISSOtm while looking at Arch Linux's PKGBUILD for
+# the corresponding package. (And its dependencies)
+# https://aur.archlinux.org/packages/mingw-w64-libpng/
+
+set -e
+
+pngver=1.6.37
+_apngver=$pngver
+_arch="$1"
+
+
+## Install mingw-configure and mingw-env (both build dependencies)
+
+install -m 755 .github/actions/mingw-env.sh /usr/bin/mingw-env
+
+sed "s|@TRIPLE@|${_arch}|g" .github/actions/mingw-configure.sh > ${_arch}-configure
+install -m 755 ${_arch}-configure /usr/bin/
+
+
+## Grab sources and check them
+
+wget http://downloads.sourceforge.net/sourceforge/libpng/libpng-$pngver.tar.xz
+wget http://downloads.sourceforge.net/project/apng/libpng/libpng16/libpng-$_apngver-apng.patch.gz
+sha256sum -c .github/actions/mingw-w64-libpng-dev.sha256sums
+
+## Extract sources
+
+tar -xf libpng-$pngver.tar.xz
+gunzip libpng-$_apngver-apng.patch.gz
+
+
+## Start building!
+
+cd libpng-$pngver
+# Patch in apng support
+patch -p0 ../libpng-$_apngver-apng.patch
+
+mkdir -p build-${_arch}
+cd build-${_arch}
+${_arch}-configure LDFLAGS=-static-libgcc
+make
+make install

.github/actions/mingw-w64-libpng-dev.sha256sums

@@ -0,0 +1,2 @@
+10d9e0cb60e2b387a79b355eb7527c0bee2ed8cbd12cf04417cabc4d6976683c  libpng-1.6.37-apng.patch.gz
+505e70834d35383537b6491e7ae8641f1a4bed1876dbfe361201fc80868d88ca  libpng-1.6.37.tar.xz

.github/workflows/checkdiff.yml

@@ -0,0 +1,17 @@
+name: "Code coverage checking"
+on: pull_request
+
+jobs:
+  checkdiff:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up repo
+        run: |
+          git clone -b "${{ github.event.pull_request.head.ref }}" "${{ github.event.pull_request.head.repo.clone_url }}" rgbds
+          cd rgbds
+          git remote add upstream "${{ github.event.pull_request.base.repo.clone_url }}"
+          git fetch upstream
+      - name: Checkdiff
+        working-directory: rgbds
+        run: |
+          make checkdiff "BASE_REF=${{ github.event.pull_request.base.sha }}" Q= | tee log

.github/workflows/checkpatch.yml

@@ -0,0 +1,25 @@
+name: "Code style checking"
+on: pull_request
+
+jobs:
+  checkpatch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up repo
+        run: |
+          git clone -b "${{ github.event.pull_request.head.ref }}" "${{ github.event.pull_request.head.repo.clone_url }}" rgbds
+          cd rgbds
+          git remote add upstream "${{ github.event.pull_request.base.repo.clone_url }}"
+          git fetch upstream
+      - name: Set up checkpatch
+        working-directory: rgbds
+        run: |
+          wget 'https://raw.githubusercontent.com/torvalds/linux/master/scripts/checkpatch.pl'
+          chmod +x checkpatch.pl
+          wget 'https://raw.githubusercontent.com/torvalds/linux/master/scripts/const_structs.checkpatch'
+          wget 'https://raw.githubusercontent.com/torvalds/linux/master/scripts/spelling.txt'
+      - name: Checkpatch
+        working-directory: rgbds
+        run: |
+          make checkpatch CHECKPATCH=./checkpatch.pl "BASE_REF=${{ github.event.pull_request.base.sha }}" Q= | tee log
+          if grep -q ERROR: log; then exit 1; else exit 0; fi

.github/workflows/create-release-artifacts.yaml

@@ -0,0 +1,96 @@
+name: "Create release artifacts"
+on:
+  push:
+    tags:
+      - v[0-9]*
+
+jobs:
+  windows:
+    runs-on: windows-2019
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get version from tag
+        shell: bash
+        run: | # Turn "refs/tags/vX.Y.Z" into "X.Y.Z"
+          VERSION="${{ github.ref }}"
+          echo "version=${VERSION##*/v}" >> $GITHUB_ENV
+      - name: Get zlib, libpng and bison
+        run: | # TODO: use an array
+          $wc = New-Object System.Net.WebClient
+          $wc.DownloadFile('https://www.zlib.net/zlib1212.zip', 'zlib.zip')
+          $hash = (Get-FileHash "zlib.zip" -Algorithm SHA256).Hash
+          if ($hash -ne '173e89893dcb8b4a150d7731cd72f0602f1d6b45e60e2a54efdf7f3fc3325fd7') {
+            Write-Host "zlib SHA256 mismatch! ($hash)"
+            exit 1
+          }
+          $wc.DownloadFile('https://download.sourceforge.net/libpng/lpng1637.zip', 'libpng.zip')
+          $hash = (Get-FileHash "libpng.zip" -Algorithm SHA256).Hash
+          if ($hash -ne '3b4b1cbd0bae6822f749d39b1ccadd6297f05e2b85a83dd2ce6ecd7d09eabdf2') {
+            Write-Host "libpng SHA256 mismatch! ($hash)"
+            exit 1
+          }
+          $wc.DownloadFile('https://github.com/lexxmark/winflexbison/releases/download/v2.5.24/win_flex_bison-2.5.24.zip', 'winflexbison.zip')
+          $hash = (Get-FileHash "winflexbison.zip" -Algorithm SHA256).Hash
+          if ($hash -ne '39c6086ce211d5415500acc5ed2d8939861ca1696aee48909c7f6daf5122b505') {
+            Write-Host "bison SHA256 mismatch! ($hash)"
+          }
+          Expand-Archive -DestinationPath .           "zlib.zip"
+          Expand-Archive -DestinationPath .           "libpng.zip"
+          Expand-Archive -DestinationPath install_dir "winflexbison.zip"
+          Move-Item zlib-1.2.12 zlib
+          Move-Item lpng1637 libpng
+      - name: Build 32-bit zlib
+        run: | # BUILD_SHARED_LIBS causes the output DLL to be correctly called `zlib1.dll`
+          cmake -S zlib -B zbuild32 -A Win32 -DCMAKE_INSTALL_PREFIX=install_dir -DBUILD_SHARED_LIBS=ON
+          cmake --build zbuild32 --config Release
+          cmake --install zbuild32
+      - name: Build 32-bit libpng
+        run: |
+          cmake -S libpng -B pngbuild32 -A Win32 -DCMAKE_INSTALL_PREFIX=install_dir -DPNG_SHARED=ON -DPNG_STATIC=ON -DPNG_TESTS=OFF
+          cmake --build pngbuild32 --config Release
+          cmake --install pngbuild32
+      - name: Build 32-bit Windows binaries
+        run: |
+          cmake -S . -B build32 -A Win32 -DCMAKE_INSTALL_PREFIX=install_dir -DCMAKE_BUILD_TYPE=Release
+          cmake --build build32 --config Release
+          cmake --install build32
+      - name: Package 32-bit binaries
+        run: |
+          Compress-Archive -LiteralPath @("install_dir/bin/rgbasm.exe", "install_dir/bin/rgblink.exe", "install_dir/bin/rgbfix.exe", "install_dir/bin/rgbgfx.exe", "install_dir/bin/zlib1.dll", "install_dir/bin/libpng16.dll") "rgbds-${{ env.version }}-win32.zip"
+      - name: Build 64-bit zlib
+        run: | # BUILD_SHARED_LIBS causes the output DLL to be correctly called `zlib1.dll`
+          cmake -S zlib -B zbuild64 -A x64 -DCMAKE_INSTALL_PREFIX=install_dir -DBUILD_SHARED_LIBS=ON
+          cmake --build zbuild64 --config Release
+          cmake --install zbuild64
+      - name: Build 64-bit libpng
+        run: |
+          cmake -S libpng -B pngbuild64 -A x64 -DCMAKE_INSTALL_PREFIX=install_dir -DPNG_SHARED=ON -DPNG_STATIC=ON -DPNG_TESTS=OFF
+          cmake --build pngbuild64 --config Release
+          cmake --install pngbuild64
+      - name: Build 64-bit Windows binaries
+        run: |
+          cmake -S . -B build64 -A x64 -DCMAKE_INSTALL_PREFIX=install_dir -DCMAKE_BUILD_TYPE=Release
+          cmake --build build64 --config Release
+          cmake --install build64
+      - name: Package 64-bit binaries
+        run: |
+          Compress-Archive -LiteralPath @("install_dir/bin/rgbasm.exe", "install_dir/bin/rgblink.exe", "install_dir/bin/rgbfix.exe", "install_dir/bin/rgbgfx.exe", "install_dir/bin/zlib1.dll", "install_dir/bin/libpng16.dll") "rgbds-${{ env.version }}-win64.zip"
+      - name: Package sources
+        run: |
+          make dist
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body: |
+            Please ensure that the three assets below work properly.
+            Once that's done, replace this text with the changelog, un-draft the release, and update the `release` branch.
+            By the way, if you forgot to update `include/version.h`, RGBASM's version test is gonna fail in the tag's regression testing! (Use `git push --delete origin <tag>` to delete it)
+          draft: true # Don't publish the release quite yet...
+          prerelease: ${{ contains(github.ref, '-rc') }}
+          files: |
+            rgbds-${{ env.version }}-win32.zip
+            rgbds-${{ env.version }}-win64.zip
+            rgbds-${{ env.version }}.tar.gz
+          fail_on_unmatched_files: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/create-release-docs.yml

@@ -0,0 +1,53 @@
+name: "Create release docs"
+on:
+  release:
+    types:
+      - released # This avoids triggering on pre-releases
+
+jobs:
+  build:
+    if: github.repository_owner == 'gbdev'
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout rgbds@release
+        uses: actions/checkout@v2
+        with:
+          path: rgbds
+      - name: Checkout rgbds-www@master
+        uses: actions/checkout@v2
+        with:
+          repository: ${{ github.repository_owner }}/rgbds-www
+          path: rgbds-www
+      # `-O toc` was added in 1.14.5, but the repos only have 1.14.4
+      - name: Build and install mandoc + install groff
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get install -yq groff zlib1g-dev
+          wget 'http://mandoc.bsd.lv/snapshots/mandoc-1.14.5.tar.gz'
+          tar xf mandoc-1.14.5.tar.gz
+          cd mandoc-1.14.5
+          ./configure
+          make
+          sudo make install
+      - name: Update pages
+        working-directory: rgbds
+        run: | # The ref appears to be in the format "refs/tags/<version>", so strip that
+          ./.github/actions/get-pages.sh -r ../rgbds-www ${GITHUB_REF##*/}
+      - name: Push new pages
+        working-directory: rgbds-www
+        run: |
+          mkdir -p -m 700 ~/.ssh
+          cat > ~/.ssh/id_ed25519 <<<"${{ secrets.SSH_KEY_SECRET }}"
+          chmod 0600 ~/.ssh/id_ed25519
+          eval $(ssh-agent -s)
+          ssh-add ~/.ssh/id_ed25519
+          git config --global user.name "GitHub Action"
+          git config --global user.email "[email protected]"
+          git add -A
+          git commit -m "Create RGBDS ${GITHUB_REF##*/} documentation"
+          if git remote | grep -q origin; then
+            git remote set-url origin [email protected]:${{ github.repository_owner }}/rgbds-www.git
+          else
+            git remote add origin [email protected]:${{ github.repository_owner }}/rgbds-www.git
+          fi
+          git push origin master

.github/workflows/testing.yml

@@ -0,0 +1,197 @@
+name: "Regression testing"
+on:
+  - push
+  - pull_request
+
+jobs:
+  unix-testing:
+    strategy:
+      matrix:
+        os: [ubuntu-20.04, ubuntu-18.04, macos-11.0, macos-10.15]
+        cc: [gcc, clang]
+        buildsys: [make, cmake]
+        exclude:
+          # `gcc` is just an alias to `clang` on macOS, don't bother
+          - os: macos-10.15
+            cc: gcc
+          - os: macos-11.0
+            cc: gcc
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install deps
+        shell: bash
+        run: |
+          ./.github/actions/install_deps.sh ${{ matrix.os }}
+      # The `export` lines are to allow working on macOS...
+      # Apple's base version is severely outdated, not even supporting -Wall,
+      # but it overrides Homebrew's version nonetheless...
+      - name: Build & install using Make
+        run: |
+          export PATH="/usr/local/opt/bison/bin:$PATH"
+          make develop -j Q= CC=${{ matrix.cc }}
+          sudo make install -j Q=
+        if: matrix.buildsys == 'make'
+      - name: Build & install using CMake
+        run: |
+          export PATH="/usr/local/opt/bison/bin:$PATH"
+          cmake -S . -B build -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER=${{ matrix.cc }} -DSANITIZERS=ON -DMORE_WARNINGS=ON
+          cmake --build build -j
+          cp build/src/rgb{asm,link,fix,gfx} .
+          sudo cmake --install build
+        if: matrix.buildsys == 'cmake'
+      - name: Package binaries
+        run: |
+          mkdir bins
+          cp rgb{asm,link,fix,gfx} bins
+      - name: Upload binaries
+        uses: actions/upload-artifact@v1
+        with:
+          name: rgbds-canary-${{ matrix.os }}-${{ matrix.cc }}-${{ matrix.buildsys }}
+          path: bins
+      - name: Test
+        shell: bash
+        run: |
+          test/run-tests.sh
+
+  windows-testing:
+    strategy:
+      matrix:
+        bits: [32, 64]
+        include:
+          - bits: 32
+            arch: x86
+            platform: Win32
+          - bits: 64
+            arch: x86_x64
+            platform: x64
+      fail-fast: false
+    runs-on: windows-2019
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get zlib, libpng and bison
+        run: | # TODO: use an array
+          $wc = New-Object System.Net.WebClient
+          $wc.DownloadFile('https://www.zlib.net/zlib1212.zip', 'zlib.zip')
+          $hash = (Get-FileHash "zlib.zip" -Algorithm SHA256).Hash
+          if ($hash -ne '173e89893dcb8b4a150d7731cd72f0602f1d6b45e60e2a54efdf7f3fc3325fd7') {
+            Write-Host "zlib SHA256 mismatch! ($hash)"
+            exit 1
+          }
+          $wc.DownloadFile('https://download.sourceforge.net/libpng/lpng1637.zip', 'libpng.zip')
+          $hash = (Get-FileHash "libpng.zip" -Algorithm SHA256).Hash
+          if ($hash -ne '3b4b1cbd0bae6822f749d39b1ccadd6297f05e2b85a83dd2ce6ecd7d09eabdf2') {
+            Write-Host "libpng SHA256 mismatch! ($hash)"
+            exit 1
+          }
+          $wc.DownloadFile('https://github.com/lexxmark/winflexbison/releases/download/v2.5.24/win_flex_bison-2.5.24.zip', 'winflexbison.zip')
+          $hash = (Get-FileHash "winflexbison.zip" -Algorithm SHA256).Hash
+          if ($hash -ne '39c6086ce211d5415500acc5ed2d8939861ca1696aee48909c7f6daf5122b505') {
+            Write-Host "bison SHA256 mismatch! ($hash)"
+          }
+          Expand-Archive -DestinationPath .           "zlib.zip"
+          Expand-Archive -DestinationPath .           "libpng.zip"
+          Expand-Archive -DestinationPath install_dir "winflexbison.zip"
+          Move-Item zlib-1.2.12 zlib
+          Move-Item lpng1637 libpng
+      - name: Build zlib
+        run: | # BUILD_SHARED_LIBS causes the output DLL to be correctly called `zlib1.dll`
+          cmake -S zlib -B zbuild -A ${{ matrix.platform }} -DCMAKE_INSTALL_PREFIX=install_dir -DBUILD_SHARED_LIBS=ON
+          cmake --build zbuild --config Release -j
+          cmake --install zbuild
+      - name: Build libpng
+        run: |
+          cmake -S libpng -B pngbuild -A ${{ matrix.platform }} -DCMAKE_INSTALL_PREFIX=install_dir -DPNG_SHARED=ON -DPNG_STATIC=ON -DPNG_TESTS=OFF
+          cmake --build pngbuild --config Release -j
+          cmake --install pngbuild
+      - name: Build Windows binaries
+        run: |
+          cmake -S . -B build -A ${{ matrix.platform }} -DCMAKE_INSTALL_PREFIX=install_dir -DCMAKE_BUILD_TYPE=Release
+          cmake --build build --config Release -j
+          cmake --install build
+      - name: Package binaries
+        shell: bash
+        run: |
+          mkdir bins
+          cp install_dir/bin/{rgbasm.exe,rgblink.exe,rgbfix.exe,rgbgfx.exe,zlib1.dll,libpng16.dll} bins
+      - name: Upload Windows binaries
+        uses: actions/upload-artifact@v1
+        with:
+          name: rgbds-canary-win${{ matrix.bits }}
+          path: bins
+      - name: Test
+        shell: bash
+        run: |
+          cp bins/* .
+          test/run-tests.sh
+
+  windows-xbuild:
+    strategy:
+      matrix:
+        bits: [32, 64]
+        os: [ubuntu-18.04]
+        include:
+          - bits: 32
+            arch: i686
+            triplet: i686-w64-mingw32
+          - bits: 64
+            arch: x86-64
+            triplet: x86_64-w64-mingw32
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    env:
+      DIST_DIR: win${{ matrix.bits }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install deps
+        shell: bash
+        run: |
+          ./.github/actions/install_deps.sh ${{ matrix.os }}
+      - name: Install MinGW
+        run: |
+          sudo apt-get install gcc-mingw-w64-${{ matrix.arch }} mingw-w64-tools libz-mingw-w64-dev
+      - name: Install libpng dev headers for MinGW
+        run: |
+          sudo ./.github/actions/mingw-w64-libpng-dev.sh ${{ matrix.triplet }}
+      - name: Cross-build Windows binaries
+        run: |
+          make mingw${{ matrix.bits }} -j Q=
+      - name: Package binaries
+        run: |
+          mkdir bins
+          mv rgbasm bins/rgbasm.exe
+          mv rgblink bins/rgblink.exe
+          mv rgbfix bins/rgbfix.exe
+          mv rgbgfx bins/rgbgfx.exe
+          cp /usr/${{ matrix.triplet }}/lib/zlib1.dll bins
+          cp /usr/${{ matrix.triplet }}/bin/libpng16-16.dll bins
+          if [ ${{ matrix.bits }} -eq 32 ]; then cp /usr/lib/gcc/${{ matrix.triplet }}/7.3-win32/libgcc_s_sjlj-1.dll bins; fi
+      - name: Upload Windows binaries
+        uses: actions/upload-artifact@v1
+        with:
+          name: rgbds-canary-mingw-win${{ matrix.bits }}
+          path: bins
+
+  windows-xtesting:
+    needs: windows-xbuild
+    strategy:
+      matrix:
+        bits: [32, 64]
+      fail-fast: false
+    runs-on: windows-2019
+    steps:
+      - uses: actions/checkout@v2
+      - name: Retrieve binaries
+        uses: actions/download-artifact@v1
+        with:
+          name: rgbds-canary-mingw-win${{ matrix.bits }}
+          path: bins
+      - name: Extract binaries
+        shell: bash
+        run: |
+          cp bins/* .
+      - name: Run tests
+        shell: bash
+        run: |
+          test/run-tests.sh

.github/workflows/update-master-docs.yml

@@ -0,0 +1,66 @@
+name: "Update master docs"
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - .github/actions/get-pages.sh
+      - src/gbz80.7
+      - src/rgbds.5
+      - src/rgbds.7
+      - src/asm/rgbasm.1
+      - src/asm/rgbasm.5
+      - src/link/rgblink.1
+      - src/link/rgblink.5
+      - src/fix/rgbfix.1
+      - src/gfx/rgbgfx.1
+
+jobs:
+  build:
+    if: github.repository_owner == 'gbdev'
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout rgbds@master
+        uses: actions/checkout@v2
+        with:
+          repository: gbdev/rgbds
+          ref: master
+          path: rgbds
+      - name: Checkout rgbds-www@master
+        uses: actions/checkout@v2
+        with:
+          repository: gbdev/rgbds-www
+          ref: master
+          path: rgbds-www
+      - name: Build and install mandoc + install groff
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get install -yq groff zlib1g-dev
+          wget 'http://mandoc.bsd.lv/snapshots/mandoc-1.14.5.tar.gz'
+          tar xf mandoc-1.14.5.tar.gz
+          cd mandoc-1.14.5
+          ./configure
+          make
+          sudo make install
+      - name: Update pages
+        working-directory: rgbds
+        run: |
+          ./.github/actions/get-pages.sh ../rgbds-www master
+      - name: Push new pages
+        working-directory: rgbds-www
+        run: |
+          mkdir -p -m 700 ~/.ssh
+          echo "${{ secrets.SSH_KEY_SECRET }}" > ~/.ssh/id_ed25519
+          chmod 0600 ~/.ssh/id_ed25519
+          eval $(ssh-agent -s)
+          ssh-add ~/.ssh/id_ed25519
+          git config --global user.name "GitHub Action"
+          git config --global user.email "[email protected]"
+          git add .
+          git commit -m "Update RGBDS master documentation"
+          if git remote | grep -q origin; then
+            git remote set-url origin [email protected]:gbdev/rgbds-www.git
+          else
+            git remote add origin [email protected]:gbdev/rgbds-www.git
+          fi
+          git push origin master

.gitignore

@@ -1,11 +1,12 @@
-rgbasm
-rgblink
-rgbfix
-rgbgfx
+/rgbasm
+/rgblink
+/rgbfix
+/rgbgfx
+/rgbshim.sh
 *.o
 *.exe
+*.dll
 .checkpatch-camelcase.*
-
-test/pokecrystal
-test/pokered
-test/ucity
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake

.travis-checkpatch.sh

@@ -1,45 +0,0 @@
-#!/bin/bash
-
-echo "Checking code style..."
-
-# Return failure as soon as a command fails to execute
-
-set -e
-
-# Download checkpatch.pl and related files
-
-echo "Getting checkpatch.pl..."
-
-mkdir checkpatchdir
-
-wget https://raw.githubusercontent.com/torvalds/linux/master/scripts/checkpatch.pl
-mv checkpatch.pl checkpatchdir/checkpatch.pl
-chmod +x checkpatchdir/checkpatch.pl
-
-touch checkpatchdir/const_structs.checkpatch
-touch checkpatchdir/spelling.txt
-
-# Run checkpatch.pl on the new commits
-
-echo "Running checkpatch.pl..."
-
-fname=$(mktemp)
-rc=0
-
-make CHECKPATCH=checkpatchdir/checkpatch.pl checkpatch > $fname
-
-cat $fname
-
-if grep "ERROR" $fname; then
-    # At least one error found
-    echo "Code style errors have been found!"
-    rc=1
-else
-    echo "No code style errors found, your patches are ready!"
-fi
-
-# Cleanup
-
-rm -rf checkpatchdir
-
-exit $rc

.travis-deps.sh

@@ -1,13 +0,0 @@
-#!/bin/sh
-
-if [ $TRAVIS_OS_NAME = "osx" ]; then
-    brew update
-    brew install libpng pkg-config md5sha1sum
-else # linux
-    sudo apt-get -qq update
-    sudo apt-get install -y -q bison flex libpng-dev pkg-config
-fi
-
-echo "Dependencies:"
-yacc --version
-flex --version

.travis.yml

@@ -1,19 +0,0 @@
-language: c
-sudo: required
-install:
-  - ./.travis-deps.sh
-  - make Q=
-  - sudo make install Q=
-os:
-  - linux
-  - osx
-compiler:
-  - clang
-  - gcc
-script:
-  - cd test && ./run-tests.sh
-matrix:
-  include:
-    - env: _="checkpatch"
-      script:
-        - ./.travis-checkpatch.sh

CMakeLists.txt

@@ -0,0 +1,99 @@
+#
+# This file is part of RGBDS.
+#
+# Copyright (c) 2020 RGBDS contributors.
+#
+# SPDX-License-Identifier: MIT
+#
+
+# 3.9 required for LTO checks
+cmake_minimum_required(VERSION 3.9 FATAL_ERROR)
+
+project(rgbds
+        LANGUAGES C)
+
+# get real path of source and binary directories
+get_filename_component(srcdir "${CMAKE_SOURCE_DIR}" REALPATH)
+get_filename_component(bindir "${CMAKE_BINARY_DIR}" REALPATH)
+
+# reject in-source builds, may conflict with Makefile
+if(srcdir STREQUAL bindir)
+  message("RGBDS should not be built in the source directory.")
+  message("Instead, create a separate build directory and specify to CMake the path to the source directory.")
+  message(FATAL_ERROR "Terminating configuration")
+endif()
+
+option(SANITIZERS "Build with sanitizers enabled" OFF) # Ignored on MSVC
+option(MORE_WARNINGS "Turn on more warnings" OFF) # Ignored on MSVC
+
+if(MSVC)
+  # MSVC's standard library triggers warning C5105,
+  # "macro expansion producing 'defined' has undefined behavior"
+  add_compile_options(/std:c11 /W1 /MP /wd5105)
+  add_definitions(/D_CRT_SECURE_NO_WARNINGS)
+else()
+  add_compile_options(-Wall -pedantic)
+  add_definitions(-D_POSIX_C_SOURCE=200809L -D_ISOC11_SOURCE)
+  if(SANITIZERS)
+    set(SAN_FLAGS -fsanitize=shift -fsanitize=integer-divide-by-zero
+                  -fsanitize=unreachable -fsanitize=vla-bound
+                  -fsanitize=signed-integer-overflow -fsanitize=bounds
+                  -fsanitize=object-size -fsanitize=bool -fsanitize=enum
+                  -fsanitize=alignment -fsanitize=null -fsanitize=address)
+    add_compile_options(${SAN_FLAGS})
+    link_libraries(${SAN_FLAGS})
+    # A non-zero optimization level is desired in debug mode, but allow overriding it nonetheless
+    # TODO: this overrides anything previously set... that's a bit sloppy!
+    set(CMAKE_C_FLAGS_DEBUG "-g -Og -fno-omit-frame-pointer -fno-optimize-sibling-calls" CACHE STRING "" FORCE)
+  endif()
+
+  if(MORE_WARNINGS)
+    add_compile_options(-Werror -Wextra
+                        -Walloc-zero -Wcast-align -Wcast-qual -Wduplicated-branches -Wduplicated-cond
+                        -Wfloat-equal -Winline -Wlogical-op -Wnested-externs -Wnull-dereference
+                        -Wold-style-definition -Wshift-overflow=2 -Wstrict-overflow=5
+                        -Wstrict-prototypes -Wstringop-overflow=4 -Wundef -Wuninitialized -Wunused
+                        -Wshadow # TODO: -Wshadow=compatible-local ?
+                        -Wformat=2 -Wformat-overflow=2 -Wformat-truncation=1
+                        -Wno-format-nonliteral # We have a couple of "dynamic" prints
+                        # We do some range checks that are always false on some platforms (GCC, Clang)
+                        -Wno-type-limits -Wno-tautological-constant-out-of-range-compare
+                        -Wvla # MSVC does not support VLAs
+                        -Wno-unknown-warning-option) # Clang shouldn't diagnose unknown warnings
+  endif()
+endif()
+
+# Use versioning consistent with Makefile
+# the git revision is used but uses the fallback in an archive
+
+find_program(GIT git)
+if(GIT)
+  execute_process(COMMAND ${GIT} describe --tags --dirty --always
+                  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+                  OUTPUT_VARIABLE GIT_REV OUTPUT_STRIP_TRAILING_WHITESPACE
+                  ERROR_QUIET)
+  message(STATUS "RGBDS version: ${GIT_REV}")
+else(GIT)
+  message(STATUS "Cannot determine RGBDS version (Git not installed), falling back")
+endif(GIT)
+
+include_directories("${PROJECT_SOURCE_DIR}/include")
+
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD_REQUIRED True)
+
+add_subdirectory(src)
+
+# By default, build in Release mode; Debug mode must be explicitly requested
+# (You may want to augment it with the options above)
+if(CMAKE_BUILD_TYPE STREQUAL "Release")
+  message(CHECK_START "Checking if LTO is supported")
+  include(CheckIPOSupported)
+  check_ipo_supported(RESULT enable_lto)
+  if(enable_lto)
+    message(CHECK_PASS "yes")
+    set_property(TARGET rgbasm rgblink rgbfix rgbgfx PROPERTY INTERPROCEDURAL_OPTIMIZATION ON)
+  else()
+    message(CHECK_FAIL "no")
+  endif()
+endif()

CONTRIBUTING.rst

@@ -1,10 +1,9 @@
 Contributing
 ============
 
-RGBDS was created in the late 90's and has received contributions from several
+RGBDS was created in the late '90s and has received contributions from several
 developers since then. It wouldn't have been possible to get to this point
-without their work and, for that reason, it is always open to the contributions
-of other people.
+without their work, and it is always open to the contributions of other people.
 
 Reporting Bugs
 --------------

CONTRIBUTORS.rst

@@ -19,6 +19,10 @@ Main contributors
 
 - Antonio Niño Díaz <[email protected]>
 
+- Eldred "ISSOtm" Habert <[email protected]>
+
+- Rangi <http://github.com/Rangi42>
+
 Other contributors
 ------------------
 
@@ -30,7 +34,9 @@ Other contributors
 
 - David Brotz <[email protected]>
 
-- Eldred Habert <[email protected]>
+- Jakub Kądziołka <[email protected]>
+
+- James "JL2210" Larrowe <https://github.com/JL2210>
 
 - The Musl C library <http://www.musl-libc.org>
 

Dockerfile

@@ -7,8 +7,7 @@
 FROM alpine:latest
 RUN apk add --update \
       build-base \
-      byacc \
-      flex \
+      bison \
       libpng-dev
 COPY . /rgbds
 WORKDIR /rgbds

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+Copyright (c) 1997-2020, Carsten Sorensen and RGBDS contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

Makefile

@@ -7,132 +7,147 @@
 #
 
 .SUFFIXES:
-.SUFFIXES: .h .l .y .c .o
+.SUFFIXES: .h .y .c .o
 
 # User-defined variables
 
 Q		:= @
 PREFIX		:= /usr/local
 bindir		:= ${PREFIX}/bin
-mandir		:= ${PREFIX}/man
+mandir		:= ${PREFIX}/share/man
 STRIP		:= -s
-BINMODE		:= 555
-MANMODE		:= 444
+BINMODE		:= 755
+MANMODE		:= 644
 CHECKPATCH	:= ../linux/scripts/checkpatch.pl
 
 # Other variables
 
 PKG_CONFIG	:= pkg-config
-PNGCFLAGS	:= `${PKG_CONFIG} --static --cflags libpng`
-PNGLDFLAGS	:= `${PKG_CONFIG} --static --libs-only-L libpng`
-PNGLDLIBS	:= `${PKG_CONFIG} --static --libs-only-l libpng`
+PNGCFLAGS	:= `${PKG_CONFIG} --cflags libpng`
+PNGLDFLAGS	:= `${PKG_CONFIG} --libs-only-L libpng`
+PNGLDLIBS	:= `${PKG_CONFIG} --libs-only-l libpng`
 
+# Note: if this comes up empty, `version.c` will automatically fall back to last release number
 VERSION_STRING	:= `git describe --tags --dirty --always 2>/dev/null`
 
-WARNFLAGS	:= -Wall
+WARNFLAGS	:= -Wall -pedantic
 
 # Overridable CFLAGS
-CFLAGS		:= -g
+CFLAGS		?= -O3 -flto -DNDEBUG
 # Non-overridable CFLAGS
-REALCFLAGS	:= ${CFLAGS} ${WARNFLAGS} -std=c99 -D_POSIX_C_SOURCE=200809L \
-		   -Iinclude -DBUILD_VERSION_STRING=\"${VERSION_STRING}\"
+# _ISOC11_SOURCE is required on certain platforms to get C11 on top of the C99-based POSIX 2008
+REALCFLAGS	:= ${CFLAGS} ${WARNFLAGS} -std=gnu11 -I include \
+		   -D_POSIX_C_SOURCE=200809L -D_ISOC11_SOURCE
 # Overridable LDFLAGS
-LDFLAGS		:=
+LDFLAGS		?=
 # Non-overridable LDFLAGS
-REALLDFLAGS	:= ${LDFLAGS} ${WARNFLAGS}
+REALLDFLAGS	:= ${LDFLAGS} ${WARNFLAGS} \
+		   -DBUILD_VERSION_STRING=\"${VERSION_STRING}\"
 
-YFLAGS		:=
-LFLAGS		:= --nounistd
+YFLAGS		?= -Wall
 
-YACC		:= yacc
-LEX		:= flex
+BISON		:= bison
 RM		:= rm -rf
 
+# Used for checking pull requests
+BASE_REF	:= origin/master
+
 # Rules to build the RGBDS binaries
 
 all: rgbasm rgblink rgbfix rgbgfx
 
 rgbasm_obj := \
-	src/asm/asmy.o \
 	src/asm/charmap.o \
-	src/asm/constexpr.o \
+	src/asm/fixpoint.o \
+	src/asm/format.o \
 	src/asm/fstack.o \
-	src/asm/globlex.o \
 	src/asm/lexer.o \
+	src/asm/macro.o \
 	src/asm/main.o \
-	src/asm/math.o \
+	src/asm/opt.o \
 	src/asm/output.o \
+	src/asm/parser.o \
 	src/asm/rpn.o \
+	src/asm/section.o \
 	src/asm/symbol.o \
 	src/asm/util.o \
-	src/extern/err.o \
+	src/asm/warning.o \
+	src/extern/getopt.o \
 	src/extern/utf8decoder.o \
-	src/version.o
+	src/error.o \
+	src/hashmap.o \
+	src/linkdefs.o \
+	src/opmath.o
 
-src/asm/globlex.o src/asm/lexer.o src/asm/constexpr.o: src/asm/asmy.h
+src/asm/lexer.o src/asm/main.o: src/asm/parser.h
 
 rgblink_obj := \
 	src/link/assign.o \
-	src/link/lexer.o \
-	src/link/library.o \
 	src/link/main.o \
-	src/link/mapfile.o \
 	src/link/object.o \
 	src/link/output.o \
 	src/link/patch.o \
-	src/link/parser.o \
 	src/link/script.o \
+	src/link/section.o \
 	src/link/symbol.o \
-	src/extern/err.o \
-	src/version.o
-
-src/link/lexer.o: src/link/parser.h
+	src/extern/getopt.o \
+	src/error.o \
+	src/hashmap.o \
+	src/linkdefs.o \
+	src/opmath.o
 
 rgbfix_obj := \
 	src/fix/main.o \
-	src/extern/err.o \
-	src/version.o
+	src/extern/getopt.o \
+	src/error.o
 
 rgbgfx_obj := \
 	src/gfx/gb.o \
 	src/gfx/main.o \
 	src/gfx/makepng.o \
-	src/extern/err.o \
-	src/version.o
+	src/extern/getopt.o \
+	src/error.o
 
 rgbasm: ${rgbasm_obj}
-	$Q${CC} ${REALLDFLAGS} -o $@ ${rgbasm_obj} -lm
+	$Q${CC} ${REALLDFLAGS} -o $@ ${rgbasm_obj} ${REALCFLAGS} src/version.c -lm
 
 rgblink: ${rgblink_obj}
-	$Q${CC} ${REALLDFLAGS} -o $@ ${rgblink_obj}
+	$Q${CC} ${REALLDFLAGS} -o $@ ${rgblink_obj} ${REALCFLAGS} src/version.c
 
 rgbfix: ${rgbfix_obj}
-	$Q${CC} ${REALLDFLAGS} -o $@ ${rgbfix_obj}
+	$Q${CC} ${REALLDFLAGS} -o $@ ${rgbfix_obj} ${REALCFLAGS} src/version.c
 
 rgbgfx: ${rgbgfx_obj}
-	$Q${CC} ${REALLDFLAGS} ${PNGLDFLAGS} -o $@ ${rgbgfx_obj} ${PNGLDLIBS}
+	$Q${CC} ${REALLDFLAGS} ${PNGLDFLAGS} -o $@ ${rgbgfx_obj} ${REALCFLAGS} src/version.c ${PNGLDLIBS}
 
 # Rules to process files
 
-# We want the yacc and lex invocations to pass through our rules
+# We want the Bison invocation to pass through our rules, not default ones
 .y.o:
-.l.o:
 
-# yacc- and lex-generated C files have an accompanying header
-.c.h:
+# Bison-generated C files have an accompanying header
+src/asm/parser.h: src/asm/parser.c
 	$Qtouch $@
 
-.y.c:
-	$Q${YACC} -d ${YFLAGS} -o $@ $<
-
-.l.c:
-	$Q${LEX} ${LFLAGS} -o $@ $<
+src/asm/parser.c: src/asm/parser.y
+	$QDEFS=; \
+	add_flag(){ \
+		if src/check_bison_ver.sh $$1 $$2; then \
+			DEFS="-D$$3 $$DEFS"; \
+		fi \
+	}; \
+	add_flag 3 5 api.token.raw=true; \
+	add_flag 3 6 parse.error=detailed; \
+	add_flag 3 0 parse.error=verbose; \
+	add_flag 3 0 parse.lac=full; \
+	add_flag 3 0 lr.type=ielr; \
+	echo "DEFS=$$DEFS"; \
+	${BISON} $$DEFS -d ${YFLAGS} -o $@ $<
 
 .c.o:
 	$Q${CC} ${REALCFLAGS} ${PNGCFLAGS} -c -o $@ $<
 
-# Target used to remove all files generated by other Makefile targets, except
-# for the html documentation.
+# Target used to remove all files generated by other Makefile targets
 
 clean:
 	$Q${RM} rgbasm rgbasm.exe
@@ -140,17 +155,8 @@ clean:
 	$Q${RM} rgbfix rgbfix.exe
 	$Q${RM} rgbgfx rgbgfx.exe
 	$Qfind src/ -name "*.o" -exec rm {} \;
-	$Q${RM} src/asm/asmy.c src/asm/asmy.h
-	$Q${RM} src/link/lexer.c src/link/parser.c src/link/parser.h
-
-# Target used to remove all html files generated by the wwwman target
-
-cleanwwwman:
-	$Q${RM} docs/rgbds.7.html docs/gbz80.7.html docs/rgbds.5.html
-	$Q${RM} docs/rgbasm.1.html docs/rgbasm.5.html
-	$Q${RM} docs/rgblink.1.html docs/rgblink.5.html
-	$Q${RM} docs/rgbfix.1.html
-	$Q${RM} docs/rgbgfx.1.html
+	$Q${RM} rgbshim.sh
+	$Q${RM} src/asm/parser.c src/asm/parser.h
 
 # Target used to install the binaries and man pages.
 
@@ -171,61 +177,59 @@ install: all
 	$Qinstall -m ${MANMODE} src/link/rgblink.5 ${DESTDIR}${mandir}/man5/rgblink.5
 	$Qinstall -m ${MANMODE} src/gfx/rgbgfx.1 ${DESTDIR}${mandir}/man1/rgbgfx.1
 
-# Target used to check the coding style of the whole codebase. '.y' and '.l'
-# files aren't checked, unfortunately...
+# Target used to check the coding style of the whole codebase.
+# `extern/` is excluded, as it contains external code that should not be patched
+# to meet our coding style, so applying upstream patches is easier.
+# `.y` files aren't checked, unfortunately...
 
 checkcodebase:
-	$Qfor file in `git ls-files | grep -E '\.c|\.h' | grep -v '\.html'`; do	\
+	$Qfor file in `git ls-files | grep -E '(\.c|\.h)$$' | grep -Ev '(src|include)/extern/'`; do	\
 		${CHECKPATCH} -f "$$file";					\
 	done
 
 # Target used to check the coding style of the patches from the upstream branch
 # to the HEAD. Runs checkpatch once for each commit between the current HEAD and
-# the first common commit between the HEAD and origin/master. '.y' and '.l'
-# files aren't checked, unfortunately...
+# the first common commit between the HEAD and origin/master.
+# `.y` files aren't checked, unfortunately...
 
 checkpatch:
-	$Qeval COMMON_COMMIT=$$(git merge-base HEAD origin/master);	\
+	$QCOMMON_COMMIT=`git merge-base HEAD ${BASE_REF}`;		\
 	for commit in `git rev-list $$COMMON_COMMIT..HEAD`; do		\
 		echo "[*] Analyzing commit '$$commit'";			\
 		git format-patch --stdout "$$commit~..$$commit"		\
+			-- src include '!src/extern' '!include/extern'	\
 			| ${CHECKPATCH} - || true;			\
 	done
 
-# Target for the project maintainer to easily create web manuals.
-# It relies on mandoc: http://mdocml.bsd.lv
+# Target used to check for suspiciously missing changed files.
 
-MANDOC	:= -Thtml -Ios=General -Oman=%N.%S.html -Ostyle=mandoc.css
-
-wwwman:
-	$Qmandoc ${MANDOC} src/rgbds.7 > docs/rgbds.7.html
-	$Qmandoc ${MANDOC} src/gbz80.7 > docs/gbz80.7.html
-	$Qmandoc ${MANDOC} src/rgbds.5 > docs/rgbds.5.html
-	$Qmandoc ${MANDOC} src/asm/rgbasm.1 > docs/rgbasm.1.html
-	$Qmandoc ${MANDOC} src/asm/rgbasm.5 > docs/rgbasm.5.html
-	$Qmandoc ${MANDOC} src/fix/rgbfix.1 > docs/rgbfix.1.html
-	$Qmandoc ${MANDOC} src/link/rgblink.1 > docs/rgblink.1.html
-	$Qmandoc ${MANDOC} src/link/rgblink.5 > docs/rgblink.5.html
-	$Qmandoc ${MANDOC} src/gfx/rgbgfx.1 > docs/rgbgfx.1.html
+checkdiff:
+	$Qcontrib/checkdiff.bash `git merge-base HEAD ${BASE_REF}`
 
 # This target is used during development in order to prevent adding new issues
 # to the source code. All warnings are treated as errors in order to block the
 # compilation and make the continous integration infrastructure return failure.
+# The rationale for some of the flags is documented in the CMakeLists.
 
 develop:
-	$Qenv make -j WARNFLAGS="-Werror -Wall -Wextra -Wpedantic \
-		-Wno-sign-compare -Wformat=2 -Wformat-overflow=2 \
-		-Wformat-truncation=1 -Wformat-y2k -Wswitch-enum -Wunused \
-		-Wuninitialized -Wunknown-pragmas -Wstrict-overflow=5 \
-		-Wstringop-overflow=4 -Walloc-zero -Wduplicated-cond \
-		-Wfloat-equal -Wshadow -Wcast-qual -Wcast-align -Wlogical-op \
-		-Wnested-externs -Wno-aggressive-loop-optimizations -Winline \
-		-Wundef -Wstrict-prototypes -Wold-style-definition \
+	$Qenv ${MAKE} WARNFLAGS="-Werror -Wextra \
+		-Walloc-zero -Wcast-align -Wcast-qual -Wduplicated-branches -Wduplicated-cond \
+		-Wfloat-equal -Winline -Wlogical-op -Wnested-externs -Wold-style-definition \
+		-Wshift-overflow=2 \
+		-Wstrict-overflow=5 -Wstrict-prototypes -Wundef -Wuninitialized -Wunused \
+		-Wshadow \
+		-Wnull-dereference -Wstringop-overflow=4 \
+		-Wformat=2 -Wformat-overflow=2 -Wformat-truncation=1 \
+		-Wno-format-nonliteral \
+		-Wno-type-limits -Wno-tautological-constant-out-of-range-compare \
+		-Wvla \
+		-Wno-unknown-warning-option \
 		-fsanitize=shift -fsanitize=integer-divide-by-zero \
 		-fsanitize=unreachable -fsanitize=vla-bound \
 		-fsanitize=signed-integer-overflow -fsanitize=bounds \
 		-fsanitize=object-size -fsanitize=bool -fsanitize=enum \
-		-fsanitize=alignment -fsanitize=null"
+		-fsanitize=alignment -fsanitize=null -fsanitize=address" \
+		CFLAGS="-ggdb3 -Og -fno-omit-frame-pointer -fno-optimize-sibling-calls"
 
 # Targets for the project maintainer to easily create Windows exes.
 # This is not for Windows users!
@@ -233,17 +237,25 @@ develop:
 # install instructions instead.
 
 mingw32:
-	$Qenv PKG_CONFIG_PATH=/usr/i686-w64-mingw32/sys-root/mingw/lib/pkgconfig/ \
-		make CC=i686-w64-mingw32-gcc YACC=bison -j
-	$Qmv rgbasm rgbasm.exe
-	$Qmv rgblink rgblink.exe
-	$Qmv rgbfix rgbfix.exe
-	$Qmv rgbgfx rgbgfx.exe
+	$Q${MAKE} CC=i686-w64-mingw32-gcc BISON=bison \
+		PKG_CONFIG=i686-w64-mingw32-pkg-config -j
 
 mingw64:
-	$Qenv PKG_CONFIG_PATH=/usr/x86_64-w64-mingw32/sys-root/mingw/lib/pkgconfig/ \
-		make CC=x86_64-w64-mingw32-gcc YACC=bison -j
-	$Qmv rgbasm rgbasm.exe
-	$Qmv rgblink rgblink.exe
-	$Qmv rgbfix rgbfix.exe
-	$Qmv rgbgfx rgbgfx.exe
+	$Q${MAKE} CC=x86_64-w64-mingw32-gcc BISON=bison \
+		PKG_CONFIG=x86_64-w64-mingw32-pkg-config -j
+
+wine-shim:
+	$Qecho '#!/bin/bash' > rgbshim.sh
+	$Qecho 'WINEDEBUG=-all wine $$0.exe "$${@:1}"' >> rgbshim.sh
+	$Qchmod +x rgbshim.sh
+	$Qln -s rgbshim.sh rgbasm
+	$Qln -s rgbshim.sh rgblink
+	$Qln -s rgbshim.sh rgbfix
+	$Qln -s rgbshim.sh rgbgfx
+
+# Target for the project maintainer to produce distributable release tarballs
+# of the source code.
+
+dist:
+	$Qgit ls-files | sed s~^~$${PWD##*/}/~ \
+	  | tar -czf rgbds-`git describe --tags | cut -c 2-`.tar.gz -C .. -T -

README.rst

@@ -15,160 +15,100 @@ other UNIX tools.
 This toolchain is maintained on `GitHub <https://github.com/rednex/rgbds>`__.
 
 The documentation of this toolchain can be viewed online
-`here <https://rednex.github.io/rgbds/>`__, it is generated from the man pages
+`here <https://rgbds.gbdev.io/docs/>`__, it is generated from the man pages
 found in this repository.
 
+If you want to contribute or maintain RGBDS, and have questions regarding the code, its organisation, etc. you can find me `on GBDev <https://gbdev.io/chat>`__ or via mail at ``rgbds at eldred dot fr``.
+
 1. Installing RGBDS
 -------------------
 
-1.1 Windows
-~~~~~~~~~~~
-
-Windows builds are available in the releases page on GitHub
-`here <https://github.com/rednex/rgbds/releases>`__.
-
-Extract the zip and then add the executable directory to the path. For example:
-
-::
-
-    path %PATH%;C:\Programs\rgbds-0.3.8-win64\win64
-
-Alternatively, the RGBDS executables can be simply dropped in the folder of the project they're used in.
-
-If you require the latest version in development, it should be possible to
-compile RGBDS with MinGW or Cygwin by following the instructions to build it on
-UNIX systems.
-
-1.2 macOS
-~~~~~~~~~
-
-You can build RGBDS by following the instructions below. However, if you would
-prefer not to build RGBDS yourself, you may also install it using
-`Homebrew <http://brew.sh/>`__.
-
-To install the latest release, use:
-
-.. code:: sh
-
-    brew install rgbds
-
-To install RGBDS with all of the current changes in development (as seen on the
-``master`` branch on GitHub), use:
-
-.. code:: sh
-
-    brew install rgbds --HEAD
-    
-1.3 Arch Linux
-~~~~~~~~~~~~~~
-
-To install RGBDS through the AUR run
-
-.. code:: sh
-
-    yaourt -S rgbds
-
-1.4 Other UNIX-like systems
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-No official binaries of RGBDS are distributed for these systems, you must follow
-the simple instructions below to compile and install it.
-
-2. Building RGBDS from source
------------------------------
-
-RGBDS can be built in UNIX-like systems by following the instructions below.
-
-2.1 Dependencies
-~~~~~~~~~~~~~~~~
-
-RGBDS requires yacc, flex, libpng and pkg-config to be installed.
-
-On macOS, install the latter two with `Homebrew <http://brew.sh/>`__:
-
-.. code:: sh
-
-    brew install libpng pkg-config
-
-On other Unixes, use the built-in package manager. For example, on Debian or
-Ubuntu:
-
-.. code:: sh
-
-    sudo apt-get install byacc flex pkg-config libpng-dev
-
-You can test if libpng and pkg-config are installed by running ``pkg-config
---cflags libpng``: if the output is a path, then you're good, and if it outputs
-an error then you need to install them via a package manager.
-
-2.2 Build process
-~~~~~~~~~~~~~~~~~
-
-To build the programs, run in your terminal:
+The `installation procedure <https://rgbds.gbdev.io/install>`__ is available
+online for various platforms. `Building from source <https://rgbds.gbdev.io/install/source>`__
+is possible using ``make`` or ``cmake``; follow the link for more detailed instructions.
 
 .. code:: sh
 
     make
-
-Then, to install the compiled programs and manual pages, run (with appropriate
-privileges, e.g, with ``sudo``):
+    sudo make install
 
 .. code:: sh
 
-    make install
+    cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+    cmake --build build
+    cmake --install build
 
-After installation, you can read the manuals with the ``man`` command. E.g.,
+2. RGBDS Folder Organization
+----------------------------
 
-.. code:: sh
+The RGBDS source code file structure somewhat resembles the following:
 
-    man 7 rgbds
+::
 
-There are some variables in the Makefile that can be redefined by the user. The
-variables described below can affect installation behavior when given on the
-make command line. For example, to install RGBDS in your home directory instead
-of systemwide, run the following:
+       .
+       ├── .github/
+       │   ├── actions/
+       │   │   └── ...
+       │   └── workflows/
+       │       └── ...
+       ├── contrib/
+       │   ├── zsh_compl/
+       │   │   └── ...
+       │   └── ...
+       ├── include/
+       │   └── ...
+       ├── src/
+       │   ├── asm/
+       │   │   └── ...
+       │   ├── extern/
+       │   │   └── ...
+       │   ├── fix/
+       │   │   └── ...
+       │   ├── gfx/
+       │   │   └── ...
+       │   ├── link/
+       │   │   └── ...
+       │   ├── CMakeLists.txt
+       │   └── ...
+       ├── test/
+       │   ├── ...
+       │   └── run-tests.sh
+       ├── .clang-format
+       ├── CMakeLists.txt
+       ├── Makefile
+       └── README.rst
 
-.. code:: sh
+.. |clang-format| replace:: ``clang-format``
+.. _clang-format: https://clang.llvm.org/docs/ClangFormat.html
 
-    make install PREFIX=$HOME
+- ``.github/`` - files and scripts related to the integration of the RGBDS codebase with
+  GitHub.
 
-To do a verbose build, run:
+  * ``actions/`` - scripts used by workflow files.
+  * ``workflows/`` - CI workflow description files.
 
-.. code:: sh
+- ``contrib/`` - scripts and other resources which may be useful to users and developers of
+  RGBDS.
 
-    make Q=
+  * ``zsh_compl`` contains tab completion scripts for use with zsh. Put them somewhere in your ``fpath``, and they should auto-load.
 
-This is the complete list of user-defined variables:
+  * ``bash_compl`` contains tab completion scripts for use with bash. Run them with ``source`` somewhere in your ``.bashrc``, and they should load every time you open a shell.
 
-- ``PREFIX``: Location where RGBDS will be installed. Defaults to
-  ``/usr/local``.
+- ``include/`` - header files for each respective C files in `src`.
 
-- ``bindir``: Location where the binaries will be installed. Defaults to
-  ``${PREFIX}/bin``.
+- ``src/`` - source code and manual pages for RGBDS.
 
-- ``mandir``: Location where the manpages will be installed. Defaults to
-  ``${PREFIX}/man``.
+  * Note that the code unique to each RGBDS tool is stored in its respective subdirectory
+    (rgbasm -> ``src/asm/``, for example). ``src/extern/`` contains code imported from external sources.
 
-- ``DESTDIR``: This is prepended to all paths during the installation. It is
-  mainly used for packaging.
+- ``test/`` - testing framework used to verify that changes to the code don't break or modify the behavior of RGBDS.
 
-- ``Q``: Whether to quiet the build or not. To make the build more verbose,
-  clear this variable. Defaults to ``@``.
+- ``.clang-format`` - code style for automated formatting with |clang-format|_. The C code does not currently follow this style, but all C++ code should.
 
-- ``STRIP``: Whether to strip the installed binaries of debug symbols or not.
-  Defaults to ``-s``.
+3. History
+----------
 
-- ``BINMODE``: Permissions of the installed binaries. Defaults to ``555``.
-
-- ``MANMODE``: Permissions of the installed manpages. Defaults to ``444``.
-
-- ``CHECKPATCH``: Path of the script ``checkpatch.pl`` of the Linux kernel.
-  Defaults to ``../linux/scripts/checkpatch.pl``.
-
-3 History
----------
-
-- Around 1997, Carsten Sorensen (AKA SurfSmurf) writes ASMotor as a
+- Around 1997, Carsten Sørensen (AKA SurfSmurf) writes ASMotor as a
   general-purpose assembler/linker system for DOS/Win32
 
 - Around 1999, Justin Lloyd (AKA Otaku no Zoku) adapts ASMotor to read and
@@ -184,3 +124,5 @@ This is the complete list of user-defined variables:
 - 2017, Bentley's repository is moved to a neutral name.
 
 - 2018, codebase relicensed under the MIT license.
+
+- 2020, repository is moved to the `gbdev <https://github.com/gbdev>`__ organisation. The `rgbds.gbdev.io <https://rgbds.gbdev.io>`__ website serving documentation and downloads is created.

RELEASE.rst

@@ -0,0 +1,67 @@
+Releasing
+=========
+
+This describes for the maintainers of RGBDS how to publish a new release on
+GitHub.
+
+1. Update, commit, and push `include/version.h <include/version.h>`__ with
+   values for ``PACKAGE_VERSION_MAJOR``, ``PACKAGE_VERSION_MINOR``,
+   ``PACKAGE_VERSION_PATCH``, and ``PACKAGE_VERSION_RC``. Only define
+   ``PACKAGE_VERSION_RC`` if you are publishing a release candidate! You can
+   use ``git commit -m "Release <version>"`` and ``git push origin master``.
+
+2. Create a Git tag formatted as ``v<MAJOR>.<MINOR>.<PATCH>``, or
+   ``v<MAJOR>.<MINOR>.<PATCH>-rc<RC>`` for a release candidate. ``MAJOR``,
+   ``MINOR``, ``PATCH``, and ``RC`` should match their values from
+   `include/version.h <include/version.h>`__. You can use ``git tag <tag>``.
+
+3. Push the tag to GitHub. You can use ``git push origin <tag>``.
+
+   GitHub Actions will run the `create-release-artifacts.yaml
+   <.github/workflows/create-release-artifacts.yaml>`__ workflow to detect the
+   tag starting with "``v[0-9]``" and automatically do the following:
+
+   1. Build 32-bit and 64-bit RGBDS binaries for Windows with ``cmake``.
+
+   2. Package the binaries into zip files.
+
+   3. Package the source code into a tar.gz file with ``make dist``.
+
+   4. Create a draft GitHub release for the tag, attaching the three
+      packaged files. It will be a prerelease if the tag contains "``-rc``".
+
+      If an error occurred in the above steps, delete the tag and restart the
+      procedure. You can use ``git push --delete origin <tag>`` and
+      ``git tag --delete <tag>``.
+
+4. GitHub Actions will run the `create-release-docs.yml
+   <.github/workflows/create-release-docs.yml>`__ workflow to add the release
+   documentation to `rgbds-www <https://github.com/gbdev/rgbds-www>`__.
+
+   For a release candidate, which creates a prerelease, you will have to
+   take these steps yourself.
+
+   1. Clone `rgbds-www <https://github.com/gbdev/rgbds-www>`__. You can use
+      ``git clone https://github.com/gbdev/rgbds-www.git``.
+
+   2. Make sure that you have installed ``groff`` and ``mandoc``. You will
+      need ``mandoc`` 1.14.5 or later to support ``-O toc``.
+
+   3. Run ``.github/actions/get-pages.sh -r <path/to/rgbds-www> <tag>``. This
+      will render the RGBDS documentation as HTML and PDF and copy it to
+      ``rgbds-www``.
+
+      If you do not have ``groff`` installed, you can change
+      ``groff -Tpdf -mdoc -wall`` to ``mandoc -Tpdf -I os=Linux`` in
+      `.github/actions/get-pages.sh <.github/actions/get-pages.sh>`__ and it
+      will suffice.
+
+   4. Commit and push the documentation. You can use ``git commit -m
+      "Create RGBDS <tag> documentation"`` and ``git push origin master``
+      (within the ``rgbds-www`` directory, not RGBDS).
+
+5. Write a changelog in the GitHub draft release.
+
+6. Click the "Publish release" button to publish it!
+
+7. Update the `release` branch. You can use ``git push origin release``.

contrib/bash_compl/_rgbasm.bash

@@ -0,0 +1,215 @@
+#/usr/bin/env bash
+
+# Known bugs:
+# - Newlines in file/directory names break this script
+#   This is because we rely on `compgen -A`, which is broken like this.
+#   A fix would require implementing it ourselves, and no thanks!
+# - `rgbasm --binary-digits=a` is treated the same as `rgbasm --binary-digits=` (for example)
+#   This is not our fault, Bash passes both of these identically.
+#   Maybe it could be worked around, but such a fix would likely be involved.
+#   The user can work around it by typing `--binary-digits ''` instead, for example.
+# - Directories are not completed as such in "coalesced" short-opt arguments. For example,
+#   `rgbasm -M d<tab>` can autocomplete to `rgbasm -M dir/` (no space), but
+#   `rgbasm -Md<tab>` would autocomplete to `rgbasm -Mdir ` (trailing space) instead.
+#   This is because dircetory handling is performed by Readline, whom we can't tell about the short
+#   opt kerfuffle. The user can work around by separating the argument, as shown above.
+#   (Also, there might be more possible bugs if `-Mdir` is actually a directory. Ugh.)
+
+# Something to note:
+# `rgbasm --binary-digits=a` gets passed to us as ('rgbasm' '--binary-digits' '=' 'a')
+# Thus, we don't need to do much to handle that form of argument passing: skip '=' after long opts.
+
+_rgbasm_completions() {
+	COMPREPLY=()
+
+	# Format: "long_opt:state_after"
+	# Empty long opt = it doesn't exit
+	# See the `state` variable below for info about `state_after`
+	declare -A opts=(
+		[V]="version:normal"
+		[E]="export-all:normal"
+		[h]="halt-without-nop:normal"
+		[L]="preserve-ld:normal"
+		[v]="verbose:normal"
+		[w]=":normal"
+		[b]="binary-digits:unk"
+		[D]="define:unk"
+		[g]="gfx-chars:unk"
+		[i]="include:dir"
+		[M]="dependfile:glob-*.mk *.d"
+		[o]="output:glob-*.o"
+		[p]="pad-value:unk"
+		[r]="recursion-depth:unk"
+		[W]="warning:warning"
+	)
+	# Parse command-line up to current word
+	local opt_ena=true
+	# Possible states:
+	# - normal  = Well, normal. Options are parsed normally.
+	# - unk     = An argument that can't be completed, and should just be skipped.
+	# - warning = A warning flag.
+	# - dir     = A directory path
+	# - glob-*  = A glob, after the dash is a whitespace-separated list of file globs to use
+	local state=normal
+	# The length of the option, used as a return value by the function below
+	local optlen=0
+	# $1: a short option word
+	# `state` will be set to the parsing state after the last option character in the word. If
+	# "normal" is not returned, `optlen` will be set to the length (dash included) of the "option"
+	# part of the argument.
+	parse_short_opt() {
+		for (( i = 1; i < "${#1}"; i++ )); do
+			# If the option is not known, assume it doesn't take an argument
+			local opt="${opts["${1:$i:1}"]:-":normal"}"
+			state="${opt#*:}"
+			# If the option takes an argument, record the length and exit
+			if [[ "$state" != 'normal' ]]; then
+				let optlen="$i + 1"
+				return
+			fi
+		done
+		optlen=0
+	}
+
+	for (( i = 1; i < $COMP_CWORD; i++ )); do
+		local word="${COMP_WORDS[$i]}"
+
+		# If currently processing an argument, skip this word
+		if [[ "$state" != 'normal' ]]; then
+			state=normal
+			continue
+		fi
+
+		if [[ "$word" = '--' ]]; then
+			# Options stop being parsed after this
+			opt_ena=false
+			break
+		fi
+
+		# Check if it's a long option
+		if [[ "${word:0:2}" = '--' ]]; then
+			# If the option is unknown, assume it takes no arguments: keep the state at "normal"
+			for long_opt in "${opts[@]}"; do
+				if [[ "$word" = "--${long_opt%%:*}" ]]; then
+					state="${long_opt#*:}"
+					# Check if the next word is just '='; if so, skip it, the argument must follow
+					# (See "known bugs" at the top of this script)
+					let i++
+					if [[ "${COMP_WORDS[$i]}" != '=' ]]; then
+						let i--
+					fi
+					optlen=0
+					break
+				fi
+			done
+		# Check if it's a short option
+		elif [[ "${word:0:1}" = '-' ]]; then
+			# The `-M?` ones are a mix of short and long, augh
+			# They must match the *full* word, but only take a single dash
+			# So, handle them here
+			if [[ "$1" = "-M"[GP] ]]; then
+				state=normal
+			elif [[ "$1" = "-M"[TQ] ]]; then
+				state='glob-*.d *.mk *.o'
+			else
+				parse_short_opt "$word"
+				# The last option takes an argument...
+				if [[ "$state" != 'normal' ]]; then
+					if [[ "$optlen" -ne "${#word}" ]]; then
+						# If it's contained within the word, we won't complete it, revert to "normal"
+						state=normal
+					else
+						# Otherwise, complete it, but start at the beginning of *that* word
+						optlen=0
+					fi
+				fi
+			fi
+		fi
+	done
+
+	# Parse current word
+	# Careful that it might look like an option, so use `--` aggressively!
+	local cur_word="${COMP_WORDS[$COMP_CWORD]}"
+
+	# Process options, as short ones may change the state
+	if $opt_ena && [[ "$state" = 'normal' && "${cur_word:0:1}" = '-' ]]; then
+		# We might want to complete to an option or an arg to that option
+		# Parse the option word to check
+		# There's no whitespace in the option names, so we can ride a little dirty...
+
+		# Is this a long option?
+		if [[ "${cur_word:1:1}" = '-' ]]; then
+			# It is, try to complete one
+			COMPREPLY+=( $(compgen -W "${opts[*]%%:*}" -P '--' -- "${cur_word#--}") )
+			return 0
+		else
+			# Short options may be grouped, parse them to determine what to complete
+			# The `-M?` ones may not be followed by anything
+			if [[ "$1" != "-M"[GPTQ] ]]; then
+				parse_short_opt "$cur_word"
+				# We got some short options that behave like long ones
+				COMPREPLY+=( $(compgen -W '-MG -MP -MT -MQ' -- "$cur_word") )
+
+				if [[ "$state" = 'normal' ]]; then
+					COMPREPLY+=( $(compgen -W "${!opts[*]}" -P "$cur_word" '') )
+					return 0
+				elif [[ "$optlen" = "${#cur_word}" && "$state" != "warning" ]]; then
+					# This short option group only awaits its argument!
+					# Post the option group as-is as a reply so that Readline inserts a space,
+					# so that the next completion request switches to the argument
+					# An exception is made for warnings, since it's idiomatic to stick them to the
+					# `-W`, and it doesn't break anything.
+					COMPREPLY+=( "$cur_word" )
+					return 0
+				fi
+			fi
+		fi
+	fi
+
+	case "$state" in
+		unk) # Return with no replies: no idea what to complete!
+			;;
+		warning)
+			COMPREPLY+=( $(compgen -W "
+				assert
+				backwards-for
+				builtin-args
+				charmap-redef
+				div
+				empty-data-directive
+				empty-macro-arg
+				empty-strrpl
+				large-constant
+				long-string
+				macro-shift
+				nested-comment
+				numeric-string
+				obsolete
+				shift
+				shift-amount
+				truncation
+				user
+				all
+				extra
+				everything
+				error" -P "${cur_word:0:$optlen}" -- "${cur_word:$optlen}") )
+			;;
+		normal) # Acts like a glob...
+			state="glob-*.asm *.inc *.sm83"
+			;&
+		glob-*)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(for glob in ${state#glob-}; do compgen -A file -X \!"$glob" -- "${cur_word:$optlen}"; done)
+			# Also complete directories
+			;&
+		dir)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(compgen -A directory -- "${cur_word:$optlen}")
+			compopt -o filenames
+			;;
+	esac
+}
+
+complete -F _rgbasm_completions rgbasm

contrib/bash_compl/_rgbfix.bash

@@ -0,0 +1,181 @@
+#/usr/bin/env bash
+
+# Same notes as RGBASM
+
+_rgbfix_completions() {
+	COMPREPLY=()
+
+	# Format: "long_opt:state_after"
+	# Empty long opt = it doesn't exit
+	# See the `state` variable below for info about `state_after`
+	declare -A opts=(
+		[V]="version:normal"
+		[j]="non-japanese:normal"
+		[s]="sgb-compatible:normal"
+		[v]="validate:normal"
+		[C]="color-only:normal"
+		[c]="color-compatible:normal"
+		[f]="fix-spec:fix-spec"
+		[i]="game-id:unk"
+		[k]="new-licensee:unk"
+		[l]="old-licensee:unk"
+		[m]="mbc-type:mbc"
+		[n]="rom-version:unk"
+		[p]="pad-value:unk"
+		[r]="ram-size:unk"
+		[t]="title:unk"
+	)
+	# Parse command-line up to current word
+	local opt_ena=true
+	# Possible states:
+	# - normal  = Well, normal. Options are parsed normally.
+	# - unk     = An argument that can't be completed, and should just be skipped.
+	# - warning = A warning flag.
+	# - dir     = A directory path
+	# - glob-*  = A glob, after the dash is a whitespace-separated list of file globs to use
+	local state=normal
+	# The length of the option, used as a return value by the function below
+	local optlen=0
+	# $1: a short option word
+	# `state` will be set to the parsing state after the last option character in the word. If
+	# "normal" is not returned, `optlen` will be set to the length (dash included) of the "option"
+	# part of the argument.
+	parse_short_opt() {
+		for (( i = 1; i < "${#1}"; i++ )); do
+			# If the option is not known, assume it doesn't take an argument
+			local opt="${opts["${1:$i:1}"]:-":normal"}"
+			state="${opt#*:}"
+			# If the option takes an argument, record the length and exit
+			if [[ "$state" != 'normal' ]]; then
+				let optlen="$i + 1"
+				return
+			fi
+		done
+		optlen=0
+	}
+
+	for (( i = 1; i < $COMP_CWORD; i++ )); do
+		local word="${COMP_WORDS[$i]}"
+
+		# If currently processing an argument, skip this word
+		if [[ "$state" != 'normal' ]]; then
+			state=normal
+			continue
+		fi
+
+		if [[ "$word" = '--' ]]; then
+			# Options stop being parsed after this
+			opt_ena=false
+			break
+		fi
+
+		# Check if it's a long option
+		if [[ "${word:0:2}" = '--' ]]; then
+			# If the option is unknown, assume it takes no arguments: keep the state at "normal"
+			for long_opt in "${opts[@]}"; do
+				if [[ "$word" = "--${long_opt%%:*}" ]]; then
+					state="${long_opt#*:}"
+					# Check if the next word is just '='; if so, skip it, the argument must follow
+					# (See "known bugs" at the top of this script)
+					let i++
+					if [[ "${COMP_WORDS[$i]}" != '=' ]]; then
+						let i--
+					fi
+					optlen=0
+					break
+				fi
+			done
+		# Check if it's a short option
+		elif [[ "${word:0:1}" = '-' ]]; then
+			parse_short_opt "$word"
+			# The last option takes an argument...
+			if [[ "$state" != 'normal' ]]; then
+				if [[ "$optlen" -ne "${#word}" ]]; then
+					# If it's contained within the word, we won't complete it, revert to "normal"
+					state=normal
+				else
+					# Otherwise, complete it, but start at the beginning of *that* word
+					optlen=0
+				fi
+			fi
+		fi
+	done
+
+	# Parse current word
+	# Careful that it might look like an option, so use `--` aggressively!
+	local cur_word="${COMP_WORDS[$COMP_CWORD]}"
+
+	# Process options, as short ones may change the state
+	if $opt_ena && [[ "$state" = 'normal' && "${cur_word:0:1}" = '-' ]]; then
+		# We might want to complete to an option or an arg to that option
+		# Parse the option word to check
+		# There's no whitespace in the option names, so we can ride a little dirty...
+
+		# Is this a long option?
+		if [[ "${cur_word:1:1}" = '-' ]]; then
+			# It is, try to complete one
+			COMPREPLY+=( $(compgen -W "${opts[*]%%:*}" -P '--' -- "${cur_word#--}") )
+			return 0
+		else
+			# Short options may be grouped, parse them to determine what to complete
+			parse_short_opt "$cur_word"
+
+			if [[ "$state" = 'normal' ]]; then
+				COMPREPLY+=( $(compgen -W "${!opts[*]}" -P "$cur_word" '') )
+				return 0
+			elif [[ "$optlen" = "${#cur_word}" && "$state" != "warning" ]]; then
+				# This short option group only awaits its argument!
+				# Post the option group as-is as a reply so that Readline inserts a space,
+				# so that the next completion request switches to the argument
+				# An exception is made for warnings, since it's idiomatic to stick them to the
+				# `-W`, and it doesn't break anything.
+				COMPREPLY+=( "$cur_word" )
+				return 0
+			fi
+		fi
+	fi
+
+	case "$state" in
+		unk) # Return with no replies: no idea what to complete!
+			;;
+		fix-spec)
+			COMPREPLY+=( "${cur_word}"{l,h,g,L,H,G} )
+			;;
+		mbc)
+			local cur_arg="${cur_word:$optlen}"
+			cur_arg="${cur_arg@U}"
+			COMPREPLY=( $(compgen -W "
+				ROM_ONLY
+				MBC1{,+RAM,+RAM+BATTERY}
+				MBC2{,+BATTERY}
+				MMM01{,+RAM}
+				MBC3{+TIMER+BATTERY,+TIMER+RAM+BATTERY,,+RAM,+RAM+BATTERY}
+				MBC5{,+RAM,+RAM+BATTERY,+RUMBLE,+RUMBLE+RAM,+RUMBLE+RAM+BATTERY}
+				MBC6
+				MBC7+SENSOR+RUMBLE+RAM+BATTERY
+				POCKET_CAMERA
+				BANDAI_TAMA5
+				HUC3
+				HUC1+RAM+BATTERY
+				TPP1_1.0{,+BATTERY}{,+RTC}{,+RUMBLE,+MULTIRUMBLE}" -P "${cur_word:0:$optlen}" -- "`tr 'a-z ' 'A-Z_' <<<"${cur_word/ /_}"`") )
+			COMPREPLY+=( $(compgen -W "help" -P "${cur_word:0:$optlen}" -- "${cur_word:$optlen}") )
+			;;
+		normal) # Acts like a glob...
+			state="glob-*.gb *.gbc *.sgb"
+			;&
+		glob-*)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(for glob in ${state#glob-}; do compgen -A file -X \!"$glob" -- "${cur_word:$optlen}"; done)
+			# Also complete directories
+			;&
+		dir)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(compgen -A directory -- "${cur_word:$optlen}")
+			compopt -o filenames
+			;;
+	esac
+}
+
+complete -F _rgbfix_completions rgbfix

contrib/bash_compl/_rgbgfx.bash

@@ -0,0 +1,162 @@
+#/usr/bin/env bash
+
+# Same notes as RGBASM
+
+_rgbgfx_completions() {
+	COMPREPLY=()
+
+	# Format: "long_opt:state_after"
+	# Empty long opt = it doesn't exit
+	# See the `state` variable below for info about `state_after`
+	declare -A opts=(
+		[V]="version:normal"
+		[C]="color-curve:normal"
+		[D]="debug:normal"
+		[h]="horizontal:normal"
+		[m]="mirror-tiles:normal"
+		[u]="unique-tiles:normal"
+		[v]="verbose:normal"
+		[f]="fix:normal"
+		[F]="fix-and-save:normal"
+		[a]="attr-map:*.attrmap"
+		[A]="output-attr-map:normal"
+		[d]="depth:unk"
+		[o]="output:glob *.2bpp"
+		[p]="palette:glob *.pal"
+		[P]="output-palette:normal"
+		[t]="tilemap:glob *.tilemap"
+		[T]="output-tilemap:normal"
+		[x]="trim-end:unk"
+	)
+	# Parse command-line up to current word
+	local opt_ena=true
+	# Possible states:
+	# - normal  = Well, normal. Options are parsed normally.
+	# - unk     = An argument that can't be completed, and should just be skipped.
+	# - warning = A warning flag.
+	# - dir     = A directory path
+	# - glob-*  = A glob, after the dash is a whitespace-separated list of file globs to use
+	local state=normal
+	# The length of the option, used as a return value by the function below
+	local optlen=0
+	# $1: a short option word
+	# `state` will be set to the parsing state after the last option character in the word. If
+	# "normal" is not returned, `optlen` will be set to the length (dash included) of the "option"
+	# part of the argument.
+	parse_short_opt() {
+		for (( i = 1; i < "${#1}"; i++ )); do
+			# If the option is not known, assume it doesn't take an argument
+			local opt="${opts["${1:$i:1}"]:-":normal"}"
+			state="${opt#*:}"
+			# If the option takes an argument, record the length and exit
+			if [[ "$state" != 'normal' ]]; then
+				let optlen="$i + 1"
+				return
+			fi
+		done
+		optlen=0
+	}
+
+	for (( i = 1; i < $COMP_CWORD; i++ )); do
+		local word="${COMP_WORDS[$i]}"
+
+		# If currently processing an argument, skip this word
+		if [[ "$state" != 'normal' ]]; then
+			state=normal
+			continue
+		fi
+
+		if [[ "$word" = '--' ]]; then
+			# Options stop being parsed after this
+			opt_ena=false
+			break
+		fi
+
+		# Check if it's a long option
+		if [[ "${word:0:2}" = '--' ]]; then
+			# If the option is unknown, assume it takes no arguments: keep the state at "normal"
+			for long_opt in "${opts[@]}"; do
+				if [[ "$word" = "--${long_opt%%:*}" ]]; then
+					state="${long_opt#*:}"
+					# Check if the next word is just '='; if so, skip it, the argument must follow
+					# (See "known bugs" at the top of this script)
+					let i++
+					if [[ "${COMP_WORDS[$i]}" != '=' ]]; then
+						let i--
+					fi
+					optlen=0
+					break
+				fi
+			done
+		# Check if it's a short option
+		elif [[ "${word:0:1}" = '-' ]]; then
+			parse_short_opt "$word"
+			# The last option takes an argument...
+			if [[ "$state" != 'normal' ]]; then
+				if [[ "$optlen" -ne "${#word}" ]]; then
+					# If it's contained within the word, we won't complete it, revert to "normal"
+					state=normal
+				else
+					# Otherwise, complete it, but start at the beginning of *that* word
+					optlen=0
+				fi
+			fi
+		fi
+	done
+
+	# Parse current word
+	# Careful that it might look like an option, so use `--` aggressively!
+	local cur_word="${COMP_WORDS[$COMP_CWORD]}"
+
+	# Process options, as short ones may change the state
+	if $opt_ena && [[ "$state" = 'normal' && "${cur_word:0:1}" = '-' ]]; then
+		# We might want to complete to an option or an arg to that option
+		# Parse the option word to check
+		# There's no whitespace in the option names, so we can ride a little dirty...
+
+		# Is this a long option?
+		if [[ "${cur_word:1:1}" = '-' ]]; then
+			# It is, try to complete one
+			COMPREPLY+=( $(compgen -W "${opts[*]%%:*}" -P '--' -- "${cur_word#--}") )
+			return 0
+		else
+			# Short options may be grouped, parse them to determine what to complete
+			parse_short_opt "$cur_word"
+
+			if [[ "$state" = 'normal' ]]; then
+				COMPREPLY+=( $(compgen -W "${!opts[*]}" -P "$cur_word" '') )
+				return 0
+			elif [[ "$optlen" = "${#cur_word}" && "$state" != "warning" ]]; then
+				# This short option group only awaits its argument!
+				# Post the option group as-is as a reply so that Readline inserts a space,
+				# so that the next completion request switches to the argument
+				# An exception is made for warnings, since it's idiomatic to stick them to the
+				# `-W`, and it doesn't break anything.
+				COMPREPLY+=( "$cur_word" )
+				return 0
+			fi
+		fi
+	fi
+
+	case "$state" in
+		unk) # Return with no replies: no idea what to complete!
+			;;
+		normal) # Acts like a glob...
+			state="glob-*.png"
+			;&
+		glob-*)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(for glob in ${state#glob-}; do compgen -A file -X \!"$glob" -- "${cur_word:$optlen}"; done)
+			# Also complete directories
+			;&
+		dir)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(compgen -A directory -- "${cur_word:$optlen}")
+			compopt -o filenames
+			;;
+	esac
+}
+
+complete -F _rgbgfx_completions rgbgfx

contrib/bash_compl/_rgblink.bash

@@ -0,0 +1,157 @@
+#/usr/bin/env bash
+
+# Same notes as RGBASM
+
+_rgblink_completions() {
+	COMPREPLY=()
+
+	# Format: "long_opt:state_after"
+	# Empty long opt = it doesn't exit
+	# See the `state` variable below for info about `state_after`
+	declare -A opts=(
+		[V]="version:normal"
+		[d]="dmg:normal"
+		[t]="tiny:normal"
+		[v]="verbose:normal"
+		[w]="wramx:normal"
+		[x]="nopad:normal"
+		[l]="linkerscript:glob-*"
+		[m]="map:glob-*.map"
+		[n]="sym:glob-*.sym"
+		[O]="overlay:glob-*.gb *.gbc *.sgb"
+		[o]="output:glob-*.gb *.gbc *.sgb"
+		[p]="pad:unk"
+		[s]="smart:unk"
+	)
+	# Parse command-line up to current word
+	local opt_ena=true
+	# Possible states:
+	# - normal  = Well, normal. Options are parsed normally.
+	# - unk     = An argument that can't be completed, and should just be skipped.
+	# - warning = A warning flag.
+	# - dir     = A directory path
+	# - glob-*  = A glob, after the dash is a whitespace-separated list of file globs to use
+	local state=normal
+	# The length of the option, used as a return value by the function below
+	local optlen=0
+	# $1: a short option word
+	# `state` will be set to the parsing state after the last option character in the word. If
+	# "normal" is not returned, `optlen` will be set to the length (dash included) of the "option"
+	# part of the argument.
+	parse_short_opt() {
+		for (( i = 1; i < "${#1}"; i++ )); do
+			# If the option is not known, assume it doesn't take an argument
+			local opt="${opts["${1:$i:1}"]:-":normal"}"
+			state="${opt#*:}"
+			# If the option takes an argument, record the length and exit
+			if [[ "$state" != 'normal' ]]; then
+				let optlen="$i + 1"
+				return
+			fi
+		done
+		optlen=0
+	}
+
+	for (( i = 1; i < $COMP_CWORD; i++ )); do
+		local word="${COMP_WORDS[$i]}"
+
+		# If currently processing an argument, skip this word
+		if [[ "$state" != 'normal' ]]; then
+			state=normal
+			continue
+		fi
+
+		if [[ "$word" = '--' ]]; then
+			# Options stop being parsed after this
+			opt_ena=false
+			break
+		fi
+
+		# Check if it's a long option
+		if [[ "${word:0:2}" = '--' ]]; then
+			# If the option is unknown, assume it takes no arguments: keep the state at "normal"
+			for long_opt in "${opts[@]}"; do
+				if [[ "$word" = "--${long_opt%%:*}" ]]; then
+					state="${long_opt#*:}"
+					# Check if the next word is just '='; if so, skip it, the argument must follow
+					# (See "known bugs" at the top of this script)
+					let i++
+					if [[ "${COMP_WORDS[$i]}" != '=' ]]; then
+						let i--
+					fi
+					optlen=0
+					break
+				fi
+			done
+		# Check if it's a short option
+		elif [[ "${word:0:1}" = '-' ]]; then
+			parse_short_opt "$word"
+			# The last option takes an argument...
+			if [[ "$state" != 'normal' ]]; then
+				if [[ "$optlen" -ne "${#word}" ]]; then
+					# If it's contained within the word, we won't complete it, revert to "normal"
+					state=normal
+				else
+					# Otherwise, complete it, but start at the beginning of *that* word
+					optlen=0
+				fi
+			fi
+		fi
+	done
+
+	# Parse current word
+	# Careful that it might look like an option, so use `--` aggressively!
+	local cur_word="${COMP_WORDS[$COMP_CWORD]}"
+
+	# Process options, as short ones may change the state
+	if $opt_ena && [[ "$state" = 'normal' && "${cur_word:0:1}" = '-' ]]; then
+		# We might want to complete to an option or an arg to that option
+		# Parse the option word to check
+		# There's no whitespace in the option names, so we can ride a little dirty...
+
+		# Is this a long option?
+		if [[ "${cur_word:1:1}" = '-' ]]; then
+			# It is, try to complete one
+			COMPREPLY+=( $(compgen -W "${opts[*]%%:*}" -P '--' -- "${cur_word#--}") )
+			return 0
+		else
+			# Short options may be grouped, parse them to determine what to complete
+			parse_short_opt "$cur_word"
+
+			if [[ "$state" = 'normal' ]]; then
+				COMPREPLY+=( $(compgen -W "${!opts[*]}" -P "$cur_word" '') )
+				return 0
+			elif [[ "$optlen" = "${#cur_word}" && "$state" != "warning" ]]; then
+				# This short option group only awaits its argument!
+				# Post the option group as-is as a reply so that Readline inserts a space,
+				# so that the next completion request switches to the argument
+				# An exception is made for warnings, since it's idiomatic to stick them to the
+				# `-W`, and it doesn't break anything.
+				COMPREPLY+=( "$cur_word" )
+				return 0
+			fi
+		fi
+	fi
+
+	case "$state" in
+		unk) # Return with no replies: no idea what to complete!
+			;;
+		normal) # Acts like a glob...
+			state="glob-*.o *.obj"
+			;&
+		glob-*)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(for glob in ${state#glob-}; do compgen -A file -X \!"$glob" -- "${cur_word:$optlen}"; done)
+			# Also complete directories
+			;&
+		dir)
+			while read -r word; do
+				COMPREPLY+=("${cur_word:0:$optlen}$word")
+			done < <(compgen -A directory -- "${cur_word:$optlen}")
+			compopt -o filenames
+			;;
+	esac
+}
+
+complete -F _rgblink_completions rgblink

contrib/checkdiff.bash

@@ -0,0 +1,85 @@
+#!/bin/bash
+
+# SPDX-License-Identifier: MIT
+#
+# Copyright (c) 2021 Rangi
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+declare -A FILES
+while read -r -d '' file; do
+	FILES["$file"]="true"
+done < <(git diff --name-only -z $1 HEAD)
+
+edited () {
+	${FILES["$1"]:-"false"}
+}
+
+dependency () {
+	if edited "$1" && ! edited "$2"; then
+		echo "'$1' was modified, but not '$2'! $3" | xargs
+	fi
+}
+
+# Pull requests that edit the first file without the second may be correct,
+# but are suspicious enough to require review.
+
+dependency include/linkdefs.h    src/rgbds.5 \
+           "Was the object file format changed?"
+
+dependency src/asm/parser.y      src/asm/rgbasm.5 \
+           "Was the rgbasm grammar changed?"
+
+dependency include/asm/warning.h src/asm/rgbasm.1 \
+           "Were the rgbasm warnings changed?"
+
+dependency src/asm/object.c      include/linkdefs.h \
+           "Should the object file revision be bumped?"
+dependency src/link/object.c     include/linkdefs.h \
+           "Should the object file revision be bumped?"
+
+dependency Makefile              CMakeLists.txt \
+           "Did the build process change?"
+dependency Makefile              src/CMakeLists.txt \
+           "Did the build process change?"
+
+dependency src/asm/main.c        src/asm/rgbasm.1 \
+           "Did the rgbasm CLI change?"
+dependency src/asm/main.c        contrib/zsh_compl/_rgbasm \
+           "Did the rgbasm CLI change?"
+dependency src/asm/main.c        contrib/bash_compl/_rgbasm.bash \
+           "Did the rgbasm CLI change?"
+dependency src/link/main.c       src/link/rgblink.1 \
+           "Did the rgblink CLI change?"
+dependency src/link/main.c       contrib/zsh_compl/_rgblink \
+           "Did the rgblink CLI change?"
+dependency src/link/main.c        contrib/bash_compl/_rgblink.bash \
+           "Did the rgblink CLI change?"
+dependency src/fix/main.c        src/fix/rgbfix.1 \
+           "Did the rgbfix CLI change?"
+dependency src/fix/main.c        contrib/zsh_compl/_rgbfix \
+           "Did the rgbfix CLI change?"
+dependency src/fix/main.c        contrib/bash_compl/_rgbfix.bash \
+           "Did the rgbfix CLI change?"
+dependency src/gfx/main.c        src/gfx/rgbgfx.1 \
+           "Did the rgbgfx CLI change?"
+dependency src/gfx/main.c        contrib/zsh_compl/_rgbgfx \
+           "Did the rgbgfx CLI change?"
+dependency src/gfx/main.c        contrib/bash_compl/_rgbgfx.bash \
+           "Did the rgbgfx CLI change?"

contrib/gbdiff.bash

@@ -0,0 +1,73 @@
+#!/bin/bash
+
+# SPDX-License-Identifier: MIT
+#
+# Copyright (c) 2020 Eldred Habert
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+STATE=0
+diff <(xxd $1) <(xxd $2) | while read -r LINE; do
+	if [ $STATE -eq 0 ]; then
+		# Discard first line (line info)
+		STATE=1
+	elif [ "$LINE" = '---' ]; then
+		# Separator between files switches states
+		echo $LINE
+		STATE=3
+	elif grep -Eq '^[0-9]+(,[0-9]+)?[cd][0-9]+(,[0-9]+)?' <<< "$LINE"; then
+		# Line info resets the whole thing
+		STATE=1
+	elif [ $STATE -eq 1  -o  $STATE -eq 3 ]; then
+		# Compute the GB address from the ROM offset
+		OFS=$(cut -d ' ' -f 2 <<< "$LINE" | tr -d ':')
+		BANK=$((0x$OFS / 0x4000))
+		ADDR=$((0x$OFS % 0x4000 + ($BANK != 0) * 0x4000))
+		# Try finding the preceding symbol closest to the diff
+		if [ $STATE -eq 1 ]; then
+			STATE=2
+			SYMFILE=${1%.*}.sym
+		else
+			STATE=4
+			SYMFILE=${2%.*}.sym
+		fi
+		EXTRA=$(if [ -f "$SYMFILE" ]; then
+			# Read the sym file for such a symbol
+			# Ignore comment lines, only pick matching bank
+			# (The bank regex ignores comments already, make `cut` and `tr` process less lines)
+			grep -Ei $(printf "^%02x:" $BANK) "$SYMFILE" |
+			 cut -d ';' -f 1 |
+			 tr -d "\r" |
+			 while read -r SYMADDR SYM; do
+				SYMADDR=$((0x${SYMADDR#*:}))
+				if [ $SYMADDR -le $ADDR ]; then
+					printf " (%s+%#x)\n" "$SYM" $(($ADDR - $SYMADDR))
+				fi
+			# TODO: assumes sorted sym files
+			done | tail -n 1
+		fi)
+		printf "%02x:%04x %s\n" $BANK $ADDR $EXTRA
+	fi
+	if [ $STATE -eq 2  -o  $STATE -eq 4 ]; then
+		OFS=$(cut -d ' ' -f 2 <<< "$LINE" | tr -d ':')
+		BANK=$((0x$OFS / 0x4000))
+		ADDR=$((0x$OFS % 0x4000 + ($BANK != 0) * 0x4000))
+		printf "%s %02x:%04x: %s\n" "${LINE:0:1}" $BANK $ADDR "${LINE#*: }"
+	fi
+done

contrib/zsh_compl/_rgbasm

@@ -0,0 +1,61 @@
+#compdef rgbasm
+
+_rgbasm_warnings() {
+	local warnings=(
+		'error:Turn all warnings into errors'
+
+		'all:Enable most warning messages'
+		'extra:Enable extra, possibly unwanted, messages'
+		'everything:Enable literally everything'
+
+		'assert:Warn when WARN-type asserts fail'
+		'backwards-for:Warn when start and stop are backwards relative to step'
+		'builtin-args:Report incorrect args to built-in funcs'
+		'charmap-redef:Warn when redefining a charmap mapping'
+		'div:Warn when dividing the smallest int by -1'
+		'empty-data-directive:Warn on arg-less d[bwl] in ROM'
+		'empty-macro-arg:Warn on empty macro arg'
+		'empty-strrpl:Warn on calling STRRPL with empty pattern'
+		'large-constant:Warn on constants too large for a signed 32-bit int'
+		'long-string:Warn on strings too long'
+		'macro-shift:Warn when shifting macro args part their limits'
+		'nested-comment:Warn on "/*" inside block comments'
+		'numeric-string:Warn when a multi-character string is treated as a number'
+		'obsolete:Warn when using deprecated features'
+		'shift:Warn when shifting negative values'
+		'shift-amount:Warn when a shift'\''s operand it negative or \> 32'
+		'truncation:Warn when implicit truncation loses bits'
+		'user:Warn when executing the WARN built-in'
+	)
+	# TODO: handle `no-` and `error=` somehow?
+	# TODO: handle `=0|1|2` levels for `numeric-string` and `truncation`?
+	_describe warning warnings
+}
+
+local args=(
+	# Arguments are listed here in the same order as in the manual, except for the version
+	'(- : * options)'{-V,--version}'[Print version number]'
+
+	'(-E --export-all)'{-E,--export-all}'[Export all symbols]'
+	'(-h --halt-without-nop)'{-h,--halt-without-nop}'[Avoid outputting a `nop` after `halt`]'
+	'(-L ---preserve-ld)'{-L,--preserve-ld}'[Prevent auto-optimizing `ld` into `ldh`]'
+	'(-v --verbose)'{-v,--verbose}'[Print additional messages regarding progression]'
+	-w'[Disable all warnings]'
+
+	'(-b --binary-digits)'{-b,--binary-digits}'+[Change chars for binary constants]:digit spec:'
+	'*'{-D,--define}'+[Define a string symbol]:name + value (default 1):'
+	'(-g --gfx-chars)'{-g,--gfx-chars}'+[Change chars for gfx constants]:chars spec:'
+	'(-i --include)'{-i,--include}'+[Add an include directory]:include path:_files -/'
+	'(-M --dependfile)'{-M,--dependfile}"+[List deps in make format]:output file:_files -g '*.{d,mk}'"
+	-MG'[Assume missing files should be generated]'
+	-MP'[Add phony targets to all deps]'
+	'*'-MT"+[Add a target to the rules]:target:_files -g '*.{d,mk,o}'"
+	'*'-MQ"+[Add a target to the rules]:target:_files -g '*.{d,mk,o}'"
+	'(-o --output)'{-o,--output}'+[Output file]:output file:_files'
+	'(-p --pad-value)'{-p,--pad-value}'+[Set padding byte]:padding byte:'
+	'(-r --recursion-depth)'{-r,--recursion-depth}'+[Set maximum recursion depth]:depth:'
+	'(-W --warning)'{-W,--warning}'+[Toggle warning flags]:warning flag:_rgbasm_warnings'
+
+	":assembly sources:_files -g '*.asm'"
+)
+_arguments -s -S : $args

contrib/zsh_compl/_rgbfix

@@ -0,0 +1,60 @@
+#compdef rgbfix
+
+_mbc_names() {
+	local mbc_names=(
+		'ROM:$00'
+		'MBC1:$01'
+		'MBC1+RAM:$02'
+		'MBC1+RAM+BATTERY:$03'
+		'MBC2:$05'
+		'MBC2+BATTERY:$06'
+		'ROM+RAM:$08'
+		'ROM+RAM+BATTERY:$09'
+		'MMM01:$0B'
+		'MMM01+RAM:$0C'
+		'MMM01+RAM+BATTERY:$0D'
+		'MBC3+TIMER+BATTERY:$0F'
+		'MBC3+TIMER+RAM+BATTERY:$10'
+		'MBC3:$11'
+		'MBC3+RAM:$12'
+		'MBC3+RAM+BATTERY:$13'
+		'MBC5:$19'
+		'MBC5+RAM:$1A'
+		'MBC5+RAM+BATTERY:$1B'
+		'MBC5+RUMBLE:$1C'
+		'MBC5+RUMBLE+RAM:$1D'
+		'MBC5+RUMBLE+RAM+BATTERY:$1E'
+		'MBC6:$20'
+		'MBC7+SENSOR+RUMBLE+RAM+BATTERY:$22'
+		'POCKET_CAMERA:$FC'
+		'BANDAI_TAMA5:$FD'
+		'HUC3:$FE'
+		'HUC1+RAM+BATTERY:$FF'
+	)
+	_describe "MBC name" mbc_names
+}
+
+local args=(
+	# Arguments are listed here in the same order as in the manual, except for the version
+	'(- : * options)'{-V,--version}'[Print version number]'
+
+	'(-C --color-only -c --color-compatible)'{-C,--color-only}'[Mark ROM as GBC-only]'
+	'(-C --color-only -c --color-compatible)'{-c,--color-compatible}'[Mark ROM as GBC-compatible]'
+	'(-j --non-japanese)'{-j,--non-japanese}'[Set the non-Japanese region flag]'
+	'(-O --overwrite)'{-O,--overwrite}'[Allow overwriting non-zero bytes]'
+	'(-s --sgb-compatible)'{-s,--sgb-compatible}'[Set the SGB flag]'
+	'(-f --fix-spec -v --validate)'{-v,--validate}'[Shorthand for -f lhg]'
+
+	'(-f --fix-spec -v --validate)'{-f,--fix-spec}'+[Fix or trash some header values]:fix spec:'
+	'(-i --game-id)'{-i,--game-id}'+[Set game ID string]:4-char game ID:'
+	'(-k --new-licensee)'{-k,--new-licensee}'+[Set new licensee string]:2-char licensee ID:'
+	'(-l --old-licensee)'{-l,--old-licensee}'+[Set old licensee ID]:licensee number:'
+	'(-m --mbc-type)'{-m,--mbc-type}"+[Set MBC flags]:mbc name:_mbc_names"
+	'(-n --rom-version)'{-n,--rom-version}'+[Set ROM version]:rom version byte:'
+	'(-p --pad-value)'{-p,--pad-value}'+[Pad to next valid size using this byte as padding]:padding byte:'
+	'(-r --ram-size)'{-r,--ram-size}'+[Set RAM size]:ram size byte:'
+	'(-t --title)'{-t,--title}'+[Set title string]:11-char title string:'
+
+	'*'":ROM files:_files -g '*.{gb,sgb,gbc}'"
+)
+_arguments -s -S : $args

contrib/zsh_compl/_rgbgfx

@@ -0,0 +1,37 @@
+#compdef rgbgfx
+
+_depths() {
+	local depths=(
+		'1:1bpp'
+		'2:2bpp (native)'
+	)
+
+	_describe 'bit depth' depths
+}
+
+local args=(
+	# Arguments are listed here in the same order as in the manual, except for the version
+	'(- : * options)'{-V,--version}'[Print version number]'
+
+	'(-a --attr-map -A --output-attr-map)'{-A,--output-attr-map}'[Shortcut for -a <file>.attrmap]'
+	'(-C --color-curve)'{-C,--color-curve}'[Generate palettes using GBC color curve]'
+	'(-D --debug)'{-D,--debug}'[Enable debug features]'
+	'(-f --fix -F --fix-and-save)'{-f,--fix}'[Fix input PNG into an indexed image]'
+	'(-f --fix -F --fix-and-save)'{-F,--fix-and-save}'[Like -f but also save CLI params within the PNG]'
+	'(-h --horizontal)'{-h,--horizontal}'[Lay out tiles horizontally instead of vertically]'
+	'(-m --mirror-tiles)'{-m,--mirror-tiles}'[Eliminate mirrored tiles from output]'
+	'(-p --palette -P --output-palette)'{-P,--output-palette}'[Shortcut for -p <file>.pal]'
+	'(-t --tilemap -T --output-tilemap)'{-T,--output-tilemap}'[Shortcut for -t <file>.tilemap]'
+	'(-u --unique-tiles)'{-u,--unique-tiles}'[Eliminate redundant tiles]'
+	'(-v --verbose)'{-v,--verbose}'[Enable verbose output]'
+
+	'(-a --attr-map -A --output-attr-map)'{-a,--attr-map}'+[Generate a map of tile attributes (mirroring)]:attrmap file:_files'
+	'(-d --depth)'{-d,--depth}'+[Set bit depth]:bit depth:_depths'
+	'(-o --output)'{-o,--output}'+[Set output file]:output file:_files'
+	'(-p --palette -P --output-palette)'{-p,--palette}"+[Output the image's palette in little-endian native RGB555 format]:palette file:_files"
+	'(-t --tilemap -T --output-tilemap)'{-t,--tilemap}'+[Generate a map of tile indices]:tilemap file:_files'
+	'(-x --trim-end)'{-x,--trim-end}'+[Trim end of output by this many tiles]:tile count:'
+
+	":input png file:_files -g '*.png'"
+)
+_arguments -s -S : $args

contrib/zsh_compl/_rgblink

@@ -0,0 +1,24 @@
+#compdef rgblink
+
+local args=(
+	# Arguments are listed here in the same order as in the manual, except for the version
+	'(- : * options)'{-V,--version}'[Print version number]'
+
+	'(-d --dmg)'{-d,--dmg}'[Enable DMG mode (-w + no VRAM banking)]'
+	'(-t --tiny)'{-t,--tiny}'[Enable tiny mode, disabling ROM banking]'
+	'(-v --verbose)'{-v,--verbose}'[Enable verbose output]'
+	'(-w --wramx)'{-w,--wramx}'[Disable WRAM banking]'
+	'(-x --nopad)'{-x,--nopad}'[Disable padding the end of the final file]'
+
+	'(-l --linkerscript)'{-l,--linkerscript}"+[Use a linker script]:linker script:_files -g '*.link'"
+	'(-m --map)'{-m,--map}"+[Produce a map file]:map file:_files -g '*.map'"
+	'(-n --sym)'(-n,--sym)"+[Produce a symbol file]:sym file:_files -g '*.sym'"
+	'(-O --overlay)'{-O,--overlay}'+[Overlay sections over on top of bin file]:base overlay:_files'
+	'(-o --output)'{-o,--output}"+[Write ROM image to this file]:rom file:_files -g '*.{gb,sgb,gbc}'"
+	'(-p --pad-value)'{-p,--pad-value}'+[Set padding byte]:padding byte:'
+	'(-S --scramble)'{-s,--scramble}'+[Activate scrambling]:scramble spec'
+	'(-s --smart)'{-s,--smart}'+[!BROKEN! Perform smart linking from this symbol]:symbol name:'
+
+	'*'":object files:_files -g '*.o'"
+)
+_arguments -s -S : $args

docs/index.html

@@ -1,36 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="utf-8"/>
-  <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
-  <title>General Information</title>
-  <link rel="stylesheet" type="text/css" href="mandoc.css">
-</head>
-<body>
-<h1>RGBDS — Rednex Game Boy Development System</h1>
-<h2>Table of Contents</h2>
-<ol>
-  <li>General information
-    <ul>
-      <li><a href="rgbds.7.html">RGBDS general information</a></li>
-      <li><a href="rgbds.5.html">RGBDS object file format</a></li>
-    </ul>
-  <li>Language description
-    <ul>
-      <li><a href="rgbasm.5.html">RGBASM language description</a></li>
-      <li><a href="rgblink.5.html">RGBLINK linkerscript language description</a></li>
-      <li><a href="gbz80.7.html">GBZ80 CPU instruction set description</a></li>
-    </ul>
-  <li>Command line usage
-    <ul>
-      <li><a href="rgbasm.1.html">RGBASM command-line usage</a></li>
-      <li><a href="rgblink.1.html">RGBLINK command-line usage</a></li>
-      <li><a href="rgbfix.1.html">RGBFIX command-line usage</a></li>
-      <li><a href="rgbgfx.1.html">RGBGFX command-line usage</a></li>
-    </ul>
-</ol>
-<h2 id="GitHub Repository">GitHub Repository:</h2>
-<ul>
-  <li><a href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a></li>
-</ul>
-</body>

docs/mandoc.css

@@ -1,203 +0,0 @@
-/* $Id: mandoc.css,v 1.22 2017/07/16 18:45:00 schwarze Exp $ */
-/*
- * Standard style sheet for mandoc(1) -Thtml and man.cgi(8).
- */
-
-/* Global defaults. */
-
-html {		max-width: 100ex; }
-body {		font-family: Helvetica,Arial,sans-serif; }
-table {		margin-top: 0em;
-		margin-bottom: 0em; }
-td {		vertical-align: top; }
-ul, ol, dl {	margin-top: 0em;
-		margin-bottom: 0em; }
-li, dt {	margin-top: 1em; }
-
-a.selflink {	border-bottom: thin dotted;
-		color: inherit;
-		font: inherit;
-		text-decoration: inherit; }
-* {		clear: both }
-
-/* Search form and search results. */
-
-fieldset {	border: thin solid silver;
-		border-radius: 1em;
-		text-align: center; }
-input[name=expr] {
-		width: 25%; }
-
-table.results {	margin-top: 1em;
-		margin-left: 2em;
-		font-size: smaller; }
-
-/* Header and footer lines. */
-
-table.head {	width: 100%;
-		border-bottom: 1px dotted #808080;
-		margin-bottom: 1em;
-		font-size: smaller; }
-td.head-vol {	text-align: center; }
-td.head-rtitle {
-		text-align: right; }
-span.Nd { }
-
-table.foot {	width: 100%;
-		border-top: 1px dotted #808080;
-		margin-top: 1em;
-		font-size: smaller; }
-td.foot-os {	text-align: right; }
-
-/* Sections and paragraphs. */
-
-div.manual-text {
-		margin-left: 5ex; }
-h1.Sh {		margin-top: 2ex;
-		margin-bottom: 1ex;
-		margin-left: -4ex;
-		font-size: 110%; }
-h2.Ss {		margin-top: 2ex;
-		margin-bottom: 1ex;
-		margin-left: -2ex;
-		font-size: 105%; }
-div.Pp {	margin: 1ex 0ex; }
-a.Sx { }
-a.Xr { }
-
-/* Displays and lists. */
-
-div.Bd { }
-div.D1 {	margin-left: 5ex; }
-
-ul.Bl-bullet {	list-style-type: disc;
-		padding-left: 1em; }
-li.It-bullet { }
-ul.Bl-dash {	list-style-type: none;
-		padding-left: 0em; }
-li.It-dash:before {
-		content: "\2014  "; }
-ul.Bl-item {	list-style-type: none;
-		padding-left: 0em; }
-li.It-item { }
-ul.Bl-compact > li {
-		margin-top: 0ex; }
-
-ol.Bl-enum {	padding-left: 2em; }
-li.It-enum { }
-ol.Bl-compact > li {
-		margin-top: 0ex; }
-
-dl.Bl-diag { }
-dt.It-diag { }
-dd.It-diag {	margin-left: 0ex; }
-b.It-diag {	font-style: normal; }
-dl.Bl-hang { }
-dt.It-hang { }
-dd.It-hang {	margin-left: 10.2ex; }
-dl.Bl-inset { }
-dt.It-inset { }
-dd.It-inset {	margin-left: 0ex; }
-dl.Bl-ohang { }
-dt.It-ohang { }
-dd.It-ohang {	margin-left: 0ex; }
-dl.Bl-tag {	margin-left: 10.2ex; }
-dt.It-tag {	float: left;
-		margin-top: 0ex;
-		margin-left: -10.2ex;
-		padding-right: 2ex;
-		vertical-align: top; }
-dd.It-tag {	clear: right;
-		width: 100%;
-		margin-top: 0ex;
-		margin-left: 0ex;
-		vertical-align: top;
-		overflow: auto; }
-dl.Bl-compact > dt {
-		margin-top: 0ex; }
-
-table.Bl-column { }
-tr.It-column { }
-td.It-column {	margin-top: 1em; }
-table.Bl-compact > tbody > tr > td {
-		margin-top: 0ex; }
-
-cite.Rs {	font-style: normal;
-		font-weight: normal; }
-span.RsA { }
-i.RsB {		font-weight: normal; }
-span.RsC { }
-span.RsD { }
-i.RsI {		font-weight: normal; }
-i.RsJ {		font-weight: normal; }
-span.RsN { }
-span.RsO { }
-span.RsP { }
-span.RsQ { }
-span.RsR { }
-span.RsT {	text-decoration: underline; }
-a.RsU { }
-span.RsV { }
-
-span.eqn { }
-table.tbl { }
-
-/* Semantic markup for command line utilities. */
-
-table.Nm { }
-b.Nm {		font-style: normal; }
-b.Fl {		font-style: normal; }
-b.Cm {		font-style: normal; }
-var.Ar {	font-style: italic;
-		font-weight: normal; }
-span.Op { }
-b.Ic {		font-style: normal; }
-code.Ev {	font-style: normal;
-		font-weight: normal;
-		font-family: monospace; }
-i.Pa {		font-weight: normal; }
-
-/* Semantic markup for function libraries. */
-
-span.Lb { }
-b.In {		font-style: normal; }
-a.In { }
-b.Fd {		font-style: normal; }
-var.Ft {	font-style: italic;
-		font-weight: normal; }
-b.Fn {		font-style: normal; }
-var.Fa {	font-style: italic;
-		font-weight: normal; }
-var.Vt {	font-style: italic;
-		font-weight: normal; }
-var.Va {	font-style: italic;
-		font-weight: normal; }
-code.Dv {	font-style: normal;
-		font-weight: normal;
-		font-family: monospace; }
-code.Er {	font-style: normal;
-		font-weight: normal;
-		font-family: monospace; }
-
-/* Various semantic markup. */
-
-span.An { }
-a.Lk { }
-a.Mt { }
-b.Cd {		font-style: normal; }
-i.Ad {		font-weight: normal; }
-b.Ms {		font-style: normal; }
-span.St { }
-a.Ux { }
-
-/* Physical markup. */
-
-.No {		font-style: normal;
-		font-weight: normal; }
-.Em {		font-style: italic;
-		font-weight: normal; }
-.Sy {		font-style: normal;
-		font-weight: bold; }
-.Li {		font-style: normal;
-		font-weight: normal;
-		font-family: monospace; }

docs/rgbasm.1.html

@@ -1,144 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- This is an automatically generated file.  Do not edit.
-   This file is part of RGBDS.
-  
-   Copyright (c) 2010-2019, Anthony J. Bentley and RGBDS contributors.
-  
-   SPDX-License-Identifier: MIT
-   -->
-<head>
-  <meta charset="utf-8"/>
-  <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
-  <title>RGBASM(1)</title>
-</head>
-<body>
-<table class="head">
-  <tr>
-    <td class="head-ltitle">RGBASM(1)</td>
-    <td class="head-vol">General Commands Manual</td>
-    <td class="head-rtitle">RGBASM(1)</td>
-  </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<code class="Nm">rgbasm</code> &#x2014;
-<div class="Nd">Game Boy assembler</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<table class="Nm">
-  <tr>
-    <td><code class="Nm">rgbasm</code></td>
-    <td>[<code class="Fl">-EhLVvw</code>] [<code class="Fl">-b</code>
-      <var class="Ar">chars</var>] [<code class="Fl">-D</code>
-      <var class="Ar">name</var>[=<var class="Ar">value</var>]]
-      [<code class="Fl">-g</code> <var class="Ar">chars</var>]
-      [<code class="Fl">-i</code> <var class="Ar">path</var>]
-      [<code class="Fl">-M</code> <var class="Ar">dependfile</var>]
-      [<code class="Fl">-o</code> <var class="Ar">outfile</var>]
-      [<code class="Fl">-p</code> <var class="Ar">pad_value</var>]
-      [<code class="Fl">-r</code> <var class="Ar">recursion_depth</var>]
-      <var class="Ar">file</var></td>
-  </tr>
-</table>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-The <code class="Nm">rgbasm</code> program creates an object file from an
-  assembly source file. The input <var class="Ar">file</var> can be a file path,
-  or <code class="Cm">-</code> denoting <code class="Cm">stdin</code>. Its
-  arguments are as follows:
-<dl class="Bl-tag">
-  <dt><a class="permalink" href="#b"><code class="Fl" id="b">-b</code></a>
-    <var class="Ar">chars</var></dt>
-  <dd>Change the two characters used for binary constants. The defaults are
-    01.</dd>
-  <dt><a class="permalink" href="#D"><code class="Fl" id="D">-D</code></a>
-    <var class="Ar">name</var>[=<var class="Ar">value</var>]</dt>
-  <dd>Add string symbol to the compiled source code. This is equivalent to
-      <var class="Ar">name</var> <code class="Cm">EQUS</code>
-      &#x201C;<var class="Ar">value</var>&#x201D; in code. If a value is not
-      specified, a value of 1 is given.</dd>
-  <dt><a class="permalink" href="#E"><code class="Fl" id="E">-E</code></a></dt>
-  <dd>Export all labels, including unreferenced and local labels.</dd>
-  <dt><a class="permalink" href="#g"><code class="Fl" id="g">-g</code></a>
-    <var class="Ar">chars</var></dt>
-  <dd>Change the four characters used for binary constants. The defaults are
-      0123.</dd>
-  <dt><a class="permalink" href="#h"><code class="Fl" id="h">-h</code></a></dt>
-  <dd>By default, <code class="Nm">rgbasm</code> inserts a &#x2018;nop&#x2019;
-      instruction immediately after any &#x2018;halt&#x2019; instruction. The
-      <code class="Fl">-h</code> option disables this behavior.</dd>
-  <dt><a class="permalink" href="#i"><code class="Fl" id="i">-i</code></a>
-    <var class="Ar">path</var></dt>
-  <dd>Add an include path.</dd>
-  <dt><a class="permalink" href="#L"><code class="Fl" id="L">-L</code></a></dt>
-  <dd>Disable the optimization that turns loads of the form <b class="Sy">LD
-      [$FF00+n8],A</b> into the opcode <b class="Sy">LDH [$FF00+n8],A</b> in
-      order to have full control of the result in the final ROM.</dd>
-  <dt><a class="permalink" href="#M"><code class="Fl" id="M">-M</code></a>
-    <var class="Ar">dependfile</var></dt>
-  <dd>Print <a class="Xr">make(1)</a> dependencies to
-      <var class="Ar">dependfile</var>.</dd>
-  <dt><a class="permalink" href="#o"><code class="Fl" id="o">-o</code></a>
-    <var class="Ar">outfile</var></dt>
-  <dd>Write an object file to the given filename.</dd>
-  <dt><a class="permalink" href="#p"><code class="Fl" id="p">-p</code></a>
-    <var class="Ar">pad_value</var></dt>
-  <dd>When padding an image, pad with this value. The default is 0x00.</dd>
-  <dt><a class="permalink" href="#r"><code class="Fl" id="r">-r</code></a>
-    <var class="Ar">recursion_depth</var></dt>
-  <dd>Specifies the recursion depth at which RGBASM will assume being in an
-      infinite loop.</dd>
-  <dt><a class="permalink" href="#V"><code class="Fl" id="V">-V</code></a></dt>
-  <dd>Print the version of the program and exit.</dd>
-  <dt><a class="permalink" href="#v"><code class="Fl" id="v">-v</code></a></dt>
-  <dd>Be verbose.</dd>
-  <dt><a class="permalink" href="#w"><code class="Fl" id="w">-w</code></a></dt>
-  <dd>Disable warning output.</dd>
-</dl>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-You can assemble a source file in two ways. Straight forward way:
-<div class="Bd Pp Bd-indent">
-<pre>
-$ rgbasm -o bar.o foo.asm
-</pre>
-</div>
-<p class="Pp">Pipes way:</p>
-<div class="Bd Pp Bd-indent">
-<pre>
-$ cat foo.asm | rgbasm -o bar.o -
-$ rgbasm -o bar.o - &lt; foo.asm
-</pre>
-</div>
-<p class="Pp">The resulting object file is not yet a usable ROM image &#x2014;
-    it must first be run through <a class="Xr">rgblink(1)</a> and
-    <a class="Xr">rgbfix(1)</a>.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
-  ALSO</a></h1>
-<a class="Xr">rgbasm(5)</a>, <a class="Xr">rgbfix(1)</a>,
-  <a class="Xr">rgblink(1)</a>, <a class="Xr">rgbds(5)</a>,
-  <a class="Xr">rgbds(7)</a>, <a class="Xr">gbz80(7)</a>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<code class="Nm">rgbasm</code> was originally written by Carsten S&#x00F8;rensen
-  as part of the ASMotor package, and was later packaged in RGBDS by Justin
-  Lloyd. It is now maintained by a number of contributors at
-  <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.
-</section>
-</div>
-<table class="foot">
-  <tr>
-    <td class="foot-date">July 8, 2019</td>
-    <td class="foot-os">RGBDS Manual</td>
-  </tr>
-</table>
-</body>
-</html>

docs/rgbds.5.html

@@ -1,314 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- This is an automatically generated file.  Do not edit.
-   This file is part of RGBDS.
-  
-   Copyright (c) 2017-2018, Antonio Nino Diaz and RGBDS contributors.
-  
-   SPDX-License-Identifier: MIT
-   -->
-<head>
-  <meta charset="utf-8"/>
-  <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
-  <title>RGBDS(5)</title>
-</head>
-<body>
-<table class="head">
-  <tr>
-    <td class="head-ltitle">RGBDS(5)</td>
-    <td class="head-vol">File Formats Manual</td>
-    <td class="head-rtitle">RGBDS(5)</td>
-  </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<code class="Nm">rgbds</code> &#x2014;
-<div class="Nd">object file format documentation</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-This is the description of the object files used by <a class="Xr">rgbasm(1)</a>
-  and <a class="Xr">rgblink(1)</a>. Please, note that the specifications may
-  change. This toolchain is in development and new features may require adding
-  more information to the current format, or modifying some fields, which would
-  break compatibility with older versions.
-</section>
-<section class="Sh">
-<h1 class="Sh" id="FILE_STRUCTURE"><a class="permalink" href="#FILE_STRUCTURE">FILE
-  STRUCTURE</a></h1>
-The following types are used:
-<p class="Pp"><var class="Ar">LONG</var> is a 32&#x2010;bit integer stored in
-    little&#x2010;endian format (Intel). <var class="Ar">BYTE</var> is an
-    8&#x2010;bit integer. <var class="Ar">STRING</var> is a 0&#x2010;terminated
-    string of <var class="Ar">BYTE</var>.</p>
-<div class="Bd Pp">
-<pre>
-; Header
-
-BYTE    ID[4]            ; &quot;RGB6&quot;
-LONG    NumberOfSymbols  ; The number of symbols used in this file
-LONG    NumberOfSections ; The number of sections used in this file
-
-; Symbols
-
-REPT    NumberOfSymbols   ; Number of symbols defined in this object file.
-
-    STRING  Name          ; The name of this symbol. Local symbols are stored
-                          ; as &quot;Scope.Symbol&quot;.
-
-    BYTE    Type          ; 0 = LOCAL symbol only used in this file.
-                          ; 1 = IMPORT this symbol from elsewhere
-                          ; 2 = EXPORT this symbol to other objects.
-
-    IF      Type != 1     ; If symbol is defined in this object file.
-
-        STRING  FileName  ; File where the symbol is defined.
-
-        LONG    LineNum   ; Line number in the file where the symbol is defined.
-
-        LONG    SectionID ; The section number (of this object file) in which
-                          ; this symbol is defined. If it doesn't belong to any
-                          ; specific section (like a constant), this field has
-                          ; the value -1.
-
-        LONG    Value     ; The symbols value. It's the offset into that
-                          ; symbol's section.
-
-    ENDC
-
-ENDR
-
-; Sections
-
-REPT NumberOfSections
-    STRING  Name  ; Name of the section
-
-    LONG    Size  ; Size in bytes of this section
-
-    BYTE    Type  ; 0 = WRAM0
-                  ; 1 = VRAM
-                  ; 2 = ROMX
-                  ; 3 = ROM0
-                  ; 4 = HRAM
-                  ; 5 = WRAMX
-                  ; 6 = SRAM
-                  ; 7 = OAM
-
-    LONG    Org   ; Address to fix this section at. -1 if the linker should
-                  ; decide (floating address).
-
-    LONG    Bank  ; Bank to load this section into. -1 if the linker should
-                  ; decide (floating bank). This field is only valid for ROMX,
-                  ; VRAM, WRAMX and SRAM sections.
-
-    LONG    Align ; Alignment of this section (expressed as number of low bits
-                  ; to leave as 0). -1 if not defined.
-
-    IF      (Type == ROMX) || (Type == ROM0) ; Sections that can contain data.
-
-        BYTE    Data[Size]      ; Raw data of the section.
-
-        LONG    NumberOfPatches ; Number of patches to apply.
-
-        ; These types of sections may have patches
-
-        REPT    NumberOfPatches
-
-            STRING  SourceFile   ; Name of the source file (for printing error
-                                 ; messages).
-
-            LONG    Line         ; The line of the source file.
-
-            LONG    Offset       ; Offset into the section where patch should
-                                 ; be applied (in bytes).
-
-            BYTE    Type         ; 0 = BYTE patch.
-                                 ; 1 = little endian WORD patch.
-                                 ; 2 = little endian LONG patch.
-                                 ; 3 = JR offset value BYTE patch.
-
-            LONG    RPNSize      ; Size of the buffer with the RPN.
-                                 ; expression.
-
-            BYTE    RPN[RPNSize] ; RPN expression. Definition below.
-
-        ENDR
-
-    ENDC
-
-ENDR
-</pre>
-</div>
-<section class="Ss">
-<h2 class="Ss" id="RPN_DATA"><a class="permalink" href="#RPN_DATA">RPN
-  DATA</a></h2>
-Expressions in the object file are stored as RPN. This is an expression of the
-  form &#x201C;2 5 +&#x201D;. This will first push the value &#x201C;2&#x201D;
-  to the stack. Then &#x201C;5&#x201D;. The &#x201C;+&#x201D; operator pops two
-  arguments from the stack, adds them, and then pushes the result on the stack,
-  effectively replacing the two top arguments with their sum. In the RGB format,
-  RPN expressions are stored as BYTEs with some bytes being special prefixes for
-  integers and symbols.
-<table class="Bl-column Bd-indent">
-  <tr>
-    <td><b class="Sy">Value</b></td>
-    <td><b class="Sy">Meaning</b></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$00"><code class="Li" id="$00">$00</code></a></td>
-    <td><a class="permalink" href="#+_operator"><code class="Li" id="+_operator">+
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$01"><code class="Li" id="$01">$01</code></a></td>
-    <td><a class="permalink" href="#-_operator"><code class="Li" id="-_operator">-
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$02"><code class="Li" id="$02">$02</code></a></td>
-    <td><a class="permalink" href="#*_operator"><code class="Li" id="*_operator">*
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$03"><code class="Li" id="$03">$03</code></a></td>
-    <td><a class="permalink" href="#/_operator"><code class="Li" id="/_operator">/
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$04"><code class="Li" id="$04">$04</code></a></td>
-    <td><a class="permalink" href="#__operator"><code class="Li" id="__operator">%
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$05"><code class="Li" id="$05">$05</code></a></td>
-    <td><a class="permalink" href="#unary_-"><code class="Li" id="unary_-">unary
-      -</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$10"><code class="Li" id="$10">$10</code></a></td>
-    <td>|
-      <a class="permalink" href="#operator"><code class="Li" id="operator">operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$11"><code class="Li" id="$11">$11</code></a></td>
-    <td><a class="permalink" href="#&amp;_operator"><code class="Li" id="&amp;_operator">&amp;
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$12"><code class="Li" id="$12">$12</code></a></td>
-    <td><a class="permalink" href="#__operator_2"><code class="Li" id="__operator_2">^
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$13"><code class="Li" id="$13">$13</code></a></td>
-    <td><a class="permalink" href="#unary_~"><code class="Li" id="unary_~">unary
-      ~</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$21"><code class="Li" id="$21">$21</code></a></td>
-    <td><a class="permalink" href="#&amp;&amp;_comparison"><code class="Li" id="&amp;&amp;_comparison">&amp;&amp;
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$22"><code class="Li" id="$22">$22</code></a></td>
-    <td><a class="permalink" href="#___comparison"><code class="Li" id="___comparison">||
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$23"><code class="Li" id="$23">$23</code></a></td>
-    <td><a class="permalink" href="#unary"><code class="Li" id="unary">unary</code></a>!</td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$30"><code class="Li" id="$30">$30</code></a></td>
-    <td><a class="permalink" href="#==_comparison"><code class="Li" id="==_comparison">==
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$31"><code class="Li" id="$31">$31</code></a></td>
-    <td><a class="permalink" href="#!=_comparison"><code class="Li" id="!=_comparison">!=
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$32"><code class="Li" id="$32">$32</code></a></td>
-    <td><a class="permalink" href="#__comparison"><code class="Li" id="__comparison">&gt;
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$33"><code class="Li" id="$33">$33</code></a></td>
-    <td><a class="permalink" href="#__comparison_2"><code class="Li" id="__comparison_2">&lt;
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$34"><code class="Li" id="$34">$34</code></a></td>
-    <td><a class="permalink" href="#_=_comparison"><code class="Li" id="_=_comparison">&gt;=
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$35"><code class="Li" id="$35">$35</code></a></td>
-    <td><a class="permalink" href="#_=_comparison_2"><code class="Li" id="_=_comparison_2">&lt;=
-      comparison</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$40"><code class="Li" id="$40">$40</code></a></td>
-    <td><a class="permalink" href="#___operator"><code class="Li" id="___operator">&lt;&lt;
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$41"><code class="Li" id="$41">$41</code></a></td>
-    <td><a class="permalink" href="#___operator_2"><code class="Li" id="___operator_2">&gt;&gt;
-      operator</code></a></td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$50"><code class="Li" id="$50">$50</code></a></td>
-    <td><a class="permalink" href="#BANK(symbol),"><code class="Li" id="BANK(symbol),">BANK(symbol),</code></a>
-      a <var class="Ar">LONG</var> Symbol ID follows.</td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$51"><code class="Li" id="$51">$51</code></a></td>
-    <td><a class="permalink" href="#BANK(section_name),"><code class="Li" id="BANK(section_name),">BANK(section_name),</code></a>
-      a null-terminated string follows.</td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$52"><code class="Li" id="$52">$52</code></a></td>
-    <td><a class="permalink" href="#Current_BANK()"><code class="Li" id="Current_BANK()">Current
-      BANK()</code></a>.</td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$60"><code class="Li" id="$60">$60</code></a></td>
-    <td><a class="permalink" href="#HRAMCheck."><code class="Li" id="HRAMCheck.">HRAMCheck.</code></a>
-      Check if the value is in HRAM, AND it with 0xFF.</td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$80"><code class="Li" id="$80">$80</code></a></td>
-    <td><var class="Ar">LONG</var> integer follows.</td>
-  </tr>
-  <tr>
-    <td><a class="permalink" href="#$81"><code class="Li" id="$81">$81</code></a></td>
-    <td><var class="Ar">LONG</var> Symbol ID follows.</td>
-  </tr>
-</table>
-</section>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
-  ALSO</a></h1>
-<a class="Xr">rgbasm(1)</a>, <a class="Xr">rgblink(1)</a>,
-  <a class="Xr">rgbds(7)</a>, <a class="Xr">gbz80(7)</a>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<code class="Nm">rgbds</code> was originally written by Carsten S&#x00F8;rensen
-  as part of the ASMotor package, and was later packaged in RGBDS by Justin
-  Lloyd. It is now maintained by a number of contributors at
-  <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.
-</section>
-</div>
-<table class="foot">
-  <tr>
-    <td class="foot-date">January 26, 2018</td>
-    <td class="foot-os">RGBDS Manual</td>
-  </tr>
-</table>
-</body>
-</html>

docs/rgbds.7.html

@@ -1,78 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- This is an automatically generated file.  Do not edit.
-   This file is part of RGBDS.
-  
-   Copyright (c) 2010-2018, Anthony J. Bentley and RGBDS contributors.
-  
-   SPDX-License-Identifier: MIT
-   -->
-<head>
-  <meta charset="utf-8"/>
-  <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
-  <title>RGBDS(7)</title>
-</head>
-<body>
-<table class="head">
-  <tr>
-    <td class="head-ltitle">RGBDS(7)</td>
-    <td class="head-vol">Miscellaneous Information Manual</td>
-    <td class="head-rtitle">RGBDS(7)</td>
-  </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<code class="Nm">rgbds</code> &#x2014;
-<div class="Nd">Rednex Game Boy Development System</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-To get a working ROM image from a single assembly source file:
-<div class="Bd Pp Bd-indent">
-<pre>
-$ rgbasm -o bar.o foo.asm
-$ rgblink -o baz.gb bar.o
-$ rgbfix -v -p 0 baz.gb
-</pre>
-</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
-  ALSO</a></h1>
-<a class="Xr">rgbasm(1)</a>, <a class="Xr">rgbfix(1)</a>,
-  <a class="Xr">rgblink(1)</a>, <a class="Xr">rgbds(5)</a>,
-  <a class="Xr">gbz80(7)</a>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<dl class="Bl-ohang">
-  <dt></dt>
-  <dd>1997, Carsten S&#x00F8;rensen (AKA SurfSmurf) writes ASMotor as a
-      general-purpose assembler/linker system for DOS/Win32.</dd>
-  <dt></dt>
-  <dd>1999, Justin Lloyd (AKA Otaku no Zoku) adapts ASMotor to read and produce
-      GBZ80 assembly/machine code, and releases this version as RGBDS.</dd>
-  <dt></dt>
-  <dd>2009, Vegard Nossum adapts the code to be more UNIX-like and releases this
-      version as rgbds-linux on GitHub.</dd>
-  <dt></dt>
-  <dd>2010, Anthony J. Bentley forks that repository. The fork becomes the
-      reference implementation of rgbds.</dd>
-  <dt></dt>
-  <dd>2017, Bentley's repository is moved to a neutral name. It is now
-      maintained by a number of contributors at
-      <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.</dd>
-  <dt></dt>
-  <dd>2018, codebase relicensed under the MIT license.</dd>
-</dl>
-</section>
-</div>
-<table class="foot">
-  <tr>
-    <td class="foot-date">March 7, 2018</td>
-    <td class="foot-os">RGBDS Manual</td>
-  </tr>
-</table>
-</body>
-</html>

docs/rgbfix.1.html

@@ -1,183 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- This is an automatically generated file.  Do not edit.
-   This file is part of RGBDS.
-  
-   Copyright (c) 2010-2017, Anthony J. Bentley and RGBDS contributors.
-  
-   SPDX-License-Identifier: MIT
-   -->
-<head>
-  <meta charset="utf-8"/>
-  <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
-  <title>RGBFIX(1)</title>
-</head>
-<body>
-<table class="head">
-  <tr>
-    <td class="head-ltitle">RGBFIX(1)</td>
-    <td class="head-vol">General Commands Manual</td>
-    <td class="head-rtitle">RGBFIX(1)</td>
-  </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<code class="Nm">rgbfix</code> &#x2014;
-<div class="Nd">Game Boy checksum fixer</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<table class="Nm">
-  <tr>
-    <td><code class="Nm">rgbfix</code></td>
-    <td>[<code class="Fl">-CcjsVv</code>] [<code class="Fl">-f</code>
-      <var class="Ar">fix_spec</var>] [<code class="Fl">-i</code>
-      <var class="Ar">game_id</var>] [<code class="Fl">-k</code>
-      <var class="Ar">licensee_str</var>] [<code class="Fl">-l</code>
-      <var class="Ar">licensee_id</var>] [<code class="Fl">-m</code>
-      <var class="Ar">mbc_type</var>] [<code class="Fl">-n</code>
-      <var class="Ar">rom_version</var>] [<code class="Fl">-p</code>
-      <var class="Ar">pad_value</var>] [<code class="Fl">-r</code>
-      <var class="Ar">ram_size</var>] [<code class="Fl">-t</code>
-      <var class="Ar">title_str</var>] <var class="Ar">file</var></td>
-  </tr>
-</table>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-The <code class="Nm">rgbfix</code> program changes headers of Game Boy ROM
-  images. It also performs other filetype operations, such as truncation. The
-  arguments are as follows:
-<dl class="Bl-tag">
-  <dt><a class="permalink" href="#C"><code class="Fl" id="C">-C</code></a></dt>
-  <dd>Set the Game Boy Color&#x2013;only flag: <span class="Ad">0x143</span> =
-      0xC0. If both this and the <code class="Fl">-c</code> flag are set, this
-      takes precedence.</dd>
-  <dt><a class="permalink" href="#c"><code class="Fl" id="c">-c</code></a></dt>
-  <dd>Set the Game Boy Color&#x2013;compatible flag:
-      <span class="Ad">0x143</span> = 0x80. If both this and the
-      <code class="Fl">-C</code> flag are set, <code class="Fl">-C</code> takes
-      precedence.</dd>
-  <dt><a class="permalink" href="#f"><code class="Fl" id="f">-f</code></a>
-    <var class="Ar">fix_spec</var></dt>
-  <dd>Fix certain header values that the Game Boy checks for correctness.
-      Alternatively, intentionally trash these values by writing their binary
-      inverse instead. <var class="Ar">fix_spec</var> is a string containing any
-      combination of the following characters:
-    <p class="Pp"></p>
-    <dl class="Bl-tag Bl-compact">
-      <dt><a class="permalink" href="#l"><code class="Cm" id="l">l</code></a></dt>
-      <dd>Fix the Nintendo logo
-          (<span class="Ad">0x104</span>&#x2013;<span class="Ad">0x133</span>).</dd>
-      <dt><a class="permalink" href="#L"><code class="Cm" id="L">L</code></a></dt>
-      <dd>Trash the Nintendo logo.</dd>
-      <dt><a class="permalink" href="#h"><code class="Cm" id="h">h</code></a></dt>
-      <dd>Fix the header checksum (<span class="Ad">0x14D</span>).</dd>
-      <dt><a class="permalink" href="#H"><code class="Cm" id="H">H</code></a></dt>
-      <dd>Trash the header checksum.</dd>
-      <dt><a class="permalink" href="#g"><code class="Cm" id="g">g</code></a></dt>
-      <dd>Fix the global checksum
-          (<span class="Ad">0x14E</span>&#x2013;<span class="Ad">0x14F</span>).</dd>
-      <dt><a class="permalink" href="#G"><code class="Cm" id="G">G</code></a></dt>
-      <dd>Trash the global checksum.</dd>
-    </dl>
-  </dd>
-  <dt><a class="permalink" href="#i"><code class="Fl" id="i">-i</code></a>
-    <var class="Ar">game_id</var></dt>
-  <dd>Set the game ID string
-      (<span class="Ad">0x13F</span>&#x2013;<span class="Ad">0x142</span>) to a
-      given string of exactly 4 characters. If both this and the title are set,
-      the game ID will overwrite the overlapping portion of the title.</dd>
-  <dt><a class="permalink" href="#j"><code class="Fl" id="j">-j</code></a></dt>
-  <dd>Set the non-Japanese region flag: <span class="Ad">0x14A</span> = 1.</dd>
-  <dt><a class="permalink" href="#k"><code class="Fl" id="k">-k</code></a>
-    <var class="Ar">licensee_str</var></dt>
-  <dd>Set the new licensee string
-      (<span class="Ad">0x144</span>&#x2013;<span class="Ad">0x145</span>) to a
-      given string, truncated to at most two characters.</dd>
-  <dt><a class="permalink" href="#l_2"><code class="Fl" id="l_2">-l</code></a>
-    <var class="Ar">licensee_id</var></dt>
-  <dd>Set the old licensee code, <span class="Ad">0x14B</span>, to a given value
-      from 0 to 0xFF. This value is deprecated and should be set to 0x33 in all
-      new software.</dd>
-  <dt><a class="permalink" href="#m"><code class="Fl" id="m">-m</code></a>
-    <var class="Ar">mbc_type</var></dt>
-  <dd>Set the MBC type, <span class="Ad">0x147</span>, to a given value from 0
-      to 0xFF.</dd>
-  <dt><a class="permalink" href="#n"><code class="Fl" id="n">-n</code></a>
-    <var class="Ar">rom_version</var></dt>
-  <dd>Set the ROM version, <span class="Ad">0x14C</span>, to a given value from
-      0 to 0xFF.</dd>
-  <dt><a class="permalink" href="#p"><code class="Fl" id="p">-p</code></a>
-    <var class="Ar">pad_value</var></dt>
-  <dd>Pad the image to a valid size with a given pad value from 0 to 0xFF.
-      <code class="Nm">rgbfix</code> will automatically pick a size from 32KiB,
-      64KiB, 128KiB, ..., 8192KiB and give a warning thereafter. The cartridge
-      size byte (<span class="Ad">0x148</span>) will be changed to reflect this
-      new size.</dd>
-  <dt><a class="permalink" href="#r"><code class="Fl" id="r">-r</code></a>
-    <var class="Ar">ram_size</var></dt>
-  <dd>Set the RAM size, <span class="Ad">0x149</span>, to a given value from 0
-      to 0xFF.</dd>
-  <dt><a class="permalink" href="#s"><code class="Fl" id="s">-s</code></a></dt>
-  <dd>Set the SGB flag: <span class="Ad">0x146</span> = 3.</dd>
-  <dt><a class="permalink" href="#t"><code class="Fl" id="t">-t</code></a>
-    <var class="Ar">title</var></dt>
-  <dd>Set the title string
-      (<span class="Ad">0x134</span>&#x2013;<span class="Ad">0x143</span>) to a
-      given string, truncated to at most 16 characters. It is recommended to use
-      15 characters instead, to avoid clashing with the CGB flag
-      (<code class="Fl">-c</code> or <code class="Fl">-C</code>). If both this
-      and the game ID are set, the game ID will overwrite the overlapping
-      portion of the title.</dd>
-  <dt><a class="permalink" href="#V"><code class="Fl" id="V">-V</code></a></dt>
-  <dd>Print the version of the program and exit.</dd>
-  <dt><a class="permalink" href="#v"><code class="Fl" id="v">-v</code></a></dt>
-  <dd>Equivalent to <code class="Fl">-f</code> <code class="Cm">lhg</code>.</dd>
-</dl>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-Most values in the ROM header are only cosmetic. The bare minimum requirements
-  for a workable image are checksums, the Nintendo logo, and (if needed) the
-  CGB/SGB flags. It is a good idea to pad the image to a valid size as well
-  (&#x201C;valid&#x201D; meaning a multiple of 32KiB).
-<p class="Pp">The following will make a plain, no-color Game Boy game without
-    checking for a valid size:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbfix -v foo.gb</div>
-<p class="Pp">The following will make a SGB-enabled, color-enabled game with a
-    title of &#x201C;foobar&#x201D;, and pad it to a multiple of 32KiB. (The
-    Game Boy itself does not use the title, but some emulators or ROM managers
-    might.)</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbfix -vcs -l 0x33 -p 0 -t foobar baz.gb</div>
-<p class="Pp">The following will duplicate the header (sans global checksum) of
-    the game &#x201C;Survival Kids&#x201D;:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbfix -cjsv -k A4 -l 0x33 -m 0x1B -p 0xFF -r 3 -t
-  SURVIVALKIDAVKE SurvivalKids.gbc</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
-  ALSO</a></h1>
-<a class="Xr">rgbasm(1)</a>, <a class="Xr">rgblink(1)</a>,
-  <a class="Xr">rgbds(7)</a>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<code class="Nm">rgbfix</code> was originally released by Carsten
-  S&#x00F8;rensen as a standalone program called gbfix, and was later packaged
-  in RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
-  <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.
-</section>
-</div>
-<table class="foot">
-  <tr>
-    <td class="foot-date">March 11, 2018</td>
-    <td class="foot-os">RGBDS Manual</td>
-  </tr>
-</table>
-</body>
-</html>

docs/rgbgfx.1.html

@@ -1,180 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- This is an automatically generated file.  Do not edit.
-   This file is part of RGBDS.
-  
-   Copyright (c) 2013-2018, stag019 and RGBDS contributors.
-  
-   SPDX-License-Identifier: MIT
-   -->
-<head>
-  <meta charset="utf-8"/>
-  <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
-  <title>RGBGFX(1)</title>
-</head>
-<body>
-<table class="head">
-  <tr>
-    <td class="head-ltitle">RGBGFX(1)</td>
-    <td class="head-vol">General Commands Manual</td>
-    <td class="head-rtitle">RGBGFX(1)</td>
-  </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<code class="Nm">rgbgfx</code> &#x2014;
-<div class="Nd">Game Boy graphics converter</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<table class="Nm">
-  <tr>
-    <td><code class="Nm">rgbgfx</code></td>
-    <td>[<code class="Fl">-ADfFhmPTuVv</code>] [<code class="Fl">-o</code>
-      <var class="Ar">outfile</var>] [<code class="Fl">-a</code>
-      <var class="Ar">attrmap</var>] [<code class="Fl">-d</code>
-      <var class="Ar">depth</var>] [<code class="Fl">-p</code>
-      <var class="Ar">palfile</var>] [<code class="Fl">-t</code>
-      <var class="Ar">tilemap</var>] [<code class="Fl">-x</code>
-      <var class="Ar">tiles</var>] <var class="Ar">file</var></td>
-  </tr>
-</table>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-The <code class="Nm">rgbgfx</code> program converts PNG images into the Nintendo
-  Game Boy's planar tile format.
-<p class="Pp">The resulting colors and their palette indices are determined
-    differently depending on the input PNG file:</p>
-<ul class="Bl-dash">
-  <li>If the file has an embedded palette, that palette's color and order are
-      used.</li>
-  <li>If not, and the image only contains shades of gray, rgbgfx maps them to
-      the indices appropriate for each shade. Any undetermined indices are set
-      to respective default shades of gray. For example: if the bit depth is 2
-      and the image contains light gray and black, they become the second and
-      fourth colors - and the first and third colors get set to default white
-      and dark gray. If the image has multiple shades that map to the same
-      index, the palette is instead determined as if the image had color.</li>
-  <li>If the image has color (or the grayscale method failed), the colors are
-      sorted from lightest to darkest.</li>
-</ul>
-<p class="Pp">The input image may not contain more colors than the selected bit
-    depth allows. Transparent pixels are set to palette index 0.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="ARGUMENTS"><a class="permalink" href="#ARGUMENTS">ARGUMENTS</a></h1>
-<dl class="Bl-tag">
-  <dt><a class="permalink" href="#a"><code class="Fl" id="a">-a</code></a>
-    <var class="Ar">attrmap</var></dt>
-  <dd>Generate a file of tile mirroring attributes for OAM or (CGB-only)
-      background tiles. For each tile in the input file, a byte is written
-      representing the dimensions that the associated tile in the output file
-      should be mirrored. Useful in combination with <code class="Fl">-m</code>
-      to keep track the mirror direction of mirrored duplicate tiles.</dd>
-  <dt><a class="permalink" href="#A"><code class="Fl" id="A">-A</code></a></dt>
-  <dd>Same as <code class="Fl">-a</code>, but the attrmap file output name is
-      made by taking the input filename, removing the file extension, and
-      appending <span class="Pa">.attrmap</span>.</dd>
-  <dt><a class="permalink" href="#C"><code class="Fl" id="C">-C</code></a></dt>
-  <dd>Use the color curve of the Game Boy Color when generating palettes.</dd>
-  <dt><a class="permalink" href="#D"><code class="Fl" id="D">-D</code></a></dt>
-  <dd>Debug features are enabled.</dd>
-  <dt><a class="permalink" href="#f"><code class="Fl" id="f">-f</code></a></dt>
-  <dd>Fix the input PNG file to be a correctly indexed image.</dd>
-  <dt><a class="permalink" href="#F"><code class="Fl" id="F">-F</code></a></dt>
-  <dd>Same as <code class="Fl">-f</code>, but additionally, the supplied command
-      line parameters are saved within the PNG and will be loaded and
-      automatically used next time.</dd>
-  <dt><a class="permalink" href="#d"><code class="Fl" id="d">-d</code></a>
-    <var class="Ar">depth</var></dt>
-  <dd>The bit depth of the output image (either 1 or 2). By default, the bit
-      depth is 2 (two bits per pixel).</dd>
-  <dt><a class="permalink" href="#h"><code class="Fl" id="h">-h</code></a></dt>
-  <dd>Lay out tiles horizontally rather than vertically.</dd>
-  <dt><a class="permalink" href="#m"><code class="Fl" id="m">-m</code></a></dt>
-  <dd>Truncate tiles by checking for tiles that are mirrored versions of others
-      and omitting these from the output file. Useful with tilemaps and attrmaps
-      together to keep track of the duplicated tiles and the dimension mirrored.
-      Tiles are checked for horizontal, vertical, and horizontal-vertical
-      mirroring. Implies <code class="Fl">-u</code>.</dd>
-  <dt><a class="permalink" href="#o"><code class="Fl" id="o">-o</code></a>
-    <var class="Ar">outfile</var></dt>
-  <dd>The name of the output file.</dd>
-  <dt><a class="permalink" href="#p"><code class="Fl" id="p">-p</code></a>
-    <var class="Ar">palfile</var></dt>
-  <dd>Output the image's palette in standard GBC palette format - bytes (8 bytes
-      for two bits per pixel, 4 bytes for one bit per pixel) containing the
-      RGB15 values in little-endian byte order. If the palette contains too few
-      colors, the remaining entries are set to black.</dd>
-  <dt><a class="permalink" href="#P"><code class="Fl" id="P">-P</code></a></dt>
-  <dd>Same as <code class="Fl">-p</code>, but the palette file output name is
-      made by taking the input PNG file's filename, removing the file extension,
-      and appending <span class="Pa">.pal</span>.</dd>
-  <dt><a class="permalink" href="#t"><code class="Fl" id="t">-t</code></a>
-    <var class="Ar">tilemap</var></dt>
-  <dd>Generate a file of tile indices. For each tile in the input file, a byte
-      is written representing the index of the associated tile in the output
-      file. Useful in combination with <code class="Fl">-u</code> or
-      <code class="Fl">-m</code> to keep track of duplicate tiles.</dd>
-  <dt><a class="permalink" href="#T"><code class="Fl" id="T">-T</code></a></dt>
-  <dd>Same as <code class="Fl">-t</code>, but the tilemap file output name is
-      made by taking the input filename, removing the file extension, and
-      appending <span class="Pa">.tilemap</span>.</dd>
-  <dt><a class="permalink" href="#u"><code class="Fl" id="u">-u</code></a></dt>
-  <dd>Truncate tiles by checking for tiles that are exact duplicates of others
-      and omitting these from the output file. Useful with tilemaps to keep
-      track of the duplicated tiles.</dd>
-  <dt><a class="permalink" href="#V"><code class="Fl" id="V">-V</code></a></dt>
-  <dd>Print the version of the program and exit.</dd>
-  <dt><a class="permalink" href="#v"><code class="Fl" id="v">-v</code></a></dt>
-  <dd>Verbose. Print errors when the command line parameters and the parameters
-      in the PNG file don't match.</dd>
-  <dt><a class="permalink" href="#x"><code class="Fl" id="x">-x</code></a>
-    <var class="Ar">tiles</var></dt>
-  <dd>Trim the end of the output file by this many tiles.</dd>
-</dl>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-The following will take a PNG file with a bit depth of 1, 2, or 8, and output
-  planar 2bpp data:
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbgfx -o out.2bpp in.png</div>
-<p class="Pp">The following creates a planar 2bpp file with only unique tiles,
-    and its tilemap <span class="Pa">out.tilemap</span>:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbgfx -T -u -o out.2bpp in.png</div>
-<p class="Pp">The following creates a planar 2bpp file with only unique tiles
-    (accounting for tile mirroring) and its associated tilemap
-    <span class="Pa">out.tilemap</span> and attrmap
-    <span class="Pa">out.attrmap</span>:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbgfx -A -T -m -o out.2bpp in.png</div>
-<p class="Pp">The following will do nothing:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbgfx in.png</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
-  ALSO</a></h1>
-<a class="Xr">rgbds(7)</a>, <a class="Xr">rgbasm(1)</a>,
-  <a class="Xr">rgblink(1)</a>, <a class="Xr">rgbfix(1)</a>,
-  <a class="Xr">gbz80(7)</a>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<code class="Nm">rgbgfx</code> was created by <span class="An">stag019</span> to
-  be included in RGBDS. It is now maintained by a number of contributors at
-  <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.
-</section>
-</div>
-<table class="foot">
-  <tr>
-    <td class="foot-date">January 26, 2018</td>
-    <td class="foot-os">RGBDS Manual</td>
-  </tr>
-</table>
-</body>
-</html>

docs/rgblink.1.html

@@ -1,138 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- This is an automatically generated file.  Do not edit.
-   This file is part of RGBDS.
-  
-   Copyright (c) 2010-2018, Anthony J. Bentley and RGBDS contributors.
-  
-   SPDX-License-Identifier: MIT
-   -->
-<head>
-  <meta charset="utf-8"/>
-  <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
-  <title>RGBLINK(1)</title>
-</head>
-<body>
-<table class="head">
-  <tr>
-    <td class="head-ltitle">RGBLINK(1)</td>
-    <td class="head-vol">General Commands Manual</td>
-    <td class="head-rtitle">RGBLINK(1)</td>
-  </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<code class="Nm">rgblink</code> &#x2014;
-<div class="Nd">Game Boy linker</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<table class="Nm">
-  <tr>
-    <td><code class="Nm">rgblink</code></td>
-    <td>[<code class="Fl">-dtVw</code>] [<code class="Fl">-m</code>
-      <var class="Ar">mapfile</var>] [<code class="Fl">-n</code>
-      <var class="Ar">symfile</var>] [<code class="Fl">-O</code>
-      <var class="Ar">overlayfile</var>] [<code class="Fl">-o</code>
-      <var class="Ar">outfile</var>] [<code class="Fl">-p</code>
-      <var class="Ar">pad_value</var>] [<code class="Fl">-s</code>
-      <var class="Ar">symbol</var>] [<code class="Fl">-l</code>
-      <var class="Ar">linkerscript</var>] <var class="Ar">file ...</var></td>
-  </tr>
-</table>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-The <code class="Nm">rgblink</code> program links objects created by
-  <a class="Xr">rgbasm(1)</a> into a single Game Boy ROM file.
-<p class="Pp">By default, ROM0 sections created by the assembler are placed in
-    the 16KiB bank 0, and ROMX sections are placed in any bank except bank 0. If
-    your ROM will only be 32KiB, you can use the <code class="Fl">-t</code>
-    option to override this.</p>
-<p class="Pp">Similarly, WRAM0 sections are placed in the first 4KiB of WRAM
-    bank 0 and WRAMX sections are placed in any bank except bank 0. If your ROM
-    doesn't use banked WRAM you can use option <code class="Fl">-w</code> option
-    to override this.</p>
-<p class="Pp">Also, if your ROM is designed for DMG, you can make sure that you
-    don't use any prohibited section by using the option
-    <code class="Fl">-d</code>, which implies <code class="Fl">-w</code> but
-    also prohibits the use of VRAM bank 1.</p>
-<p class="Pp">The arguments are as follows:</p>
-<dl class="Bl-tag">
-  <dt><a class="permalink" href="#m"><code class="Fl" id="m">-m</code></a>
-    <var class="Ar">mapfile</var></dt>
-  <dd>Write a mapfile to the given filename.</dd>
-  <dt><a class="permalink" href="#n"><code class="Fl" id="n">-n</code></a>
-    <var class="Ar">symfile</var></dt>
-  <dd>Write a symbol file to the given filename.</dd>
-  <dt><a class="permalink" href="#O"><code class="Fl" id="O">-O</code></a>
-    <var class="Ar">overlayfile</var></dt>
-  <dd>The ROM image to overlay sections over. When an overlay ROM is provided,
-      all sections must be fixed. This may be used to patch an existing
-    binary.</dd>
-  <dt><a class="permalink" href="#o"><code class="Fl" id="o">-o</code></a>
-    <var class="Ar">outfile</var></dt>
-  <dd>Write ROM image to the given filename.</dd>
-  <dt><a class="permalink" href="#p"><code class="Fl" id="p">-p</code></a>
-    <var class="Ar">pad_value</var></dt>
-  <dd>When padding an image, pad with this value. The default is 0x00.</dd>
-  <dt><a class="permalink" href="#s"><code class="Fl" id="s">-s</code></a>
-    <var class="Ar">symbol</var></dt>
-  <dd>???</dd>
-  <dt><a class="permalink" href="#w"><code class="Fl" id="w">-w</code></a></dt>
-  <dd>Expand the WRAM0 section size from 4KiB to the full 8KiB assigned to WRAM
-      and prohibit the use of WRAMX sections.</dd>
-  <dt><a class="permalink" href="#d"><code class="Fl" id="d">-d</code></a></dt>
-  <dd>Enable DMG mode. Prohibit the use of sections that doesn't exist on a DMG,
-      such as WRAMX and VRAM bank 1. This option automatically enables
-      <code class="Fl">-w</code>.</dd>
-  <dt><a class="permalink" href="#t"><code class="Fl" id="t">-t</code></a></dt>
-  <dd>Expand the ROM0 section size from 16KiB to the full 32KiB assigned to ROM
-      and prohibit the use of ROMX sections. Useful for ROMs that fit in 32
-    KiB.</dd>
-  <dt><a class="permalink" href="#l"><code class="Fl" id="l">-l</code></a>
-    <var class="Ar">linkerscript</var></dt>
-  <dd>Specify a linkerscript file that tells the linker how sections must be
-      placed in the ROM. This file has priority over the attributes assigned in
-      the source code, but they have to be consistent. See
-      <a class="Xr">rgblink(5)</a> for more information about its format.</dd>
-  <dt><a class="permalink" href="#V"><code class="Fl" id="V">-V</code></a></dt>
-  <dd>Print the version of the program and exit.</dd>
-</dl>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-All you need for a basic ROM is an object file, which can be made into a ROM
-  image like so:
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgblink -o bar.gb foo.o</div>
-<p class="Pp">The resulting bar.gb will not have correct checksums (unless you
-    put them in the assembly source). You should use <a class="Xr">rgbfix(1)</a>
-    to fix these so that the program will actually run in a Game Boy:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent">$ rgbfix -v bar.gb</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
-  ALSO</a></h1>
-<a class="Xr">rgbasm(1)</a>, <a class="Xr">rgblink(5)</a>,
-  <a class="Xr">rgbfix(1)</a>, <a class="Xr">rgbds(5)</a>,
-  <a class="Xr">rgbds(7)</a>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<code class="Nm">rgblink</code> was originally written by Carsten
-  S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-  RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
-  <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.
-</section>
-</div>
-<table class="foot">
-  <tr>
-    <td class="foot-date">January 26, 2018</td>
-    <td class="foot-os">RGBDS Manual</td>
-  </tr>
-</table>
-</body>
-</html>

docs/rgblink.5.html

@@ -1,105 +0,0 @@
-<!DOCTYPE html>
-<html>
-<!-- This is an automatically generated file.  Do not edit.
-   This file is part of RGBDS.
-  
-   Copyright (c) 2017-2018, Antonio Nino Diaz and RGBDS contributors.
-  
-   SPDX-License-Identifier: MIT
-   -->
-<head>
-  <meta charset="utf-8"/>
-  <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
-  <title>RGBLINK(5)</title>
-</head>
-<body>
-<table class="head">
-  <tr>
-    <td class="head-ltitle">RGBLINK(5)</td>
-    <td class="head-vol">File Formats Manual</td>
-    <td class="head-rtitle">RGBLINK(5)</td>
-  </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<code class="Nm">rgblink</code> &#x2014;
-<div class="Nd">linkerscript file format</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-The linkerscript is an external file that allows the user to specify the order
-  of sections without the need for doing so before assembling each object file.
-<p class="Pp">The placement of sections specified in the linkerscript is done
-    before the sections whose placement is defined in the source code.</p>
-<p class="Pp">A linkerscript consists on a series of banks followed by a list of
-    sections and, optionally, commands. They can be lowercase or uppercase, it
-    is ignored. Any line can contain a comment starting with
-    &#x2018;<code class="Li">;</code>&#x2019; that ends at the end of the
-  line:</p>
-<div class="Bd Pp Bd-indent">
-<pre>
-ROMX $F ; This is a comment
-  &quot;Functions to read array&quot;
-  ALIGN 8
-  &quot;Array aligned to 256 bytes&quot;
-
-WRAMX 2
-  &quot;Some variables&quot;
-</pre>
-</div>
-<p class="Pp">Numbers can be in decimal or hexadecimal format (the prefix is
-    &#x2018;<code class="Li">$</code>&#x2019;). It is an error if any section
-    name or command are found before setting a bank.</p>
-<p class="Pp">Files can be included by using the <var class="Ar">INCLUDE</var>
-    keyword followed by a string with the path of the file that has to be
-    included.</p>
-<p class="Pp">The possible bank types are: <b class="Sy">ROM0</b>,
-    <b class="Sy">ROMX</b>, <b class="Sy">VRAM</b>, <b class="Sy">WRAM0</b>,
-    <b class="Sy">WRAMX</b>, <b class="Sy">OAM</b> and <b class="Sy">HRAM</b>.
-    Types <b class="Sy">ROMX</b>, <b class="Sy">VRAM</b>,
-    <b class="Sy">WRAMX</b> and <b class="Sy">SRAM</b> are banked, which means
-    that it is needed to specify a bank after the type.</p>
-<p class="Pp">When a new bank statement is found, sections found after it will
-    be placed right from the beginning of that bank. If the linkerscript
-    switches to a different bank and then it comes back to the previous one it
-    will continue from the last address that was used.</p>
-<p class="Pp">The only two commands are <var class="Ar">ORG</var> and
-    <var class="Ar">ALIGN</var>:</p>
-<ul class="Bl-bullet">
-  <li><var class="Ar">ORG</var> sets the address in which new sections will be
-      placed. It can not be lower than the current address.</li>
-  <li><var class="Ar">ALIGN</var> will increase the address until it is aligned
-      to the specified boundary (it tries to set to 0 the number of bits
-      specified after the command: <b class="Sy">ALIGN 8</b> will align to
-      $100).</li>
-</ul>
-<p class="Pp">Note: The bank, alignment, address and type of sections can be
-    specified both in the source code and in the linkerscript. For a section to
-    be able to be placed with the linkerscript the bank must be left unassigned
-    in the source code or be the same as the one specified in the linkerscript.
-    The address and alignment musn't be set.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
-  ALSO</a></h1>
-<a class="Xr">rgbasm(1)</a>, <a class="Xr">rgblink(1)</a>,
-  <a class="Xr">rgbfix(1)</a>, <a class="Xr">rgbds(5)</a>,
-  <a class="Xr">rgbds(7)</a>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<code class="Nm">rgblink</code> was originally written by Carsten
-  S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-  RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
-  <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.
-</section>
-</div>
-<table class="foot">
-  <tr>
-    <td class="foot-date">January 27, 2018</td>
-    <td class="foot-os">RGBDS Manual</td>
-  </tr>
-</table>
-</body>
-</html>

include/asm/asm.h

@@ -1,45 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-/*
- * Contains some assembler-wide defines and externs
- */
-
-#ifndef RGBDS_ASM_ASM_H
-#define RGBDS_ASM_ASM_H
-
-#include <stdbool.h>
-#include <stdint.h>
-#include <stdio.h>
-#include <stdlib.h>
-
-#include "asm/localasm.h"
-#include "asm/symbol.h"
-
-#define MAXUNIONS	128
-#define MAXMACROARGS	256
-#define MAXINCPATHS	128
-
-extern int32_t nLineNo;
-extern uint32_t nTotalLines;
-extern uint32_t nPC;
-extern uint32_t nIFDepth;
-extern bool skipElif;
-extern uint32_t nUnionDepth;
-extern uint32_t unionStart[MAXUNIONS];
-extern uint32_t unionSize[MAXUNIONS];
-extern char tzCurrentFileName[_MAX_PATH + 1];
-extern struct Section *pCurrentSection;
-extern struct sSymbol *tHashedSymbols[HASHSIZE];
-extern struct sSymbol *pPCSymbol;
-extern bool oDontExpandStrings;
-
-size_t symvaluetostring(char *dest, size_t maxLength, char *sym,
-			const char *mode);
-
-#endif /* RGBDS_ASM_ASM_H */

include/asm/charmap.h

@@ -11,33 +11,13 @@
 
 #include <stdint.h>
 
-#define MAXCHARMAPS	512
-#define CHARMAPLENGTH	16
-#define MAXCHARNODES	(MAXCHARMAPS * CHARMAPLENGTH + 1)
-
-/*
- * A node for trie structure.
- */
-struct Charnode {
-	uint8_t code; /* the value in a key-value pair. */
-	uint8_t isCode; /* has one if it's a code node, not just a bridge node. */
-	struct Charnode *next[256]; /* each index representing the next possible character from its current state. */
-};
-
-struct Charmap {
-	char name[MAXSYMLEN + 1];
-	int32_t charCount; /* user-side count. */
-	int32_t nodeCount; /* node-side count. */
-	struct Charnode nodes[MAXCHARNODES]; /* first node is reserved for the root node in charmap. */
-	struct Charmap *next; /* next charmap in hash table bucket */
-};
-
-void charmap_InitMain(void);
-struct Charmap *charmap_New(const char *name, const char *baseName);
-void charmap_Set(const char *name);
+struct Charmap *charmap_New(char const *name, char const *baseName);
+void charmap_Delete(struct Charmap *charmap);
+void charmap_Set(char const *name);
 void charmap_Push(void);
 void charmap_Pop(void);
-int32_t charmap_Add(char *input, uint8_t output);
-int32_t charmap_Convert(char **input);
+void charmap_Add(char *mapping, uint8_t value);
+size_t charmap_Convert(char const *input, uint8_t *output);
+size_t charmap_ConvertNext(char const **input, uint8_t **output);
 
 #endif /* RGBDS_ASM_CHARMAP_H */

include/asm/constexpr.h

@@ -1,33 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_ASM_CONSTEXPR_H
-#define RGBDS_ASM_CONSTEXPR_H
-
-#include <stdint.h>
-
-struct ConstExpression {
-	union {
-		int32_t nVal;
-		struct sSymbol *pSym;
-	} u;
-	uint32_t isSym;
-};
-
-void constexpr_Symbol(struct ConstExpression *expr, char *tzSym);
-void constexpr_Number(struct ConstExpression *expr, int32_t i);
-void constexpr_UnaryOp(struct ConstExpression *expr,
-		       int32_t op,
-		       const struct ConstExpression *src);
-void constexpr_BinaryOp(struct ConstExpression *expr,
-			int32_t op,
-			const struct ConstExpression *src1,
-			const struct ConstExpression *src2);
-int32_t constexpr_GetConstantValue(struct ConstExpression *expr);
-
-#endif /* RGBDS_ASM_CONSTEXPR_H */

include/asm/fixpoint.h

@@ -0,0 +1,31 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 1997-2021, Carsten Sorensen and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef RGBDS_ASM_FIXPOINT_H
+#define RGBDS_ASM_FIXPOINT_H
+
+#include <stdint.h>
+
+int32_t fix_Callback_PI(void);
+void fix_Print(int32_t i);
+int32_t fix_Sin(int32_t i);
+int32_t fix_Cos(int32_t i);
+int32_t fix_Tan(int32_t i);
+int32_t fix_ASin(int32_t i);
+int32_t fix_ACos(int32_t i);
+int32_t fix_ATan(int32_t i);
+int32_t fix_ATan2(int32_t i, int32_t j);
+int32_t fix_Mul(int32_t i, int32_t j);
+int32_t fix_Div(int32_t i, int32_t j);
+int32_t fix_Pow(int32_t i, int32_t j);
+int32_t fix_Log(int32_t i, int32_t j);
+int32_t fix_Round(int32_t i);
+int32_t fix_Ceil(int32_t i);
+int32_t fix_Floor(int32_t i);
+
+#endif /* RGBDS_ASM_FIXPOINT_H */

include/asm/format.h

@@ -0,0 +1,63 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 2020, RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef RGBDS_FORMAT_SPEC_H
+#define RGBDS_FORMAT_SPEC_H
+
+#include <stdbool.h>
+#include <stdint.h>
+
+enum FormatState {
+	FORMAT_SIGN,    // expects '+' or ' ' (optional)
+	FORMAT_PREFIX,  // expects '#' (optional)
+	FORMAT_ALIGN,   // expects '-' (optional)
+	FORMAT_WIDTH,   // expects '0'-'9', max 255 (optional) (leading '0' indicates pad)
+	FORMAT_FRAC,    // got '.', expects '0'-'9', max 255 (optional)
+	FORMAT_DONE,    // got [duXxbofs] (required)
+	FORMAT_INVALID, // got unexpected character
+};
+
+struct FormatSpec {
+	enum FormatState state;
+	int sign;
+	bool prefix;
+	bool alignLeft;
+	bool padZero;
+	size_t width;
+	bool hasFrac;
+	size_t fracWidth;
+	int type;
+	bool valid;
+};
+
+struct StrFmtArg {
+	union {
+		uint32_t number;
+		char *string;
+	};
+	bool isNumeric;
+};
+
+#define INITIAL_STRFMT_ARG_SIZE 4
+struct StrFmtArgList {
+	char *format;
+	size_t nbArgs;
+	size_t capacity;
+	struct StrFmtArg *args;
+};
+
+struct FormatSpec fmt_NewSpec(void);
+bool fmt_IsEmpty(struct FormatSpec const *fmt);
+bool fmt_IsValid(struct FormatSpec const *fmt);
+bool fmt_IsFinished(struct FormatSpec const *fmt);
+void fmt_UseCharacter(struct FormatSpec *fmt, int c);
+void fmt_FinishCharacters(struct FormatSpec *fmt);
+void fmt_PrintString(char *buf, size_t bufLen, struct FormatSpec const *fmt, char const *value);
+void fmt_PrintNumber(char *buf, size_t bufLen, struct FormatSpec const *fmt, uint32_t value);
+
+#endif /* RGBDS_FORMAT_SPEC_H */

include/asm/fstack.h

@@ -13,41 +13,71 @@
 #ifndef RGBDS_ASM_FSTACK_H
 #define RGBDS_ASM_FSTACK_H
 
+#include <stdbool.h>
 #include <stdint.h>
 #include <stdio.h>
 
-#include "asm/asm.h"
 #include "asm/lexer.h"
 
-#include "types.h"
 
-struct sContext {
-	YY_BUFFER_STATE FlexHandle;
-	struct sSymbol *pMacro;
-	struct sContext *pNext;
-	char tzFileName[_MAX_PATH + 1];
-	char *tzMacroArgs[MAXMACROARGS + 1];
-	int32_t nLine;
-	uint32_t nStatus;
-	FILE *pFile;
-	char *pREPTBlock;
-	uint32_t nREPTBlockCount;
-	uint32_t nREPTBlockSize;
-	int32_t nREPTBodyFirstLine;
-	int32_t nREPTBodyLastLine;
+struct FileStackNode {
+	struct FileStackNode *parent; /* Pointer to parent node, for error reporting */
+	/* Line at which the parent context was exited; meaningless for the root level */
+	uint32_t lineNo;
+
+	struct FileStackNode *next; /* Next node in the output linked list */
+	bool referenced; /* If referenced, don't free! */
+	uint32_t ID; /* Set only if referenced: ID within the object file, -1 if not output yet */
+
+	enum {
+		NODE_REPT,
+		NODE_FILE,
+		NODE_MACRO,
+	} type;
 };
 
-extern unsigned int nMaxRecursionDepth;
+struct FileStackReptNode { /* NODE_REPT */
+	struct FileStackNode node;
+	uint32_t reptDepth;
+	/* WARNING: if changing this type, change overflow check in `fstk_Init` */
+	uint32_t iters[]; /* REPT iteration counts since last named node, in reverse depth order */
+};
 
-void fstk_RunInclude(char *tzFileName);
-void fstk_RunMacroArg(int32_t s);
-void fstk_Init(char *s);
-void fstk_Dump(void);
-void fstk_DumpStringExpansions(void);
-void fstk_AddIncludePath(char *s);
-uint32_t fstk_RunMacro(char *s);
-void fstk_RunRept(uint32_t count, int32_t nReptLineNo);
-FILE *fstk_FindFile(char *fname, char **incPathUsed);
-int32_t fstk_GetLine(void);
+struct FileStackNamedNode { /* NODE_FILE, NODE_MACRO */
+	struct FileStackNode node;
+	char name[]; /* File name for files, file::macro name for macros */
+};
+
+extern size_t maxRecursionDepth;
+
+struct MacroArgs;
+
+void fstk_Dump(struct FileStackNode const *node, uint32_t lineNo);
+void fstk_DumpCurrent(void);
+struct FileStackNode *fstk_GetFileStack(void);
+/* The lifetime of the returned chars is until reaching the end of that file */
+char const *fstk_GetFileName(void);
+
+void fstk_AddIncludePath(char const *s);
+/**
+ * @param path The user-provided file name
+ * @param fullPath The address of a pointer, which will be made to point at the full path
+ *                 The pointer's value must be a valid argument to `realloc`, including NULL
+ * @param size Current size of the buffer, or 0 if the pointer is NULL
+ * @return True if the file was found, false if no path worked
+ */
+bool fstk_FindFile(char const *path, char **fullPath, size_t *size);
+
+bool yywrap(void);
+void fstk_RunInclude(char const *path);
+void fstk_RunMacro(char const *macroName, struct MacroArgs *args);
+void fstk_RunRept(uint32_t count, int32_t reptLineNo, char *body, size_t size);
+void fstk_RunFor(char const *symName, int32_t start, int32_t stop, int32_t step,
+		     int32_t reptLineNo, char *body, size_t size);
+void fstk_StopRept(void);
+bool fstk_Break(void);
+
+void fstk_NewRecursionDepth(size_t newDepth);
+void fstk_Init(char const *mainPath, size_t maxDepth);
 
 #endif /* RGBDS_ASM_FSTACK_H */

include/asm/lexer.h

@@ -9,78 +9,94 @@
 #ifndef RGBDS_ASM_LEXER_H
 #define RGBDS_ASM_LEXER_H
 
-#include <stdint.h>
-#include <stdio.h>
+#include <stdbool.h>
 
-#define LEXHASHSIZE	(1 << 11)
 #define MAXSTRLEN	255
 
-struct sLexInitString {
-	char *tzName;
-	uint32_t nToken;
+struct LexerState;
+extern struct LexerState *lexerState;
+extern struct LexerState *lexerStateEOL;
+
+static inline struct LexerState *lexer_GetState(void)
+{
+	return lexerState;
+}
+
+static inline void lexer_SetState(struct LexerState *state)
+{
+	lexerState = state;
+}
+
+static inline void lexer_SetStateAtEOL(struct LexerState *state)
+{
+	lexerStateEOL = state;
+}
+
+extern char binDigits[2];
+extern char gfxDigits[4];
+
+static inline void lexer_SetBinDigits(char const digits[2])
+{
+	binDigits[0] = digits[0];
+	binDigits[1] = digits[1];
+}
+
+static inline void lexer_SetGfxDigits(char const digits[4])
+{
+	gfxDigits[0] = digits[0];
+	gfxDigits[1] = digits[1];
+	gfxDigits[2] = digits[2];
+	gfxDigits[3] = digits[3];
+}
+
+/*
+ * `path` is referenced, but not held onto..!
+ */
+struct LexerState *lexer_OpenFile(char const *path);
+struct LexerState *lexer_OpenFileView(char const *path, char *buf, size_t size, uint32_t lineNo);
+void lexer_RestartRept(uint32_t lineNo);
+void lexer_DeleteState(struct LexerState *state);
+void lexer_Init(void);
+
+enum LexerMode {
+	LEXER_NORMAL,
+	LEXER_RAW,
+	LEXER_SKIP_TO_ELIF,
+	LEXER_SKIP_TO_ENDC,
+	LEXER_SKIP_TO_ENDR
 };
 
-struct sLexFloat {
-	uint32_t (*Callback)(char *s, uint32_t size);
-	uint32_t nToken;
+void lexer_SetMode(enum LexerMode mode);
+void lexer_ToggleStringExpansion(bool enable);
+
+uint32_t lexer_GetIFDepth(void);
+void lexer_IncIFDepth(void);
+void lexer_DecIFDepth(void);
+bool lexer_RanIFBlock(void);
+bool lexer_ReachedELSEBlock(void);
+void lexer_RunIFBlock(void);
+void lexer_ReachELSEBlock(void);
+
+struct CaptureBody {
+	uint32_t lineNo;
+	char *body;
+	size_t size;
 };
 
-struct yy_buffer_state {
-	/* Actual starting address */
-	char *pBufferRealStart;
-	/* Address where the data is initially written after a safety margin */
-	char *pBufferStart;
-	char *pBuffer;
-	size_t nBufferSize;
-	uint32_t oAtLineStart;
-};
-
-enum eLexerState {
-	LEX_STATE_NORMAL,
-	LEX_STATE_MACROARGS
-};
-
-struct sStringExpansionPos {
-	char *tzName;
-	char *pBuffer;
-	char *pBufferPos;
-	struct sStringExpansionPos *pParent;
-};
-
-#define INITIAL		0
-#define macroarg	3
-
-typedef struct yy_buffer_state *YY_BUFFER_STATE;
-
-void setup_lexer(void);
-
-void yy_set_state(enum eLexerState i);
-YY_BUFFER_STATE yy_create_buffer(FILE *f);
-YY_BUFFER_STATE yy_scan_bytes(char *mem, uint32_t size);
-void yy_delete_buffer(YY_BUFFER_STATE buf);
-void yy_switch_to_buffer(YY_BUFFER_STATE buf);
-uint32_t lex_FloatAlloc(const struct sLexFloat *tok);
-void lex_FloatAddRange(uint32_t id, uint16_t start, uint16_t end);
-void lex_FloatDeleteRange(uint32_t id, uint16_t start, uint16_t end);
-void lex_FloatAddFirstRange(uint32_t id, uint16_t start, uint16_t end);
-void lex_FloatDeleteFirstRange(uint32_t id, uint16_t start, uint16_t end);
-void lex_FloatAddSecondRange(uint32_t id, uint16_t start, uint16_t end);
-void lex_FloatDeleteSecondRange(uint32_t id, uint16_t start, uint16_t end);
-void lex_Init(void);
-void lex_AddStrings(const struct sLexInitString *lex);
-void lex_SetBuffer(char *buffer, uint32_t len);
-void lex_BeginStringExpansion(const char *tzName);
-int yywrap(void);
+void lexer_CheckRecursionDepth(void);
+char const *lexer_GetFileName(void);
+uint32_t lexer_GetLineNo(void);
+uint32_t lexer_GetColNo(void);
+void lexer_DumpStringExpansions(void);
 int yylex(void);
-void yyunput(char c);
-void yyunputstr(const char *s);
-void yyskipbytes(uint32_t count);
-void yyunputbytes(uint32_t count);
+bool lexer_CaptureRept(struct CaptureBody *capture);
+bool lexer_CaptureMacroBody(struct CaptureBody *capture);
 
-extern YY_BUFFER_STATE pCurrentBuffer;
-extern struct sStringExpansionPos *pCurrentStringExpansion;
-
-void upperstring(char *s);
-void lowerstring(char *s);
+#define INITIAL_DS_ARG_SIZE 2
+struct DsArgList {
+	size_t nbArgs;
+	size_t capacity;
+	struct Expression *args;
+};
 
 #endif /* RGBDS_ASM_LEXER_H */

include/asm/localasm.h

@@ -1,131 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_ASM_LOCALASM_H
-#define RGBDS_ASM_LOCALASM_H
-
-/*
- * GB Z80 instruction groups
- *
- * n3 = 3-bit
- * n  = 8-bit
- * nn = 16-bit
- *
- * ADC  A,n         :   0xCE
- * ADC  A,r         :   0x88|r
- * ADD  A,n         :   0xC6
- * ADD  A,r         :   0x80|r
- * ADD  HL,ss       :   0x09|(ss<<4)
- * ADD  SP,n        :   0xE8
- * AND  A,n         :   0xE6
- * AND  A,r         :   0xA0|r
- * BIT  n3,r        :   0xCB 0x40|(n3<<3)|r
- * CALL cc,nn       :   0xC4|(cc<<3)
- * CALL nn          :   0xCD
- * CCF              :   0x3F
- * CP   A,n         :   0xFE
- * CP   A,r         :   0xB8|r
- * CPL              :   0x2F
- * DAA              :   0x27
- * DEC  r           :   0x05|(r<<3)
- * DEC  ss          :   0x0B|(ss<<4)
- * DI               :   0xF3
- * EI               :   0xFB
- * HALT             :   0x76
- * INC  r           :   0x04|(r<<3)
- * INC  ss          :   0x03|(ss<<4)
- * JP   HL          :   0xE9
- * JP   cc,nn       :   0xC2|(cc<<3)
- * JP   nn          :   0xC3|(cc<<3)
- * JR   n           :   0x18
- * JR   cc,n        :   0x20|(cc<<3)
- * LD   (nn),SP     :   0x08
- * LD   ($FF00+C),A :   0xE2
- * LD   ($FF00+n),A :   0xE0
- * LD   (nn),A      :   0xEA
- * LD   (rr),A      :   0x02|(rr<<4) // HL+ and HL- included
- * LD   A,($FF00+C) :   0xF2
- * LD   A,($FF00+n) :   0xF0
- * LD   A,(nn)      :   0xFA
- * LD   A,(rr)      :   0x0A|(rr<<4) // HL+ and HL- included
- * LD   HL,SP+n     :   0xF8
- * LD   SP,HL       :   0xF9
- * LD   r,n         :   0x06|(r<<3)
- * LD   r,r'        :   0x40|(r<<3)|r' // NOTE: LD (HL),(HL) not allowed
- * LD   ss,nn       :   0x01|(ss<<4)
- * NOP              :   0x00
- * OR   A,n         :   0xF6
- * OR   A,r         :   0xB0|r
- * POP  tt          :   0xC1|(tt<<4)
- * PUSH tt          :   0xC5|(tt<<4)
- * RES  n3,r        :   0xCB 0x80|(n3<<3)|r
- * RET              :   0xC9
- * RET  cc          :   0xC0|(cc<<3)
- * RETI             :   0xD9
- * RL   r           :   0xCB 0x10|r
- * RLA              :   0x17
- * RLC  r           :   0xCB 0x00|r
- * RLCA             :   0x07
- * RR   r           :   0xCB 0x18|r
- * RRA              :   0x1F
- * RRC  r           :   0xCB 0x08|r
- * RRCA             :   0x0F
- * RST  n           :   0xC7|n
- * SBC  A,n         :   0xDE
- * SBC  A,r         :   0x98|r
- * SCF              :   0x37
- * SET  n3,r        :   0xCB 0xC0|(n8<<3)|r
- * SLA  r           :   0xCB 0x20|r
- * SRA  r           :   0xCB 0x28|r
- * SRL  r           :   0xCB 0x38|r
- * STOP             :   0x10 0x00
- * SUB  A,n         :   0xD6
- * SUB  A,r         :   0x90|r
- * SWAP r           :   0xCB 0x30|r
- * XOR  A,n         :   0xEE
- * XOR  A,r         :   0xA8|r
- */
-
-/* "r" defs */
-enum {
-	REG_B = 0,
-	REG_C,
-	REG_D,
-	REG_E,
-	REG_H,
-	REG_L,
-	REG_HL_IND,
-	REG_A
-};
-
-/* "rr" defs */
-enum {
-	REG_BC_IND = 0,
-	REG_DE_IND,
-	REG_HL_INDINC,
-	REG_HL_INDDEC,
-};
-
-/* "ss" defs (SP) and "tt" defs (AF) */
-enum {
-	REG_BC = 0,
-	REG_DE = 1,
-	REG_HL = 2,
-	REG_SP = 3,
-	REG_AF = 3
-};
-
-/* "cc" defs */
-enum {
-	CC_NZ = 0,
-	CC_Z,
-	CC_NC,
-	CC_C
-};
-
-#endif /* RGBDS_ASM_LOCALASM_H */

include/asm/macro.h

@@ -0,0 +1,37 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 2020, Carsten Sorensen and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef RGBDS_MACRO_H
+#define RGBDS_MACRO_H
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <stdlib.h>
+
+#include "asm/warning.h"
+
+#include "helpers.h"
+
+struct MacroArgs;
+
+struct MacroArgs *macro_GetCurrentArgs(void);
+struct MacroArgs *macro_NewArgs(void);
+void macro_AppendArg(struct MacroArgs **args, char *s);
+void macro_UseNewArgs(struct MacroArgs *args);
+void macro_FreeArgs(struct MacroArgs *args);
+char const *macro_GetArg(uint32_t i);
+char const *macro_GetAllArgs(void);
+
+uint32_t macro_GetUniqueID(void);
+char const *macro_GetUniqueIDStr(void);
+void macro_SetUniqueID(uint32_t id);
+uint32_t macro_UseNewUniqueID(void);
+void macro_ShiftCurrentArgs(int32_t count);
+uint32_t macro_NbArgs(void);
+
+#endif

include/asm/main.h

@@ -1,7 +1,7 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2021, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
@@ -15,59 +15,15 @@
 
 #include "helpers.h"
 
-struct sOptions {
-	char binary[2];
-	char gbgfx[4];
-	bool exportall;
-	int32_t fillchar;
-	bool haltnop;
-	bool optimizeloads;
-	bool verbose;
-	bool warnings; /* True to enable warnings, false to disable them. */
-};
-
-extern char *tzNewMacro;
-extern uint32_t ulNewMacroSize;
-extern int32_t nGBGfxID;
-extern int32_t nBinaryID;
-
-extern struct sOptions DefaultOptions;
-extern struct sOptions CurrentOptions;
+extern bool haltnop;
+extern bool optimizeLoads;
+extern bool verbose;
+extern bool warnings; /* True to enable warnings, false to disable them. */
 
 extern FILE *dependfile;
-
-void opt_Push(void);
-void opt_Pop(void);
-void opt_Parse(char *s);
-
-/*
- * Used for errors that compromise the whole assembly process by affecting the
- * folliwing code, potencially making the assembler generate errors caused by
- * the first one and unrelated to the code that the assembler complains about.
- * It is also used when the assembler goes into an invalid state (for example,
- * when it fails to allocate memory).
- */
-noreturn_ void fatalerror(const char *fmt, ...);
-
-/*
- * Used for errors that make it impossible to assemble correctly, but don't
- * affect the following code. The code will fail to assemble but the user will
- * get a list of all errors at the end, making it easier to fix all of them at
- * once.
- */
-void yyerror(const char *fmt, ...);
-
-/*
- * Used to warn the user about problems that don't prevent the generation of
- * valid code.
- */
-void warning(const char *fmt, ...);
-
-#define YY_FATAL_ERROR fatalerror
-
-#ifdef YYLMAX
-#undef YYLMAX
-#endif
-#define YYLMAX 65536
+extern char *targetFileName;
+extern bool generatedMissingIncludes;
+extern bool failedOnMissingInclude;
+extern bool generatePhonyDeps;
 
 #endif /* RGBDS_MAIN_H */

include/asm/mymath.h

@@ -1,29 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_ASM_MATH_H
-#define RGBDS_ASM_MATH_H
-
-#include <stdint.h>
-
-void math_DefinePI(void);
-void math_Print(int32_t i);
-int32_t math_Sin(int32_t i);
-int32_t math_Cos(int32_t i);
-int32_t math_Tan(int32_t i);
-int32_t math_ASin(int32_t i);
-int32_t math_ACos(int32_t i);
-int32_t math_ATan(int32_t i);
-int32_t math_ATan2(int32_t i, int32_t j);
-int32_t math_Mul(int32_t i, int32_t j);
-int32_t math_Div(int32_t i, int32_t j);
-int32_t math_Round(int32_t i);
-int32_t math_Ceil(int32_t i);
-int32_t math_Floor(int32_t i);
-
-#endif /* RGBDS_ASM_MATH_H */

include/asm/opt.h

@@ -0,0 +1,25 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 2021, Eldred Habert and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef RGBDS_OPT_H
+#define RGBDS_OPT_H
+
+#include <stdbool.h>
+#include <stdint.h>
+
+void opt_B(char const chars[2]);
+void opt_G(char const chars[4]);
+void opt_P(uint8_t fill);
+void opt_L(bool optimize);
+void opt_W(char const *flag);
+void opt_Parse(char const *option);
+
+void opt_Push(void);
+void opt_Pop(void);
+
+#endif

include/asm/output.h

@@ -11,44 +11,20 @@
 
 #include <stdint.h>
 
-#include "asm/rpn.h"
+#include "linkdefs.h"
 
-struct Section {
-	char *pzName;
-	uint8_t nType;
-	uint32_t nPC;
-	uint32_t nOrg;
-	uint32_t nBank;
-	uint32_t nAlign;
-	struct Section *pNext;
-	struct Patch *pPatches;
-	struct Charmap *charmap;
-	uint8_t *tData;
-};
+struct Expression;
+struct FileStackNode;
 
-extern char *tzObjectname;
+extern char *objectName;
+extern struct Section *sectionList;
 
-void out_PrepPass2(void);
+void out_RegisterNode(struct FileStackNode *node);
+void out_ReplaceNode(struct FileStackNode *node);
 void out_SetFileName(char *s);
-void out_NewSection(char *pzName, uint32_t secttype);
-void out_NewAbsSection(char *pzName, uint32_t secttype, int32_t org,
-		       int32_t bank);
-void out_NewAlignedSection(char *pzName, uint32_t secttype, int32_t alignment,
-			   int32_t bank);
-void out_AbsByte(int32_t b);
-void out_AbsByteGroup(char *s, int32_t length);
-void out_RelByte(struct Expression *expr);
-void out_RelWord(struct Expression *expr);
-void out_PCRelByte(struct Expression *expr);
-void out_CheckErrors(void);
+void out_CreatePatch(uint32_t type, struct Expression const *expr, uint32_t ofs, uint32_t pcShift);
+bool out_CreateAssert(enum AssertionType type, struct Expression const *expr,
+		      char const *message, uint32_t ofs);
 void out_WriteObject(void);
-void out_Skip(int32_t skip);
-void out_BinaryFile(char *s);
-void out_BinaryFileSlice(char *s, int32_t start_pos, int32_t length);
-void out_String(char *s);
-void out_AbsLong(int32_t b);
-void out_RelLong(struct Expression *expr);
-void out_PushSection(void);
-void out_PopSection(void);
 
 #endif /* RGBDS_ASM_OUTPUT_H */

include/asm/rpn.h

@@ -10,69 +10,61 @@
 #define RGBDS_ASM_RPN_H
 
 #include <stdint.h>
+#include <stdbool.h>
+
+#include "linkdefs.h"
 
 #define MAXRPNLEN 1048576
 
 struct Expression {
-	int32_t  nVal;
-	uint8_t  *tRPN;
-	uint32_t nRPNCapacity;
-	uint32_t nRPNLength;
-	uint32_t nRPNPatchSize;
-	uint32_t nRPNOut;
-	uint32_t isReloc;
+	int32_t  val;          // If the expression's value is known, it's here
+	char     *reason;      // Why the expression is not known, if it isn't
+	bool     isKnown;      // Whether the expression's value is known
+	bool     isSymbol;     // Whether the expression represents a symbol
+	uint8_t  *rpn;         // Array of bytes serializing the RPN expression
+	uint32_t rpnCapacity;  // Size of the `rpn` buffer
+	uint32_t rpnLength;    // Used size of the `rpn` buffer
+	uint32_t rpnPatchSize; // Size the expression will take in the object file
 };
 
-uint32_t rpn_isReloc(const struct Expression *expr);
-void rpn_Symbol(struct Expression *expr, char *tzSym);
+/*
+ * Determines if an expression is known at assembly time
+ */
+static inline bool rpn_isKnown(struct Expression const *expr)
+{
+	return expr->isKnown;
+}
+
+/*
+ * Determines if an expression is a symbol suitable for const diffing
+ */
+static inline bool rpn_isSymbol(const struct Expression *expr)
+{
+	return expr->isSymbol;
+}
+
+void rpn_Symbol(struct Expression *expr, char const *symName);
 void rpn_Number(struct Expression *expr, uint32_t i);
 void rpn_LOGNOT(struct Expression *expr, const struct Expression *src);
-void rpn_LOGOR(struct Expression *expr, const struct Expression *src1,
-	       const struct Expression *src2);
-void rpn_LOGAND(struct Expression *expr, const struct Expression *src1,
-		const struct Expression *src2);
-void rpn_LOGEQU(struct Expression *expr, const struct Expression *src1,
-		const struct Expression *src2);
-void rpn_LOGGT(struct Expression *expr, const struct Expression *src1,
-	       const struct Expression *src2);
-void rpn_LOGLT(struct Expression *expr, const struct Expression *src1,
-	       const struct Expression *src2);
-void rpn_LOGGE(struct Expression *expr, const struct Expression *src1,
-	       const struct Expression *src2);
-void rpn_LOGLE(struct Expression *expr, const struct Expression *src1,
-	       const struct Expression *src2);
-void rpn_LOGNE(struct Expression *expr, const struct Expression *src1,
-	       const struct Expression *src2);
-void rpn_ADD(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_SUB(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_XOR(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_OR(struct Expression *expr, const struct Expression *src1,
-	    const struct Expression *src2);
-void rpn_AND(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_SHL(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_SHR(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_MUL(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_DIV(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
-void rpn_MOD(struct Expression *expr, const struct Expression *src1,
-	     const struct Expression *src2);
+struct Symbol const *rpn_SymbolOf(struct Expression const *expr);
+bool rpn_IsDiffConstant(struct Expression const *src, struct Symbol const *symName);
+void rpn_BinaryOp(enum RPNCommand op, struct Expression *expr,
+		  const struct Expression *src1,
+		  const struct Expression *src2);
 void rpn_HIGH(struct Expression *expr, const struct Expression *src);
 void rpn_LOW(struct Expression *expr, const struct Expression *src);
+void rpn_ISCONST(struct Expression *expr, const struct Expression *src);
 void rpn_UNNEG(struct Expression *expr, const struct Expression *src);
 void rpn_UNNOT(struct Expression *expr, const struct Expression *src);
-uint16_t rpn_PopByte(struct Expression *expr);
-void rpn_BankSymbol(struct Expression *expr, char *tzSym);
-void rpn_BankSection(struct Expression *expr, char *tzSectionName);
+void rpn_BankSymbol(struct Expression *expr, char const *symName);
+void rpn_BankSection(struct Expression *expr, char const *sectionName);
 void rpn_BankSelf(struct Expression *expr);
-void rpn_Init(struct Expression *expr);
+void rpn_SizeOfSection(struct Expression *expr, char const *sectionName);
+void rpn_StartOfSection(struct Expression *expr, char const *sectionName);
 void rpn_Free(struct Expression *expr);
 void rpn_CheckHRAM(struct Expression *expr, const struct Expression *src);
+void rpn_CheckRST(struct Expression *expr, const struct Expression *src);
+void rpn_CheckNBit(struct Expression const *expr, uint8_t n);
+int32_t rpn_GetConstVal(struct Expression const *expr);
 
 #endif /* RGBDS_ASM_RPN_H */

include/asm/section.h

@@ -0,0 +1,82 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 2020, Carsten Sorensen and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef RGBDS_SECTION_H
+#define RGBDS_SECTION_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include "linkdefs.h"
+#include "platform.h" // NONNULL
+
+extern uint8_t fillByte;
+
+struct Expression;
+
+struct Section {
+	char *name;
+	enum SectionType type;
+	enum SectionModifier modifier;
+	struct FileStackNode *src; /* Where the section was defined */
+	uint32_t fileLine; /* Line where the section was defined */
+	uint32_t size;
+	uint32_t org;
+	uint32_t bank;
+	uint8_t align; // Exactly as specified in `ALIGN[]`
+	uint16_t alignOfs;
+	struct Section *next;
+	struct Patch *patches;
+	uint8_t *data;
+};
+
+struct SectionSpec {
+	uint32_t bank;
+	uint8_t alignment;
+	uint16_t alignOfs;
+};
+
+extern struct Section *currentSection;
+
+struct Section *sect_FindSectionByName(char const *name);
+void sect_NewSection(char const *name, uint32_t secttype, uint32_t org,
+		     struct SectionSpec const *attributes, enum SectionModifier mod);
+void sect_SetLoadSection(char const *name, uint32_t secttype, uint32_t org,
+			 struct SectionSpec const *attributes, enum SectionModifier mod);
+void sect_EndLoadSection(void);
+
+struct Section *sect_GetSymbolSection(void);
+uint32_t sect_GetSymbolOffset(void);
+uint32_t sect_GetOutputOffset(void);
+void sect_AlignPC(uint8_t alignment, uint16_t offset);
+
+void sect_StartUnion(void);
+void sect_NextUnionMember(void);
+void sect_EndUnion(void);
+void sect_CheckUnionClosed(void);
+
+void sect_AbsByte(uint8_t b);
+void sect_AbsByteGroup(uint8_t const *s, size_t length);
+void sect_AbsWordGroup(uint8_t const *s, size_t length);
+void sect_AbsLongGroup(uint8_t const *s, size_t length);
+void sect_Skip(uint32_t skip, bool ds);
+void sect_String(char const *s);
+void sect_RelByte(struct Expression *expr, uint32_t pcShift);
+void sect_RelBytes(uint32_t n, struct Expression *exprs, size_t size);
+void sect_RelWord(struct Expression *expr, uint32_t pcShift);
+void sect_RelLong(struct Expression *expr, uint32_t pcShift);
+void sect_PCRelByte(struct Expression *expr, uint32_t pcShift);
+void sect_BinaryFile(char const *s, int32_t startPos);
+void sect_BinaryFileSlice(char const *s, int32_t start_pos, int32_t length);
+
+void sect_PushSection(void);
+void sect_PopSection(void);
+
+bool sect_IsSizeKnown(struct Section const NONNULL(name));
+
+#endif

include/asm/symbol.h

@@ -1,7 +1,7 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2020, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
@@ -9,83 +9,142 @@
 #ifndef RGBDS_SYMBOL_H
 #define RGBDS_SYMBOL_H
 
+#include <stdbool.h>
 #include <stdint.h>
+#include <string.h>
+#include <time.h>
 
-#include "types.h"
+#include "asm/section.h"
 
-#define HASHSIZE	(1 << 16)
-#define MAXSYMLEN	256
+#include "platform.h" // MIN_NB_ELMS
 
-struct sSymbol {
-	char tzName[MAXSYMLEN + 1];
-	int32_t nValue;
-	uint32_t nType;
-	struct sSymbol *pScope;
-	struct sSymbol *pNext;
-	struct Section *pSection;
-	uint32_t ulMacroSize;
-	char *pMacro;
-	int32_t (*Callback)(struct sSymbol *);
-	char tzFileName[_MAX_PATH + 1]; /* File where the symbol was defined. */
-	uint32_t nFileLine; /* Line where the symbol was defined. */
+#define MAXSYMLEN	255
+
+enum SymbolType {
+	SYM_LABEL,
+	SYM_EQU,
+	SYM_VAR,
+	SYM_MACRO,
+	SYM_EQUS,
+	SYM_REF // Forward reference to a label
 };
 
-/* Symbol will be relocated during linking, it's absolute value is unknown */
-#define SYMF_RELOC	0x001
-/* Symbol is defined using EQU, will not be changed during linking */
-#define SYMF_EQU	0x002
-/* Symbol is (re)defined using SET, will not be changed during linking */
-#define SYMF_SET	0x004
-/* Symbol should be exported */
-#define SYMF_EXPORT	0x008
-/* Symbol referenced in RPN expression */
-#define SYMF_REF	0x010
-/* Symbol is a local symbol */
-#define SYMF_LOCAL	0x020
-/* Symbol has been defined, not only referenced */
-#define SYMF_DEFINED	0x040
-/* Symbol is a macro */
-#define SYMF_MACRO	0x080
-/* Symbol is a stringsymbol */
-#define SYMF_STRING	0x100
-/* Symbol has a constant value, will not be changed during linking */
-#define SYMF_CONST	0x200
+struct Symbol {
+	char name[MAXSYMLEN + 1];
+	enum SymbolType type;
+	bool isExported; /* Whether the symbol is to be exported */
+	bool isBuiltin;  /* Whether the symbol is a built-in */
+	struct Section *section;
+	struct FileStackNode *src; /* Where the symbol was defined */
+	uint32_t fileLine; /* Line where the symbol was defined */
 
-uint32_t sym_CalcHash(const char *s);
-void sym_SetExportAll(uint8_t set);
-void sym_AddLocalReloc(char *tzSym);
-void sym_AddReloc(char *tzSym);
-void sym_Export(char *tzSym);
-void sym_PrintSymbolTable(void);
-struct sSymbol *sym_FindMacro(char *s);
-void sym_InitNewMacroArgs(void);
-void sym_AddNewMacroArg(char *s);
-void sym_SaveCurrentMacroArgs(char *save[]);
-void sym_RestoreCurrentMacroArgs(char *save[]);
-void sym_UseNewMacroArgs(void);
-void sym_AddEqu(char *tzSym, int32_t value);
-void sym_AddSet(char *tzSym, int32_t value);
-void sym_Init(void);
-uint32_t sym_GetConstantValue(char *s);
-uint32_t sym_isConstant(char *s);
-struct sSymbol *sym_FindSymbol(char *tzName);
-char *sym_FindMacroArg(int32_t i);
-char *sym_GetStringValue(char *tzSym);
-void sym_UseCurrentMacroArgs(void);
-void sym_SetMacroArgID(uint32_t nMacroCount);
-uint32_t sym_isString(char *tzSym);
-void sym_AddMacro(char *tzSym, int32_t nDefLineNo);
-void sym_Ref(char *tzSym);
-void sym_ShiftCurrentMacroArgs(void);
-void sym_AddString(char *tzSym, char *tzValue);
-uint32_t sym_GetDefinedValue(char *s);
-uint32_t sym_isDefined(char *tzName);
-void sym_Purge(char *tzName);
-uint32_t sym_isConstDefined(char *tzName);
-int32_t sym_IsRelocDiffDefined(char *tzSym1, char *tzSym2);
+	bool hasCallback;
+	union {
+		/* If sym_IsNumeric */
+		int32_t value;
+		int32_t (*numCallback)(void);
+		/* For SYM_MACRO and SYM_EQUS; TODO: have separate fields */
+		struct {
+			size_t macroSize;
+			char *macro;
+		};
+		/* For SYM_EQUS */
+		char const *(*strCallback)(void);
+	};
+
+	uint32_t ID; /* ID of the symbol in the object file (-1 if none) */
+	struct Symbol *next; /* Next object to output in the object file */
+};
+
+bool sym_IsPC(struct Symbol const *sym);
+
+static inline bool sym_IsDefined(struct Symbol const *sym)
+{
+	return sym->type != SYM_REF;
+}
+
+static inline struct Section *sym_GetSection(struct Symbol const *sym)
+{
+	return sym_IsPC(sym) ? sect_GetSymbolSection() : sym->section;
+}
+
+static inline bool sym_IsConstant(struct Symbol const *sym)
+{
+	if (sym->type == SYM_LABEL) {
+		struct Section const *sect = sym_GetSection(sym);
+
+		return sect && sect->org != (uint32_t)-1;
+	}
+	return sym->type == SYM_EQU || sym->type == SYM_VAR;
+}
+
+static inline bool sym_IsNumeric(struct Symbol const *sym)
+{
+	return sym->type == SYM_LABEL || sym->type == SYM_EQU || sym->type == SYM_VAR;
+}
+
+static inline bool sym_IsLabel(struct Symbol const *sym)
+{
+	return sym->type == SYM_LABEL || sym->type == SYM_REF;
+}
+
+static inline bool sym_IsLocal(struct Symbol const *sym)
+{
+	return sym_IsLabel(sym) && strchr(sym->name, '.');
+}
+
+static inline bool sym_IsExported(struct Symbol const *sym)
+{
+	return sym->isExported;
+}
+
+/*
+ * Get a string equate's value
+ */
+static inline char const *sym_GetStringValue(struct Symbol const *sym)
+{
+	if (sym->hasCallback)
+		return sym->strCallback();
+	return sym->macro;
+}
+
+void sym_ForEach(void (*func)(struct Symbol *, void *), void *arg);
+
+int32_t sym_GetValue(struct Symbol const *sym);
+void sym_SetExportAll(bool set);
+struct Symbol *sym_AddLocalLabel(char const *symName);
+struct Symbol *sym_AddLabel(char const *symName);
+struct Symbol *sym_AddAnonLabel(void);
+void sym_WriteAnonLabelName(char buf[MIN_NB_ELMS(MAXSYMLEN + 1)], uint32_t ofs, bool neg);
+void sym_Export(char const *symName);
+struct Symbol *sym_AddEqu(char const *symName, int32_t value);
+struct Symbol *sym_RedefEqu(char const *symName, int32_t value);
+struct Symbol *sym_AddVar(char const *symName, int32_t value);
+uint32_t sym_GetPCValue(void);
+uint32_t sym_GetConstantSymValue(struct Symbol const *sym);
+uint32_t sym_GetConstantValue(char const *symName);
+/*
+ * Find a symbol by exact name, bypassing expansion checks
+ */
+struct Symbol *sym_FindExactSymbol(char const *symName);
+/*
+ * Find a symbol by exact name; may not be scoped, produces an error if it is
+ */
+struct Symbol *sym_FindUnscopedSymbol(char const *symName);
+/*
+ * Find a symbol, possibly scoped, by name
+ */
+struct Symbol *sym_FindScopedSymbol(char const *symName);
+struct Symbol const *sym_GetPC(void);
+struct Symbol *sym_AddMacro(char const *symName, int32_t defLineNo, char *body, size_t size);
+struct Symbol *sym_Ref(char const *symName);
+struct Symbol *sym_AddString(char const *symName, char const *value);
+struct Symbol *sym_RedefString(char const *symName, char const *value);
+void sym_Purge(char const *symName);
+void sym_Init(time_t now);
 
 /* Functions to save and restore the current symbol scope. */
-struct sSymbol *sym_GetCurrentSymbolScope(void);
-void sym_SetCurrentSymbolScope(struct sSymbol *pNewScope);
+char const *sym_GetCurrentSymbolScope(void);
+void sym_SetCurrentSymbolScope(char const *newScope);
 
 #endif /* RGBDS_SYMBOL_H */

include/asm/util.h

@@ -11,7 +11,11 @@
 
 #include <stdint.h>
 
-uint32_t calchash(const char *s);
-int32_t readUTF8Char(char *dest, char *src);
+char const *printChar(int c);
+
+/*
+ * @return The number of bytes read, or 0 if invalid data was found
+ */
+size_t readUTF8Char(uint8_t *dest, char const *src);
 
 #endif /* RGBDS_UTIL_H */

include/asm/warning.h

@@ -0,0 +1,93 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 2019, Eldred Habert and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef WARNING_H
+#define WARNING_H
+
+#include "helpers.h"
+
+extern unsigned int nbErrors;
+
+enum WarningState {
+	WARNING_DEFAULT,
+	WARNING_DISABLED,
+	WARNING_ENABLED,
+	WARNING_ERROR
+};
+
+enum WarningID {
+	WARNING_ASSERT,		      // Assertions
+	WARNING_BACKWARDS_FOR,	      // `for` loop with backwards range
+	WARNING_BUILTIN_ARG,	      // Invalid args to builtins
+	WARNING_CHARMAP_REDEF,        // Charmap entry re-definition
+	WARNING_DIV,		      // Division undefined behavior
+	WARNING_EMPTY_DATA_DIRECTIVE, // `db`, `dw` or `dl` directive without data in ROM
+	WARNING_EMPTY_MACRO_ARG,      // Empty macro argument
+	WARNING_EMPTY_STRRPL,	      // Empty second argument in `STRRPL`
+	WARNING_LARGE_CONSTANT,	      // Constants too large
+	WARNING_LONG_STR,	      // String too long for internal buffers
+	WARNING_MACRO_SHIFT,	      // Shift past available arguments in macro
+	WARNING_NESTED_COMMENT,	      // Comment-start delimiter in a block comment
+	WARNING_OBSOLETE,	      // Obsolete things
+	WARNING_SHIFT,		      // Shifting undefined behavior
+	WARNING_SHIFT_AMOUNT,	      // Strange shift amount
+	WARNING_USER,		      // User warnings
+
+	NB_PLAIN_WARNINGS,
+
+	// Warnings past this point are "parametric" warnings, only mapping to a single flag
+#define PARAM_WARNINGS_START NB_PLAIN_WARNINGS
+	// Treating string as number may lose some bits
+	WARNING_NUMERIC_STRING_1 = PARAM_WARNINGS_START,
+	WARNING_NUMERIC_STRING_2,
+	// Implicit truncation loses some bits
+	WARNING_TRUNCATION_1,
+	WARNING_TRUNCATION_2,
+
+	NB_PLAIN_AND_PARAM_WARNINGS,
+#define NB_PARAM_WARNINGS (NB_PLAIN_AND_PARAM_WARNINGS - PARAM_WARNINGS_START)
+
+	// Warnings past this point are "meta" warnings
+#define META_WARNINGS_START NB_PLAIN_AND_PARAM_WARNINGS
+	WARNING_ALL = META_WARNINGS_START,
+	WARNING_EXTRA,
+	WARNING_EVERYTHING,
+
+	NB_WARNINGS,
+#define NB_META_WARNINGS (NB_WARNINGS - META_WARNINGS_START)
+};
+
+extern enum WarningState warningStates[NB_PLAIN_AND_PARAM_WARNINGS];
+extern bool warningsAreErrors;
+
+void processWarningFlag(char *flag);
+
+/*
+ * Used to warn the user about problems that don't prevent the generation of
+ * valid code.
+ */
+void warning(enum WarningID id, char const *fmt, ...) format_(printf, 2, 3);
+
+/*
+ * Used for errors that compromise the whole assembly process by affecting the
+ * following code, potencially making the assembler generate errors caused by
+ * the first one and unrelated to the code that the assembler complains about.
+ * It is also used when the assembler goes into an invalid state (for example,
+ * when it fails to allocate memory).
+ */
+_Noreturn void fatalerror(char const *fmt, ...) format_(printf, 1, 2);
+
+/*
+ * Used for errors that make it impossible to assemble correctly, but don't
+ * affect the following code. The code will fail to assemble but the user will
+ * get a list of all errors at the end, making it easier to fix all of them at
+ * once.
+ */
+void error(char const *fmt, ...) format_(printf, 1, 2);
+
+#endif

include/common.h

@@ -1,44 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_COMMON_H
-#define RGBDS_COMMON_H
-
-#define RGBDS_OBJECT_VERSION_STRING "RGB6"
-
-enum eBankCount {
-	BANK_COUNT_ROM0  = 1,
-	BANK_COUNT_ROMX  = 511,
-	BANK_COUNT_WRAM0 = 1,
-	BANK_COUNT_WRAMX = 7,
-	BANK_COUNT_VRAM  = 2,
-	BANK_COUNT_OAM   = 1,
-	BANK_COUNT_HRAM  = 1,
-	BANK_COUNT_SRAM  = 16
-};
-
-enum eBankGBCount {
-	BANK_MIN_ROM0  = 0,
-	BANK_MAX_ROM0  = BANK_COUNT_ROM0  + BANK_MIN_ROM0  - 1,
-	BANK_MIN_ROMX  = 1,
-	BANK_MAX_ROMX  = BANK_COUNT_ROMX  + BANK_MIN_ROMX  - 1,
-	BANK_MIN_WRAM0 = 0,
-	BANK_MAX_WRAM0 = BANK_COUNT_WRAM0 + BANK_MIN_WRAM0 - 1,
-	BANK_MIN_WRAMX = 1,
-	BANK_MAX_WRAMX = BANK_COUNT_WRAMX + BANK_MIN_WRAMX - 1,
-	BANK_MIN_VRAM  = 0,
-	BANK_MAX_VRAM  = BANK_COUNT_VRAM  + BANK_MIN_VRAM  - 1,
-	BANK_MIN_OAM   = 0,
-	BANK_MAX_OAM   = BANK_COUNT_OAM   + BANK_MIN_OAM   - 1,
-	BANK_MIN_HRAM  = 0,
-	BANK_MAX_HRAM  = BANK_COUNT_HRAM  + BANK_MIN_HRAM  - 1,
-	BANK_MIN_SRAM  = 0,
-	BANK_MAX_SRAM  = BANK_COUNT_SRAM  + BANK_MIN_SRAM  - 1
-};
-
-#endif /* RGBDS_COMMON_H */

include/error.h

@@ -0,0 +1,21 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 1997-2021, RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef RGBDS_ERROR_H
+#define RGBDS_ERROR_H
+
+#include "helpers.h"
+#include "platform.h"
+
+void warn(char const NONNULL(fmt), ...) format_(printf, 1, 2);
+void warnx(char const NONNULL(fmt), ...) format_(printf, 1, 2);
+
+_Noreturn void err(char const NONNULL(fmt), ...) format_(printf, 1, 2);
+_Noreturn void errx(char const NONNULL(fmt), ...) format_(printf, 1, 2);
+
+#endif /* RGBDS_ERROR_H */

include/extern/err.h

@@ -1,44 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef EXTERN_ERR_H
-#define EXTERN_ERR_H
-
-#ifdef ERR_IN_LIBC
-
-#include <err.h>
-
-#else /* ERR_IN_LIBC */
-
-#include <stdarg.h>
-
-#include "helpers.h"
-
-#define warn rgbds_warn
-#define vwarn rgbds_vwarn
-#define warnx rgbds_warnx
-#define vwarnx rgbds_vwarnx
-
-#define err rgbds_err
-#define verr rgbds_verr
-#define errx rgbds_errx
-#define verrx rgbds_verrx
-
-void warn(const char *fmt, ...);
-void vwarn(const char *fmt, va_list ap);
-void warnx(const char *fmt, ...);
-void vwarnx(const char *fmt, va_list ap);
-
-noreturn_ void err(int status, const char *fmt, ...);
-noreturn_ void verr(int status, const char *fmt, va_list ap);
-noreturn_ void errx(int status, const char *fmt, ...);
-noreturn_ void verrx(int status, const char *fmt, va_list ap);
-
-#endif /* ERR_IN_LIBC */
-
-#endif /* EXTERN_ERR_H */

include/extern/getopt.h

@@ -0,0 +1,46 @@
+/*
+ * Copyright © 2005-2020 Rich Felker, et al.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/* This implementation was taken from musl and modified for RGBDS */
+
+#ifndef RGBDS_EXTERN_GETOPT_H
+#define RGBDS_EXTERN_GETOPT_H
+
+extern char *musl_optarg;
+extern int musl_optind, musl_opterr, musl_optopt, musl_optreset;
+
+struct option {
+	char const *name;
+	int has_arg;
+	int *flag;
+	int val;
+};
+
+int musl_getopt_long_only(int argc, char **argv, char const *optstring,
+			  const struct option *longopts, int *idx);
+
+#define no_argument        0
+#define required_argument  1
+#define optional_argument  2
+
+#endif

include/extern/utf8decoder.h

@@ -9,6 +9,6 @@
 #ifndef EXTERN_UTF8DECODER_H
 #define EXTERN_UTF8DECODER_H
 
-uint32_t decode(uint32_t *state, uint32_t *codep, uint32_t byte);
+uint32_t decode(uint32_t *state, uint32_t *codep, uint8_t byte);
 
 #endif /* EXTERN_UTF8DECODER_H */

include/gfx/main.h

@@ -13,7 +13,7 @@
 #include <stdbool.h>
 #include <stdint.h>
 
-#include "extern/err.h"
+#include "error.h"
 
 struct Options {
 	bool debug;
@@ -24,7 +24,7 @@ struct Options {
 	bool mirror;
 	bool unique;
 	bool colorcurve;
-	int trim;
+	unsigned int trim;
 	char *tilemapfile;
 	bool tilemapout;
 	char *attrmapfile;
@@ -43,7 +43,7 @@ struct RGBColor {
 
 struct ImageOptions {
 	bool horizontal;
-	int trim;
+	unsigned int trim;
 	char *tilemapfile;
 	bool tilemapout;
 	char *attrmapfile;
@@ -55,6 +55,7 @@ struct ImageOptions {
 struct PNGImage {
 	png_struct *png;
 	png_info *info;
+
 	png_byte **data;
 	int width;
 	int height;
@@ -66,8 +67,8 @@ struct RawIndexedImage {
 	uint8_t **data;
 	struct RGBColor *palette;
 	int num_colors;
-	int width;
-	int height;
+	unsigned int width;
+	unsigned int height;
 };
 
 struct GBImage {
@@ -82,7 +83,7 @@ struct Mapfile {
 	int size;
 };
 
-int depth, colors;
+extern int depth, colors;
 
 #include "gfx/makepng.h"
 #include "gfx/gb.h"

include/hashmap.h

@@ -0,0 +1,77 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+/* Generic hashmap implementation (C++ templates are calling...) */
+#ifndef RGBDS_LINK_HASHMAP_H
+#define RGBDS_LINK_HASHMAP_H
+
+#include <assert.h>
+#include <stdbool.h>
+
+#define HASH_NB_BITS 32
+#define HALF_HASH_NB_BITS 16
+static_assert(HALF_HASH_NB_BITS * 2 == HASH_NB_BITS, "");
+#define HASHMAP_NB_BUCKETS (1 << HALF_HASH_NB_BITS)
+
+/* HashMapEntry is internal, please do not attempt to use it */
+typedef struct HashMapEntry *HashMap[HASHMAP_NB_BUCKETS];
+
+/**
+ * Adds an element to a hashmap.
+ * @warning Adding a new element with an already-present key will not cause an
+ *          error, this must be handled externally.
+ * @warning Inserting a NULL will make `hash_GetElement`'s return ambiguous!
+ * @param map The HashMap to add the element to
+ * @param key The key with which the element will be stored and retrieved
+ * @param element The element to add
+ * @return A pointer to the pointer to the element.
+ */
+void **hash_AddElement(HashMap map, char const *key, void *element);
+
+/**
+ * Removes an element from a hashmap.
+ * @param map The HashMap to remove the element from
+ * @param key The key to search the element with
+ * @return True if the element was found and removed
+ */
+bool hash_RemoveElement(HashMap map, char const *key);
+
+/**
+ * Finds an element in a hashmap, and returns a pointer to its value field.
+ * @param map The map to consider the elements of
+ * @param key The key to search an element for
+ * @return A pointer to the pointer to the element, or NULL if not found.
+ */
+void **hash_GetNode(HashMap const map, char const *key);
+
+/**
+ * Finds an element in a hashmap.
+ * @param map The map to consider the elements of
+ * @param key The key to search an element for
+ * @return A pointer to the element, or NULL if not found. (NULL can be returned
+ *         if such an element was added, but that sounds pretty silly.)
+ */
+void *hash_GetElement(HashMap const map, char const *key);
+
+/**
+ * Executes a function on each element in a hashmap.
+ * @param map The map to consider the elements of
+ * @param func The function to run. The first argument will be the element,
+ *                                  the second will be `arg`.
+ * @param arg An argument to be passed to all function calls
+ */
+void hash_ForEach(HashMap const map, void (*func)(void *, void *), void *arg);
+
+/**
+ * Cleanly empties a hashmap from its contents.
+ * This does not `free` the data structure itself!
+ * @param map The map to empty
+ */
+void hash_EmptyMap(HashMap map);
+
+#endif /* RGBDS_LINK_HASHMAP_H */

include/helpers.h

@@ -1,7 +1,7 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 2014-2018, RGBDS contributors.
+ * Copyright (c) 2014-2020, RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
@@ -9,14 +9,88 @@
 #ifndef HELPERS_H
 #define HELPERS_H
 
-#ifdef __GNUC__
-	/* GCC or compatible */
-	#define noreturn_	__attribute__ ((noreturn))
-	#define unused_		__attribute__ ((unused))
-#else
-	/* Unsupported, but no need to throw a fit */
-	#define noreturn_
-	#define unused_
+// Of course, MSVC does not support C11, so no _Noreturn there...
+#ifdef _MSC_VER
+	#define _Noreturn __declspec(noreturn)
 #endif
 
+// Ideally, we'd use `__has_attribute` and `__has_builtin`, but these were only introduced in GCC 9
+#ifdef __GNUC__ // GCC or compatible
+	#define format_(archetype, str_index, first_arg) \
+		__attribute__ ((format (archetype, str_index, first_arg)))
+	#define attr_(...) __attribute__ ((__VA_ARGS__))
+	// In release builds, define "unreachable" as such, but trap in debug builds
+	#ifdef NDEBUG
+		#define unreachable_	__builtin_unreachable
+	#else
+		#define unreachable_	__builtin_trap
+	#endif
+#else
+	// Unsupported, but no need to throw a fit
+	#define format_(archetype, str_index, first_arg)
+	#define attr_(...)
+	// This seems to generate similar code to __builtin_unreachable, despite different semantics
+	// Note that executing this is undefined behavior (declared _Noreturn, but does return)
+	static inline _Noreturn unreachable_(void) {}
+#endif
+
+// Use builtins whenever possible, and shim them otherwise
+#ifdef __GNUC__ // GCC or compatible
+	#define ctz __builtin_ctz
+	#define clz __builtin_clz
+
+#elif defined(_MSC_VER)
+	#include <assert.h>
+	#include <intrin.h>
+	#pragma intrinsic(_BitScanReverse, _BitScanForward)
+	static inline int ctz(unsigned int x)
+	{
+		unsigned long cnt;
+
+		assert(x != 0);
+		_BitScanForward(&cnt, x);
+		return cnt;
+	}
+	static inline int clz(unsigned int x)
+	{
+		unsigned long cnt;
+
+		assert(x != 0);
+		_BitScanReverse(&cnt, x);
+		return 31 - cnt;
+	}
+
+#else
+	#include <limits.h>
+	static inline int ctz(unsigned int x)
+	{
+		int cnt = 0;
+
+		while (!(x & 1)) {
+			x >>= 1;
+			cnt++;
+		}
+		return cnt;
+	}
+
+	static inline int clz(unsigned int x)
+	{
+		int cnt = 0;
+
+		while (x <= UINT_MAX / 2) {
+			x <<= 1;
+			cnt++;
+		}
+		return cnt;
+	}
+#endif
+
+// Macros for stringification
+#define STR(x) #x
+#define EXPAND_AND_STR(x) STR(x)
+
+// Obtaining the size of an array; `arr` must be an expression, not a type!
+// (Having two instances of `arr` is OK because the contents of `sizeof` are not evaluated.)
+#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof *(arr))
+
 #endif /* HELPERS_H */

include/link/assign.h

@@ -1,54 +1,27 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
 
+/* Assigning all sections a place */
 #ifndef RGBDS_LINK_ASSIGN_H
 #define RGBDS_LINK_ASSIGN_H
 
 #include <stdint.h>
 
-#include "common.h"
-#include "mylink.h"
+extern uint64_t nbSectionsToAssign;
 
-/* Bank numbers as seen by the linker */
-enum eBankDefine {
-	BANK_INDEX_ROM0  = 0,
-	BANK_INDEX_ROMX  = BANK_INDEX_ROM0  + BANK_COUNT_ROM0,
-	BANK_INDEX_WRAM0 = BANK_INDEX_ROMX  + BANK_COUNT_ROMX,
-	BANK_INDEX_WRAMX = BANK_INDEX_WRAM0 + BANK_COUNT_WRAM0,
-	BANK_INDEX_VRAM  = BANK_INDEX_WRAMX + BANK_COUNT_WRAMX,
-	BANK_INDEX_OAM   = BANK_INDEX_VRAM  + BANK_COUNT_VRAM,
-	BANK_INDEX_HRAM  = BANK_INDEX_OAM   + BANK_COUNT_OAM,
-	BANK_INDEX_SRAM  = BANK_INDEX_HRAM  + BANK_COUNT_HRAM,
-	BANK_INDEX_MAX   = BANK_INDEX_SRAM  + BANK_COUNT_SRAM
-};
+/**
+ * Assigns all sections a slice of the address space
+ */
+void assign_AssignSections(void);
 
-extern int32_t MaxBankUsed;
-extern int32_t MaxAvail[BANK_INDEX_MAX];
-
-int32_t area_Avail(int32_t bank);
-void AssignSections(void);
-void CreateSymbolTable(void);
-struct sSection *GetSectionByName(const char *name);
-int32_t IsSectionNameInUse(const char *name);
-void SetLinkerscriptName(char *tzLinkerscriptFile);
-int32_t IsSectionSameTypeBankAndAttrs(const char *name,
-				      enum eSectionType type, int32_t bank,
-				      int32_t org, int32_t align);
-uint32_t AssignSectionAddressAndBankByName(const char *name, uint32_t address,
-					   int32_t bank);
-
-int BankIndexIsROM0(int32_t bank);
-int BankIndexIsROMX(int32_t bank);
-int BankIndexIsWRAM0(int32_t bank);
-int BankIndexIsWRAMX(int32_t bank);
-int BankIndexIsVRAM(int32_t bank);
-int BankIndexIsOAM(int32_t bank);
-int BankIndexIsHRAM(int32_t bank);
-int BankIndexIsSRAM(int32_t bank);
+/**
+ * `free`s all assignment memory that was allocated.
+ */
+void assign_Cleanup(void);
 
 #endif /* RGBDS_LINK_ASSIGN_H */

include/link/library.h

@@ -1,14 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_LINK_LIBRARY_H
-#define RGBDS_LINK_LIBRARY_H
-
-void AddNeededModules(void);
-
-#endif /* RGBDS_LINK_LIBRARY_H */

include/link/main.h

@@ -1,17 +1,89 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
 
+/* Declarations that all modules use, as well as `main` and related */
 #ifndef RGBDS_LINK_MAIN_H
 #define RGBDS_LINK_MAIN_H
 
 #include <stdint.h>
+#include <stdbool.h>
+#include <stdio.h>
 
-extern int32_t fillchar;
-extern char *smartlinkstartsymbol;
+#include "helpers.h"
+
+/* Variables related to CLI options */
+extern bool isDmgMode;
+extern char       *linkerScriptName;
+extern char const *mapFileName;
+extern char const *symFileName;
+extern char const *overlayFileName;
+extern char const *outputFileName;
+extern uint8_t padValue;
+extern uint16_t scrambleROMX;
+extern uint8_t scrambleWRAMX;
+extern uint8_t scrambleSRAM;
+extern bool is32kMode;
+extern bool beVerbose;
+extern bool isWRA0Mode;
+extern bool disablePadding;
+
+struct FileStackNode {
+	struct FileStackNode *parent;
+	/* Line at which the parent context was exited; meaningless for the root level */
+	uint32_t lineNo;
+
+	enum {
+		NODE_REPT,
+		NODE_FILE,
+		NODE_MACRO,
+	} type;
+	union {
+		char *name; /* NODE_FILE, NODE_MACRO */
+		struct { /* NODE_REPT */
+			uint32_t reptDepth;
+			uint32_t *iters;
+		};
+	};
+};
+
+/* Helper macro for printing verbose-mode messages */
+#define verbosePrint(...)   do { \
+					if (beVerbose) \
+						fprintf(stderr, __VA_ARGS__); \
+				} while (0)
+
+/**
+ * Dump a file stack to stderr
+ * @param node The leaf node to dump the context of
+ */
+char const *dumpFileStack(struct FileStackNode const *node);
+
+void warning(struct FileStackNode const *where, uint32_t lineNo,
+	     char const *fmt, ...) format_(printf, 3, 4);
+
+void error(struct FileStackNode const *where, uint32_t lineNo,
+	   char const *fmt, ...) format_(printf, 3, 4);
+
+_Noreturn void fatal(struct FileStackNode const *where, uint32_t lineNo,
+		     char const *fmt, ...) format_(printf, 3, 4);
+
+/**
+ * Opens a file if specified, and aborts on error.
+ * @param fileName The name of the file to open; if NULL, no file will be opened
+ * @param mode The mode to open the file with
+ * @return A pointer to a valid FILE structure, or NULL if fileName was NULL
+ */
+FILE *openFile(char const *fileName, char const *mode);
+
+#define closeFile(file) do { \
+				FILE *tmp = file; \
+				if (tmp) \
+					fclose(tmp); \
+			} while (0)
 
 #endif /* RGBDS_LINK_MAIN_H */

include/link/mapfile.h

@@ -1,21 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_LINK_MAPFILE_H
-#define RGBDS_LINK_MAPFILE_H
-
-#include <stdint.h>
-
-void SetMapfileName(char *name);
-void SetSymfileName(char *name);
-void CloseMapfile(void);
-void MapfileWriteSection(const struct sSection *pSect);
-void MapfileInitBank(int32_t bank);
-void MapfileCloseBank(int32_t slack);
-
-#endif /* RGBDS_LINK_MAPFILE_H */

include/link/mylink.h

@@ -1,68 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_LINK_LINK_H
-#define RGBDS_LINK_LINK_H
-
-#include <stdint.h>
-
-#include "linkdefs.h"
-
-extern int32_t options;
-
-#define OPT_TINY		0x01
-#define OPT_SMART_C_LINK	0x02
-#define OPT_OVERLAY		0x04
-#define OPT_CONTWRAM		0x08
-#define OPT_DMG_MODE		0x10
-
-struct sSection {
-	int32_t nBank;
-	int32_t nOrg;
-	int32_t nAlign;
-	uint8_t oAssigned;
-
-	char *pzName;
-	int32_t nByteSize;
-	enum eSectionType Type;
-	uint8_t *pData;
-	int32_t nNumberOfSymbols;
-	struct sSymbol **tSymbols;
-	struct sPatch *pPatches;
-	struct sSection *pNext;
-};
-
-struct sSymbol {
-	char *pzName;
-	enum eSymbolType Type;
-
-	/* The following 3 items only valid when Type!=SYM_IMPORT */
-	int32_t nSectionID; /* Internal to object.c */
-	struct sSection *pSection;
-	int32_t nOffset;
-
-	char *pzObjFileName; /* Object file where the symbol is located. */
-	char *pzFileName; /* Source file where the symbol was defined. */
-	uint32_t nFileLine; /* Line where the symbol was defined. */
-};
-
-struct sPatch {
-	char *pzFilename;
-	int32_t nLineNo;
-	int32_t nOffset;
-	enum ePatchType Type;
-	int32_t nRPNSize;
-	uint8_t *pRPN;
-	struct sPatch *pNext;
-	uint8_t oRelocPatch;
-};
-
-extern struct sSection *pSections;
-extern struct sSection *pLibSections;
-
-#endif /* RGBDS_LINK_LINK_H */

include/link/object.h

@@ -1,14 +1,42 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
 
+/* Declarations related to processing of object (.o) files */
+
 #ifndef RGBDS_LINK_OBJECT_H
 #define RGBDS_LINK_OBJECT_H
 
-void obj_Readfile(char *tzObjectfile);
+/**
+ * Read an object (.o) file, and add its info to the data structures.
+ * @param fileName A path to the object file to be read
+ * @param i The ID of the file
+ */
+void obj_ReadFile(char const *fileName, unsigned int i);
+
+/**
+ * Perform validation on the object files' contents
+ */
+void obj_DoSanityChecks(void);
+
+/**
+ * Evaluate all assertions
+ */
+void obj_CheckAssertions(void);
+
+/**
+ * Sets up object file reading
+ * @param nbFiles The number of object files that will be read
+ */
+void obj_Setup(unsigned int nbFiles);
+
+/**
+ * `free`s all object memory that was allocated.
+ */
+void obj_Cleanup(void);
 
 #endif /* RGBDS_LINK_OBJECT_H */

include/link/output.h

@@ -1,16 +1,35 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
 
+/* Outputting the result of linking */
 #ifndef RGBDS_LINK_OUTPUT_H
 #define RGBDS_LINK_OUTPUT_H
 
-void out_Setname(char *tzOutputfile);
-void out_SetOverlayname(char *tzOverlayfile);
-void Output(void);
+#include <stdint.h>
+
+#include "link/section.h"
+
+/**
+ * Registers a section for output.
+ * @param section The section to add
+ */
+void out_AddSection(struct Section const *section);
+
+/**
+ * Finds an assigned section overlapping another one.
+ * @param section The section that is being overlapped
+ * @return A section overlapping it
+ */
+struct Section const *out_OverlappingSection(struct Section const *section);
+
+/**
+ * Writes all output (bin, sym, map) files.
+ */
+void out_WriteFiles(void);
 
 #endif /* RGBDS_LINK_OUTPUT_H */

include/link/patch.h

@@ -1,17 +1,41 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
 
+/* Applying patches to SECTIONs */
 #ifndef RGBDS_LINK_PATCH_H
 #define RGBDS_LINK_PATCH_H
 
+#include <stdbool.h>
 #include <stdint.h>
 
-void Patch(void);
-extern int32_t nPC;
+#include "link/section.h"
+
+#include "linkdefs.h"
+
+struct Assertion {
+	struct Patch patch;
+	// enum AssertionType type; The `patch`'s field is instead re-used
+	char *message;
+	// This would be redundant with `.section->fileSymbols`... but `section` is sometimes NULL!
+	struct Symbol **fileSymbols;
+
+	struct Assertion *next;
+};
+
+/**
+ * Checks all assertions
+ * @return true if assertion failed
+ */
+void patch_CheckAssertions(struct Assertion *assertion);
+
+/**
+ * Applies all SECTIONs' patches to them
+ */
+void patch_ApplyPatches(void);
 
 #endif /* RGBDS_LINK_PATCH_H */

include/link/script.h

@@ -1,30 +1,36 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 2017-2018, Antonio Nino Diaz and RGBDS contributors.
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
 
+/* Parsing a linker script */
 #ifndef RGBDS_LINK_SCRIPT_H
 #define RGBDS_LINK_SCRIPT_H
 
 #include <stdint.h>
 
-#include "helpers.h"
+extern FILE * linkerScript;
 
-noreturn_ void script_fatalerror(const char *fmt, ...);
+struct SectionPlacement {
+	struct Section *section;
+	uint16_t org;
+	uint32_t bank;
+};
 
-void script_Parse(const char *path);
+extern uint64_t script_lineNo;
 
-void script_IncludeFile(const char *path);
-int32_t script_IncludeDepthGet(void);
-void script_IncludePop(void);
+/**
+ * Parses the linker script to return the next section constraint
+ * @return A pointer to a struct, or NULL on EOF. The pointer shouldn't be freed
+ */
+struct SectionPlacement *script_NextSection(void);
 
-void script_InitSections(void);
-void script_SetCurrentSectionType(const char *type, uint32_t bank);
-void script_SetAddress(uint32_t addr);
-void script_SetAlignment(uint32_t alignment);
-void script_OutputSection(const char *section_name);
+/**
+ * `free`s all assignment memory that was allocated.
+ */
+void script_Cleanup(void);
 
 #endif /* RGBDS_LINK_SCRIPT_H */

include/link/section.h

@@ -0,0 +1,100 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+/* Declarations manipulating symbols */
+#ifndef RGBDS_LINK_SECTION_H
+#define RGBDS_LINK_SECTION_H
+
+/* GUIDELINE: external code MUST NOT BE AWARE of the data structure used!! */
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include "link/main.h"
+
+#include "linkdefs.h"
+
+struct FileStackNode;
+struct Section;
+
+struct AttachedSymbol {
+	struct Symbol *symbol;
+	struct AttachedSymbol *next;
+};
+
+struct Patch {
+	struct FileStackNode const *src;
+	uint32_t lineNo;
+	uint32_t offset;
+	uint32_t pcSectionID;
+	uint32_t pcOffset;
+	enum PatchType type;
+	uint32_t rpnSize;
+	uint8_t *rpnExpression;
+
+	struct Section const *pcSection;
+};
+
+struct Section {
+	/* Info contained in the object files */
+	char *name;
+	uint16_t size;
+	uint16_t offset;
+	enum SectionType type;
+	enum SectionModifier modifier;
+	bool isAddressFixed;
+	uint16_t org;
+	bool isBankFixed;
+	uint32_t bank;
+	bool isAlignFixed;
+	uint16_t alignMask;
+	uint16_t alignOfs;
+	uint8_t *data; /* Array of size `size`*/
+	uint32_t nbPatches;
+	struct Patch *patches;
+	/* Extra info computed during linking */
+	struct Symbol **fileSymbols;
+	uint32_t nbSymbols;
+	struct Symbol const **symbols;
+	struct Section *nextu; /* The next "component" of this unionized sect */
+};
+
+/*
+ * Execute a callback for each section currently registered.
+ * This is to avoid exposing the data structure in which sections are stored.
+ * @param callback The function to call for each structure;
+ *                 the first argument will be a pointer to the structure,
+ *                 the second argument will be the pointer `arg`.
+ * @param arg A pointer which will be passed to all calls to `callback`.
+ */
+void sect_ForEach(void (*callback)(struct Section *, void *), void *arg);
+
+/**
+ * Registers a section to be processed.
+ * @param section The section to register.
+ */
+void sect_AddSection(struct Section *section);
+
+/**
+ * Finds a section by its name.
+ * @param name The name of the section to look for
+ * @return A pointer to the section, or NULL if it wasn't found
+ */
+struct Section *sect_GetSection(char const *name);
+
+/**
+ * `free`s all section memory that was allocated.
+ */
+void sect_CleanupSections(void);
+
+/**
+ * Checks if all sections meet reasonable criteria, such as max size
+ */
+void sect_DoSanityChecks(void);
+
+#endif /* RGBDS_LINK_SECTION_H */

include/link/symbol.h

@@ -1,21 +1,61 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
+ * Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
 
+/* Declarations manipulating symbols */
 #ifndef RGBDS_LINK_SYMBOL_H
 #define RGBDS_LINK_SYMBOL_H
 
+/* GUIDELINE: external code MUST NOT BE AWARE of the data structure used!! */
+
 #include <stdint.h>
 
-void sym_Init(void);
-void sym_CreateSymbol(char *tzName, int32_t nValue, int32_t nBank,
-		      char *tzObjFileName, char *tzFileName,
-		      uint32_t nFileLine);
-int32_t sym_GetValue(struct sPatch *pPatch, char *tzName);
-int32_t sym_GetBank(struct sPatch *pPatch, char *tzName);
+#include "linkdefs.h"
+
+struct FileStackNode;
+
+struct Symbol {
+	/* Info contained in the object files */
+	char *name;
+	enum ExportLevel type;
+	char const *objFileName;
+	struct FileStackNode const *src;
+	int32_t lineNo;
+	int32_t sectionID;
+	union {
+		int32_t offset;
+		int32_t value;
+	};
+	/* Extra info computed during linking */
+	struct Section *section;
+};
+
+/*
+ * Execute a callback for each symbol currently registered.
+ * This is done to avoid exposing the data structure in which symbol are stored.
+ * @param callback The function to call for each symbol;
+ *                 the first argument will be a pointer to the symbol,
+ *                 the second argument will be the pointer `arg`.
+ * @param arg A pointer which will be passed to all calls to `callback`.
+ */
+void sym_ForEach(void (*callback)(struct Symbol *, void *), void *arg);
+
+void sym_AddSymbol(struct Symbol *symbol);
+
+/**
+ * Finds a symbol in all the defined symbols.
+ * @param name The name of the symbol to look for
+ * @return A pointer to the symbol, or NULL if not found.
+ */
+struct Symbol *sym_GetSymbol(char const *name);
+
+/**
+ * `free`s all symbol memory that was allocated.
+ */
+void sym_CleanupSymbols(void);
 
 #endif /* RGBDS_LINK_SYMBOL_H */

include/linkdefs.h

@@ -9,65 +9,147 @@
 #ifndef RGBDS_LINKDEFS_H
 #define RGBDS_LINKDEFS_H
 
-enum eRpnData {
-	RPN_ADD		= 0x00,
-	RPN_SUB		= 0x01,
-	RPN_MUL		= 0x02,
-	RPN_DIV		= 0x03,
-	RPN_MOD		= 0x04,
-	RPN_UNSUB	= 0x05,
+#include <stdbool.h>
+#include <stdint.h>
 
-	RPN_OR		= 0x10,
-	RPN_AND		= 0x11,
-	RPN_XOR		= 0x12,
-	RPN_UNNOT	= 0x13,
+#define RGBDS_OBJECT_VERSION_STRING "RGB%1u"
+#define RGBDS_OBJECT_VERSION_NUMBER 9U
+#define RGBDS_OBJECT_REV 9U
 
-	RPN_LOGAND	= 0x21,
-	RPN_LOGOR	= 0x22,
-	RPN_LOGUNNOT	= 0x23,
-
-	RPN_LOGEQ	= 0x30,
-	RPN_LOGNE	= 0x31,
-	RPN_LOGGT	= 0x32,
-	RPN_LOGLT	= 0x33,
-	RPN_LOGGE	= 0x34,
-	RPN_LOGLE	= 0x35,
-
-	RPN_SHL		= 0x40,
-	RPN_SHR		= 0x41,
-
-	RPN_BANK_SYM	= 0x50,
-	RPN_BANK_SECT	= 0x51,
-	RPN_BANK_SELF	= 0x52,
-
-	RPN_HRAM	= 0x60,
-
-	RPN_CONST	= 0x80,
-	RPN_SYM		= 0x81
+enum AssertionType {
+	ASSERT_WARN,
+	ASSERT_ERROR,
+	ASSERT_FATAL
 };
 
-enum eSectionType {
-	SECT_WRAM0	= 0x00,
-	SECT_VRAM	= 0x01,
-	SECT_ROMX	= 0x02,
-	SECT_ROM0	= 0x03,
-	SECT_HRAM	= 0x04,
-	SECT_WRAMX	= 0x05,
-	SECT_SRAM	= 0x06,
-	SECT_OAM	= 0x07
+enum RPNCommand {
+	RPN_ADD			= 0x00,
+	RPN_SUB			= 0x01,
+	RPN_MUL			= 0x02,
+	RPN_DIV			= 0x03,
+	RPN_MOD			= 0x04,
+	RPN_UNSUB		= 0x05, // FIXME: should be renamed to "NEG" for consistency
+	RPN_EXP			= 0x06,
+
+	RPN_OR			= 0x10,
+	RPN_AND			= 0x11,
+	RPN_XOR			= 0x12,
+	RPN_UNNOT		= 0x13, // FIXME: should be renamed to "NOT" for consistency
+
+	RPN_LOGAND		= 0x21,
+	RPN_LOGOR		= 0x22,
+	RPN_LOGUNNOT		= 0x23, // FIXME: should be renamed to "LOGNOT" for consistency
+
+	RPN_LOGEQ		= 0x30,
+	RPN_LOGNE		= 0x31,
+	RPN_LOGGT		= 0x32,
+	RPN_LOGLT		= 0x33,
+	RPN_LOGGE		= 0x34,
+	RPN_LOGLE		= 0x35,
+
+	RPN_SHL			= 0x40,
+	RPN_SHR			= 0x41,
+	RPN_USHR		= 0x42,
+
+	RPN_BANK_SYM		= 0x50,
+	RPN_BANK_SECT		= 0x51,
+	RPN_BANK_SELF		= 0x52,
+	RPN_SIZEOF_SECT		= 0x53,
+	RPN_STARTOF_SECT	= 0x54,
+
+	RPN_HRAM		= 0x60,
+	RPN_RST			= 0x61,
+
+	RPN_CONST		= 0x80,
+	RPN_SYM			= 0x81
 };
 
-enum eSymbolType {
-	SYM_LOCAL	= 0x00,
-	SYM_IMPORT	= 0x01,
-	SYM_EXPORT	= 0x02
+enum SectionType {
+	SECTTYPE_WRAM0,
+	SECTTYPE_VRAM,
+	SECTTYPE_ROMX,
+	SECTTYPE_ROM0,
+	SECTTYPE_HRAM,
+	SECTTYPE_WRAMX,
+	SECTTYPE_SRAM,
+	SECTTYPE_OAM,
+
+	SECTTYPE_INVALID
 };
 
-enum ePatchType {
-	PATCH_BYTE	= 0x00,
-	PATCH_WORD_L	= 0x01,
-	PATCH_LONG_L	= 0x02,
-	PATCH_BYTE_JR	= 0x03
+enum SectionModifier {
+	SECTION_NORMAL,
+	SECTION_UNION,
+	SECTION_FRAGMENT
 };
 
+extern char const * const sectionModNames[];
+
+/**
+ * Tells whether a section has data in its object file definition,
+ * depending on type.
+ * @param type The section's type
+ * @return `true` if the section's definition includes data
+ */
+static inline bool sect_HasData(enum SectionType type)
+{
+	return type == SECTTYPE_ROM0 || type == SECTTYPE_ROMX;
+}
+
+enum ExportLevel {
+	SYMTYPE_LOCAL,
+	SYMTYPE_IMPORT,
+	SYMTYPE_EXPORT
+};
+
+enum PatchType {
+	PATCHTYPE_BYTE,
+	PATCHTYPE_WORD,
+	PATCHTYPE_LONG,
+	PATCHTYPE_JR,
+
+	PATCHTYPE_INVALID
+};
+
+#define BANK_MIN_ROM0  0
+#define BANK_MAX_ROM0  0
+#define BANK_MIN_ROMX  1
+#define BANK_MAX_ROMX  511
+#define BANK_MIN_VRAM  0
+#define BANK_MAX_VRAM  1
+#define BANK_MIN_SRAM  0
+#define BANK_MAX_SRAM  15
+#define BANK_MIN_WRAM0 0
+#define BANK_MAX_WRAM0 0
+#define BANK_MIN_WRAMX 1
+#define BANK_MAX_WRAMX 7
+#define BANK_MIN_OAM   0
+#define BANK_MAX_OAM   0
+#define BANK_MIN_HRAM  0
+#define BANK_MAX_HRAM  0
+
+extern uint16_t startaddr[];
+extern uint16_t maxsize[];
+extern uint32_t bankranges[][2];
+
+/**
+ * Computes a memory region's end address (last byte), eg. 0x7FFF
+ * @return The address of the last byte in that memory region
+ */
+static inline uint16_t endaddr(enum SectionType type)
+{
+	return startaddr[type] + maxsize[type] - 1;
+}
+
+/**
+ * Computes a memory region's number of banks
+ * @return The number of banks, 1 for regions without banking
+ */
+static inline uint32_t nbbanks(enum SectionType type)
+{
+	return bankranges[type][1] - bankranges[type][0] + 1;
+}
+
+extern char const * const typeNames[SECTTYPE_INVALID];
+
 #endif /* RGBDS_LINKDEFS_H */

include/opmath.h

@@ -0,0 +1,21 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 1997-2021, RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef RGBDS_OP_MATH_H
+#define RGBDS_OP_MATH_H
+
+#include <stdint.h>
+
+int32_t op_divide(int32_t dividend, int32_t divisor);
+int32_t op_modulo(int32_t dividend, int32_t divisor);
+int32_t op_exponent(int32_t base, uint32_t power);
+int32_t op_shift_left(int32_t value, int32_t amount);
+int32_t op_shift_right(int32_t value, int32_t amount);
+int32_t op_shift_right_unsigned(int32_t value, int32_t amount);
+
+#endif /* RGBDS_OP_MATH_H */

include/platform.h

@@ -0,0 +1,76 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 2020 RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+/* platform-specific hacks */
+
+#ifndef RGBDS_PLATFORM_H
+#define RGBDS_PLATFORM_H
+
+// MSVC doesn't have str(n)casecmp, use a suitable replacement
+#ifdef _MSC_VER
+# include <string.h>
+# define strcasecmp _stricmp
+# define strncasecmp _strnicmp
+#else
+# include <strings.h>
+#endif
+
+/* MSVC has deprecated strdup in favor of _strdup */
+#ifdef _MSC_VER
+# define strdup _strdup
+#endif
+
+/* MSVC prefixes the names of S_* macros with underscores,
+   and doesn't define any S_IS* macros. Define them ourselves */
+#ifdef _MSC_VER
+# define S_IFMT _S_IFMT
+# define S_IFDIR _S_IFDIR
+# define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
+#endif
+
+/* MSVC doesn't use POSIX types or defines for `read` */
+#ifdef _MSC_VER
+# include <io.h>
+# define STDIN_FILENO 0
+# define STDOUT_FILENO 1
+# define STDERR_FILENO 2
+# define ssize_t int
+# define SSIZE_MAX INT_MAX
+#else
+# include <fcntl.h>
+# include <unistd.h>
+#endif
+
+/* MSVC doesn't support `[static N]` for array arguments from C99 */
+#ifdef _MSC_VER
+# define MIN_NB_ELMS(N)
+# define NONNULL(ptr) *ptr
+#else
+# define MIN_NB_ELMS(N) static (N)
+# define NONNULL(ptr) ptr[static 1]
+#endif
+
+// MSVC uses a different name for O_RDWR, and needs an additional _O_BINARY flag
+#ifdef _MSC_VER
+# include <fcntl.h>
+# define O_RDWR _O_RDWR
+# define S_ISREG(field) ((field) & _S_IFREG)
+# define O_BINARY _O_BINARY
+#elif !defined(O_BINARY) // Cross-compilers define O_BINARY
+# define O_BINARY 0 // POSIX says we shouldn't care!
+#endif // _MSC_VER
+
+// Windows has stdin and stdout open as text by default, which we may not want
+#if defined(_MSC_VER) || defined(__MINGW32__)
+# include <io.h>
+# define setmode(fd, mode) _setmode(fd, mode)
+#else
+# define setmode(fd, mode) ((void)0)
+#endif
+
+#endif /* RGBDS_PLATFORM_H */

include/types.h

@@ -1,16 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#ifndef RGBDS_TYPES_H
-#define RGBDS_TYPES_H
-
-#ifndef _MAX_PATH
-#define _MAX_PATH 512
-#endif
-
-#endif /* RGBDS_TYPES_H */

include/version.h

@@ -1,7 +1,7 @@
 /*
  * This file is part of RGBDS.
  *
- * Copyright (c) 2017-2018, Antonio Nino Diaz and RGBDS contributors.
+ * Copyright (c) 2017-2021, Antonio Nino Diaz and RGBDS contributors.
  *
  * SPDX-License-Identifier: MIT
  */
@@ -9,10 +9,10 @@
 #ifndef EXTERN_VERSION_H
 #define EXTERN_VERSION_H
 
-#define PACKAGE_VERSION_MAJOR (0)
-#define PACKAGE_VERSION_MINOR (3)
-#define PACKAGE_VERSION_PATCH (9)
+#define PACKAGE_VERSION_MAJOR 0
+#define PACKAGE_VERSION_MINOR 5
+#define PACKAGE_VERSION_PATCH 2
 
-const char *get_package_version_string(void);
+char const *get_package_version_string(void);
 
 #endif /* EXTERN_VERSION_H */

src/.gitignore

@@ -0,0 +1,2 @@
+# Generated by CMake
+/.version.c

src/CMakeLists.txt

@@ -0,0 +1,130 @@
+#
+# This file is part of RGBDS.
+#
+# Copyright (c) 2020 RGBDS contributors.
+#
+# SPDX-License-Identifier: MIT
+#
+
+configure_file(version.c _version.c ESCAPE_QUOTES)
+
+set(common_src
+    "error.c"
+    "extern/getopt.c"
+    "_version.c"
+    )
+
+find_package(PkgConfig)
+if(MSVC OR NOT PKG_CONFIG_FOUND)
+  # fallback to find_package
+  find_package(PNG REQUIRED)
+else()
+  pkg_check_modules(LIBPNG REQUIRED libpng)
+endif()
+
+find_package(BISON REQUIRED)
+set(BISON_FLAGS "-Wall")
+# Set sompe optimization flags on versions that support them
+if(BISON_VERSION VERSION_GREATER_EQUAL "3.5")
+  set(BISON_FLAGS "${BISON_FLAGS} -Dapi.token.raw=true")
+endif()
+if(BISON_VERSION VERSION_GREATER_EQUAL "3.6")
+  set(BISON_FLAGS "${BISON_FLAGS} -Dparse.error=detailed")
+elseif(BISON_VERSION VERSION_GREATER_EQUAL "3.0")
+  set(BISON_FLAGS "${BISON_FLAGS} -Dparse.error=verbose")
+endif()
+if(BISON_VERSION VERSION_GREATER_EQUAL "3.0")
+  set(BISON_FLAGS "${BISON_FLAGS} -Dparse.lac=full")
+  set(BISON_FLAGS "${BISON_FLAGS} -Dlr.type=ielr")
+endif()
+BISON_TARGET(PARSER "asm/parser.y"
+             "${PROJECT_SOURCE_DIR}/src/asm/parser.c"
+             COMPILE_FLAGS "${BISON_FLAGS}"
+             DEFINES_FILE "${PROJECT_SOURCE_DIR}/src/asm/parser.h"
+             )
+
+set(rgbasm_src
+    "${BISON_PARSER_OUTPUT_SOURCE}"
+    "asm/charmap.c"
+    "asm/fixpoint.c"
+    "asm/format.c"
+    "asm/fstack.c"
+    "asm/lexer.c"
+    "asm/macro.c"
+    "asm/main.c"
+    "asm/opt.c"
+    "asm/output.c"
+    "asm/rpn.c"
+    "asm/section.c"
+    "asm/symbol.c"
+    "asm/util.c"
+    "asm/warning.c"
+    "extern/utf8decoder.c"
+    "hashmap.c"
+    "linkdefs.c"
+    "opmath.c"
+    )
+
+set(rgbfix_src
+    "fix/main.c"
+    )
+
+set(rgbgfx_src
+    "gfx/gb.c"
+    "gfx/main.c"
+    "gfx/makepng.c"
+    )
+
+set(rgblink_src
+    "link/assign.c"
+    "link/main.c"
+    "link/object.c"
+    "link/output.c"
+    "link/patch.c"
+    "link/script.c"
+    "link/section.c"
+    "link/symbol.c"
+    "hashmap.c"
+    "linkdefs.c"
+    "opmath.c"
+    )
+
+foreach(PROG "asm" "fix" "gfx" "link")
+  add_executable(rgb${PROG}
+                 ${rgb${PROG}_src}
+                 ${common_src}
+                 )
+  install(TARGETS rgb${PROG} RUNTIME DESTINATION bin)
+endforeach()
+
+set(MANDIR "share/man")
+set(man1 "asm/rgbasm.1"
+         "fix/rgbfix.1"
+         "gfx/rgbgfx.1"
+         "link/rgblink.1")
+set(man5 "asm/rgbasm.5"
+         "link/rgblink.5"
+         "rgbds.5")
+set(man7 "gbz80.7"
+         "rgbds.7")
+
+foreach(SECTION "man1" "man5" "man7")
+  set(DEST "${MANDIR}/${SECTION}")
+  install(FILES ${${SECTION}} DESTINATION ${DEST})
+endforeach()
+
+if(LIBPNG_FOUND) # pkg-config
+  target_include_directories(rgbgfx PRIVATE ${LIBPNG_INCLUDE_DIRS})
+  target_link_directories(rgbgfx PRIVATE ${LIBPNG_LIBRARY_DIRS})
+  target_link_libraries(rgbgfx PRIVATE ${LIBPNG_LIBRARIES})
+else()
+  target_compile_definitions(rgbgfx PRIVATE ${PNG_DEFINITIONS})
+  target_include_directories(rgbgfx PRIVATE ${PNG_INCLUDE_DIRS})
+  target_link_libraries(rgbgfx PRIVATE ${PNG_LIBRARIES})
+endif()
+
+include(CheckLibraryExists)
+check_library_exists("m" "sin" "" HAS_LIBM)
+if(HAS_LIBM)
+  target_link_libraries(rgbasm PRIVATE "m")
+endif()

src/asm/.gitignore

@@ -1,2 +1,2 @@
-asmy.c
-asmy.h
+/parser.c
+/parser.h

src/asm/charmap.c

@@ -6,133 +6,137 @@
  * SPDX-License-Identifier: MIT
  */
 
+#include <errno.h>
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 
-#include "asm/asm.h"
 #include "asm/charmap.h"
 #include "asm/main.h"
 #include "asm/output.h"
 #include "asm/util.h"
+#include "asm/warning.h"
 
-#define CHARMAP_HASH_SIZE (1 << 9)
+#include "hashmap.h"
+
+/*
+ * Charmaps are stored using a structure known as "trie".
+ * Essentially a tree, where each nodes stores a single character's worth of info:
+ * whether there exists a mapping that ends at the current character,
+ */
+struct Charnode {
+	bool isTerminal; /* Whether there exists a mapping that ends here */
+	uint8_t value; /* If the above is true, its corresponding value */
+	/* This MUST be indexes and not pointers, because pointers get invalidated by `realloc`!! */
+	size_t next[255]; /* Indexes of where to go next, 0 = nowhere */
+};
+
+#define INITIAL_CAPACITY 32
+
+struct Charmap {
+	char *name;
+	size_t usedNodes; /* How many nodes are being used */
+	size_t capacity; /* How many nodes have been allocated */
+	struct Charnode nodes[]; /* first node is reserved for the root node */
+};
+
+static HashMap charmaps;
+
+/*
+ * Store pointers to hashmap nodes, so that there is only one pointer to the memory block
+ * that gets reallocated.
+ */
+static struct Charmap **currentCharmap;
 
 struct CharmapStackEntry {
-	struct Charmap *charmap;
+	struct Charmap **charmap;
 	struct CharmapStackEntry *next;
 };
 
-static struct Charmap *tHashedCharmaps[CHARMAP_HASH_SIZE];
-
-static struct Charmap *mainCharmap;
-static struct Charmap *currentCharmap;
-
 struct CharmapStackEntry *charmapStack;
 
-static void warnSectionCharmap(void)
+static struct Charmap *charmap_Get(char const *name)
 {
-	static bool warned = false;
-
-	if (warned)
-		return;
-
-	warning("Using 'charmap' within a section when the current charmap is 'main' is deprecated");
-	warned = true;
+	return hash_GetElement(charmaps, name);
 }
 
-static uint32_t charmap_CalcHash(const char *s)
+static void resizeCharmap(struct Charmap **map, size_t capacity)
 {
-	return calchash(s) % CHARMAP_HASH_SIZE;
+	*map = realloc(*map, sizeof(**map) + sizeof(*(*map)->nodes) * capacity);
+
+	if (!*map)
+		fatalerror("Failed to %s charmap: %s\n",
+			   *map ? "create" : "resize", strerror(errno));
+	(**map).capacity = capacity;
 }
 
-static struct Charmap **charmap_Get(const char *name)
+static void initNode(struct Charnode *node)
 {
-	struct Charmap **ppCharmap = &tHashedCharmaps[charmap_CalcHash(name)];
-
-	while (*ppCharmap != NULL && strcmp((*ppCharmap)->name, name))
-		ppCharmap = &(*ppCharmap)->next;
-
-	return ppCharmap;
+	node->isTerminal = false;
+	memset(node->next, 0, sizeof(node->next));
 }
 
-static void CopyNode(struct Charmap *dest,
-		     const struct Charmap *src,
-		     int nodeIdx)
+struct Charmap *charmap_New(char const *name, char const *baseName)
 {
-	dest->nodes[nodeIdx].code = src->nodes[nodeIdx].code;
-	dest->nodes[nodeIdx].isCode = src->nodes[nodeIdx].isCode;
-	for (int i = 0; i < 256; i++)
-		if (src->nodes[nodeIdx].next[i])
-			dest->nodes[nodeIdx].next[i] = dest->nodes +
-				(src->nodes[nodeIdx].next[i] - src->nodes);
-}
-
-struct Charmap *charmap_New(const char *name, const char *baseName)
-{
-	struct Charmap *pBase = NULL;
+	struct Charmap *base = NULL;
 
 	if (baseName != NULL) {
-		struct Charmap **ppBase = charmap_Get(baseName);
+		base = charmap_Get(baseName);
 
-		if (*ppBase == NULL) {
-			yyerror("Base charmap '%s' doesn't exist", baseName);
-			return NULL;
-		}
-
-		pBase = *ppBase;
+		if (base == NULL)
+			error("Base charmap '%s' doesn't exist\n", baseName);
 	}
 
-	struct Charmap **ppCharmap = charmap_Get(name);
+	struct Charmap *charmap = charmap_Get(name);
 
-	if (*ppCharmap != NULL) {
-		yyerror("Charmap '%s' already exists", name);
-		return NULL;
+	if (charmap) {
+		error("Charmap '%s' already exists\n", name);
+		return charmap;
 	}
 
-	*ppCharmap = calloc(1, sizeof(struct Charmap));
+	/* Init the new charmap's fields */
+	if (base) {
+		resizeCharmap(&charmap, base->capacity);
+		charmap->usedNodes = base->usedNodes;
 
-	if (*ppCharmap == NULL)
-		fatalerror("Not enough memory for charmap");
-
-	struct Charmap *pCharmap = *ppCharmap;
-
-	snprintf(pCharmap->name, sizeof(pCharmap->name), "%s", name);
-
-	if (pBase != NULL) {
-		pCharmap->charCount = pBase->charCount;
-		pCharmap->nodeCount = pBase->nodeCount;
-
-		for (int i = 0; i < MAXCHARNODES; i++)
-			CopyNode(pCharmap, pBase, i);
+		memcpy(charmap->nodes, base->nodes, sizeof(base->nodes[0]) * charmap->usedNodes);
+	} else {
+		resizeCharmap(&charmap, INITIAL_CAPACITY);
+		charmap->usedNodes = 1;
+		initNode(&charmap->nodes[0]); /* Init the root node */
 	}
+	charmap->name = strdup(name);
 
-	currentCharmap = pCharmap;
+	currentCharmap = (struct Charmap **)hash_AddElement(charmaps, charmap->name, charmap);
 
-	return pCharmap;
+	return charmap;
 }
 
-void charmap_Set(const char *name)
+void charmap_Delete(struct Charmap *charmap)
 {
-	struct Charmap **ppCharmap = charmap_Get(name);
+	free(charmap->name);
+	free(charmap);
+}
 
-	if (*ppCharmap == NULL) {
-		yyerror("Charmap '%s' doesn't exist", name);
-		return;
-	}
+void charmap_Set(char const *name)
+{
+	struct Charmap **charmap = (struct Charmap **)hash_GetNode(charmaps, name);
 
-	currentCharmap = *ppCharmap;
+	if (charmap == NULL)
+		error("Charmap '%s' doesn't exist\n", name);
+	else
+		currentCharmap = charmap;
 }
 
 void charmap_Push(void)
 {
 	struct CharmapStackEntry *stackEntry;
 
-	stackEntry = malloc(sizeof(struct CharmapStackEntry));
+	stackEntry = malloc(sizeof(*stackEntry));
 	if (stackEntry == NULL)
-		fatalerror("No memory for charmap stack");
+		fatalerror("Failed to alloc charmap stack entry: %s\n", strerror(errno));
 
 	stackEntry->charmap = currentCharmap;
 	stackEntry->next = charmapStack;
@@ -142,8 +146,10 @@ void charmap_Push(void)
 
 void charmap_Pop(void)
 {
-	if (charmapStack == NULL)
-		fatalerror("No entries in the charmap stack");
+	if (charmapStack == NULL) {
+		error("No entries in the charmap stack\n");
+		return;
+	}
 
 	struct CharmapStackEntry *top = charmapStack;
 
@@ -152,145 +158,107 @@ void charmap_Pop(void)
 	free(top);
 }
 
-void charmap_InitMain(void)
+void charmap_Add(char *mapping, uint8_t value)
 {
-	mainCharmap = charmap_New("main", NULL);
-}
+	struct Charmap *charmap = *currentCharmap;
+	struct Charnode *node = &charmap->nodes[0];
 
-int32_t charmap_Add(char *input, uint8_t output)
-{
-	int32_t i;
-	uint8_t v;
+	for (uint8_t c; *mapping; mapping++) {
+		c = *mapping - 1;
 
-	struct Charmap 	*charmap;
-	struct Charnode	*curr_node, *temp_node;
-
-	/*
-	 * If the user tries to define a character mapping inside a section
-	 * and the current global charmap is the "main" one, then a local
-	 * section charmap will be created or modified instead of the global
-	 * one. In other words, the local section charmap can override the
-	 * main global one, but not the others.
-	 */
-	if (pCurrentSection && currentCharmap == mainCharmap) {
-		warnSectionCharmap();
-		if (pCurrentSection->charmap) {
-			charmap = pCurrentSection->charmap;
+		if (node->next[c]) {
+			node = &charmap->nodes[node->next[c]];
 		} else {
-			charmap = calloc(1, sizeof(struct Charmap));
-			if (charmap == NULL)
-				fatalerror("Not enough memory for charmap");
-			pCurrentSection->charmap = charmap;
-		}
-	} else {
-		charmap = currentCharmap;
-	}
-
-	if (charmap->charCount >= MAXCHARMAPS || strlen(input) > CHARMAPLENGTH)
-		return -1;
-
-	curr_node = &charmap->nodes[0];
-
-	for (i = 0; (v = (uint8_t)input[i]); i++) {
-		if (curr_node->next[v]) {
-			curr_node = curr_node->next[v];
-		} else {
-			temp_node = &charmap->nodes[charmap->nodeCount + 1];
-
-			curr_node->next[v] = temp_node;
-			curr_node = temp_node;
-
-			++charmap->nodeCount;
-		}
-	}
-
-	/* prevent duplicated keys by accepting only first key-value pair.  */
-	if (curr_node->isCode)
-		return charmap->charCount;
-
-	curr_node->code = output;
-	curr_node->isCode = 1;
-
-	return ++charmap->charCount;
-}
-
-int32_t charmap_Convert(char **input)
-{
-	struct Charmap 	*charmap;
-	struct Charnode	*charnode;
-
-	char *output;
-	char outchar[8];
-
-	int32_t i, match, length;
-	uint8_t v, foundCode;
-
-	/*
-	 * If there is a local section charmap and the current global charmap
-	 * is the "main" one, the local one is used. Otherwise, the global
-	 * one is used. In other words, the local section charmap can override
-	 * the main global one, but not the others.
-	 */
-	if (pCurrentSection &&
-	    pCurrentSection->charmap &&
-	    currentCharmap == mainCharmap)
-		charmap = pCurrentSection->charmap;
-	else
-		charmap = currentCharmap;
-
-	output = malloc(strlen(*input));
-	if (output == NULL)
-		fatalerror("Not enough memory for buffer");
-
-	length = 0;
-
-	while (**input) {
-		charnode = &charmap->nodes[0];
-
-		/*
-		 * find the longest valid match which has been registered in charmap.
-		 * note that there could be either multiple matches or no match.
-		 * and it possibly takes the longest match between them,
-		 * which means that it ignores partial matches shorter than the longest one.
-		*/
-		for (i = match = 0; (v = (*input)[i]);) {
-			if (!charnode->next[v])
-				break;
-
-			charnode = charnode->next[v];
-			i++;
-
-			if (charnode->isCode) {
-				match = i;
-				foundCode = charnode->code;
-			}
-		}
-
-		if (match) {
-			output[length] = foundCode;
-
-			length += 1;
-		} else {
-			/*
-			 * put a utf-8 character
-			 * if failed to find a match.
-			 */
-			match = readUTF8Char(outchar, *input);
-
-			if (match) {
-				memcpy(output + length, *input, match);
-			} else {
-				output[length] = 0;
-				match = 1;
+			/* Register next available node */
+			node->next[c] = charmap->usedNodes;
+			/* If no more nodes are available, get new ones */
+			if (charmap->usedNodes == charmap->capacity) {
+				charmap->capacity *= 2;
+				resizeCharmap(currentCharmap, charmap->capacity);
+				charmap = *currentCharmap;
 			}
 
-			length += match;
+			/* Switch to and init new node */
+			node = &charmap->nodes[charmap->usedNodes++];
+			initNode(node);
 		}
-
-		*input += match;
 	}
 
-	*input = output;
+	if (node->isTerminal)
+		warning(WARNING_CHARMAP_REDEF, "Overriding charmap mapping\n");
 
-	return length;
+	node->isTerminal = true;
+	node->value = value;
+}
+
+size_t charmap_Convert(char const *input, uint8_t *output)
+{
+	uint8_t *start = output;
+
+	while (charmap_ConvertNext(&input, &output))
+		;
+
+	return output - start;
+}
+
+size_t charmap_ConvertNext(char const **input, uint8_t **output)
+{
+	/*
+	 * The goal is to match the longest mapping possible.
+	 * For that, advance through the trie with each character read.
+	 * If that would lead to a dead end, rewind characters until the last match, and output.
+	 * If no match, read a UTF-8 codepoint and output that.
+	 */
+	struct Charmap const *charmap = *currentCharmap;
+	struct Charnode const *node = &charmap->nodes[0];
+	struct Charnode const *match = NULL;
+	size_t rewindDistance = 0;
+
+	for (;;) {
+		uint8_t c = **input - 1;
+
+		if (**input && node->next[c]) {
+			// Consume that char
+			(*input)++;
+			rewindDistance++;
+
+			// Advance to next node (index starts at 1)
+			node = &charmap->nodes[node->next[c]];
+			if (node->isTerminal) {
+				// This node matches, register it
+				match = node;
+				rewindDistance = 0; // If no longer match is found, rewind here
+			}
+
+		} else {
+			// We are at a dead end (either because we reached the end of input, or of
+			// the trie), so rewind up to the last match, and output.
+			*input -= rewindDistance; // This will rewind all the way if no match found
+
+			if (match) { // A match was found, use it
+				if (output)
+					*(*output)++ = match->value;
+
+				return 1;
+
+			} else if (**input) { // No match found, but there is some input left
+				// This will write the codepoint's value to `output`, little-endian
+				size_t codepointLen = readUTF8Char(output ? *output : NULL,
+								   *input);
+
+				if (codepointLen == 0)
+					error("Input string is not valid UTF-8!\n");
+
+				// OK because UTF-8 has no NUL in multi-byte chars
+				*input += codepointLen;
+				if (output)
+					*output += codepointLen;
+
+				return codepointLen;
+
+			} else { // End of input
+				return 0;
+			}
+		}
+	}
 }

src/asm/constexpr.c

@@ -1,239 +0,0 @@
-/*
- * This file is part of RGBDS.
- *
- * Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
- *
- * SPDX-License-Identifier: MIT
- */
-
-#include <stdint.h>
-#include <stdio.h>
-#include <string.h>
-
-#include "asm/asm.h"
-#include "asm/constexpr.h"
-#include "asm/lexer.h"
-#include "asm/main.h"
-#include "asm/mymath.h"
-#include "asm/rpn.h"
-#include "asm/symbol.h"
-
-#include "asmy.h"
-
-void constexpr_Symbol(struct ConstExpression *expr, char *tzSym)
-{
-	if (!sym_isConstant(tzSym)) {
-		struct sSymbol *pSym = sym_FindSymbol(tzSym);
-
-		if (pSym != NULL) {
-			expr->u.pSym = pSym;
-			expr->isSym = 1;
-		} else {
-			fatalerror("'%s' not defined", tzSym);
-		}
-	} else {
-		constexpr_Number(expr, sym_GetConstantValue(tzSym));
-	}
-}
-
-void constexpr_Number(struct ConstExpression *expr, int32_t i)
-{
-	expr->u.nVal = i;
-	expr->isSym = 0;
-}
-
-void constexpr_UnaryOp(struct ConstExpression *expr,
-		       int32_t op,
-		       const struct ConstExpression *src)
-{
-	if (src->isSym)
-		fatalerror("Non-constant operand in constant expression");
-
-	int32_t value = src->u.nVal;
-	int32_t result = 0;
-
-	switch (op) {
-	case T_OP_HIGH:
-		result = (value >> 8) & 0xFF;
-		break;
-	case T_OP_LOW:
-		result = value & 0xFF;
-		break;
-	case T_OP_LOGICNOT:
-		result = !value;
-		break;
-	case T_OP_ADD:
-		result = value;
-		break;
-	case T_OP_SUB:
-		result = -(uint32_t)value;
-		break;
-	case T_OP_NOT:
-		result = ~value;
-		break;
-	case T_OP_ROUND:
-		result = math_Round(value);
-		break;
-	case T_OP_CEIL:
-		result = math_Ceil(value);
-		break;
-	case T_OP_FLOOR:
-		result = math_Floor(value);
-		break;
-	case T_OP_SIN:
-		result = math_Sin(value);
-		break;
-	case T_OP_COS:
-		result = math_Cos(value);
-		break;
-	case T_OP_TAN:
-		result = math_Tan(value);
-		break;
-	case T_OP_ASIN:
-		result = math_ASin(value);
-		break;
-	case T_OP_ACOS:
-		result = math_ACos(value);
-		break;
-	case T_OP_ATAN:
-		result = math_ATan(value);
-		break;
-	default:
-		fatalerror("Unknown unary op");
-	}
-
-	constexpr_Number(expr, result);
-}
-
-void constexpr_BinaryOp(struct ConstExpression *expr,
-			int32_t op,
-			const struct ConstExpression *src1,
-			const struct ConstExpression *src2)
-{
-	int32_t value1;
-	int32_t value2;
-	int32_t result = 0;
-
-	if (op == T_OP_SUB && src1->isSym && src2->isSym) {
-		char *symName1 = src1->u.pSym->tzName;
-		char *symName2 = src2->u.pSym->tzName;
-
-		if (!sym_IsRelocDiffDefined(symName1, symName2))
-			fatalerror("'%s - %s' not defined", symName1, symName2);
-		value1 = sym_GetDefinedValue(symName1);
-		value2 = sym_GetDefinedValue(symName2);
-		result = value1 - value2;
-	} else if (src1->isSym || src2->isSym) {
-		fatalerror("Non-constant operand in constant expression");
-	} else {
-		value1 = src1->u.nVal;
-		value2 = src2->u.nVal;
-
-		switch (op) {
-		case T_OP_LOGICOR:
-			result = value1 || value2;
-			break;
-		case T_OP_LOGICAND:
-			result = value1 && value2;
-			break;
-		case T_OP_LOGICEQU:
-			result = value1 == value2;
-			break;
-		case T_OP_LOGICGT:
-			result = value1 > value2;
-			break;
-		case T_OP_LOGICLT:
-			result = value1 < value2;
-			break;
-		case T_OP_LOGICGE:
-			result = value1 >= value2;
-			break;
-		case T_OP_LOGICLE:
-			result = value1 <= value2;
-			break;
-		case T_OP_LOGICNE:
-			result = value1 != value2;
-			break;
-		case T_OP_ADD:
-			result = (uint32_t)value1 + (uint32_t)value2;
-			break;
-		case T_OP_SUB:
-			result = (uint32_t)value1 - (uint32_t)value2;
-			break;
-		case T_OP_XOR:
-			result = value1 ^ value2;
-			break;
-		case T_OP_OR:
-			result = value1 | value2;
-			break;
-		case T_OP_AND:
-			result = value1 & value2;
-			break;
-		case T_OP_SHL:
-			if (value1 < 0)
-				warning("Left shift of negative value: %d",
-					value1);
-
-			if (value2 < 0)
-				fatalerror("Shift by negative value: %d",
-					   value2);
-			else if (value2 >= 32)
-				fatalerror("Shift by too big value: %d",
-					   value2);
-
-			result = (uint32_t)value1 << value2;
-			break;
-		case T_OP_SHR:
-			if (value2 < 0)
-				fatalerror("Shift by negative value: %d",
-					   value2);
-			else if (value2 >= 32)
-				fatalerror("Shift by too big value: %d",
-					   value2);
-
-			result = value1 >> value2;
-			break;
-		case T_OP_MUL:
-			result = (uint32_t)value1 * (uint32_t)value2;
-			break;
-		case T_OP_DIV:
-			if (value2 == 0)
-				fatalerror("Division by zero");
-			if (value1 == INT32_MIN && value2 == -1) {
-				warning("Division of min value by -1");
-				result = INT32_MIN;
-			} else {
-				result = value1 / value2;
-			}
-			break;
-		case T_OP_MOD:
-			if (value2 == 0)
-				fatalerror("Division by zero");
-			if (value1 == INT32_MIN && value2 == -1)
-				result = 0;
-			else
-				result = value1 % value2;
-			break;
-		case T_OP_FDIV:
-			result = math_Div(value1, value2);
-			break;
-		case T_OP_FMUL:
-			result = math_Mul(value1, value2);
-			break;
-		case T_OP_ATAN2:
-			result = math_ATan2(value1, value2);
-			break;
-		default:
-			fatalerror("Unknown binary op");
-		}
-	}
-
-	constexpr_Number(expr, result);
-}
-
-int32_t constexpr_GetConstantValue(struct ConstExpression *expr)
-{
-	if (expr->isSym)
-		fatalerror("Non-constant expression");
-	return expr->u.nVal;
-}

src/asm/fixpoint.c

@@ -0,0 +1,170 @@
+/*
+ * This file is part of RGBDS.
+ *
+ * Copyright (c) 1997-2021, Carsten Sorensen and RGBDS contributors.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+/*
+ * Fixed-point math routines
+ */
+
+#include <inttypes.h>
+#include <math.h>
+#include <stdint.h>
+#include <stdio.h>
+
+#include "asm/fixpoint.h"
+#include "asm/symbol.h"
+#include "asm/warning.h"
+
+#define fix2double(i)	((double)((i) / 65536.0))
+#define double2fix(d)	((int32_t)round((d) * 65536.0))
+
+// pi radians == 32768 fixed-point "degrees"
+#define fdeg2rad(f)	((f) * (M_PI / 32768.0))
+#define rad2fdeg(r)	((r) * (32768.0 / M_PI))
+
+#ifndef M_PI
+#define M_PI 3.14159265358979323846
+#endif
+
+/*
+ * Return the _PI symbol value
+ */
+int32_t fix_Callback_PI(void)
+{
+	warning(WARNING_OBSOLETE, "`_PI` is deprecated; use 3.14159\n");
+
+	return double2fix(M_PI);
+}
+
+/*
+ * Print a fixed point value
+ */
+void fix_Print(int32_t i)
+{
+	uint32_t u = i;
+	char const *sign = "";
+
+	if (i < 0) {
+		u = -u;
+		sign = "-";
+	}
+
+	printf("%s%" PRIu32 ".%05" PRIu32, sign, u >> 16,
+	       ((uint32_t)(fix2double(u) * 100000 + 0.5)) % 100000);
+}
+
+/*
+ * Calculate sine
+ */
+int32_t fix_Sin(int32_t i)
+{
+	return double2fix(sin(fdeg2rad(fix2double(i))));
+}
+
+/*
+ * Calculate cosine
+ */
+int32_t fix_Cos(int32_t i)
+{
+	return double2fix(cos(fdeg2rad(fix2double(i))));
+}
+
+/*
+ * Calculate tangent
+ */
+int32_t fix_Tan(int32_t i)
+{
+	return double2fix(tan(fdeg2rad(fix2double(i))));
+}
+
+/*
+ * Calculate arcsine
+ */
+int32_t fix_ASin(int32_t i)
+{
+	return double2fix(rad2fdeg(asin(fix2double(i))));
+}
+
+/*
+ * Calculate arccosine
+ */
+int32_t fix_ACos(int32_t i)
+{
+	return double2fix(rad2fdeg(acos(fix2double(i))));
+}
+
+/*
+ * Calculate arctangent
+ */
+int32_t fix_ATan(int32_t i)
+{
+	return double2fix(rad2fdeg(atan(fix2double(i))));
+}
+
+/*
+ * Calculate atan2
+ */
+int32_t fix_ATan2(int32_t i, int32_t j)
+{
+	return double2fix(rad2fdeg(atan2(fix2double(i), fix2double(j))));
+}
+
+/*
+ * Multiplication
+ */
+int32_t fix_Mul(int32_t i, int32_t j)
+{
+	return double2fix(fix2double(i) * fix2double(j));
+}
+
+/*
+ * Division
+ */
+int32_t fix_Div(int32_t i, int32_t j)
+{
+	return double2fix(fix2double(i) / fix2double(j));
+}
+
+/*
+ * Power
+ */
+int32_t fix_Pow(int32_t i, int32_t j)
+{
+	return double2fix(pow(fix2double(i), fix2double(j)));
+}
+
+/*
+ * Logarithm
+ */
+int32_t fix_Log(int32_t i, int32_t j)
+{
+	return double2fix(log(fix2double(i)) / log(fix2double(j)));
+}
+
+/*
+ * Round
+ */
+int32_t fix_Round(int32_t i)
+{
+	return double2fix(round(fix2double(i)));
+}
+
+/*
+ * Ceil
+ */
+int32_t fix_Ceil(int32_t i)
+{
+	return double2fix(ceil(fix2double(i)));
+}
+
+/*
+ * Floor
+ */
+int32_t fix_Floor(int32_t i)
+{
+	return double2fix(floor(fix2double(i)));
+}