technic_cnc: use programs definition to generate formspec (#647)

This deprecates the variables onesize_products and twosize_products by using a shared definition table.
With these changes, it should be easier to add new programs in the future.

New feature: Tooltips are added to all programs. (only applies to newly placed nodes)

technic_cnc/cnc.lua

@@ -72,64 +72,46 @@ else
 	end
 end
 
-local onesize_products = {
+local function add_buttons(do_variants, t, x, y)
-	slope                    = 2,
+	local X_OFFSET = 1
-	slope_edge               = 1,
+	local BUTTONS_PER_ROW = 7
-	slope_inner_edge         = 1,
+
-	pyramid                  = 2,
+	-- ipairs: only iterate over continuous integers
-	spike                    = 1,
+	for _, data in ipairs(technic_cnc.programs) do
-	cylinder                 = 2,
+		-- Never add full variants. Only add half variants when asked
-	oblate_spheroid          = 1,
+		if not data.half_counterpart and (do_variants == (data.full_counterpart ~= nil)) then
-	sphere                   = 1,
+			--print("add", data.suffix)
-	stick                    = 8,
+			t[#t + 1] = ("image_button[%g,%g;1,1;%s.png;%s; ]"):format(
-	slope_upsdown            = 2,
+				x + X_OFFSET, y, data.suffix, data.short_name
-	slope_edge_upsdown       = 1,
+			)
-	slope_inner_edge_upsdown = 1,
+			t[#t + 1] = ("tooltip[%s;%s]"):format(
-	cylinder_horizontal      = 2,
+				data.short_name, minetest.formspec_escape(data.desc .. " (* " .. data.output .. ")")
-	slope_lying              = 2,
+			)
-	onecurvededge            = 1,
+
-	twocurvededge            = 1,
+			x = x + 1
-}
+			if x == BUTTONS_PER_ROW then
-local twosize_products = {
+				x = 0
-	element_straight         = 2,
+				y = y + 1
-	element_end              = 2,
+			end
-	element_cross            = 1,
+		end
-	element_t                = 1,
+	end
-	element_edge             = 2,
+end
+
+local function make_formspec()
+	local t = {
+		"size[9,11;]",
+		"label[1,0;"..S("Choose Milling Program:").."]",
 	}
+	add_buttons(false, t, 0, 0.5)
 
-local cnc_formspec =
+	t[#t + 1] = (
-	"size[9,11;]"..
-	"label[1,0;"..S("Choose Milling Program:").."]"..
-	"image_button[1,0.5;1,1;technic_cnc_slope.png;slope; ]"..
-	"image_button[2,0.5;1,1;technic_cnc_slope_edge.png;slope_edge; ]"..
-	"image_button[3,0.5;1,1;technic_cnc_slope_inner_edge.png;slope_inner_edge; ]"..
-	"image_button[4,0.5;1,1;technic_cnc_pyramid.png;pyramid; ]"..
-	"image_button[5,0.5;1,1;technic_cnc_spike.png;spike; ]"..
-	"image_button[6,0.5;1,1;technic_cnc_cylinder.png;cylinder; ]"..
-	"image_button[7,0.5;1,1;technic_cnc_oblate_spheroid.png;oblate_spheroid; ]"..
-	"image_button[8,0.5;1,1;technic_cnc_stick.png;stick; ]"..
-
-	"image_button[1,1.5;1,1;technic_cnc_slope_upsdwn.png;slope_upsdown; ]"..
-	"image_button[2,1.5;1,1;technic_cnc_slope_edge_upsdwn.png;slope_edge_upsdown; ]"..
-	"image_button[3,1.5;1,1;technic_cnc_slope_inner_edge_upsdwn.png;slope_inner_edge_upsdown; ]"..
-	"image_button[4,1.5;1,1;technic_cnc_cylinder_horizontal.png;cylinder_horizontal; ]"..
-	"image_button[5,1.5;1,1;technic_cnc_sphere.png;sphere; ]"..
-
-	"image_button[1,2.5;1,1;technic_cnc_slope_lying.png;slope_lying; ]"..
-	"image_button[2,2.5;1,1;technic_cnc_onecurvededge.png;onecurvededge; ]"..
-	"image_button[3,2.5;1,1;technic_cnc_twocurvededge.png;twocurvededge; ]"..
-
 		"label[1,3.5;"..S("Slim Elements half / normal height:").."]"..
-
 		"image_button[1,4;1,0.5;technic_cnc_full.png;full; ]"..
-	"image_button[1,4.5;1,0.5;technic_cnc_half.png;half; ]"..
+		"image_button[1,4.5;1,0.5;technic_cnc_half.png;half; ]"
-	"image_button[2,4;1,1;technic_cnc_element_straight.png;element_straight; ]"..
+	)
-	"image_button[3,4;1,1;technic_cnc_element_end.png;element_end; ]"..
+	add_buttons(true, t, 1, 4)
-	"image_button[4,4;1,1;technic_cnc_element_cross.png;element_cross; ]"..
-	"image_button[5,4;1,1;technic_cnc_element_t.png;element_t; ]"..
-	"image_button[6,4;1,1;technic_cnc_element_edge.png;element_edge; ]"..
 
+	t[#t + 1] = (
 		"label[0, 5;"..S("In:").."]"..
 		"list[current_name;src;0.5,5.5;1,1;]"..
 		"label[4, 5;"..S("Out:").."]"..
@@ -140,6 +122,18 @@ local cnc_formspec =
 		"listring[current_player;main]"..
 		"listring[current_name;src]"..
 		"listring[current_player;main]"
+	)
+
+	return table.concat(t)
+end
+
+local cnc_formspec = nil
+
+minetest.register_on_mods_loaded(function()
+	technic_cnc._populate_shortcuts()
+	cnc_formspec = make_formspec()
+end)
+
 
 -- The form handler is declared here because we need it in both the inactive and active modes
 -- in order to be able to change programs wile it is running.
@@ -168,27 +162,28 @@ local function form_handler(pos, formname, fields, sender)
 
 	for k, _ in pairs(fields) do
 		-- Set a multipier for the half/full size capable blocks
-		local multiplier
+		local program = technic_cnc.programs["technic_cnc_" .. k]
-		if twosize_products[k] ~= nil then
+		if size == 1 and program and program.full_counterpart then
-			multiplier = size * twosize_products[k]
+			program = technic_cnc.programs["technic_cnc_" .. k .. "_double"]
-		else
-			multiplier = onesize_products[k]
 		end
+		if program then
+			local multiplier = program.output
+			local product = inputname .. "_" .. program.suffix
 
-		if onesize_products[k] ~= nil or twosize_products[k] ~= nil then
 			meta:set_float( "cnc_multiplier", multiplier)
 			meta:set_string("cnc_user", sender:get_player_name())
+
+			if program.half_counterpart then -- is full
+				if size == 1 then
+					meta:set_string("cnc_product", product)
+					--print(product, multiplier)
+				end
+				break -- no larger sizes allowed
 			end
 
-		if onesize_products[k] ~= nil or (twosize_products[k] ~= nil and size==2) then
+			-- half for normal
-			meta:set_string("cnc_product",  inputname .. "_technic_cnc_" .. k)
+			meta:set_string("cnc_product", product)
-			--print(inputname .. "_technic_cnc_" .. k)
+			--print(product, multiplier)
-			break
-		end
-
-		if twosize_products[k] ~= nil and size==1 then
-			meta:set_string("cnc_product",  inputname .. "_technic_cnc_" .. k .. "_double")
-			--print(inputname .. "_technic_cnc_" .. k .. "_double")
 			break
 		end
 	end
@@ -236,7 +231,7 @@ local run = function(pos, node)
 		meta:set_int("src_time", meta:get_int("src_time") + 1)
 		if meta:get_int("src_time") >= 3 then -- 3 ticks per output
 			meta:set_int("src_time", 0)
-			srcstack = inv:get_stack("src", 1)
+			local srcstack = inv:get_stack("src", 1)
 			srcstack:take_item()
 			inv:set_stack("src", 1, srcstack)
 			inv:add_item("dst", result.." "..meta:get_int("cnc_multiplier"))

technic_cnc/cnc_api.lua

@@ -8,16 +8,27 @@ local ALPHA_CLIP = minetest.features.use_texture_alpha_string_modes and "clip" o
 ------------------------------------------------------
 
 -- Define slope boxes for the various nodes
+--[[
+Additional keys after registration:
+	programs[program.suffix] = program
+
+Additional fields after registration:
+	program.short_name = (trimmed suffix)
+	program.full_counterpart = suffix (optional, for full/half variants)
+	program.half_counterpart = suffix (optional, for full/half variants)
+]]
 -------------------------------------------
 technic_cnc.programs = {
 	{ suffix  = "technic_cnc_stick",
 		model = {-0.15, -0.5, -0.15, 0.15, 0.5, 0.15},
-		desc  = S("Stick")
+		desc  = S("Stick"),
+		output = 8
 	},
 
 	{ suffix  = "technic_cnc_element_end_double",
 		model = {-0.3, -0.5, -0.3, 0.3, 0.5, 0.5},
-		desc  = S("Element End Double")
+		desc  = S("Element End Double"),
+		output = 2
 	},
 
 	{ suffix  = "technic_cnc_element_cross_double",
@@ -25,7 +36,8 @@ technic_cnc.programs = {
 			{0.3, -0.5, -0.3, 0.5, 0.5, 0.3},
 			{-0.3, -0.5, -0.5, 0.3, 0.5, 0.5},
 			{-0.5, -0.5, -0.3, -0.3, 0.5, 0.3}},
-		desc  = S("Element Cross Double")
+		desc  = S("Element Cross Double"),
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_element_t_double",
@@ -33,24 +45,28 @@ technic_cnc.programs = {
 			{-0.3, -0.5, -0.5, 0.3, 0.5, 0.3},
 			{-0.5, -0.5, -0.3, -0.3, 0.5, 0.3},
 			{0.3, -0.5, -0.3, 0.5, 0.5, 0.3}},
-		desc  = S("Element T Double")
+		desc  = S("Element T Double"),
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_element_edge_double",
 		model = {
 			{-0.3, -0.5, -0.5, 0.3, 0.5, 0.3},
 			{-0.5, -0.5, -0.3, -0.3, 0.5, 0.3}},
-		desc  = S("Element Edge Double")
+		desc  = S("Element Edge Double"),
+		output = 2
 	},
 
 	{ suffix  = "technic_cnc_element_straight_double",
 		model = {-0.3, -0.5, -0.5, 0.3, 0.5, 0.5},
-		desc  = S("Element Straight Double")
+		desc  = S("Element Straight Double"),
+		output = 2
 	},
 
 	{ suffix  = "technic_cnc_element_end",
 		model = {-0.3, -0.5, -0.3, 0.3, 0, 0.5},
-		desc  = S("Element End")
+		desc  = S("Element End"),
+		output = nil -- calculated
 	},
 
 	{ suffix  = "technic_cnc_element_cross",
@@ -58,7 +74,8 @@ technic_cnc.programs = {
 			{0.3, -0.5, -0.3, 0.5, 0, 0.3},
 			{-0.3, -0.5, -0.5, 0.3, 0, 0.5},
 			{-0.5, -0.5, -0.3, -0.3, 0, 0.3}},
-		desc  = S("Element Cross")
+		desc  = S("Element Cross"),
+		output = nil -- calculated
 	},
 
 	{ suffix  = "technic_cnc_element_t",
@@ -66,19 +83,22 @@ technic_cnc.programs = {
 			{-0.3, -0.5, -0.5, 0.3, 0, 0.3},
 			{-0.5, -0.5, -0.3, -0.3, 0, 0.3},
 			{0.3, -0.5, -0.3, 0.5, 0, 0.3}},
-		desc  = S("Element T")
+		desc  = S("Element T"),
+		output = nil -- calculated
 	},
 
 	{ suffix  = "technic_cnc_element_edge",
 		model = {
 			{-0.3, -0.5, -0.5, 0.3, 0, 0.3},
 			{-0.5, -0.5, -0.3, -0.3, 0, 0.3}},
-		desc  = S("Element Edge")
+		desc  = S("Element Edge"),
+		output = nil -- calculated
 	},
 
 	{ suffix  = "technic_cnc_element_straight",
 		model = {-0.3, -0.5, -0.5, 0.3, 0, 0.5},
-		desc  = S("Element Straight")
+		desc  = S("Element Straight"),
+		output = nil -- calculated
 	},
 
 	{ suffix  = "technic_cnc_oblate_spheroid",
@@ -91,32 +111,38 @@ technic_cnc.programs = {
 				{ -8/16, -4/16, -8/16, 8/16,  4/16, 8/16 },
 				{ -6/16, -8/16, -6/16, 6/16, -4/16, 6/16 }
 			}
-		}
+		},
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_sphere",
 		model = "technic_cnc_sphere.obj",
-		desc  = S("Sphere")
+		desc  = S("Sphere"),
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_cylinder_horizontal",
 		model = "technic_cnc_cylinder_horizontal.obj",
-		desc  = S("Horizontal Cylinder")
+		desc  = S("Horizontal Cylinder"),
+		output = 2
 	},
 
 	{ suffix  = "technic_cnc_cylinder",
 		model = "technic_cnc_cylinder.obj",
-		desc  = S("Cylinder")
+		desc  = S("Cylinder"),
+		output = 2
 	},
 
 	{ suffix  = "technic_cnc_twocurvededge",
 		model = "technic_cnc_two_curved_edge.obj",
-		desc  = S("Two Curved Edge/Corner Block")
+		desc  = S("Two Curved Edge/Corner Block"),
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_onecurvededge",
 		model = "technic_cnc_one_curved_edge.obj",
-		desc  = S("One Curved Edge Block")
+		desc  = S("One Curved Edge Block"),
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_spike",
@@ -130,7 +156,8 @@ technic_cnc.programs = {
 				{ -6/16, -4/16, -6/16, 6/16,     0, 6/16 },
 				{ -8/16, -8/16, -8/16, 8/16, -4/16, 8/16 }
 			}
-		}
+		},
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_pyramid",
@@ -144,7 +171,8 @@ technic_cnc.programs = {
 				{ -6/16, -6/16, -6/16, 6/16, -4/16, 6/16 },
 				{ -8/16, -8/16, -8/16, 8/16, -6/16, 8/16 }
 			}
