Reformat

.luarc.json

@@ -0,0 +1,9 @@
+{
+    "diagnostics.globals": [
+        "printError",
+        "turtle",
+        "shell",
+        "peripheral",
+        "parallel"
+    ]
+}

controller/audio_controller.lua

@@ -1,5 +1,4 @@
 local dfpwm = require("cc.audio.dfpwm")
-local Direction = require("lib.direction")
 
 ---@alias AudioControllerConfig {buffer_length_seconds: number}
 
@@ -9,31 +8,26 @@ local Direction = require("lib.direction")
 local AudioController = {}
 AudioController.__index = AudioController
 
-
 ---@return AudioController
 function AudioController:Create()
 	local t = {}
 	setmetatable(t, AudioController)
 
-
 	-----------------------------------------------------------------------------------------------
 	-- Fields
 	-----------------------------------------------------------------------------------------------
 	t.config = {
-        buffer_length_seconds = 1
+		buffer_length_seconds = 1,
 	}
 	t.play = false
 
-
 	return t
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Audio Methods
 -----------------------------------------------------------------------------------------------
 
-
 function AudioController:PlayAudio(filename)
 	self.play = true
 
@@ -47,6 +41,10 @@ function AudioController:PlayAudio(filename)
 			local buffer = decoder(chunk)
 
 			while not self:GetSpeaker().playAudio(buffer) do
+				if not self.play then
+					break
+				end
+
 				---@diagnostic disable-next-line: undefined-field
 				os.pullEvent("speaker_audio_empty")
 			end
@@ -54,7 +52,6 @@ function AudioController:PlayAudio(filename)
 	end
 end
 
-
 function AudioController:PlayAudioFactory(filename)
 	local function play()
 		self:PlayAudio(filename)
@@ -63,34 +60,28 @@ function AudioController:PlayAudioFactory(filename)
 	return play
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Management Methods
 -----------------------------------------------------------------------------------------------
 
-
 ---@return table | nil
 function AudioController:GetSpeaker()
 	return peripheral.find("speaker")
 end
 
-
 function AudioController:StopPlaying()
 	self.play = false
 	self:GetSpeaker().stop()
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Main Method
 -----------------------------------------------------------------------------------------------
 
-
 function AudioController:Run()
 	-- self:Configure()
 
 	self:PlayAudio("bangarang")
 end
 
-
 return AudioController

controller/excavation_controller.lua

@@ -11,18 +11,15 @@ local AudioController = require("controller.audio_controller")
 local ExcavationController = {}
 ExcavationController.__index = ExcavationController
 
-
 ---@return ExcavationController
 function ExcavationController:Create()
 	local t = {}
 	setmetatable(t, ExcavationController)
 
-
 	-----------------------------------------------------------------------------------------------
 	-- Fields
 	-----------------------------------------------------------------------------------------------
 
-
 	t.controller = TurtleController:Create()
 	t.audio = AudioController:Create()
 	t.config = {
@@ -35,16 +32,13 @@ function ExcavationController:Create()
 		slices_right = 0,
 	}
 
-
 	return t
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Behavior Methods
 -----------------------------------------------------------------------------------------------
 
-
 ---Excavates a single 1x1/1x2 tunnel of configured length.
 ---Will leave the turtle wherever it ends up.
 ---Only unstocks/refuels if required.
@@ -66,7 +60,6 @@ function ExcavationController:Excavate_1x1or2or3xL(mine_above, mine_below)
 	self.controller:DisableMiningBelow()
 end
 
-
 ---Excavates a single 1xH partial slice of configured length.
 ---Will leave the turtle in its starting position.
 ---Only unstocks/refuels if required.
@@ -123,7 +116,6 @@ function ExcavationController:Excavate_1xHxL()
 	self.controller:DisableMiningBelow()
 end
 
-
 ---Excavates a single WxH slice of configured length (EAST to WEST).
 ---Will leave the turtle in its starting position.
 ---Only unstocks/refuels if required.
@@ -153,7 +145,6 @@ function ExcavationController:Excavate_WxHxL(center_slice)
 	self.controller:MoveBack()
 end
 
