Check for indent spaces and fixed found problems. Lib C/C++ code is not checked.

Author: sfence

.github/workflows/whitespace_checks.yml

@@ -14,6 +14,7 @@ on:
       - '**.sh'
       - '**.cmake'
       - '**.glsl'
+      - '**.lua'
   pull_request:
     paths:
       - '**.txt'
@@ -24,6 +25,7 @@ on:
       - '**.sh'
       - '**.cmake'
       - '**.glsl'
+      - '**.lua'
 
 jobs:
   trailing_whitespaces:
@@ -34,6 +36,23 @@ jobs:
       - name: Check trailing whitespaces
         run: if git ls-files | grep -E '\.txt$|\.md$|\.[ch]$|\.cpp$|\.hpp$|\.sh$|\.cmake$|\.glsl$' | xargs grep -n '\s$'; then echo -e "\033[0;31mFound trailing whitespace"; (exit 1); else (exit 0); fi
 
+  indent_spaces:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Line endings are already ensured by .gitattributes
+      - name: Check for unsupported multiline comments
+        run: |
+          if git ls-files | grep -E '^src/.*\.cpp$|^src/.*\.[ch]$' | xargs grep -n '\*/.*/\*'; then echo -e "\033[0;31mUnsupported combination of multiline comments. New multiline comment should begin on new line."; (exit 1); else (exit 0); fi
+          if git ls-files | grep -E '\.lua$' | xargs grep -n '\]\]--.*--\[\['; then echo -e "\033[0;31mUnsupported combination of multiline comments. New multiline comment should begin on new line."; (exit 1); else (exit 0); fi
+      - name: Preprocess files
+        run: |
+          git ls-files | grep -E '^src/.*\.cpp$|^src/.*\.[ch]$' | xargs -L 1 -P $(($(nproc) + 1)) python3 ./util/ci/indent_tab_preprocess.py "/\\*" "\\*/"
+          git ls-files | grep -E '\.lua$' | xargs -L 1 -P $(($(nproc) + 1))  python3 ./util/ci/indent_tab_preprocess.py "--\\[\\[*" "--\\]\\]"
+      - name: Check indent spaces
+        run: |
+          if git ls-files | grep -E '^src/.*\.cpp$|^src/.*\.[ch]$|\.lua' | xargs grep -n -P '^\t*[ ]'; then echo -e "\033[0;31mFound indent whitespace"; (exit 1); else (exit 0); fi
+
   tabs_lua_api_files:
     runs-on: ubuntu-latest
     steps:

builtin/common/serialize.lua