-		}
+		},
+		output = 2
 	},
 
 	{ suffix  = "technic_cnc_slope_inner_edge_upsdown",
@@ -165,7 +193,8 @@ technic_cnc.programs = {
 				{ -0.5,   0.25, -0.25, 0.5,  0,     0.5  },
 				{ -0.5,   0.5,  -0.5,  0.5,  0.25,  0.5  }
 			}
-		}
+		},
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_slope_edge_upsdown",
@@ -179,7 +208,8 @@ technic_cnc.programs = {
 				{     0,     0,     0, 8/16, -4/16, 8/16 },
 				{  4/16, -4/16,  4/16, 8/16, -8/16, 8/16 }
 			}
-		}
+		},
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_slope_inner_edge",
@@ -200,7 +230,8 @@ technic_cnc.programs = {
 				{ -0.5,   0.25,  0.25, 0.5,  0.5,   0.5  },
 				{  0.25,  0.25, -0.5,  0.5,  0.5,   0.5  }
 			}
-		}
+		},
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_slope_edge",
@@ -214,7 +245,8 @@ technic_cnc.programs = {
 				{ -4/16, -4/16, -4/16, 8/16,     0, 8/16 },
 				{ -8/16, -8/16, -8/16, 8/16, -4/16, 8/16 }
 			}