-
 ---Excavates all slices.
 ---Will leave the turtle refueled and unstocked in its 0x0x0 position.
 function ExcavationController:Excavate()
@@ -260,12 +251,10 @@ function ExcavationController:Excavate()
 	self.audio:StopPlaying()
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Management Methods
 -----------------------------------------------------------------------------------------------
 
-
 function ExcavationController:Configure()
 	local config_complete = false
 
@@ -299,23 +288,31 @@ function ExcavationController:Configure()
 		local mined_width = mined_width_left + mined_width_right + self.config.center_slice_width
 
 		print("Configuration complete!")
-        print(("Mining area spans %d x %d x %d (width x height x forward), totalling %d blocks."):format(
+		print(
-            padded_width, self.config.slice_height, self.config.slice_length, padded_width * self.config.slice_height * self.config.slice_length
+			("Mining area spans %d x %d x %d (width x height x forward), totalling %d blocks."):format(
-        ))
+				padded_width,
-        print(("Turtle will mine %d block wide slices (%d wide in the center) with %d blocks of padding, totalling %d mined blocks."):format(
+				self.config.slice_height,
-            self.config.slice_width, self.config.center_slice_width, self.config.slice_padding, mined_width * self.config.slice_height * self.config.slice_length
+				self.config.slice_length,
-        ))
+				padded_width * self.config.slice_height * self.config.slice_length
+			)
+		)
+		print(
+			("Turtle will mine %d block wide slices (%d wide in the center) with %d blocks of padding, totalling %d mined blocks."):format(
+				self.config.slice_width,
+				self.config.center_slice_width,
+				self.config.slice_padding,
+				mined_width * self.config.slice_height * self.config.slice_length
+			)
+		)
 		print("Do you want to accept the configuration (enter 1, otherwise 0)?")
 		config_complete = tonumber(io.read()) == 1
 	end
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Main Method
 -----------------------------------------------------------------------------------------------
 
-
 function ExcavationController:Run()
 	self.controller:Configure()
 	self:Configure()
@@ -325,8 +322,9 @@ function ExcavationController:Run()
 	turtle.refuel()
 	self.controller:RefuelIfEmpty()
 
-    parallel.waitForAll(function() self:Excavate() end, self.audio:PlayAudioFactory("bangarang"))
+	parallel.waitForAll(function()
+		self:Excavate()
+	end, self.audio:PlayAudioFactory("bangarang"))
 end
 
-
 return ExcavationController

controller/testing_controller.lua

@@ -6,7 +6,6 @@ local TurtleController = require("controller.turtle_controller")
 local TestingController = {}
 TestingController.__index = TestingController
 
-
 ---@return TestingController
 function TestingController:Create()
 	local t = {}
@@ -17,12 +16,10 @@ function TestingController:Create()
 	return t
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Behavior Methods
 -----------------------------------------------------------------------------------------------
 
-
 function TestingController:TestRelativeMovementWithRelativeRotation()
 	print("Testing relative movement with relative rotation...")
 
@@ -41,14 +38,18 @@ function TestingController:TestRelativeMovementWithRelativeRotation()
 	self.controller:TurnRelative(1) -- N: BackCenter (Center)
 
 	print("The turtle should be in its original location.")
-    print(("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
+	print(
-        self.controller.position.x, self.controller.position.y, self.controller.position.z, self.controller.position.dir
+		("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
-    ))
+			self.controller.position.x,
+			self.controller.position.y,
+			self.controller.position.z,
+			self.controller.position.dir
+		)
+	)
 	print("Press Enter to continue")
 	_ = io.read()
 end
 
-
 function TestingController:TestRelativeMovementWithAbsoluteRotation()
 	print("Testing relative movement with absolute rotation...")
 
@@ -67,14 +68,18 @@ function TestingController:TestRelativeMovementWithAbsoluteRotation()
 	self.controller:TurnToDirection(Direction.NORTH) -- N: BackCenter (Center)
 
 	print("The turtle should be in its original location.")
