Fix incorrect power transmission of buttons

[MineClone/MineClone2.git] / mods / ITEMS / REDSTONE / mesecons / util.lua

function mesecon.move_node(pos, newpos)
        local node = minetest.get_node(pos)
        local meta = minetest.get_meta(pos):to_table()
        minetest.remove_node(pos)
        minetest.set_node(newpos, node)
        minetest.get_meta(pos):from_table(meta)
end

--Rules rotation Functions:
function mesecon.rotate_rules_right(rules)
        local nr = {}
        for i, rule in ipairs(rules) do
                table.insert(nr, {
                        x = -rule.z,
                        y =  rule.y,
                        z =  rule.x,
                        name = rule.name,
                        spread = rule.spread,})
        end
        return nr
end

function mesecon.rotate_rules_left(rules)
        local nr = {}
        for i, rule in ipairs(rules) do
                table.insert(nr, {
                        x =  rule.z,
                        y =  rule.y,
                        z = -rule.x,
                        name = rule.name,
                        spread = rule.spread,})
        end
        return nr
end

function mesecon.rotate_rules_down(rules)
        local nr = {}
        for i, rule in ipairs(rules) do
                table.insert(nr, {
                        x = -rule.y,
                        y =  rule.x,
                        z =  rule.z,
                        name = rule.name,
                        spread = rule.spread,})
        end
        return nr
end

function mesecon.rotate_rules_up(rules)
        local nr = {}
        for i, rule in ipairs(rules) do
                table.insert(nr, {
                        x =  rule.y,
                        y = -rule.x,
                        z =  rule.z,
                        name = rule.name,
                        spread = rule.spread,})
        end
        return nr
end

function mesecon.flattenrules(allrules)
--[[
        {
                {
                        {xyz},
                        {xyz},
                },
                {
                        {xyz},
                        {xyz},
                },
        }
--]]
        if allrules[1] and
           allrules[1].x then
                return allrules
        end

        local shallowrules = {}
        for _, metarule in ipairs( allrules) do
        for _,     rule in ipairs(metarule ) do
                table.insert(shallowrules, rule)
        end
        end
        return shallowrules
--[[
        {
                {xyz},
                {xyz},
                {xyz},
                {xyz},
        }
--]]
end

function mesecon.rule2bit(findrule, allrules)
        --get the bit of the metarule the rule is in, or bit 1
        if (allrules[1] and
            allrules[1].x) or
            not findrule then
                return 1
        end
        for m,metarule in ipairs( allrules) do
        for _,    rule in ipairs(metarule ) do
                if vector.equals(findrule, rule) then
                        return m
                end
        end
        end
end

function mesecon.rule2metaindex(findrule, allrules)
        --get the metarule the rule is in, or allrules
        if allrules[1].x then
                return nil
        end

        if not(findrule) then
                return mesecon.flattenrules(allrules)
        end

        for m, metarule in ipairs( allrules) do
        for _,     rule in ipairs(metarule ) do
                if vector.equals(findrule, rule) then
                        return m
                end
        end
        end
end

function mesecon.rule2meta(findrule, allrules)
        if #allrules == 0 then return {} end

        local index = mesecon.rule2metaindex(findrule, allrules)
        if index == nil then
                if allrules[1].x then
                        return allrules
                else
                        return {}
                end
        end
        return allrules[index]
end

-- Returns the 6 immediate neighbors of pos
-- (nodes which touch the sides of pos).
-- NOT PART OF ORIGINAL MESECONS!
function mesecon.mcl_get_neighbors(pos)
        local r = {
                { x= 0, y= 0, z=-1 },
                { x= 0, y= 0, z= 1 },
                { x= 0, y=-1, z= 0 },
                { x= 0, y= 1, z= 0 },
                { x=-1, y= 0, z= 0 },
                { x= 1, y= 0, z= 0 },
        }
        local e = {}
        for i=1, #r do
                table.insert(e, { pos = vector.add(pos, r[i]), link = r[i] })
        end
        return e
end

function mesecon.dec2bin(n)
        local x, y = math.floor(n / 2), n % 2
        if (n > 1) then
                return mesecon.dec2bin(x)..y
        else
                return ""..y
        end
end

function mesecon.getstate(nodename, states)
        for state, name in ipairs(states) do
                if name == nodename then
                        return state
                end
        end
        error(nodename.." doesn't mention itself in "..dump(states))
end

function mesecon.getbinstate(nodename, states)
        return mesecon.dec2bin(mesecon.getstate(nodename, states)-1)
end

function mesecon.get_bit(binary,bit)
        bit = bit or 1
        local c = binary:len()-(bit-1)
        return binary:sub(c,c) == "1"
