tile-window.lisp

;;; a dumping spot for window stuff that has tiling stuff in it

(in-package :stumpwm)

(export '(*ignore-wm-inc-hints*))

(defvar *ignore-wm-inc-hints* nil
  "Set this to T if you never want windows to resize based on incremental WM_HINTs,
like xterm and emacs.")

(define-swm-class tile-window (window)
  ((frame   :initarg :frame   :accessor window-frame :type frame)
   (normal-size :initform nil :accessor window-normal-size)))

(defmethod print-swm-object ((object tile-window) stream)
  (write-string "TILE-" stream)
  (call-next-method))

(defmethod update-decoration ((window tile-window))
  ;; give it a colored border but only if there are more than 1 frames.
  (let* ((group (window-group window))
         (screen (group-screen group)))
    (let ((c (if (eq (group-current-window group) window)
                 (screen-focus-color screen)
                 (screen-unfocus-color screen))))
      (setf (xlib:window-border (window-parent window)) c
            ;; windows that dont fill the entire screen have a transparent background.
            (xlib:window-background (window-parent window))
            (if (eq (window-type window) :normal)
                (if (eq *window-border-style* :thick)
                    c
                    (screen-win-bg-color screen))
                :none))
      ;; get the background updated
      (xlib:clear-area (window-parent window)))))

(defmethod window-sync ((window tile-window) hint)
  (case hint
    ((:normal-hints :type)
     (maximize-window window))))

(defmethod window-visible-p ((window tile-window))
  ;; A TILE-WINDOW is visible is it is the top window in the frame or when the
  ;; focused window is a FLOAT-WINDOW and the TILE-WINDOW can be seen below.
  (let* ((frame (window-frame window))
         (frame-windows (frame-windows (window-group window) frame)))
    (flet ((full-frame-p (win)
             (not (and (window-normal-hints win)
                       (xlib:wm-size-hints-x (window-normal-hints win))
                       (xlib:wm-size-hints-y (window-normal-hints win))))))
      (or (eq window (or (frame-window frame)
                         (first frame-windows)))
          (when (> (length frame-windows) 1)
            (loop :for (current-window next-window) :on frame-windows
                  :until (full-frame-p current-window)
                  :when (eq window next-window)
                    :do (return t)))))))

(defmethod window-head ((window tile-window))
  (frame-head (window-group window) (window-frame window)))

(defmethod (setf window-fullscreen) :after (val (window tile-window))
  (if val
      (maximize-window window)
      (progn
        (setf (xlib:drawable-border-width (window-parent window)) (default-border-width-for-type window))
        (maximize-window window))))

;;;;

(defmethod really-raise-window ((window tile-window))
  (frame-raise-window (window-group window) (window-frame window) window))

(defun raise-modals-of (window)
  (mapc 'really-raise-window (modals-of window)))

(defun raise-modals-of-gang (window)
  (mapc 'really-raise-window (only-modals (window-gang window))))

(defun raise-transients-of-gang (window)
  (mapc 'really-raise-window (only-transients (window-gang window))))

;;;

(defgeneric geometry-hints (win)
  (:documentation "Return hints for max width and height and increment hints. These
hints have been modified to always be defined and never be greater
than the root window's width and height.")
  (:method (win)
    (let* ((f (window-frame win))
           (x (frame-x f))
           (y (frame-display-y (window-group win) f))
           (border (if (or (eq *window-border-style* :none)
                           (= (length (group-frames (window-group win))) 1))
                       0
                       (default-border-width-for-type win)))
           (fwidth (- (frame-width f) (* 2 border)))
           (fheight (- (frame-display-height (window-group win) f)
                       (* 2 border)))
           (width fwidth)
           (height fheight)
           (hints (window-normal-hints win))
           (hints-min-width (and hints (xlib:wm-size-hints-min-width hints)))
           (hints-min-height (and hints (xlib:wm-size-hints-min-height hints)))
           (hints-max-width (and hints (xlib:wm-size-hints-max-width hints)))
           (hints-max-height (and hints (xlib:wm-size-hints-max-height hints)))
           (hints-width (and hints (xlib:wm-size-hints-base-width hints)))
           (hints-height (and hints (xlib:wm-size-hints-base-height hints)))
           (hints-spec-width (and hints (xlib:wm-size-hints-width hints)))
           (hints-spec-height (and hints (xlib:wm-size-hints-height hints)))
           (hints-inc-x (and hints (xlib:wm-size-hints-width-inc hints)))
           (hints-inc-y (and hints (xlib:wm-size-hints-height-inc hints)))
           (hints-min-aspect (and hints (xlib:wm-size-hints-min-aspect hints)))
           (hints-max-aspect (and hints (xlib:wm-size-hints-max-aspect hints)))
           center)
      ;;    (dformat 4 "hints: ~s~%" hints)
      ;; determine what the width and height should be
      (cond
        ;; handle specially fullscreen windows.
        ((window-fullscreen win)
         (let* ((win-group (window-group win))
                (fs-in-frame (fullscreen-in-frame-p win))
                (head (frame-head win-group f))
                (frame-to-fill (if fs-in-frame f head)))
           ;; Determine if the window should be fullscreened in the frame or the
           ;; head. If fullscreening a frame, use the frame-display functions on
           ;; y axis to account for the modeline.
           (if fs-in-frame
               (setf x (frame-x frame-to-fill)
                     y (frame-display-y win-group frame-to-fill)
                     width (frame-width frame-to-fill)
                     height (frame-display-height win-group frame-to-fill))
               (setf x (frame-x frame-to-fill)
                     y (frame-y frame-to-fill)
                     width (frame-width frame-to-fill)
                     height (frame-height frame-to-fill))))
         (return-from geometry-hints (values x y 0 0 width height 0 t)))
        ;; Adjust the defaults if the window is a transient_for window.
        ((find (window-type win) '(:transient :dialog))
         (setf center t
               width (min (max (or hints-width 0)
                               (or hints-min-width 0)
                               (window-width win))
                          width)
               height (min (max (or hints-height 0)
                                (or hints-min-height 0)
                                (window-height win))
                           height)))
        ;; Set requested size for non-maximized windows
        ((and (window-normal-size win)
              hints-spec-width hints-spec-height)
         (setf center t
               width (min hints-spec-width width)
               height (min hints-spec-height height)))
        ;; aspect hints are handled similar to max size hints
        ((and hints-min-aspect hints-max-aspect)
         (let ((ratio (/ width height)))
           (cond ((< ratio hints-min-aspect)
                  (setf height (ceiling width hints-min-aspect)))
                 ((> ratio hints-max-aspect)
                  (setf width  (ceiling (* height hints-max-aspect)))))
           (setf center t)))
        ;; Update our defaults if the window has the maxsize hints
        ((or hints-max-width hints-max-height)
         (when (and hints-max-width
                    (< hints-max-width width))
           (setf width hints-max-width))
         (when (and hints-max-height
                    (< hints-max-height height))
           (setf height hints-max-height))
         (setf center t))
        (t
         ;; if they have inc hints then start with the size and adjust
         ;; based on those increments until the window fits in the frame
         (when (and (not *ignore-wm-inc-hints*) hints-inc-x (plusp hints-inc-x))
           (let ((w (or hints-width (window-width win))))
             (setf width (+ w (* hints-inc-x
                                 (+ (floor (- fwidth w) hints-inc-x)))))))
         (when (and (not *ignore-wm-inc-hints*) hints-inc-y (plusp hints-inc-y))
           (let ((h (or hints-height (window-height win))))
             (setf height (+ h (* hints-inc-y
                                  (+ (floor (- fheight h) hints-inc-y)))))))))
      ;; adjust for gravity
      (multiple-value-bind (wx wy) (gravity-coords (gravity-for-window win)
                                                   width height
                                                   0 0
                                                   fwidth fheight)
        (when (or center
                  (find *window-border-style* '(:tight :none)))
          (setf x (+ wx (frame-x f))
                y (+ wy (frame-display-y (window-group win) f))
                wx 0 wy 0))
        ;; Now return our findings
        (values x y wx wy width height border center)))))

(defun maximize-window (win)
  "Maximize the window."
  (multiple-value-bind (x y wx wy width height border stick)
      (geometry-hints win)
    (dformat 4 "maximize window ~a x: ~d y: ~d width: ~d height: ~d border: ~d stick: ~s~%" win x y width height border stick)
    ;; This is the only place a window's geometry should change
    (set-window-geometry win :x wx :y wy :width width :height height :border-width 0)
    (xlib:with-state ((window-parent win))
      ;; FIXME: updating the border doesn't need to be run everytime
      ;; the window is maximized, but only when the border style or
      ;; window type changes. The overhead is probably minimal,
      ;; though.
      (setf (xlib:drawable-x (window-parent win)) x
            (xlib:drawable-y (window-parent win)) y
            (xlib:drawable-border-width (window-parent win)) border)
      ;; the parent window should stick to the size of the window
      ;; unless it isn't being maximized to fill the frame.
      (if (or stick
              (find *window-border-style* '(:tight :none)))
          (setf (xlib:drawable-width (window-parent win)) (window-width win)
                (xlib:drawable-height (window-parent win)) (window-height win))
          (let ((frame (window-frame win)))
            (setf (xlib:drawable-width (window-parent win)) (- (frame-width frame)
                                                               (* 2 (xlib:drawable-border-width (window-parent win))))
                  (xlib:drawable-height (window-parent win)) (- (frame-display-height (window-group win) frame)
                                                                (* 2 (xlib:drawable-border-width (window-parent win)))))))
      ;; update the "extents"
      (xlib:change-property (window-xwin win) :_NET_FRAME_EXTENTS
                            (list wx
                                  (- (xlib:drawable-width (window-parent win)) width wx)
                                  wy
                                  (- (xlib:drawable-height (window-parent win)) height wy))
                            :cardinal 32))
    (update-decoration win)
    (update-configuration win)))

;;;

(defun only-tile-windows (windows)
  (remove-if-not (lambda (w) (typep w 'tile-window))
                 windows))

(defun pull-window (win &optional (to-frame (tile-group-current-frame (window-group win))) (focus-p t))
  (let ((f (window-frame win))
        (group (window-group win)))
    (unless (eq (frame-window to-frame) win)
      (xwin-hide win)
      (setf (window-frame win) to-frame)
      (maximize-window win)
      (when (eq (window-group win) (current-group))
        (xwin-unhide (window-xwin win) (window-parent win)))
      ;; We have to restore the focus after hiding.
      (when (eq win (screen-focus (window-screen win)))
        (screen-set-focus (window-screen win) win))
      (frame-raise-window group to-frame win focus-p)
      ;; if win was focused in its old frame then give the old
      ;; frame the frame's last focused window.
      (when (eq (frame-window f) win)
        ;; the current value is no longer valid.
        (setf (frame-window f) nil)
        (frame-raise-window group f (first (frame-windows group f)) nil)))))

;; In the future, this window will raise the window into the current
;; frame.
(defun focus-forward (group window-list &optional pull-p (predicate (constantly t)))
  "Set the focus to the next item in window-list from the focused
window. If PULL-P is T then pull the window into the current
frame."
  ;; The window with focus is the "current" window, so find it in the
  ;; list and give that window focus
  (let* ((w (group-current-window group))
         (wins (remove-if-not predicate (cdr (member w window-list))))
         (nw (if (null wins)
                 ;; If the last window in the list is focused, then
                 ;; focus the first one.
                 (car (remove-if-not predicate window-list))
                 ;; Otherwise, focus the next one in the list.
                 (first wins))))
    ;; there's still the case when the window is the only one in the
    ;; list, so make sure its not the same as the current window.
    (if (and nw
             (not (eq w nw)))
        (if pull-p
            (pull-window nw)
            (frame-raise-window group (window-frame nw) nw))
        (message "No other window."))))

(defcommand (pull-window-by-number tile-group) (n &optional (group (current-group)))
                                               ((:window-number "Pull: "))
  "Pull window N from another frame into the current frame and focus it."
  (let ((win (find n (group-windows group) :key 'window-number :test '=)))
    (when win
      (pull-window win))))

(defcommand-alias pull pull-window-by-number)

(defun other-hidden-window (group)
  "Return the last window that was accessed and that is hidden."
  (let ((wins (remove-if (lambda (w) (eq (frame-window (window-frame w)) w))
                         (only-tile-windows (group-windows group)))))
    (first wins)))

(defun pull-other-hidden-window (group)
  "pull the last accessed hidden window from any frame into the
current frame and raise it."
  (let ((win (other-hidden-window group)))
    (if win
        (pull-window win)
        (echo-string (group-screen group) "No other window."))))

(defun other-window-in-frame (group)
  (let* ((f (tile-group-current-frame group))
         (wins (frame-windows group f))
         (win (if (frame-window f)
                  (second wins)
                  (first wins))))
    (if win
        (frame-raise-window group (window-frame win) win)
        (echo-string (group-screen group) "No other window."))))

(defcommand (pull-hidden-next tile-group) () ()
"Pull the next hidden window into the current frame."
  (let ((group (current-group)))
    (focus-forward group (only-tile-windows (sort-windows group)) t
                   (lambda (w) (not (eq (frame-window (window-frame w)) w))))))

(defcommand (pull-hidden-previous tile-group) () ()
"Pull the next hidden window into the current frame."
  (let ((group (current-group)))
    (focus-forward group (nreverse (only-tile-windows (sort-windows group))) t
                   (lambda (w) (not (eq (frame-window (window-frame w)) w))))))

(defcommand (pull-hidden-other tile-group) () ()
"Pull the last focused, hidden window into the current frame."
  (let ((group (current-group)))
    (pull-other-hidden-window group)))

(defcommand (pull-from-windowlist tile-group)
    (&optional (fmt *window-format*)) (:rest)
  "Pulls a window selected from the list of windows.
This allows a behavior similar to Emacs' switch-to-buffer
when selecting another window."
  (let ((pulled-window (select-window-from-menu
                        (group-windows (current-group))
                        fmt)))
    (when pulled-window
      (pull-window pulled-window))))

(defgeneric exchange-windows (win1 win2)
  (:documentation "Exchange the windows in their respective frames."))

(defmethod exchange-windows ((win1 tile-window) (win2 tile-window))
  "Exchange tile windows in their respective frames."
  (let ((f1 (window-frame win1))
        (f2 (window-frame win2)))
    (unless (eq f1 f2)
      (pull-window win1 f2)
      (pull-window win2 f1)
      (focus-frame (window-group win1) f2))))

(defcommand (exchange-direction tile-group) (dir &optional (win (current-window)))
    ((:direction "Direction: "))
  "Exchange the current window (by default) with the top window of the frame in specified direction. (bound to @kbd{C-t x} by default)
@table @asis
@item up
@item down
@item left
@item right
@end table"
  (if win
      (let* ((frame-set (group-frames (window-group win)))
             (neighbour (neighbour dir (window-frame win) frame-set)))
        (if (and neighbour (frame-window neighbour))
            (exchange-windows win (frame-window neighbour))
            (message "No window in direction ~A!" dir)))
      (message "No window in current frame!")))


(defcommand (echo-frame-windows tile-group) (&optional (fmt *window-format*)) (:rest)
  "Display a list of all the windows in the current frame."
  (echo-windows fmt (current-group) (frame-windows (current-group)
                                                   (tile-group-current-frame (current-group)))))

(defcommand-alias frame-windows echo-frame-windows)

(defcommand (gravity tile-group) (gravity) ((:gravity "Gravity: "))
  "Set a window's gravity within its frame. Gravity controls where the
window will appear in a frame if it is smaller that the
frame. Possible values are:

@table @var
@item center
@item top
@item right
@item bottom
@item left
@item top-right
@item top-left
@item bottom-right
@item bottom-left
@end table"
  (when (current-window)
    (setf (window-gravity (current-window)) gravity)
    (maximize-window (current-window))))

(defcommand (pull-marked tile-group) () ()
"Pull all marked windows into the current frame and clear the marks."
  (let ((group (current-group)))
    (dolist (i (marked-windows group))
      (pull-window i))
    (clear-window-marks group)))

;;; window placement commands

(defun make-rule-for-window (window &optional lock title)
  "Guess at a placement rule for WINDOW and add it to the current set."
  (let* ((group (window-group window))
         (group-name (group-name group))
         (frame-number-or-float (if (typep window 'float-window)
                                    :float
                                    (frame-number (window-frame window))))
         (role (window-role window)))
    (push (list group-name frame-number-or-float t lock
                :class (window-class window)
                :instance (window-res window)
                :title (and title (window-name window))
                :role (and (not (equal role "")) role))
          *window-placement-rules*)))

(defcommand (remember tile-group) (lock title)
                                  ((:y-or-n "Lock to group? ")
                                   (:y-or-n "Use title? "))
  "Make a generic placement rule for the current window. Might be too specific/not specific enough!"
  (make-rule-for-window (current-window) lock title))

(defcommand (forget tile-group) () ()
  "Forget the window placement rule that matches the current window."
  (let* ((window (current-window))
         (match (rule-matching-window window)))
    (if match
        (progn
          (setf *window-placement-rules* (delete match *window-placement-rules*))
          (message "Rule forgotten."))
        (message "No matching rule."))))

(defcommand (dump-window-placement-rules tile-group) (file) ((:rest "Filename: "))
  "Dump *window-placement-rules* to FILE."
  (dump-to-file *window-placement-rules* file))

(defcommand-alias dump-rules dump-window-placement-rules)

(defcommand (restore-window-placement-rules tile-group) (file) ((:rest "Filename: "))
  "Restore *window-placement-rules* from FILE."
  (setf *window-placement-rules* (read-dump-from-file file)))

(defcommand-alias restore-rules restore-window-placement-rules)

(defcommand (redisplay tile-group) () ()
  "Refresh current window by a pair of resizes, also make it occupy entire frame."
  (let ((window (current-window)))
    (when window
      (with-slots (width height frame) window
      (set-window-geometry window
                           :width (- width (window-width-inc window))
                           :height (- height (window-height-inc window)))
      ;; make sure the first one goes through before sending the second
      (xlib:display-finish-output *display*)
      (set-window-geometry window
                           :width (+ width
                                     (* (window-width-inc window)
                                        (floor (- (frame-width frame) width)
                                               (window-width-inc window))))
                           :height (+ height
                                      (* (window-height-inc window)
                                         (floor (- (frame-height frame) height)
                                                (window-height-inc window)))))
      (maximize-window window)))))

(defcommand (unmaximize tile-group) (&optional (window (current-window))) (:rest)
  "Use the size the program requested for current window (if any) instead of maximizing it."
  (let ((status (not (window-normal-size window)))
        (hints (window-normal-hints window)))
    (if (and (xlib:wm-size-hints-width hints)
             (xlib:wm-size-hints-height hints))
        (progn
          (setf (window-normal-size window) status)
          ;; This makes the naming a bit funny.
          (maximize-window window))
        (message "Window has no normal size."))))

(defcommand frame-windowlist (&optional (fmt *window-format*)) (:rest)
  "Allow the user to select a window from the list of windows in the current
frame and focus the selected window.  The optional argument @var{fmt} can be
specified to override the default window formatting."
  (let* ((group (current-group))
         (frame (tile-group-current-frame group)))
    (if (null (frame-windows group frame))
        (message "No Managed Windows.")
        (let ((window (select-window-from-menu (frame-sort-windows group frame) fmt)))
          (if window
              (group-focus-window group window)
              (throw 'error :abort))))))