implement new autochop

docs/plugins/autochop.rst

@@ -13,8 +13,7 @@ close to your walls, giving invaders an unexpected path into your fort.
 Autochop checks your stock of logs and designates appropriate trees for chopping
 once every in-game day. Logs that are forbidden or inaccessible (e.g. in hidden
 parts of the map, under water, etc.) are not counted towards your target. Trees
-that are inaccessible are likewise never designated. Tree cutting quota
-agreements that you have made are respected (by default).
+that are inaccessible are likewise never designated.
 
 Please see `gui/autochop` for the interactive configuration dialog.
 
@@ -27,28 +26,39 @@ Usage
     autochop [status]
     autochop (designate|undesignate)
     autochop target <max> [<min>]
-    autochop quota (abide|ignore)
-    autochop restrict (set|add|remove) <burrow>[,<burrow>...]
-    autochop clearcut (set|add|remove) <burrow>[,<burrow>...]
-    autochop (protect|unprotect) <type>[,<type>...]
+    autochop (chop|nochop) <burrow>[,<burrow>...]
+    autochop (clearcut|noclearcut) <burrow>[,<burrow>...]
+    autochop (protect|unprotect) <type>[,<type>...] <burrow>[,<burrow>...]
 
 Examples
 --------
 
-Ensure we always have about 500 logs in stock, harvested from anywhere on the
-map. Also ensure the caravan pathway and the area around the outer wall is
-always clear (requires existence of appropriately-named burrows)::
+Ensure we always have about 200 logs in stock, harvested from accessible trees
+anywhere on the map::
 
+    enable autochop
+
+Ensure we always have about 500 logs in stock, harvested from a burrow named
+"TreeFarm". Also ensure the caravan pathway and the area around the outer wall
+("CaravanPath" and "OuterWall") are always clear::
+
+    enable autochop
     autochop target 500
+    autochop chop TreeFarm
     autochop clearcut CaravanPath,OuterWall
-    enable autochop
+
+Clear all non-food-producing trees out of a burrow ("PicnicArea") intended to
+contain only food-producing trees::
+
+    autochop clearcut PicnicArea
+    autochop protect brewable,edible,cookable PicnicArea
+    autochop designate
 
 Commands
 --------
 
 ``status``
-    Show current configuration and statistics, including tree cutting quota
-    agreement status.
+    Show current configuration and relevant statistics.
 
 ``designate``
     Designate trees for chopping right now according to the current
@@ -62,19 +72,15 @@ Commands
     minimum amount is not specified, it defaults to 20% less than the maximum.
     The default target is ``200`` (with a corresponding minimum of ``160``).
 
-``quota (abide|ignore)``
-    Choose whether to abide by or ignore tree cutting quota agreements that you
-    may have signed with friendly elven civilizations. By default, ``autochop``
-    will abide by any agreements you have made.
-
-``restrict (set|add|remove) <burrow>[,<burrow>...]``
+``(no)chop <burrow>[,<burrow>...]``
     Instead of choosing trees across the whole game map, restrict tree cutting
     to the given burrows. Burrows can be specified by name or internal ID.
 
-``clearcut (set|add|remove) <burrow>[,<burrow>...]``
+``(no)clearcut <burrow>[,<burrow>...]``
     Ensure the given burrows are always clear of trees. As soon as a tree
-    appears in any of these burrows, it is designated for chopping.
+    appears in any of these burrows, it is designated for chopping at priority
+    2.
 
-``protect <type>[,<type>...]``, ``unprotect <type>[,<type>...]``
+``(un)protect <type>[,<type>...] <burrow>[,<burrow>...]``
     Choose whether to exclude trees from chopping that produce any of the given
     types of food. Valid types are: ``brewable``, ``edible``, and ``cookable``.

plugins/CMakeLists.txt

@@ -81,7 +81,7 @@ set_source_files_properties( Brushes.h PROPERTIES HEADER_FILE_ONLY TRUE )
 #dfhack_plugin(3dveins 3dveins.cpp)
 #dfhack_plugin(add-spatter add-spatter.cpp)
 dfhack_plugin(autobutcher autobutcher.cpp LINK_LIBRARIES lua)
