zqwell/init-loader.el

## init-loader.el
;;;  -*- coding: utf-8; mode: emacs-lisp; -*-
;;; init-loader.el ---

;; Author: IMAKADO <ken.imakado@gmail.com>
;; Author's blog: http://d.hatena.ne.jp/IMAKADO (japanese)
;; Prefix: init-loader-

;; This file 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, or (at your option)
;; any later version.

;; This file 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 GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; 使い方
;; load-pathの通った場所に置いて
;; (require 'init-loader)
;; (init-loader-load "/path/to/init-directory")

;;  デフォルト設定の場合,以下の順序で引数に渡したディレクトリ以下のファイルをロードする.
;; 引数が省略された場合は,変数`init-loader-directory'の値を使用する.デフォルトは"~/.emacs.d/inits".

;; 1. ソートされた,二桁の数字から始まるファイル. e.x, "00_utils.el" "01_ik-cmd.el" "21_javascript.el" "99_global-keys.el"
;; 2. meadowの場合, meadow から始まる名前のファイル. e.x, "meadow-cmd.el" "meadow-config.el"
;; 3. carbon-emacsの場合, carbon-emacs から始まる名前のファイル. e.x, "carbon-emacs-config.el" "carbon-emacs-migemo.el"
;; 4. windowシステム以外の場合(terminal), nw から始まる名前のファイル e.x, "nw-config.el"

;; ファイルロード後,変数`init-loader-show-log-after-init'の値がnon-nilなら,ログバッファを表示する関数を`after-init-hook'へ追加する.
;; ログの表示は, M-x init-loader-show-log でも可能.

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

;;; customize-variables
(defgroup init-loader nil
  "init loader"
  :group 'init-loader)

(defcustom init-loader-directory (expand-file-name "~/.emacs.d/inits")
  "inits directory"
  :type 'directory
  :group 'init-loader)

(defcustom init-loader-show-log-after-init t
  "non-nilだと起動時にログバッファを表示する"
  :type 'boolean
  :group 'init-loader)

(defcustom init-loader-default-regexp "\\(?:^[[:digit:]]\\{2\\}\\)"
  "起動時に読み込まれる設定ファイルにマッチする正規表現.
デフォルトは二桁の数字から始まるファイルにマッチする正規表現.
e.x, 00_hoge.el, 01_huga.el ... 99_keybind.el"
  :type 'regexp
  :group 'init-loader )

(defcustom init-loader-meadow-regexp "^meadow-"
  "meadow 使用時に読み込まれる設定ファイルにマッチする正規表現"
  :group 'init-loader
  :type 'regexp)

(defcustom init-loader-carbon-emacs-regexp "^carbon-emacs-"
  "carbon-emacs 使用時に読み込まれる設定ファイルにマッチする正規表現"
  :group 'init-loader
  :type 'regexp)

(defcustom init-loader-cocoa-emacs-regexp "^cocoa-emacs-"
  "cocoa-emacs 使用時に読み込まれる設定ファイルにマッチする正規表現"
  :group 'init-loader
  :type 'regexp)

(defcustom init-loader-nw-regexp "^nw-"
  "no-window環境での起動時に読み込まれる設定ファイルにマッチする正規表現"
  :group 'init-loader
  :type 'regexp)

;; 2011/06/12 zqwell Windows/Linux 固有設定ファイル読み込み用
;; 参考URL: http://d.hatena.ne.jp/kiki114/20101109/1289316478
(defcustom init-loader-win-regexp "^win-"
  "Windows環境での起動時に読み込まれる設定ファイルにマッチする正規表現"
  :group 'init-loader
  :type 'regexp)

(defcustom init-loader-lin-regexp "^lin-"
  "Linux環境での起動時に読み込まれる設定ファイルにマッチする正規表現"
  :group 'init-loader
  :type 'regexp)


;;; Code
(defun* init-loader-load (&optional (init-dir init-loader-directory))
  (let ((init-dir (init-loader-follow-symlink init-dir)))
    (assert (and (stringp init-dir) (file-directory-p init-dir)))
    (init-loader-re-load init-loader-default-regexp init-dir t)
    ;; meadow
    (and (featurep 'meadow)
         (init-loader-re-load init-loader-meadow-regexp init-dir))
    ;; carbon emacs
    (and (featurep 'carbon-emacs-package)
         (init-loader-re-load init-loader-carbon-emacs-regexp init-dir))
    ;; cocoa emacs
    (and (equal window-system 'ns)
         (init-loader-re-load init-loader-cocoa-emacs-regexp init-dir))
    ;; no window
    (and (null window-system)
         (init-loader-re-load init-loader-nw-regexp init-dir))
    ;; 2011/06/12 zqwell Windows/Linux 固有設定ファイル読み込み用
    ;; windows
    (and (featurep 'dos-w32)
	 (init-loader-re-load init-loader-win-regexp init-dir))
    ;; Linux
    (and (equal system-type 'gnu/linux)
	 (init-loader-re-load init-loader-lin-regexp init-dir))

    (when init-loader-show-log-after-init
      (add-hook  'after-init-hook 'init-loader-show-log))))

(defun init-loader-follow-symlink (dir)
  (cond ((file-symlink-p dir)
         (expand-file-name (file-symlink-p dir)))
        (t (expand-file-name dir))))

(lexical-let (logs)
  (defun init-loader-log (&optional s)
    (if s (and (stringp s) (push s logs)) (mapconcat 'identity (reverse logs) "\n"))))

(lexical-let (err-logs)
  (defun init-loader-error-log (&optional s)
    (if s (and (stringp s) (push s err-logs)) (mapconcat 'identity (reverse err-logs) "\n"))))

(defun init-loader-re-load (re dir &optional sort)
;; 2011/06/12 zqwell load-path問題修正 (autoloadを使ったりすると問題になる)
;  (let ((load-path (cons dir load-path)))
  (add-to-list 'load-path dir) ; globalなload-pathを利用するようにする
    (dolist (el (init-loader--re-load-files re dir sort))
      (condition-case e
          (let ((time (car (benchmark-run (load (file-name-sans-extension el))))))
            (init-loader-log (format "loaded %s. %s" (locate-library el) time)))
        (error
	 ;; 2011/06/12 zqwell エラー箇所表示対応
	 ;; 参考URL: http://d.hatena.ne.jp/kitokitoki/20101205/p1
         ; (init-loader-error-log (error-message-string e))
         (init-loader-error-log (format "%s. %s" (locate-library el) (error-message-string e)))
	 ))));)

;; 2011/06/12 zqwell elc優先読み込み対応
;; 参考URL: http://twitter.com/#!/fkmn/statuses/21411277599
(defun init-loader--re-load-files (re dir &optional sort)
    (loop for el in (directory-files dir t)
          when (and (string-match re (file-name-nondirectory el))
                    (or (string-match "elc$" el)
                        (and (string-match "el$" el)
                             (not (locate-library (concat el "c"))))))
          collect (file-name-nondirectory el) into ret
          finally return (if sort (sort ret 'string<) ret)))

(defun init-loader-show-log ()
  "return buffer"
  (interactive)
  (let ((b (get-buffer-create "*init log*")))
    (with-current-buffer b
      (erase-buffer)
      (insert "------- error log -------\n\n"
              (init-loader-error-log)
              "\n\n")
      (insert "------- init log -------\n\n"
              (init-loader-log)
              "\n\n")
      ;; load-path
      (insert "------- load path -------\n\n"
              (mapconcat 'identity load-path "\n"))
      (goto-char (point-min)))
    (switch-to-buffer b)))


;;;; Test
(defvar init-loader-test-files
  '("00_utils.el"
    "23_yaml.el"
    "01_ik-cmd.el"
    "96_color.el"
    "20_elisp.el"
    "21_javascript.el"
    "25_perl.el"
    "98_emacs-config.el"
    "99_global-keys.el"
    "carbon-emacs-config.el"
    "carbon-emacs-migemo.el"
    "nw-config.el"
    "emacs-migemo.el"
    "meadow-cmd.el"
    "meadow-config.el"
    "meadow-gnuserv.el"
    "meadow-shell.el"
    "meadow-w32-symlinks.el"))

(dont-compile
  (when (fboundp 'expectations)
    (expectations
      (desc "init-loader--re-load-files")
      (expect  '("00_utils.el" "01_ik-cmd.el" "20_elisp.el" "21_javascript.el" "23_yaml.el" "25_perl.el" "96_color.el" "98_emacs-config.el" "99_global-keys.el")
        (stub directory-files => init-loader-test-files)
        (init-loader--re-load-files init-loader-default-regexp "" t))
      (expect  '("meadow-cmd.el" "meadow-config.el" "meadow-gnuserv.el" "meadow-shell.el" "meadow-w32-symlinks.el")
        (stub directory-files => init-loader-test-files)
        (init-loader--re-load-files init-loader-meadow-regexp "" t))

      (expect  '("carbon-emacs-config.el" "carbon-emacs-migemo.el")
        (stub directory-files => init-loader-test-files)
        (init-loader--re-load-files init-loader-carbon-emacs-regexp "" t))
      (expect  '("nw-config.el")
        (stub directory-files => init-loader-test-files)
        (init-loader--re-load-files init-loader-nw-regexp "" t))
      ;; 環境依存
      (desc "follow symlink")
      (expect "c/.emacs.d/inits"
        (file-relative-name (file-symlink-p "~/tmp/el-inits"))) ; symlink
      (desc "init-loader-follow-symlink")
      (expect "c/.emacs.d/inits"
        (file-relative-name (init-loader-follow-symlink "~/tmp/el-inits")))
      (expect "c/.emacs.d/inits"
        (file-relative-name (init-loader-follow-symlink "~/tmp/el-inits")))
      )))

(provide 'init-loader)
	;;; -- coding: utf-8; mode: emacs-lisp; --
	;;; init-loader.el ---

	;; Author: IMAKADO <ken.imakado@gmail.com>
	;; Author's blog: http://d.hatena.ne.jp/IMAKADO (japanese)
	;; Prefix: init-loader-

	;; This file 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, or (at your option)
	;; any later version.

	;; This file 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 GNU Emacs; see the file COPYING. If not, write to the
	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	;; Boston, MA 02110-1301, USA.

	;;; 使い方
	;; load-pathの通った場所に置いて
	;; (require 'init-loader)
	;; (init-loader-load "/path/to/init-directory")

	;; デフォルト設定の場合,以下の順序で引数に渡したディレクトリ以下のファイルをロードする.
	;; 引数が省略された場合は,変数`init-loader-directory'の値を使用する.デフォルトは"~/.emacs.d/inits".

	;; 1. ソートされた,二桁の数字から始まるファイル. e.x, "00_utils.el" "01_ik-cmd.el" "21_javascript.el" "99_global-keys.el"
	;; 2. meadowの場合, meadow から始まる名前のファイル. e.x, "meadow-cmd.el" "meadow-config.el"
	;; 3. carbon-emacsの場合, carbon-emacs から始まる名前のファイル. e.x, "carbon-emacs-config.el" "carbon-emacs-migemo.el"
	;; 4. windowシステム以外の場合(terminal), nw から始まる名前のファイル e.x, "nw-config.el"

	;; ファイルロード後,変数`init-loader-show-log-after-init'の値がnon-nilなら,ログバッファを表示する関数を`after-init-hook'へ追加する.
	;; ログの表示は, M-x init-loader-show-log でも可能.

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

	;;; customize-variables
	(defgroup init-loader nil
	"init loader"
	:group 'init-loader)

	(defcustom init-loader-directory (expand-file-name "~/.emacs.d/inits")
	"inits directory"
	:type 'directory
	:group 'init-loader)

	(defcustom init-loader-show-log-after-init t
	"non-nilだと起動時にログバッファを表示する"
	:type 'boolean
	:group 'init-loader)

	(defcustom init-loader-default-regexp "\\(?:^[[:digit:]]\\{2\\}\\)"
	"起動時に読み込まれる設定ファイルにマッチする正規表現.
	デフォルトは二桁の数字から始まるファイルにマッチする正規表現.
	e.x, 00_hoge.el, 01_huga.el ... 99_keybind.el"
	:type 'regexp
	:group 'init-loader )

	(defcustom init-loader-meadow-regexp "^meadow-"
	"meadow 使用時に読み込まれる設定ファイルにマッチする正規表現"
	:group 'init-loader
	:type 'regexp)

	(defcustom init-loader-carbon-emacs-regexp "^carbon-emacs-"
	"carbon-emacs 使用時に読み込まれる設定ファイルにマッチする正規表現"
	:group 'init-loader
	:type 'regexp)

	(defcustom init-loader-cocoa-emacs-regexp "^cocoa-emacs-"
	"cocoa-emacs 使用時に読み込まれる設定ファイルにマッチする正規表現"
	:group 'init-loader
	:type 'regexp)

	(defcustom init-loader-nw-regexp "^nw-"
	"no-window環境での起動時に読み込まれる設定ファイルにマッチする正規表現"
	:group 'init-loader
	:type 'regexp)

	;; 2011/06/12 zqwell Windows/Linux 固有設定ファイル読み込み用
	;; 参考URL: http://d.hatena.ne.jp/kiki114/20101109/1289316478
	(defcustom init-loader-win-regexp "^win-"
	"Windows環境での起動時に読み込まれる設定ファイルにマッチする正規表現"
	:group 'init-loader
	:type 'regexp)

	(defcustom init-loader-lin-regexp "^lin-"
	"Linux環境での起動時に読み込まれる設定ファイルにマッチする正規表現"
	:group 'init-loader
	:type 'regexp)


	;;; Code
	(defun* init-loader-load (&optional (init-dir init-loader-directory))
	(let ((init-dir (init-loader-follow-symlink init-dir)))
	(assert (and (stringp init-dir) (file-directory-p init-dir)))
	(init-loader-re-load init-loader-default-regexp init-dir t)
	;; meadow
	(and (featurep 'meadow)
	(init-loader-re-load init-loader-meadow-regexp init-dir))
	;; carbon emacs
	(and (featurep 'carbon-emacs-package)
	(init-loader-re-load init-loader-carbon-emacs-regexp init-dir))
	;; cocoa emacs
	(and (equal window-system 'ns)
	(init-loader-re-load init-loader-cocoa-emacs-regexp init-dir))
	;; no window
	(and (null window-system)
	(init-loader-re-load init-loader-nw-regexp init-dir))
	;; 2011/06/12 zqwell Windows/Linux 固有設定ファイル読み込み用
	;; windows
	(and (featurep 'dos-w32)
	(init-loader-re-load init-loader-win-regexp init-dir))
	;; Linux
	(and (equal system-type 'gnu/linux)
	(init-loader-re-load init-loader-lin-regexp init-dir))

	(when init-loader-show-log-after-init
	(add-hook 'after-init-hook 'init-loader-show-log))))

	(defun init-loader-follow-symlink (dir)
	(cond ((file-symlink-p dir)
	(expand-file-name (file-symlink-p dir)))
	(t (expand-file-name dir))))

	(lexical-let (logs)
	(defun init-loader-log (&optional s)
	(if s (and (stringp s) (push s logs)) (mapconcat 'identity (reverse logs) "\n"))))

	(lexical-let (err-logs)
	(defun init-loader-error-log (&optional s)
	(if s (and (stringp s) (push s err-logs)) (mapconcat 'identity (reverse err-logs) "\n"))))

	(defun init-loader-re-load (re dir &optional sort)
	;; 2011/06/12 zqwell load-path問題修正 (autoloadを使ったりすると問題になる)
	; (let ((load-path (cons dir load-path)))
	(add-to-list 'load-path dir) ; globalなload-pathを利用するようにする
	(dolist (el (init-loader--re-load-files re dir sort))
	(condition-case e
	(let ((time (car (benchmark-run (load (file-name-sans-extension el))))))
	(init-loader-log (format "loaded %s. %s" (locate-library el) time)))
	(error
	;; 2011/06/12 zqwell エラー箇所表示対応
	;; 参考URL: http://d.hatena.ne.jp/kitokitoki/20101205/p1
	; (init-loader-error-log (error-message-string e))
	(init-loader-error-log (format "%s. %s" (locate-library el) (error-message-string e)))
	))));)

	;; 2011/06/12 zqwell elc優先読み込み対応
	;; 参考URL: http://twitter.com/#!/fkmn/statuses/21411277599
	(defun init-loader--re-load-files (re dir &optional sort)
	(loop for el in (directory-files dir t)
	when (and (string-match re (file-name-nondirectory el))
	(or (string-match "elc$" el)
	(and (string-match "el$" el)
	(not (locate-library (concat el "c"))))))
	collect (file-name-nondirectory el) into ret
	finally return (if sort (sort ret 'string<) ret)))

	(defun init-loader-show-log ()
	"return buffer"
	(interactive)
	(let ((b (get-buffer-create "init log")))
	(with-current-buffer b
	(erase-buffer)
	(insert "------- error log -------\n\n"
	(init-loader-error-log)
	"\n\n")
	(insert "------- init log -------\n\n"
	(init-loader-log)
	"\n\n")
	;; load-path
	(insert "------- load path -------\n\n"
	(mapconcat 'identity load-path "\n"))
	(goto-char (point-min)))
	(switch-to-buffer b)))


	;;;; Test
	(defvar init-loader-test-files
	'("00_utils.el"
	"23_yaml.el"
	"01_ik-cmd.el"
	"96_color.el"
	"20_elisp.el"
	"21_javascript.el"
	"25_perl.el"
	"98_emacs-config.el"
	"99_global-keys.el"
	"carbon-emacs-config.el"
	"carbon-emacs-migemo.el"
	"nw-config.el"
	"emacs-migemo.el"
	"meadow-cmd.el"
	"meadow-config.el"
	"meadow-gnuserv.el"
	"meadow-shell.el"
	"meadow-w32-symlinks.el"))

	(dont-compile
	(when (fboundp 'expectations)
	(expectations
	(desc "init-loader--re-load-files")
	(expect '("00_utils.el" "01_ik-cmd.el" "20_elisp.el" "21_javascript.el" "23_yaml.el" "25_perl.el" "96_color.el" "98_emacs-config.el" "99_global-keys.el")
	(stub directory-files => init-loader-test-files)
	(init-loader--re-load-files init-loader-default-regexp "" t))
	(expect '("meadow-cmd.el" "meadow-config.el" "meadow-gnuserv.el" "meadow-shell.el" "meadow-w32-symlinks.el")
	(stub directory-files => init-loader-test-files)
	(init-loader--re-load-files init-loader-meadow-regexp "" t))

	(expect '("carbon-emacs-config.el" "carbon-emacs-migemo.el")
	(stub directory-files => init-loader-test-files)
	(init-loader--re-load-files init-loader-carbon-emacs-regexp "" t))
	(expect '("nw-config.el")
	(stub directory-files => init-loader-test-files)
	(init-loader--re-load-files init-loader-nw-regexp "" t))
	;; 環境依存
	(desc "follow symlink")
	(expect "c/.emacs.d/inits"
	(file-relative-name (file-symlink-p "~/tmp/el-inits"))) ; symlink
	(desc "init-loader-follow-symlink")
	(expect "c/.emacs.d/inits"
	(file-relative-name (init-loader-follow-symlink "~/tmp/el-inits")))
	(expect "c/.emacs.d/inits"
	(file-relative-name (init-loader-follow-symlink "~/tmp/el-inits")))
	)))

	(provide 'init-loader)