-    print(("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
+	print(
-        self.controller.position.x, self.controller.position.y, self.controller.position.z, self.controller.position.dir
+		("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
-    ))
+			self.controller.position.x,
+			self.controller.position.y,
+			self.controller.position.z,
+			self.controller.position.dir
+		)
+	)
 	print("Press Enter to continue")
 	_ = io.read()
 end
 
-
 function TestingController:TestAbsoluteMovementWithoutStack()
 	print("Testing absolute movement without stack...")
 
@@ -87,14 +92,18 @@ function TestingController:TestAbsoluteMovementWithoutStack()
 	self.controller:MoveToPosition(0, 0, 0, Direction.NORTH) -- N: BackCenter (Center)
 
 	print("The turtle should be in its original location.")
-    print(("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
+	print(
-        self.controller.position.x, self.controller.position.y, self.controller.position.z, self.controller.position.dir
+		("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
-    ))
+			self.controller.position.x,
+			self.controller.position.y,
+			self.controller.position.z,
+			self.controller.position.dir
+		)
+	)
 	print("Press Enter to continue")
 	_ = io.read()
 end
 
-
 function TestingController:TestAbsoluteMovementWithStack()
 	print("Testing absolute movement with stack...")
 
@@ -105,14 +114,18 @@ function TestingController:TestAbsoluteMovementWithStack()
 	self.controller:MoveBack() -- N: BotCenter (Center)
 
 	print("The turtle should be in its original location.")
-    print(("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
+	print(
-        self.controller.position.x, self.controller.position.y, self.controller.position.z, self.controller.position.dir
+		("The turtle has internal position (%d, %d, %d) and internal direction %d"):format(
-    ))
+			self.controller.position.x,
+			self.controller.position.y,
+			self.controller.position.z,
+			self.controller.position.dir
+		)
+	)
 	print("Press Enter to continue")
 	_ = io.read()
 end
 
-
 function TestingController:TestUnstocking()
 	print("Testing inventory unloading...")
 
@@ -130,7 +143,6 @@ function TestingController:TestUnstocking()
 	_ = io.read()
 end
 
-
 function TestingController:TestRefueling()
 	print("Testing refueling...")
 
@@ -148,12 +160,10 @@ function TestingController:TestRefueling()
 	_ = io.read()
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Main Method
 -----------------------------------------------------------------------------------------------
 
-
 function TestingController:Run()
 	self.controller:Configure()
 	self.controller:DisableMiningForward()
@@ -207,5 +217,4 @@ function TestingController:Run()
 	end
 end
 
-
 return TestingController

controller/turtle_controller.lua

@@ -14,18 +14,15 @@ local Stack = require("lib.stack")
 local TurtleController = {}
 TurtleController.__index = TurtleController
 
-
 ---@return TurtleController
 function TurtleController:Create()
 	local t = {}
 	setmetatable(t, TurtleController)
 
-
 	-----------------------------------------------------------------------------------------------
 	-- Fields
 	-----------------------------------------------------------------------------------------------
 
