dframe.el 31.4 KB
Newer Older
1
;;; dframe --- dedicate frame support modes  -*- lexical-binding:t -*-
Chong Yidong's avatar
Chong Yidong committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1996-2019 Free Software Foundation, Inc.
Chong Yidong's avatar
Chong Yidong committed
4 5 6 7 8 9 10 11 12

;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: file, tags, tools

(defvar dframe-version "1.3"
  "The current version of the dedicated frame library.")

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Chong Yidong's avatar
Chong Yidong committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Chong Yidong's avatar
Chong Yidong committed
17 18 19 20 21 22 23

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Chong Yidong's avatar
Chong Yidong committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

;;; Commentary:
;;
;; This code was developed and maintained as a part of speedbar since 1996.
;; It became its own support utility in Aug 2000.
;;
;; Dedicated frame mode is an Emacs independent library for supporting
;; a program/buffer combination that resides in a dedicated frame.
;; Support of this nature requires several complex interactions with the
;; user which this library will provide, including:
;;
;; * Creation of a frame.  Positioned relatively.
;;   Includes a frame cache for User position caching.
;; * Switching between frames.
;; * Timed activities using idle-timers
;; * Frame/buffer killing hooks
;; * Mouse-3 position relative menu
;; * Mouse motion, help-echo hacks
43
;; * Mouse clicking, double clicking, & XEmacs image clicking hack
Chong Yidong's avatar
Chong Yidong committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
;; * Mode line hacking
;; * Utilities for use in a program covering:
;;    o keymap massage for some actions
;;    o working with an associated buffer
;;    o shift-click
;;    o detaching a frame
;;    o focus-shifting & optional frame jumping
;;    o currently active frame.
;;    o message/y-or-n-p
;;    o mouse set point
;;
;; To Use:
;; 1) (require 'dframe)
;; 2) Variable Setup:
;;   -frame-parameters -- Frame parameters for Emacs.
;;   -frame-plist -- Frame parameters for XEmacs.
;;   -- Not on parameter lists: They can optionally include width
;;      and height.  If width or height is not included, then it will
;;      be provided to match the originating frame.  In general,
;;      turning off the menu bar, mode line, and minibuffer can
;;      provide a smaller window, or more display area.
;;   -track-mouse-flag -- mouse tracking on/off specific to your tool.
;;   -update-flag -- app toggle for timer use.  Init from
;;     `dframe-have-timer-flag'.  This is nil for terminals, since
;;     updating a frame in a terminal is not useful to the user.
;;   -key-map -- Your keymap.  Call `dframe-update-keymap' on it.
;;   -buffer, -frame, -cached-frame -- Variables used to track your
;;     applications buffer, frame, or frame cache (when hidden).  See
;;     `dframe-frame-mode' for details.
;;   -before-delete-hook, -before-popup-hook, -after-create-hook --
;;     Hooks to have called.  The `-after-create-hook' probably wants
;;     to call a function which calls `dframe-reposition-frame' in an
;;     appropriate manner.
;; 3) Function Setup:
;;   your-frame-mode -- function to toggle your app frame on and off.
;;     its tasks are:
;;       a) create a buffer
;;       b) Call `dframe-frame-mode'.  (See its doc)
;;       c) If successful (your -frame variable has a value), call
;;          timer setup if applicable.
;;   your-frame-reposition- -- Function to call from after-create-hook to
Paul Eggert's avatar
Paul Eggert committed
85
;;     reposition your frame with `dframe-reposition-frame'.
Chong Yidong's avatar
Chong Yidong committed
86 87 88 89 90 91 92 93 94 95 96 97 98
;;   your-mode -- Set up the major mode of the buffer for your app.
;;     Set these variables: dframe-track-mouse-function,
;;                          dframe-help-echo-function,
;;                          dframe-mouse-click-function,
;;                          dframe-mouse-position-function.
;;   See speedbar's implementation of these functions.
;;    `speedbar-current-frame', `speedbar-get-focus', `speedbar-message',
;;    `speedbar-y-or-n-p', `speedbar-set-timer', `speedbar-click',
;;    `speedbar-position-cursor-on-line'
;; 4) Handling mouse clicks, and help text:
;;   dframe-track-mouse, dframe-help-echo-function --
;;    These variables need to be set to functions that display info
;;    based on the mouse's position.
Paul Eggert's avatar
Paul Eggert committed
99
;;   Text property 'help-echo, set to `dframe-help-echo', which will
Chong Yidong's avatar
Chong Yidong committed
100 101 102 103 104 105 106 107
;;    call `dframe-help-echo-function'.
;;   Have a `-click' function, it can call `dframe-quick-mouse' for
;;    positioning.  If the variable `dframe-power-click' is non-nil,
;;    then `shift' was held down during the click.

;;; Bugs
;;
;;  * The timer managers doesn't handle multiple different timeouts.
108
;;  * You can't specify continuous timeouts (as opposed to just idle timers.)
Chong Yidong's avatar
Chong Yidong committed
109

