/local-elisp/historyf/historyf.el

;;; historyf.el --- file history library like browser
;; -*- Mode: Emacs-Lisp -*-

;; Copyright (C) 2010 by 101000code/101000LAB

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2 of the License, or
;; (at your option) any later version.

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

;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA

;; Version: 0.0.7
;; Author: k1LoW (Kenichirou Oyama), <k1lowxb [at] gmail [dot] com> <k1low [at] 101000lab [dot] org>
;; URL: http://code.101000lab.org

;;; Install
;; Put this file into load-path'ed directory, and byte compile it if
;; desired.  And put the following expression into your ~/.emacs.
;;
;; (require 'historyf)
;;

;;; Commentary:

;;; Commands:
;;
;; Below are complete command list:
;;
;;  `historyf-back'
;;    Back file history.
;;  `historyf-back-same-mode-history'
;;    Back same mode file history.
;;  `historyf-forward'
;;    Forward file history.
;;  `historyf-forward-same-mode-history'
;;    Forward same mode file history.
;;  `historyf-clear-history'
;;    Clear file history.
;;
;;; Customizable Options:
;;
;; Below are customizable option list:
;;
;;  `historyf-major-modes'
;;    Target major-mode.
;;    default = (quote (emacs-lisp-mode lisp-interaction-mode c-mode cc-mode c++-mode ...))
;;  `historyf-minor-modes'
;;    Target minor-mode.
;;    default = (quote (cake))
;;  `historyf-limit'
;;    File history limit.
;;    default = 100

;;; TODO
;; Add more testcase

;;; Code:

(eval-when-compile
  (require 'cl))

(defgroup historyf nil
  "File history like browser"
  :group 'lisp
  :prefix "historyf-")

(defvar historyf-history nil
  "File history.")

(defcustom historyf-major-modes
  '(emacs-lisp-mode
    lisp-interaction-mode
    c-mode cc-mode c++-mode java-mode
    perl-mode cperl-mode python-mode ruby-mode
    ecmascript-mode javascript-mode js2-mode php-mode css-mode
    makefile-mode sh-mode fortran-mode f90-mode ada-mode
    xml-mode sgml-mode)
  "Target major-mode."
  :type 'list
  :group 'historyf)

(defcustom historyf-minor-modes
  '(cake yarm li3 titanium)
  "Target minor-mode."
  :type 'list
  :group 'historyf)

(defcustom historyf-limit 100
  "File history limit."
  :type 'inter
  :group 'historyf)

(defvar historyf-mark nil)

(defvar historyf-forward-temp nil)

(defadvice switch-to-buffer (before historyf-switch-to-buffer activate)
  (historyf-push-history))

(defun historyf-push-history ()
  "Push file history."
  (let ((active-modes (historyf-active-mode-list))
        (file (buffer-file-name)))
    (when (and active-modes file)
      (historyf-clear-head)
      (unless (equal (expand-file-name file) (cdar historyf-history))
        (push (random) active-modes)
        (push (cons active-modes (expand-file-name (buffer-file-name))) historyf-history)
        (unless (< (length historyf-history) historyf-limit)
          (setq historyf-history (subseq historyf-history 0 (1- historyf-limit))))))))

(defun historyf-make-history ()
  "Make file history."
  (let ((active-modes (historyf-active-mode-list))
        (file (buffer-file-name)))
    (unless (not active-modes)
      (push (random) active-modes)
      (cons active-modes (expand-file-name (buffer-file-name))))))
;; (historyf-make-history)

(defun historyf-clear-head ()
  "Clear head history."
  (when historyf-mark
    (setq historyf-history (cdr (memq historyf-mark historyf-history))))
  (setq historyf-mark nil
        historyf-forward-temp nil))

(defun historyf-find-file (file)
  "Find file."
  (message (concat "switch to " file))
  (find-file file))

(defun historyf-back (&optional mode-list)
  "Back file history."
  (interactive)
  (let ((temp-hist))
    (ad-disable-advice 'switch-to-buffer 'before 'historyf-switch-to-buffer)
    (ad-activate 'switch-to-buffer)
    (if (not mode-list)
        ;; no mode-list
        (if historyf-mark
            (setq temp-hist (cadr (memq historyf-mark historyf-history)))
          (setq temp-hist (car historyf-history)))
      ;; else
      (setq hist (if historyf-mark
                     (cdr (memq historyf-mark historyf-history))
                   historyf-history))
      (mapc (lambda (h)
              (if (and (intersection (car h) mode-list)
                       (not temp-hist))
                  (setq temp-hist h)))
            hist))
    (when temp-hist
      (unless historyf-forward-temp
        (setq historyf-forward-temp (historyf-make-history)))
      (historyf-find-file (cdr temp-hist))
      (setq historyf-mark temp-hist))
    (ad-enable-advice 'switch-to-buffer 'before 'historyf-switch-to-buffer)
    (ad-activate 'switch-to-buffer)))

(defun historyf-back-same-mode-history ()
  "Back same mode file history."
  (interactive)
  (let ((active-modes (historyf-active-mode-list)))
    (historyf-back active-modes)))

(defun historyf-forward (&optional mode-list)
  "Forward file history."
  (interactive)
  (let* ((temp-hist)
         (history-head (unless (not historyf-mark)
                         (subseq historyf-history 0 (position historyf-mark historyf-history)))))
    (ad-disable-advice 'switch-to-buffer 'before 'historyf-switch-to-buffer)
    (ad-activate 'switch-to-buffer)
    (if (not mode-list)
        ;; no mode-list
        (when historyf-mark
          (if history-head
              (historyf-find-file (cdar (reverse history-head)))
            (when historyf-forward-temp
              (historyf-find-file (cdr historyf-forward-temp))
              (setq historyf-forward-temp nil)))
          (setq historyf-mark (car (reverse history-head))))
      ;; else
      (unless (not historyf-mark)
        (if history-head
            (progn
              (mapc (lambda (h)
                      (if (and (intersection (car h) mode-list)
                               (not temp-hist))
                          (setq temp-hist h)))
                    (reverse history-head))
              (if (not temp-hist)
                  (unless (not (and historyf-forward-temp
                                    (intersection (car historyf-forward-temp) mode-list)))
                    (historyf-find-file (cdr historyf-forward-temp))
                    (setq historyf-forward-temp nil)
                    (setq historyf-mark nil))
                (historyf-find-file (cdr temp-hist))
                (setq historyf-mark temp-hist)))
          (unless (not (and historyf-forward-temp
                            (intersection (car historyf-forward-temp) mode-list)))
            (historyf-find-file (cdr historyf-forward-temp))
            (setq historyf-forward-temp nil)
            (setq historyf-mark nil)))))
    (ad-enable-advice 'switch-to-buffer 'before 'historyf-switch-to-buffer)
    (ad-activate 'switch-to-buffer)))

(defun historyf-forward-same-mode-history ()
  "Forward same mode file history."
  (interactive)
  (let ((active-modes (historyf-active-mode-list)))
    (historyf-forward active-modes)))

(defun historyf-clear-history ()
  "Clear file history."
  (interactive)
  (setq historyf-history nil)
  (setq historyf-mark nil)
  (setq historyf-forward-temp nil))

(defun historyf-active-mode-list ()
  "Active mode list."
  (let ((active-major-mode (historyf-active-major-mode))
        (active-minor-modes (historyf-active-minor-mode-list))
        (active-modes))
    (if active-major-mode
        (push active-major-mode active-modes))
    (if active-minor-modes
        (setq active-modes (union active-minor-modes active-modes)))
    active-modes))

(defun historyf-active-major-mode ()
  "Active major-mode."
  (if (and (buffer-file-name)
           (memq major-mode historyf-major-modes))
      major-mode
    nil))

(defun historyf-active-minor-mode-list ()
  "Active minor-mode list."
  (let ((active-minor-modes))
    (mapc (lambda (mode) (condition-case nil
                             (if (and (symbolp mode) (symbol-value mode))
                                 (add-to-list 'active-minor-modes mode))
                           (error nil) ))
          minor-mode-list)
    (if (and (buffer-file-name)
             (intersection active-minor-modes historyf-minor-modes))
        (intersection active-minor-modes historyf-minor-modes)
      nil)))

;; Tests
(dont-compile
  (when (fboundp 'expectations)
    (expectations
      (desc "init")
      (expect t
        (setq historyf-test-dir (expand-file-name (concat default-directory "t/")))
        t)
      (expect 'emacs-lisp-mode
        (find-file (concat historyf-test-dir "test.el"))
        major-mode)
      (expect nil
        (historyf-clear-history)
        historyf-history)
      (desc "push file history test")
      (expect 0
        (length historyf-history))
      (expect nil
        (cdar (car historyf-history)))
      (expect nil
        historyf-forward-temp)
      (expect 'emacs-lisp-mode
        (find-file (concat historyf-test-dir "test2.el"))
        major-mode)
      (expect 1
        (length historyf-history))
      (expect '(emacs-lisp-mode)
        (cdar (car historyf-history)))
      (expect (concat historyf-test-dir "test.el")
        (cdr (car historyf-history)))
      (expect 'c-mode
        (find-file (concat historyf-test-dir "test3.c"))
        major-mode)
      (expect 2
        (length historyf-history))
      (expect '(emacs-lisp-mode)
        (cdar (car historyf-history)))
      (expect 'emacs-lisp-mode
        (find-file (concat historyf-test-dir "test4.el"))
        major-mode)
      (expect 3
        (length historyf-history))
      (expect '(c-mode)
        (cdar (car historyf-history)))
      (desc "back file history test")
      (expect (concat historyf-test-dir "test3.c")
        (historyf-back)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (expect (concat historyf-test-dir "test2.el")
        (historyf-back)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (expect (concat historyf-test-dir "test.el")
        (historyf-back)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (expect (concat historyf-test-dir "test.el")
        (historyf-back)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (desc "forward file history test")
      (expect (concat historyf-test-dir "test2.el")
        (historyf-forward)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (expect (concat historyf-test-dir "test3.c")
        (historyf-forward)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (expect (concat historyf-test-dir "test4.el")
        (historyf-forward)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect nil
        (cdr historyf-forward-temp))
      (desc "back same mode file history test")
      (expect (concat historyf-test-dir "test2.el")
        (historyf-back-same-mode-history)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (expect (concat historyf-test-dir "test.el")
        (historyf-back-same-mode-history)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (desc "forward same mode file history test")
      (expect (concat historyf-test-dir "test2.el")
        (historyf-forward-same-mode-history)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect (concat historyf-test-dir "test4.el")
        (cdr historyf-forward-temp))
      (expect (concat historyf-test-dir "test4.el")
        (historyf-forward-same-mode-history)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (length historyf-history))
      (expect nil
        (cdr historyf-forward-temp))
      (desc "back -> forward test")
      (expect (concat historyf-test-dir "test4.el")
        (expand-file-name (buffer-file-name)))
      (expect (concat historyf-test-dir "test3.c")
        (historyf-back)
        (expand-file-name (buffer-file-name)))
      (expect 3
        (find-file (concat historyf-test-dir "test1.el"))
        (length historyf-history))
      (expect nil
        historyf-mark)
      (expect nil
        historyf-forward-temp)
      (expect (concat historyf-test-dir "test1.el")
        (historyf-forward)
        (expand-file-name (buffer-file-name)))
      (expect (concat historyf-test-dir "test3.c")
        (historyf-back)
        (expand-file-name (buffer-file-name)))
      (expect (concat historyf-test-dir "test1.el")
        (historyf-forward)
        (expand-file-name (buffer-file-name)))
      )))

(provide 'historyf)
;;; historyf.el ends here