Merge remote-tracking branch 'pronvit/mousequery' into develop

plugins/mousequery.cpp

@@ -48,6 +48,9 @@ static bool mouse_moved = false;
 
 static uint32_t scroll_delay = 100;
 
+static bool awaiting_lbut_up, awaiting_rbut_up;
+static enum { None, Left, Right } drag_mode;
+
 static df::coord get_mouse_pos(int32_t &mx, int32_t &my)
 {
     df::coord pos;
@@ -293,156 +296,186 @@ struct mousequery_hook : public df::viewscreen_dwarfmodest
         return false;
     }
 
-    bool handleMouse(const set<df::interface_key> *input)
+    bool handleLeft(df::coord &mpos, int32_t mx, int32_t my)
     {
-        int32_t mx, my;
+        if (!(Core::getInstance().getModstate() & DFH_MOD_SHIFT))
-        auto mpos = get_mouse_pos(mx, my);
+            mpos.z += Gui::getDepthAt(mx, my);
-        if (mpos.x == -30000)
-            return false;
 
-        auto dims = Gui::getDwarfmodeViewDims();
+        bool cursor_still_here = (last_clicked_x == mpos.x && last_clicked_y == mpos.y && last_clicked_z == mpos.z);
-        if (enabler->mouse_lbut)
+        last_clicked_x = mpos.x;
-        {
+        last_clicked_y = mpos.y;
-            bool cursor_still_here = (last_clicked_x == mpos.x && last_clicked_y == mpos.y && last_clicked_z == mpos.z);
+        last_clicked_z = mpos.z;
-            last_clicked_x = mpos.x;
-            last_clicked_y = mpos.y;
-            last_clicked_z = mpos.z;
 
-            df::interface_key key = interface_key::NONE;
+        df::interface_key key = interface_key::NONE;
-            bool designationMode = false;
+        bool designationMode = false;
-            bool skipRefresh = false;
+        bool skipRefresh = false;
 
-            if (isInTrackableMode())
+        if (isInTrackableMode())
-            {
+        {
-                designationMode = true;
+            designationMode = true;
-                key = df::interface_key::SELECT;
+            key = df::interface_key::SELECT;
-            }
+        }
-            else
+        else
+        {
+            switch (ui->main.mode)
             {
-                switch (ui->main.mode)
+            case QueryBuilding:
+                if (cursor_still_here)
+                    key = df::interface_key::D_BUILDITEM;
+                break;
+
+            case BuildingItems:
+                if (cursor_still_here)
+                    key = df::interface_key::D_VIEWUNIT;
+                break;
+
+            case ViewUnits:
+                if (cursor_still_here)
+                    key = df::interface_key::D_LOOK;
+                break;
+
+            case LookAround:
+                if (cursor_still_here)
+                    key = df::interface_key::D_BUILDJOB;
+                break;
+
+            case Build:
+                if (ui_build_selector)
                 {
-                case QueryBuilding:
+                    if (ui_build_selector->stage < 2)
-                    if (cursor_still_here)
-                        key = df::interface_key::D_BUILDITEM;
-                    break;
-
-                case BuildingItems:
-                    if (cursor_still_here)
-                        key = df::interface_key::D_VIEWUNIT;
-                    break;
-
-                case ViewUnits:
-                    if (cursor_still_here)
-                        key = df::interface_key::D_LOOK;
-                    break;
-
-                case LookAround:
-                    if (cursor_still_here)
-                        key = df::interface_key::D_BUILDJOB;
-                    break;
-
-                case Build:
-                    if (ui_build_selector)
                     {
-                        if (ui_build_selector->stage < 2)
+                        designationMode = true;
-                        {
+                        key = df::interface_key::SELECT;
-                            designationMode = true;
-                            key = df::interface_key::SELECT;
-                        }
-                        else
-                        {
-                            designationMode = true;
-                            skipRefresh = true;
-                            key = df::interface_key::SELECT_ALL;
-                        }
                     }
-                    break;
+                    else
+                    {
+                        designationMode = true;
+                        skipRefresh = true;
+                        key = df::interface_key::SELECT_ALL;
+                    }
+                }
+                break;
 
-                case Default:
+            case Default:
-                    break;
+                break;
 
-                default:
+            default:
-                    return false;
+                return false;
-                }
             }
+        }
 
-            enabler->mouse_lbut = 0;
+        enabler->mouse_lbut = 0;
 
-            // Can't check limits earlier as we must be sure we are in query or default mode
+        // Can't check limits earlier as we must be sure we are in query or default mode
-            // (so we can clear the button down flag)
+        // (so we can clear the button down flag)
-            int right_bound = (dims.menu_x1 > 0) ? dims.menu_x1 - 2 : gps->dimx - 2;
+        auto dims = Gui::getDwarfmodeViewDims();
-            if (mx < 1 || mx > right_bound || my < 1 || my > gps->dimy - 2)
+        int right_bound = (dims.menu_x1 > 0) ? dims.menu_x1 - 2 : gps->dimx - 2;
-                return false;
+        if (mx < 1 || mx > right_bound || my < 1 || my > gps->dimy - 2)
+            return false;
 
-            if (ui->main.mode == df::ui_sidebar_mode::Zones ||
+        if (ui->main.mode == df::ui_sidebar_mode::Zones ||
-                ui->main.mode == df::ui_sidebar_mode::Stockpiles)
+            ui->main.mode == df::ui_sidebar_mode::Stockpiles)
+        {
+            int32_t x, y, z;
+            if (Gui::getDesignationCoords(x, y, z))
             {
-                int32_t x, y, z;
+                auto dX = abs(x - mpos.x);
-                if (Gui::getDesignationCoords(x, y, z))
+                if (dX > 30)
-                {
+                    return false;
-                    auto dX = abs(x - mpos.x);
-                    if (dX > 30)
-                        return false;
 
-                    auto dY = abs(y - mpos.y);
+                auto dY = abs(y - mpos.y);
-                    if (dY > 30)
+                if (dY > 30)
-                        return false;
+                    return false;
-                }
             }
+        }
 
-            if (!designationMode)
+        if (!designationMode)
-            {
+        {
-                Gui::resetDwarfmodeView();
+            Gui::resetDwarfmodeView();
 
-                if (key == interface_key::NONE)
+            if (key == interface_key::NONE)
-                    key = get_default_query_mode(mpos);
+                key = get_default_query_mode(mpos);
 
-                sendKey(key);
+            sendKey(key);
-            }
+        }
 
-            if (!skipRefresh)
+        if (!skipRefresh)
-            {
+        {
-                // Force UI refresh
+            // Force UI refresh
-                moveCursor(mpos, true);
+            moveCursor(mpos, true);
-            }
+        }
 
-            if (designationMode)
+        if (designationMode)
-                sendKey(key);
+            sendKey(key);
 
-            return true;
+        return true;
+    }
+
+    bool handleRight(df::coord &mpos, int32_t mx, int32_t my)
+    {
+        if (isInDesignationMenu() && !box_designation_enabled)
+            return false;
+
+        // Escape out of query mode
+        enabler->mouse_rbut_down = 0;
+        enabler->mouse_rbut = 0;
+
+        using namespace df::enums::ui_sidebar_mode;
+        if ((ui->main.mode == QueryBuilding || ui->main.mode == BuildingItems ||
+            ui->main.mode == ViewUnits || ui->main.mode == LookAround) ||
+            (isInTrackableMode() && tracking_enabled))
+        {
+            sendKey(df::interface_key::LEAVESCREEN);
         }
-        else if (rbutton_enabled && enabler->mouse_rbut)
+        else
         {
-            if (isInDesignationMenu() && !box_designation_enabled)
+            auto dims = Gui::getDwarfmodeViewDims();
-                return false;
+            int scroll_trigger_x = dims.menu_x1 / 3;
+            int scroll_trigger_y = gps->dimy / 3;
+            if (mx < scroll_trigger_x)
+                sendKey(interface_key::CURSOR_LEFT_FAST);
+
+            if (mx > ((dims.menu_x1 > 0) ? dims.menu_x1 : gps->dimx) - scroll_trigger_x)
+                sendKey(interface_key::CURSOR_RIGHT_FAST);
 
-            // Escape out of query mode
+            if (my < scroll_trigger_y)
-            enabler->mouse_rbut_down = 0;
+                sendKey(interface_key::CURSOR_UP_FAST);
-            enabler->mouse_rbut = 0;
 
-            using namespace df::enums::ui_sidebar_mode;
+            if (my > gps->dimy - scroll_trigger_y)
-            if ((ui->main.mode == QueryBuilding || ui->main.mode == BuildingItems ||
+                sendKey(interface_key::CURSOR_DOWN_FAST);
-                ui->main.mode == ViewUnits || ui->main.mode == LookAround) ||
+        }
-                (isInTrackableMode() && tracking_enabled))
+
+        return false;
+    }
+
+    bool handleMouse(const set<df::interface_key> *input)
+    {
+        int32_t mx, my;
+        auto mpos = get_mouse_pos(mx, my);
+        if (mpos.x == -30000)
+            return false;
+
+        if (enabler->mouse_lbut)
+        {
+            if (drag_mode == Left)
             {
-                sendKey(df::interface_key::LEAVESCREEN);
+                awaiting_lbut_up = true;
+                enabler->mouse_lbut = false;
+                last_move_pos = mpos;
             }
             else
+                return handleLeft(mpos, mx, my);
+        }
+        else if (enabler->mouse_rbut)
+        {
+            if (drag_mode == Right)
             {
-                int scroll_trigger_x = dims.menu_x1 / 3;
+                awaiting_rbut_up = true;
-                int scroll_trigger_y = gps->dimy / 3;
+                enabler->mouse_rbut = false;
-                if (mx < scroll_trigger_x)
+                last_move_pos = mpos;
-                    sendKey(interface_key::CURSOR_LEFT_FAST);
-
-                if (mx > ((dims.menu_x1 > 0) ? dims.menu_x1 : gps->dimx) - scroll_trigger_x)
-                    sendKey(interface_key::CURSOR_RIGHT_FAST);
-
-                if (my < scroll_trigger_y)
-                    sendKey(interface_key::CURSOR_UP_FAST);
-
-                if (my > gps->dimy - scroll_trigger_y)
-                    sendKey(interface_key::CURSOR_DOWN_FAST);
             }
+            else if (rbutton_enabled)
+                return handleRight(mpos, mx, my);
         }
         else if (input->count(interface_key::CUSTOM_ALT_M) && isInDesignationMenu())
         {
@@ -554,10 +587,39 @@ struct mousequery_hook : public df::viewscreen_dwarfmodest
             return;
         }
 
+        if (awaiting_lbut_up && !enabler->mouse_lbut_down)
+        {
+            awaiting_lbut_up = false;
+            handleLeft(mpos, mx, my);
+        }
+
+        if (awaiting_rbut_up && !enabler->mouse_rbut_down)
+        {
+            awaiting_rbut_up = false;
+            if (rbutton_enabled)
+                handleRight(mpos, mx, my);
+        }
+
         if (mpos_valid)
         {
             if (mpos.x != last_move_pos.x || mpos.y != last_move_pos.y || mpos.z != last_move_pos.z)
             {
+                awaiting_lbut_up = false;
+                awaiting_rbut_up = false;
+
+                if ((enabler->mouse_lbut_down && drag_mode == Left) || (enabler->mouse_rbut_down && drag_mode == Right))
+                {
+                    int newx = (*df::global::window_x) - (mpos.x - last_move_pos.x);
+                    int newy = (*df::global::window_y) - (mpos.y - last_move_pos.y);
+
+                    newx = std::max(0, std::min(newx, world->map.x_count - dims.map_x2+1));
+                    newy = std::max(0, std::min(newy, world->map.y_count - dims.map_y2+1));
+
+                    (*df::global::window_x) = newx;
+                    (*df::global::window_y) = newy;
+                    return;
+                }
+
                 mouse_moved = true;
                 last_move_pos = mpos;
             }
@@ -677,6 +739,10 @@ struct mousequery_hook : public df::viewscreen_dwarfmodest
                 return;
             }
 
+            // Don't change levels
+            if (mpos.z != *df::global::window_z)
+                return;
+
             last_t = enabler->clock;
             moveCursor(mpos, false);
         }
