X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=lsdb.el;h=57be8d3d27344e64120bb953dc619d05cab3f2d9;hb=50aa9861c0c79fa2ddb028e9e0b220c667a411e7;hp=4705b8e8500d19a8caeca111e2a14d6de4a8d4e8;hpb=9960f9bb43ea564906ff1be617c38c41f708fbce;p=elisp%2Flsdb.git diff --git a/lsdb.el b/lsdb.el index 4705b8e..57be8d3 100644 --- a/lsdb.el +++ b/lsdb.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2002 Daiki Ueno ;; Author: Daiki Ueno -;; Keywords: adress book +;; Keywords: address book ;; This file is part of the Lovely Sister Database. @@ -31,18 +31,36 @@ ;;; (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) -;;; (lsdb-wl-insinuate) +;;; (autoload 'lsdb-wl-insinuate "lsdb") +;;; (add-hook 'wl-init-hook 'lsdb-wl-insinuate) ;;; (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 @@ -55,7 +73,7 @@ :group 'lsdb :type 'file) -(defcustom lsdb-file-coding-system 'iso-2022-jp +(defcustom lsdb-file-coding-system (find-coding-system 'ctext) "Coding system for `lsdb-file'." :group 'lsdb :type 'symbol) @@ -73,10 +91,16 @@ :type 'list) (defcustom lsdb-interesting-header-alist - '(("Organization" nil organization) - ("\\(X-\\)?User-Agent\\|X-Mailer" nil user-agent) + `(("Organization" nil organization) + ("\\(X-\\)?User-Agent\\|X-Mailer\\|X-Newsreader" nil user-agent) ("\\(X-\\)?ML-Name" nil mailing-list) - ("X-Attribution\\|X-cite-me" nil attribution)) + ("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) + (,lsdb-sender-headers nil sender)) "Alist of headers we are interested in. The format of elements of this list should be (FIELD-NAME REGEXP ENTRY STRING) @@ -86,16 +110,26 @@ where the last three elements are optional." (defcustom lsdb-entry-type-alist '((net 5 ?,) - (creation-date 2) - (last-modified 2) - (mailing-list 3 ?,) - (attribution 3 ?.) - (organization 3) - (score -1)) - "Alist of entries to display. + (creation-date 2 ?. t) + (last-modified 3 ?. t) + (mailing-list 4 ?,) + (attribution 4 ?.) + (organization 4) + (www 4) + (aka 4 ?,) + (score -1) + (x-face -1) + (sender -1)) + "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) @@ -110,17 +144,123 @@ where the last element is optional." :group 'lsdb :type 'function) -(defcustom lsdb-print-record-function - #'lsdb-print-record - "Function to print LSDB record." +(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 'function) + :type 'hook) + +(defcustom lsdb-after-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-after-delete-record-functions + '(lsdb-delete-address-cache) + "List of functions called after a record is removed. +The removed 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 (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-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-display-records-belong-to-user t + "Non-nil means LSDB displays records belong to yourself. +When this option is equal to nil and a message is sent by the user +whose address is `user-mail-address', the LSDB record for the To: line +will be shown instead of the one for the From: line." + :group 'lsdb + :type 'boolean) + +(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) + +(defcustom lsdb-edit-form-mode-hook nil + "Hook run in `lsdb-edit-form-mode' buffers." + :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) + +(defcustom lsdb-verbose t + "If non-nil, confirm user to submit changes to lsdb-hash-table." + :type 'boolean + :group 'lsdb) + +(defcustom lsdb-strip-address nil + "If non-nil, strip display-name from sender address before completion." + :group 'lsdb + :type 'boolean) + +(defcustom lsdb-use-migemo nil + "If non-nil, use `migemo' when complete address." + :type 'boolean + :group 'lsdb) + ;;;_. Faces (defface lsdb-header-face '((t (:underline t))) @@ -145,7 +285,7 @@ where the last element is optional." (defvar lsdb-field-body-face 'lsdb-field-body-face) (defconst lsdb-font-lock-keywords - '(("^\\sw.*$" + '(("^\\sw[^\r\n]*" (0 lsdb-header-face)) ("^\t\t.*$" (0 lsdb-field-body-face)) @@ -156,17 +296,33 @@ where the last element is optional." (put 'lsdb-mode 'font-lock-defaults '(lsdb-font-lock-keywords t)) ;;;_* CODE - no user customizations below +;;;_. Internal Variables (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 (fboundp 'make-hash-table) +(if (and (fboundp 'make-hash-table) + (subrp (symbol-function 'make-hash-table))) (progn (defalias 'lsdb-puthash 'puthash) (defalias 'lsdb-gethash 'gethash) @@ -212,7 +368,7 @@ may remhash or puthash the entry currently being processed by FUNCTION." (mapatoms (lambda (symbol) (funcall function (symbol-name symbol) (symbol-value symbol))) - hash-table)) + (nth 1 hash-table))) (defun lsdb-hash-table-size (hash-table) "Return the size of HASH-TABLE. This is the current number of slots in HASH-TABLE, whether occupied or not." @@ -223,63 +379,113 @@ 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." - (save-excursion - (set-buffer (find-file-noselect file)) - (re-search-forward "^#s") - (beginning-of-line) - (read (point-min-marker))))) + (and + ;; In XEmacs, hash tables can also be created by the lisp reader + ;; using structure syntax. + (read-from-string "#s(hash-table)") + (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(") + (let ((end-marker + (progn + (forward-char 2) ;skip "#s" + (forward-sexp) ;move to the left paren + (point-marker)))) + (with-temp-buffer + (buffer-disable-undo) + (insert-buffer-substring (marker-buffer marker) + marker end-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)))) + (read marker))))))) + +(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) + (let (print-level print-length) + (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 - (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 "))")))) - -(defun lsdb-offer-save () - (if (and lsdb-hash-table-is-dirty - (y-or-n-p "Save the LSDB now?")) - (lsdb-save-file lsdb-file lsdb-hash-table))) + (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 ";;; -*- mode: emacs-lisp; 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) @@ -302,11 +508,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 @@ -324,23 +534,102 @@ 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)) + (setq lsdb-hash-tables-are-dirty t)) + (setq tables (cdr tables)))) + (if lsdb-hash-tables-are-dirty + (lsdb-maphash + (lambda (key value) + (run-hook-with-args + 'lsdb-after-update-record-functions + (cons key value))) + lsdb-hash-table))) + +(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)))) +(defun lsdb-delete-address-cache (record) + (let ((net (cdr (assq 'net record)))) + (while net + (lsdb-remhash (pop net) 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"))) @@ -348,13 +637,14 @@ This is the current number of slots in HASH-TABLE, whether occupied or not." (setcdr entry last-modified) (setcdr record (cons (cons 'last-modified last-modified) (cdr record))))) - (lsdb-puthash (car record) (copy-sequence (cdr record)) + (lsdb-puthash (car record) (cdr record) lsdb-hash-table) - (setq lsdb-hash-table-is-dirty t)) + (run-hook-with-args 'lsdb-after-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) @@ -369,13 +659,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)) @@ -412,149 +704,1078 @@ 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) - (shrink-window (- height lsdb-window-max-height)) - (shrink-window-if-larger-than-buffer))))) + (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-update-records-and-display () + (let ((records (lsdb-update-records))) + (if lsdb-display-records-belong-to-user + (if records + (lsdb-display-record (car records)) + (lsdb-hide-buffer)) + (catch 'lsdb-show-record + (while records + (if (member user-mail-address (cdr (assq 'net (car records)))) + (setq records (cdr records)) + (lsdb-display-record (car records)) + (throw 'lsdb-show-record t))) + (lsdb-hide-buffer))))) (defun lsdb-display-record (record) - (let ((temp-buffer-show-function - (function lsdb-temp-buffer-show-function))) - (with-output-to-temp-buffer lsdb-buffer-name - (set-buffer standard-output) - (funcall lsdb-print-record-function record) - (lsdb-mode)))) + "Display only one RECORD, then shrink the window as possible." + (let ((temp-buffer-show-function lsdb-temp-buffer-show-function)) + (lsdb-display-records (list record)))) + +(defun lsdb-display-records (records) + (with-current-buffer (get-buffer-create lsdb-buffer-name) + (let ((standard-output (current-buffer)) + (inhibit-read-only t) + buffer-read-only) + (buffer-disable-undo) + (erase-buffer) + (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))) + (goto-char (point-max)) + (setq records (cdr records)))) + (lsdb-mode) + (set-buffer-modified-p lsdb-hash-tables-are-dirty) + (goto-char (point-min)) + (if temp-buffer-show-function + (funcall temp-buffer-show-function (current-buffer)) + (pop-to-buffer (current-buffer))))) + +(defsubst lsdb-entry-score (entry) + (or (nth 1 (assq (car entry) lsdb-entry-type-alist)) 0)) + +(defun lsdb-insert-entry (entry) + (let ((entry-name (capitalize (symbol-name (car entry))))) + (intern entry-name lsdb-known-entry-names) + (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") (let ((entries - (sort (cdr record) + (sort (copy-sequence (cdr record)) (lambda (entry1 entry2) - (> (or (nth 1 (assq (car entry1) lsdb-entry-type-alist)) - 0) - (or (nth 1 (assq (car entry2) lsdb-entry-type-alist)) - 0)))))) + (> (lsdb-entry-score entry1) (lsdb-entry-score entry2)))))) (while entries - (insert "\t" (capitalize (symbol-name (car (car entries)))) ": " - (if (listp (cdr (car entries))) - (mapconcat #'identity (cdr (car entries)) - (if (eq ?, (nth 2 (assq (car (car entries)) - lsdb-entry-type-alist))) - ", " - "\n\t\t")) - (cdr (car entries))) - "\n") - (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) + +;;; avoid byte-compile warning for migemo +(eval-when-compile + (autoload 'migemo-get-pattern "migemo")) + +(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) + (if (and lsdb-use-migemo (fboundp 'migemo-get-pattern)) + (re-search-forward lsdb-last-completion end) + (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)) (unless (eq last-command this-command) (setq lsdb-last-candidates nil lsdb-last-candidates-pointer nil - lsdb-last-completion (buffer-substring start (point)) - pattern (concat "\\<" lsdb-last-completion)) + lsdb-last-completion (buffer-substring start (point))) + (if (and lsdb-use-migemo (fboundp 'migemo-get-pattern)) + (setq lsdb-last-completion (migemo-get-pattern lsdb-last-completion) + pattern (concat "\\<\\(" lsdb-last-completion "\\)")) + (setq pattern (concat "\\<" (regexp-quote lsdb-last-completion)))) (lsdb-maphash (lambda (key value) - (let ((net (cdr (assq 'net value)))) - (if (string-match pattern key) - (setq lsdb-last-candidates - (nconc lsdb-last-candidates - (mapcar (lambda (address) - (if (equal key address) - key - (concat key " <" address ">"))) - net))) - (while net - (if (string-match pattern (car net)) - (push (car net) lsdb-last-candidates)) - (setq net (cdr net)))))) - lsdb-hash-table)) + (setq lsdb-last-candidates + (nconc lsdb-last-candidates + (delq nil (mapcar + (lambda (candidate) + (if (string-match pattern candidate) + candidate)) + (if lsdb-strip-address + (cdr (assq 'net value)) + (append (cdr (assq 'net value)) + (cdr (assq 'sender value))))))))) + 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 "D" 'lsdb-mode-delete-record) + (define-key keymap "e" 'lsdb-mode-edit-entry) + (define-key keymap "E" 'lsdb-mode-edit-record) + (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) + (define-key keymap "p" 'lsdb-mode-previous-record) + (define-key keymap "n" 'lsdb-mode-next-record) + (define-key keymap " " 'scroll-up) + (define-key keymap [delete] 'scroll-down) + (define-key keymap "\177" 'scroll-down) + (define-key keymap [backspace] 'scroll-down) + 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 (and net (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 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." + (get-text-property (point) 'lsdb-record)) + +(defun lsdb-delete-record (record) + "Delete given RECORD." + (lsdb-remhash (car record) lsdb-hash-table) + (run-hook-with-args 'lsdb-after-delete-record-functions record) + (setq lsdb-hash-tables-are-dirty t)) + +(defun lsdb-current-entry () + "Return the current entry name in canonical form." + (save-excursion + (beginning-of-line) + (if (looking-at "^\t\\([^\t][^:]+\\):") + (intern (downcase (match-string 1)))))) + +(defun lsdb-read-entry (record &optional prompt) + "Prompt to select an entry in the given RECORD." + (let* ((completion-ignore-case t) + (entry-name + (completing-read + (or prompt + "Which entry: ") + (mapcar (lambda (entry) + (list (capitalize (symbol-name (car entry))))) + (cdr record)) + nil t))) + (unless (equal entry-name "") + (intern (downcase entry-name))))) + +(defun lsdb-delete-entry (record entry) + "Delete given ENTRY from RECORD." + (setcdr record (delq entry (cdr record))) + (lsdb-puthash (car record) (cdr record) + lsdb-hash-table) + (run-hook-with-args 'lsdb-after-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t)) + +(defun lsdb-mode-add-entry (entry-name) + "Add an entry on the current line." + (interactive + (let ((completion-ignore-case t)) + (list (completing-read "Entry name: " lsdb-known-entry-names)))) + (beginning-of-line) + (unless (symbolp entry-name) + (setq entry-name (intern (downcase entry-name)))) + (when (assq entry-name (cdr (lsdb-current-record))) + (error "The entry already exists")) + (let ((marker (point-marker))) + (lsdb-edit-form + nil "Editing the entry." + `(lambda (form) + (when form + (save-excursion + (set-buffer lsdb-buffer-name) + (goto-char ,marker) + (let ((record (lsdb-current-record)) + (inhibit-read-only t) + buffer-read-only) + (setcdr record (cons (cons ',entry-name form) (cdr record))) + (lsdb-puthash (car record) (cdr record) + lsdb-hash-table) + (run-hook-with-args 'lsdb-after-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t) + (beginning-of-line 2) + (add-text-properties + (point) + (progn + (lsdb-insert-entry (cons ',entry-name form)) + (point)) + (list 'lsdb-record record))))))))) + +(defun lsdb-mode-delete-entry-1 (entry) + "Delete text contents of the ENTRY from the current buffer." + (save-restriction + (lsdb-narrow-to-record) + (let ((case-fold-search t) + (inhibit-read-only t) + buffer-read-only) + (goto-char (point-min)) + (if (re-search-forward + (concat "^\t" (capitalize (symbol-name (car entry))) ":") + nil t) + (delete-region (match-beginning 0) + (if (re-search-forward + "^\t[^\t][^:]+:" nil t) + (match-beginning 0) + (point-max))))))) + +(defun lsdb-mode-delete-entry () + "Delete the entry on the current line." + (interactive) + (let ((record (lsdb-current-record)) + entry-name entry) + (unless record + (error "There is nothing to follow here")) + (setq entry-name (or (lsdb-current-entry) + (lsdb-read-entry record "Which entry to delete: ")) + entry (assq entry-name (cdr record))) + (when (and entry + (or (not lsdb-verbose) + (y-or-n-p + (format "Do you really want to delete entry `%s' of `%s'? " + entry-name (car record))))) + (lsdb-delete-entry record entry) + (lsdb-mode-delete-entry-1 entry)))) + +(defun lsdb-mode-delete-record () + "Delete the record on the current line." + (interactive) + (let ((record (lsdb-current-record))) + (unless record + (error "%s" "There is nothing to follow here")) + (when (or (not lsdb-verbose) + (yes-or-no-p + (format "Do you really want to delete entire record of `%s'? " + (car record)))) + (lsdb-delete-record record) + (save-restriction + (lsdb-narrow-to-record) + (let ((inhibit-read-only t) + buffer-read-only) + (delete-region (point-min) (point-max))))))) + +(defun lsdb-mode-delete-entry-or-record () + "Delete the entry on the current line. +If the cursor is on the first line of a database entry (the name line) +then the entire entry will be deleted." + (interactive) + (if (lsdb-current-entry) + (lsdb-mode-delete-entry) + (lsdb-mode-delete-record))) + +(defun lsdb-mode-edit-entry () + "Edit the entry on the current line." + (interactive) + (let ((record (lsdb-current-record))) + (unless record + (error "There is nothing to follow here")) + (let ((entry-name (or (lsdb-current-entry) + (lsdb-read-entry record "Which entry to edit: ")))) + (lsdb-edit-form + (cdr (assq entry-name (cdr record))) "Editing the entry." + `(lambda (form) + (let* ((record ',record) + (entry-name ',entry-name) + (entry (assq entry-name (cdr record)))) + (unless (equal form (cdr entry)) + (setcdr entry form) + (run-hook-with-args 'lsdb-after-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t) + (with-current-buffer lsdb-buffer-name + (let ((inhibit-read-only t) + buffer-read-only + (pos (text-property-any (point-min) (point-max) + 'lsdb-record record))) + (unless pos + (error "%s" "The entry currently in editing is discarded")) + (lsdb-mode-delete-entry-1 entry) + (forward-line 0) + (add-text-properties + (point) + (progn + (lsdb-insert-entry (cons entry-name form)) + (point)) + (list 'lsdb-record record))))))))))) + +(defun lsdb-mode-edit-record () + "Edit the name of the record on the current line." + (interactive) + (let ((record (lsdb-current-record))) + (unless record + (error "There is nothing to follow here")) + (lsdb-edit-form + (car record) "Editing the name." + `(lambda (new-name) + (unless (stringp new-name) + (error "String is required: `%s'" new-name)) + (let* ((record ',record) + (old-name (car record))) + (unless (equal new-name old-name) + (lsdb-delete-record record) + (setcar record new-name) + (lsdb-puthash new-name (cdr record) lsdb-hash-table) + (run-hook-with-args 'lsdb-after-update-record-functions record) + (setq lsdb-hash-tables-are-dirty t) + (with-current-buffer lsdb-buffer-name + (let ((inhibit-read-only t) + buffer-read-only + (pos (text-property-any (point-min) (point-max) + 'lsdb-record record))) + (unless pos + (error "%s" "The entry currently in editing is discarded")) + (delete-region (point) (+ (point) (length old-name))) + (add-text-properties (point) + (progn (insert form) (point)) + (list 'lsdb-record record)))))))))) + +(defun lsdb-mode-edit-entry-or-record () + "Edit the entry on the current line. +If the cursor is on the first line of a database entry (the name line) +then the name of this record will be edited." + (interactive) + (if (lsdb-current-entry) + (lsdb-mode-edit-entry) + (lsdb-mode-edit-record))) + +(defun lsdb-mode-save (&optional dont-ask) + "Save LSDB hash table into `lsdb-file'." + (interactive (list t)) + (if (not lsdb-hash-tables-are-dirty) + (message "(No changes need to be saved)") + (when (or dont-ask + (not lsdb-verbose) + (y-or-n-p "Save the LSDB now? ")) + (lsdb-save-hash-tables) + (set-buffer-modified-p (setq lsdb-hash-tables-are-dirty nil)) + (message "The LSDB was saved successfully.")))) + +(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 + (progn + (lambda (key value) + (let ((entry (cdr (assq entry-name value))) + found) + (unless (listp entry) + (setq entry (list entry))) + (while (and (not found) entry) + (if (string-match regexp (pop entry)) + (setq found t))) + (if found + (push (cons key value) records))))) + (lambda (key value) + (if (string-match regexp key) + (push (cons key value) records)))) + lsdb-hash-table) + records)) + +(defvar lsdb-mode-lookup-history nil) + +(defun lsdb-mode-lookup (regexp &optional entry-name) + "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 + (if current-prefix-arg + (completing-read "Entry name: " + lsdb-known-entry-names)))) + (list + (read-from-minibuffer + (if entry-name + (format "Search records `%s' regexp: " entry-name) + "Search records regexp: ") + nil nil nil 'lsdb-mode-lookup-history) + (if (and entry-name (not (equal entry-name ""))) + (intern (downcase entry-name)))))) + (lsdb-maybe-load-hash-tables) + (let ((records (lsdb-lookup-records regexp entry-name))) + (if records + (lsdb-display-records records)))) + +;;;###autoload +(defalias 'lsdb 'lsdb-mode-lookup) + +(defun lsdb-mode-next-record (&optional arg) + "Go to the next record." + (interactive "p") + (unless arg ;called noninteractively? + (setq arg 1)) + (if (< arg 0) + (lsdb-mode-previous-record (- arg)) + (while (> arg 0) + (goto-char (next-single-property-change + (point) 'lsdb-record nil (point-max))) + (setq arg (1- arg))))) + +(defun lsdb-mode-previous-record (&optional arg) + "Go to the previous record." + (interactive "p") + (unless arg ;called noninteractively? + (setq arg 1)) + (if (< arg 0) + (lsdb-mode-next-record (- arg)) + (while (> arg 0) + (goto-char (previous-single-property-change + (point) 'lsdb-record nil (point-min))) + (setq arg (1- arg))))) + +;;;_ : Edit Forms -- stolen (and renamed) from gnus-eform.el +(defvar lsdb-edit-form-buffer "*LSDB edit form*") +(defvar lsdb-edit-form-done-function nil) +(defvar lsdb-previous-window-configuration nil) + +(defvar lsdb-edit-form-mode-map + (let ((keymap (make-sparse-keymap))) + (set-keymap-parent keymap emacs-lisp-mode-map) + (define-key keymap "\C-c\C-c" 'lsdb-edit-form-done) + (define-key keymap "\C-c\C-k" 'lsdb-edit-form-exit) + keymap) + "Edit form's keymap.") + +(defun lsdb-edit-form-mode () + "Major mode for editing forms. +It is a slightly enhanced emacs-lisp-mode. + +\\{lsdb-edit-form-mode-map}" + (interactive) + (kill-all-local-variables) + (setq major-mode 'lsdb-edit-form-mode + mode-name "LSDB Edit Form") + (use-local-map lsdb-edit-form-mode-map) + (make-local-variable 'lsdb-edit-form-done-function) + (make-local-variable 'lsdb-previous-window-configuration) + (run-hooks 'lsdb-edit-form-mode-hook)) + +(defun lsdb-edit-form (form documentation exit-func) + "Edit FORM in a new buffer. +Call EXIT-FUNC on exit. Display DOCUMENTATION in the beginning +of the buffer." + (let ((window-configuration + (current-window-configuration))) + (switch-to-buffer (get-buffer-create lsdb-edit-form-buffer)) + (lsdb-edit-form-mode) + (setq lsdb-previous-window-configuration window-configuration + lsdb-edit-form-done-function exit-func) + (erase-buffer) + (insert documentation) + (unless (bolp) + (insert "\n")) + (goto-char (point-min)) + (while (not (eobp)) + (insert ";;; ") + (forward-line 1)) + (insert ";; Type `C-c C-c' after you've finished editing.\n") + (insert "\n") + (let ((p (point))) + (pp form (current-buffer)) + (insert "\n") + (goto-char p)))) + +(defun lsdb-edit-form-done () + "Update changes and kill the current buffer." + (interactive) + (goto-char (point-min)) + (let ((form (condition-case nil + (read (current-buffer)) + (end-of-file nil))) + (func lsdb-edit-form-done-function)) + (lsdb-edit-form-exit) + (funcall func form))) + +(defun lsdb-edit-form-exit () + "Kill the current buffer." + (interactive) + (let ((window-configuration lsdb-previous-window-configuration)) + (kill-buffer (current-buffer)) + (set-window-configuration window-configuration))) ;;;_. Interface to Semi-gnus ;;;###autoload (defun lsdb-gnus-insinuate () "Call this function to hook LSDB into Semi-gnus." (add-hook 'gnus-article-prepare-hook 'lsdb-gnus-update-record) - (add-hook 'gnus-save-newsrc-hook 'lsdb-offer-save)) + (add-hook 'gnus-save-newsrc-hook 'lsdb-mode-save)) -(defvar gnus-current-headers) +(defvar gnus-article-current-summary) +(defvar gnus-original-article-buffer) (defun lsdb-gnus-update-record () - (let ((entity gnus-current-headers) - records) - (with-temp-buffer - (set-buffer-multibyte nil) - (buffer-disable-undo) - (mime-insert-entity entity) - (setq records (lsdb-update-records)) - (when records - (lsdb-display-record (car records)))))) + (with-current-buffer (with-current-buffer gnus-article-current-summary + gnus-original-article-buffer) + (lsdb-update-records-and-display))) ;;;_. Interface to Wanderlust +;;;###autoload (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-exit-hook 'lsdb-offer-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-update-records-and-display)))) + +(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 + (condition-case nil + (progn + (require 'mew) + ;; Avoid macro `mew-cache-hit' expand (Mew 1.94.2 or earlier). + ;; Changed `mew-cache-hit' from macro to function at Mew 2.0. + (if (not (fboundp 'mew-current-get-fld)) + (setq byte-compile-macro-environment + (cons '(mew-cache-hit . nil) + byte-compile-macro-environment)))) + (error + ;; Silence byte compiler for environments where Mew does not installed. + (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")))) + +;;;###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))) + (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)) + (lsdb-update-records-and-display)))))) + +;;;_. 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 + (lsdb-lookup-records (concat "\\<" address "\\>") 'net))) + (if records + (cdr (assq 'attribution (cdr (car records))))))) + +(defun lsdb-mu-set-attribution (attribution address) + "Add attribute information to LSDB." + (let ((records + (lsdb-lookup-records (concat "\\<" address "\\>") 'net)) + entry) + (when records + (setq entry (assq 'attribution (cdr (car records)))) + (if entry + (setcdr entry attribution) + (setcdr (car records) (cons (cons 'attribution attribution) + (cdr (car records)))) + (lsdb-puthash (car (car records)) (cdr (car records)) + lsdb-hash-table) + (run-hook-with-args 'lsdb-after-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 \">\". +If an `attribution' value is found in LSDB, the value is returned. +Otherwise \">\" is returned." + (or (lsdb-mu-attribution (mu-cite-get-value 'address)) + ">")) + +(defvar minibuffer-allow-text-properties) + +(defvar lsdb-mu-history nil) + +(defun lsdb-mu-get-prefix-register-method () + "A mu-cite method to return a prefix from LSDB or register it. +If an `attribution' value is found in LSDB, the value is returned. +Otherwise the function requests a prefix from a user. The prefix will +be registered to LSDB if the user wants it." + (let ((address (mu-cite-get-value 'address))) + (or (lsdb-mu-attribution address) + (let* (minibuffer-allow-text-properties + (result (read-string "Citation name? " + (or (mu-cite-get-value 'x-attribution) + (mu-cite-get-value 'full-name)) + 'lsdb-mu-history))) + (if (and (not (string-equal result "")) + (y-or-n-p (format "Register \"%s\"? " result))) + (lsdb-mu-set-attribution result address)) + result)))) +(defun lsdb-mu-get-prefix-register-verbose-method () + "A mu-cite method to return a prefix using LSDB. + +In this method, a user must specify a prefix unconditionally. If an +`attribution' value is found in LSDB, the value is used as a initial +value to input the prefix. The prefix will be registered to LSDB if +the user wants it." + (let* ((address (mu-cite-get-value 'address)) + (attribution (lsdb-mu-attribution address)) + minibuffer-allow-text-properties + (result (read-string "Citation name? " + (or attribution + (mu-cite-get-value 'x-attribution) + (mu-cite-get-value 'full-name)) + 'lsdb-mu-history))) + (if (and (not (string-equal result "")) + (not (string-equal result attribution)) + (y-or-n-p (format "Register \"%s\"? " result))) + (lsdb-mu-set-attribution result address)) + result)) + +(defvar mu-cite-methods-alist) +;;;###autoload +(defun lsdb-mu-insinuate () + (add-hook 'mu-cite-instantiation-hook + (lambda () + (setq mu-cite-methods-alist + (nconc + mu-cite-methods-alist + (list + (cons 'lsdb-prefix + #'lsdb-mu-get-prefix-method) + (cons 'lsdb-prefix-register + #'lsdb-mu-get-prefix-register-method) + (cons 'lsdb-prefix-register-verbose + #'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)))) + (delimiter "\r ")) + (when (and lsdb-insert-x-face-function + x-face) + (goto-char (point-min)) + (end-of-line) + (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) + (coding-system-for-read 'binary) + (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 10))) + ;;;_* Local emacs vars. -;;; The following `outline-layout' local variable setting: +;;; The following `allout-layout' local variable setting: ;;; - closes all topics from the first topic to just before the third-to-last, ;;; - shows the children of the third to last (config vars) ;;; - and the second to last (code section), ;;; - and closes the last topic (this local-variables section). ;;;Local variables: -;;;outline-layout: (0 : -1 -1 0) +;;;allout-layout: (0 : -1 -1 0) ;;;End: ;;; lsdb.el ends here