Merge remote-tracking branch 'upstream/master'

* Add GitHub workflow
* Fix LuaCheck warnings
* Add build status badge on README.md

.github/workflows/build.yml

@@ -0,0 +1,11 @@
+on: [push, pull_request]
+name: build
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: lint
+        uses: Roang-zero1/factorio-mod-luacheck@master
+        with:
+          luacheckrc_url: ""

.luacheckrc

@@ -7,6 +7,7 @@ read_globals = {
 	"pipeworks",
 	"dump",
 	"VoxelArea",
+	"ItemStack",
 }
 
 globals = {

README.md

@@ -1,7 +1,10 @@
 Digilines
 ==========
-- The minetest counterpart for bus systems like i2c, SPI, RS232, USB -
 
+[![Build status](https://github.com/minetest-mods/digilines/workflows/build/badge.svg)](https://github.com/minetest-mods/digilines/actions)
+
+- The minetest counterpart for bus systems like i2c, SPI, RS232, USB -
+- Minetest 5.0.0+ is required to use this mod.
 
 This mod adds digiline wires, an RTC (Real Time Clock), a light sensor as well as an LCD Screen.
 Can be used together with the luacontroller from mesecons. See the luacontroller manual for more information.

depends.txt

@@ -1 +0,0 @@
-default

description.txt

@@ -1 +0,0 @@
-This mod adds digiline wires, an RTC (Real Time Clock), a light sensor as well as an LCD Screen. Can be used together with the luacontroller from mesecons.

internal.lua

@@ -92,7 +92,7 @@ function digilines.transmit(pos, channel, msg, checked)
 		return
 	end
 	checked[checkedID] = true
-	
+
 	digilines.vm_begin()
 	local queue = queue_new()
 	queue_enqueue(queue, pos)
@@ -112,9 +112,9 @@ function digilines.transmit(pos, channel, msg, checked)
 				for _, rule in ipairs(rules) do
 					local nextPos = digilines.addPosRule(curPos, rule)
 					if digilines.rules_link(curPos, nextPos) then
-						local checkedID = minetest.hash_node_position(nextPos)
-						if not checked[checkedID] then
-							checked[checkedID] = true
+						local checkedID2 = minetest.hash_node_position(nextPos)
+						if not checked[checkedID2] then
+							checked[checkedID2] = true
 							queue_enqueue(queue, nextPos)
 						end
 					end

inventory.lua

@@ -97,7 +97,7 @@ minetest.register_node("digilines:chest", {
 			minetest.get_meta(pos):set_string("channel",fields.channel)
 		end
 	end,
-	digiline = {
+	digilines = {
 		receptor = {},
 		effector = {
 			action = function() end
@@ -229,7 +229,7 @@ minetest.register_node("digilines:chest", {
 		last_inventory_take_index = index
 		return stack:get_count()
 	end,
-	on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player)
+	on_metadata_inventory_move = function(pos, _, from_index, _, to_index, count, player)
 		-- See what would happen if we were to move the items back from in the
 		-- opposite direction. In the event of a normal move, this must
 		-- succeed, because a normal move subtracts some items from the from

lcd.lua

@@ -5,7 +5,6 @@
 -- load characters map
 local chars_file = io.open(minetest.get_modpath("digilines").."/characters", "r")
 local charmap = {}
-local max_chars = 12
 if not chars_file then
 	print("[digilines] E: LCD: character map file not found")
 else
@@ -21,7 +20,7 @@ else
 end
 
 -- CONSTANTS
-local LCD_WITH = 100
+local LCD_WIDTH = 100
 local LCD_PADDING = 8
 
 local LINE_LENGTH = 12
@@ -30,31 +29,95 @@ local NUMBER_OF_LINES = 5
 local LINE_HEIGHT = 14
 local CHAR_WIDTH = 5
 
+
+assert((CHAR_WIDTH+1) * LINE_LENGTH <= LCD_WIDTH - LCD_PADDING*2, "LCD: Lines set too long!")
+assert((LINE_HEIGHT+1) * NUMBER_OF_LINES <= LCD_WIDTH - LCD_PADDING*2, "LCD: Too many lines!")
+
+
+local split = function(s, pat)
+	-- adapted from https://stackoverflow.com/a/1647577/4067384
+	-- simplified for our only usecase
+	local st, g = 1, s:gmatch("()("..pat..")")
+	local function getter()
+		if st then
+			local segs, seps, sep = st, g()
+			st = sep and seps + #sep
+			return s:sub(segs, (seps or 0) - 1)
+		end
+	end
+	return getter
+end
+
 local create_lines = function(text)
+	--[[
+	  Typeset the lines according to these rules (in order of subjective significance):
+	  - words that fit on the screen but would let the current line overflow are placed on a new line instead
+	  - " | " always forces a linebreak
+	  - spaces are included, except when there is a linebreak anyway
+	  - words with more characters than fit on screen are just chopped up, filling the lines as full as possible
+	  - don't bother typesetting more lines than fit on screen
+	  - if we are on the last line that will fit on screen
+	]]--
 	local line = ""
 	local line_num = 1
 	local tab = {}
-	for word in string.gmatch(text, "%S+") do
-		if string.len(line)+string.len(word) < LINE_LENGTH and word ~= "|" then
-			if line ~= "" then
-				line = line.." "..word
+	local flush_line_and_check_for_return = function()
+		table.insert(tab, line)
+		line_num = line_num+1
+		if line_num > NUMBER_OF_LINES then
+			return true
+		end
+		line = ""
+	end
+	for par in split(text, " | ") do
+		for word in split(par, "%s") do
+			if string.len(word) <= LINE_LENGTH and line_num < NUMBER_OF_LINES then
+				local line_len = string.len(line)
+				if line_len > 0 then
+					-- remember the space
+					line_len = line_len + 1
+				end
+				if line_len + string.len(word) <= LINE_LENGTH then
+					if line_len > 0 then
+						line = line.." "..word
+					else
+						line = word
+					end
+				else
+					-- don't add the space since we have a line break
+					if word ~= " " then
+						if line_len > 0 then
+							-- ok, we need the new line
+							if flush_line_and_check_for_return() then return tab end
+						end
+						line = word
+					end
+				end
 			else
-				line = word
-			end
-		else
-			table.insert(tab, line)
-			if word ~= "|" then
-				line = word
-			else
-				line = ""
-			end
-			line_num = line_num+1
-			if line_num > NUMBER_OF_LINES then
-				return tab
+				-- chop up word to make it fit
+				local remaining
+				while true do
+					remaining = LINE_LENGTH - string.len(line)
+					if remaining < LINE_LENGTH then
+						line = line .. " "
+						remaining = remaining - 1
+					end
+					if remaining < string.len(word) then
+						line = line .. string.sub(word, 1, remaining)
+						word = string.sub(word, remaining+1)
+						if flush_line_and_check_for_return() then return tab end
+					else
+						-- used up the word
+						line = line .. word
+						break
+					end
+				end
 			end
 		end
+		-- end of paragraph
+		if flush_line_and_check_for_return() then return tab end
+		line = ""
 	end
-	table.insert(tab, line)
 	return tab
 end
 
@@ -63,7 +126,7 @@ local generate_line = function(s, ypos)
 	local parsed = {}
 	local width = 0
 	local chars = 0
-	while chars < max_chars and i <= #s do
+	while chars < LINE_LENGTH and i <= #s do
 		local file = nil
 		if charmap[s:sub(i, i)] ~= nil then
 			file = charmap[s:sub(i, i)]
@@ -73,10 +136,13 @@ local generate_line = function(s, ypos)
 			i = i + 2
 		else
 			print("[digilines] W: LCD: unknown symbol in '"..s.."' at "..i)
+			if charmap[" "] ~= nil then
+				file = charmap[" "]
+			end
 			i = i + 1
 		end
 		if file ~= nil then
-			width = width + CHAR_WIDTH
+			width = width + CHAR_WIDTH + 1
 			table.insert(parsed, file)
 			chars = chars + 1
 		end
@@ -84,7 +150,7 @@ local generate_line = function(s, ypos)
 	width = width - 1
 
 	local texture = ""
-	local xpos = math.floor((LCD_WITH - 2 * LCD_PADDING - width) / 2 + LCD_PADDING)
+	local xpos = math.floor((LCD_WIDTH - width) / 2)
 	for ii = 1, #parsed do
 		texture = texture..":"..xpos..","..ypos.."="..parsed[ii]..".png"
 		xpos = xpos + CHAR_WIDTH + 1
@@ -93,8 +159,8 @@ local generate_line = function(s, ypos)
 end
 
 local generate_texture = function(lines)
-	local texture = "[combine:"..LCD_WITH.."x"..LCD_WITH
-	local ypos = 16
+	local texture = "[combine:"..LCD_WIDTH.."x"..LCD_WIDTH
+	local ypos = math.floor((LCD_WIDTH - LINE_HEIGHT*NUMBER_OF_LINES) / 2)
 	for i = 1, #lines do
 		texture = texture..generate_line(lines[i], ypos)
 		ypos = ypos + LINE_HEIGHT
@@ -173,7 +239,7 @@ local prepare_writing = function(pos)
 	if entity then
 		set_texture(entity)
 		rotate_text(pos)
-	end	
+	end
 end
 
 local spawn_entity = function(pos)
@@ -225,12 +291,12 @@ minetest.register_node("digilines:lcd", {
 	end,
 	on_construct = reset_meta,
 	on_destruct = clearscreen,
-	on_punch = function(pos, node, puncher, pointed_thing)
+	on_punch = function(pos, _, puncher, _)
 		if minetest.is_player(puncher) then
 			spawn_entity(pos)
 		end
 	end,
-	on_rotate = function(pos, node, user, mode, new_param2)
+	on_rotate = function(pos, _, _, mode, new_param2)
 		if mode ~= screwdriver.ROTATE_FACE then
 			return false
 		end
@@ -246,7 +312,7 @@ minetest.register_node("digilines:lcd", {
 			minetest.get_meta(pos):set_string("channel", fields.channel)
 		end
 	end,
-	digiline = {
+	digilines = {
 		receptor = {},
 		effector = {
 			action = on_digiline_receive
@@ -273,7 +339,10 @@ minetest.register_craft({
 	output = "digilines:lcd 2",
 	recipe = {
 		{"default:steel_ingot", "digilines:wire_std_00000000", "default:steel_ingot"},
-		{"mesecons_lightstone:lightstone_green_off","mesecons_lightstone:lightstone_green_off","mesecons_lightstone:lightstone_green_off"},
+		{"mesecons_lightstone:lightstone_green_off",
+		"mesecons_lightstone:lightstone_green_off",
+		"mesecons_lightstone:lightstone_green_off"},
+
 		{"default:glass","default:glass","default:glass"}
 	}
 })

lightsensor.lua

@@ -39,7 +39,7 @@ minetest.register_node("digilines:lightsensor", {
 	groups = {dig_immediate=2},
 	selection_box = lsensor_selbox,
 	node_box = lsensor_nodebox,
-	digiline =
+	digilines =
 	{
 		receptor = {},
 		effector = {

mod.conf

@@ -1 +1,6 @@
 name = digilines
+depends = default
+description = """
+This mod adds digiline wires, an RTC (Real Time Clock), a light sensor as well as an LCD Screen. 
+Can be used together with the luacontroller from mesecons.
+"""

rtc.lua

@@ -35,7 +35,7 @@ minetest.register_node("digilines:rtc", {
 	groups = {dig_immediate=2},
 	selection_box = rtc_selbox,
 	node_box = rtc_nodebox,
-	digiline =
+	digilines =
 	{
 		receptor = {},
 		effector = {

wire_std.lua

@@ -90,7 +90,7 @@ for zmy=0, 1 do
 		paramtype = "light",
 		paramtype2 = "facedir",
 		sunlight_propagates = true,
-		digiline =
+		digilines =
 		{
 			wire =
 			{

wires_common.lua

@@ -1,15 +1,12 @@
-minetest.register_on_placenode(function(pos, node)
-	if minetest.registered_nodes[node.name].digiline then
-		digilines.update_autoconnect(pos)
-	end
-end)
 
-minetest.register_on_dignode(function(pos, node)
-	if minetest.registered_nodes[node.name] and minetest.registered_nodes[node.name].digiline then
--- need to make sure that node exists (unknown nodes!)
+local function check_and_update(pos, node)
+	if digilines.getspec(node) then
 		digilines.update_autoconnect(pos)
 	end
-end)
+end
+
+minetest.register_on_placenode(check_and_update)
+minetest.register_on_dignode(check_and_update)
 
 function digilines.update_autoconnect(pos, secondcall)
 	local xppos = {x=pos.x+1, y=pos.y, z=pos.z}
@@ -42,8 +39,7 @@ function digilines.update_autoconnect(pos, secondcall)
 		digilines.update_autoconnect(zmympos, true)
 	end
 
-	local def = minetest.registered_nodes[minetest.get_node(pos).name]
-	local digilinespec = def and def.digiline
+	local digilinespec = digilines.getspec(minetest.get_node(pos))
 	if not (digilinespec and digilinespec.wire and
 			digilinespec.wire.use_autoconnect) then
 		return nil