@@ -699,6 +765,14 @@ struct mousequery_hook : public df::viewscreen_dwarfmodest
         set_to_limit(look_list, 8);
         int disp_y = gps->dimy - look_list - 2;
 
+        if (mpos.z != *df::global::window_z)
+        {
+            int y = gps->dimy - 2;
+            char buf[6];
+            sprintf(buf, "@%d", mpos.z - *df::global::window_z);
+            OutputString(COLOR_GREY, disp_x, y, buf, true, left_margin);
+        }
+
         int c = 0;
         for (auto it = ulist.begin(); it != ulist.end() && c < 8; it++, c++)
         {
@@ -783,6 +857,15 @@ static command_result mousequery_cmd(color_ostream &out, vector <string> & param
         {
             live_view = (state == "enable");
         }
+        else if (cmd == "drag")
+        {
+            if (state == "left")
+                drag_mode = Left;
+            else if (state == "right")
+                drag_mode = Right;
+            else if (state == "disable")
+                drag_mode = None;
+        }
         else if (cmd[0] == 'd')
         {
             auto l = atoi(state.c_str());
@@ -828,12 +911,14 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
         PluginCommand(
         "mousequery", "Add mouse functionality to Dwarf Fortress",
         mousequery_cmd, false,
-        "mousequery [plugin|rbutton|track|edge|live] [enabled|disabled]\n"
+        "mousequery [plugin|rbutton|track|edge|live] [enable|disable]\n"
         "  plugin: enable/disable the entire plugin\n"
         "  rbutton: enable/disable right mouse button\n"
         "  track: enable/disable moving cursor in build and designation mode\n"
         "  edge: enable/disable active edge scrolling (when on, will also enable tracking)\n"
         "  live: enable/disable query view when unpaused\n\n"
+        "mousequery drag [left|right|disable]\n"
+        "  Enable/disable map dragging with the specified mouse button\n\n"
         "mousequery delay <amount>\n"
         "  Set delay when edge scrolling in tracking mode. Omit amount to display current setting.\n"
         ));