Merge pull request #2657 from myk002/myk_autodump

update autodump, only commands, add hotkeys

data/init/dfhack.keybindings.init

@@ -27,8 +27,8 @@ keybinding add Ctrl-Shift-K gui/cp437-table
 # dwarfmode bindings #
 ######################
 
-# quicksave, only in main dwarfmode screen and menu page
-#keybinding add Ctrl-Alt-S@dwarfmode/Default quicksave
+# quicksave
+keybinding add Ctrl-Alt-S@dwarfmode quicksave
 
 # toggle the display of water level as 1-7 tiles
 #keybinding add Ctrl-W@dwarfmode|dungeonmode twaterlvl
@@ -47,7 +47,7 @@ keybinding add Ctrl-Shift-K gui/cp437-table
 #keybinding add Ctrl-Shift-K@dwarfmode autodump-destroy-here
 
 # apply blueprints to the map (Alt-F for compatibility with LNP Quickfort)
-#keybinding add Ctrl-Shift-Q@dwarfmode gui/quickfort
+keybinding add Ctrl-Shift-Q@dwarfmode gui/quickfort
 #keybinding add Alt-F@dwarfmode gui/quickfort
 
 # show information collected by dwarfmonitor

docs/plugins/autodump.rst

@@ -2,48 +2,32 @@ autodump
 ========
 
 .. dfhack-tool::
-    :summary: Automatically set items in a stockpile to be dumped.
-    :tags: untested fort armok fps productivity items stockpiles
-    :no-command:
-
-.. dfhack-command:: autodump
-    :summary: Teleports items marked for dumping to the cursor position.
+    :summary: Instantly gather or destroy items marked for dumping.
+    :tags: fort armok fps items
 
 .. dfhack-command:: autodump-destroy-here
-    :summary: Destroy items marked for dumping under the cursor.
-
-.. dfhack-command:: autodump-destroy-item
-    :summary: Destroys the selected item.
+    :summary: Destroy items marked for dumping under the keyboard cursor.
 
-When `enabled <enable>`, this plugin adds an option to the :kbd:`q` menu for
-stockpiles. When the ``autodump`` option is selected for the stockpile, any
-items placed in the stockpile will automatically be designated to be dumped.
+This tool can instantly move all unforbidden items marked for dumping to the
+tile under the keyboard cursor. After moving the items, the dump flag is unset
+and the forbid flag is set, just as if it had been dumped normally. Be aware
+that dwarves that are en route to pick up the item for dumping may still come
+and move the item to your dump zone.
 
-When invoked as a command, it can instantly move all unforbidden items marked
-for dumping to the tile under the cursor. After moving the items, the dump flag
-is unset and the forbid flag is set, just as if it had been dumped normally. Be
-aware that dwarves that are en route to pick up the item for dumping may still
-come and move the item to your dump zone.
-
-The cursor must be placed on a floor tile so the items can be dumped there.
+The keyboard cursor must be placed on a floor tile so the items can be dumped
+there.
 
 Usage
 -----
 
 ::
 
-    enable autodump
     autodump [<options>]
     autodump-destroy-here
-    autodump-destroy-item
 
 ``autodump-destroy-here`` is an alias for ``autodump destroy-here`` and is
 intended for use as a keybinding.
 
-``autodump-destroy-item`` destroys only the selected item. The item may be
-selected in the :kbd:`k` list or in the container item list. If called again
-before the game is resumed, cancels destruction of the item.
-
 Options
 -------
 
@@ -67,5 +51,5 @@ Examples
     Teleports items marked for dumping to the cursor position.
 ``autodump destroy``
     Destroys all unforbidden items marked for dumping
-``autodump-destroy-item``
-    Destroys the selected item.
+``autodump-destroy-here``
+    Destroys items on the selected tile that are marked for dumping.

library/include/df/custom/coord.methods.inc

@@ -3,7 +3,7 @@ coord(uint16_t _x, uint16_t _y, uint16_t _z) : x(_x), y(_y), z(_z) {}
 
 operator coord2d() const { return coord2d(x,y); }
 