-		}
+		},
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_slope_upsdown",
@@ -228,7 +260,8 @@ technic_cnc.programs = {
 				{ -8/16,     0,     0, 8/16, -4/16, 8/16 },
 				{ -8/16, -4/16,  4/16, 8/16, -8/16, 8/16 }
 			}
-		}
+		},
+		output = 1
 	},
 
 	{ suffix  = "technic_cnc_slope_lying",
@@ -242,7 +275,8 @@ technic_cnc.programs = {
 				{ -4/16, -8/16, -4/16,     0, 8/16, 8/16 },
 				{ -8/16, -8/16, -8/16, -4/16, 8/16, 8/16 }
 			}
-		}
+		},
+		output = 2
 	},
 
 	{ suffix  = "technic_cnc_slope",
@@ -256,11 +290,40 @@ technic_cnc.programs = {
 				{ -8/16, -4/16, -4/16, 8/16,     0, 8/16 },
 				{ -8/16, -8/16, -8/16, 8/16, -4/16, 8/16 }
 			}
-		}
+		},
+		output = 2
 	},
 
 }
 
+technic_cnc._populate_shortcuts = function()
+	-- Program quick access by string key
+	for _, data in ipairs(technic_cnc.programs) do
+		technic_cnc.programs[data.suffix] = data
+		data.short_name = assert(data.suffix:match("technic_cnc_(%S+)"))
+	end
+
+	-- Detect half/full counterparts
+	for k, data in pairs(technic_cnc.programs) do
+		if type(k) == "string" then
+			local full = technic_cnc.programs[k .. "_double"]
+			if full then
+				full.half_counterpart = k
+				data.full_counterpart = k .. "_double"
+				data.output = full.output * 2
+
+				--print("populate", k)
+			end
+		end
+	end
+
+	-- Final checks
+	for _, data in ipairs(technic_cnc.programs) do
+		assert(type(data.output) == "number", data.suffix)
+		assert(type(data.short_name) == "string", data.suffix)
+	end
+end
+
 -- Allow disabling certain programs for some node. Default is allowing all types for all nodes
 technic_cnc.programs_disable = {
 	-- ["default:brick"] = {"technic_cnc_stick"}, -- Example: Disallow the stick for brick
@@ -327,44 +390,3 @@ function technic_cnc.register_all(recipeitem, groups, images, description)
 	end
 end
 
--- REGISTER NEW TECHNIC_CNC_API's PART 2: technic_cnc..register_element_end(subname, recipeitem, groups, images, desc_element_xyz)
------------------------------------------------------------------------------------------------------------------------
-function technic_cnc.register_slope_edge_etc(recipeitem, groups, images, desc_slope, desc_slope_lying, desc_slope_upsdown, desc_slope_edge, desc_slope_inner_edge, desc_slope_upsdwn_edge, desc_slope_upsdwn_inner_edge, desc_pyramid, desc_spike, desc_onecurvededge, desc_twocurvededge, desc_cylinder, desc_cylinder_horizontal, desc_spheroid, desc_element_straight, desc_element_edge, desc_element_t, desc_element_cross, desc_element_end)
-		-- TODO: Remove this evil sorcery
-         technic_cnc.register_slope(recipeitem, groups, images, desc_slope)
-         technic_cnc.register_slope_lying(recipeitem, groups, images, desc_slope_lying)
-         technic_cnc.register_slope_upsdown(recipeitem, groups, images, desc_slope_upsdown)
-         technic_cnc.register_slope_edge(recipeitem, groups, images, desc_slope_edge)
-         technic_cnc.register_slope_inner_edge(recipeitem, groups, images, desc_slope_inner_edge)
-         technic_cnc.register_slope_edge_upsdown(recipeitem, groups, images, desc_slope_upsdwn_edge)
-         technic_cnc.register_slope_inner_edge_upsdown(recipeitem, groups, images, desc_slope_upsdwn_inner_edge)
-         technic_cnc.register_pyramid(recipeitem, groups, images, desc_pyramid)
-         technic_cnc.register_spike(recipeitem, groups, images, desc_spike)
-         technic_cnc.register_onecurvededge(recipeitem, groups, images, desc_onecurvededge)
-         technic_cnc.register_twocurvededge(recipeitem, groups, images, desc_twocurvededge)
-         technic_cnc.register_cylinder(recipeitem, groups, images, desc_cylinder)
-         technic_cnc.register_cylinder_horizontal(recipeitem, groups, images, desc_cylinder_horizontal)
-         technic_cnc.register_spheroid(recipeitem, groups, images, desc_spheroid)
-         technic_cnc.register_element_straight(recipeitem, groups, images, desc_element_straight)
-         technic_cnc.register_element_edge(recipeitem, groups, images, desc_element_edge)
-         technic_cnc.register_element_t(recipeitem, groups, images, desc_element_t)
-         technic_cnc.register_element_cross(recipeitem, groups, images, desc_element_cross)
-         technic_cnc.register_element_end(recipeitem, groups, images, desc_element_end)
-end
-
--- REGISTER STICKS: noncubic.register_xyz(recipeitem, groups, images, desc_element_xyz)
-------------------------------------------------------------------------------------------------------------
-function technic_cnc.register_stick_etc(recipeitem, groups, images, desc_stick)
-		-- TODO: Remove this evil sorcery
-         technic_cnc.register_stick(recipeitem, groups, images, desc_stick)
-end
-
-function technic_cnc.register_elements(recipeitem, groups, images, desc_element_straight_double, desc_element_edge_double, desc_element_t_double, desc_element_cross_double, desc_element_end_double)
-		-- TODO: Remove this evil sorcery
-         technic_cnc.register_element_straight_double(recipeitem, groups, images, desc_element_straight_double)
-         technic_cnc.register_element_edge_double(recipeitem, groups, images, desc_element_edge_double)
-         technic_cnc.register_element_t_double(recipeitem, groups, images, desc_element_t_double)
-         technic_cnc.register_element_cross_double(recipeitem, groups, images, desc_element_cross_double)
-         technic_cnc.register_element_end_double(recipeitem, groups, images, desc_element_end_double)
-end
-