110 111 112
(defvar x-pointer-hand2)
(defvar x-pointer-top-left-arrow)

Chong Yidong's avatar
Chong Yidong committed
113 114 115 116
;;; Code:

;;; Compatibility functions
;;
117 118 119 120 121
(defalias 'dframe-frame-parameter
  (if (fboundp 'frame-parameter) 'frame-parameter
    (lambda (frame parameter)
      "Return FRAME's PARAMETER value."
      (cdr (assoc parameter (frame-parameters frame))))))
Chong Yidong's avatar
Chong Yidong committed
122 123 124 125 126 127 128 129 130


;;; Variables
;;
(defgroup dframe nil
  "Faces used in dframe."
  :prefix "dframe-"
  :group 'dframe)

131 132 133 134 135 136
(defvar dframe-have-timer-flag (if (fboundp 'display-graphic-p)
				   (display-graphic-p)
				 window-system)
  "Non-nil means that timers are available for this Emacs.
This is nil for terminals, since updating a frame in a terminal
is not useful to the user.")
Chong Yidong's avatar
Chong Yidong committed
137

138
(defcustom dframe-update-speed 1
139
  "Idle time in seconds needed before dframe will update itself.
Chong Yidong's avatar
Chong Yidong committed
140 141 142 143 144 145
Updates occur to allow dframe to display directory information
relevant to the buffer you are currently editing."
  :group 'dframe
  :type 'integer)

(defcustom dframe-activity-change-focus-flag nil
146
  "Non-nil means the selected frame will change based on activity.
Chong Yidong's avatar
Chong Yidong committed
147 148 149 150 151 152
Thus, if a file is selected for edit, the buffer will appear in the
selected frame and the focus will change to that frame."
  :group 'dframe
  :type 'boolean)

(defcustom dframe-after-select-attached-frame-hook nil
153
  "Hook run after dframe has selected the attached frame."
Chong Yidong's avatar
Chong Yidong committed
154 155 156 157
  :group 'dframe
  :type 'hook)

(defvar dframe-track-mouse-function nil
158
  "A function to call when the mouse is moved in the given frame.
Chong Yidong's avatar
Chong Yidong committed
159 160 161 162
Typically used to display info about the line under the mouse.")
(make-variable-buffer-local 'dframe-track-mouse-function)

(defvar dframe-help-echo-function nil
163
  "A function to call when help-echo is used in newer versions of Emacs.
Chong Yidong's avatar
Chong Yidong committed
164 165 166 167
Typically used to display info about the line under the mouse.")
(make-variable-buffer-local 'dframe-help-echo-function)

(defvar dframe-mouse-click-function nil
168
  "A function to call when the mouse is clicked.
Chong Yidong's avatar
Chong Yidong committed
169 170 171 172
Valid clicks are mouse 2, our double mouse 1.")
(make-variable-buffer-local 'dframe-mouse-click-function)

(defvar dframe-mouse-position-function nil
173
  "A function to call to position the cursor for a mouse click.")
Chong Yidong's avatar
Chong Yidong committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
(make-variable-buffer-local 'dframe-mouse-position-function)

(defvar dframe-power-click nil
  "Never set this by hand.  Value is t when S-mouse activity occurs.")

(defvar dframe-timer nil
  "The dframe timer used for updating the buffer.")
(make-variable-buffer-local 'dframe-timer)

(defvar dframe-attached-frame nil
  "The frame which started a frame mode.
This is the frame from which all interesting activities will go
for the mode using dframe.")
(make-variable-buffer-local 'dframe-attached-frame)

(defvar dframe-controlled nil
  "Is this buffer controlled by a dedicated frame.
Local to those buffers, as a function called that created it.")
(make-variable-buffer-local 'dframe-controlled)

(defun dframe-update-keymap (map)
  "Update the keymap MAP for dframe default bindings."
  ;; Frame control
  (define-key map "q" 'dframe-close-frame)
  (define-key map "Q" 'delete-frame)

  ;; Override switch to buffer to never hack our frame.
  (substitute-key-definition 'switch-to-buffer
			     'dframe-switch-buffer-attached-frame
			     map global-map)

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
  ;; mouse bindings so we can manipulate the items on each line
  ;; (define-key map [down-mouse-1] 'dframe-double-click)
  (define-key map [follow-link] 'mouse-face)
  (define-key map [mouse-2] 'dframe-click)
  ;; This is the power click for new frames, or refreshing a cache
  (define-key map [S-mouse-2] 'dframe-power-click)
  ;; This adds a small unnecessary visual effect
  ;;(define-key map [down-mouse-2] 'dframe-quick-mouse)

  (define-key map [down-mouse-3] 'dframe-popup-kludge)

  ;; This lets the user scroll as if we had a scrollbar... well maybe not
  (define-key map [mode-line mouse-2] 'dframe-mouse-hscroll)
  ;; another handy place users might click to get our menu.
  (define-key map [mode-line down-mouse-1]
    'dframe-popup-kludge)

  ;; We can't switch buffers with the buffer mouse menu.  Lets hack it.
  (define-key map [C-down-mouse-1] 'dframe-hack-buffer-menu)

  ;; Lastly, we want to track the mouse.  Play here
  (define-key map [mouse-movement] 'dframe-track-mouse))
Chong Yidong's avatar
Chong Yidong committed
227 228 229 230 231

(defun dframe-live-p (frame)
  "Return non-nil if FRAME is currently available."
  (and frame (frame-live-p frame) (frame-visible-p frame)))

232 233 234
(defvar x-sensitive-text-pointer-shape)
(defvar x-pointer-shape)

Chong Yidong's avatar
Chong Yidong committed
235 236 237 238 239 240 241 242 243 244 245 246
(defun dframe-frame-mode (arg frame-var cache-var buffer-var frame-name
			      local-mode-fn
			      &optional
			      parameters
			      delete-hook popup-hook create-hook
			      )
  "Manage a frame for an application, enabling it when ARG is positive.
FRAME-VAR is a variable used to cache the frame being used.
This frame is either resurrected, hidden, killed, etc based on
the value.
CACHE-VAR is a variable used to cache a cached frame.
BUFFER-VAR is a variable used to cache the buffer being used in dframe.
247
This buffer will have `dframe-frame-mode' run on it.
Chong Yidong's avatar
Chong Yidong committed
248 249 250
FRAME-NAME is the name of the frame to create.
LOCAL-MODE-FN is the function used to call this one.
PARAMETERS are frame parameters to apply to this dframe.
251 252 253 254 255 256 257 258 259
DELETE-HOOK is a hook to run when deleting a frame.
POPUP-HOOK is a hook to run before showing a frame.
CREATE-HOOK is a hook to run after creating a frame."
  (let ((conv-hook (lambda (val)
                     (let ((sym (make-symbol "hook")))
                       (set sym val) sym))))
    (if (consp delete-hook) (setq delete-hook (funcall conv-hook delete-hook)))
    (if (consp create-hook) (setq create-hook (funcall conv-hook create-hook)))
    (if (consp popup-hook)  (setq popup-hook  (funcall conv-hook popup-hook))))
Chong Yidong's avatar
Chong Yidong committed
260 261 262 263 264 265 266 267
  ;; toggle frame on and off.
  (if (not arg) (if (dframe-live-p (symbol-value frame-var))
		    (setq arg -1) (setq arg 1)))
  ;; Make sure the current buffer is set.
  (set-buffer (symbol-value buffer-var))
  ;; turn the frame off on neg number
  (if (and (numberp arg) (< arg 0))
      (progn
268
	(run-hooks delete-hook)
Chong Yidong's avatar
Chong Yidong committed
269 270 271 272 273 274 275 276
	(if (and (symbol-value frame-var)
		 (frame-live-p (symbol-value frame-var)))
	    (progn
	      (set cache-var (symbol-value frame-var))
	      (make-frame-invisible (symbol-value frame-var))))
	(set frame-var nil))
    ;; Set this as our currently attached frame
    (setq dframe-attached-frame (selected-frame))
277
    (run-hooks 'dframe-setup-hook)
278
    (run-hooks popup-hook)
Chong Yidong's avatar
Chong Yidong committed
279 280
    ;; Updated the buffer passed in to contain all the hacks needed
    ;; to make it work well in a dedicated window.
281
    (with-current-buffer (symbol-value buffer-var)
Chong Yidong's avatar
Chong Yidong committed
282 283 284
      ;; Declare this buffer a dedicated frame
      (setq dframe-controlled local-mode-fn)

285 286 287 288
      ;; Enable mouse tracking in emacs
      (if dframe-track-mouse-function
	  (set (make-local-variable 'track-mouse) t)) ;this could be messy.

Chong Yidong's avatar
Chong Yidong committed
289 290 291 292 293 294 295 296 297 298 299
      ;; Override `temp-buffer-show-hook' so that help and such
      ;; put their stuff into a frame other than our own.
      ;; Correct use of `temp-buffer-show-function': Bob Weiner
      (if (and (boundp 'temp-buffer-show-hook)
	       (boundp 'temp-buffer-show-function))
	  (progn (make-local-variable 'temp-buffer-show-hook)
		 (setq temp-buffer-show-hook temp-buffer-show-function)))
      (make-local-variable 'temp-buffer-show-function)
      (setq temp-buffer-show-function 'dframe-temp-buffer-show-function)
      ;; If this buffer is killed, we must make sure that we destroy
      ;; the frame the dedicated window is in.
300 301 302 303 304 305 306 307 308
      (add-hook 'kill-buffer-hook (lambda ()
                                    (let ((skilling (boundp 'skilling)))
                                      (if skilling
                                          nil
                                        (if dframe-controlled
                                            (progn
                                              (funcall dframe-controlled -1)
                                              (set buffer-var nil)
                                              )))))
309
		t t))
Chong Yidong's avatar
Chong Yidong committed
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
    ;; Get the frame to work in
    (if (frame-live-p (symbol-value cache-var))
	(progn
	  (set frame-var (symbol-value cache-var))
	  (make-frame-visible (symbol-value frame-var))
	  (select-frame (symbol-value frame-var))
	  (set-window-dedicated-p (selected-window) nil)
	  (if (not (eq (current-buffer) (symbol-value buffer-var)))
	      (switch-to-buffer (symbol-value buffer-var)))
	  (set-window-dedicated-p (selected-window) t)
	  (raise-frame (symbol-value frame-var))
	  )
      (if (frame-live-p (symbol-value frame-var))
	  (raise-frame (symbol-value frame-var))
	(set frame-var
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
	     (let* ((mh (dframe-frame-parameter dframe-attached-frame
						'menu-bar-lines))
		    (paramsa
		     ;; Only add a guessed height if one is not specified
		     ;; in the input parameters.
		     (if (assoc 'height parameters)
			 parameters
		       (append
			parameters
			(list (cons 'height (+ (or mh 0) (frame-height)))))))
		    (params
		     ;; Only add a guessed width if one is not specified
		     ;; in the input parameters.
		     (if (assoc 'width parameters)
			 paramsa
		       (append
			paramsa
			(list (cons 'width (frame-width))))))
		    (frame
		     (if (not (eq window-system 'x))
			 (make-frame params)
		       (let ((x-pointer-shape x-pointer-top-left-arrow)
			     (x-sensitive-text-pointer-shape
			      x-pointer-hand2))
			 (make-frame params)))))
	       frame))
Chong Yidong's avatar
Chong Yidong committed
351 352 353 354 355 356
	;; Put the buffer into the frame
	(save-excursion
	  (select-frame (symbol-value frame-var))
	  (switch-to-buffer (symbol-value buffer-var))
	  (set-window-dedicated-p (selected-window) t))
	;; Run hooks (like reposition)
357
	(run-hooks create-hook)
Chong Yidong's avatar
Chong Yidong committed
358 359 360 361 362 363 364 365 366
	;; Frame name
	(if (and (or (null window-system) (eq window-system 'pc))
		 (fboundp 'set-frame-name))
	    (save-window-excursion
	      (select-frame (symbol-value frame-var))
	      (set-frame-name frame-name)))
	;; On a terminal, raise the frame or the user will
	;; be confused.
	(if (not window-system)
367
	    (select-frame (symbol-value frame-var)))))))
Chong Yidong's avatar
Chong Yidong committed
368

369 370 371 372
;; Not defined in builds without X, but behind window-system test.
(declare-function x-display-pixel-width "xfns.c" (&optional terminal))
(declare-function x-display-pixel-height "xfns.c" (&optional terminal))

373
(defun dframe-reposition-frame (new-frame parent-frame location)
Chong Yidong's avatar
Chong Yidong committed
374
  "Move NEW-FRAME to be relative to PARENT-FRAME.
375
LOCATION can be one of `random', `left-right', `top-bottom', or
376
a cons cell indicating a position of the form (LEFT . TOP)."
377 378 379 380 381
  ;; Position dframe.
  ;; Do no positioning if not on a windowing system,
  (unless (or (not window-system) (eq window-system 'pc))
    (let* ((pfx (dframe-frame-parameter parent-frame 'left))
	   (pfy (dframe-frame-parameter parent-frame 'top))
382 383
	   (pfw (+ (tool-bar-pixel-width parent-frame)
		   (frame-pixel-width parent-frame)))
384 385 386 387
	   (pfh (frame-pixel-height parent-frame))
	   (nfw (frame-pixel-width new-frame))
	   (nfh (frame-pixel-height new-frame))
	   newleft newtop)
Chong Yidong's avatar
Chong Yidong committed
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
      ;; Rebuild pfx,pfy to be absolute positions.
      (setq pfx (if (not (consp pfx))
		    pfx
		  ;; If pfx is a list, that means we grow
		  ;; from a specific edge of the display.
		  ;; Convert that to the distance from the
		  ;; left side of the display.
		  (if (eq (car pfx) '-)
		      ;; A - means distance from the right edge
		      ;; of the display, or DW - pfx - framewidth
		      (- (x-display-pixel-width) (car (cdr pfx)) pfw)
		    (car (cdr pfx))))
	    pfy (if (not (consp pfy))
		    pfy
		  ;; If pfy is a list, that means we grow
		  ;; from a specific edge of the display.
		  ;; Convert that to the distance from the
		  ;; left side of the display.
		  (if (eq (car pfy) '-)
		      ;; A - means distance from the right edge
		      ;; of the display, or DW - pfx - framewidth
		      (- (x-display-pixel-height) (car (cdr pfy)) pfh)
410
		    (car (cdr pfy)))))
Chong Yidong's avatar
Chong Yidong committed
411
      (cond ((eq location 'right)
412
	     (setq newleft (+ pfx pfw 10)
Chong Yidong's avatar
Chong Yidong committed
413 414
		   newtop pfy))
	    ((eq location 'left)
415
	     (setq newleft (- pfx 10 nfw)
Chong Yidong's avatar
Chong Yidong committed
416 417 418 419 420 421 422 423
		   newtop pfy))
	    ((eq location 'left-right)
	     (setq newleft
		   ;; Decide which side to put it on.  200 is just a
		   ;; buffer for the left edge of the screen.  The
		   ;; extra 10 is just dressings for window
		   ;; decorations.
		   (let* ((left-guess (- pfx 10 nfw))
424
			  (right-guess (+ pfx pfw 10))
Chong Yidong's avatar
Chong Yidong committed
425 426 427 428 429 430 431 432
			  (left-margin left-guess)
			  (right-margin (- (x-display-pixel-width)
					   right-guess 5 nfw)))
		     (cond ((>= left-margin 0) left-guess)
			   ((>= right-margin 0) right-guess)
			   ;; otherwise choose side we overlap less
			   ((> left-margin right-margin) 0)
			   (t (- (x-display-pixel-width) nfw 5))))
433
		   newtop pfy))
Chong Yidong's avatar
Chong Yidong committed
434 435 436 437 438 439 440 441 442 443 444 445 446
	    ((eq location 'top-bottom)
	     (setq newleft pfx
		   newtop
		   ;; Try and guess if we should be on the top or bottom.
		   (let* ((top-guess (- pfy 15 nfh))
			  (bottom-guess (+ pfy 5 pfh))
			  (top-margin top-guess)
			  (bottom-margin (- (x-display-pixel-height)
					    bottom-guess 5 nfh)))
		     (cond ((>= top-margin 0) top-guess)
			   ((>= bottom-margin 0) bottom-guess)
			   ;; Choose a side to overlap the least.
			   ((> top-margin bottom-margin) 0)
447
			   (t (- (x-display-pixel-height) nfh 5))))))
Chong Yidong's avatar
Chong Yidong committed
448 449 450 451 452
	    ((consp location)
	     (setq newleft (or (car location) 0)
		   newtop (or (cdr location) 0)))
	    (t nil))
      (modify-frame-parameters new-frame
453 454
			       (list (cons 'left newleft)
				     (cons 'top newtop))))))
Chong Yidong's avatar
Chong Yidong committed
455 456

(defun dframe-detach (frame-var cache-var buffer-var)
Paul Eggert's avatar
Paul Eggert committed
457
  "Detach the frame in symbol FRAME-VAR.
Juanma Barranquero's avatar
Juanma Barranquero committed
458
CACHE-VAR and BUFFER-VAR are symbols as in `dframe-frame-mode'."
459
  (with-current-buffer (symbol-value buffer-var)
Chong Yidong's avatar
Chong Yidong committed
460 461 462 463 464
    (rename-buffer (buffer-name) t)
    (let ((oldframe (symbol-value frame-var)))
      (set buffer-var nil)
      (set frame-var nil)
      (set cache-var nil)
465
      ;; FIXME: Looks very suspicious.  Luckily this function is unused.
Chong Yidong's avatar
Chong Yidong committed
466
      (make-variable-buffer-local frame-var)
467
      (set frame-var oldframe))))
Chong Yidong's avatar
Chong Yidong committed
468 469

;;; Special frame event proxies
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
(defvar dframe-setup-hook nil
  "Used for setting frame special event bindings.")

(defun dframe-set-special-events ()
  (define-key special-event-map [make-frame-visible]
    'dframe-handle-make-frame-visible)
  (define-key special-event-map [iconify-frame]
    'dframe-handle-iconify-frame)
  (define-key special-event-map [delete-frame]
    'dframe-handle-delete-frame)
  ;; Only need to run once.
  (remove-hook 'dframe-setup-hook #'dframe-set-special-events))

(when (boundp 'special-event-map)
  (add-hook 'dframe-setup-hook #'dframe-set-special-events))
Chong Yidong's avatar
Chong Yidong committed
485 486 487 488 489 490 491 492 493 494 495 496 497

(defvar dframe-make-frame-visible-function nil
  "Function used when a dframe controlled frame is de-iconified.
The function must take an EVENT.")
(defvar dframe-iconify-frame-function nil
  "Function used when a dframe controlled frame is iconified.
The function must take an EVENT.")
(defvar dframe-delete-frame-function nil
  "Function used when a frame attached to a dframe frame is deleted.
The function must take an EVENT.")

(defun dframe-handle-make-frame-visible (e)
  "Handle a `make-frame-visible' event.
498
Should enable auto-updating if the last state was also enabled.
Chong Yidong's avatar
Chong Yidong committed
499 500 501 502 503 504 505 506 507 508
Argument E is the event making the frame visible."
  (interactive "e")
  (let ((f last-event-frame))
    (if (and (dframe-attached-frame f)
	     dframe-make-frame-visible-function)
	(funcall dframe-make-frame-visible-function e)
      )))

(defun dframe-handle-iconify-frame (e)
  "Handle a `iconify-frame' event.
509
Should disable auto-updating if the last state was also enabled.
Chong Yidong's avatar
Chong Yidong committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
Argument E is the event iconifying the frame."
  (interactive "e")
  (let ((f last-event-frame))
    (if (and (dframe-attached-frame f)
	     dframe-iconify-frame-function e)
	(funcall dframe-iconify-frame-function)
      )))

(defun dframe-handle-delete-frame (e)
  "Handle `delete-frame' event.
Argument E is the event deleting the frame."
  (interactive "e")
  (let ((fl (frame-list))
	(sf (selected-frame)))
    ;; Loop over all frames.  If dframe-delete-frame-function is
    ;; non-nil, call it.
    (while fl
      (select-frame (car fl))
      (if dframe-delete-frame-function
	  (funcall dframe-delete-frame-function e))
      (setq fl (cdr fl)))
    (if (frame-live-p sf)
	(select-frame sf))
    (handle-delete-frame e)))


;;; Utilities
;;
538
(defun dframe-get-focus (frame-var activator)
Chong Yidong's avatar
Chong Yidong committed
539 540 541 542
  "Change frame focus to or from a dedicated frame.
If the selected frame is not in the symbol FRAME-VAR, then FRAME-VAR
frame is selected.  If the FRAME-VAR is active, then select the
attached frame.  If FRAME-VAR is nil, ACTIVATOR is called to
543
created it."
Chong Yidong's avatar
Chong Yidong committed
544 545 546 547 548 549 550 551 552 553
  (interactive)
  (if (eq (selected-frame) (symbol-value frame-var))
      (if (frame-live-p dframe-attached-frame)
	  (dframe-select-attached-frame))
    ;; make sure we have a frame
    (if (not (frame-live-p (symbol-value frame-var)))
	(funcall activator 1))
    ;; go there
    (select-frame (symbol-value frame-var))
    )
554
  (other-frame 0))
Chong Yidong's avatar
Chong Yidong committed
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569


(defun dframe-close-frame ()
  "Close the current frame if it is dedicated."
  (interactive)
  (if dframe-controlled
      (let ((b (current-buffer)))
	(funcall dframe-controlled -1)
	(kill-buffer b))))

(defun dframe-current-frame (frame-var desired-major-mode)
  "Return the existing dedicated frame to use.
FRAME-VAR is the variable storing the currently active dedicated frame.
If the current frame's buffer uses DESIRED-MAJOR-MODE, then use that frame."
  (if (not (eq (selected-frame) (symbol-value frame-var)))
570
      (if (and (eq major-mode desired-major-mode)
Chong Yidong's avatar
Chong Yidong committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584
	       (get-buffer-window (current-buffer))
	       (window-frame (get-buffer-window (current-buffer))))
	  (window-frame (get-buffer-window (current-buffer)))
	(symbol-value frame-var))
    (symbol-value frame-var)))

(defun dframe-attached-frame (&optional frame)
  "Return the attached frame belonging to the dframe controlled frame FRAME.
If optional arg FRAME is nil just return `dframe-attached-frame'."
  (save-excursion
    (if frame (select-frame frame))
    dframe-attached-frame))

(defun dframe-select-attached-frame (&optional frame)
585 586 587 588
  "Switch to the frame the dframe controlled frame FRAME was started from.
If optional arg FRAME is nil assume the attached frame is already selected
and just run the hooks `dframe-after-select-attached-frame-hook'.  Return
the attached frame."
Chong Yidong's avatar
Chong Yidong committed
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
  (let ((frame (dframe-attached-frame frame)))
    (if frame (select-frame frame))
    (prog1 frame
      (run-hooks 'dframe-after-select-attached-frame-hook))))

(defmacro dframe-with-attached-buffer (&rest forms)
  "Execute FORMS in the attached frame's special buffer.
Optionally select that frame if necessary."
  `(save-selected-window
     ;;(speedbar-set-timer speedbar-update-speed)
     (dframe-select-attached-frame)
     ,@forms
     (dframe-maybee-jump-to-attached-frame)))

(defun dframe-maybee-jump-to-attached-frame ()
  "Jump to the attached frame ONLY if this was not a mouse event."
  (when (or (not (dframe-mouse-event-p last-input-event))
            dframe-activity-change-focus-flag)
    (dframe-select-attached-frame)
608
    ;; KB: For what is this - raising the frame??
Chong Yidong's avatar
Chong Yidong committed
609 610 611 612 613 614 615
    (other-frame 0)))


(defvar dframe-suppress-message-flag nil
  "Non-nil means that `dframe-message' should just return a string.")

(defun dframe-message (fmt &rest args)
616
  "Like `message', but for use in a dedicated frame.
Chong Yidong's avatar
Chong Yidong committed
617 618 619
Argument FMT is the format string, and ARGS are the arguments for message."
  (save-selected-window
    (if dframe-suppress-message-flag
620
	(apply #'format-message fmt args)
Chong Yidong's avatar
Chong Yidong committed
621 622 623
      (if dframe-attached-frame
          ;; KB: Here we do not need calling `dframe-select-attached-frame'
	  (select-frame dframe-attached-frame))
624
      (apply #'message fmt args))))
Chong Yidong's avatar
Chong Yidong committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650

(defun dframe-y-or-n-p (prompt)
  "Like `y-or-n-p', but for use in a dedicated frame.
Argument PROMPT is the prompt to use."
  (save-selected-window
    (if (and ;;default-minibuffer-frame
	     dframe-attached-frame
	     ;;(not (eq default-minibuffer-frame dframe-attached-frame))
	     )
        ;; KB: Here we do not need calling `dframe-select-attached-frame'
	(select-frame dframe-attached-frame))
    (y-or-n-p prompt)))

;;; timer management
;;
;; Unlike speedbar with a dedicated set of routines, dframe has one master
;; timer, and all dframe users will use it.  At least until I figure out a way
;; around that problem.
;;
;; Advantage 1: Two apps with timer/frames can munge the master list
;;              to make sure they occur in order.
;; Advantage 2: If a user hits a key between timer functions, we can
;;	        interrupt them safely.
(defvar dframe-client-functions nil
  "List of client functions using the dframe timer.")

651
(defun dframe-set-timer (timeout fn &optional _null-on-error)
Chong Yidong's avatar
Chong Yidong committed
652
  "Apply a timer with TIMEOUT, to call FN, or remove a timer if TIMEOUT is nil.
Paul Eggert's avatar
Paul Eggert committed
653
TIMEOUT is the number of seconds until the dframe controlled program
Chong Yidong's avatar
Chong Yidong committed
654 655
timer is called again.  When TIMEOUT is nil, turn off all timeouts.
This function must be called from the buffer belonging to the program
656
who requested the timer.  NULL-ON-ERROR is ignored."
Chong Yidong's avatar
Chong Yidong committed
657 658 659 660
  ;; First, fix up our list of client functions
  (if timeout
      (add-to-list 'dframe-client-functions fn)
    (setq dframe-client-functions (delete fn dframe-client-functions)))
Paul Eggert's avatar
Paul Eggert committed
661
  ;; Now decided what to do about the timeout.
Chong Yidong's avatar
Chong Yidong committed
662 663 664 665 666 667 668
  (if (or
       ;; We have a timer, restart the timer with the new time.
       timeout
       ;; We have a timer, an off is requested, and no client
       ;; functions are left, shut er down.
       (and dframe-timer (not timeout) dframe-client-functions))
      ;; Only call the low level function if we are changing the state.
669
      (dframe-set-timer-internal timeout)))
Chong Yidong's avatar
Chong Yidong committed
670

671
(defun dframe-set-timer-internal (timeout &optional _null-on-error)
672 673
  "Apply a timer with TIMEOUT to call the dframe timer manager."
  (when dframe-timer
674
    (cancel-timer dframe-timer)
675 676
    (setq dframe-timer nil))
  (when timeout
677
    (setq dframe-timer (run-with-idle-timer timeout t 'dframe-timer-fn))))
Chong Yidong's avatar
Chong Yidong committed
678 679 680 681 682 683

(defun dframe-timer-fn ()
  "Called due to the dframe timer.
Evaluates all cached timer functions in sequence."
  (let ((l dframe-client-functions))
    (while (and l (sit-for 0))
684 685
      (with-demoted-errors "DFRAME TIMER ERROR: %S"
	(funcall (car l)))
Chong Yidong's avatar
Chong Yidong committed
686 687
      (setq l (cdr l)))))

688
(defalias 'dframe-popup-kludge
689 690
  (lambda (e)
    "Pop up a menu related to the clicked on item.
Chong Yidong's avatar
Chong Yidong committed
691
Must be bound to event E."
692 693 694 695 696 697 698
    (interactive "e")
    (save-excursion
      (mouse-set-point e)
      ;; This gets the cursor where the user can see it.
      (if (not (bolp)) (forward-char -1))
      (sit-for 0)
      (popup-menu (mouse-menu-major-mode-map) e))))
Chong Yidong's avatar
Chong Yidong committed
699 700 701

;;; Interactive user functions for the mouse
;;
702
(defalias 'dframe-mouse-event-p
703 704 705 706 707 708 709
  (lambda (event)
    "Return t if the event is a mouse related event."
    (if (and (listp event)
             (member (event-basic-type event)
                     '(mouse-1 mouse-2 mouse-3)))
        t
      nil)))
Chong Yidong's avatar
Chong Yidong committed
710 711 712 713 714

(defun dframe-track-mouse (event)
  "For motion EVENT, display info about the current line."
  (interactive "e")
  (when (and dframe-track-mouse-function
715
	     (windowp (posn-window (event-end event)))) ; Sometimes
Chong Yidong's avatar
Chong Yidong committed
716 717 718
					; there is no window to jump into.
    (funcall dframe-track-mouse-function event)))

719
(defun dframe-help-echo (_window &optional buffer position)
Chong Yidong's avatar
Chong Yidong committed
720
  "Display help based context.
721
The context is in WINDOW, viewing BUFFER, at POSITION."
Chong Yidong's avatar
Chong Yidong committed
722 723 724 725 726
  (when (and (not dframe-track-mouse-function)
	     (bufferp buffer)
	     dframe-help-echo-function)
    (let ((dframe-suppress-message-flag t))
      (with-current-buffer buffer
727 728 729
	(save-excursion
	  (if position (goto-char position))
	  (funcall dframe-help-echo-function))))))
Chong Yidong's avatar
Chong Yidong committed
730 731

(defun dframe-mouse-set-point (e)
732 733
  "Set point based on event E."
  (mouse-set-point e))
Chong Yidong's avatar
Chong Yidong committed
734 735 736 737 738 739 740 741 742 743

(defun dframe-quick-mouse (e)
  "Since mouse events are strange, this will keep the mouse nicely positioned.
This should be bound to mouse event E."
  (interactive "e")
  (dframe-mouse-set-point e)
  (if dframe-mouse-position-function
      (funcall dframe-mouse-position-function)))

(defun dframe-power-click (e)
744
  "Activate any dframe mouse click as a power click.
Chong Yidong's avatar
Chong Yidong committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
A power click will dispose of cached data (if available) or bring a buffer
up into a different window.
This should be bound to mouse event E."
  (interactive "e")
  (let ((dframe-power-click t))
    (select-frame last-event-frame)
    (dframe-click e)))

(defun dframe-click (e)
  "Call our clients click function on a user click.
E is the event causing the click."
  (interactive "e")
  (dframe-mouse-set-point e)
  (when dframe-mouse-click-function
    ;; On the off chance of buffer switch, or something incorrectly
    ;; configured.
    (funcall dframe-mouse-click-function e)))

(defun dframe-double-click (e)
  "Activate the registered click function on a double click.
This must be bound to a mouse event.
This should be bound to mouse event E."
  (interactive "e")
  (cond ((eq (car e) 'down-mouse-1)
	 (dframe-mouse-set-point e))
	((eq (car e) 'mouse-1)
	 (dframe-quick-mouse e))
	((or (eq (car e) 'double-down-mouse-1)
	     (eq (car e) 'triple-down-mouse-1))
	 (dframe-click e))))

;;; Hacks of normal things.
;;
;; Some normal things that happen in one of these dedicated frames
;; must be handled specially, so that our dedicated frame isn't
;; messed up.
(defun dframe-temp-buffer-show-function (buffer)
  "Placed in the variable `temp-buffer-show-function' in dedicated frames.
If a user requests help using \\[help-command] <Key> the temp BUFFER will be
redirected into a window on the attached frame."
  (if dframe-attached-frame (dframe-select-attached-frame))
  (pop-to-buffer buffer nil)
  (other-window -1)
788
  (run-hooks 'temp-buffer-show-hook))
Chong Yidong's avatar
Chong Yidong committed
789

790
(defun dframe-hack-buffer-menu (_e)
Chong Yidong's avatar
Chong Yidong committed
791 792 793 794 795
  "Control mouse 1 is buffer menu.
This hack overrides it so that the right thing happens in the main
Emacs frame, not in the dedicated frame.
Argument E is the event causing this activity."
  (interactive "e")
796
  (let ((fn (lookup-key global-map [C-down-mouse-1]))
Chong Yidong's avatar
Chong Yidong committed
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
	(oldbuff (current-buffer))
	(newbuff nil))
    (unwind-protect
	(save-excursion
	  (set-window-dedicated-p (selected-window) nil)
	  (call-interactively fn)
	  (setq newbuff (current-buffer)))
      (switch-to-buffer oldbuff)
      (set-window-dedicated-p (selected-window) t))
    (if (not (eq newbuff oldbuff))
	(dframe-with-attached-buffer
	 (switch-to-buffer newbuff)))))

(defun dframe-switch-buffer-attached-frame (&optional buffer)
  "Switch to BUFFER in the attached frame, and raise that frame.
This overrides the default behavior of `switch-to-buffer' which is
broken because of the dedicated frame."
  (interactive)
  ;; Assume we are in the dedicated frame.
  (other-frame 1)
  ;; Now switch buffers
  (if buffer
      (switch-to-buffer buffer)
    (call-interactively 'switch-to-buffer nil nil)))

(defun dframe-mouse-hscroll (e)
  "Read a mouse event E from the mode line, and horizontally scroll.
824 825
If the mouse is being clicked on the far left, or far right of
the mode-line."
Chong Yidong's avatar
Chong Yidong committed
826 827 828 829
  (interactive "e")
  (let* ((x-point (car (nth 2 (car (cdr e)))))
	 (pixels-per-10-col (/ (* 10 (frame-pixel-width))
			       (frame-width)))
830
	 (click-col (1+ (/ (* 10 x-point) pixels-per-10-col))))
Chong Yidong's avatar
Chong Yidong committed
831 832 833 834 835
    (cond ((< click-col 3)
	   (scroll-left 2))
	  ((> click-col (- (window-width) 5))
	   (scroll-right 2))
	  (t (dframe-message
836
	      "Click on the edge of the mode line to scroll left/right")))))
Chong Yidong's avatar
Chong Yidong committed
837 838 839 840

(provide 'dframe)

;;; dframe.el ends here