-;;; aggressive-indent.el --- Minor mode to keep your code always indented. More aggressive than electric-indent-mode.
+;;; aggressive-indent.el --- Minor mode to aggressively keep your code always indented
-;; Copyright (C) 2014 Artur Malabarba <bruce.connor.am@gmail.com>
+;; Copyright (C) 2014 Free Software Foundation, Inc.
-;; Author: Artur Malabarba <bruce.connor.am@gmail.com>
-;; URL: http://github.com/Bruce-Connor/aggressive-indent-mode
-;; Version: 0.1
-;; Package-Requires: ((emacs "24.1") (names "0.5") (cl-lib "0.5"))
+;; Author: Artur Malabarba <emacs@endlessparentheses.com>
+;; URL: http://github.com/Malabarba/aggressive-indent-mode
+;; Version: 1.1.1
+;; Package-Requires: ((emacs "24.1") (names "20150125.9") (cl-lib "0.5"))
;; Keywords: indent lisp maint tools
;; Prefix: aggressive-indent
;; Separator: -
;;; Commentary:
-;;
+;;
;; `electric-indent-mode' is enough to keep your code nicely aligned when
-;; all you do is type. However, once you start shifting blocks around,
+;; all you do is type. However, once you start shifting blocks around,
;; transposing lines, or slurping and barfing sexps, indentation is bound
;; to go wrong.
-;;
+;;
;; `aggressive-indent-mode' is a minor mode that keeps your code always
-;; indented. It reindents after every command, making it more reliable
+;; indented. It reindents after every change, making it more reliable
;; than `electric-indent-mode'.
-;;
+;;
;; ### Instructions ###
-;;
+;;
;; This package is available fom Melpa, you may install it by calling
-;;
+;;
;; M-x package-install RET aggressive-indent
-;;
+;;
;; Then activate it with
-;;
+;;
;; (add-hook 'emacs-lisp-mode-hook #'aggressive-indent-mode)
;; (add-hook 'css-mode-hook #'aggressive-indent-mode)
-;;
+;;
;; You can use this hook on any mode you want, `aggressive-indent' is not
-;; exclusive to emacs-lisp code. In fact, if you want to turn it on for
+;; exclusive to emacs-lisp code. In fact, if you want to turn it on for
;; every programming mode, you can do something like:
-;;
+;;
;; (global-aggressive-indent-mode 1)
;; (add-to-list 'aggressive-indent-excluded-modes 'html-mode)
-;;
+;;
;; ### Manual Installation ###
-;;
+;;
;; If you don't want to install from Melpa, you can download it manually,
;; place it in your `load-path' and require it with
-;;
+;;
;; (require 'aggressive-indent)
;;; Instructions:
;;
;;; Change Log:
-;; 0.1 - 2014/10/15 - Release.
+;; 0.3.1 - 2014/10/30 - Define new delete-backward bound to backspace.
+;; 0.3 - 2014/10/23 - Implement a smarter engine for non-lisp modes.
+;; 0.2 - 2014/10/20 - Reactivate `electric-indent-mode'.
+;; 0.2 - 2014/10/19 - Add variable `aggressive-indent-dont-indent-if', so the user can prevent indentation.
+;; 0.1 - 2014/10/15 - Release.
;;; Code:
(require 'cl-lib)
-(require 'names)
+(eval-when-compile (require 'names))
;;;###autoload
-(define-namespace aggressive-indent- :group indent
+(define-namespace aggressive-indent-
+:group indent
-(defconst version "0.1" "Version of the aggressive-indent.el package.")
(defun bug-report ()
- "Opens github issues page in a web browser. Please send any bugs you find.
-Please include your emacs and aggressive-indent versions."
+ "Opens github issues page in a web browser. Please send any bugs you find.
+Please include your Emacs and `aggressive-indent' versions."
(interactive)
+ (require 'lisp-mnt)
(message "Your `aggressive-indent-version' is: %s, and your emacs version is: %s.
Please include this in your report!"
- aggressive-indent-version emacs-version)
+ (lm-version (find-library-name "aggressive-indent"))
+ emacs-version)
(browse-url "https://github.com/Bruce-Connor/aggressive-indent-mode/issues/new"))
\f
;;; Start of actual Code:
+(defcustom dont-electric-modes '(ruby-mode)
+ "List of major-modes where `electric-indent' should be disabled."
+ :type '(choice
+ (const :tag "Never use `electric-indent-mode'." t)
+ (repeat :tag "List of major-modes to avoid `electric-indent-mode'." symbol))
+ :package-version '(aggressive-indent . "0.3.1"))
+
(defcustom excluded-modes
- '(text-mode tabulated-list-mode special-mode
- minibuffer-inactive-mode)
+ '(
+ bibtex-mode
+ cider-repl-mode
+ coffee-mode
+ comint-mode
+ conf-mode
+ Custom-mode
+ diff-mode
+ doc-view-mode
+ dos-mode
+ erc-mode
+ jabber-chat-mode
+ haml-mode
+ haskell-mode
+ image-mode
+ makefile-mode
+ makefile-gmake-mode
+ minibuffer-inactive-mode
+ netcmd-mode
+ python-mode
+ sass-mode
+ slim-mode
+ special-mode
+ shell-mode
+ snippet-mode
+ eshell-mode
+ tabulated-list-mode
+ term-mode
+ TeX-output-mode
+ text-mode
+ yaml-mode
+ )
"Modes in which `aggressive-indent-mode' should not be activated.
This variable is only used if `global-aggressive-indent-mode' is
-active. If the minor mode is turned on with the local command,
+active. If the minor mode is turned on with the local command,
`aggressive-indent-mode', this variable is ignored."
:type '(repeat symbol)
- :package-version '(aggressive-indent . "0.1"))
+ :package-version '(aggressive-indent . "0.3.1"))
(defcustom protected-commands '(undo undo-tree-undo undo-tree-redo)
"Commands after which indentation will NOT be performed.
:type '(repeat symbol)
:package-version '(aggressive-indent . "0.1"))
-(defun -softly-indent-defun ()
- "Indent current defun unobstrusively.
-Like `aggressive-indent-indent-defun', except do nothing if
-mark is active (to avoid deactivaing it), or if buffer is not
-modified (to avoid creating accidental modifications).
-Also, never throw errors nor messages.
-
-Meant for use in hooks. Interactively, use the other one."
- (unless (or (region-active-p)
- buffer-read-only
- (null (buffer-modified-p))
- (memq last-command protected-commands))
- (ignore-errors
- (cl-letf (((symbol-function 'message) #'ignore))
- (indent-defun)))))
+(defcustom comments-too nil
+ "If non-nil, aggressively indent in comments as well."
+ :type 'boolean
+ :package-version '(aggressive-indent . "0.3"))
+
+(defvar -internal-dont-indent-if
+ '((memq this-command aggressive-indent-protected-commands)
+ (region-active-p)
+ buffer-read-only
+ (null (buffer-modified-p))
+ (and (boundp 'smerge-mode) smerge-mode)
+ (let ((line (thing-at-point 'line)))
+ (when (stringp line)
+ (or (string-match "\\`[[:blank:]]*\n?\\'" line)
+ ;; If the user is starting to type a comment.
+ (and (stringp comment-start)
+ (string-match (concat "\\`[[:blank:]]*"
+ (substring comment-start 0 1)
+ "[[:blank:]]*$")
+ line)))))
+ (let ((sp (syntax-ppss)))
+ ;; Comments.
+ (or (and (not aggressive-indent-comments-too) (elt sp 4))
+ ;; Strings.
+ (elt sp 3))))
+ "List of forms which prevent indentation when they evaluate to non-nil.
+This is for internal use only. For user customization, use
+`aggressive-indent-dont-indent-if' instead.")
+
+(defcustom modes-to-prefer-defun
+ '(emacs-lisp-mode lisp-mode scheme-mode clojure-mode)
+ "List of major-modes in which indenting defun is preferred.
+Add here any major modes with very good definitions of
+`end-of-defun' and `beginning-of-defun', or modes which bug out
+if you have `after-change-functions' (such as paredit).
+
+If current major mode is derived from one of these,
+`aggressive-indent' will call `aggressive-indent-indent-defun'
+after every command. Otherwise, it will call
+`aggressive-indent-indent-region-and-on' after every buffer
+change."
+ :type '(repeat symbol)
+ :package-version '(aggressive-indent . "0.3"))
+
+(eval-after-load 'yasnippet
+ '(when (boundp 'yas--active-field-overlay)
+ (add-to-list 'aggressive-indent--internal-dont-indent-if
+ '(and
+ (overlayp yas--active-field-overlay)
+ (overlay-end yas--active-field-overlay))
+ 'append)))
+(eval-after-load 'company
+ '(when (boundp 'company-candidates)
+ (add-to-list 'aggressive-indent--internal-dont-indent-if
+ 'company-candidates)))
+(eval-after-load 'auto-complete
+ '(when (boundp 'ac-completing)
+ (add-to-list 'aggressive-indent--internal-dont-indent-if
+ 'ac-completing)))
+(eval-after-load 'iedit
+ '(when (boundp 'iedit-mode)
+ (add-to-list 'aggressive-indent--internal-dont-indent-if
+ 'iedit-mode)))
+(eval-after-load 'coq
+ '(add-to-list 'aggressive-indent--internal-dont-indent-if
+ '(and (derived-mode-p 'coq-mode)
+ (not (string-match "\\.[[:space:]]*$"
+ (thing-at-point 'line))))))
+
+(defcustom dont-indent-if '()
+ "List of variables and functions to prevent aggressive indenting.
+This variable is a list where each element is a Lisp form.
+As long as any one of these forms returns non-nil,
+aggressive-indent will not perform any indentation.
+See `aggressive-indent--internal-dont-indent-if' for usage examples."
+ :type '(repeat sexp)
+ :group 'aggressive-indent
+ :package-version '(aggressive-indent . "0.2"))
+
+(defvar -error-message
+ "One of the forms in `aggressive-indent-dont-indent-if' had the following error, I've disabled it until you fix it: %S"
+ "Error message thrown by `aggressive-indent-dont-indent-if'.")
+
+(defvar -has-errored nil
+ "Keep track of whether `aggressive-indent-dont-indent-if' is throwing.
+This is used to prevent an infinite error loop on the user.")
+
+(defun -run-user-hooks ()
+ "Safely run forms in `aggressive-indent-dont-indent-if'.
+If any of them errors out, we only report it once until it stops
+erroring again."
+ (and dont-indent-if
+ (condition-case er
+ (prog1 (eval (cons 'or dont-indent-if))
+ (setq -has-errored nil))
+ (error (unless -has-errored
+ (setq -has-errored t)
+ (message -error-message er))))))
+
+\f
:autoload
-(defun indent-defun ()
+(defun indent-defun (&optional l r)
"Indent current defun.
-Throw an error if parentheses are unbalanced."
+Throw an error if parentheses are unbalanced.
+If L and R are provided, use them for finding the start and end of defun."
(interactive)
(let ((p (point-marker)))
(set-marker-insertion-type p t)
(indent-region
- (save-excursion (beginning-of-defun 1) (point))
- (save-excursion (end-of-defun 1) (point)))
+ (save-excursion
+ (when l (goto-char l))
+ (beginning-of-defun 1) (point))
+ (save-excursion
+ (when r (goto-char r))
+ (end-of-defun 1) (point)))
(goto-char p)))
-\f
-;;; Minor modes
+(defun -softly-indent-defun (&optional l r)
+ "Indent current defun unobstrusively.
+Like `aggressive-indent-indent-defun', but without errors or
+messages. L and R passed to `aggressive-indent-indent-defun'."
+ (unless (or (run-hook-wrapped
+ 'aggressive-indent--internal-dont-indent-if
+ #'eval)
+ (aggressive-indent--run-user-hooks))
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (ignore-errors (indent-defun l r)))))
+
:autoload
-(define-globalized-minor-mode global-aggressive-indent-mode
- mode mode)
+(defun indent-region-and-on (l r)
+ "Indent region between L and R, and then some.
+Call `indent-region' between L and R, and then keep indenting
+until nothing more happens."
+ (interactive "r")
+ (let ((p (point-marker))
+ was-begining-of-line)
+ (set-marker-insertion-type p t)
+ (unwind-protect
+ (progn
+ (goto-char r)
+ (setq was-begining-of-line
+ (= r (line-beginning-position)))
+ ;; If L is at the end of a line, skip that line.
+ (unless (= l r)
+ (goto-char l)
+ (when (= l (line-end-position))
+ (cl-incf l)))
+ ;; Indent the affected region.
+ (unless (= l r) (indent-region l r))
+ ;; `indent-region' doesn't do anything if R was the beginning of a line, so we indent manually there.
+ (when was-begining-of-line
+ (indent-according-to-mode))
+ ;; And then we indent each following line until nothing happens.
+ (forward-line 1)
+ (skip-chars-forward "[:blank:]\n")
+ (let* ((eod (ignore-errors
+ (save-excursion (end-of-defun)
+ (point-marker))))
+ (point-limit (if (and eod (< (point) eod))
+ eod (point-max-marker))))
+ (while (and (null (eobp))
+ (< (point) point-limit)
+ (/= (point)
+ (progn (indent-according-to-mode)
+ (point))))
+ (forward-line 1)
+ (skip-chars-forward "[:blank:]\n"))))
+ (goto-char p))))
+(defun -softly-indent-region-and-on (l r &rest _)
+ "Indent region between L and R, and a bit more.
+Like `aggressive-indent-indent-region-and-on', but without errors
+or messages."
+ (unless (or (run-hook-wrapped
+ 'aggressive-indent--internal-dont-indent-if
+ #'eval)
+ (aggressive-indent--run-user-hooks))
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (ignore-errors (indent-region-and-on l r)))))
+
+(defvar -changed-list nil
+ "List of (left right) limit of regions changed in the last command loop.")
+
+(defun -indent-if-changed ()
+ "Indent any region that changed in the last command loop."
+ (when -changed-list
+ (while-no-input
+ (let ((inhibit-modification-hooks t)
+ (inhibit-point-motion-hooks t)
+ (indent-function
+ (if (cl-member-if #'derived-mode-p modes-to-prefer-defun)
+ #'-softly-indent-defun
+ #'-softly-indent-region-and-on)))
+ (while -changed-list
+ (apply indent-function (car -changed-list))
+ (setq -changed-list (cdr -changed-list)))))))
+
+(defun -keep-track-of-changes (l r &rest _)
+ "Store the limits (L and R) of each change in the buffer."
+ (push (list l r) -changed-list))
+
+\f
+;;; Minor modes
:autoload
-(define-minor-mode mode nil nil " =>"
- '(("\C-c\C-q" . aggressive-indent-indent-defun))
+(define-minor-mode mode
+ nil nil " =>"
+ '(("\ 3\11" . aggressive-indent-indent-defun)
+ ([backspace] menu-item "maybe-delete-indentation" ignore
+ :filter (lambda (&optional _)
+ (when (and (looking-back "^[[:blank:]]+")
+ ;; Wherever we don't want to indent, we probably also
+ ;; want the default backspace behavior.
+ (not (run-hook-wrapped
+ 'aggressive-indent--internal-dont-indent-if
+ #'eval))
+ (not (aggressive-indent--run-user-hooks)))
+ #'delete-indentation))))
(if mode
(if (and global-aggressive-indent-mode
(or (cl-member-if #'derived-mode-p excluded-modes)
+ (memq major-mode '(text-mode fundamental-mode))
buffer-read-only))
(mode -1)
- (setq-local electric-indent-mode nil)
- (add-hook 'post-command-hook #'-softly-indent-defun nil 'local))
+ ;; Should electric indent be ON or OFF?
+ (if (or (eq dont-electric-modes t)
+ (cl-member-if #'derived-mode-p dont-electric-modes))
+ (-local-electric nil)
+ (-local-electric t))
+ (add-hook 'after-change-functions #'-keep-track-of-changes nil 'local)
+ ;; (add-hook 'post-command-hook #'-softly-indent-defun nil 'local)
+ (add-hook 'post-command-hook #'-indent-if-changed nil 'local))
+ ;; Clean the hooks
+ (remove-hook 'after-change-functions #'-keep-track-of-changes 'local)
+ (remove-hook 'post-command-hook #'-indent-if-changed 'local)
(remove-hook 'post-command-hook #'-softly-indent-defun 'local)))
+(defun -local-electric (on)
+ "Turn variable `electric-indent-mode' on or off locally, as per boolean ON."
+ (if (fboundp 'electric-indent-local-mode)
+ (electric-indent-local-mode (if on 1 -1))
+ (set (make-local-variable 'electric-indent-mode) on)))
+
+:autoload
+(define-globalized-minor-mode global-aggressive-indent-mode
+ mode mode)
+
:autoload
-(defalias 'aggressive-indent-global-mode
+(defalias 'aggressive-indent-global-mode
#'global-aggressive-indent-mode)
)
(provide 'aggressive-indent)
-;;; aggressive-indent.el ends here.
+;;; aggressive-indent.el ends here