3 ;; Copyright (C) 1998 by Darryl Okahata
5 ;; Author: Darryl Okahata <darrylo@sr.hp.com>
8 ;; This file is part of XEmacs.
10 ;; XEmacs is free software; you can redistribute it and/or modify it
11 ;; under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; XEmacs is distributed in the hope that it will be useful, but
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ;; General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25 ;;; Synched up with: Not in FSF
27 (require 'package-get) ;; which, in turn, requires 'package-admin
29 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 ;; User-changeable variables:
31 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
34 "Conventient interface to the package system."
36 :tag "Package User interface"
39 (defcustom pui-package-install-dest-dir nil
40 "*If non-nil (Automatic) path to package tree to install packages in.
41 Otherwise, use old path for installed packages and make a guess for
44 :tag "Install Location"
45 :type '(choice (const :tag "Automatic" nil)
48 (defcustom pui-list-verbose t
49 "*If non-nil, display verbose info in the package list buffer."
51 :tag "Verbose Listing"
54 (defcustom pui-up-to-date-package-face nil
55 "*The face to use for packages that are up-to-date."
59 (defcustom pui-selected-package-face 'bold
60 "*The face to use for selected packages.
61 Set this to `nil' to use the `default' face."
65 (defcustom pui-deleted-package-face 'blue
66 "*The face to use for packages marked for removal.
67 Set this to `nil' to use the `default' face."
71 (defcustom pui-outdated-package-face 'red
72 "*The face to use for outdated packages.
73 Set this to `nil' to use the `default' face."
77 (defcustom pui-uninstalled-package-face 'italic
78 "*The face to use for uninstalled packages.
79 Set this to `nil' to use the `default' face."
86 (defvar pui-info-buffer "*Packages*"
87 "Buffer to use for displaying package information.")
89 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
90 ;; End of user-changeable variables.
91 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
93 (defvar pui-selected-packages nil
94 "The list of user-selected packages to install.")
96 (defvar pui-deleted-packages nil
97 "The list of user-selected packages to remove.")
99 (defvar pui-actual-package "")
101 (defvar pui-display-keymap
102 (let ((m (make-keymap)))
104 (set-keymap-name m 'pui-display-keymap)
105 (define-key m "q" 'pui-quit)
106 (define-key m "g" 'pui-list-packages)
107 (define-key m "i" 'pui-display-info)
108 (define-key m "?" 'describe-mode)
109 (define-key m "v" 'pui-toggle-verbosity-redisplay)
110 (define-key m "d" 'pui-toggle-package-delete-key)
111 (define-key m "D" 'pui-toggle-package-delete-key)
112 (define-key m [return] 'pui-toggle-package-key)
113 (define-key m "x" 'pui-install-selected-packages)
114 (define-key m "I" 'pui-install-selected-packages)
115 (define-key m "r" 'pui-add-required-packages)
116 (define-key m "n" 'next-line)
117 (define-key m "+" 'pui-toggle-package-key)
118 (define-key m "p" 'previous-line)
119 (define-key m " " 'scroll-up-command)
120 (define-key m [delete] 'scroll-down-command)
122 "Keymap to use in the `pui-info-buffer' buffer")
124 (defvar pui-package-keymap
125 (let ((m (make-sparse-keymap)))
126 (set-keymap-name m 'pui-package-keymap)
127 (define-key m 'button2 'pui-toggle-package-event)
128 ;; We use a popup menu
129 (define-key m 'button3 'pui-popup-context-sensitive)
131 "Keymap to use over package names/descriptions.")
133 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
137 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
138 ;; Configuration routines
140 (defun pui-directory-exists (dir)
141 "Check to see if DIR exists in `package-get-remote'."
143 (mapcar '(lambda (item)
144 (if (and (null (car item))
145 (string-equal (file-name-as-directory (car (cdr item)))
146 (file-name-as-directory dir)))
148 ) package-get-remote)
152 (defun pui-package-dir-list (buffer)
153 "In BUFFER, format the list of package binary paths."
154 (let ( (count 1) paths sys dir)
156 (buffer-disable-undo buffer)
157 (erase-buffer buffer)
158 (insert "Existing package binary paths:\n\n")
159 (setq paths package-get-remote)
161 (setq sys (car (car paths))
162 dir (car (cdr (car paths))))
163 (insert (format "%2s. " count))
166 (insert sys ":" dir))
168 (setq count (1+ count))
169 (setq paths (cdr paths))
171 (insert "\nThese are the places that will be searched for package binaries.\n")
172 (goto-char (point-min))
176 (defun package-ui-add-site (site)
177 "Add site to package-get-remote and possibly offer to update package list."
178 (let ((had-none (null package-get-remote)))
179 (push site package-get-remote)
180 (when (and had-none package-get-was-current
181 (y-or-n-p "Update Package list?"))
182 (setq package-get-was-current nil)
183 (package-get-require-base t)
184 (if (get-buffer pui-info-buffer)
185 (save-window-excursion
186 (pui-list-packages))))
187 (set-menubar-dirty-flag)))
191 (defun pui-add-install-directory (dir)
192 "Add a new package binary directory to the head of `package-get-remote'.
193 Note that no provision is made for saving any changes made by this function.
194 It exists mainly as a convenience for one-time package installations from
196 (interactive (let ( (tmpbuf (get-buffer-create
197 "*Existing Package Binary Paths*"))
199 (save-window-excursion
203 (pui-package-dir-list tmpbuf)
204 (display-buffer tmpbuf)
205 (setq dir (read-directory-name
206 "New package binary directory to add? "
214 (if (not (pui-directory-exists dir))
216 (setq package-get-remote (cons (list nil dir) package-get-remote))
217 (message "Package directory \"%s\" added." dir)
219 (message "Directory \"%s\" already exists in `package-get-remote'." dir))
222 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
223 ;; Package list/installer routines
229 (defun pui-package-symbol-char (pkg-sym version)
231 (if (package-get-info-find-package packages-package-list pkg-sym)
232 (let ((installed (package-get-key pkg-sym :version)))
233 (if (>= (if (stringp installed)
234 (string-to-number installed)
236 (if (stringp version)
237 (string-to-number version)
239 (list " " pui-up-to-date-package-face)
240 (list "*" pui-outdated-package-face)))
241 (list "-" pui-uninstalled-package-face))
244 (defun pui-update-package-display (extent &optional pkg-sym version)
245 "Update the package status for EXTENT.
246 If PKG-SYM or VERSION are not given, they are read from the extent.
247 These are used to determine whether or not the package is installed,
248 and whether or not it is up-to-date."
249 (let (buffer-read-only disp sym-char)
251 (setq pkg-sym (extent-property extent 'pui-package)))
253 (setq version (package-get-info-prop (extent-property extent 'pui-info)
255 (cond ((member pkg-sym pui-selected-packages)
256 (if pui-selected-package-face
257 (set-extent-face extent (get-face pui-selected-package-face))
258 (set-extent-face extent (get-face 'default)))
260 ((member pkg-sym pui-deleted-packages)
261 (if pui-deleted-package-face
262 (set-extent-face extent (get-face pui-deleted-package-face))
263 (set-extent-face extent (get-face 'default)))
266 (setq disp (pui-package-symbol-char pkg-sym version))
267 (setq sym-char (car disp))
269 (set-extent-face extent (get-face (car (cdr disp))))
270 (set-extent-face extent (get-face 'default)))))
272 (goto-char (extent-start-position extent))
275 (set-buffer-modified-p nil)
279 (defun pui-toggle-package (extent)
281 (setq pkg-sym (extent-property extent 'pui-package))
282 (if (member pkg-sym pui-selected-packages)
283 (setq pui-selected-packages
284 (delete pkg-sym pui-selected-packages))
285 (setq pui-selected-packages
286 (cons pkg-sym pui-selected-packages))
287 (setq pui-deleted-packages
288 (delete pkg-sym pui-deleted-packages)))
289 (pui-update-package-display extent pkg-sym)
292 (defun pui-toggle-package-key ()
293 "Select/unselect package for installation, using the keyboard."
296 (if (setq extent (extent-at (point) (current-buffer) 'pui))
298 (pui-toggle-package extent)
301 (error "No package under cursor!"))
304 (defun pui-toggle-package-delete (extent)
306 (setq pkg-sym (extent-property extent 'pui-package))
307 (if (member pkg-sym pui-deleted-packages)
308 (setq pui-deleted-packages
309 (delete pkg-sym pui-deleted-packages))
310 (setq pui-deleted-packages
311 (cons pkg-sym pui-deleted-packages))
312 (setq pui-seleted-packages
313 (delete pkg-sym pui-selected-packages)))
314 (pui-update-package-display extent pkg-sym)
318 (defun pui-toggle-package-delete-key ()
319 "Select/unselect package for removal, using the keyboard."
322 (if (setq extent (extent-at (point) (current-buffer) 'pui))
324 (pui-toggle-package-delete extent)
327 (error "No package under cursor!"))
330 (defun pui-current-package ()
331 (let ((extent (extent-at (point) (current-buffer) 'pui)))
333 (extent-property extent 'pui-package))))
335 (defun pui-toggle-package-event (event)
336 "Select/unselect package for installation, using the mouse."
338 (let* ( (ep (event-point event))
339 (buffer (window-buffer (event-window event)))
340 (extent (extent-at ep buffer 'pui-package))
342 (pui-toggle-package extent)
345 (defun pui-toggle-verbosity-redisplay ()
346 "Toggle verbose package info."
349 (setq pui-list-verbose (not pui-list-verbose))
353 (defun pui-install-selected-packages ()
354 "Install selected packages."
356 (let ( (tmpbuf "*Packages-To-Remove*") do-delete)
357 (when pui-deleted-packages
358 (save-window-excursion
359 (with-output-to-temp-buffer tmpbuf
360 (display-completion-list (sort
361 (mapcar '(lambda (pkg)
364 pui-deleted-packages)
366 :activate-callback nil
367 :help-string "Packages selected for removal:\n"
370 (setq tmpbuf (get-buffer-create tmpbuf))
371 (display-buffer tmpbuf)
372 (setq do-delete (yes-or-no-p "Remove these packages? "))
373 (kill-buffer tmpbuf))
375 (message "Deleting selected packages ...") (sit-for 0)
376 (mapcar (lambda (pkg)
377 (package-admin-delete-binary-package
378 pkg (package-admin-get-install-dir pkg nil)))
379 pui-deleted-packages)
380 (message "Packages deleted"))))
382 (let ( (tmpbuf "*Packages-To-Install*") do-install)
383 (if pui-selected-packages
385 ;; Don't change window config when asking the user if he really
386 ;; wants to install the packages. We do this to avoid messing up
387 ;; the window configuration if errors occur (we don't want to
388 ;; display random buffers in addition to the error buffer, if
389 ;; errors occur, which would normally be caused by display-buffer).
390 (save-window-excursion
391 (with-output-to-temp-buffer tmpbuf
392 (display-completion-list (sort
393 (mapcar '(lambda (pkg)
396 pui-selected-packages)
398 :activate-callback nil
399 :help-string "Packages selected for installation:\n"
402 (setq tmpbuf (get-buffer-create tmpbuf))
403 (display-buffer tmpbuf)
404 (setq do-install (y-or-n-p "Install these packages? "))
410 ;; Clear old temp buffer history
411 (set-buffer (get-buffer-create package-admin-temp-buffer))
412 (buffer-disable-undo package-admin-temp-buffer)
413 (erase-buffer package-admin-temp-buffer)
415 (message "Installing selected packages ...") (sit-for 0)
417 (mapcar (lambda (pkg)
418 (if (not (package-get pkg nil nil
419 pui-package-install-dest-dir))
421 pui-selected-packages)
425 (message "Packages installed")
431 (if pui-deleted-packages
433 (error "No packages have been selected!")))
436 (defun pui-add-required-packages ()
437 "Select packages required by those already selected for installation."
439 (let ((tmpbuf "*Required-Packages*") do-select)
440 (if pui-selected-packages
445 (package-get-key pkg :version))
447 (package-get-info-prop
448 (package-get-info-version
449 (package-get-info-find-package
450 package-get-base pkg) nil)
452 (if (or (null installed)
453 (< (if (stringp installed)
454 (string-to-number installed)
456 (if (stringp current)
457 (string-to-number current)
461 (package-get-dependencies pui-selected-packages)))))
462 ;; Don't change window config when asking the user if he really
463 ;; wants to add the packages. We do this to avoid messing up
464 ;; the window configuration if errors occur (we don't want to
465 ;; display random buffers in addition to the error buffer, if
466 ;; errors occur, which would normally be caused by display-buffer).
467 (save-window-excursion
468 (with-output-to-temp-buffer tmpbuf
469 (display-completion-list (sort
470 (mapcar #'(lambda (pkg)
474 :activate-callback nil
475 :help-string "Required packages:\n"
476 :completion-string t))
477 (setq tmpbuf (get-buffer-create tmpbuf))
478 (display-buffer tmpbuf)
479 (setq do-select (y-or-n-p "Select these packages? "))
480 (kill-buffer tmpbuf))
483 (setq pui-selected-packages
484 (union pui-selected-packages dependencies))
485 (map-extents #'(lambda (extent maparg)
486 (pui-update-package-display extent))
487 nil nil nil nil nil 'pui)
488 (message "added dependencies"))
490 (error "No packages have been selected!"))))
492 (defun pui-help-echo (extent &optional force-update)
493 "Display additional package info in the modeline.
494 EXTENT determines the package to display (the package information is
495 attached to the extent as properties)."
496 (let (pkg-sym info inst-ver auth-ver date maintainer)
497 (if (or force-update (not (current-message))
498 (string-match ".*: .*: " (current-message))
501 (setq pkg-sym (extent-property extent 'pui-package)
502 info (extent-property extent 'pui-info)
503 inst-ver (package-get-key pkg-sym :version)
504 auth-ver (package-get-info-prop info 'author-version)
505 date (package-get-info-prop info 'date)
506 maintainer (package-get-info-prop info 'maintainer))
510 (format "Author version: %-8s %11s: %s"
511 auth-ver date maintainer)
512 (format "%-6s: %-8s %11s: %s"
513 inst-ver auth-ver date maintainer))
517 (defun pui-display-info (&optional no-error event)
518 "Display additional package info in the modeline.
519 Designed to be called interactively (from a keypress)."
524 (if (setq extent (extent-at (point) (current-buffer) 'pui))
525 (message (pui-help-echo extent t))
528 (error "No package under cursor!")))
531 ;;; "Why is there no standard function to do this?"
532 (defun pui-popup-context-sensitive (event)
535 (set-buffer (event-buffer event))
536 (goto-char (event-point event))
537 (popup-menu pui-menu event)
538 ;; I agreee with dired.el this is seriously bogus.
539 (while (popup-menu-up-p)
540 (dispatch-event (next-event)))))
544 ["Toggle install " pui-toggle-package-key :active (pui-current-package) :suffix (format "`%s'" (or (pui-current-package) "..."))]
545 ["Toggle delete " pui-toggle-package-delete-key :active (pui-current-package) :suffix (format "`%s'" (or (pui-current-package) "..."))]
546 ["Info on" pui-display-info :active (pui-current-package) :suffix (format "`%s'" (or (pui-current-package) "..."))]
548 ["Add Required" pui-add-required-packages t]
549 ["Install/Remove Selected" pui-install-selected-packages t]
551 ["Verbose" pui-toggle-verbosity-redisplay
552 :active t :style toggle :selected pui-list-verbose]
553 ["Refresh" pui-list-packages t]
555 ["Quit" pui-quit t]))
558 (defun list-packages-mode ()
559 "Symbols in the leftmost column:
561 + The package is marked for installation.
562 - The package has not been installed.
563 D The package has been marked for deletion.
564 * The currently installed package is old, and a newer version is
569 `\\[pui-toggle-package-key]' to select/unselect the current package for installation.
570 `\\[pui-toggle-package-delete-key]' to select/unselect the current package for removal.
571 `\\[pui-add-required-packages]' to add any packages required by those selected.
572 `\\[pui-install-selected-packages]' to install/delete selected packages.
573 `\\[pui-display-info]' to display additional information about the package in the modeline.
574 `\\[pui-list-packages]' to refresh the package list.
575 `\\[pui-toggle-verbosity-redisplay]' to toggle between a verbose and non-verbose display.
576 `\\[pui-quit]' to kill this buffer.
578 (error "You cannot enter this mode directly. Use `pui-list-packages'"))
580 (put 'list-packages-mode 'mode-class 'special)
583 (defun pui-list-packages ()
584 "List all packages and package information.
585 The package name, version, and description are displayed. From the displayed
586 buffer, the user can see which packages are installed, which are not, and
587 which are out-of-date (a newer version is available). The user can then
588 select packages for installation via the keyboard or mouse."
590 (package-get-require-base t)
591 (let ( (outbuf (get-buffer-create pui-info-buffer))
592 (sep-string "===============================================================================\n")
594 (message "Creating package list ...") (sit-for 0)
596 (setq buffer-read-only nil)
597 (buffer-disable-undo outbuf)
598 (erase-buffer outbuf)
599 (kill-all-local-variables)
600 (use-local-map pui-display-keymap)
601 (setq major-mode 'list-packages-mode)
602 (setq mode-name "Packages")
603 (setq truncate-lines t)
605 (unless package-get-remote
607 Warning: No download sites specified. Package index may be out of date.
608 If you intend to install packages, specify download sites first.
613 (insert " Latest Installed
614 Package name Vers. Vers. Description
617 Package name Vers. Description
621 (mapcar '(lambda (pkg)
622 (let (pkg-sym info version desc
623 b e extent current-vers disp)
624 (setq pkg-sym (car pkg)
625 info (package-get-info-version (cdr pkg) nil))
626 (setq version (package-get-info-prop info 'version)
627 desc (package-get-info-prop info 'description))
629 (setq disp (pui-package-symbol-char pkg-sym
634 (setq current-vers (package-get-key pkg-sym :version))
637 (setq current-vers "-----") )
638 ( (stringp current-vers)
641 (string-to-number current-vers))) )
642 ( (numberp current-vers)
643 (setq current-vers (format "%.2f" current-vers)) )
646 (format "%s %-15s %-5.2f %-5s %s\n"
648 (if (stringp version)
649 (string-to-number version)
653 ;; (format "\t\t %-12s %s\n"
654 ;; (package-get-info-prop info 'author-version)
655 ;; (package-get-info-prop info 'date)
658 (insert (format "%s %-15s %-5s %s\n"
660 pkg-sym version desc)))
667 (setq extent (make-extent b e))
669 (set-extent-face extent (get-face (car (cdr disp))))
670 (set-extent-face extent (get-face 'default)))
671 (set-extent-property extent 'highlight t)
672 (set-extent-property extent 'pui t)
673 (set-extent-property extent 'pui-package pkg-sym)
674 (set-extent-property extent 'pui-info info)
675 (set-extent-property extent 'help-echo 'pui-help-echo)
676 (set-extent-property extent 'keymap pui-package-keymap)
677 )) (sort (copy-sequence package-get-base)
679 (string< (symbol-name (car a))
680 (symbol-name (car b)))
683 (insert (documentation 'list-packages-mode))
684 (set-buffer-modified-p nil)
685 (setq buffer-read-only t)
686 (pop-to-buffer outbuf)
687 (delete-other-windows)
689 (setq pui-selected-packages nil) ; Reset list
690 (setq pui-deleted-packages nil) ; Reset list
691 (when (featurep 'menubar)
692 (set-buffer-menubar current-menubar)
693 (add-submenu '() pui-menu)
694 (setq mode-popup-menu pui-menu))
696 ; (message (substitute-command-keys "Press `\\[pui-help]' for help."))
700 (defalias 'list-packages 'pui-list-packages)
702 (provide 'package-ui)
704 ;;; package-ui.el ends here