Use features of RGBDS 1.0.0 (#1204)

- Use single-quoted character literals or `CHARVAL` when you need
  a character's numeric value; using strings as numbers is deprecated
- Use `?` to silence a node in warning/error location backtraces
- Use `===` and `!==` instead of `STRCMP`, and `++` instead of `STRCAT`
- Use `__SCOPE__` instead of checking for `..` and `.` separately
- Use `#string` instead of `"{string}"`
- All programs (rgbasm, rgblink, rgbfix, rgbgfx) support `-W` warnings
- `rgbgfx --colors dmg` is short for `rgbgfx --colors dmg=e4`

Author: Rangi42

.github/workflows/main.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/checkout@master
         with:
           path: rgbds
-          ref: v0.9.3
+          ref: v1.0.0
           repository: gbdev/rgbds
 
       - name: Install rgbds

.rgbds-version

@@ -1 +1 @@
-0.9.3
+1.0.0

FAQ.md

@@ -41,15 +41,15 @@ You need to install `gcc`. If you're using Cygwin, re-run its setup, and at "Sel
 
 ### "ERROR: `UNION` already defined"
 
-Download [**rgbds 0.9.3**][rgbds] or newer. Older versions will not work.
+Download [**rgbds 1.0.0**][rgbds] or newer. Older versions will not work.
 
 ### "ERROR: Macro not defined"
 
-Download [**rgbds 0.9.3**][rgbds] or newer. Older versions will not work.
+Download [**rgbds 1.0.0**][rgbds] or newer. Older versions will not work.
 
 ### "Expression must be 8-bit"
 
-Download [**rgbds 0.9.3**][rgbds] or newer. Older versions will not work.
+Download [**rgbds 1.0.0**][rgbds] or newer. Older versions will not work.
 
 ### "Segmentation fault" from `rgbgfx`
 

INSTALL.md

@@ -42,9 +42,9 @@ Run setup and leave the default settings. At the "**Select Packages**" step, cho
 
 Double click on the text that says "**Skip**" next to each package to select the most recent version to install.
 
-Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#pre-built) for Windows with Cygwin to install **rgbds 0.9.3**.
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#pre-built) for Windows with Cygwin to install **rgbds 1.0.0**.
 
-**Note:** If you already have an installed rgbds older than 0.9.3, you will need to update to 0.9.3. Ignore this if you have never installed rgbds before. If a version newer than 0.9.3 does not work, try downloading 0.9.3.
+**Note:** If you already have an installed rgbds older than 1.0.0, you will need to update to 1.0.0. Ignore this if you have never installed rgbds before. If a version newer than 1.0.0 does not work, try downloading 1.0.0.
 
 Now open the **Cygwin terminal** and enter the following commands.
 
@@ -67,7 +67,7 @@ Install [**Homebrew**](https://brew.sh/). Follow the official instructions.
 
 Open **Terminal** and prepare to enter commands.
 
-Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#pre-built) for macOS to install **rgbds 0.9.3**.
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#pre-built) for macOS to install **rgbds 1.0.0**.
 
 Now you're ready to [build **pokecrystal**](#build-pokecrystal).
 
@@ -84,7 +84,7 @@ To install the software required for **pokecrystal**:
 sudo apt-get install make gcc git
 ```
 
-Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 0.9.3** from source.
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 1.0.0** from source.
 
 ### OpenSUSE
 
@@ -94,7 +94,7 @@ To install the software required for **pokecrystal**:
 sudo zypper install make gcc git
 ```
 
-Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 0.9.3** from source.
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 1.0.0** from source.
 
 ### Arch Linux
 
@@ -104,7 +104,7 @@ To install the software required for **pokecrystal**:
 sudo pacman -S make gcc git rgbds
 ```
 
-If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 0.9.3** from source.
+If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 1.0.0** from source.
 
 ### Termux
 
@@ -120,7 +120,7 @@ To install **rgbds**:
 pkg install rgbds
 ```
 
-If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 0.9.3** from source.
+If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 1.0.0** from source.
 
 ### Other distros
 
@@ -131,7 +131,7 @@ If your distro is not listed here, try to find the required software in its repo
 - `git`
 - `rgbds`
 
-If `rgbds` is not available, you'll need to follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 0.9.3** from source.
+If `rgbds` is not available, you'll need to follow the [**rgbds** instructions](https://rgbds.gbdev.io/install#building-from-source) to build **rgbds 1.0.0** from source.
 
 Now you're ready to [build **pokecrystal**](#build-pokecrystal).
 
@@ -159,12 +159,12 @@ make crystal11
 
 ### Build with a local rgbds version
 
-If you have different projects that require different versions of `rgbds`, it might not be convenient to install rgbds 0.9.3 globally. Instead, you can put its files in a directory within pokecrystal, such as `pokecrystal/rgbds-0.9.3/`. Then specify it when you run `make`:
+If you have different projects that require different versions of `rgbds`, it might not be convenient to install rgbds 1.0.0 globally. Instead, you can put its files in a directory within pokecrystal, such as `pokecrystal/rgbds-1.0.0/`. Then specify it when you run `make`:
 
 ```bash
-make RGBDS=rgbds-0.9.3/
+make RGBDS=rgbds-1.0.0/
 ```
 
 ```bash
-make RGBDS=rgbds-0.9.3/ crystal11
+make RGBDS=rgbds-1.0.0/ crystal11
 ```

Makefile

@@ -47,6 +47,11 @@ RGBFIX  ?= $(RGBDS)rgbfix
 RGBGFX  ?= $(RGBDS)rgbgfx
 RGBLINK ?= $(RGBDS)rgblink
 
+RGBASMFLAGS  ?= -Weverything -Wtruncation=1
+RGBLINKFLAGS ?= -Weverything -Wtruncation=1
+RGBFIXFLAGS  ?= -Weverything
+RGBGFXFLAGS  ?= -Weverything
+
 
 ### Build targets
 
@@ -104,7 +109,7 @@ tools:
 	$(MAKE) -C tools/
 
 
-RGBASMFLAGS = -Q8 -P includes.asm -Weverything -Wtruncation=1
+RGBASMFLAGS += -Q8 -P includes.asm
 # Create a sym/map for debug purposes if `make` run with `DEBUG=1`
 ifeq ($(DEBUG),1)
 RGBASMFLAGS += -E
@@ -150,16 +155,17 @@ $(foreach obj, $(pokecrystal11_vc_obj), $(eval $(call DEP,$(obj),$(obj:11_vc.o=.
 endif
 
 
-pokecrystal_opt         = -Cjv -t PM_CRYSTAL -i BYTE -n 0 -k 01 -l 0x33 -m MBC3+TIMER+RAM+BATTERY -r 3 -p 0
-pokecrystal11_opt       = -Cjv -t PM_CRYSTAL -i BYTE -n 1 -k 01 -l 0x33 -m MBC3+TIMER+RAM+BATTERY -r 3 -p 0
-pokecrystal_au_opt      = -Cjv -t PM_CRYSTAL -i BYTU -n 0 -k 01 -l 0x33 -m MBC3+TIMER+RAM+BATTERY -r 3 -p 0
-pokecrystal_debug_opt   = -Cjv -t PM_CRYSTAL -i BYTE -n 0 -k 01 -l 0x33 -m MBC3+TIMER+RAM+BATTERY -r 3 -p 0
-pokecrystal11_debug_opt = -Cjv -t PM_CRYSTAL -i BYTE -n 1 -k 01 -l 0x33 -m MBC3+TIMER+RAM+BATTERY -r 3 -p 0
-pokecrystal11_vc_opt    = -Cjv -t PM_CRYSTAL -i BYTE -n 1 -k 01 -l 0x33 -m MBC3+TIMER+RAM+BATTERY -r 3 -p 0
+RGBFIXFLAGS += -Cjv -t PM_CRYSTAL -k 01 -l 0x33 -m MBC3+TIMER+RAM+BATTERY -r 3 -p 0
+pokecrystal.gbc:         RGBFIXFLAGS += -i BYTE -n 0
+pokecrystal11.gbc:       RGBFIXFLAGS += -i BYTE -n 1
+pokecrystal_au.gbc:      RGBFIXFLAGS += -i BYTU -n 0
+pokecrystal_debug.gbc:   RGBFIXFLAGS += -i BYTE -n 0
+pokecrystal11_debug.gbc: RGBFIXFLAGS += -i BYTE -n 1
+pokecrystal11_vc.gbc:    RGBFIXFLAGS += -i BYTE -n 1
 
 %.gbc: $$(%_obj) layout.link
-	$(RGBLINK) -n $*.sym -m $*.map -l layout.link -o $@ $(filter %.o,$^)
-	$(RGBFIX) $($*_opt) $@
+	$(RGBLINK) $(RGBLINKFLAGS) -l layout.link -n $*.sym -m $*.map -o $@ $(filter %.o,$^)
+	$(RGBFIX) $(RGBFIXFLAGS) $@
 	tools/stadium $@
 
 
@@ -206,35 +212,35 @@ gfx/pokemon/girafarig/front.animated.tilemap: gfx/pokemon/girafarig/front.2bpp g
 
 ### Pokemon and trainer sprite rules
 
-gfx/pokemon/%/back.2bpp: rgbgfx += --columns
+gfx/pokemon/%/back.2bpp: RGBGFXFLAGS += --columns
 gfx/pokemon/%/back.2bpp: gfx/pokemon/%/back.png gfx/pokemon/%/normal.gbcpal
-	$(RGBGFX) $(rgbgfx) --colors gbc:$(word 2,$^) -o $@ $<
+	$(RGBGFX) $(RGBGFXFLAGS) --colors gbc:$(word 2,$^) -o $@ $<
 gfx/pokemon/%/front.2bpp: gfx/pokemon/%/front.png gfx/pokemon/%/normal.gbcpal
-	$(RGBGFX) $(rgbgfx) --colors gbc:$(word 2,$^) -o $@ $<
+	$(RGBGFX) $(RGBGFXFLAGS) --colors gbc:$(word 2,$^) -o $@ $<
 gfx/pokemon/%/normal.gbcpal: gfx/pokemon/%/front.gbcpal gfx/pokemon/%/back.gbcpal
 	tools/gbcpal $(tools/gbcpal) $@ $^
 
-gfx/trainers/%.2bpp: rgbgfx += --columns
+gfx/trainers/%.2bpp: RGBGFXFLAGS += --columns
 gfx/trainers/%.2bpp: gfx/trainers/%.png gfx/trainers/%.gbcpal
-	$(RGBGFX) $(rgbgfx) --colors gbc:$(word 2,$^) -o $@ $<
+	$(RGBGFX) $(RGBGFXFLAGS) --colors gbc:$(word 2,$^) -o $@ $<
 
 # Egg does not have a back sprite, so it only uses front.gbcpal
 gfx/pokemon/egg/front.2bpp: gfx/pokemon/egg/front.png gfx/pokemon/egg/front.gbcpal
-gfx/pokemon/egg/front.2bpp: rgbgfx += --colors gbc:$(word 2,$^)
+gfx/pokemon/egg/front.2bpp: RGBGFXFLAGS += --colors gbc:$(word 2,$^)
 
 # Unown letters share one normal.gbcpal
 unown_pngs := $(wildcard gfx/pokemon/unown_*/front.png) $(wildcard gfx/pokemon/unown_*/back.png)
 $(foreach png, $(unown_pngs),\
 	$(eval $(png:.png=.2bpp): $(png) gfx/pokemon/unown/normal.gbcpal))
-gfx/pokemon/unown_%/back.2bpp: rgbgfx += --colors gbc:$(word 2,$^)
-gfx/pokemon/unown_%/front.2bpp: rgbgfx += --colors gbc:$(word 2,$^)
+gfx/pokemon/unown_%/back.2bpp: RGBGFXFLAGS += --colors gbc:$(word 2,$^)
+gfx/pokemon/unown_%/front.2bpp: RGBGFXFLAGS += --colors gbc:$(word 2,$^)
 gfx/pokemon/unown/normal.gbcpal: $(subst .png,.gbcpal,$(unown_pngs))
 	tools/gbcpal $(tools/gbcpal) $@ $^
 
 
 ### Misc file-specific graphics rules
 
-gfx/pokemon/egg/unused_front.2bpp: rgbgfx += --columns
+gfx/pokemon/egg/unused_front.2bpp: RGBGFXFLAGS += --columns
 
 gfx/pokemon/spearow/normal.gbcpal: tools/gbcpal += --reverse
 gfx/pokemon/fearow/normal.gbcpal: tools/gbcpal += --reverse
@@ -247,8 +253,8 @@ gfx/pokemon/porygon2/normal.gbcpal: tools/gbcpal += --reverse
 
 gfx/trainers/swimmer_m.gbcpal: tools/gbcpal += --reverse
 
-gfx/new_game/shrink1.2bpp: rgbgfx += --columns
-gfx/new_game/shrink2.2bpp: rgbgfx += --columns
+gfx/new_game/shrink1.2bpp: RGBGFXFLAGS += --columns
+gfx/new_game/shrink2.2bpp: RGBGFXFLAGS += --columns
 
 gfx/mail/dragonite.1bpp: tools/gfx += --remove-whitespace
 gfx/mail/large_note.1bpp: tools/gfx += --remove-whitespace
@@ -258,17 +264,17 @@ gfx/mail/litebluemail_border.1bpp: tools/gfx += --remove-whitespace
 
 gfx/pokedex/pokedex.2bpp: tools/gfx += --trim-whitespace
 gfx/pokedex/pokedex_sgb.2bpp: tools/gfx += --trim-whitespace
-gfx/pokedex/question_mark.2bpp: rgbgfx += --columns
+gfx/pokedex/question_mark.2bpp: RGBGFXFLAGS += --columns
 gfx/pokedex/slowpoke.2bpp: tools/gfx += --trim-whitespace
 
-gfx/pokegear/pokegear.2bpp: rgbgfx += --trim-end 2
+gfx/pokegear/pokegear.2bpp: RGBGFXFLAGS += --trim-end 2
 gfx/pokegear/pokegear_sprites.2bpp: tools/gfx += --trim-whitespace
 
 gfx/mystery_gift/mystery_gift.2bpp: tools/gfx += --trim-whitespace
 
 gfx/title/crystal.2bpp: tools/gfx += --interleave --png=$<
 gfx/title/old_fg.2bpp: tools/gfx += --interleave --png=$<
-gfx/title/logo.2bpp: rgbgfx += --trim-end 4
+gfx/title/logo.2bpp: RGBGFXFLAGS += --trim-end 4
 
 gfx/trade/ball.2bpp: tools/gfx += --remove-whitespace
 gfx/trade/game_boy.2bpp: tools/gfx += --remove-duplicates --preserve=0x23,0x27
@@ -299,21 +305,21 @@ gfx/battle_anims/rocks.2bpp: tools/gfx += --remove-whitespace
 gfx/battle_anims/skyattack.2bpp: tools/gfx += --remove-whitespace
 gfx/battle_anims/status.2bpp: tools/gfx += --remove-whitespace
 
-gfx/player/chris.2bpp: rgbgfx += --columns
-gfx/player/chris_back.2bpp: rgbgfx += --columns
-gfx/player/kris.2bpp: rgbgfx += --columns
-gfx/player/kris_back.2bpp: rgbgfx += --columns
+gfx/player/chris.2bpp: RGBGFXFLAGS += --columns
+gfx/player/chris_back.2bpp: RGBGFXFLAGS += --columns
+gfx/player/kris.2bpp: RGBGFXFLAGS += --columns
+gfx/player/kris_back.2bpp: RGBGFXFLAGS += --columns
 
-gfx/trainer_card/chris_card.2bpp: rgbgfx += --columns
-gfx/trainer_card/kris_card.2bpp: rgbgfx += --columns
+gfx/trainer_card/chris_card.2bpp: RGBGFXFLAGS += --columns
+gfx/trainer_card/kris_card.2bpp: RGBGFXFLAGS += --columns
 gfx/trainer_card/leaders.2bpp: tools/gfx += --trim-whitespace
 
 gfx/overworld/chris_fish.2bpp: tools/gfx += --trim-whitespace
 gfx/overworld/kris_fish.2bpp: tools/gfx += --trim-whitespace
 
 gfx/sprites/big_onix.2bpp: tools/gfx += --remove-whitespace --remove-xflip
 
-gfx/battle/dude.2bpp: rgbgfx += --columns
+gfx/battle/dude.2bpp: RGBGFXFLAGS += --columns
 
 gfx/font/unused_bold_font.1bpp: tools/gfx += --trim-whitespace
 
@@ -336,12 +342,12 @@ gfx/mobile/stadium2_n64.2bpp: tools/gfx += --trim-whitespace
 ### Catch-all graphics rules
 
 %.2bpp: %.png
-	$(RGBGFX) --colors dmg=e4 $(rgbgfx) -o $@ $<
+	$(RGBGFX) --colors dmg $(RGBGFXFLAGS) -o $@ $<
 	$(if $(tools/gfx),\
 		tools/gfx $(tools/gfx) -o $@ $@ || $$($(RM) $@ && false))
 
 %.1bpp: %.png
-	$(RGBGFX) --colors dmg=e4 $(rgbgfx) --depth 1 -o $@ $<
+	$(RGBGFX) --colors dmg $(RGBGFXFLAGS) --depth 1 -o $@ $<
 	$(if $(tools/gfx),\
 		tools/gfx $(tools/gfx) --depth 1 -o $@ $@ || $$($(RM) $@ && false))
 

data/events/unown_walls.asm

@@ -8,15 +8,15 @@ UnownWalls:
 ; entries correspond to UNOWNWORDS_* constants
 	list_start
 	for x, NUM_UNOWN_WALLS
-		li "{UNOWNWORD_{d:x}}"
+		li #UNOWNWORD_{d:x}
 	endr
 	assert_list_length NUM_UNOWN_WALLS
 
 MenuHeaders_UnownWalls:
 ; entries correspond to UNOWNWORDS_* constants
 	table_width UNOWN_WALL_MENU_HEADER_SIZE
 	for x, NUM_UNOWN_WALLS
-		DEF n = CHARLEN("{UNOWNWORD_{d:x}}")
+		DEF n = CHARLEN(#UNOWNWORD_{d:x})
 		db MENU_BACKUP_TILES ; flags
 		menu_coords 9 - n, 4, 10 + n, 9
 	endr

data/maps/attributes.asm

@@ -37,7 +37,7 @@ MACRO connection
 			DEF _tgt = 0
 		endc
 
-		if !STRCMP("\1", "north")
+		if "\1" === "north"
 			DEF _blk = \3_WIDTH * (\3_HEIGHT - MAP_CONNECTION_PADDING_WIDTH) + _src
 			DEF _map = _tgt
 			DEF _win = (\3_WIDTH + MAP_CONNECTION_PADDING_WIDTH * 2) * \3_HEIGHT + 1
@@ -48,7 +48,7 @@ MACRO connection
 				DEF _len = \3_WIDTH
 			endc
 
-		elif !STRCMP("\1", "south")
+		elif "\1" === "south"
 			DEF _blk = _src
 			DEF _map = (CURRENT_MAP_WIDTH + MAP_CONNECTION_PADDING_WIDTH * 2) * (CURRENT_MAP_HEIGHT + MAP_CONNECTION_PADDING_WIDTH) + _tgt
 			DEF _win = \3_WIDTH + MAP_CONNECTION_PADDING_WIDTH * 2 + 1
@@ -59,7 +59,7 @@ MACRO connection
 				DEF _len = \3_WIDTH
 			endc
 
-		elif !STRCMP("\1", "west")
+		elif "\1" === "west"
 			DEF _blk = (\3_WIDTH * _src) + \3_WIDTH - MAP_CONNECTION_PADDING_WIDTH
 			DEF _map = (CURRENT_MAP_WIDTH + MAP_CONNECTION_PADDING_WIDTH * 2) * _tgt
 			DEF _win = (\3_WIDTH + MAP_CONNECTION_PADDING_WIDTH * 2) * 2 - MAP_CONNECTION_PADDING_WIDTH * 2
@@ -70,7 +70,7 @@ MACRO connection
 				DEF _len = \3_HEIGHT
 			endc
 
-		elif !STRCMP("\1", "east")
+		elif "\1" === "east"
 			DEF _blk = (\3_WIDTH * _src)
 			DEF _map = (CURRENT_MAP_WIDTH + MAP_CONNECTION_PADDING_WIDTH * 2) * _tgt + CURRENT_MAP_WIDTH + MAP_CONNECTION_PADDING_WIDTH
 			DEF _win = \3_WIDTH + MAP_CONNECTION_PADDING_WIDTH * 2 + 1

data/pokemon/unown_words.asm

@@ -1,6 +1,6 @@
 MACRO unownword
 for n, CHARLEN(\1)
-	db STRCHAR(\1, n) - "A" + FIRST_UNOWN_CHAR
+	db CHARVAL(STRCHAR(\1, n)) - 'A' + FIRST_UNOWN_CHAR
 endr
 	db -1
 ENDM

engine/battle/anim_hp_bar.asm

@@ -257,7 +257,7 @@ HPBarAnim_UpdateHPRemaining:
 .loaded_de
 	push hl
 	add hl, de
-	ld a, " "
+	ld a, ' '
 	ld [hli], a
 	ld [hli], a
 	ld [hld], a

engine/battle/battle_transition.asm

@@ -5,8 +5,8 @@ DEF BATTLETRANSITION_NO_CAVE          EQU $10
 DEF BATTLETRANSITION_NO_CAVE_STRONGER EQU $18
 DEF BATTLETRANSITION_FINISH           EQU $20
 
-DEF BATTLETRANSITION_SQUARE EQU "8" ; $fe
-DEF BATTLETRANSITION_BLACK  EQU "9" ; $ff
+DEF BATTLETRANSITION_SQUARE EQU '8' ; $fe
+DEF BATTLETRANSITION_BLACK  EQU '9' ; $ff
 
 DoBattleTransition:
 	call .InitGFX