code.delx.au - gnu-emacs-elpa/blob - aggressive-indent.el

   1 ;;; aggressive-indent.el --- Minor mode to aggressively keep your code always indented
   2
   3 ;; Copyright (C) 2014 Artur Malabarba <bruce.connor.am@gmail.com>
   4
   5 ;; Author: Artur Malabarba <bruce.connor.am@gmail.com>
   6 ;; URL: http://github.com/Bruce-Connor/aggressive-indent-mode
   7 ;; Version: 0.3.1
   8 ;; Package-Requires: ((emacs "24.1") (names "0.5") (cl-lib "0.5"))
   9 ;; Keywords: indent lisp maint tools
  10 ;; Prefix: aggressive-indent
  11 ;; Separator: -
  12
  13 ;;; Commentary:
  14 ;;
  15 ;; `electric-indent-mode' is enough to keep your code nicely aligned when
  16 ;; all you do is type. However, once you start shifting blocks around,
  17 ;; transposing lines, or slurping and barfing sexps, indentation is bound
  18 ;; to go wrong.
  19 ;;
  20 ;; `aggressive-indent-mode' is a minor mode that keeps your code always
  21 ;; indented. It reindents after every command, making it more reliable
  22 ;; than `electric-indent-mode'.
  23 ;;
  24 ;; ### Instructions ###
  25 ;;
  26 ;; This package is available fom Melpa, you may install it by calling
  27 ;;
  28 ;;     M-x package-install RET aggressive-indent
  29 ;;
  30 ;; Then activate it with
  31 ;;
  32 ;;     (add-hook 'emacs-lisp-mode-hook #'aggressive-indent-mode)
  33 ;;     (add-hook 'css-mode-hook #'aggressive-indent-mode)
  34 ;;
  35 ;; You can use this hook on any mode you want, `aggressive-indent' is not
  36 ;; exclusive to emacs-lisp code. In fact, if you want to turn it on for
  37 ;; every programming mode, you can do something like:
  38 ;;
  39 ;;     (global-aggressive-indent-mode 1)
  40 ;;     (add-to-list 'aggressive-indent-excluded-modes 'html-mode)
  41 ;;
  42 ;; ### Manual Installation ###
  43 ;;
  44 ;; If you don't want to install from Melpa, you can download it manually,
  45 ;; place it in your `load-path' and require it with
  46 ;;
  47 ;;     (require 'aggressive-indent)
  48
  49 ;;; Instructions:
  50 ;;
  51 ;; INSTALLATION
  52 ;;
  53 ;; This package is available fom Melpa, you may install it by calling
  54 ;; M-x package-install RET aggressive-indent.
  55 ;;
  56 ;; Then activate it with
  57 ;;     (add-hook 'emacs-lisp-mode-hook #'aggressive-indent-mode)
  58 ;;
  59 ;; You can also use an equivalent hook for another mode,
  60 ;; `aggressive-indent' is not exclusive to emacs-lisp code.
  61 ;;
  62 ;; Alternatively, you can download it manually, place it in your
  63 ;; `load-path' and require it with
  64 ;;
  65 ;;     (require 'aggressive-indent)
  66
  67 ;;; License:
  68 ;;
  69 ;; This file is NOT part of GNU Emacs.
  70 ;;
  71 ;; This program is free software; you can redistribute it and/or
  72 ;; modify it under the terms of the GNU General Public License
  73 ;; as published by the Free Software Foundation; either version 2
  74 ;; of the License, or (at your option) any later version.
  75 ;;
  76 ;; This program is distributed in the hope that it will be useful,
  77 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  78 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  79 ;; GNU General Public License for more details.
  80 ;;
  81
  82 ;;; Change Log:
  83 ;; 0.3 - 2014/10/23 - Implement a smarter engine for non-lisp modes.
  84 ;; 0.2 - 2014/10/20 - Reactivate `electric-indent-mode'.
  85 ;; 0.2 - 2014/10/19 - Add variable `aggressive-indent-dont-indent-if', so the user can prevent indentation.
  86 ;; 0.1 - 2014/10/15 - Release.
  87 ;;; Code:
  88
  89 (require 'cl-lib)
  90 (require 'names)
  91
  92 ;;;###autoload
  93 (define-namespace aggressive-indent- :group indent
  94
  95 (defconst version "0.3.1" "Version of the aggressive-indent.el package.")
  96 (defun bug-report ()
  97   "Opens github issues page in a web browser. Please send any bugs you find.
  98 Please include your emacs and aggressive-indent versions."
  99   (interactive)
 100   (message "Your `aggressive-indent-version' is: %s, and your emacs version is: %s.
 101 Please include this in your report!"
 102            version emacs-version)
 103   (browse-url "https://github.com/Bruce-Connor/aggressive-indent-mode/issues/new"))
 104
 105 \f
 106 ;;; Start of actual Code:
 107 (defcustom dont-electric-modes '(ruby-mode)
 108   "List of major-modes where `electric-indent-mode' shouold be disabled."
 109   :type '(choice
 110           (const :tag "Never use `electric-indent-mode'." t)
 111           (repeat :tag "Major-modes to avoid `electric-indent-mode'" symbol))
 112   :package-version '(aggressive-indent . "0.3.1"))
 113
 114 (defcustom excluded-modes
 115   '(text-mode
 116     tabulated-list-mode
 117     special-mode
 118     minibuffer-inactive-mode
 119     bibtex-mode
 120     erc-mode
 121     yaml-mode
 122     jabber-chat-mode)
 123   "Modes in which `aggressive-indent-mode' should not be activated.
 124 This variable is only used if `global-aggressive-indent-mode' is
 125 active. If the minor mode is turned on with the local command,
 126 `aggressive-indent-mode', this variable is ignored."
 127   :type '(repeat symbol)
 128   :package-version '(aggressive-indent . "0.2"))
 129
 130 (defcustom protected-commands '(undo undo-tree-undo undo-tree-redo)
 131   "Commands after which indentation will NOT be performed.
 132 Aggressive indentation could break things like `undo' by locking
 133 the user in a loop, so this variable is used to control which
 134 commands will NOT be followed by a re-indent."
 135   :type '(repeat symbol)
 136   :package-version '(aggressive-indent . "0.1"))
 137
 138 (defcustom comments-too nil
 139   "If non-nil, aggressively indent in comments as well."
 140   :type 'boolean
 141   :package-version '(aggressive-indent . "0.3"))
 142
 143 (defvar -internal-dont-indent-if
 144   '((memq this-command aggressive-indent-protected-commands)
 145     (region-active-p)
 146     buffer-read-only
 147     (null (buffer-modified-p))
 148     (string-match "\\`[[:blank:]]*\n?\\'" (thing-at-point 'line))
 149     (and (not aggressive-indent-comments-too)
 150          (aggressive-indent--in-comment-p)))
 151   "List of forms which prevent indentation when they evaluate to non-nil.
 152 This is for internal use only. For user customization, use
 153 `aggressive-indent-dont-indent-if' instead.")
 154
 155 (defcustom modes-to-prefer-defun '(emacs-lisp-mode lisp-mode scheme-mode)
 156   "List of major-modes in which indenting defun is preferred.
 157 Add here any major modes with very good definitions of
 158 `end-of-defun' and `beginning-of-defun', or modes which bug out
 159 if you have `after-change-functions' (such as paredit).
 160
 161 If current major mode is derived from one of these,
 162 `aggressive-indent-mode' will call
 163 `aggressive-indent-indent-defun' after every command. Otherwise,
 164 it will call `aggressive-indent-indent-region-and-on' after every
 165 buffer change."
 166   :type '(repeat symbol)
 167   :package-version '(aggressive-indent . "0.3"))
 168
 169 (eval-after-load 'yasnippet
 170   '(when (boundp 'yas--active-field-overlay)
 171      (add-to-list 'aggressive-indent--internal-dont-indent-if
 172                   '(and
 173                     (overlayp yas--active-field-overlay)
 174                     (overlay-end yas--active-field-overlay))
 175                   'append)))
 176 (eval-after-load 'company
 177   '(when (boundp 'company-candidates)
 178      (add-to-list 'aggressive-indent--internal-dont-indent-if
 179                   'company-candidates)))
 180 (eval-after-load 'auto-complete
 181   '(when (boundp 'ac-completing)
 182      (add-to-list 'aggressive-indent--internal-dont-indent-if
 183                   'ac-completing)))
 184
 185 (eval-after-load 'css-mode
 186   '(add-hook
 187     'css-mode-hook
 188     (lambda () (unless defun-prompt-regexp
 189             (setq-local defun-prompt-regexp "^[^[:blank:]].*")))))
 190
 191 (defcustom dont-indent-if '()
 192   "List of variables and functions to prevent aggressive indenting.
 193 This variable is a list where each element is a lisp form.
 194 As long as any one of these forms returns non-nil,
 195 aggressive-indent will not perform any indentation.
 196
 197 See `aggressive-indent--internal-dont-indent-if' for usage examples."
 198   :type '(repeat sexp)
 199   :group 'aggressive-indent
 200   :package-version '(aggressive-indent . "0.2"))
 201
 202 (defvar -error-message
 203   "One of the forms in `aggressive-indent-dont-indent-if' had the following error, I've disabled it until you fix it: %S"
 204   "Error message thrown by `aggressive-indent-dont-indent-if'.")
 205
 206 (defvar -has-errored nil
 207   "Keep track of whether `aggressive-indent-dont-indent-if' is throwing.
 208 This is used to prevent an infinite error loop on the user.")
 209
 210 (defun -run-user-hooks ()
 211   "Safely run forms in `aggressive-indent-dont-indent-if'.
 212 If any of them errors out, we only report it once until it stops
 213 erroring again."
 214   (and dont-indent-if
 215        (condition-case er
 216            (prog1 (eval (cons 'or dont-indent-if))
 217              (setq -has-errored nil))
 218          (error
 219           (unless -has-errored
 220             (setq -has-errored t)
 221             (message -error-message er))))))
 222
 223 (defmacro -do-softly (&rest body)
 224   "Execute body unobstrusively.
 225 This means: do nothing if mark is active (to avoid deactivaing
 226 it), or if buffer is not modified (to avoid creating accidental
 227 modifications), or if any of the forms in
 228 `aggressive-indent-dont-indent-if' evaluates to non-nil.
 229
 230 Also, never throw errors nor messages.
 231 Meant for use in functions which go in hooks."
 232   (declare (debug t))
 233   `(unless (or (run-hook-wrapped
 234                 'aggressive-indent--internal-dont-indent-if
 235                 #'eval)
 236                (aggressive-indent--run-user-hooks))
 237      (ignore-errors
 238        (cl-letf (((symbol-function 'message) #'ignore))
 239          ,@body))))
 240
 241 :autoload
 242 (defun indent-defun ()
 243   "Indent current defun.
 244 Throw an error if parentheses are unbalanced."
 245   (interactive)
 246   (let ((p (point-marker)))
 247     (set-marker-insertion-type p t)
 248     (indent-region
 249      (save-excursion (beginning-of-defun 1) (point))
 250      (save-excursion (end-of-defun 1) (point)))
 251     (goto-char p)))
 252
 253 (defun -softly-indent-defun ()
 254   "Indent current defun unobstrusively.
 255 Like `aggressive-indent-indent-defun', but wrapped in a
 256 `aggressive-indent--do-softly'."
 257   (unless (or (run-hook-wrapped
 258                'aggressive-indent--internal-dont-indent-if
 259                #'eval)
 260               (aggressive-indent--run-user-hooks))
 261     (ignore-errors
 262       (cl-letf (((symbol-function 'message) #'ignore))
 263         (indent-defun)))))
 264
 265 :autoload
 266 (defun indent-region-and-on (l r)
 267   "Indent region between L and R, and then some.
 268 Call `indent-region' between L and R, and then keep indenting
 269 until nothing more happens."
 270   (interactive "r")
 271   (let ((p (point-marker))
 272         was-begining-of-line)
 273     (set-marker-insertion-type p t)
 274     (goto-char r)
 275     (setq was-begining-of-line
 276           (= r (line-beginning-position)))
 277     ;; If L is at the end of a line, skip that line.
 278     (unless (= l r)
 279       (goto-char l)
 280       (when (= l (line-end-position))
 281         (cl-incf l)))
 282     ;; Indent the affected region.
 283     (unless (= l r) (indent-region l r))
 284     ;; `indent-region' doesn't do anything if R was the beginning of a line, so we indent manually there.
 285     (when was-begining-of-line
 286       (indent-according-to-mode))
 287     ;; And then we indent each following line until nothing happens.
 288     (forward-line 1)
 289     (while (and (null (eobp))
 290                 (/= (progn (skip-chars-forward "[:blank:]\n")
 291                            (point))
 292                     (progn (indent-according-to-mode)
 293                            (point))))
 294       (forward-line 1))
 295     (goto-char p)))
 296
 297 (defun -softly-indent-region-and-on (l r &rest _)
 298   "Indent current defun unobstrusively.
 299 Like `aggressive-indent-indent-region-and-on', but wrapped in a
 300 `aggressive-indent--do-softly'."
 301   (unless (or (run-hook-wrapped
 302                'aggressive-indent--internal-dont-indent-if
 303                #'eval)
 304               (aggressive-indent--run-user-hooks))
 305     (ignore-errors
 306       (cl-letf (((symbol-function 'message) #'ignore))
 307         (indent-region-and-on l r)))))
 308
 309 (defvar changed-list-right nil
 310   "List of right limit of regions changed in the last command loop.")
 311
 312 (defvar changed-list-left nil
 313   "List of left limit of regions changed in the last command loop.")
 314
 315 (defun -indent-if-changed ()
 316   "Indent any region that changed in the last command loop."
 317   (let ((inhibit-modification-hooks t))
 318     (when changed-list-left
 319       (-softly-indent-region-and-on
 320        (apply #'min changed-list-left)
 321        (apply #'max changed-list-right))
 322       (setq changed-list-left nil
 323             changed-list-right nil))))
 324
 325 (defun -keep-track-of-changes (l r &rest _)
 326   "Store the limits of each change that happens in the buffer."
 327   (push l changed-list-left)
 328   (push r changed-list-right))
 329
 330 (defun -in-comment-p ()
 331   "Return non-nil if point is inside a comment.
 332 Assumes that the syntax table is sufficient to find comments."
 333   (nth 4 (syntax-ppss)))
 334
 335 \f
 336 ;;; Minor modes
 337 :autoload
 338 (define-minor-mode mode nil nil " =>"
 339   '(("\C-c\C-q" . aggressive-indent-indent-defun))
 340   (if mode
 341       (if (and global-aggressive-indent-mode
 342                (or (cl-member-if #'derived-mode-p excluded-modes)
 343                    buffer-read-only))
 344           (mode -1)
 345         ;; Should electric indent be ON or OFF?
 346         (if (or (eq dont-electric-modes t)
 347                 (cl-member-if #'derived-mode-p dont-electric-modes))
 348             (-local-electric nil)
 349           (-local-electric t))
 350         (if (cl-member-if #'derived-mode-p modes-to-prefer-defun)
 351             (add-hook 'post-command-hook #'-softly-indent-defun nil 'local)
 352           (add-hook 'after-change-functions #'-keep-track-of-changes nil 'local)
 353           (add-hook 'post-command-hook #'-indent-if-changed nil 'local)))
 354     ;; Clean the hooks
 355     (remove-hook 'after-change-functions #'-keep-track-of-changes 'local)
 356     (remove-hook 'post-command-hook #'-indent-if-changed 'local)
 357     (remove-hook 'post-command-hook #'-softly-indent-defun 'local)))
 358
 359 (defun -local-electric (on)
 360   "Turn `electric-indent-mode' on or off locally, as given by boolean ON."
 361   (if (fboundp 'electric-indent-local-mode)
 362       (electric-indent-local-mode (if on 1 -1))
 363     (set (make-local-variable 'electric-indent-mode) on)))
 364
 365 :autoload
 366 (define-globalized-minor-mode global-aggressive-indent-mode
 367   mode mode)
 368
 369 :autoload
 370 (defalias 'aggressive-indent-global-mode
 371   #'global-aggressive-indent-mode)
 372 )
 373
 374 (provide 'aggressive-indent)
 375 ;;; aggressive-indent.el ends here.