Add support for displaying buffers in PIP temporarily

.gitignore

@@ -0,0 +1,2 @@
+*.elc
+*.eld

pip-frame.el

@@ -61,6 +61,11 @@ custom option but it can be overriden here."
   :type '(alist :key-type symbol :value-type sexp)
   :group 'pip-frame)
 
+(defcustom pip-frame-temporary-buffer-seconds 10
+  "Number of seconds to keep a buffer displayed temporarily by default."
+  :type 'number
+  :group 'pip-frame)
+
 (defvar pip-frame--name "PIP-frame")
 
 (defun pip-frame--get-frame (&optional no-error)
@@ -70,7 +75,7 @@ custom option but it can be overriden here."
         (unless no-error
           (error "No PIP frame")))))
 
-(defun pip-frame--make-frame ()
+(defun pip-frame--make-frame (buffer)
   (let ((frame (make-frame `((name . ,pip-frame--name)
                              (unsplittable . t)
                              ,@pip-frame-parameters
@@ -81,49 +86,87 @@ custom option but it can be overriden here."
     (set-face-attribute 'default frame :height face-height)
     (mapc #'(lambda (p) (set-face-attribute 'default frame (car p) (cdr p)))
           pip-frame-face-attributes)
+    (set-window-buffer (car (window-list frame)) buffer)
     frame))
 
 (defun pip-frame-delete-frame ()
-  ""
+  "Delete the PIP frame."
   (interactive)
   (delete-frame (pip-frame--get-frame)))
 
 (defun pip-frame--buffers ()
   (mapcar #'window-buffer (window-list (pip-frame--get-frame))))
 
-(defun pip-frame--add-additional-buffer ()
+(defun pip-frame--add-additional-buffer (buffer temporary)
-  (let* ((windows (window-list (pip-frame--get-frame)))
+  (let ((windows (window-list (pip-frame--get-frame))))
-         (sizes (mapcar #'(lambda (w)
+    (unless (and temporary
-                            (let ((width (window-body-width w t))
+                 (cl-find buffer windows :key #'window-buffer :test #'eq))
-                                  (height (window-body-height w t)))
+      (let* ((sizes (mapcar #'(lambda (w)
-                              (cons (+ (* width width) (* height height))
+                                (let ((width (window-body-width w t))
-                                    w)))
+                                      (height (window-body-height w t)))
-                        windows))
+                                  (cons (+ (* width width) (* height height))
-         (largest (cdr (cl-first (cl-sort sizes #'> :key #'car))))
+                                        w)))
-         (side (if (> (window-body-width largest t) (* 2 (window-body-height largest t)))
+                            windows))
-                   'right
+             (largest (cdr (cl-first (cl-sort sizes #'> :key #'car))))
-                 'below))
+             (side (if (> (window-body-width largest t)
-         (new-window (split-window largest nil side)))
+                          (* 2 (window-body-height largest t)))
-    (set-window-buffer new-window (current-buffer))))
+                       'right
+                     'below))
+             (new-window (split-window largest nil side)))
+        (set-window-buffer new-window buffer)))))
+
+(defvar pip-frame--buffer-timers '())
+
+(defun pip-frame--make-buffer-temporary (buffer seconds)
+  (when (eq seconds t)
+    (setq seconds pip-frame-temporary-buffer-seconds))
+  (let ((timer (run-with-timer seconds nil #'pip-frame-remove-buffer buffer)))
+    (setq pip-frame--buffer-timers (cons (cons buffer timer)
+                                         pip-frame--buffer-timers))))
+
+(defun pip-frame--delete-buffer-timer (buffer)
+  (let ((timer (alist-get buffer pip-frame--buffer-timers)))
+    (when timer
+      (cancel-timer timer)
+      (setq pip-frame--buffer-timers
+            (assq-delete-all buffer pip-frame--buffer-timers)))))
   
 ;;;###autoload
-(defun pip-frame-add-buffer ()
+(defun pip-frame-add-buffer (&optional buffer-or-name temporary)
-  ""
+  "Add a buffer to the PIP frame.
+If there is no PIP frame then create one.
+If BUFFER-OR-NAME is specified, add the given buffer to the frame,
+otherwise add the current buffer.
+If TEMPORARY is given, display the buffer in the PIP frame for that
+many seconds and then remove it from the frame.  If t, display it for
+`pip-frame-temporary-buffer-seconds'.
+A buffer can be added and displayed multiple times in the frame.  If
+TEMPORARY is non-nil, the buffer is not displayed again if it is
+already present."
   (interactive)
-  (let ((frame (or (pip-frame--get-frame t))))
+  (let ((frame (pip-frame--get-frame t))
+        (buffer (get-buffer (or buffer-or-name (current-buffer)))))
     (if frame
-        (pip-frame--add-additional-buffer)
+        (progn
-      (pip-frame--make-frame))))
+          (when temporary
+            (pip-frame--delete-buffer-timer buffer))
+          (pip-frame--add-additional-buffer buffer temporary))
+      (pip-frame--make-frame buffer))
+    (when temporary
+      (pip-frame--make-buffer-temporary buffer temporary))))
 
-(defun pip-frame-remove-buffer (buffer-name)
+(defun pip-frame-remove-buffer (buffer-or-name)
-  ""
+  "Remove buffer named BUFFER-OR-NAME from the PIP frame.
+If it is the last buffer in the PIP frame, delete the frame.
+If the buffer is not present in the PIP frame, do nothing."
   (interactive (list (completing-read "Remove PIP buffer: "
                                       (mapcar #'buffer-name (pip-frame--buffers))
                                       nil t)))
   (let* ((windows (window-list (pip-frame--get-frame)))
-         (windows-to-delete (cl-remove buffer-name windows
+         (buffer (get-buffer buffer-or-name))
-                                       :key #'(lambda (w) (buffer-name (window-buffer w)))
+         (windows-to-delete (cl-remove buffer windows
-                                       :test-not #'string=)))
+                                       :key #'window-buffer
+                                       :test-not #'eq)))
     (if (= (length windows-to-delete) (length windows))
         (pip-frame-delete-frame)
       (mapc #'delete-window windows-to-delete))))
@@ -164,7 +207,9 @@ custom option but it can be overriden here."
     map))
   
 (defun pip-frame-move ()
-  ""
+  "Move PIP frame interactively.
+Use arrow keys to move the frame around.
+Any other key stops this command and executes its own command."
   (interactive)
   (message "Use arrow keys to move the frame, any other key to quit")
   (set-transient-map pip-frame-move-map t))