-bool isValid() const { return x != -30000; }
+bool isValid() const { return x >= 0; }
 void clear() { x = y = z = -30000; }
 
 bool operator==(const coord &other) const

library/include/df/custom/coord2d.methods.inc

@@ -1,6 +1,6 @@
 coord2d(uint16_t _x, uint16_t _y) : x(_x), y(_y) {}
 
-bool isValid() const { return x != -30000; }
+bool isValid() const { return x >= 0; }
 void clear() { x = y = -30000; }
 
 bool operator==(const coord2d &other) const

library/lua/dfhack.lua

@@ -321,7 +321,7 @@ end
 function pos2xyz(pos)
     if pos then
         local x = pos.x
-        if x and x ~= -30000 then
+        if x and x >= 0 then
             return x, pos.y, pos.z
         end
     end
@@ -346,7 +346,7 @@ end
 function pos2xy(pos)
     if pos then
         local x = pos.x
-        if x and x ~= -30000 then
+        if x and x >= 0 then
             return x, pos.y
         end
     end

library/lua/gui.lua

@@ -481,7 +481,7 @@ end
 function View:getMousePos(view_rect)
     local rect = view_rect or self.frame_body
     local x,y = dscreen.getMousePos()
-    if rect and rect:inClipGlobalXY(x,y) then
+    if rect and x and rect:inClipGlobalXY(x,y) then
         return rect:localXY(x,y)
     end
 end

library/modules/Gui.cpp

@@ -46,6 +46,7 @@ using namespace DFHack;
 #include "modules/Screen.h"
 #include "modules/Maps.h"
 #include "modules/Units.h"
+#include "modules/World.h"
 
 #include "DataDefs.h"
 
@@ -625,10 +626,8 @@ bool Gui::anywhere_hotkey(df::viewscreen *) {
     return true;
 }
 
