major-mode-icons.el

   1 ;;; major-mode-icons.el --- display icon for major-mode on mode-line.
   2
   3 ;; Authors: stardiviner <numbchild@gmail.com>
   4 ;; Package-Requires: ((emacs "25.1") (powerline "2.4"))
   5 ;; Version: 0.1
   6 ;; Keywords: frames multimedia
   7 ;; homepage: http://github.com/stardiviner/major-mode-icons
   8
   9 ;; You should have received a copy of the GNU General Public License
  10 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  11
  12 ;;; Commentary:
  13
  14 ;; If you want to use `major-mode-icons--major-mode-extra' extra info, you
  15 ;; should install corresponding packages.
  16 ;;
  17 ;; - clojure-mode <-> cider
  18 ;; - ruby-mode <-> rbenv
  19 ;; - python-mode <-> pyvenv
  20
  21
  22 ;;; Code:
  23 ;;; ----------------------------------------------------------------------------
  24
  25 (require 'cl-lib)
  26 (require 'powerline)
  27
  28 (defgroup major-mode-icons nil
  29   "Show icon for current buffer's major-mode."
  30   :group 'mode-line)
  31
  32 (defconst major-mode-icons--icons-default-path
  33   (concat
  34    (file-name-directory (or load-file-name
  35                             (buffer-file-name)))
  36    "icons/")
  37   "Default icons path of major-mode-icons.")
  38
  39 (defcustom major-mode-icons-icons-path major-mode-icons--icons-default-path
  40   "Path to icons."
  41   :group 'major-mode-icons
  42   :type 'string)
  43
  44 (defcustom major-mode-icons-mode-name-font "Segoe Print"
  45   "The font family used for major mode name."
  46   :group 'major-mode-icons
  47   :type 'string)
  48
  49 ;; major mode with icon
  50 (defvar major-mode-icons--major-mode-list
  51   '(((emacs-lisp-mode
  52       inferior-emacs-lisp-mode
  53       ielm-mode) . "Emacs")
  54     ((lisp-mode
  55       inferior-lisp-mode
  56       slime-repl-mode sly-mrepl-mode) . "Common-Lisp")
  57     ((scheme-mode) . "Scheme")
  58     ((clojure-mode
  59       cider-repl-mode) . "Clojure")
  60     ((clojurescript-mode) . "ClojureScript")
  61     ((python-mode) . "Python")
  62     ((enh-ruby-mode ruby-mode) . "Ruby")
  63     ((inf-ruby-mode) . "inf-ruby")
  64     ((c-mode) . "C")
  65     ((c++-mode) . "C++")
  66     ((csharp-mode) . "C#")
  67     ((go-mode) . "Go")
  68     ((swift-mode) . "Swift")
  69     ((rust-mode) . "Rust")
  70     ((java-mode) . "Java")
  71     ((php-mode) . "PHP")
  72     ((web-mode html-mode) . "HTML")
  73     ((css-mode) . "CSS")
  74     ((javascript-mode
  75       js-mode js2-mode js3-mode inferior-js-mode) . "JavaScript")
  76     ((coffee-mode) . "CoffeeScript")
  77     ((org-mode org-agenda-mode) . "Org-mode")
  78     ((tex-mode latex-mode TeX-mode LaTeX-mode) . "TeX")
  79     ((bibtex-mode) . "BibTeX")
  80     ((markdown-mode) . "Markdown")
  81     ((yaml-mode) . "YAML")
  82     ((rst-mode) . "reStructuredText")
  83     ((eshell-mode) . "Command-Line")
  84     ((sh-mode shell-mode) . "Shell")
  85     ((term-mode) . "term")
  86     ((powershell-mode) . "powershell")
  87     ((ess-mode R-mode) . "R")
  88     ((julia-mode ess-julia-mode) . "Julia")
  89     ((gnuplot-mode) . "gnuplot")
  90     ((octave-mode) . "Octave")
  91     ((matlab-mode) . "Matlab")
  92     ((haskell-mode) . "Haskell")
  93     ((scala-mode) . "Scala")
  94     ((erlang-mode) . "Erlang")
  95     ((prolog-mode) . "Prolog")
  96     ((ocaml-mode) . "OCaml")
  97     ((sql-mode) . "SQL")
  98     ((xml-mode nxml-mode) . "XML")
  99     ((json-mode) . "JSON")
 100     ((diff-mode ediff-mode magit-diff-mode) . "diff")
 101     ((asm-mode nasm-mode) . "Assembly")
 102     ((android-mode) . "Android")
 103     ((qt-mode) . "Qt")
 104     ((arduino-mode) . "Arduino")
 105     ((systemd-mode) . "Systemd")
 106     ((docker-mode) . "Docker")
 107     ((projectile-rails-mode) . "Rails")
 108     ((slim-mode) . "Slim")
 109     ((sass-mode) . "Sass")
 110     ((spice-mode) . "Electric")
 111     )
 112   "Pairs: ([mode-list] . [icon-name])."
 113   )
 114
 115 (defun major-mode-icons--major-mode-list-match ()
 116   "Return the matched item in `major-mode-list'."
 117   (assoc
 118    (cl-some ; or use (remove nil '(nil nil (clojure-mode) nil nil ...))
 119     (lambda (elem)
 120       (when (not (null elem))
 121         elem))
 122     (mapcar
 123      (lambda (element)
 124        (member major-mode element))
 125      (mapcar 'car major-mode-icons--major-mode-list)))
 126    major-mode-icons--major-mode-list))
 127
 128 (defun major-mode-icons--major-mode-icon (&optional extra)
 129   "Display icon for current buffer's `major-mode' and `EXTRA' info."
 130   (let* ((match (major-mode-icons--major-mode-list-match))
 131          (icon (cdr match))
 132          (icon-path (concat major-mode-icons-icons-path icon ".xpm")))
 133     (concat
 134      (if (and (file-exists-p icon-path) (image-type-available-p 'xpm))
 135          (propertize
 136           "  "
 137           'display (if (and (file-exists-p icon-path) (image-type-available-p 'xpm))
 138                        (create-image icon-path 'xpm nil :ascent 'center))
 139           'mouse-face 'mode-line-highlight
 140           'help-echo "Major-mode\n\ mouse-1: Display major mode menu\n\ mouse2: Show help for major mode\n\ mouse-3: Toggle minor modes"
 141           'local-map (let ((map (make-sparse-keymap)))
 142                        (define-key map [mode-line down-mouse-1]
 143                          `(menu-item ,(purecopy "Menu Bar") ignore
 144                                      :filter (lambda (_) (mouse-menu-major-mode-map))))
 145                        (define-key map [mode-line mouse-2] 'describe-mode)
 146                        (define-key map [mode-line down-mouse-3] mode-line-mode-menu)
 147                        map)
 148           )
 149        (propertize (format-mode-line mode-name))
 150        )
 151      ;;; extra
 152      (if extra
 153          (propertize (format " %s" (or extra "")))
 154        "")
 155      )))
 156
 157 ;;; auto show extra info
 158 (defun major-mode-icons--major-mode-extra ()
 159   "Extend function `major-mode-icon' with extra info."
 160   (let ((extra
 161          (cl-case major-mode
 162            ('clojure-mode
 163             (if (and (featurep 'cider)
 164                      (not (equal (cider--modeline-info) "not connected")))
 165                 (cider--project-name nrepl-project-dir)))
 166            ('enh-ruby-mode
 167             (if (and (featurep 'rbenv) global-rbenv-mode)
 168                 (rbenv--active-ruby-version) ; `rbenv--modestring'
 169               ))
 170            ('python-mode
 171             (if (and (featurep 'pyvenv) pyvenv-mode)
 172                 ;; `pyvenv-mode-line-indicator' -> `pyvenv-virtual-env-name'
 173                 pyvenv-virtual-env-name
 174               ;; conda: `conda-env-current-name'
 175               ))
 176            )))))
 177
 178 ;;;###autoload
 179 (defun major-mode-icons-show ()
 180   "Show icon on mode-line."
 181   (major-mode-icons--major-mode-icon (major-mode-icons--major-mode-extra)))
 182
 183 ;;;###autoload
 184 (defpowerline powerline-major-mode-icons
 185   (let* ((match (major-mode-icons--major-mode-list-match))
 186          (icon (cdr match))
 187          (icon-path (concat major-mode-icons-icons-path icon ".xpm")))
 188     (propertize (format-mode-line mode-name) ; display `mode-name' text.
 189                 'display ; display icon
 190                 (if (and (image-type-available-p 'xpm)
 191                          (file-exists-p icon-path))
 192                     (create-image icon-path 'xpm nil :ascent 'center))
 193                 'mouse-face 'mode-line-highlight
 194                 'help-echo "Major-mode\n\ mouse-1: Display major mode menu\n\ mouse2: Show help for major mode\n\ mouse-3: Toggle minor modes"
 195                 'local-map (let ((map (make-sparse-keymap)))
 196                              (define-key map [mode-line down-mouse-1]
 197                                `(menu-item ,(purecopy "Menu Bar") ignore
 198                                            :filter (lambda (_) (mouse-menu-major-mode-map))))
 199                              (define-key map [mode-line mouse-2] 'describe-mode)
 200                              (define-key map [mode-line down-mouse-3] mode-line-mode-menu)
 201                              map))))
 202
 203 ;;;###autoload
 204 (defvar major-mode-icons-lighter
 205   (let* ((match (major-mode-icons--major-mode-list-match))
 206          (icon (cdr match)))
 207     (propertize (format-mode-line mode-name) ; display `mode-name' text.
 208                 'display ; display icon
 209                 (let ((icon-path
 210                        (concat major-mode-icons-icons-path icon ".xpm")))
 211                   (if (and (image-type-available-p 'xpm)
 212                            (file-exists-p icon-path))
 213                       (create-image icon-path 'xpm nil :ascent 'center)
 214                     ))
 215                 'mouse-face 'mode-line-highlight
 216                 'help-echo "Major-mode\n\ mouse-1: Display major mode menu\n\ mouse2: Show help for major mode\n\ mouse-3: Toggle minor modes"
 217                 'local-map (let ((map (make-sparse-keymap)))
 218                              (define-key map [mode-line down-mouse-1]
 219                                `(menu-item ,(purecopy "Menu Bar") ignore
 220                                            :filter (lambda (_) (mouse-menu-major-mode-map))))
 221                              (define-key map [mode-line mouse-2] 'describe-mode)
 222                              (define-key map [mode-line down-mouse-3] mode-line-mode-menu)
 223                              map)))
 224   "Lighter for minor mode `major-mode-icons'.")
 225
 226 (put 'major-mode-icons-lighter 'risky-local-variable t)
 227
 228 ;;;###autoload
 229 (define-minor-mode major-mode-icons-mode
 230   "A minor mode of showing icon for major-mode of current buffer."
 231   :init-value t
 232   :lighter major-mode-icons-lighter
 233   :global t)
 234
 235 ;;; ----------------------------------------------------------------------------
 236
 237 (provide 'major-mode-icons)
 238
 239 ;;; major-mode-icons.el ends here