end

function mesecon.set_bit(binary,bit,value)
        if value == "1" then
                if not mesecon.get_bit(binary,bit) then
                        return mesecon.dec2bin(tonumber(binary,2)+math.pow(2,bit-1))
                end
        elseif value == "0" then
                if mesecon.get_bit(binary,bit) then
                        return mesecon.dec2bin(tonumber(binary,2)-math.pow(2,bit-1))
                end
        end
        return binary

end

function mesecon.invertRule(r)
        return vector.multiply(r, -1)
end

function mesecon.tablecopy(table) -- deep table copy
        if type(table) ~= "table" then return table end -- no need to copy
        local newtable = {}

        for idx, item in pairs(table) do
                if type(item) == "table" then
                        newtable[idx] = mesecon.tablecopy(item)
                else
                        newtable[idx] = item
                end
        end

        return newtable
end

function mesecon.cmpAny(t1, t2)
        if type(t1) ~= type(t2) then return false end
        if type(t1) ~= "table" and type(t2) ~= "table" then return t1 == t2 end

        for i, e in pairs(t1) do
                if not mesecon.cmpAny(e, t2[i]) then return false end
        end

        return true
end

-- does not overwrite values; number keys (ipairs) are appended, not overwritten
function mesecon.mergetable(source, dest)
        local rval = mesecon.tablecopy(dest)

        for k, v in pairs(source) do
                rval[k] = dest[k] or mesecon.tablecopy(v)
        end
        for i, v in ipairs(source) do
                table.insert(rval, mesecon.tablecopy(v))
        end

        return rval
end

function mesecon.register_node(name, spec_common, spec_off, spec_on)
        spec_common.drop = spec_common.drop or name .. "_off"
        spec_common.__mesecon_basename = name
        spec_on.__mesecon_state = "on"
        spec_off.__mesecon_state = "off"

        spec_on = mesecon.mergetable(spec_common, spec_on);
        spec_off = mesecon.mergetable(spec_common, spec_off);

        minetest.register_node(name .. "_on", spec_on)
        minetest.register_node(name .. "_off", spec_off)
end

-- swap onstate and offstate nodes, returns new state
function mesecon.flipstate(pos, node)
        local nodedef = minetest.registered_nodes[node.name]
        local newstate
        if (nodedef.__mesecon_state == "on") then newstate = "off" end
        if (nodedef.__mesecon_state == "off") then newstate = "on" end

        minetest.swap_node(pos, {name = nodedef.__mesecon_basename .. "_" .. newstate,
                param2 = node.param2})

        return newstate
end

-- File writing / reading utilities
local wpath = minetest.get_worldpath()
function mesecon.file2table(filename)
        local f = io.open(wpath..DIR_DELIM..filename, "r")
        if f == nil then return {} end
        local t = f:read("*all")
        f:close()
        if t == "" or t == nil then return {} end
        return minetest.deserialize(t)
end

function mesecon.table2file(filename, table)
        local f = io.open(wpath..DIR_DELIM..filename, "w")
        f:write(minetest.serialize(table))
        f:close()
end

-- Block position "hashing" (convert to integer) functions for voxelmanip cache
local BLOCKSIZE = 16

-- convert node position --> block hash
local function hash_blockpos(pos)
        return minetest.hash_node_position({
                x = math.floor(pos.x/BLOCKSIZE),
                y = math.floor(pos.y/BLOCKSIZE),
                z = math.floor(pos.z/BLOCKSIZE)
        })
end

-- Maps from a hashed mapblock position (as returned by hash_blockpos) to a
-- table.
--
-- Contents of the table are:
-- “vm” → the VoxelManipulator
-- “va” → the VoxelArea
-- “data” → the data array
-- “param1” → the param1 array
-- “param2” → the param2 array
-- “dirty” → true if data has been modified
--
-- Nil if no VM-based transaction is in progress.
local vm_cache = nil

-- Starts a VoxelManipulator-based transaction.
--
-- During a VM transaction, calls to vm_get_node and vm_swap_node operate on a
-- cached copy of the world loaded via VoxelManipulators. That cache can later
-- be committed to the real map by means of vm_commit or discarded by means of
-- vm_abort.
function mesecon.vm_begin()
        vm_cache = {}
end

-- Finishes a VoxelManipulator-based transaction, freeing the VMs and map data
-- and writing back any modified areas.
function mesecon.vm_commit()
        for hash, tbl in pairs(vm_cache) do
                if tbl.dirty then
                        local vm = tbl.vm
                        vm:set_data(tbl.data)
                        vm:write_to_map()
                        vm:update_map()
                end
        end
        vm_cache = nil