@@ -193,7 +193,7 @@ end
 function core.serialize(value)
 	local rope = {}
 	serialize(value, function(text)
-		 -- Faster than table.insert(rope, text) on PUC Lua 5.1
+		-- Faster than table.insert(rope, text) on PUC Lua 5.1
 		rope[#rope + 1] = text
 	end)
 	return table_concat(rope)

builtin/common/vector.lua

@@ -71,8 +71,8 @@ metatable.__tostring = vector.to_string
 
 function vector.equals(a, b)
 	return a.x == b.x and
-	       a.y == b.y and
-	       a.z == b.z
+			a.y == b.y and
+			a.z == b.z
 end
 metatable.__eq = vector.equals
 
@@ -380,7 +380,7 @@ function vector.random_direction()
 	local x, y, z, l2
 	repeat -- expected less than two attempts on average (volume sphere vs. cube)
 		x, y, z = math.random() * 2 - 1, math.random() * 2 - 1, math.random() * 2 - 1
-        l2 = x*x + y*y + z*z
+		l2 = x*x + y*y + z*z
 	until l2 <= 1 and l2 >= 1e-6
 	-- normalize
 	local l = math.sqrt(l2)

builtin/fstk/buttonbar.lua

@@ -40,7 +40,7 @@ local function buttonbar_formspec(self)
 	-- `BASE_SPACING` is used as the minimum spacing, like `gap` in CSS Flexbox.
 
 	-- The number of buttons per page is always calculated as if the scroll
-    -- buttons were visible.
+	-- buttons were visible.
 	local avail_space = self.size.x - 2*BASE_SPACING - 2*get_scroll_btn_width()
 	local btns_per_page = math.floor((avail_space - BASE_SPACING) / (btn_size + BASE_SPACING))
 

builtin/game/falling.lua

@@ -80,7 +80,7 @@ core.register_entity(":__builtin:falling_node", {
 		self.floats = core.get_item_group(node.name, "float") ~= 0
 
 		-- Save liquidtype for falling water
-        self.liquidtype = def.liquidtype
+		self.liquidtype = def.liquidtype
 
 		-- Set entity visuals
 		if def.drawtype == "torchlike" or def.drawtype == "signlike" then

builtin/game/register.lua

@@ -247,17 +247,17 @@ function core.register_tool(name, tooldef)
 		tooldef.inventory_image = tooldef.image
 	end
 	if tooldef.tool_capabilities == nil and
-	   (tooldef.full_punch_interval ~= nil or
-	    tooldef.basetime ~= nil or
-	    tooldef.dt_weight ~= nil or
-	    tooldef.dt_crackiness ~= nil or
-	    tooldef.dt_crumbliness ~= nil or
-	    tooldef.dt_cuttability ~= nil or
-	    tooldef.basedurability ~= nil or
-	    tooldef.dd_weight ~= nil or
-	    tooldef.dd_crackiness ~= nil or
-	    tooldef.dd_crumbliness ~= nil or
-	    tooldef.dd_cuttability ~= nil) then
+			(tooldef.full_punch_interval ~= nil or
+			tooldef.basetime ~= nil or
+			tooldef.dt_weight ~= nil or
+			tooldef.dt_crackiness ~= nil or
+			tooldef.dt_crumbliness ~= nil or
+			tooldef.dt_cuttability ~= nil or
+			tooldef.basedurability ~= nil or
+			tooldef.dd_weight ~= nil or
+			tooldef.dd_crackiness ~= nil or
+			tooldef.dd_crumbliness ~= nil or
+			tooldef.dd_cuttability ~= nil) then
 		tooldef.tool_capabilities = {
 			full_punch_interval = tooldef.full_punch_interval,
 			basetime = tooldef.basetime,

builtin/game/voxelarea.lua

@@ -46,16 +46,16 @@ end
 function VoxelArea:index(x, y, z)
 	local MinEdge = self.MinEdge
 	local i = (z - MinEdge.z) * self.zstride +
-			  (y - MinEdge.y) * self.ystride +
-			  (x - MinEdge.x) + 1
+			(y - MinEdge.y) * self.ystride +
+			(x - MinEdge.x) + 1
 	return math_floor(i)
 end
 
 function VoxelArea:indexp(p)
 	local MinEdge = self.MinEdge
 	local i = (p.z - MinEdge.z) * self.zstride +
-			  (p.y - MinEdge.y) * self.ystride +
-			  (p.x - MinEdge.x) + 1
+			(p.y - MinEdge.y) * self.ystride +
+			(p.x - MinEdge.x) + 1
 	return math_floor(i)
 end
 
@@ -78,15 +78,15 @@ end
 function VoxelArea:contains(x, y, z)
 	local MaxEdge, MinEdge = self.MaxEdge, self.MinEdge
 	return (x >= MinEdge.x) and (x <= MaxEdge.x) and
-		   (y >= MinEdge.y) and (y <= MaxEdge.y) and
-		   (z >= MinEdge.z) and (z <= MaxEdge.z)
+			(y >= MinEdge.y) and (y <= MaxEdge.y) and
+			(z >= MinEdge.z) and (z <= MaxEdge.z)
 end
 
 function VoxelArea:containsp(p)
 	local MaxEdge, MinEdge = self.MaxEdge, self.MinEdge
 	return (p.x >= MinEdge.x) and (p.x <= MaxEdge.x) and
-		   (p.y >= MinEdge.y) and (p.y <= MaxEdge.y) and
-		   (p.z >= MinEdge.z) and (p.z <= MaxEdge.z)
+			(p.y >= MinEdge.y) and (p.y <= MaxEdge.y) and
+			(p.z >= MinEdge.z) and (p.z <= MaxEdge.z)
 end
 
 function VoxelArea:containsi(i)

games/devtest/mods/soundstuff/racecar.lua

@@ -4,14 +4,14 @@ local drive_distance = 30
 
 minetest.register_entity("soundstuff:racecar", {
 	initial_properties = {
-        physical = false,
-        collisionbox = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
-        selectionbox = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
-        visual = "upright_sprite",
-        visual_size = {x = 1, y = 1, z = 1},
-        textures = {"soundstuff_racecar.png", "soundstuff_racecar.png^[transformFX"},
-        static_save = false,
-    },
+		physical = false,
+		collisionbox = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
+		selectionbox = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
+		visual = "upright_sprite",
+		visual_size = {x = 1, y = 1, z = 1},
+		textures = {"soundstuff_racecar.png", "soundstuff_racecar.png^[transformFX"},
+		static_save = false,
+	},
 
 	on_activate = function(self, _staticdata, _dtime_s)
 		self.min_x = self.object:get_pos().x - drive_distance * 0.5

games/devtest/mods/testentities/selectionbox.lua

@@ -68,7 +68,7 @@ minetest.register_globalstep(function()
 				hud_ids[pname] = hud_id or player:hud_add({
 					type = "text",  -- See HUD element types
 					position = {x=0.5, y=0.5},
-			        text = "X",
+					text = "X",
 					number = 0xFF0000,
 					alignment = {x=0, y=0},
 				})

games/devtest/mods/tiled/init.lua

@@ -2,37 +2,38 @@ local align_help = "Texture spans over a space of 8×8 nodes"
 local align_help_n = "Tiles looks the same for every node"
 
 minetest.register_node("tiled:tiled", {
-        description = "Tiled Node (world-aligned)".."\n"..align_help,
-        tiles = {{
-                name = "tiled_tiled.png",
-                align_style = "world",
-                scale = 8,
-        }},
-        groups = {cracky=3},
+	description = "Tiled Node (world-aligned)".."\n"..align_help,
+	tiles = {{
+			name = "tiled_tiled.png",
+			align_style = "world",
+			scale = 8,
+	}},
+	groups = {cracky=3},
 })
 
 minetest.register_node("tiled:tiled_rooted", {
-        description = "Tiled 'plantlike_rooted' Node (world-aligned)".."\n"..
-                "Base node texture spans over a space of 8×8 nodes".."\n"..
-                "A plantlike thing grows on top",
-        paramtype = "light",
-        drawtype = "plantlike_rooted",
-        tiles = {{
-                name = "tiled_tiled.png",
-                align_style = "world",
-                scale = 8,
-        }},
-        special_tiles = {"tiled_tiled_node.png"},
-        groups = {cracky=3},
+	description =
+		"Tiled 'plantlike_rooted' Node (world-aligned)".."\n"..
+		"Base node texture spans over a space of 8×8 nodes".."\n"..
+		"A plantlike thing grows on top",
+	paramtype = "light",
+	drawtype = "plantlike_rooted",
+	tiles = {{
+		name = "tiled_tiled.png",
+		align_style = "world",
+		scale = 8,
+	}},
+	special_tiles = {"tiled_tiled_node.png"},
+	groups = {cracky=3},
 })
 
 minetest.register_node("tiled:tiled_n", {
-        description = "Tiled Node (node-aligned)".."\n"..align_help_n,
-        tiles = {{
-                name = "tiled_tiled_node.png",
-                align_style = "node",
-        }},
-        groups = {cracky=3},
+	description = "Tiled Node (node-aligned)".."\n"..align_help_n,
+	tiles = {{
+		name = "tiled_tiled_node.png",
+		align_style = "node",
+	}},
+	groups = {cracky=3},
 })
 
 stairs.register_stair_and_slab("tiled_n", "tiled:tiled_n",

games/devtest/mods/unittests/get_version.lua

@@ -1,16 +1,16 @@
 
 unittests.register("test_get_version", function()
-    local version = core.get_version()
-    assert(type(version) == "table")
-    assert(type(version.project) == "string")
-    assert(type(version.string) == "string")
-    assert(type(version.proto_min) == "number")
-    assert(type(version.proto_max) == "number")
-    assert(version.proto_max >= version.proto_min)
-    assert(type(version.is_dev) == "boolean")
-    if version.is_dev then
-        assert(type(version.hash) == "string")
-    else
-        assert(version.hash == nil)
-    end
+	local version = core.get_version()
+	assert(type(version) == "table")
+	assert(type(version.project) == "string")
+	assert(type(version.string) == "string")
+	assert(type(version.proto_min) == "number")
+	assert(type(version.proto_max) == "number")
+	assert(version.proto_max >= version.proto_min)
+	assert(type(version.is_dev) == "boolean")
+	if version.is_dev then
+		assert(type(version.hash) == "string")
+	else
+		assert(version.hash == nil)
+	end
 end)

games/devtest/mods/unittests/raycast.lua

@@ -1,36 +1,36 @@
 local function raycast_with_pointabilities(start_pos, end_pos, pointabilities)
 	local ray = core.raycast(start_pos, end_pos, nil, nil, pointabilities)
 	for hit in ray do
-        if hit.type == "node" then
-            return hit.under
-        end
+		if hit.type == "node" then
+			return hit.under
+		end
 	end
-    return nil
+	return nil
 end
 
 local function test_raycast_pointabilities(player, pos1)
-    local pos2 = pos1:offset(0, 0, 1)
-    local pos3 = pos1:offset(0, 0, 2)
+	local pos2 = pos1:offset(0, 0, 1)
+	local pos3 = pos1:offset(0, 0, 2)
 
-    local oldnode1 = core.get_node(pos1)
-    local oldnode2 = core.get_node(pos2)
-    local oldnode3 = core.get_node(pos3)
-    core.swap_node(pos1, {name = "air"})
-    core.swap_node(pos2, {name = "testnodes:not_pointable"})
-    core.swap_node(pos3, {name = "testnodes:pointable"})
+	local oldnode1 = core.get_node(pos1)
+	local oldnode2 = core.get_node(pos2)
+	local oldnode3 = core.get_node(pos3)
+	core.swap_node(pos1, {name = "air"})
+	core.swap_node(pos2, {name = "testnodes:not_pointable"})
+	core.swap_node(pos3, {name = "testnodes:pointable"})
 
-    local p = nil
-    assert(raycast_with_pointabilities(pos1, pos3, p) == pos3)
+	local p = nil
+	assert(raycast_with_pointabilities(pos1, pos3, p) == pos3)
 
-    p = core.registered_items["testtools:blocked_pointing_staff"].pointabilities
-    assert(raycast_with_pointabilities(pos1, pos3, p) == nil)
+	p = core.registered_items["testtools:blocked_pointing_staff"].pointabilities
+	assert(raycast_with_pointabilities(pos1, pos3, p) == nil)
 
-    p = core.registered_items["testtools:ultimate_pointing_staff"].pointabilities
-    assert(raycast_with_pointabilities(pos1, pos3, p) == pos2)
+	p = core.registered_items["testtools:ultimate_pointing_staff"].pointabilities
+	assert(raycast_with_pointabilities(pos1, pos3, p) == pos2)
 
-    core.swap_node(pos1, oldnode1)
-    core.swap_node(pos2, oldnode2)
-    core.swap_node(pos3, oldnode3)
+	core.swap_node(pos1, oldnode1)
+	core.swap_node(pos2, oldnode2)
+	core.swap_node(pos3, oldnode3)
 end
 
 unittests.register("test_raycast_pointabilities", test_raycast_pointabilities, {map=true})

games/devtest/mods/util_commands/init.lua

@@ -234,10 +234,10 @@ minetest.register_chatcommand("dump_wear_bar", {
 })
 
 core.register_chatcommand("set_saturation", {
-    params = "<saturation>",
-    description = "Set the saturation for current player.",
-    func = function(player_name, param)
-        local saturation = tonumber(param)
-        minetest.get_player_by_name(player_name):set_lighting({saturation = saturation })
-    end
+	params = "<saturation>",
+	description = "Set the saturation for current player.",
+	func = function(player_name, param)
+		local saturation = tonumber(param)
+		minetest.get_player_by_name(player_name):set_lighting({saturation = saturation })
+	end
 })

src/client/client.cpp

@@ -974,7 +974,7 @@ void Client::ReceiveAll()
 		} catch (const con::InvalidIncomingDataException &e) {
 			infostream << "Client::ReceiveAll(): "
 					"InvalidIncomingDataException: what()="
-					 << e.what() << std::endl;
+					<< e.what() << std::endl;
 		}
 	}
 }

src/client/clientlauncher.cpp

@@ -503,7 +503,7 @@ bool ClientLauncher::launch_game(std::string &error_message,
 
 	auto &worldspec = start_data.world_spec;
 	infostream << "Selected world: " << worldspec.name
-	           << " [" << worldspec.path << "]" << std::endl;
+			<< " [" << worldspec.path << "]" << std::endl;
 
 	if (start_data.address.empty()) {
 		// For singleplayer and local server

src/client/clientmedia.cpp

@@ -452,7 +452,7 @@ void ClientMediaDownloader::startRemoteMediaTransfers()
 
 		if (filestatus->received ||
 				(filestatus->current_remote < 0 &&
-				 !m_outstanding_hash_sets)) {
+				!m_outstanding_hash_sets)) {
 			// If we arrive here, we conclusively know that we
 			// won't fetch this file from a remote server in the
 			// future. So update the name bound if possible.

src/client/content_cso.cpp

@@ -53,8 +53,8 @@ class SmokePuffCSO: public ClientSimpleObject
 		bool pos_ok;
 		MapNode n = env->getMap().getNode(floatToInt(pos, BS), &pos_ok);
 		light = pos_ok ? decode_light(n.getLightBlend(env->getDayNightRatio(),
-							env->getGameDef()->ndef()->getLightingFlags(n)))
-		               : 64;
+				env->getGameDef()->ndef()->getLightingFlags(n)))
+				: 64;
 		video::SColor color(255,light,light,light);
 		m_spritenode->setColor(color);
 	}