Merge branch 'develop' into filesystem-module-pr

Author: lethosor

NEWS

@@ -4,6 +4,7 @@ DFHack future
     - support for calling a lua function via a protobuf request (demonstrated by dfhack-run --lua).
     - Lua API for listing files in directory. Needed for mod-manager.
     - Lua API for creating unit combat reports and writing to gamelog.
+    - Lua API for running arbitrary DFHack commands
     - support for multiple raw/init.d/*.lua init scripts in one save.
     - eventful now has a more friendly way of making custom sidebars
     - new plugin: building-hacks. Allows to add custom functionality and/or animations to buildings. 
@@ -26,10 +27,12 @@ DFHack future
   New tweaks:
     - craft-age-wear: make crafted items wear out with time like in old versions (bug 6003)
     - adamantine-cloth-wear: stop adamantine clothing from wearing out (bug 6481)
+    - confirm-embark: adds a prompt before embarking (on the "prepare carefully" screen)
 
   New plugins:
     - rendermax: replace the renderer with something else. Most interesting is "rendermax light"- a lighting engine for df.
     - stockflow (by eswald): queues manager jobs of the configured type based on the state of a stockpile.
+    - embark-tools: implementations of Embark Anywhere, Nano Embark, and a few other embark-related utilities
 
   Misc improvements:
     - digfort: improved csv parsing, add start() comment handling

Readme.html

@@ -2053,6 +2053,21 @@ See the bay12 thread for details: http://www.bay12forums.com/smf/index.php?topic
     * Some of the DFusion plugins aren't completely ported yet. This can lead to crashes.
     * The game will be suspended while you're using dfusion. Don't panic when it doesn't respond.
 
+embark-tools
+------------
+A collection of embark-related tools.
+
+Usage::
+
+    embark-tools enable/disable tool [tool]...
+
+Tools:
+
+* ``anywhere``: Allows embarking anywhere (including sites, mountain-only biomes, and oceans). Use with caution.
+* ``nano``: An implementation of nano embark - allows resizing below 2x2 when enabled.
+* ``sand``: Displays an indicator when sand is present in the currently-selected area, similar to the default clay/stone indicators.
+* ``sticky``: Maintains the selected local area while navigating the world map
+
 misery
 ------
 When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).
@@ -2523,15 +2538,19 @@ To activate, open the unit screen and press 'l'.
 
 This tool implements a Dwarf Therapist-like interface within the game UI. The
 far left column displays the unit's Happiness (color-coded based on its
-value), and the right half of the screen displays each dwarf's labor settings
-and skill levels (0-9 for Dabbling thru Professional, A-E for Great thru Grand
-Master, and U-Z for Legendary thru Legendary+5).
+value), Name, Profession/Squad, and the right half of the screen displays each 
+dwarf's labor settings and skill levels (0-9 for Dabbling thru Professional, A-E for 
+Great thru Grand Master, and U-Z for Legendary thru Legendary+5).
 
 Cells with teal backgrounds denote skills not controlled by labors, e.g.
 military and social skills.
 
 .. image:: images/manipulator2.png
 
+Press ``t`` to toggle between Profession and Squad view.
+
+.. image:: images/manipulator3.png
+
 Use the arrow keys or number pad to move the cursor around, holding Shift to
 move 10 tiles at a time.
 
@@ -2543,7 +2562,7 @@ Press Enter to toggle the selected labor for the selected unit, or Shift+Enter
 to toggle all labors within the selected category.
 
 Press the ``+-`` keys to sort the unit list according to the currently selected
-skill/labor, and press the ``*/`` keys to sort the unit list by Name, Profession,
+skill/labor, and press the ``*/`` keys to sort the unit list by Name, Profession/Squad, 
 Happiness, or Arrival order (using Tab to select which sort method to use here).
 
 With a unit selected, you can press the "v" key to view its properties (and
@@ -2553,12 +2572,12 @@ Manipulator and zoom to its position within your fortress.
 The following mouse shortcuts are also available:
 
 * Click on a column header to sort the unit list. Left-click to sort it in one
-  direction (descending for happiness or labors/skills, ascending for name or
-  profession) and right-click to sort it in the opposite direction.
+  direction (descending for happiness or labors/skills, ascending for name,
+  profession or squad) and right-click to sort it in the opposite direction.
 * Left-click on a labor cell to toggle that labor. Right-click to move the
   cursor onto that cell instead of toggling it.
-* Left-click on a unit's name or profession to view its properties.
-* Right-click on a unit's name or profession to zoom to it.
+* Left-click on a unit's name, profession or squad to view its properties.
+* Right-click on a unit's name, profession or squad to zoom to it.
 
 Pressing ESC normally returns to the unit screen, but Shift-ESC would exit
 directly to the main dwarf mode screen.

Readme.rst

@@ -2242,6 +2242,64 @@ static int internal_getDir(lua_State *L)
     }
     return 1;
 }
+
+static int internal_runCommand(lua_State *L)
+{
+    buffered_color_ostream out;
+    command_result res;
+    if (lua_gettop(L) == 0)
+    {
+        lua_pushstring(L, "");
+    }
+    int type_1 = lua_type(L, 1);
+    if (type_1 == LUA_TTABLE)
+    {
+        std::string command = "";
+        std::vector<std::string> args;
+        lua_pushnil(L);   // first key
+        while (lua_next(L, 1) != 0)
+        {
+            if (command == "")
+                command = lua_tostring(L, -1);
+            else
+                args.push_back(lua_tostring(L, -1));
+            lua_pop(L, 1);  // remove value, leave key
+        }
+        CoreSuspender suspend;
+        res = Core::getInstance().runCommand(out, command, args);
+    }
+    else if (type_1 == LUA_TSTRING)
+    {
+        std::string command = lua_tostring(L, 1);
+        CoreSuspender suspend;
+        res = Core::getInstance().runCommand(out, command);
+    }
+    else
+    {
+        lua_pushnil(L);
+        lua_pushfstring(L, "Expected table, got %s", lua_typename(L, type_1));
+        return 2;
+    }
+    auto fragments = out.fragments();
+    lua_newtable(L);
+    lua_pushinteger(L, (int)res);
+    lua_setfield(L, -2, "status");
+    int i = 1;
+    for (auto iter = fragments.begin(); iter != fragments.end(); iter++, i++)
+    {
+        int color = iter->first;
+        std::string output = iter->second;
+        lua_createtable(L, 2, 0);
+        lua_pushinteger(L, color);
+        lua_rawseti(L, -2, 1);
+        lua_pushstring(L, output.c_str());
+        lua_rawseti(L, -2, 2);
+        lua_rawseti(L, -2, i);
+    }
+    lua_pushvalue(L, -1);
+    return 1;
+}
+
 static const luaL_Reg dfhack_internal_funcs[] = {
     { "getAddress", internal_getAddress },
     { "setAddress", internal_setAddress },
@@ -2255,6 +2313,7 @@ static const luaL_Reg dfhack_internal_funcs[] = {
     { "memscan", internal_memscan },
     { "diffscan", internal_diffscan },
     { "getDir", internal_getDir },
+    { "runCommand", internal_runCommand },
     { NULL, NULL }
 };
 

images/manipulator.png

@@ -256,6 +256,8 @@ DFHACK_EXPORT std::string getCasteProfessionName(int race, int caste, df::profes
 
 DFHACK_EXPORT int8_t getProfessionColor(df::unit *unit, bool ignore_noble = false);
 DFHACK_EXPORT int8_t getCasteProfessionColor(int race, int caste, df::profession pid);
+
+DFHACK_EXPORT std::string getSquadName(df::unit *unit);
 }
 }
 #endif

images/manipulator2.png

@@ -10,6 +10,14 @@ local dfhack = dfhack
 local base_env = dfhack.BASE_G
 local _ENV = base_env
 
+CR_LINK_FAILURE = -3
+CR_NEEDS_CONSOLE = -2
+CR_NOT_IMPLEMENTED = -1
+CR_OK = 0
+CR_FAILURE = 1
+CR_WRONG_USAGE = 2
+CR_NOT_FOUND = 3
+
 -- Console color constants
 
 COLOR_RESET = -1
@@ -256,7 +264,8 @@ function dfhack.interpreter(prompt,hfile,env)
         print("Shortcuts:\n"..
               " '= foo' => '_1,_2,... = foo'\n"..
               " '! foo' => 'print(foo)'\n"..
-              "Both save the first result as '_'.")
+              " '~ foo' => 'printall(foo)'\n"..
+              "All of these save the first result as '_'.")
         print_banner = false
     end
 
@@ -357,6 +366,31 @@ function dfhack.run_script(name,...)
     return f(...)
 end
 
+function dfhack.run_command(...)
+    args = {...}
+    if type(args[1]) == 'table' then
+        command = args[1]
+    elseif #args > 1 and type(args[2]) == 'table' then
+        -- {args[1]} + args[2]
+        command = args[2]
+        table.insert(command, 1, args[1])
+    elseif #args == 1 and type(args[1]) == 'string' then
+        command = args[1]
+    elseif #args > 1 and type(args[1]) == 'string' then
+        command = args
+    else
+        error('Invalid arguments')
+    end
+    result = internal.runCommand(command)
+    output = ""
+    for i, f in pairs(result) do
+        if type(f) == 'table' then
+            output = output .. f[2]
+        end
+    end
+    return output, result.status
+end
+
 -- Per-save init file
 
 function dfhack.getSavePath()

images/manipulator3.png

@@ -69,6 +69,7 @@ using namespace std;
 #include "df/unit_misc_trait.h"
 #include "df/unit_skill.h"
 #include "df/curse_attr_change.h"
+#include "df/squad.h"
 
 using namespace DFHack;
 using namespace df::enums;
@@ -1552,3 +1553,15 @@ int8_t DFHack::Units::getCasteProfessionColor(int race, int casteid, df::profess
     // default to dwarven peasant color
     return 3;
 }
+
+std::string DFHack::Units::getSquadName(df::unit *unit)
+{
+    if (unit->military.squad_id == -1)
+        return "";
+    df::squad *squad = df::squad::find(unit->military.squad_id);
+    if (!squad)
+        return "";
+    if (squad->alias.size() > 0)
+        return squad->alias;
+    return Translation::TranslateName(&squad->name, true);
+}