Updated docs to add reference, improved itemscript.

docs/src/.vuepress/config.js

@@ -56,7 +56,8 @@ module.exports = {
           children: [
             '',
             'spec',
-            'settings'
+            'settings',
+            'reference'
           ]
         }
       ]

docs/src/guide/movescript/README.md

@@ -7,7 +7,7 @@ The Movescript module provides a simple interface for executing *movescript sour
 To install this module, run the following command from your turtle's console:
 
 ```shell
-wget https://raw.githubusercontent.com/andrewlalis/movescript/main/src/movescript.lua movescript.lua
+wget https://raw.githubusercontent.com/andrewlalis/movescript/main/min/movescript.lua movescript.lua
 ```
 
 And then use it in a script:

docs/src/guide/movescript/reference.md

@@ -0,0 +1,24 @@
+# Module Reference
+
+The following is a complete reference of the **movescript** module. All symbols defined here belong to the `movescript` module, and can be accessed via an instance of that module. For example:
+
+```lua
+local ms = require("movescript")
+ms.run("2F")
+```
+
+## Functions
+
+### `run(script, settings)`
+
+Runs the given `script` string as a movescript, and optionally a `settings` table can be provided. Otherwise, [default settings](settings.md) will be used.
+
+### `runFile(filename, settings)`
+
+Reads content from the given filename and executes it as a script. Just like with `run`, an optional `settings` table can be provided.
+
+## Variables
+
+### `defaultSettings`
+
+A table containing the default settings for any script executed by the movescript module.

src/itemscript.lua

@@ -12,7 +12,9 @@ local t = turtle
 -- The itemscript module. Functions defined within this table are exported.
 local itemscript = {}
 
-local function itemStackMatches(itemStack, name, fuzzy)
+-- Determines if an item stack matches the given name.
+-- If fuzzy, then the item name will be matched against the given name.
+local function stackMatches(itemStack, name, fuzzy)
     return itemStack ~= nil and
         (
             (not fuzzy and itemStack.name == name) or
@@ -20,14 +22,66 @@ local function itemStackMatches(itemStack, name, fuzzy)
         )
 end
 
+--[[
+The following describes an item filter:
+A table containing a filter mechanism.
+{
+    filterFunction = stackMatches,
+    fuzzy = false,
+    whitelist = true
+}
+The filterFunction is defined like so:
+function filterFunction(item, filter)
+    return true | false
+end
+]]--
+
+local function makeItemFilter(var, fuzzy, whitelist)
+    local filter = {
+        filterFunction = nil,
+        fuzzy = fuzzy or false,
+        whitelist = whitelist
+    }
+    if type(var) == "string" then
+        -- If the filter is a single item name, define a single-item filter that matches against the name.
+        filter.filterFunction = function (item, filter)
+            local matches = stackMatches(item, var, filter.fuzzy)
+            if filter.whitelist then
+                return matches
+            else
+                return not matches
+            end
+        end
+    elseif type(var) == "table" then
+        -- If the filter is a list of item names, define a multi-item filter.
+        filter.filterFunction = function (item, filter)
+            for _, itemName in pairs(var) do
+                if filter.whitelist and stackMatches(item, itemName, filter.fuzzy) then
+                    return true
+                elseif not filter.whitelist and not stackMatches(item, itemName, filter.fuzzy) then
+                    return false
+                end
+            end
+            -- If whitelist and we couldn't find a match, return false.
+            -- If blacklist and we couldn't find a non-match, return true.
+            return not filter.whitelist
+        end
+    elseif type(var) == "function" then
+        -- Otherwise, just use the provided filter.
+        filter.filterFunction = var
+    end
+    filter.apply = function(item)
+        return filter.filterFunction(item, filter)
+    end
+    return filter
+end
+
 -- Gets the total number of items of a certain type in the turtle's inventory.
--- If fuzzy is set as true, then it'll match substrings matching the given name.
+function itemscript.totalCount(filter)
-function itemscript.totalCount(name, fuzzy)
-    fuzzy = fuzzy or false
     local count = 0
     for i = 1, 16 do
         local item = t.getItemDetail(i)
-        if itemStackMatches(item, name, fuzzy) then
+        if filter.apply(item) then
             count = count + item.count
         end
     end
@@ -36,11 +90,10 @@ end
 
 -- Selects a slot containing at least one of the given item type.
 -- Returns a boolean indicating whether we could find and select the item.
-function itemscript.select(name, fuzzy)
+function itemscript.select(filter)
-    fuzzy = fuzzy or false
     for i = 1, 16 do
         local item = t.getItemDetail(i)
-        if itemStackMatches(item, name, fuzzy) then
+        if filter.apply(item) then
             t.select(i)
             return true
         end
@@ -48,43 +101,27 @@ function itemscript.select(name, fuzzy)
     return false
 end
 
-local function itemMatchesFilter(item, name, fuzzy)
+-- Helper function to drop items in a flexible way, using a drop function and filtering function.
-    fuzzy = fuzzy or false
+local function dropFiltered(dropFunction, filter)
-    return (not fuzzy and item.name == name) or string.find(item.name, name)
-end
-
-local function itemNotMatchesFilter(item, name, fuzzy)
-    return not itemMatchesFilter(item, name, fuzzy)
-end
-
-local function dropFiltered(name, fuzzy, dropFunction, filterFunction)
     for i = 1, 16 do
         local item = t.getItemDetail(i)
-        if filterFunction(item, name, fuzzy) then
+        if filter.apply(item) then
             t.select(i)
             dropFunction()
         end
     end
 end
 
-function itemscript.dropAll(name, fuzzy)
+function itemscript.dropAll(filter)
-    dropFiltered(name, fuzzy or false, t.drop, itemMatchesFilter)
+    dropFiltered(t.drop, filter)
 end
 
-function itemscript.dropAllDown(name, fuzzy)
+function itemscript.dropAllDown(filter)
-    dropFiltered(name, fuzzy or false, t.dropDown, itemMatchesFilter)
+    dropFiltered(t.dropDown, filter)
 end
 
-function itemscript.dropAllUp(name, fuzzy)
+function itemscript.dropAllUp(filter)
-    dropFiltered(name, fuzzy or false, t.dropUp, itemMatchesFilter)
+    dropFiltered(t.dropUp, filter)
-end
-
-function itemscript.dropAllExcept(name, fuzzy)
-    dropFiltered(name, fuzzy or false, t.drop, itemNotMatchesFilter)
-end
-
-function itemscript.dropAllDownExcept(name, fuzzy)
-    dropFiltered(name, fuzzy or false, t.dropDown, itemNotMatchesFilter)
 end
 
 -- Cleans up the turtle's inventory by compacting all stacks of items.

src/movescript.lua

@@ -198,4 +198,11 @@ function movescript.run(script, settings)
     end
 end
 
+function movescript.runFile(filename, settings)
+    local f = fs.open(filename, "r")
+    local script = f.readAll()
+    f.close()
+    movescript.run(script, settings)
+end
+
 return movescript