Adds CI to prevent manual calls of update_icon_state, update_overlay, etc. (#27010)

* CI something something

* last fix

code/__DEFINES/_spacemandmm.dm

@@ -1,15 +1,22 @@
 // This file contains all the defines related to the spacemanDMM linter (dreamchecker). When running under normal conditions, BYOND will ignore all these
+// Read https://github.com/SpaceManiac/SpacemanDMM/tree/master/crates/dreamchecker for more info.
 #ifdef SPACEMAN_DMM
 	#define RETURN_TYPE(X) set SpacemanDMM_return_type = X
 	#define SHOULD_CALL_PARENT(X) set SpacemanDMM_should_call_parent = X
 	#define UNLINT(X) SpacemanDMM_unlint(X)
 	#define SHOULD_NOT_OVERRIDE(X) set SpacemanDMM_should_not_override = X
 	#define SHOULD_NOT_SLEEP(X) set SpacemanDMM_should_not_sleep = X
+	/// A "pure" proc does not make any external changes, or to its output.
 	#define SHOULD_BE_PURE(X) set SpacemanDMM_should_be_pure = X
+	/// Private procs can only be called by things of exactly the same type. This also prevents overriding of the proc.
 	#define PRIVATE_PROC(X) set SpacemanDMM_private_proc = X
+	/// Protected procs can only be call by things of the same type or subtypes
 	#define PROTECTED_PROC(X) set SpacemanDMM_protected_proc = X
+	/// Final vars forbid overriding their value by types that inherit it.
 	#define VAR_FINAL var/SpacemanDMM_final
+	/// Private vars can only be called by things of exactly the same type
 	#define VAR_PRIVATE var/SpacemanDMM_private
+	/// Protected vars can only be call by things of the same type or subtypes
 	#define VAR_PROTECTED var/SpacemanDMM_protected
 #else
 	#define RETURN_TYPE(X)

code/game/atoms.dm

@@ -488,11 +488,13 @@
 /// Updates the name of the atom
 /atom/proc/update_name(updates=ALL)
 	SHOULD_CALL_PARENT(TRUE)
+	PROTECTED_PROC(TRUE)
 	return SEND_SIGNAL(src, COMSIG_ATOM_UPDATE_NAME, updates)
 
 /// Updates the description of the atom
 /atom/proc/update_desc(updates=ALL)
 	SHOULD_CALL_PARENT(TRUE)
+	PROTECTED_PROC(TRUE)
 	return SEND_SIGNAL(src, COMSIG_ATOM_UPDATE_DESC, updates)
 
 /// Updates the icon of the atom
@@ -525,10 +527,12 @@
 
 /// Updates the icon state of the atom
 /atom/proc/update_icon_state()
+	PROTECTED_PROC(TRUE)
 	return
 
 /// Updates the overlays of the atom. It has to return a list of overlays if it can't call the parent to create one. The list can contain anything that would be valid for the add_overlay proc: Images, mutable appearances, icon states...
 /atom/proc/update_overlays()
+	PROTECTED_PROC(TRUE)
 	return list()
 
 /atom/proc/relaymove()

code/game/machinery/doors/airlock.dm

@@ -1531,8 +1531,7 @@ GLOBAL_LIST_EMPTY(airlock_emissive_underlays)
 		DA.polarized_glass = polarized_glass
 		DA.state = AIRLOCK_ASSEMBLY_NEEDS_ELECTRONICS
 		DA.created_name = name
-		DA.update_name()
-		DA.update_icon()
+		DA.update_appearance(UPDATE_NAME|UPDATE_ICON)
 
 		if(!disassembled)
 			if(DA)

code/game/machinery/doors/airlock_types.dm

@@ -197,8 +197,7 @@
 	DA = new /obj/structure/door_assembly(loc)
 	if(glass)
 		DA.glass = TRUE
-	DA.update_icon()
-	DA.update_name()
+	DA.update_appearance(UPDATE_NAME|UPDATE_ICON)
 	qdel(src)
 
 /obj/machinery/door/airlock/plasma/attackby(obj/item/C, mob/user, params)

code/game/machinery/doors/door.dm

@@ -610,6 +610,6 @@
 			blockage.max_integrity += 25
 		foam_level++
 		blockage.icon_state = "foamed_[foam_level]"
-		blockage.update_icon_state()
+		blockage.update_icon(UPDATE_ICON_STATE)
 
 #undef MAX_FOAM_LEVEL

code/game/machinery/requests_console.dm

@@ -383,7 +383,7 @@ GLOBAL_LIST_EMPTY(allRequestConsoles)
 /obj/machinery/requests_console/proc/print_label(tag_name, tag_index)
 	var/obj/item/shippingPackage/sp = new /obj/item/shippingPackage(get_turf(src))
 	sp.sortTag = tag_index
-	sp.update_desc()
+	sp.update_appearance(UPDATE_DESC)
 	print_cooldown = world.time + 600	//1 minute cooldown before you can print another label, but you can still configure the next one during this time
 
 /obj/machinery/requests_console/proc/view_messages()

code/game/mecha/mecha.dm

@@ -159,7 +159,7 @@
 	qdel(V)
 
 	set_light(lights_range_ambient, lights_power_ambient)
-	update_overlays()
+	update_icon(UPDATE_OVERLAYS)
 
 /obj/mecha/update_overlays()
 	. = ..()
@@ -1037,7 +1037,7 @@
 	AI.forceMove(src)
 	occupant = AI
 	icon_state = reset_icon(icon_state)
-	update_overlays()
+	update_icon(UPDATE_OVERLAYS)
 	playsound(src, 'sound/machines/windowdoor.ogg', 50, 1)
 	if(!hasInternalDamage())
 		SEND_SOUND(occupant, sound(nominalsound, volume = 50))
@@ -1195,7 +1195,7 @@
 			H.throw_alert("locked", /atom/movable/screen/alert/mech_maintenance)
 		if(connected_port)
 			H.throw_alert("mechaport_d", /atom/movable/screen/alert/mech_port_disconnect)
-		update_overlays()
+		update_icon(UPDATE_OVERLAYS)
 		return TRUE
 	else
 		return FALSE
@@ -1251,7 +1251,7 @@
 		Move(loc)
 		icon_state = reset_icon()
 		dir = dir_in
-		update_overlays()
+		update_icon(UPDATE_OVERLAYS)
 		log_message("[mmi_as_oc] moved in as pilot.")
 		if(!hasInternalDamage())
 			SEND_SOUND(occupant, sound(nominalsound, volume = 50))
@@ -1341,7 +1341,7 @@
 	if(ishuman(L))
 		var/mob/living/carbon/human/H = L
 		H.regenerate_icons() // workaround for 14457
-	update_overlays()
+	update_icon(UPDATE_OVERLAYS)
 
 /obj/mecha/force_eject_occupant(mob/target)
 	go_out()

code/game/objects/items/scratch_card.dm

@@ -27,7 +27,7 @@
 		icon_state = "scard_loser"
 	playsound(user, 'sound/items/scratching.ogg', 25, TRUE)
 	scratched = TRUE
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/item/scratch/attack_obj(obj/O, mob/living/user, params)
 	if(winner && istype(O, /obj/machinery/economy/atm))

code/game/objects/items/weapons/chemical_flamethrower/chemical_flamethrower.dm

@@ -39,7 +39,7 @@
 	if(should_start_with_canisters && !length(canisters))
 		canisters += new /obj/item/chemical_canister
 	update_canister_stats()
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/item/chemical_flamethrower/Destroy()
 	QDEL_LIST_CONTENTS(canisters)

code/game/objects/items/weapons/melee/melee_misc.dm

@@ -174,11 +174,11 @@
 /obj/item/melee/breach_cleaver/proc/wield(obj/item/source, mob/living/carbon/human/user)
 	to_chat(user, "<span class='notice'>You heave [src] up in both hands.</span>")
 	user.apply_status_effect(STATUS_EFFECT_BREACH_AND_CLEAVE)
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/item/melee/breach_cleaver/proc/unwield(obj/item/source, mob/living/carbon/human/user)
 	user.remove_status_effect(STATUS_EFFECT_BREACH_AND_CLEAVE)
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/item/melee/breach_cleaver/attack_obj(obj/O, mob/living/user, params)
 	if(!HAS_TRAIT(src, TRAIT_WIELDED)) // Only works good when wielded

code/game/objects/items/weapons/storage/backpack.dm

@@ -431,7 +431,7 @@
 				slowdown = 1
 			if(antidrop_on_zip)
 				flags ^= NODROP
-			update_icon_state(UPDATE_ICON_STATE)
+			update_icon(UPDATE_ICON_STATE)
 			return
 
 		slowdown = 0
@@ -440,7 +440,7 @@
 			container.hide_from_all() // Hide everything inside the bag too
 		if(antidrop_on_zip)
 			flags |= NODROP
-		update_icon_state(UPDATE_ICON_STATE)
+		update_icon(UPDATE_ICON_STATE)
 
 /obj/item/storage/backpack/duffel/update_icon_state()
 	. = ..()

code/game/objects/structures/door_assembly.dm

@@ -285,8 +285,7 @@
 	if(electronics)
 		target.electronics = source.electronics
 		source.electronics.forceMove(target)
-	target.update_icon(UPDATE_OVERLAYS)
-	target.update_name()
+	target.update_appearance(UPDATE_NAME|UPDATE_OVERLAYS)
 	qdel(source)
 
 /obj/structure/door_assembly/deconstruct(disassembled = TRUE)

code/game/objects/structures/mineral_doors.dm

@@ -243,6 +243,6 @@
 			blockage.max_integrity += 25
 		foam_level++
 		blockage.icon_state = "foamed_[foam_level]"
-		blockage.update_icon_state()
+		blockage.update_icon(UPDATE_ICON_STATE)
 
 #undef MAX_FOAM_LEVEL

code/game/objects/structures/transit_tubes/transit_tube_construction.dm

@@ -37,7 +37,7 @@
 		return
 
 	flipped = !flipped
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/structure/transit_tube_construction/screwdriver_act(mob/living/user, obj/item/I)
 	. = TRUE

code/modules/atmospherics/machinery/atmospherics.dm

@@ -297,7 +297,7 @@ Pipelines + Other Objects -> Pipe network
 		level = (T.intact || !can_be_undertile) ? 2 : 1
 	else
 		level = 2
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 	add_fingerprint(usr)
 	if(!SSair.initialized) //If there's no atmos subsystem, we can't really initialize pipenets
 		SSair.machinery_to_construct.Add(src)

code/modules/hydroponics/compost_bin.dm

@@ -96,7 +96,7 @@
 			to_chat(user, "<span class='notice'>You have very nearly saturated the contents of [src] with potassium.</span>")
 
 		SStgui.update_uis(src)
-		update_icon_state()
+		update_icon(UPDATE_ICON_STATE)
 		return TRUE
 
 	if(istype(O, /obj/item/food/grown))
@@ -110,7 +110,7 @@
 		make_biomass(O)
 		to_chat(user, "<span class='notice'>You put [O] in [src].</span>")
 		SStgui.update_uis(src)
-		update_icon_state()
+		update_icon(UPDATE_ICON_STATE)
 		return TRUE
 	if(istype(O, /obj/item/reagent_containers))
 		var/proportion = 0
@@ -154,7 +154,7 @@
 			to_chat(user, "<span class='notice'>[src] has been nearly filled with potash.</span>")
 
 		SStgui.update_uis(src)
-		update_icon_state()
+		update_icon(UPDATE_ICON_STATE)
 
 		return TRUE
 
@@ -199,7 +199,7 @@
 
 	biomass -= conversion_amount + potash_saltpetre_conversion + potassium_saltpetre_conversion
 	compost += conversion_amount
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 	SStgui.update_uis(src)
 
 // Makes soil from compost
@@ -209,7 +209,7 @@
 		return
 	new /obj/item/stack/sheet/soil(loc, amount)
 	compost -= SOIL_COST * amount
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 	SStgui.update_uis(src)
 
 /obj/machinery/compost_bin/attack_hand(mob/user)

code/modules/hydroponics/gene_modder.dm

@@ -451,7 +451,7 @@
 		else
 			core_gene.value = min(core_gene.value, genemod_var)
 
-	disk.update_name()
+	disk.update_appearance(UPDATE_NAME)
 	QDEL_NULL(seed)
 	update_icon(UPDATE_OVERLAYS)
 	update_genes()
@@ -493,7 +493,7 @@
 			var/datum/plant_gene/core/C = gene.Copy()
 			disk.core_genes += C
 
-	disk.update_name()
+	disk.update_appearance(UPDATE_NAME)
 	QDEL_NULL(seed)
 	update_icon(UPDATE_OVERLAYS)
 	update_genes()

code/modules/mob/living/simple_animal/slime/slime_death.dm

@@ -22,7 +22,7 @@
 			E.Grant(src)
 			revive()
 			regenerate_icons()
-			update_name()
+			update_appearance(UPDATE_NAME)
 			return
 
 	set_stat(DEAD) //Temporarily set to dead for icon updates

code/modules/mob/living/simple_animal/slime/slime_mob.dm

@@ -113,7 +113,7 @@
 
 /mob/living/simple_animal/slime/proc/set_colour(new_colour)
 	colour = new_colour
-	update_name()
+	update_appearance(UPDATE_NAME)
 	slime_mutation = mutation_table(colour)
 	var/sanitizedcolour = replacetext(colour, " ", "")
 	coretype = text2path("/obj/item/slime_extract/[sanitizedcolour]")

code/modules/mob/living/simple_animal/slime/slime_powers.dm

@@ -132,7 +132,7 @@
 			for(var/datum/action/innate/slime/evolve/E in actions)
 				E.Remove(src)
 			regenerate_icons()
-			update_name()
+			update_appearance(UPDATE_NAME)
 		else
 			to_chat(src, "<i>I am not ready to evolve yet...</i>")
 	else

code/modules/mod/mod_activation.dm

@@ -223,7 +223,7 @@
 			module.on_suit_deactivation()
 		STOP_PROCESSING(SSobj, src)
 	update_speed()
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 	wearer.regenerate_icons()
 
 /// Quickly deploys all the suit parts and if successful, seals them and turns on the suit. Intended mostly for outfits.

code/modules/mod/mod_construction.dm

@@ -250,7 +250,7 @@
 				if(part.use_tool(src, user, 0, volume = 30))
 					to_chat(user, "<span class='notice'>Assembly unscrewed.</span>")
 					construction_step = SCREWED_ASSEMBLY_STEP
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/item/mod/construction/shell/update_icon_state()
 	. = ..()

code/modules/mod/modules/_modules.dm

@@ -362,7 +362,7 @@
 		return
 	var/core_path = pick(accepted_anomalies)
 	core = new core_path(src)
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/item/mod/module/anomaly_locked/Destroy()
 	QDEL_NULL(core)
@@ -407,7 +407,7 @@
 		core = item
 		to_chat(user, "<span class='notice'>You install [item].</span>")
 		playsound(src, 'sound/machines/click.ogg', 30, TRUE)
-		update_icon_state()
+		update_icon(UPDATE_ICON_STATE)
 		core.forceMove(src)
 	else
 		return ..()
@@ -424,7 +424,7 @@
 	if(Adjacent(user) && !issilicon(user))
 		user.put_in_hands(core)
 	core = null
-	update_icon_state()
+	update_icon(UPDATE_ICON_STATE)
 
 /obj/item/mod/module/anomaly_locked/update_icon_state()
 	icon_state = initial(icon_state) + (core ? "-core" : "")

code/modules/paperwork/paper_bundle.dm

@@ -268,7 +268,7 @@
 			. += sheet
 
 	. += "clip"
-	update_desc()
+	update_appearance(UPDATE_DESC)
 
 /obj/item/paper_bundle/proc/get_page(page_override)
 	if(page_override)

code/modules/projectiles/ammunition.dm

@@ -128,7 +128,7 @@
 	var/list/stored_ammo = list()
 	var/ammo_type = /obj/item/ammo_casing
 	var/max_ammo = 7
-	var/multi_sprite_step = AMMO_BOX_MULTI_SPRITE_STEP_NONE // see update_icon_state() for details
+	var/multi_sprite_step = AMMO_BOX_MULTI_SPRITE_STEP_NONE // see update_icon_state for details
 	var/caliber
 	var/multiload = 1
 	var/slow_loading = FALSE

code/modules/reagents/chemistry/recipes/slime_extracts.dm

@@ -463,7 +463,7 @@
 		if(slime.docile) //Undoes docility, but doesn't make rabid.
 			slime.visible_message("<span class='danger'>[slime] forgets its training, becoming wild once again!</span>")
 			slime.docile = FALSE
-			slime.update_name()
+			slime.update_appearance(UPDATE_NAME)
 			continue
 		slime.rabid = TRUE
 		slime.visible_message("<span class='danger'>[slime] is driven into a frenzy!</span>")

code/modules/recycling/sortingmachinery.dm

@@ -450,7 +450,7 @@
 				to_chat(user, "<span class='notice'>You seal [src], preparing it for delivery.</span>")
 				icon_state = "shippack_sealed"
 				sealed = 1
-				update_desc()
+				update_appearance(UPDATE_DESC)
 	else
 		if(tgui_alert(user, "Do you want to tear up the package?", "Shipping", list("Yes", "No")) == "Yes")
 			to_chat(user, "<span class='notice'>You shred [src].</span>")

tools/ci/check_grep2.py

@@ -159,6 +159,16 @@ def check_empty_list_whitespace(idx, line):
     if EMPTY_LIST_WHITESPACE.search(line):
         return [(idx + 1, "Empty list declarations should not have any whitespace within their parentheses.")]
 
+IGNORE_ATOM_ICON_FILE = "atoms.dm"
+NO_MANUAL_ICON_UPDATES = re.compile(r"([\s.])(update_icon_state|update_desc|update_overlays|update_name)\(.*\)")
+def check_manual_icon_updates(idx, line):
+    if result := NO_MANUAL_ICON_UPDATES.search(line):
+        proc_result = result.group(2)
+        target = "update_icon"
+        if(proc_result == "update_name" or proc_result == "update_desc"):
+            target = "update_appearance"
+        return [(idx + 1, f"{proc_result}() should not be called manually. Use {target}({proc_result.upper()}) instead.")]
+
 CODE_CHECKS = [
     check_space_indentation,
     check_mixed_indentation,
@@ -196,6 +206,8 @@ if __name__ == "__main__":
             extra_checks = []
             if filename != IGNORE_515_PROC_MARKER_FILENAME:
                 extra_checks.append(check_515_proc_syntax)
+            if filename != IGNORE_ATOM_ICON_FILE:
+                extra_checks.append(check_manual_icon_updates)
 
             last_line = None
             for idx, line in enumerate(code):