-#dfhack_plugin(autochop autochop.cpp)
+dfhack_plugin(autochop autochop.cpp LINK_LIBRARIES lua)
 #dfhack_plugin(autoclothing autoclothing.cpp)
 #dfhack_plugin(autodump autodump.cpp)
 #dfhack_plugin(autofarm autofarm.cpp)

plugins/lua/autochop.lua

@@ -0,0 +1,111 @@
+local _ENV = mkmodule('plugins.autochop')
+
+local argparse = require('argparse')
+
+local function process_args(opts, args)
+    if args[1] == 'help' then
+        opts.help = true
+        return
+    end
+
+    return argparse.processArgsGetopt(args, {
+            {'h', 'help', handler=function() opts.help = true end},
+        })
+end
+
+function setTargets(max, min)
+    max = tonumber(max)
+    max = max and math.floor(max) or nil
+    if not max or max < 0 then
+        qerror('target maximum must be a non-negative integer')
+    end
+
+    min = tonumber(min)
+    min = min and math.floor(min) or nil
+    if min and (min < 0 or min > max) then
+        qerror('target minimum must be between 0 and the maximum, inclusive')
+    end
+    if not min then
+        min = math.floor(max * 0.8)
+    end
+    autochop_setTargets(max, min)
+end
+
+local function do_set_burrow_config(var_name, val, burrows)
+    for _,bspec in ipairs(argparse.stringList(burrows)) do
+        local config = autochop_getBurrowConfig(bspec)
+        config[var_name] = val
+        autochop_setBurrowConfig(config.id, config.chop, config.clearcut,
+                config.protect_brewable, config.protect_edible,
+                config.protect_cookable)
+    end
+end
+
+local function do_set_burrow_protect_config(types, val, burrows)
+    for _,tname in ipairs(argparse.stringList(types)) do
+        do_set_burrow_config('protect_'..tname, val, burrows)
+    end
+end
+
+function parse_commandline(...)
+    local args, opts = {...}, {}
+    local positionals = process_args(opts, args)
+
+    if opts.help then
+        return false
+    end
+
+    local command = positionals[1]
+    if not command or command == 'status' then
+        autochop_printStatus()
+    elseif command == 'designate' then
+        autochop_designate()
+    elseif command == 'undesignate' then
+        autochop_undesignate()
+    elseif command == 'target' then
+        setTarget(args[2], args[3])
+    elseif command == 'chop' then
+        do_set_burrow_config('chop', true, args[2])
+    elseif command == 'nochop' then
+        do_set_burrow_config('chop', false, args[2])
+    elseif command == 'clearcut' or command == 'clear' then
+        do_set_burrow_config('clearcut', true, args[2])
+    elseif command == 'noclearcut' or command == 'noclear' then
+        do_set_burrow_config('clearcut', false, args[2])
+    elseif command == 'protect' then
+        do_set_burrow_protect_config(args[2], true, args[3])
+    elseif command == 'unprotect' or command == 'noprotect' then
+        do_set_burrow_protect_config(args[2], false, args[3])
+    else
+        return false
+    end
+
+    return true
+end
+
+-- used by gui/autochop
+function setBurrowConfig(config)
+    autochop_setBurrowConfig(config.id, config.chop, config.clearcut,
+            config.protect_brewable, config.protect_edible,
+            config.protect_cookable)
+end
+
+function getTreeCountsAndBurrowConfigs()
+    local data = {autochop_getTreeCountsAndBurrowConfigs()}
+    local ret = {}
+    ret.summary = table.remove(data, 1)
+    ret.tree_counts = table.remove(data, 1)
+    ret.designated_tree_counts = table.remove(data, 1)
+    ret.burrow_configs = data
+    for _,c in ipairs(ret.burrow_configs) do
+        c.name = df.burrow.find(c.id).name
+        c.chop = c.chop ~= 0
+        c.clearcut = c.clearcut ~= 0
+        c.protect_brewable = c.protect_brewable ~= 0
+        c.protect_edible = c.protect_edible ~= 0
+        c.protect_cookable = c.protect_cookable ~= 0
+    end
+    return ret
+end
+
+return _ENV