end

-- Finishes a VoxelManipulator-based transaction, freeing the VMs and throwing
-- away any modified areas.
function mesecon.vm_abort()
        vm_cache = nil
end

-- Gets the cache entry covering a position, populating it if necessary.
local function vm_get_or_create_entry(pos)
        local hash = hash_blockpos(pos)
        local tbl = vm_cache[hash]
        if not tbl then
                local vm = minetest.get_voxel_manip(pos, pos)
                local min_pos, max_pos = vm:get_emerged_area()
                local va = VoxelArea:new{MinEdge = min_pos, MaxEdge = max_pos}
                tbl = {vm = vm, va = va, data = vm:get_data(), param1 = vm:get_light_data(), param2 = vm:get_param2_data(), dirty = false}
                vm_cache[hash] = tbl
        end
        return tbl
end

-- Gets the node at a given position during a VoxelManipulator-based
-- transaction.
function mesecon.vm_get_node(pos)
        local tbl = vm_get_or_create_entry(pos)
        local index = tbl.va:indexp(pos)
        local node_value = tbl.data[index]
        if node_value == core.CONTENT_IGNORE then
                return nil
        else
                local node_param1 = tbl.param1[index]
                local node_param2 = tbl.param2[index]
                return {name = minetest.get_name_from_content_id(node_value), param1 = node_param1, param2 = node_param2}
        end
end

-- Sets a node’s name during a VoxelManipulator-based transaction.
--
-- Existing param1, param2, and metadata are left alone.
function mesecon.vm_swap_node(pos, name)
        local tbl = vm_get_or_create_entry(pos)
        local index = tbl.va:indexp(pos)
        tbl.data[index] = minetest.get_content_id(name)
        tbl.dirty = true
end

-- Gets the node at a given position, regardless of whether it is loaded or
-- not, respecting a transaction if one is in progress.
--
-- Outside a VM transaction, if the mapblock is not loaded, it is pulled into
-- the server’s main map data cache and then accessed from there.
--
-- Inside a VM transaction, the transaction’s VM cache is used.
function mesecon.get_node_force(pos)
        if vm_cache then
                return mesecon.vm_get_node(pos)
        else
                local node = minetest.get_node_or_nil(pos)
                if node == nil then
                        -- Node is not currently loaded; use a VoxelManipulator to prime
                        -- the mapblock cache and try again.
                        minetest.get_voxel_manip(pos, pos)
                        node = minetest.get_node_or_nil(pos)
                end
                return node
        end
end

-- Swaps the node at a given position, regardless of whether it is loaded or
-- not, respecting a transaction if one is in progress.
--
-- Outside a VM transaction, if the mapblock is not loaded, it is pulled into
-- the server’s main map data cache and then accessed from there.
--
-- Inside a VM transaction, the transaction’s VM cache is used.
--
-- This function can only be used to change the node’s name, not its parameters
-- or metadata.
function mesecon.swap_node_force(pos, name)
        if vm_cache then
                return mesecon.vm_swap_node(pos, name)
        else
                -- This serves to both ensure the mapblock is loaded and also hand us
                -- the old node table so we can preserve param2.
                local node = mesecon.get_node_force(pos)
                node.name = name
                minetest.swap_node(pos, node)
        end
end

-- Autoconnect Hooks
-- Nodes like conductors may change their appearance and their connection rules
-- right after being placed or after being dug, e.g. the default wires use this
-- to automatically connect to linking nodes after placement.
-- After placement, the update function will be executed immediately so that the
-- possibly changed rules can be taken into account when recalculating the circuit.
-- After digging, the update function will be queued and executed after
-- recalculating the circuit. The update function must take care of updating the
-- node at the given position itself, but also all of the other nodes the given
-- position may have (had) a linking connection to.
mesecon.autoconnect_hooks = {}

-- name: A unique name for the hook, e.g. "foowire". Used to name the actionqueue function.
-- fct: The update function with parameters function(pos, node)
function mesecon.register_autoconnect_hook(name, fct)
        mesecon.autoconnect_hooks[name] = fct
        mesecon.queue:add_function("autoconnect_hook_"..name, fct)
end

function mesecon.execute_autoconnect_hooks_now(pos, node)
        for _, fct in pairs(mesecon.autoconnect_hooks) do
                fct(pos, node)
        end
end

function mesecon.execute_autoconnect_hooks_queue(pos, node)
        for name in pairs(mesecon.autoconnect_hooks) do
                mesecon.queue:add_action(pos, "autoconnect_hook_"..name, {node})
        end
end