X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=lsdb.el;h=24f2f6736ba5d166c57a5c6013f0e37e6aac62ca;hb=3a24afba91883fdc132610e34b2067488dc3448e;hp=8391f1ca4f1d4c094946ffcfdd23dca4c5be254a;hpb=fb81740331b97c490a4986e4237cbbc95b99ae38;p=elisp%2Flsdb.git diff --git a/lsdb.el b/lsdb.el index 8391f1c..24f2f67 100644 --- a/lsdb.el +++ b/lsdb.el @@ -31,6 +31,9 @@ ;;; (add-hook 'message-setup-hook ;;; (lambda () ;;; (define-key message-mode-map "\M-\t" 'lsdb-complete-name))) +;;; (add-hook 'gnus-summary-mode-hook +;;; (lambda () +;;; (define-key gnus-summary-mode-map ":" 'lsdb-toggle-buffer))) ;;; For Wanderlust, put the following lines into your ~/.wl: ;;; (require 'lsdb) @@ -38,12 +41,26 @@ ;;; (add-hook 'wl-draft-mode-hook ;;; (lambda () ;;; (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name))) +;;; (add-hook 'wl-summary-mode-hook +;;; (lambda () +;;; (define-key wl-summary-mode-map ":" 'lsdb-wl-toggle-buffer))) + +;;; For Mew, put the following lines into your ~/.mew: +;;; (autoload 'lsdb-mew-insinuate "lsdb") +;;; (add-hook 'mew-init-hook 'lsdb-mew-insinuate) +;;; (add-hook 'mew-draft-mode-hook +;;; (lambda () +;;; (define-key mew-draft-header-map "\M-I" 'lsdb-complete-name))) +;;; (add-hook 'mew-summary-mode-hook +;;; (lambda () +;;; (define-key mew-summary-mode-map "l" 'lsdb-toggle-buffer))) ;;; Code: (require 'poem) (require 'pces) (require 'mime) +(require 'static) ;;;_* USER CUSTOMIZATION VARIABLES: (defgroup lsdb nil @@ -75,8 +92,11 @@ (defcustom lsdb-interesting-header-alist '(("Organization" nil organization) - ("\\(X-\\)?User-Agent\\|X-Mailer" nil user-agent) + ("\\(X-\\)?User-Agent\\|X-Mailer\\|X-Newsreader" nil user-agent) ("\\(X-\\)?ML-Name" nil mailing-list) + ("List-Id" "\\(.*\\)[ \t]+<[^>]+>\\'" mailing-list "\\1") + ("X-Sequence" "\\(.*\\)[ \t]+[0-9]+\\'" mailing-list "\\1") + ("Delivered-To" "mailing list[ \t]+\\([^@]+\\)@.*" mailing-list "\\1") ("\\(X-URL\\|X-URI\\)" nil www) ("X-Attribution\\|X-cite-me" nil attribution) ("X-Face" nil x-face)) @@ -89,18 +109,25 @@ where the last three elements are optional." (defcustom lsdb-entry-type-alist '((net 5 ?,) - (creation-date 2) - (last-modified 3) + (creation-date 2 ?. t) + (last-modified 3 ?. t) (mailing-list 4 ?,) (attribution 4 ?.) (organization 4) - (www 1) + (www 4) + (aka 4 ?,) (score -1) (x-face -1)) - "Alist of entries to display. + "Alist of entry types for presentation. The format of elements of this list should be - (ENTRY SCORE CLASS) -where the last element is optional." + (ENTRY SCORE [CLASS READ-ONLY]) +where the last two elements are optional. +Possible values for CLASS are `?.' and '?,'. If CLASS is `?.', the +entry takes a unique value which is overridden by newly assigned one +by `lsdb-mode-edit-entry' or such a command. If CLASS is `?,', the +entry can have multiple values separated by commas. +If the fourth element READ-ONLY is non-nil, it is assumed that the +entry cannot be modified." :group 'lsdb :type 'list) @@ -115,29 +142,73 @@ where the last element is optional." :group 'lsdb :type 'function) +(defcustom lsdb-lookup-full-name-functions + '(lsdb-lookup-full-name-from-address-cache) + "List of functions to pick up the existing full-name of the sender. +The sender is passed to each function as the argument." + :group 'lsdb + :type 'hook) + +(defcustom lsdb-update-record-functions + '(lsdb-update-address-cache) + "List of functions called after a record is updated. +The updated record is passed to each function as the argument." + :group 'lsdb + :type 'hook) + +(defcustom lsdb-secondary-hash-tables + '(lsdb-address-cache) + "List of the hash tables for reverse lookup" + :group 'lsdb + :type 'list) + (defcustom lsdb-window-max-height 7 "Maximum number of lines used to display LSDB record." :group 'lsdb :type 'integer) +(defcustom lsdb-x-face-image-type nil + "A image type of displayed x-face. +If non-nil, supersedes the return value of `lsdb-x-face-available-image-type'." + :group 'lsdb + :type 'symbol) + +(defcustom lsdb-x-face-command-alist + '((pbm "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | pnmscale 0.5") + (xpm "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | pnmscale 0.5 | ppmtoxpm")) + "An alist from an image type to a command to be executed to display an X-Face header. +The command will be executed in a sub-shell asynchronously. +The compressed face will be piped to this command." + :group 'lsdb + :type 'list) + (defcustom lsdb-insert-x-face-function - (if (and (>= emacs-major-version 21) - (locate-library "x-face-e21")) - #'lsdb-insert-x-face-with-x-face-e21 - (if (and (featurep 'xemacs) - (memq 'xface (image-instantiator-format-list))) - #'lsdb-insert-x-face-with-xemacs-glyph)) + (if (static-if (featurep 'xemacs) + (featurep 'xpm) + (and (>= emacs-major-version 21) + (fboundp 'image-type-available-p) + (or (image-type-available-p 'pbm) + (image-type-available-p 'xpm)))) + #'lsdb-insert-x-face-asynchronously) "Function to display X-Face." :group 'lsdb :type 'function) -(defcustom lsdb-display-record-hook - (if lsdb-insert-x-face-function - #'lsdb-expose-x-face) +(defcustom lsdb-print-record-hook '(lsdb-expose-x-face) "A hook called after a record is displayed." :group 'lsdb :type 'hook) +(defcustom lsdb-display-records-sort-predicate nil + "A predicate to sort records." + :group 'lsdb + :type 'function) + +(defcustom lsdb-pop-up-windows t + "Non-nil means LSDB should make new windows to display records." + :group 'lsdb + :type 'boolean) + (defgroup lsdb-edit-form nil "A mode for editing forms." :group 'lsdb) @@ -147,6 +218,17 @@ where the last element is optional." :group 'lsdb-edit-form :type 'hook) +(defcustom lsdb-shell-file-name "/bin/sh" + "File name to load inferior shells from. +Bourne shell or its equivalent \(not tcsh) is needed for \"2>\"." + :group 'lsdb + :type 'string) + +(defcustom lsdb-shell-command-switch "-c" + "Switch used to have the shell execute its command line argument." + :group 'lsdb + :type 'string) + ;;;_. Faces (defface lsdb-header-face '((t (:underline t))) @@ -186,16 +268,26 @@ where the last element is optional." (defvar lsdb-hash-table nil "Internal hash table to hold LSDB records.") +(defvar lsdb-address-cache nil + "The reverse lookup table for `lsdb-hash-table'. +It represents address to full-name mapping.") + (defvar lsdb-buffer-name "*LSDB*" "Buffer name to display LSDB record.") -(defvar lsdb-hash-table-is-dirty nil - "Flag to indicate whether the hash table needs to be saved.") +(defvar lsdb-hash-tables-are-dirty nil + "Flag to indicate whether the internal hash tables need to be saved.") (defvar lsdb-known-entry-names (make-vector 29 0) "An obarray used to complete an entry name.") +(defvar lsdb-temp-buffer-show-function + #'lsdb-temp-buffer-show-function + "Non-nil means call as function to display a help buffer. +The function is called with one argument, the buffer to be displayed. +Overrides `temp-buffer-show-function'.") + ;;;_. Hash Table Emulation (if (and (fboundp 'make-hash-table) (subrp (symbol-function 'make-hash-table))) @@ -255,61 +347,104 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (list 0 (make-vector (or (plist-get args :size) 29) 0)))) ;;;_. Hash Table Reader/Writer +(defconst lsdb-secondary-hash-table-start-format + ";;; %S\n") + +(defsubst lsdb-secondary-hash-table-start (hash-table) + (format lsdb-secondary-hash-table-start-format hash-table)) + (eval-and-compile (condition-case nil (progn ;; In XEmacs, hash tables can also be created by the lisp reader ;; using structure syntax. (read-from-string "#s(hash-table)") - (defun lsdb-load-file (file) - "Read the contents of FILE into a hash table." - (let ((buffer (find-file-noselect file))) - (unwind-protect - (save-excursion - (set-buffer buffer) - (re-search-forward "^#s") - (beginning-of-line) - (read (point-min-marker))) - (kill-buffer buffer))))) + (defalias 'lsdb-read 'read)) (invalid-read-syntax - (defun lsdb-load-file (file) - "Read the contents of FILE into a hash table." - (let* ((plist - (with-temp-buffer - (insert-file-contents file) - (save-excursion - (re-search-forward "^#s") - (replace-match "") - (beginning-of-line) - (cdr (read (point-marker)))))) - (size (plist-get plist 'size)) - (data (plist-get plist 'data)) - (hash-table (lsdb-make-hash-table :size size :test 'equal))) - (while data - (lsdb-puthash (pop data) (pop data) hash-table)) - hash-table))))) - -(defun lsdb-save-file (file hash-table) - "Write the entries within HASH-TABLE into FILE." - (let ((coding-system-for-write lsdb-file-coding-system)) - (with-temp-file file + (defun lsdb-read (&optional marker) + "Read one Lisp expression as text from MARKER, return as Lisp object." + (save-excursion + (goto-char marker) + (if (looking-at "^#s(") + (with-temp-buffer + (buffer-disable-undo) + (insert-buffer-substring (marker-buffer marker) marker) + (goto-char (point-min)) + (delete-char 2) + (let ((object (read (current-buffer))) + hash-table data) + (if (eq 'hash-table (car object)) + (progn + (setq hash-table + (lsdb-make-hash-table + :size (plist-get (cdr object) 'size) + :test 'equal) + data (plist-get (cdr object) 'data)) + (while data + (lsdb-puthash (pop data) (pop data) hash-table)) + hash-table) + object))))))))) + +(defun lsdb-load-hash-tables () + "Read the contents of `lsdb-file' into the internal hash tables." + (let ((buffer (find-file-noselect lsdb-file)) + tables) + (unwind-protect + (save-excursion + (set-buffer buffer) + (goto-char (point-min)) + (re-search-forward "^#s(") + (goto-char (match-beginning 0)) + (setq lsdb-hash-table (lsdb-read (point-marker))) + ;; Load the secondary hash tables following. + (setq tables lsdb-secondary-hash-tables) + (while tables + (if (re-search-forward + (concat "^" (lsdb-secondary-hash-table-start + (car tables))) + nil t) + (set (car tables) (lsdb-read (point-marker)))) + (setq tables (cdr tables)))) + (kill-buffer buffer)))) + +(defun lsdb-insert-hash-table (hash-table) + (insert "#s(hash-table size " + ;; Reduce the actual size of the close hash table, because + ;; XEmacs doesn't have a distinction between index-size and + ;; hash-table-size. + (number-to-string (lsdb-hash-table-count hash-table)) + " test equal data (") + (lsdb-maphash + (lambda (key value) + (insert (prin1-to-string key) " " (prin1-to-string value) " ")) + hash-table) + (insert "))")) + +(defun lsdb-save-hash-tables () + "Write the records within the internal hash tables into `lsdb-file'." + (let ((coding-system-for-write lsdb-file-coding-system) + tables) + (with-temp-file lsdb-file (if (and (or (featurep 'mule) (featurep 'file-coding)) lsdb-file-coding-system) - (insert ";;; -*- coding: " - (if (symbolp lsdb-file-coding-system) - (symbol-name lsdb-file-coding-system) - ;; XEmacs - (symbol-name (coding-system-name lsdb-file-coding-system))) - " -*-\n")) - (insert "#s(hash-table size " - (number-to-string (lsdb-hash-table-size hash-table)) - " test equal data (") - (lsdb-maphash - (lambda (key value) - (insert (prin1-to-string key) " " (prin1-to-string value) " ")) - hash-table) - (insert "))")))) + (let ((coding-system-name + (if (symbolp lsdb-file-coding-system) + (symbol-name lsdb-file-coding-system) + ;; XEmacs + (static-if (featurep 'xemacs) + (symbol-name (coding-system-name + lsdb-file-coding-system)))))) + (if coding-system-name + (insert ";;; -*- coding: " coding-system-name " -*-\n")))) + (lsdb-insert-hash-table lsdb-hash-table) + ;; Save the secondary hash tables following. + (setq tables lsdb-secondary-hash-tables) + (while tables + (insert "\n" (lsdb-secondary-hash-table-start + (car tables))) + (lsdb-insert-hash-table (symbol-value (car tables))) + (setq tables (cdr tables)))))) ;;;_. Mail Header Extraction (defun lsdb-fetch-field-bodies (regexp) @@ -332,11 +467,15 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (defun lsdb-extract-address-components (string) (let ((components (std11-extract-address-components string))) - (if (nth 1 components) + (if (and (nth 1 components) + ;; When parsing a group address, + ;; std11-extract-address-components is likely to return + ;; the ("GROUP" "") form. + (not (equal (nth 1 components) ""))) (if (car components) - (list (nth 1 components) - (funcall lsdb-canonicalize-full-name-function - (car components))) + (list (funcall lsdb-canonicalize-full-name-function + (car components)) + (nth 1 components)) (list (nth 1 components) (nth 1 components)))))) ;; stolen (and renamed) from nnheader.el @@ -354,23 +493,96 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (set-buffer-multibyte multibyte)))) ;;;_. Record Management -(defun lsdb-maybe-load-file () +(defun lsdb-rebuild-secondary-hash-tables (&optional force) + (let ((tables lsdb-secondary-hash-tables)) + (while tables + (when (or force (not (symbol-value (car tables)))) + (set (car tables) (lsdb-make-hash-table :test 'equal)) + (lsdb-maphash + (lambda (key value) + (run-hook-with-args + 'lsdb-update-record-functions + (cons key value))) + lsdb-hash-table) + (setq lsdb-hash-tables-are-dirty t)) + (setq tables (cdr tables))))) + +(defun lsdb-maybe-load-hash-tables () (unless lsdb-hash-table (if (file-exists-p lsdb-file) - (setq lsdb-hash-table (lsdb-load-file lsdb-file)) - (setq lsdb-hash-table (lsdb-make-hash-table :test 'equal))))) - + (lsdb-load-hash-tables) + (setq lsdb-hash-table (lsdb-make-hash-table :test 'equal))) + (lsdb-rebuild-secondary-hash-tables))) + +;;;_ : Fallback Lookup Functions +;;;_ , #1 Address Cache +(defun lsdb-lookup-full-name-from-address-cache (sender) + (lsdb-gethash (nth 1 sender) lsdb-address-cache)) + +(defun lsdb-update-address-cache (record) + (let ((net (cdr (assq 'net record)))) + (while net + (lsdb-puthash (pop net) (car record) lsdb-address-cache)))) + +;;;_ , #2 Iterate on the All Records (very slow) +(defun lsdb-lookup-full-name-by-fuzzy-matching (sender) + (let ((names + (if (string-match + "\\`\\(.+\\)[ \t]+\\(/[ \t]+\\|(\\([^)]+\\))\\)" + (car sender)) + (if (match-beginning 3) + (list (match-string 1 (car sender)) + (match-string 3 (car sender))) + (list (match-string 1 (car sender)) + (substring (car sender) (match-end 0)))) + (list (car sender)))) + (case-fold-search t)) + (catch 'found + (lsdb-maphash + (lambda (key value) + (while names + (if (or (string-match + (concat "\\<" (regexp-quote (car names)) "\\>") + key) + (string-match + (concat + "\\<" + (regexp-quote + (mapconcat #'identity + (nreverse (split-string (car names))) + " ")) + "\\>") + key) + ;; Don't assume that we are using address cache. + (member (nth 1 sender) (cdr (assq 'net value)))) + (throw 'found key)) + (setq names (cdr names)))) + lsdb-hash-table)))) + +;;;_ : Update Records (defun lsdb-update-record (sender &optional interesting) - (let ((old (lsdb-gethash (nth 1 sender) lsdb-hash-table)) - (new (cons (cons 'net (list (car sender))) + (let ((old (lsdb-gethash (car sender) lsdb-hash-table)) + (new (cons (cons 'net (list (nth 1 sender))) interesting)) merged - record) + record + full-name) + ;; Look for the existing record from the reverse hash table. + ;; If it is found, regsiter the current full-name as AKA. + (unless old + (setq full-name + (run-hook-with-args-until-success + 'lsdb-lookup-full-name-functions + sender)) + (when full-name + (setq old (lsdb-gethash full-name lsdb-hash-table) + new (cons (list 'aka (car sender)) new)) + (setcar sender full-name))) (unless old (setq new (cons (cons 'creation-date (format-time-string "%Y-%m-%d")) new))) (setq merged (lsdb-merge-record-entries old new) - record (cons (nth 1 sender) merged)) + record (cons (car sender) merged)) (unless (equal merged old) (let ((entry (assq 'last-modified (cdr record))) (last-modified (format-time-string "%Y-%m-%d"))) @@ -380,11 +592,12 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (cdr record))))) (lsdb-puthash (car record) (cdr record) lsdb-hash-table) - (setq lsdb-hash-table-is-dirty t)) + (run-hook-with-args 'lsdb-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t)) record)) (defun lsdb-update-records () - (lsdb-maybe-load-file) + (lsdb-maybe-load-hash-tables) (let (senders recipients interesting alist records bodies entry) (save-restriction (std11-narrow-to-header) @@ -399,13 +612,15 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (setq alist lsdb-interesting-header-alist) (while alist (setq bodies - (mapcar - (lambda (field-body) - (if (and (nth 1 (car alist)) - (string-match (nth 1 (car alist)) field-body)) - (replace-match (nth 3 (car alist)) nil nil field-body) - field-body)) - (lsdb-fetch-field-bodies (car (car alist))))) + (delq nil (mapcar + (lambda (field-body) + (if (nth 1 (car alist)) + (and (string-match (nth 1 (car alist)) + field-body) + (replace-match (nth 3 (car alist)) + nil nil field-body)) + field-body)) + (lsdb-fetch-field-bodies (car (car alist)))))) (when bodies (setq entry (or (nth 2 (car alist)) 'notes)) @@ -442,39 +657,45 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." old) ;;;_. Display Management -(defun lsdb-temp-buffer-show-function (buffer) +(defun lsdb-fit-window-to-buffer (&optional window) (save-selected-window - (let ((window (or (get-buffer-window lsdb-buffer-name) - (progn - (select-window (get-largest-window)) - (split-window-vertically)))) - height) - (set-window-buffer window buffer) - (select-window window) - (unless (pos-visible-in-window-p (point-max)) - (enlarge-window (- lsdb-window-max-height (window-height)))) - (shrink-window-if-larger-than-buffer) - (if (> (setq height (window-height)) - lsdb-window-max-height) + (if window + (select-window window)) + (unless (pos-visible-in-window-p (point-max)) + (enlarge-window (- lsdb-window-max-height (window-height)))) + (shrink-window-if-larger-than-buffer) + (let ((height (window-height))) + (if (> height lsdb-window-max-height) (shrink-window (- height lsdb-window-max-height))) (set-window-start window (point-min))))) +(defun lsdb-temp-buffer-show-function (buffer) + (when lsdb-pop-up-windows + (save-selected-window + (let ((window (or (get-buffer-window lsdb-buffer-name) + (progn + (select-window (get-largest-window)) + (split-window-vertically))))) + (set-window-buffer window buffer) + (lsdb-fit-window-to-buffer window))))) + (defun lsdb-display-record (record) "Display only one RECORD, then shrink the window as possible." - (let ((temp-buffer-show-function - (function lsdb-temp-buffer-show-function))) + (let ((temp-buffer-show-function lsdb-temp-buffer-show-function)) (lsdb-display-records (list record)))) (defun lsdb-display-records (records) (with-output-to-temp-buffer lsdb-buffer-name (set-buffer standard-output) + (setq records + (sort (copy-sequence records) + (or lsdb-display-records-sort-predicate + (lambda (record1 record2) + (string-lessp (car record1) (car record2)))))) (while records (save-restriction (narrow-to-region (point) (point)) - (lsdb-print-record (car records)) - (add-text-properties (point-min) (point-max) - (list 'lsdb-record (car records))) - (run-hooks 'lsdb-display-record-hook)) + (lsdb-print-record (car records))) (goto-char (point-max)) (setq records (cdr records))) (lsdb-mode))) @@ -485,15 +706,17 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (defun lsdb-insert-entry (entry) (let ((entry-name (capitalize (symbol-name (car entry))))) (intern entry-name lsdb-known-entry-names) - (insert "\t" entry-name ": " - (if (listp (cdr entry)) - (mapconcat - #'identity (cdr entry) - (if (eq ?, (nth 2 (assq (car entry) lsdb-entry-type-alist))) - ", " - "\n\t\t")) - (cdr entry)) - "\n"))) + (if (>= (lsdb-entry-score entry) 0) + (insert "\t" entry-name ": " + (if (listp (cdr entry)) + (mapconcat + #'identity (cdr entry) + (if (eq ?, (nth 2 (assq (car entry) + lsdb-entry-type-alist))) + ", " + "\n\t\t")) + (cdr entry)) + "\n")))) (defun lsdb-print-record (record) (insert (car record) "\n") @@ -502,24 +725,55 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (lambda (entry1 entry2) (> (lsdb-entry-score entry1) (lsdb-entry-score entry2)))))) (while entries - (if (>= (lsdb-entry-score (car entries)) 0) - (lsdb-insert-entry (car entries))) - (setq entries (cdr entries))))) + (lsdb-insert-entry (car entries)) + (setq entries (cdr entries)))) + (add-text-properties (point-min) (point-max) + (list 'lsdb-record record)) + (run-hooks 'lsdb-print-record-hook)) ;;;_. Completion (defvar lsdb-last-completion nil) (defvar lsdb-last-candidates nil) (defvar lsdb-last-candidates-pointer nil) +(defvar lsdb-complete-marker nil) + +;;;_ : Matching Highlight +(defvar lsdb-last-highlight-overlay nil) +(defun lsdb-complete-name-highlight (start end) + (make-local-hook 'pre-command-hook) + (add-hook 'pre-command-hook 'lsdb-complete-name-highlight-update nil t) + (save-excursion + (goto-char start) + (search-forward lsdb-last-completion end) + (setq lsdb-last-highlight-overlay + (make-overlay (match-beginning 0) (match-end 0))) + (overlay-put lsdb-last-highlight-overlay 'face + (or (find-face 'isearch-secondary) + (find-face 'isearch-lazy-highlight-face) + 'underline)))) + +(defun lsdb-complete-name-highlight-update () + (unless (eq this-command 'lsdb-complete-name) + (if lsdb-last-highlight-overlay + (delete-overlay lsdb-last-highlight-overlay)) + (set-marker lsdb-complete-marker nil) + (remove-hook 'pre-command-hook + 'lsdb-complete-name-highlight-update t))) + +;;;_ : Name Completion (defun lsdb-complete-name () "Complete the user full-name or net-address before point" (interactive) - (lsdb-maybe-load-file) + (lsdb-maybe-load-hash-tables) + (unless (markerp lsdb-complete-marker) + (setq lsdb-complete-marker (make-marker))) (let* ((start - (save-excursion - (re-search-backward "\\(\\`\\|[\n:,]\\)[ \t]*") - (goto-char (match-end 0)) - (point))) + (or (and (eq (marker-buffer lsdb-complete-marker) (current-buffer)) + (marker-position lsdb-complete-marker)) + (save-excursion + (re-search-backward "\\(\\`\\|[\n:,]\\)[ \t]*") + (set-marker lsdb-complete-marker (match-end 0))))) pattern (case-fold-search t) (completion-ignore-case t)) @@ -527,7 +781,7 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (setq lsdb-last-candidates nil lsdb-last-candidates-pointer nil lsdb-last-completion (buffer-substring start (point)) - pattern (concat "\\<" lsdb-last-completion)) + pattern (concat "\\<" (regexp-quote lsdb-last-completion))) (lsdb-maphash (lambda (key value) (let ((net (cdr (assq 'net value)))) @@ -543,19 +797,104 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (if (string-match pattern (car net)) (push (car net) lsdb-last-candidates)) (setq net (cdr net)))))) - lsdb-hash-table)) + lsdb-hash-table) + ;; Sort candidates by the position where the pattern occurred. + (setq lsdb-last-candidates + (sort lsdb-last-candidates + (lambda (cand1 cand2) + (< (if (string-match pattern cand1) + (match-beginning 0)) + (if (string-match pattern cand2) + (match-beginning 0))))))) (unless lsdb-last-candidates-pointer (setq lsdb-last-candidates-pointer lsdb-last-candidates)) (when lsdb-last-candidates-pointer (delete-region start (point)) - (insert (pop lsdb-last-candidates-pointer))))) + (insert (pop lsdb-last-candidates-pointer)) + (lsdb-complete-name-highlight start (point))))) ;;;_. Major Mode (`lsdb-mode') Implementation +;;;_ : Modeline Buffer Identification +(defconst lsdb-pointer-xpm + "/* XPM */ +static char * lsdb_pointer_xpm[] = { +\"14 14 5 1\", +\" c None\", +\"+ c #FF9696\", +\"@ c #FF0000\", +\"# c #FF7575\", +\"$ c #FF5959\", +\" \", +\" +++ @@@ \", +\" +++## @@@@@ \", +\" ++### @@@@@ \", +\" +#####@@@@@ \", +\" +###$$@@@@@ \", +\" +###$$@@@@@ \", +\" ##$$$@@@@ \", +\" #$$$@@@ \", +\" $$@@@ \", +\" $@@ \", +\" @ \", +\" \", +\" \"};") + +(static-if (featurep 'xemacs) + (progn + (defvar lsdb-xemacs-modeline-left-extent + (copy-extent modeline-buffer-id-left-extent)) + + (defvar lsdb-xemacs-modeline-right-extent + (copy-extent modeline-buffer-id-right-extent)) + + (defun lsdb-modeline-buffer-identification (line) + "Decorate 1st element of `mode-line-buffer-identification' LINE. +Modify whole identification by side effect." + (let ((id (car line)) chopped) + (if (and (stringp id) (string-match "^LSDB:" id)) + (progn + (setq chopped (substring id 0 (match-end 0)) + id (substring id (match-end 0))) + (nconc + (list + (let ((glyph + (make-glyph + (nconc + (if (featurep 'xpm) + (list (vector 'xpm :data lsdb-pointer-xpm))) + (list (vector 'string :data chopped)))))) + (set-glyph-face glyph 'modeline-buffer-id) + (cons lsdb-xemacs-modeline-left-extent glyph)) + (cons lsdb-xemacs-modeline-right-extent id)) + (cdr line))) + line)))) + (condition-case nil + (progn + (require 'image) + (defun lsdb-modeline-buffer-identification (line) + "Decorate 1st element of `mode-line-buffer-identification' LINE. +Modify whole identification by side effect." + (let ((id (copy-sequence (car line))) + (image + (if (image-type-available-p 'xpm) + (create-image lsdb-pointer-xpm 'xpm t :ascent 'center)))) + (when (and image + (stringp id) (string-match "^LSDB:" id)) + (add-text-properties 0 (length id) + (list 'display image + 'rear-nonsticky (list 'display)) + id) + (setcar line id)) + line))) + (error + (defalias 'lsdb-modeline-buffer-identification 'identity)))) + (defvar lsdb-mode-map (let ((keymap (make-sparse-keymap))) (define-key keymap "a" 'lsdb-mode-add-entry) (define-key keymap "d" 'lsdb-mode-delete-entry) (define-key keymap "e" 'lsdb-mode-edit-entry) + (define-key keymap "l" 'lsdb-mode-load) (define-key keymap "s" 'lsdb-mode-save) (define-key keymap "q" 'lsdb-mode-quit-window) (define-key keymap "g" 'lsdb-mode-lookup) @@ -568,29 +907,58 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." keymap) "LSDB's keymap.") +(defvar lsdb-modeline-string "") + (define-derived-mode lsdb-mode fundamental-mode "LSDB" "Major mode for browsing LSDB records." (setq buffer-read-only t) - (if (featurep 'xemacs) + (static-if (featurep 'xemacs) ;; In XEmacs, setting `font-lock-defaults' only affects on ;; `find-file-hooks'. (font-lock-set-defaults) (set (make-local-variable 'font-lock-defaults) - '(lsdb-font-lock-keywords t)))) + '(lsdb-font-lock-keywords t))) + (make-local-hook 'post-command-hook) + (add-hook 'post-command-hook 'lsdb-modeline-update nil t) + (make-local-variable 'lsdb-modeline-string) + (setq mode-line-buffer-identification + (lsdb-modeline-buffer-identification + '("LSDB: " lsdb-modeline-string))) + (lsdb-modeline-update) + (force-mode-line-update)) + +(defun lsdb-modeline-update () + (let ((record + (get-text-property (if (eobp) (point-min) (point)) 'lsdb-record)) + net) + (if record + (progn + (setq net (car (cdr (assq 'net (cdr record))))) + (if (equal net (car record)) + (setq lsdb-modeline-string net) + (setq lsdb-modeline-string (concat (car record) " <" net ">")))) + (setq lsdb-modeline-string "")))) (defun lsdb-narrow-to-record () - (narrow-to-region - (previous-single-property-change (point) 'lsdb-record nil (point-min)) - (next-single-property-change (point) 'lsdb-record nil (point-max))) - (goto-char (point-min))) + "Narrow to the current record." + (let ((end (next-single-property-change (point) 'lsdb-record nil + (point-max)))) + (narrow-to-region + (previous-single-property-change end 'lsdb-record nil (point-min)) + end) + (goto-char (point-min)))) (defun lsdb-current-record () + "Return the current record name." (let ((record (get-text-property (point) 'lsdb-record))) (unless record (error "There is nothing to follow here")) record)) (defun lsdb-current-entry () + "Return the current entry name. +If the point is not on a entry line, it prompts to select a entry in +the current record." (save-excursion (beginning-of-line) (if (looking-at "^[^\t]") @@ -629,7 +997,8 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (setcdr record (cons (cons ',entry-name form) (cdr record))) (lsdb-puthash (car record) (cdr record) lsdb-hash-table) - (setq lsdb-hash-table-is-dirty t) + (run-hook-with-args 'lsdb-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t) (beginning-of-line 2) (add-text-properties (point) @@ -651,7 +1020,8 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (setcdr record (delq entry (cdr record))) (lsdb-puthash (car record) (cdr record) lsdb-hash-table) - (setq lsdb-hash-table-is-dirty t)) + (run-hook-with-args 'lsdb-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t)) (save-restriction (lsdb-narrow-to-record) (let ((case-fold-search t) @@ -679,7 +1049,7 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (lsdb-edit-form (cdr entry) "Editing the entry." `(lambda (form) - (unless (equal form ',entry-name) + (unless (equal form ',(cdr entry)) (save-excursion (set-buffer lsdb-buffer-name) (goto-char ,marker) @@ -688,7 +1058,8 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (inhibit-read-only t) buffer-read-only) (setcdr entry form) - (setq lsdb-hash-table-is-dirty t) + (run-hook-with-args 'lsdb-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t) (lsdb-mode-delete-entry (symbol-name ',entry-name) t) (beginning-of-line) (add-text-properties @@ -698,27 +1069,80 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (point)) (list 'lsdb-record record))))))))) -(defun lsdb-mode-save () +(defun lsdb-mode-save (&optional dont-ask) "Save LSDB hash table into `lsdb-file'." (interactive) - (if (not lsdb-hash-table-is-dirty) + (if (not lsdb-hash-tables-are-dirty) (message "(No changes need to be saved)") (when (or (interactive-p) - (y-or-n-p "Save the LSDB now?")) - (lsdb-save-file lsdb-file lsdb-hash-table) - (setq lsdb-hash-table-is-dirty nil) + dont-ask + (y-or-n-p "Save the LSDB now? ")) + (lsdb-save-hash-tables) + (setq lsdb-hash-tables-are-dirty nil) (message "The LSDB was saved successfully.")))) -(if (commandp 'quit-window) - (defalias 'lsdb-mode-quit-window 'quit-window) - (defun lsdb-mode-quit-window () - "Quit the current buffer." - (interactive) - (if (one-window-p) - (bury-buffer) - (delete-window)))) +(defun lsdb-mode-load () + "Load LSDB hash table from `lsdb-file'." + (interactive) + (let (lsdb-secondary-hash-tables) + (lsdb-load-hash-tables)) + (message "Rebuilding secondary hash tables...") + (lsdb-rebuild-secondary-hash-tables t) + (message "Rebuilding secondary hash tables...done")) + +(defun lsdb-mode-quit-window (&optional kill window) + "Quit the current buffer. +It partially emulates the GNU Emacs' of `quit-window'." + (interactive "P") + (unless window + (setq window (selected-window))) + (let ((buffer (window-buffer window))) + (unless (save-selected-window + (select-window window) + (one-window-p)) + (delete-window window)) + (if kill + (kill-buffer buffer) + (bury-buffer (unless (eq buffer (current-buffer)) buffer))))) + +(defun lsdb-hide-buffer () + "Hide the LSDB window." + (let ((window (get-buffer-window lsdb-buffer-name))) + (if window + (lsdb-mode-quit-window nil window)))) + +(defun lsdb-show-buffer () + "Show the LSDB window." + (if (get-buffer lsdb-buffer-name) + (if lsdb-temp-buffer-show-function + (let ((lsdb-pop-up-windows t)) + (funcall lsdb-temp-buffer-show-function lsdb-buffer-name)) + (pop-to-buffer lsdb-buffer-name)))) + +(defun lsdb-toggle-buffer (&optional arg) + "Toggle hiding of the LSDB window. +If given a negative prefix, always show; if given a positive prefix, +always hide." + (interactive + (list (if current-prefix-arg + (prefix-numeric-value current-prefix-arg) + 0))) + (unless arg ;called noninteractively? + (setq arg 0)) + (cond + ((or (< arg 0) + (and (zerop arg) + (not (get-buffer-window lsdb-buffer-name)))) + (lsdb-show-buffer)) + ((or (> arg 0) + (and (zerop arg) + (get-buffer-window lsdb-buffer-name))) + (lsdb-hide-buffer)))) (defun lsdb-lookup-records (regexp &optional entry-name) + "Return the all records in the LSDB matching the REGEXP. +If the optional 2nd argument ENTRY-NAME is given, matching only +performed against the entry field." (let (records) (lsdb-maphash (if entry-name @@ -744,7 +1168,9 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (defvar lsdb-mode-lookup-history nil) (defun lsdb-mode-lookup (regexp &optional entry-name) - "Display all entries in the LSDB matching the REGEXP." + "Display the all records in the LSDB matching the REGEXP. +If the optional 2nd argument ENTRY-NAME is given, matching only +performed against the entry field." (interactive (let* ((completion-ignore-case t) (entry-name @@ -758,7 +1184,7 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." "Search records regexp: ") nil nil nil 'lsdb-mode-lookup-history) entry-name))) - (lsdb-maybe-load-file) + (lsdb-maybe-load-hash-tables) (let ((records (lsdb-lookup-records regexp entry-name))) (if records (lsdb-display-records records)))) @@ -884,22 +1310,113 @@ of the buffer." (defun lsdb-wl-insinuate () "Call this function to hook LSDB into Wanderlust." (add-hook 'wl-message-redisplay-hook 'lsdb-wl-update-record) - (add-hook 'wl-summary-exit-hook 'lsdb-wl-hide-buffer) - (add-hook 'wl-exit-hook 'lsdb-mode-save)) - + (add-hook 'wl-summary-exit-hook 'lsdb-hide-buffer) + (add-hook 'wl-summary-toggle-disp-off-hook 'lsdb-hide-buffer) + (add-hook 'wl-summary-toggle-disp-folder-on-hook 'lsdb-hide-buffer) + (add-hook 'wl-summary-toggle-disp-folder-off-hook 'lsdb-hide-buffer) + (add-hook 'wl-summary-toggle-disp-folder-message-resumed-hook + 'lsdb-wl-show-buffer) + (add-hook 'wl-exit-hook 'lsdb-mode-save) + (add-hook 'wl-save-hook 'lsdb-mode-save)) + +(eval-when-compile + (autoload 'wl-message-get-original-buffer "wl-message")) (defun lsdb-wl-update-record () (save-excursion (set-buffer (wl-message-get-original-buffer)) (let ((records (lsdb-update-records))) (when records - (lsdb-display-record (car records)))))) + (let ((lsdb-temp-buffer-show-function + #'lsdb-wl-temp-buffer-show-function)) + (lsdb-display-record (car records))))))) + +(defun lsdb-wl-toggle-buffer (&optional arg) + "Toggle hiding of the LSDB window for Wanderlust. +If given a negative prefix, always show; if given a positive prefix, +always hide." + (interactive + (list (if current-prefix-arg + (prefix-numeric-value current-prefix-arg) + 0))) + (let ((lsdb-temp-buffer-show-function + #'lsdb-wl-temp-buffer-show-function)) + (lsdb-toggle-buffer arg))) + +(defun lsdb-wl-show-buffer () + (when lsdb-pop-up-windows + (let ((lsdb-temp-buffer-show-function + #'lsdb-wl-temp-buffer-show-function)) + (lsdb-show-buffer)))) + +(defvar wl-current-summary-buffer) +(defvar wl-message-buffer) +(defun lsdb-wl-temp-buffer-show-function (buffer) + (when lsdb-pop-up-windows + (save-selected-window + (let ((window (or (get-buffer-window lsdb-buffer-name) + (progn + (select-window + (or (save-excursion + (if (buffer-live-p wl-current-summary-buffer) + (set-buffer wl-current-summary-buffer)) + (get-buffer-window wl-message-buffer)) + (get-largest-window))) + (split-window-vertically))))) + (set-window-buffer window buffer) + (lsdb-fit-window-to-buffer window))))) + +;;;_. Interface to Mew written by Hideyuki SHIRAI +(eval-when-compile + (autoload 'mew-sinfo-get-disp-msg "mew") + (autoload 'mew-current-get-fld "mew") + (autoload 'mew-current-get-msg "mew") + (autoload 'mew-frame-id "mew") + (autoload 'mew-cache-hit "mew") + (autoload 'mew-xinfo-get-decode-err "mew") + (autoload 'mew-xinfo-get-action "mew")) -(defun lsdb-wl-hide-buffer () - (let ((window (get-buffer-window lsdb-buffer-name))) - (if window - (delete-window window)))) +;;;###autoload +(defun lsdb-mew-insinuate () + "Call this function to hook LSDB into Mew." + (add-hook 'mew-message-hook 'lsdb-mew-update-record) + (add-hook 'mew-summary-toggle-disp-msg-hook + (lambda () + (unless (mew-sinfo-get-disp-msg) + (lsdb-hide-buffer)))) + (add-hook 'mew-suspend-hook 'lsdb-hide-buffer) + (add-hook 'mew-quit-hook 'lsdb-mode-save) + (add-hook 'kill-emacs-hook 'lsdb-mode-save) + (cond + ;; Mew 3 + ((fboundp 'mew-summary-visit-folder) + (defadvice mew-summary-visit-folder (before lsdb-hide-buffer activate) + (lsdb-hide-buffer))) + ;; Mew 2 + ((fboundp 'mew-summary-switch-to-folder) + (defadvice mew-summary-switch-to-folder (before lsdb-hide-buffer activate) + (lsdb-hide-buffer))))) + +(defun lsdb-mew-update-record () + (let* ((fld (mew-current-get-fld (mew-frame-id))) + (msg (mew-current-get-msg (mew-frame-id))) + (cache (mew-cache-hit fld msg)) + records) + (when cache + (save-excursion + (set-buffer cache) + (unless (or (mew-xinfo-get-decode-err) (mew-xinfo-get-action)) + (make-local-variable 'lsdb-decode-field-body-function) + (setq lsdb-decode-field-body-function + (lambda (body name) + (set-text-properties 0 (length body) nil body) + body)) + (when (setq records (lsdb-update-records)) + (lsdb-display-record (car records)))))))) ;;;_. Interface to MU-CITE +(eval-when-compile + (autoload 'mu-cite-get-value "mu-cite")) + (defun lsdb-mu-attribution (address) "Extract attribute information from LSDB." (let ((records @@ -920,7 +1437,8 @@ of the buffer." (cdr (car records)))) (lsdb-puthash (car (car records)) (cdr (car records)) lsdb-hash-table) - (setq lsdb-hash-table-is-dirty t))))) + (run-hook-with-args 'lsdb-update-record-functions (car records)) + (setq lsdb-hash-tables-are-dirty t))))) (defun lsdb-mu-get-prefix-method () "A mu-cite method to return a prefix from LSDB or \">\". @@ -988,45 +1506,100 @@ the user wants it." #'lsdb-mu-get-prefix-register-verbose-method))))))) ;;;_. X-Face Rendering +(defvar lsdb-x-face-cache + (lsdb-make-hash-table :test 'equal)) + +(defun lsdb-x-face-available-image-type () + (static-if (featurep 'xemacs) + (if (featurep 'xpm) + 'xpm) + (and (>= emacs-major-version 21) + (fboundp 'image-type-available-p) + (if (image-type-available-p 'pbm) + 'pbm + (if (image-type-available-p 'xpm) + 'xpm))))) + (defun lsdb-expose-x-face () (let* ((record (get-text-property (point-min) 'lsdb-record)) (x-face (cdr (assq 'x-face (cdr record)))) - (limit "\r")) + (delimiter "\r ")) (when (and lsdb-insert-x-face-function x-face) (goto-char (point-min)) (end-of-line) - (if (fboundp 'propertize) - (insert (propertize limit 'invisible t) " ") - (put-text-property 0 1 'invisible t limit) - (insert limit " ")) - (while x-face - (funcall lsdb-insert-x-face-function (pop x-face)))))) - -;; stolen (and renamed) from gnus-summary-x-face.el written by Akihiro Arisawa. -(defvar lsdb-x-face-scale-factor 0.5 - "A number of scale factor used to scale down X-face image. -See also `x-face-scale-factor'.") - -(defun lsdb-insert-x-face-with-x-face-e21 (x-face) - (require 'x-face-e21) - (insert-image (x-face-create-image - x-face :scale-factor lsdb-x-face-scale-factor))) - -(defun lsdb-insert-x-face-with-xemacs-glyph (x-face) - (let ((glyph - (make-glyph - (vector 'xface :data (concat "X-Face: " x-face))))) - (if glyph - (set-extent-end-glyph - (make-extent (point) (point)) - glyph)))) + (put-text-property 0 1 'invisible t delimiter) ;hide "\r" + (put-text-property + (point) + (progn + (insert delimiter) + (while x-face + (funcall lsdb-insert-x-face-function (pop x-face))) + (point)) + 'lsdb-record record)))) + +(defun lsdb-insert-x-face-image (data type marker) + (static-if (featurep 'xemacs) + (save-excursion + (set-buffer (marker-buffer marker)) + (goto-char marker) + (let* ((inhibit-read-only t) + buffer-read-only + (glyph (make-glyph (vector type :data data)))) + (set-extent-begin-glyph + (make-extent (point) (point)) + glyph))) + (save-excursion + (set-buffer (marker-buffer marker)) + (goto-char marker) + (let* ((inhibit-read-only t) + buffer-read-only + (image (create-image data type t :ascent 'center)) + (record (get-text-property (point) 'lsdb-record))) + (put-text-property (point) (progn + (insert-image image) + (point)) + 'lsdb-record record))))) + +(defun lsdb-insert-x-face-asynchronously (x-face) + (let* ((type (or lsdb-x-face-image-type + (lsdb-x-face-available-image-type))) + (shell-file-name lsdb-shell-file-name) + (shell-command-switch lsdb-shell-command-switch) + (process-connection-type nil) + (cached (cdr (assq type (lsdb-gethash x-face lsdb-x-face-cache)))) + (marker (point-marker)) + process) + (if cached + (lsdb-insert-x-face-image cached type marker) + (setq process + (start-process-shell-command + "lsdb-x-face-command" (generate-new-buffer " *lsdb work*") + (concat "{ " + (nth 1 (assq type lsdb-x-face-command-alist)) + "; } 2> /dev/null"))) + (process-send-string process (concat x-face "\n")) + (process-send-eof process) + (set-process-sentinel + process + `(lambda (process string) + (unwind-protect + (when (and (buffer-live-p (marker-buffer ,marker)) + (equal string "finished\n")) + (let ((data + (with-current-buffer (process-buffer process) + (set-buffer-multibyte nil) + (buffer-string)))) + (lsdb-insert-x-face-image data ',type ,marker) + (lsdb-puthash ,x-face (list (cons ',type data)) + lsdb-x-face-cache))) + (kill-buffer (process-buffer process)))))))) (require 'product) (provide 'lsdb) (product-provide 'lsdb - (product-define "LSDB" nil '(0 1))) + (product-define "LSDB" nil '(0 7))) ;;;_* Local emacs vars. ;;; The following `outline-layout' local variable setting: