add missing scratchpad.{c,h}

diff --git a/include/scratchpad.h b/include/scratchpad.h
new file mode 100644 (file)
index 0000000..4fb7523
--- /dev/null
+++ b/include/scratchpad.h
@@ -0,0 +1,33 @@
+/*
+ * vim:ts=4:sw=4:expandtab
+ *
+ * i3 - an improved dynamic tiling window manager
+ * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ *
+ * scratchpad.c: Scratchpad functions (TODO: more description)
+ *
+ */
+#ifndef _SCRATCHPAD_H
+#define _SCRATCHPAD_H
+
+/**
+ * Moves the specified window to the __i3_scratch workspace, making it floating
+ * and setting the appropriate scratchpad_state.
+ *
+ * Gets called upon the command 'move scratchpad'.
+ *
+ */
+void scratchpad_move(Con *con);
+
+/**
+ * Either shows the top-most scratchpad window (con == NULL) or shows the
+ * specified con (if it is scratchpad window).
+ *
+ * When called with con == NULL and the currently focused window is a
+ * scratchpad window, this serves as a shortcut to hide it again (so the user
+ * can press the same key to quickly look something up).
+ *
+ */
+void scratchpad_show(Con *con);
+
+#endif

diff --git a/src/scratchpad.c b/src/scratchpad.c
new file mode 100644 (file)
index 0000000..39f1854
--- /dev/null
+++ b/src/scratchpad.c
@@ -0,0 +1,117 @@
+/*
+ * vim:ts=4:sw=4:expandtab
+ *
+ * i3 - an improved dynamic tiling window manager
+ * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ *
+ * scratchpad.c: Moving windows to the scratchpad and making them visible again.
+ *
+ */
+#include "all.h"
+
+/*
+ * Moves the specified window to the __i3_scratch workspace, making it floating
+ * and setting the appropriate scratchpad_state.
+ *
+ * Gets called upon the command 'move scratchpad'.
+ *
+ */
+void scratchpad_move(Con *con) {
+    DLOG("should move con %p to __i3_scratch\n", con);
+
+    Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
+    if (con_get_workspace(con) == __i3_scratch) {
+        DLOG("This window is already on __i3_scratch.\n");
+        return;
+    }
+
+    /* 1: Ensure the window is floating. From now on, we deal with the
+     * CT_FLOATING_CON. We use automatic == false because the user made the
+     * choice that this window should be a scratchpad (and floating). */
+    floating_enable(con, false);
+    con = con->parent;
+
+    /* 2: Send the window to the __i3_scratch workspace, mainting its
+     * coordinates and not warping the pointer. */
+    Con *focus_next = con_next_focused(con);
+    con_move_to_workspace(con, __i3_scratch, true, true);
+
+    /* 3: If this is the first time this window is used as a scratchpad, we set
+     * the scratchpad_state to SCRATCHPAD_FRESH. The window will then be
+     * adjusted in size according to what the user specifies. */
+    if (con->scratchpad_state == SCRATCHPAD_NONE) {
+        DLOG("This window was never used as a scratchpad before.\n");
+        con->scratchpad_state = SCRATCHPAD_FRESH;
+    }
+
+    /* 4: Fix focus. Normally, when moving a window to a different output, the
+     * destination output gets focused. In this case, we don’t want that. */
+    con_focus(focus_next);
+}
+
+/*
+ * Either shows the top-most scratchpad window (con == NULL) or shows the
+ * specified con (if it is scratchpad window).
+ *
+ * When called with con == NULL and the currently focused window is a
+ * scratchpad window, this serves as a shortcut to hide it again (so the user
+ * can press the same key to quickly look something up).
+ *
+ */
+void scratchpad_show(Con *con) {
+    DLOG("should show scratchpad window %p\n", con);
+    Con *__i3_scratch = workspace_get("__i3_scratch", NULL);
+    Con *floating;
+
+    /* If this was 'scratchpad show' without criteria, we check if the
+     * currently focused window is a scratchpad window and should be hidden
+     * again. */
+    if (!con &&
+        (floating = con_inside_floating(focused)) &&
+        floating->scratchpad_state != SCRATCHPAD_NONE) {
+        DLOG("Focused window is a scratchpad window, hiding it.\n");
+        scratchpad_move(focused);
+        return;
+    }
+
+    /* If this was 'scratchpad show' with criteria, we check if it matches a
+     * currently visible scratchpad window and hide it. */
+    if (con &&
+        (floating = con_inside_floating(con)) &&
+        floating->scratchpad_state != SCRATCHPAD_NONE &&
+        con_get_workspace(con) != __i3_scratch) {
+        DLOG("Window is a scratchpad window, hiding it.\n");
+        scratchpad_move(con);
+        return;
+    }
+
+    Con *ws = con_get_workspace(focused);
+    if (con == NULL) {
+        /* Use the container on __i3_scratch which is highest in the focus
+         * stack. When moving windows to __i3_scratch, they get inserted at the
+         * bottom of the stack. */
+        con = TAILQ_FIRST(&(__i3_scratch->floating_head));
+
+        if (!con) {
+            LOG("You don't have any scratchpad windows yet.\n");
+            LOG("Use 'move scratchpad' to move a window to the scratchpad.\n");
+            return;
+        }
+    }
+
+    /* 1: Move the window from __i3_scratch to the current workspace. */
+    con_move_to_workspace(con, ws, true, false);
+
+    /* 2: Adjust the size if this window was not adjusted yet. */
+    if (con->scratchpad_state == SCRATCHPAD_FRESH) {
+        DLOG("Adjusting size of this window.\n");
+        Con *output = con_get_output(con);
+        con->rect.width = output->rect.width * 0.5;
+        con->rect.height = output->rect.height * 0.75;
+        con->rect.x = (output->rect.width / 2.0) - (con->rect.width / 2.0);
+        con->rect.y = (output->rect.height / 2.0) - (con->rect.height / 2.0);
+        con->scratchpad_state = SCRATCHPAD_CHANGED;
+    }
+
+    con_focus(con_descend_focused(con));
+}