-
 	t.config = {
 		fuel_direction = Direction.EAST,
 		fuel_name = turtle.getItemDetail(1) == nil and "" or turtle.getItemDetail(1).name,
@@ -39,16 +36,13 @@ function TurtleController:Create()
 	t.mine_above = false
 	t.mine_below = false
 
-
 	return t
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Movement Methods
 -----------------------------------------------------------------------------------------------
 
-
 ---Positive numbers turn clockwise, negative numbers turn counterclockwise
 ---@param number_of_turns number
 function TurtleController:TurnRelative(number_of_turns)
@@ -75,7 +69,6 @@ function TurtleController:TurnRelative(number_of_turns)
 	self.position.dir = (self.position.dir + number_of_turns) % 4
 end
 
-
 ---@param direction Direction
 function TurtleController:TurnToDirection(direction)
 	if self.position.dir == direction then
@@ -85,7 +78,6 @@ function TurtleController:TurnToDirection(direction)
 	self:TurnRelative(direction - self.position.dir)
 end
 
-
 ---Move forward by a number of blocks depending on the current rotation
 ---@param number_of_blocks number
 ---@param skip_unstocking boolean | nil
@@ -179,13 +171,11 @@ function TurtleController:MoveVertical(number_of_blocks, skip_unstocking, skip_r
 	end
 end
 
-
 ---Stores the current position on the stack so we can return using TurtleController:MoveBack()
 function TurtleController:StorePosition()
 	self.last_positions:Push(Position:Copy(self.position))
 end
 
-
 ---Move to an absolute position. Stores the current position on the stack so we can return using TurtleController:MoveBack()
 ---@param x number The EAST/WEST axis (grows from WEST to EAST)
 ---@param y number The UP/DOWN axis (grows from DOWN to UP)
@@ -227,7 +217,6 @@ function TurtleController:MoveToPosition(x, y, z, dir, skip_unstocking, skip_ref
 	end
 end
 
-
 ---Move by a vector. Stores the current position on the stack so we can return using TurtleController:MoveBack()
 ---@param x number The EAST/WEST axis (grows from WEST to EAST)
 ---@param y number The UP/DOWN axis (grows from DOWN to UP)
@@ -236,10 +225,16 @@ end
 ---@param skip_unstocking boolean | nil
 ---@param skip_refueling boolean | nil
 function TurtleController:MoveByVector(x, y, z, dir, skip_unstocking, skip_refueling)
-    self:MoveToPosition(self.position.x + x, self.position.y + y, self.position.z + z, dir, skip_unstocking, skip_refueling)
+	self:MoveToPosition(
+		self.position.x + x,
+		self.position.y + y,
+		self.position.z + z,
+		dir,
+		skip_unstocking,
+		skip_refueling
+	)
 end
 
-
 ---Move to the previously stored position and pop this position from the stack.
 ---@param skip_unstocking boolean | nil
 ---@param skip_refueling boolean | nil
@@ -249,19 +244,24 @@ function TurtleController:MoveBack(skip_unstocking, skip_refueling)
 	if last_position == nil then
 		error("Failed to obtain last_position to move back!")
 	else
-        self:MoveToPosition(last_position.x, last_position.y, last_position.z, last_position.dir, skip_unstocking, skip_refueling)
+		self:MoveToPosition(
+			last_position.x,
+			last_position.y,
+			last_position.z,
+			last_position.dir,
+			skip_unstocking,
+			skip_refueling
+		)
 
 		-- Pop the stack because MoveToPosition pushes our current position
 		self.last_positions:Pop()
 	end
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Inventory Methods
 -----------------------------------------------------------------------------------------------
 
-
 ---@return boolean
 function TurtleController:HasFuel()
 	local level = turtle.getFuelLevel()
@@ -270,7 +270,6 @@ function TurtleController:HasFuel()
 	return level > distance_home + self.config.refuel_safety_margin
 end
 
-
 ---@return boolean
 function TurtleController:HasInventorySpace()
 	for slot = 1, 16 do
@@ -282,7 +281,6 @@ function TurtleController:HasInventorySpace()
 	return false
 end
 
-
 ---@param slot number
 ---@param count number
 ---@return boolean
@@ -297,7 +295,6 @@ function TurtleController:SuckItem(slot, count)
 	return sucked
 end
 
-
 ---@param slot number
 ---@param count number
 ---@return boolean
@@ -312,7 +309,6 @@ function TurtleController:DropItem(slot, count)
 	return dropped
 end
 
-
 function TurtleController:DropInventory()
 	print("Dropping inventory into chest...")
 
@@ -324,7 +320,6 @@ function TurtleController:DropInventory()
 	turtle.select(1)
 end
 
-
 ---@param skip_inventory_check boolean | nil
 function TurtleController:UnstockIfFull(skip_inventory_check)
 	skip_inventory_check = skip_inventory_check or false
@@ -344,7 +339,6 @@ function TurtleController:UnstockIfFull(skip_inventory_check)
 	self:MoveBack(true, true)
 end
 
-
 ---@param skip_fuel_check boolean | nil
 function TurtleController:RefuelIfEmpty(skip_fuel_check)
 	skip_fuel_check = skip_fuel_check or false
@@ -387,15 +381,19 @@ function TurtleController:RefuelIfEmpty(skip_fuel_check)
 
 	self:MoveBack(true, true)
 
-    print(("Refuelled %d units, current level is %d (old level was %d)"):format(after_level - before_level, after_level, before_level))
+	print(
+		("Refuelled %d units, current level is %d (old level was %d)"):format(
+			after_level - before_level,
+			after_level,
+			before_level
+		)
+	)
 end
 
-
 -----------------------------------------------------------------------------------------------
 -- Management Methods
 -----------------------------------------------------------------------------------------------
 
-
 function TurtleController:Configure()
 	local config_complete = false
 
@@ -422,41 +420,38 @@ function TurtleController:Configure()
 		self.config.storage_direction = tonumber(io.read()) or Direction.EAST
 
 		print("Configuration complete!")
-        print(("Turtle will consume \"%s\" for fuel. Put the desired fuel into the first slot to change."):format(self.config.fuel_name))
+		print(
+			('Turtle will consume "%s" for fuel. Put the desired fuel into the first slot to change.'):format(
+				self.config.fuel_name
+			)
+		)
 		print("Do you want to accept the configuration (enter 1, otherwise 0)?")
 		config_complete = tonumber(io.read()) == 1
 	end
 end
 
-
 function TurtleController:EnableMiningForward()
 	self.mine_forward = true
 end
 
-
 function TurtleController:DisableMiningForward()
 	self.mine_forward = false
 end
 
-
 function TurtleController:EnableMiningAbove()
 	self.mine_above = true
 end
 
-
 function TurtleController:DisableMiningAbove()
 	self.mine_above = false
 end
 
-
 function TurtleController:EnableMiningBelow()
 	self.mine_below = true
 end
 
-
 function TurtleController:DisableMiningBelow()
 	self.mine_below = false
 end
 
-
 return TurtleController

lib/direction.lua

@@ -3,7 +3,7 @@ local Direction = {
 	NORTH = 0,
 	EAST = 1,
 	SOUTH = 2,
-    WEST = 3
+	WEST = 3,
 }
 
 return Direction

lib/position.lua

@@ -8,7 +8,6 @@ local Direction = require("lib.direction")
 local Position = {}
 Position.__index = Position
 
-
 ---@return Position
 function Position:Empty()
 	local t = {}

lib/stack.lua

@@ -1,11 +1,8 @@
-local Position = require("lib.position")
-
 ---@class Stack
 ---@field elements Position[]
 local Stack = {}
 Stack.__index = Stack
 
-
 ---@return Stack
 function Stack:Create()
 	-- stack table
@@ -18,7 +15,6 @@ function Stack:Create()
 	return t
 end
 
-
 ---@param element Position
 function Stack:Push(element)
 	if element == nil or element == {} then
@@ -29,7 +25,6 @@ function Stack:Push(element)
 	table.insert(self.elements, element)
 end
 
-
 ---@return Position | nil
 function Stack:Pop()
 	if self:Count() == 0 then
@@ -40,7 +35,6 @@ function Stack:Pop()
 	return table.remove(self.elements)
 end
 
-
 ---@return Position | nil
 function Stack:Peek()
 	if self:Count() == 0 then
@@ -51,11 +45,9 @@ function Stack:Peek()
 	return self.elements[#self.elements]
 end
 
-
 ---@return number
 function Stack:Count()
 	return #self.elements
 end
 
-
 return Stack

main.lua

@@ -2,7 +2,6 @@ local TestingController = require("controller.testing_controller")
 local ExcavationController = require("controller.excavation_controller")
 local AudioController = require("controller.audio_controller")
 
-
 local controllers = {
 	TestingController:Create(),
 	ExcavationController:Create(),
@@ -22,7 +21,6 @@ end
 
 controllers[choice]:Run()
 
-
 -- TODO: StackOverflow once the inventory is full, unstocking doesn't work...
 --       Is the InventoryFull check wrong?
 -- TODO: Test if there's a chest when dropping/sucking/mining (don't mine chests!)