-bool Gui::dwarfmode_hotkey(df::viewscreen *top)
-{
-    // Require the main dwarf mode screen
-    return !!strict_virtual_cast<df::viewscreen_dwarfmodest>(top);
+bool Gui::dwarfmode_hotkey(df::viewscreen *top) {
+    return World::isFortressMode();
 }
 
 bool Gui::unitjobs_hotkey(df::viewscreen *top)
@@ -650,7 +649,7 @@ bool Gui::item_details_hotkey(df::viewscreen *top)
 
 static bool has_cursor()
 {
-    return df::global::cursor && df::global::cursor->x != -30000;
+    return Gui::getCursorPos().isValid();
 }
 
 bool Gui::cursor_hotkey(df::viewscreen *top)
@@ -1721,7 +1720,7 @@ bool Gui::autoDFAnnouncement(df::report_init r, string message)
     // Check if the announcement will actually be announced
     if (*gamemode == game_mode::ADVENTURE)
     {
-        if (r.pos.x != -30000 &&
+        if (r.pos.x >= 0 &&
             r.type != announcement_type::CREATURE_SOUND &&
             r.type != announcement_type::REGULAR_CONVERSATION &&
             r.type != announcement_type::CONFLICT_CONVERSATION &&
@@ -2152,7 +2151,7 @@ bool Gui::getDesignationCoords (int32_t &x, int32_t &y, int32_t &z)
     x = selection_rect->start_x;
     y = selection_rect->start_y;
     z = selection_rect->start_z;
-    return (x == -30000) ? false : true;
+    return (x >= 0) ? false : true;
 }
 
 bool Gui::setDesignationCoords (const int32_t x, const int32_t y, const int32_t z)

plugins/CMakeLists.txt

@@ -78,7 +78,7 @@ set_source_files_properties( Brushes.h PROPERTIES HEADER_FILE_ONLY TRUE )
 dfhack_plugin(autobutcher autobutcher.cpp LINK_LIBRARIES lua)
 dfhack_plugin(autochop autochop.cpp LINK_LIBRARIES lua)
 #dfhack_plugin(autoclothing autoclothing.cpp)
-#dfhack_plugin(autodump autodump.cpp)
+dfhack_plugin(autodump autodump.cpp)
 dfhack_plugin(autofarm autofarm.cpp)
 #dfhack_plugin(autogems autogems.cpp LINK_LIBRARIES jsoncpp_static)
 #add_subdirectory(autolabor)

plugins/autodump.cpp

@@ -1,33 +1,34 @@
 // Quick Dumper : Moves items marked as "dump" to cursor
 // FIXME: local item cache in map blocks needs to be fixed after teleporting items
-#include <iostream>
-#include <iomanip>
-#include <sstream>
-#include <climits>
-#include <vector>
-#include <string>
-#include <algorithm>
-#include <set>
-using namespace std;
 
 #include "Core.h"
 #include "Console.h"
+#include "DataDefs.h"
 #include "Export.h"
 #include "PluginManager.h"
+
 #include "modules/Maps.h"
 #include "modules/Gui.h"
 #include "modules/Items.h"
 #include "modules/Materials.h"
 #include "modules/MapCache.h"
 
-#include "DataDefs.h"
 #include "df/item.h"
 #include "df/world.h"
 #include "df/general_ref.h"
 #include "df/viewscreen_dwarfmodest.h"
 #include "df/building_stockpilest.h"
-#include "uicommon.h"
 
+#include <iostream>
+#include <iomanip>
+#include <sstream>
+#include <climits>
+#include <vector>
+#include <string>
+#include <algorithm>
+#include <set>
+
+using namespace std;
 using namespace DFHack;
 using namespace df::enums;
 
@@ -40,6 +41,7 @@ DFHACK_PLUGIN("autodump");
 REQUIRE_GLOBAL(gps);
 REQUIRE_GLOBAL(world);
 
+/* TODO: merge with stockpiles plugin
 // Stockpile interface START
 static const string PERSISTENCE_KEY = "autodump/stockpiles";
 
@@ -267,6 +269,7 @@ DFhackCExport command_result plugin_enable(color_ostream &out, bool enable)
 }
 
 // Stockpile interface END
+*/
 
 command_result df_autodump(color_ostream &out, vector <string> & parameters);
 command_result df_autodump_destroy_here(color_ostream &out, vector <string> & parameters);
@@ -276,18 +279,21 @@ DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCom
 {
     commands.push_back(PluginCommand(
         "autodump",
-        "Teleport items marked for dumping to the cursor.",
-        df_autodump));
+        "Teleport items marked for dumping to the keyboard cursor.",
+        df_autodump,
+        Gui::cursor_hotkey));
     commands.push_back(PluginCommand(
         "autodump-destroy-here",
-        "Destroy items marked for dumping under cursor.",
+        "Destroy items marked for dumping under the keyboard cursor.",
         df_autodump_destroy_here,
         Gui::cursor_hotkey));
+    /* you can no longer select items
     commands.push_back(PluginCommand(
         "autodump-destroy-item",
         "Destroy the selected item.",
         df_autodump_destroy_item,
         Gui::any_item_hotkey));
+        */
     return CR_OK;
 }
 
@@ -340,16 +346,14 @@ static command_result autodump_main(color_ostream &out, vector <string> & parame
     MapCache MC;
     int dumped_total = 0;
 
-    int cx, cy, cz;
-    DFCoord pos_cursor;
+    df::coord pos_cursor;
     if(!destroy || here)
     {
-        if (!Gui::getCursorCoords(cx,cy,cz))
-        {
-            out.printerr("Cursor position not found. Please enable the cursor.\n");
+        pos_cursor = Gui::getCursorPos();
+        if (!pos_cursor.isValid()) {
+            out.printerr("Keyboard cursor must be over a suitable map tile.\n");
             return CR_FAILURE;
         }
-        pos_cursor = DFCoord(cx,cy,cz);
     }
     if (!destroy)
     {
@@ -441,13 +445,14 @@ command_result df_autodump(color_ostream &out, vector <string> & parameters)
 
 command_result df_autodump_destroy_here(color_ostream &out, vector <string> & parameters)
 {
-    // HOTKEY COMMAND; CORE ALREADY SUSPENDED
     if (!parameters.empty())
         return CR_WRONG_USAGE;
 
     vector<string> args;
     args.push_back("destroy-here");
 
+    CoreSuspender suspend;
+
     return autodump_main(out, args);
 }