howm-mode.el

   1 ;;; howm-mode.el --- Wiki-like note-taking tool
   2 ;;; Copyright (C) 2002, 2003, 2004, 2005-2022
   3 ;;;   HIRAOKA Kazuyuki <khi@users.osdn.me>
   4 ;;;
   5 ;;; This program is free software; you can redistribute it and/or modify
   6 ;;; it under the terms of the GNU General Public License as published by
   7 ;;; the Free Software Foundation; either version 1, or (at your option)
   8 ;;; any later version.
   9 ;;;
  10 ;;; This program is distributed in the hope that it will be useful,
  11 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ;;; GNU General Public License for more details.
  14 ;;;
  15 ;;; The GNU General Public License is available by anonymouse ftp from
  16 ;;; prep.ai.mit.edu in pub/gnu/COPYING.  Alternately, you can write to
  17 ;;; the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  18 ;;; USA.
  19 ;;;--------------------------------------------------------------------
  20
  21 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  22 ;; Backward compatibility
  23
  24 ;; (require 'howm-mode) in .emacs is obsolete. Use (require 'howm) instead.
  25
  26 ;; This must be earlier than (require 'howm-common), because
  27 ;; howm-common needs cl, and (require 'cl) should be written in howm.el.
  28 (when (not (featurep 'howm))
  29   (message "Warning: Requiring howm-mode is obsolete. Require howm instead.")
  30 ;;   (beep)
  31 ;;   (sit-for 1)
  32   (require 'howm))
  33
  34 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  35 ;; Require
  36
  37 (provide 'howm-mode)
  38 (require 'howm)
  39
  40 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  41 ;; Customize
  42
  43 ;;; --- level 1 ---
  44
  45 ;; You can easily modify them.
  46
  47 (howm-defvar-risky howm-template
  48   (concat howm-view-title-header " %title%cursor\n%date %file\n\n")
  49   "Contents of new file. %xxx are replaced with specified items.
  50 If it is a list, <n>-th one is used when you type C-u <n> M-x howm-create.
  51 If it is a function, it is called to get template string with the argument <n>.")
  52 (defvar howm-keyword-header "<<<"
  53   "Header string for declaration of keyword (implicit link).")
  54 (defvar howm-ref-header ">>>"
  55   "Header string for explicit link.")
  56 (defvar howm-lighter " howm"
  57   "Mode line for howm-mode")
  58
  59 (defvar howm-inhibit-title-file-match t
  60   "If non-nil, inhibit howm-list-title when search string matches file name")
  61 (defvar howm-list-all-title nil) ;; obsolete [2003-11-30]
  62 (defvar howm-list-recent-title nil) ;; obsolete [2003-11-30]
  63
  64 (defvar howm-default-key-table
  65   '(
  66     ;; ("key" func list-mode-p global-p)
  67     ("r" howm-refresh)
  68     ("l" howm-list-recent t t)
  69     ("a" howm-list-all t t)
  70     ("g" howm-list-grep t t)
  71     ("s" howm-list-grep-fixed t t)
  72     ("m" howm-list-migemo t t)
  73     ("t" howm-list-todo t t)
  74     ("y" howm-list-schedule t t)
  75     ("b" howm-list-buffers t t)
  76     ("x" howm-list-mark-ring t t)
  77     ("o" howm-occur t t)
  78     ("c" howm-create t t)
  79     ("e" howm-remember t t)
  80     ("," howm-menu t t)
  81     ("." howm-find-today nil t)
  82     (":" howm-find-yesterday nil t)
  83     ("A" howm-list-around)
  84     ("h" howm-history nil t)
  85     ("D" howm-dup)
  86     ("i" howm-insert-keyword nil t)
  87     ("d" howm-insert-date nil t)
  88     ("T" howm-insert-dtime nil t)
  89     ("K" howm-keyword-to-kill-ring t t)
  90     ("n" action-lock-goto-next-link)
  91     ("p" action-lock-goto-previous-link)
  92     ("Q" howm-kill-all t t)
  93     (" " howm-toggle-buffer nil t)
  94     ("N" howm-next-memo)
  95     ("P" howm-previous-memo)
  96     ("H" howm-first-memo)
  97     ("L" howm-last-memo)
  98     ("C" howm-create-here nil t)
  99     ("I" howm-create-interactively nil t)
 100     ("w" howm-random-walk nil t)
 101     ("M" howm-open-named-file t t)
 102     )
 103   "List of (key function list-mode-p global-p).
 104 `howm-prefix' + this key is real stroke.
 105 If optional argument list-mode-p is non-nil,
 106 same key is also available in view mode.
 107 It is further registered globally if global-p is non-nil."
 108   )
 109
 110 (howm-defvar-risky howm-migemo-client nil
 111   "Command name of migemo-client.
 112 Example of cmigemo:
 113   (setq howm-migemo-client '((type . cmigemo) (command . \"cmigemo\")))
 114 Example of migemo-client (obsolete):
 115   (setq howm-migemo-client \"migemo-client\")
 116 See also `howm-migemo-client-option`")
 117 (howm-defvar-risky howm-migemo-client-option nil
 118   "List of option for migemo-client.
 119 Example of cmigemo:
 120   (setq howm-migemo-client-option
 121         '(\"-q\" \"-d\" \"/usr/share/cmigemo/utf-8/migemo-dict\"))
 122 Example of migemo-client (obsolete):
 123   (setq howm-migemo-client-option '(\"-H\" \"::1\")
 124 See also `howm-migemo-client`")
 125
 126 ;;; --- level 2 ---
 127
 128 ;; Be careful to keep consistency.
 129
 130 (howm-defvar-risky howm-keyword/ref-regexp-format
 131   "\\(%s\\)[ \t]*\\([^ \t\r\n].*\\)")
 132 (howm-defvar-risky howm-keyword-format
 133   (format "%s %%s" howm-keyword-header)
 134   "Format for declaration of keyword. See `format'.")
 135 (howm-defvar-risky howm-keyword-regexp
 136   (format howm-keyword/ref-regexp-format (regexp-quote howm-keyword-header)))
 137 (howm-defvar-risky howm-keyword-regexp-hilit-pos 1)
 138 (howm-defvar-risky howm-keyword-regexp-pos 2)
 139 (howm-defvar-risky howm-ref-regexp
 140   (format howm-keyword/ref-regexp-format (regexp-quote howm-ref-header))
 141   "Regexp for explicit link.")
 142 (howm-defvar-risky howm-ref-regexp-hilit-pos 0
 143   "Position of search string in `howm-ref-regexp'")
 144 (howm-defvar-risky howm-ref-regexp-pos 2
 145   "Position of search string in `howm-ref-regexp'")
 146 (howm-defvar-risky howm-wiki-regexp "\\[\\[\\([^]\r\n]+\\)\\]\\]"
 147   "Regexp for explicit link.")
 148 (howm-defvar-risky howm-wiki-regexp-hilit-pos 1
 149   "Position of hilight in `howm-wiki-regexp'")
 150 (howm-defvar-risky howm-wiki-regexp-pos 1
 151   "Position of search string in `howm-wiki-regexp'")
 152 (howm-defvar-risky howm-wiki-format "[[%s]]"
 153   "Format for declaration of wiki word. See `format'.")
 154
 155 (howm-defvar-risky howm-template-rules
 156   '(("%title" . howm-template-title)
 157     ("%date" . howm-template-date)
 158     ("%file" . howm-template-previous-file)
 159     ("%cursor" . howm-template-cursor))) ;; Cursor must be the last rule.
 160 (defvar howm-template-date-format howm-dtime-format
 161   "%date is replaced with `howm-template-date-format'
 162 in `howm-template'. See `format-time-string'")
 163 (defvar howm-template-file-format (concat howm-ref-header " %s")
 164   "%file is replaced with `homw-template-file-format'
 165 in `howm-template'. %s is replaced with name of last file. See `format'.")
 166
 167 ;;; --- level 3 ---
 168
 169 ;; As you like.
 170
 171 (defun howm-action-lock-general (command regexp pos
 172                                          &optional hilit-pos
 173                                          &rest options)
 174   (list regexp
 175         `(lambda (&optional dummy)
 176            (let ((s (match-string-no-properties ,pos)))
 177 ;;             (when howm-keyword-case-fold-search
 178 ;;               (setq s (downcase s)))
 179              (,command s ,@options)))
 180         (or hilit-pos 0)
 181         t))
 182
 183 (defun howm-action-lock-search (regexp
 184                                 pos
 185                                 &optional hilit-pos create-p open-unique-p)
 186   (howm-action-lock-general 'howm-keyword-search
 187                             regexp pos hilit-pos create-p open-unique-p))
 188 (defun howm-action-lock-related (regexp pos hilit-pos)
 189   (howm-action-lock-general 'howm-list-related regexp pos hilit-pos))
 190
 191 (defun howm-action-lock-date-rule ()
 192   (action-lock-general 'howm-action-lock-date howm-date-regexp 0 0))
 193
 194 (defun howm-action-lock-quote-keyword (keyword)
 195   (let ((q (regexp-quote keyword)))
 196     ;; when a regexp is specified, leave unmatched keywords.
 197     (if (and (stringp howm-check-word-break)
 198              (not (string-match howm-check-word-break keyword)))
 199         q
 200       ;; add word break checks
 201       (concat "\\b" q "\\b"))))
 202
 203 (defun howm-action-lock-setup ()
 204   (setq action-lock-case-fold-search howm-keyword-case-fold-search)
 205   (action-lock-mode t)
 206   (let* ((date-al (action-lock-date "{_}" howm-dtime-format)))
 207     ;; override the rule in action-lock.el
 208     (action-lock-add-rules (list date-al) t))
 209   (let* ((ks (howm-keyword-for-goto))
 210          (r (mapconcat (if howm-check-word-break
 211                            #'howm-action-lock-quote-keyword
 212                          #'regexp-quote)
 213                        ks "\\|"))
 214          ;; The following optimization causes an error
 215          ;; "Variable binding depth exceeds max-specpdl-size".
 216          ;; (r (cond ((stringp howm-check-word-break)
 217          ;;           (mapconcat #'howm-action-lock-quote-keyword ks "\\|"))
 218          ;;          (t
 219          ;;           (regexp-opt ks (and howm-check-word-break 'word)))))
 220          (wiki (howm-action-lock-search howm-wiki-regexp
 221                                         howm-wiki-regexp-pos
 222                                         howm-wiki-regexp-hilit-pos
 223                                         t))
 224          (explicit (howm-action-lock-search howm-ref-regexp
 225                                             howm-ref-regexp-pos
 226                                             howm-ref-regexp-hilit-pos))
 227          (implicit (howm-action-lock-search r 0))
 228          (rev (howm-action-lock-related howm-keyword-regexp
 229                                         howm-keyword-regexp-pos
 230                                         howm-keyword-regexp-hilit-pos))
 231          (date (howm-action-lock-date-rule))
 232          (done (howm-action-lock-reminder-done-rule))
 233          (all `(
 234                 ,explicit
 235                 ,rev
 236                 ,@(if ks (list implicit) nil)
 237                 ,wiki
 238                 ,@(if (howm-menu-p) nil (list date done))
 239                 ))
 240          )
 241     ;; don't override the rule in action-lock.el
 242     ;; esp. http://xxx should call browser even if "<<< http" exists
 243     (action-lock-add-rules all)))
 244
 245 (defun howm-file-name (&optional time)
 246   (format-time-string howm-file-name-format
 247                       (or time (current-time))))
 248
 249 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 250 ;; Definitions
 251
 252 (define-minor-mode howm-mode
 253   "With no argument, this command toggles the mode.
 254 Non-null prefix argument turns on the mode.
 255 Null prefix argument turns off the mode.
 256
 257 When the mode is enabled, underlines are drawn on texts which match
 258 to titles of other files. Typing \\[action-lock-magic-return] there,
 259 you can jump to the corresponding file.
 260
 261 key     binding
 262 ---     -------
 263 \\[action-lock-magic-return]    Follow link
 264 \\[howm-refresh]        Refresh buffer
 265 \\[howm-list-all]       List all files
 266 \\[howm-list-grep]      Search (grep)
 267 \\[howm-create] Create new file
 268 \\[howm-dup]    Duplicate current file
 269 \\[howm-insert-keyword] Insert keyword
 270 \\[howm-insert-date]    Insert date
 271 \\[howm-insert-dtime]   Insert date with time
 272 \\[howm-keyword-to-kill-ring]   Copy current keyword to kill ring
 273 \\[action-lock-goto-next-link]  Go to next link
 274 \\[action-lock-goto-previous-link]      Go to previous link
 275 \\[howm-next-memo]      Go to next entry in current buffer
 276 \\[howm-previous-memo]  Go to previous entry in current buffer
 277 \\[howm-first-memo]     Go to first entry in current buffer
 278 \\[howm-last-memo]      Go to last entry in current buffer
 279 \\[howm-create-here]    Add new entry to current buffer
 280 \\[howm-create-interactively]   Create new file interactively (not recommended)
 281 \\[howm-random-walk]    Browse random entries automtically
 282 "
 283   :init-value nil ;; default = off
 284   :lighter howm-lighter ;; mode-line
 285   :keymap (mapcar (lambda (entry)
 286                     (let ((k (car entry))
 287                           (f (cadr entry)))
 288                       (cons (concat howm-prefix k) f)))
 289                   howm-default-key-table)
 290   (if howm-mode
 291       (howm-initialize-buffer)
 292     (howm-restore-buffer)))
 293
 294 (defun howm-set-keymap ()
 295   (mapc (lambda (entry)
 296           (let* ((k (car entry))
 297                  (f (cadr entry))
 298                  (list-mode-p (cl-caddr entry))
 299                  (global-p (cl-cadddr entry))
 300                  (pk (concat howm-prefix k)))
 301             (define-key howm-mode-map pk f)
 302             (when list-mode-p
 303               (mapc (lambda (m)
 304                       (define-key m k f)
 305                       (define-key m pk f))
 306                     (list howm-view-summary-mode-map
 307                           howm-view-contents-mode-map)))
 308             (when global-p
 309               (define-key global-map pk f))))
 310         howm-default-key-table)
 311   (define-key howm-mode-map "\C-x\C-s" 'howm-save-buffer))
 312 (howm-set-keymap)
 313
 314 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 315 ;; Main functions
 316
 317 (defun howm-refresh ()
 318   (interactive)
 319   (if (howm-menu-p)
 320       (howm-menu-refresh)
 321     (howm-initialize-buffer)))
 322
 323 (defun howm-initialize-buffer ()
 324   (interactive)
 325   (when (not howm-mode)
 326     (error "Not howm-mode"))
 327   (howm-message-time "init-buf"
 328     (save-restriction
 329       (widen)
 330       (howm-set-configuration-for-major-mode major-mode)
 331       (howm-action-lock-setup)
 332       (howm-mode-add-font-lock)
 333       (howm-reminder-add-font-lock)
 334       (cheat-font-lock-fontify)
 335       ;; make-local-hook is obsolete for emacs >= 21.1.
 336       (howm-funcall-if-defined (make-local-hook 'after-save-hook))
 337       (add-hook 'after-save-hook 'howm-after-save t t))))
 338
 339 (defun howm-after-save ()
 340   (when howm-mode
 341     (howm-keyword-add-current-buffer)
 342     (when howm-refresh-after-save
 343       (howm-initialize-buffer))
 344     (when (and howm-menu-refresh-after-save
 345                (> howm-menu-expiry-hours 0))
 346       (howm-menu-refresh-background))
 347     (run-hooks 'howm-after-save-hook)))
 348
 349 (defun howm-restore-buffer ()
 350   (action-lock-mode 0))
 351
 352 (defun howm-list-all ()
 353   (interactive)
 354   (howm-set-command 'howm-list-all)
 355   (howm-normalize-show "" (howm-all-items))
 356   ;; for backward compatibility
 357   (cond ((howm-list-title-p) t)  ;; already done in howm-normalize-show
 358         (howm-list-all-title (howm-list-title-internal))))
 359
 360 (defun howm-all-items ()
 361   "Returns list of all items in the first search path."
 362   (howm-folder-items (car (howm-search-path)) t))
 363
 364 (defun howm-list-recent (&optional days)
 365   (interactive "P")
 366   (howm-set-command 'howm-list-recent)
 367   (let* ((d (or days howm-list-recent-days))
 368          (now (current-time))
 369          (from (howm-days-before now d))
 370          (item-list (howm-folder-items howm-directory t)))
 371     (howm-normalize-show "" (howm-filter-items-by-mtime item-list from now))
 372     ;; clean me [2003-11-30]
 373     (cond ((howm-list-title-p) t)  ;; already done in howm-normalize-show
 374           (howm-list-recent-title (howm-list-title-internal))
 375           ((not days) (howm-view-summary-to-contents)))))
 376
 377 ;; clean me: direct access to howm-view-* is undesirable.
 378
 379 (defvar howm-list-title-previous nil
 380   "For internal use")
 381 (make-variable-buffer-local 'howm-list-title-previous)
 382 (defun howm-list-title-put-previous (&optional item-list)
 383   (when howm-list-title-undo
 384     (setq howm-list-title-previous (or item-list (howm-view-item-list)))))
 385 (defun howm-list-title-clear-previous ()
 386   (setq howm-list-title-previous nil))
 387 (defun howm-list-title-get-previous ()
 388   (if howm-list-title-undo
 389       (let ((prev howm-list-title-previous))
 390         (setq howm-list-title-previous nil)
 391         (howm-view-summary-rebuild prev))
 392     (error "Undo is not enabled.")))
 393 (defun howm-list-title-regexp ()
 394   (or howm-list-title-regexp (howm-view-title-regexp-grep)))
 395 (defalias 'howm-list-title 'howm-list-toggle-title) ;; backward compatibility
 396 (defun howm-list-toggle-title (&optional undo)
 397   (interactive "P")
 398   (if (or undo howm-list-title-previous)
 399       (howm-list-title-get-previous)
 400     (howm-list-title-internal)))
 401 (defun howm-list-title-internal ()
 402   (let ((b (current-buffer)))
 403     (howm-list-title-put-previous)
 404     (howm-view-list-title (howm-list-title-regexp))
 405     ;;       (howm-view-filter-by-contents (howm-list-title-regexp))
 406     (let ((c (current-buffer)))
 407       (when (not (eq b c))
 408         (set-buffer b)
 409         (howm-view-kill-buffer)
 410         (switch-to-buffer c)
 411         (howm-view-summary-check t)))))
 412
 413 (defun howm-list-title-p ()
 414   (let ((a (howm-get-value howm-list-title)))
 415     (cond ((null a) nil) ;; I know this is redundant.
 416           ((listp a) (member (howm-command) a))
 417           (t a))))
 418
 419 (defun howm-days-after (ti days &optional hours)
 420   (let* ((ne (howm-decode-time ti))
 421          (hour-pos 2)
 422          (day-pos 3)
 423          (nh (nth hour-pos ne))
 424          (nd (nth day-pos ne)))
 425     (setf (nth hour-pos ne) (+ nh (or hours 0)))
 426     (setf (nth day-pos ne) (+ nd days))
 427     (apply #'encode-time ne)))
 428
 429 (defun howm-days-before (ti days)
 430   (howm-days-after ti (- days)))
 431
 432 (defun howm-list-grep (&optional completion-p)
 433   (interactive "P")
 434   (howm-set-command 'howm-list-grep)
 435   (howm-list-grep-general completion-p))
 436
 437 (defun howm-list-grep-fixed ()
 438   (interactive)
 439   (howm-set-command 'howm-list-grep-fixed)
 440   (howm-list-grep-general t))
 441
 442 (defun howm-list-grep-general (&optional completion-p)
 443   (let* ((action (lambda (pattern) (howm-search pattern completion-p)))
 444          (regexp (howm-iigrep completion-p action)))
 445     (when completion-p  ;; Goto link works only for fixed string at now.
 446       (howm-write-history regexp))
 447     (funcall action regexp)))
 448
 449 (defun howm-search (regexp fixed-p &optional emacs-regexp filter bufname)
 450   (if (string= regexp "")
 451       (howm-list-all)
 452     (howm-message-time "search"
 453       (let* ((trio (howm-call-view-search-internal regexp fixed-p emacs-regexp))
 454              (kw (car trio))
 455              (name (or bufname (cadr trio)))
 456              (items (cl-caddr trio)))
 457         (when filter
 458           (setq items (funcall filter items)))
 459         (howm-normalize-show name items (or emacs-regexp regexp) nil nil kw)
 460         (howm-record-view-window-configuration)))))
 461
 462 (defun howm-iigrep (completion-p action)
 463   (howm-with-iigrep (howm-iigrep-command-for-pattern completion-p)
 464       howm-iigrep-show-what action
 465     (if completion-p
 466         (howm-completing-read-keyword)
 467       (read-from-minibuffer "Search all (grep): "))))
 468
 469 (defmacro howm-with-iigrep (command-for-pattern show-what action &rest body)
 470   (declare (indent 3))
 471   `(let ((*iigrep-post-sentinel* (howm-iigrep-post-sentinel ,action))
 472          (howm-history-limit 0)
 473          (*howm-show-item-filename* nil)
 474          (howm-message-time nil))
 475      (iigrep-with-grep ,command-for-pattern ,show-what
 476        ,@body)))
 477
 478 (defmacro howm-iigrep-command-for-pattern (&optional fixed-p converter)
 479   ;; use macro due to dynamic binding. Sigh...
 480   `(and howm-view-use-grep
 481         (lambda (str)
 482           (let* ((pattern (funcall (or ,converter #'identity) str))
 483                  (trio (howm-real-grep-single-command
 484                         pattern (list howm-directory) ,fixed-p))
 485                  (com (car trio))
 486                  (args (cl-second trio))
 487                  (fs (cl-third trio)))
 488             (append (list com) (cons "-I" args) fs)))))
 489
 490 (defmacro howm-iigrep-post-sentinel (action)
 491   ;; use macro due to dynamic binding. Sigh...
 492   `(lambda (hits pattern)
 493      (when (<= hits howm-iigrep-preview-items)
 494        (save-selected-window
 495          (funcall ,action pattern)))))
 496
 497 (defvar *howm-view-window-configuration* nil
 498   "For internal use")
 499 (defun howm-view-window-configuration ()
 500   *howm-view-window-configuration*)
 501 (defun howm-set-view-window-configuration (conf)
 502   (setq *howm-view-window-configuration* conf))
 503 (defun howm-record-view-window-configuration ()
 504   (howm-set-view-window-configuration (current-window-configuration)))
 505 (defun howm-restore-view-window-configuration ()
 506   (set-window-configuration (howm-view-window-configuration)))
 507 (defun howm-return-to-list ()
 508   (interactive)
 509   (howm-restore-view-window-configuration))
 510
 511 (defun howm-call-view-search-internal (regexp fixed-p &optional emacs-regexp)
 512   (let ((hilit (if emacs-regexp
 513                    `((,emacs-regexp . howm-view-hilit-face))
 514                  nil)))
 515     (howm-view-search-folder-internal regexp (howm-search-path-folder)
 516                                       nil nil fixed-p hilit)))
 517
 518 (defun howm-list-migemo (&optional completion-p)
 519   (interactive "P")
 520   (howm-set-command 'howm-list-migemo)
 521   (if completion-p
 522       (howm-list-grep t)
 523     (howm-list-migemo-action (howm-iigrep-migemo))))
 524
 525 (defun howm-list-migemo-action (roma)
 526   (let* ((e-reg (howm-migemo-get-pattern roma "emacs"))
 527          (g-reg (if howm-view-use-grep
 528                     (howm-migemo-get-pattern roma "egrep")
 529                   e-reg)))
 530     (if (and e-reg g-reg)
 531         (howm-search g-reg nil e-reg nil roma)
 532       (message "No response from migemo-client."))))
 533
 534 (defun howm-iigrep-migemo ()
 535   (let* ((converter (lambda (yomi) (howm-migemo-get-pattern yomi "egrep")))
 536          (command-for-pattern (howm-iigrep-command-for-pattern nil converter))
 537          (show-what (if (eq howm-iigrep-migemo-show-what 'inherit)
 538                         howm-iigrep-show-what
 539                       howm-iigrep-migemo-show-what)))
 540     (howm-with-iigrep command-for-pattern show-what
 541                       #'howm-list-migemo-action
 542       (read-from-minibuffer "Search all (migemo): "))))
 543
 544 (defun howm-migemo-get-pattern (roma type)
 545   (when (and (null howm-migemo-client) (not howm-view-use-grep))
 546     (require 'migemo))
 547   (cl-labels ((ref (key) (cdr (assoc key howm-migemo-client))))
 548     (cond ((and (featurep 'migemo) (string= type "emacs"))
 549            (howm-funcall-if-defined (migemo-get-pattern roma)))
 550           ((or (null howm-migemo-client) (stringp howm-migemo-client))
 551            (car (howm-call-process (or howm-migemo-client "migemo-client")
 552                                    `(,@howm-migemo-client-option "-t" ,type ,roma)
 553                                    0)))
 554           ((eq (ref 'type) 'cmigemo)
 555            (car (howm-call-process (ref 'command)
 556                                    `(,@howm-migemo-client-option
 557                                      ,@(and (string= type "emacs") '("-e"))
 558                                      "-w" ,roma))))
 559           (t (error "Invalid howm-migemo-client: %s" howm-migemo-client)))))
 560
 561 (defun howm-normalize-oldp ()
 562   howm-list-normalizer)
 563
 564 ;; ;; generate conv in howm-normalizer-pair
 565 ;; (let ((methods '("random" "name" "numerical-name" "date" "reverse-date"
 566 ;;                  "summary" "reminder" "mtime" "reverse")))
 567 ;;   (mapcar (lambda (m)
 568 ;;             (let ((command
 569 ;;                    (howm-get-symbol nil "howm-view-sort-by-" m))
 570 ;;                   (internal
 571 ;;                    (howm-get-symbol nil "howm-sort-items-by-" m)))
 572 ;;               (cons command internal)))
 573 ;;           methods))
 574
 575 (defun howm-normalizer-pair ()
 576   (let* ((old howm-list-normalizer)
 577          (new howm-normalizer)
 578          (conv '((howm-view-sort-by-random . howm-sort-items-by-random)
 579                  (howm-view-sort-by-name . howm-sort-items-by-name)
 580                  (howm-view-sort-by-numerical-name
 581                   . howm-sort-items-by-numerical-name)
 582                  (howm-view-sort-by-date . howm-sort-items-by-date)
 583                  (howm-view-sort-by-reverse-date
 584                   . howm-sort-items-by-reverse-date)
 585                  (howm-view-sort-by-summary . howm-sort-items-by-summary)
 586                  (howm-view-sort-by-reminder . howm-sort-items-by-reminder)
 587                  (howm-view-sort-by-mtime . howm-sort-items-by-mtime)
 588                  (howm-view-sort-by-reverse . howm-sort-items-by-reverse)))
 589          (p (assoc old conv))
 590          (q (assoc new conv)))
 591     (when q
 592       (message "Warning: %s is wrong for howm-normalizer. Use %s." (car q) (cdr q))
 593       (setq new (cdr q)))
 594     (cond ((null old) (cons old new))
 595           (p (cons nil (cdr p)))
 596           (t (cons old #'identity)))))
 597
 598 (defmacro howm-with-normalizer (&rest body)
 599   (declare (indent 0))
 600   (let ((g (cl-gensym)))
 601     `(progn
 602        (when (howm-normalize-oldp)
 603          (message
 604           "Warning: howm-list-normalizer is obsolete. Use howm-normalizer."))
 605        (let* ((,g (howm-normalizer-pair))
 606               (howm-list-normalizer (car ,g))
 607               (howm-normalizer (cdr ,g)))
 608          ,@body))))
 609
 610 (defun howm-normalize-show (name item-list
 611                                  &optional keyword comefrom-regexp no-list-title
 612                                  fl-keywords)
 613   ;; comefrom-regexp and no-list-title are never used now. [2009-07-23]
 614   (howm-with-normalizer
 615     (if (howm-normalize-oldp)
 616         ;; for backward compatibility.
 617         (progn
 618           (howm-view-summary name item-list fl-keywords)
 619           (howm-list-normalize-old keyword comefrom-regexp no-list-title))
 620       (let* ((r (howm-normalize item-list keyword
 621                                 comefrom-regexp no-list-title)))
 622         (howm-call-view-summary name (cdr r) fl-keywords)
 623         (car r)))))
 624
 625 (defun howm-call-view-summary (name item-list-pair fl-keywords)
 626   (let ((orig (car item-list-pair))
 627         (entitled (cdr item-list-pair)))
 628     (howm-view-summary name (or entitled orig) fl-keywords)
 629     ;; side effect
 630     (if entitled
 631         (howm-list-title-put-previous orig)
 632       (howm-list-title-clear-previous))))
 633
 634 (defun howm-normalize (item-list
 635                        &optional keyword comefrom-regexp no-list-title)
 636   ;; no-list-title is never used now. [2009-07-23]
 637   "Sort ITEM-LIST in the standard order."
 638   (let ((matched nil)
 639         (entitled-item-list nil))
 640     (setq item-list (funcall howm-normalizer item-list))
 641     (when keyword
 642       (let ((key-reg (or comefrom-regexp
 643                          (howm-make-keyword-regexp1 keyword)))
 644             (word-reg (format "\\<%s\\>"
 645                               (if (stringp keyword)
 646                                   (regexp-quote keyword)
 647                                 (regexp-opt keyword t))))
 648             (wiki-reg (regexp-quote (howm-make-wiki-string keyword)))
 649             (file-reg (and
 650                        (stringp keyword)
 651                        (format "^%s$"
 652                                (regexp-quote (expand-file-name keyword)))))
 653             (case-fold-search howm-keyword-case-fold-search))
 654         (cl-labels ((check (tag flag reg &optional tag-when-multi-hits)
 655                         (when flag
 656                           (let ((r (howm-normalize-check item-list tag reg
 657                                                          tag-when-multi-hits)))
 658                             (setq matched (append (car r) matched))
 659                             (setq item-list (cdr r))))))
 660           ;; not efficient. should I do them at once?
 661           (check 'word            howm-list-prefer-word word-reg)
 662           (check 'wiki            howm-list-prefer-wiki wiki-reg)
 663           (check 'related-keyword t howm-keyword-regexp)
 664           (check 'keyword         t key-reg 'keyword-multi-hits)
 665           (check 'file            file-reg file-reg))))
 666     (when (and (howm-list-title-p)
 667                (not no-list-title)
 668                (not (and (member 'file matched)
 669                          howm-inhibit-title-file-match)))
 670       (setq entitled-item-list
 671             (howm-entitle-items (howm-list-title-regexp) item-list)))
 672     (cons matched (cons item-list entitled-item-list))))
 673
 674 (defun howm-normalize-check (item-list tag reg tag-when-multi-hits)
 675   (let* ((r (if (eq tag 'file)
 676                 (howm-view-lift-by-path-internal item-list reg)
 677               (howm-view-lift-by-summary-internal item-list reg)))
 678          (m (car r))
 679          (item-list (cdr r))
 680          (matched (cond ((and tag-when-multi-hits (eq m 'multi))
 681                          (list tag-when-multi-hits tag))
 682                         (m (list tag))
 683                         (t nil))))
 684     (cons matched item-list)))
 685
 686 (defun howm-list-normalize-old (&optional keyword comefrom-regexp no-list-title)
 687   "Sort displayed items in the standard order.
 688 This function is obsolete. Use `howm-normalize' insteadly.
 689 --- Sorry, below documentation is incomplete. ---
 690 When KEYWORD is given, matched items are placed on the top.
 691 KEYWORD can be a string or a list of strings.
 692 "
 693   (prog1
 694       (howm-view-in-background
 695         (howm-list-normalize-subr keyword comefrom-regexp no-list-title))
 696     (howm-view-summary)))
 697
 698 (defun howm-list-normalize-subr (keyword comefrom-regexp no-list-title)
 699   "Obsolete. Do not use this any more."
 700   (let ((matched nil))
 701     (funcall howm-list-normalizer)
 702     (when keyword
 703       (let ((key-reg (or comefrom-regexp
 704                          (howm-make-keyword-regexp1 keyword)))
 705             (word-reg (format "\\<%s\\>"
 706                               (if (stringp keyword)
 707                                   (regexp-quote keyword)
 708                                 (regexp-opt keyword t))))
 709             (wiki-reg (regexp-quote (howm-make-wiki-string keyword)))
 710             (file-reg (and
 711                        (stringp keyword)
 712                        (format "^%s$"
 713                                (regexp-quote (expand-file-name keyword)))))
 714             (case-fold-search howm-keyword-case-fold-search))
 715         ;; clean me.
 716         (let ((check (lambda (tag flag reg &optional tag-when-multi-hits)
 717                        (when flag
 718                          (let ((m (if (eq tag 'file)
 719                                       (howm-view-lift-by-name nil reg t)
 720                                     (howm-view-lift-by-summary nil reg))))
 721                            (when m
 722                              (setq matched (cons tag matched)))
 723                            (when (and tag-when-multi-hits (eq m 'multi))
 724                              (setq matched
 725                                    (cons tag-when-multi-hits matched))))))))
 726           (funcall check 'word            howm-list-prefer-word word-reg)
 727           (funcall check 'wiki            howm-list-prefer-wiki wiki-reg)
 728           (funcall check 'related-keyword t howm-keyword-regexp)
 729           (funcall check 'keyword         t key-reg 'keyword-multi-hits)
 730           (funcall check 'file            file-reg file-reg))))
 731     (when (and (howm-list-title-p)
 732                (not no-list-title)
 733                (not (and (member 'file matched)
 734                          howm-inhibit-title-file-match)))
 735       (howm-list-title-internal))
 736     matched))
 737
 738 (defun howm-make-keyword-string (keyword)
 739   (format howm-keyword-format keyword))
 740 (defun howm-make-wiki-string (keyword)
 741   (format howm-wiki-format keyword))
 742
 743 ;; clean me
 744 (defvar howm-keyword-regexp-format "%s$"
 745   "Format to make entire-match regexp from keyword string.
 746 Default is \"%s$\" because we want to make regexp \"<<< foo$\"
 747 from keyword string \"<<< foo\",
 748 so that we can accept \"<<< foo\" and reject \"<<< foobar\".
 749 We need entire-match in order to
 750 (1) place \"<<< foo\" on the top when \"foo\" is searched, and
 751 (2) judge existence of \"<<< foo\" when [[foo]] is hit.")
 752 (defun howm-make-keyword-regexp1 (keyword)
 753   (howm-make-keyword-regexp-general keyword #'howm-make-keyword-regexp1-sub))
 754 (defun howm-make-keyword-regexp2 (keyword)
 755   (howm-make-keyword-regexp-general keyword #'howm-make-keyword-regexp2-sub))
 756 (defun howm-make-keyword-regexp1-sub (keyword)
 757   (format howm-keyword-regexp-format
 758           (regexp-quote (howm-make-keyword-string keyword))))
 759 (defun howm-make-keyword-regexp2-sub (keyword)
 760   (format howm-keyword-regexp-format
 761           (howm-make-keyword-string (regexp-quote keyword))))
 762 (defun howm-make-keyword-regexp-general (keyword regexp-generator)
 763   (cond ((stringp keyword)
 764          (funcall regexp-generator keyword))
 765         ((listp keyword)
 766          (mapconcat (lambda (s)
 767                       (concat "\\("
 768                               (funcall regexp-generator s)
 769                               "\\)"))
 770                     keyword
 771                     "\\|"))
 772         (t (error "Wrong type: %s" keyword))))
 773
 774 (defun howm-list-related (str)
 775   (howm-set-command 'howm-list-related)
 776   (let* ((keys (mapcar (lambda (k)
 777                          (if howm-keyword-case-fold-search
 778                              (downcase k)
 779                            k))
 780                        (howm-subkeyword str)))
 781          (filter `(lambda (items)
 782                     (howm-filter-items-by-summary items ,(regexp-opt keys)))))
 783     ;; Note that regexp-opt returns a regexp for emacs (not for grep).
 784     (howm-search (howm-make-keyword-string ".*") nil nil filter)))
 785
 786 (defun howm-subkeyword (str)
 787   (with-temp-buffer
 788     (insert str)
 789     (howm-keyword-for-goto)))
 790
 791 (defun howm-list-around ()
 792   (interactive)
 793   (howm-set-command 'howm-list-around)
 794   (let ((f (buffer-file-name))
 795         (item-list (howm-view-sort-by-reverse-date-internal
 796                     (howm-all-items))))
 797     (let ((howm-normalizer #'identity))
 798       (howm-normalize-show "" item-list))
 799     (let ((pos (cl-position-if (lambda (item)
 800                                       (string= (howm-item-name item) f))
 801                                     (howm-view-item-list))))
 802       (goto-char (point-min))
 803       (when pos
 804         (forward-line pos)))
 805     (howm-view-summary-check t)))
 806
 807 (defun howm-history ()
 808   (interactive)
 809   (unless (file-exists-p howm-history-file)
 810     (error "No history."))
 811   ;; disable expansion of %schedule etc.
 812   (let ((howm-menu-display-rules nil)) ;; dirty
 813     (howm-menu-open howm-history-file)))
 814
 815 ;; (defvar howm-history-exclude
 816 ;;   (let ((strings '("[0-9][0-9][0-9][0-9]" "^[*=] [^ ]")))
 817 ;;     `("| %.*%$"
 818 ;;       ,(mapconcat 'regexp-quote strings "\\|"))))
 819 ;; (defun howm-history ()
 820 ;;   (interactive)
 821 ;;   (howm-menu-open howm-history-file)
 822 ;;   (howm-edit-read-only-buffer
 823 ;;     (mapc #'flush-lines
 824 ;;           howm-history-exclude)))
 825
 826 (defvar *howm-command* nil
 827   "For internal use")
 828 (defun howm-set-command (com)
 829   (setq *howm-command* com))
 830 (defun howm-command ()
 831   *howm-command*)
 832
 833 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 834 ;; Create
 835
 836 (defun howm-create (&optional which-template here)
 837   (interactive "p")
 838   (let* ((t-c (howm-create-default-title-content))
 839          (title (car t-c))
 840          (content (cdr t-c)))
 841     (howm-create-file-with-title title which-template nil here content)))
 842
 843 (howm-dont-warn-free-variable transient-mark-mode)
 844 (howm-dont-warn-free-variable mark-active)
 845 (defun howm-create-default-title-content ()
 846   (let* ((p (point))
 847          (m (or (mark t) -777))
 848          (beg (min p m))
 849          (end (max p m))
 850          (search-str (howm-view-name)))
 851     (let* ((transient-mark-p (and (boundp 'transient-mark-mode)
 852                                   transient-mark-mode))
 853            (mark-active-p (and (boundp 'mark-active) mark-active))
 854            (active-p (if transient-mark-p
 855                          mark-active-p
 856                        t))
 857            (strictly-active-p (and transient-mark-p mark-active-p))
 858            (title-p (let* ((b (line-beginning-position))
 859                            (e (line-end-position)))
 860                       (and active-p
 861                            (< 0 beg) (<= b beg) (<= end e) (not (= beg end)))))
 862            (content-p (and strictly-active-p
 863                            howm-content-from-region))
 864            (search-p (and howm-title-from-search
 865                           (stringp search-str)))
 866            (s (cond ((or title-p content-p) (buffer-substring-no-properties beg
 867                                                                             end))
 868                     (search-p search-str))))
 869       (cond ((null s) (cons "" ""))
 870             ((eq content-p t) (cons "" s))
 871             ((or title-p search-p) (cons s ""))
 872             (content-p (cons "" s))
 873             (t (cons "" ""))))))
 874
 875 (defun howm-create-here (&optional which-template)
 876   (interactive "p")
 877   (howm-create which-template t))
 878
 879 (defun howm-create-file-with-title (title &optional
 880                                     which-template not-use-file here content)
 881   (let ((b (current-buffer)))
 882     (when (not here)
 883       (howm-create-file))
 884     (cond ((howm-buffer-empty-p) nil)
 885           ((and here howm-create-here-just) (beginning-of-line))
 886           (t (howm-create-newline)))
 887     (let ((p (point))
 888           (insert-f (lambda (switch)
 889                       (howm-insert-template (if switch title "")
 890                                             b which-template (not switch))))
 891           (use-file (not not-use-file)))
 892       ;; second candidate which appears when undo is called
 893       (let ((end (funcall insert-f not-use-file)))
 894         (save-excursion
 895           (goto-char end)
 896           (insert (or content "")))
 897         (undo-boundary)
 898         (delete-region p end))
 899       (funcall insert-f use-file))
 900     (howm-create-finish)))
 901
 902 (defun howm-create-finish ()
 903   (howm-set-mode)
 904   (run-hooks 'howm-create-hook))
 905
 906 (defun howm-create-newline ()
 907   (widen)
 908   (if howm-prepend
 909       (howm-create-newline-prepend)
 910     (howm-create-newline-append)))
 911 (defun howm-create-newline-prepend ()
 912   (goto-char (point-min)))
 913 (defun howm-create-newline-append ()
 914   (goto-char (point-max))
 915   (delete-blank-lines)
 916   (when (not (= (line-beginning-position) (point))) ;; not empty line
 917     (insert "\n"))
 918   (insert "\n"))
 919
 920 (defun howm-insert-template (title &optional
 921                                    previous-buffer which-template not-use-file)
 922   (let* ((beg (point))
 923          (f (buffer-file-name previous-buffer))
 924          (af (and f (howm-abbreviate-file-name f))))
 925     (insert (howm-template-string which-template previous-buffer))
 926     (let* ((date (format-time-string howm-template-date-format))
 927            (use-file (not not-use-file))
 928            (file (cond ((not use-file) "")
 929                        ((null f) "")
 930                        ((string= f (buffer-file-name)) "")
 931                        (t (format howm-template-file-format af)))))
 932       (let ((arg `((title . ,title) (date . ,date) (file . ,file)))
 933             (end (point-marker)))
 934         (howm-replace howm-template-rules arg beg end)
 935         end))))
 936
 937 (defvar howm-template-receive-buffer t
 938   "Non nil if howm-template should receive previous-buffer
 939 when howm-template is a function.
 940 Set this option to nil if backward compatibility with howm-1.2.4 or earlier
 941 is necessary.")
 942
 943 (defun howm-template-string (which-template previous-buffer)
 944   ;; which-template should be 1, 2, 3, ...
 945   (setq which-template (or which-template 1))
 946   (cond ((stringp howm-template) howm-template)
 947         ((functionp howm-template) (let ((args (if howm-template-receive-buffer
 948                                                    (list which-template
 949                                                          previous-buffer)
 950                                                  (list which-template))))
 951                                      (apply howm-template args)))
 952         ((listp howm-template) (nth (- which-template 1) howm-template))))
 953
 954 (defun howm-replace (rules arg &optional beg end)
 955   (mapc (lambda (pair)
 956           (let ((spell (car pair))
 957                 (disp-f (cdr pair)))
 958             (goto-char (or beg (point-min)))
 959             (while (re-search-forward spell end t)
 960               (delete-region (match-beginning 0) (match-end 0))
 961               (funcall disp-f arg))))
 962         rules))
 963
 964 (defun howm-template-title (arg)
 965   (insert (cdr (assoc 'title arg))))
 966 (defun howm-template-date (arg)
 967   (insert (cdr (assoc 'date arg))))
 968 (defun howm-template-previous-file (arg)
 969   (insert (cdr (assoc 'file arg))))
 970 (defun howm-template-cursor (arg)) ;; do nothing
 971
 972 (defun howm-dup ()
 973   (interactive)
 974   (let* ((r (howm-view-paragraph-region))
 975          (s (buffer-substring-no-properties (car r) (cadr r))))
 976     (howm-create-file)
 977     (howm-set-mode)
 978     (insert "\n" s)))
 979
 980 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 981 ;; Keyword
 982
 983 (defun howm-completing-read-keyword ()
 984   (message "Scanning...")
 985   (let* ((kl (howm-keyword-list))
 986          (table (mapcar #'list kl))
 987          (completion-ignore-case howm-keyword-case-fold-search))
 988     (completing-read "Keyword: " table)))
 989
 990 (defun howm-insert-keyword ()
 991   (interactive)
 992   (insert (howm-completing-read-keyword)))
 993
 994 (defun howm-keyword-to-kill-ring (&optional filename-p)
 995   (interactive "P")
 996   (let ((title (howm-title-at-current-point filename-p)))
 997     (if title
 998         (howm-string-to-kill-ring title)
 999       (error "No keyword."))))
1000
1001 (defun howm-title-at-current-point (&optional filename-p
1002                                               title-regexp title-regexp-pos)
1003   (let ((reg (or title-regexp howm-view-title-regexp))
1004         (pos (or title-regexp-pos howm-view-title-regexp-pos)))
1005     (save-excursion
1006       (end-of-line)
1007       (cond ((and (not filename-p)
1008                   (re-search-backward reg nil t))
1009              (match-string-no-properties pos))
1010             ((buffer-file-name)
1011              (howm-abbreviate-file-name (buffer-file-name)))
1012             (t nil)))))
1013
1014 (defun howm-string-to-kill-ring (str)
1015   (if str
1016       (progn
1017         (kill-new str)
1018         (message "%s" str))
1019     (error "Empty.")))
1020
1021 (defun howm-keyword-for-comefrom ()
1022   (save-excursion
1023     (goto-char (point-min))
1024     (let ((keyword-list nil))
1025       (while (re-search-forward howm-keyword-regexp nil t)
1026         (setq keyword-list
1027               (cons (match-string-no-properties howm-keyword-regexp-pos)
1028                     keyword-list)))
1029       (reverse keyword-list))))
1030
1031 (defun howm-keyword-list ()
1032   (let ((sep (format "[\n%s]" (or howm-keyword-list-alias-sep ""))))
1033     (with-current-buffer (howm-keyword-buffer)
1034       (delete ""
1035               (split-string (buffer-substring (point-min) (point-max)) sep)))))
1036
1037 (defun howm-keyword-add (keyword-list)
1038   (interactive "sKeyword: ")
1039   (setq keyword-list (if (stringp keyword-list)
1040                          (list keyword-list)
1041                        keyword-list))
1042   (with-current-buffer (howm-keyword-buffer)
1043     (save-excursion
1044       (goto-char (point-max))
1045       (mapc (lambda (k)
1046               (when (howm-keyword-new-p k)
1047                 (insert k "\n")))
1048             keyword-list)
1049       (when (buffer-file-name)
1050         (howm-basic-save-buffer)))))
1051
1052 (defun howm-keyword-new-p (str)
1053   (save-excursion
1054     (let ((r (format "^%s$" (regexp-quote str)))
1055           (case-fold-search howm-keyword-case-fold-search))
1056       (goto-char (point-min))
1057       (not (re-search-forward r nil t)))))
1058
1059 (defun howm-support-aliases-p ()
1060   howm-keyword-list-alias-sep)
1061 (defun howm-aliases ()
1062   (if (howm-support-aliases-p)
1063       (howm-read-aliases)
1064     nil))
1065 (defun howm-read-aliases ()
1066   (with-current-buffer (howm-keyword-buffer)
1067     (save-excursion
1068       (let ((ans nil))
1069         (goto-char (point-min))
1070         (while (search-forward howm-keyword-list-alias-sep nil t)
1071           (let* ((line (buffer-substring-no-properties (line-beginning-position)
1072                                                        (line-end-position)))
1073                  (keys (split-string line howm-keyword-list-alias-sep))
1074                  (ks (if howm-keyword-case-fold-search
1075                          (mapcar #'downcase keys)
1076                        keys)))
1077             (setq ans (cons ks ans))
1078             (end-of-line)))
1079         ans))))
1080
1081 (defun howm-expand-aliases-recursively (keyword aliases)
1082   (let ((keys (list keyword))
1083         (prev nil))
1084     (cl-labels ((expand (keys)
1085                      (sort (cl-remove-duplicates
1086                             (cl-mapcan (lambda (k)
1087                                               (cl-mapcan
1088                                                (lambda (a) (if (member k a)
1089                                                                (copy-sequence a)
1090                                                              nil))
1091                                                aliases))
1092                                             keys) :test #'string=)
1093                            #'string<)))
1094       (while (not (equal prev keys))
1095         (setq prev keys)
1096         (setq keys (expand keys))))
1097     keys))
1098 (cl-assert (equal (howm-expand-aliases-recursively "a"
1099                                                 '(("d" "e" "f") ("a" "b" "c")))
1100                '("a" "b" "c")))
1101 (cl-assert (equal (howm-expand-aliases-recursively "a"
1102                                                 '(("d" "e" "b") ("a" "b" "c")))
1103                '("a" "b" "c" "d" "e")))
1104
1105 (defun howm-keyword-aliases (keyword)
1106   "List of strings which are equivalent to KEYWORD.
1107 KEYWORD itself is always at the head of the returneded list.
1108 "
1109   ;; Return the original keyword (not downcased) for backward compatibility.
1110   ;; I'm not sure whether this behavior is really needed.
1111   (let* ((key (if howm-keyword-case-fold-search
1112                   (downcase keyword)
1113                 keyword))
1114          (aliases (howm-aliases))
1115          (equiv (if howm-keyword-aliases-recursive
1116                     (howm-expand-aliases-recursively key aliases)
1117                   (cl-remove-duplicates
1118                    (apply #'append
1119                           (cl-remove-if-not (lambda (a) (member key a))
1120                                                  aliases))))))
1121     (if (null equiv)
1122         keyword
1123       (cons keyword (remove key equiv)))))
1124
1125 (defun howm-keyword-search (keyword &optional create-p open-unique-p)
1126   (howm-message-time "key-search"
1127     (howm-set-command 'howm-keyword-search)
1128     (howm-with-normalizer
1129       (howm-keyword-search-subr keyword create-p open-unique-p))))
1130
1131 (defun howm-keyword-search-subr (keyword create-p open-unique-p)
1132   (let* ((aliases (if (howm-support-aliases-p)
1133                       (howm-keyword-aliases keyword)
1134                     keyword))
1135          (menu-p (howm-menu-keyword-p keyword))
1136          (comefrom-regexp (if menu-p ;; clean me
1137                               nil
1138                             (howm-make-keyword-regexp2 aliases)))
1139          (trio (let ((howm-search-other-dir (if menu-p ;; clean me
1140                                                  nil
1141                                                howm-search-other-dir))
1142                       (*howm-view-force-case-fold-search*
1143                        howm-keyword-case-fold-search)) ;; dirty!
1144                  (howm-call-view-search-internal aliases t)))
1145 ;; code for <http://pc8.2ch.net/test/read.cgi/unix/1077881095/823>.
1146 ;; but this change is canceled; I'll try more fundamental fix. [2005-11-04]
1147 ;;                   (if open-unique-p
1148 ;;                       (let ((r (concat "^" (regexp-quote keyword) "$")))
1149 ;;                         (howm-call-view-search r nil))
1150 ;;                     (howm-call-view-search aliases t))))
1151          (kw (car trio))
1152          (name (cadr trio))
1153          (items (cl-caddr trio))
1154          (items-pair nil)
1155          (found (if items t nil)) ;; want to forget items as soon as possible
1156          (matched (and found
1157                        (let* ((howm-keyword-format
1158                                (if menu-p ;; clean me
1159                                    (default-value 'howm-keyword-format)
1160                                  howm-keyword-format))
1161                               (r (howm-normalize items aliases
1162                                                  comefrom-regexp)))
1163                          (setq items-pair (cdr r))
1164                          (car r))))
1165          (keyword-matched (member 'keyword matched))
1166          (keyword-matched-multi (member 'keyword-multi-hits matched))
1167          (file-matched (member 'file matched))
1168          (title (howm-make-keyword-string keyword)))
1169     ;; main processing (clean me!) [2003-12-01]
1170     (cond
1171      ;; for %foo%
1172      ((and menu-p keyword-matched)
1173       (howm-keyword-search-open-menu keyword (car items-pair)
1174                                      keyword-matched-multi))
1175      ;; for [[foo]]
1176      ((and create-p (not keyword-matched))
1177       (howm-keyword-search-create title))
1178      ;; open if unique match
1179      ((and open-unique-p (howm-single-element-p items))
1180       (howm-keyword-search-open-unique items))
1181      (t
1182       (howm-call-view-summary name items-pair kw)
1183       (when (howm-normalize-oldp)
1184         ;; sorry for redundancy & inefficiency
1185         (howm-list-normalize-old aliases comefrom-regexp t))))
1186     ;; record history
1187     (when (not menu-p)
1188       (howm-write-history keyword))
1189     ;; return information
1190     `((menu-p . ,menu-p)
1191       (found . ,found)
1192       (matched . ,matched)
1193       (keyword-matched . ,keyword-matched)
1194       (create-p . ,create-p))
1195     ))
1196
1197 (defun howm-keyword-search-open-menu (keyword item-list multi-hits-p)
1198   "Open KEYWORD as menu."
1199   ;; dirty. peeking howm-view.el
1200   (let* ((item (car item-list))
1201          (fname (howm-view-item-filename item))
1202          (place (howm-view-item-place item)))
1203     (let ((howm-search-other-dir nil))
1204       (howm-menu-open fname place (howm-menu-name keyword))))
1205   (when multi-hits-p
1206     (message "Warning: found two or more %s." keyword)))
1207
1208 (defun howm-keyword-search-create (title)
1209   "create new memo <<< TITLE."
1210   (howm-create-file-with-title title)
1211   (message "New keyword."))
1212
1213 (defun howm-keyword-search-open-unique (items)
1214   "Open unique match."
1215   (howm-view-open-item (car items)))
1216
1217 ;; (defvar *howm-keyword-buffer* nil) ;; for internal use
1218 (defun howm-keyword-for-goto (&optional keyword-list)
1219   (save-excursion
1220     (let ((case-fold-search howm-keyword-case-fold-search))
1221       (sort (cl-mapcan (lambda (k)
1222                               (goto-char (point-min))
1223                               ;; when howm-check-word-break is non-nil,
1224                               ;; checking word breaks is desired for efficiency.
1225                               ;; it is not implemented yet.
1226                               (if (search-forward k nil 'noerr)
1227                                   (list k)
1228                                 nil))
1229                             (or keyword-list (howm-keyword-list)))
1230             (lambda (x y)
1231               (> (length x) (length y)))))))
1232
1233 (defun howm-keyword-add-current-buffer ()
1234   (save-excursion
1235     (goto-char (point-min))
1236     (let ((m (current-message))
1237           (keyword-list nil))
1238       (while (re-search-forward howm-keyword-regexp nil t)
1239         (let ((key-str (if howm-keyword-list-alias-sep
1240                            (mapconcat #'identity
1241                                       (howm-keyword-read)
1242                                       howm-keyword-list-alias-sep)
1243                          (match-string-no-properties howm-keyword-regexp-pos))))
1244           (setq keyword-list (cons key-str keyword-list))))
1245       (howm-keyword-add keyword-list)
1246       (message "%s" m))))
1247 (defun howm-keyword-add-items (items)
1248   (let ((files (mapcar #'howm-view-item-filename items)))
1249     (with-temp-buffer
1250       (mapc (lambda (f)
1251               (erase-buffer)
1252               (insert-file-contents f)
1253               (howm-set-configuration-for-file-name f)
1254               (howm-keyword-add-current-buffer))
1255             files))))
1256
1257 (defun howm-keyword-read ()
1258   (let ((ks nil)
1259         (beg (line-beginning-position)))
1260     (end-of-line)
1261     (skip-chars-backward " ")
1262     (while (re-search-backward howm-keyword-regexp beg t)
1263       (setq ks (cons (match-string-no-properties howm-keyword-regexp-pos) ks))
1264       (skip-chars-backward " "))
1265     (end-of-line)
1266     ks))
1267
1268 ;;; howm-mode.el ends here