-;;; aggressive-indent.el --- Minor mode to aggressively keep your code always indented
+;;; aggressive-indent.el --- Minor mode to aggressively keep your code always indented -*- lexical-binding:t -*-
-;; Copyright (C) 2014 Free Software Foundation, Inc.
+;; Copyright (C) 2014, 2015 Free Software Foundation, Inc
;; Author: Artur Malabarba <emacs@endlessparentheses.com>
;; URL: http://github.com/Malabarba/aggressive-indent-mode
- ;; Version: 1.2
- ;; Package-Requires: ((emacs "24.1") (names "20150125.9") (cl-lib "0.5"))
+ ;; Version: 1.4
+ ;; Package-Requires: ((emacs "24.1") (cl-lib "0.5"))
;; Keywords: indent lisp maint tools
;; Prefix: aggressive-indent
;; Separator: -
;;
;; 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
+;; as published by the Free Software Foundation; either version 3
;; of the License, or (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;;; Code:
(require 'cl-lib)
- (eval-when-compile (require 'names))
- ;;;###autoload
- (define-namespace aggressive-indent-
- :group indent
+ (defgroup aggressive-indent nil
+ "Customization group for aggressive-indent."
+ :prefix "aggressive-indent-"
+ :group 'indent)
- (defun bug-report ()
+ (defun aggressive-indent-bug-report ()
"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!"
- (lm-version (find-library-name "aggressive-indent"))
- emacs-version)
+ (eval-when-compile
+ (ignore-errors
+ (require 'lisp-mnt)
+ (lm-version)))
+ 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)
+ (defvar aggressive-indent-mode)
+
+ ;;; Configuring indentarion
+ (defcustom aggressive-indent-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
+ (defcustom aggressive-indent-excluded-modes
'(
bibtex-mode
cider-repl-mode
:type '(repeat symbol)
:package-version '(aggressive-indent . "0.3.1"))
- (defcustom protected-commands '(undo undo-tree-undo undo-tree-redo)
+ (defcustom aggressive-indent-protected-commands '(undo undo-tree-undo undo-tree-redo whitespace-cleanup)
"Commands after which indentation will NOT be performed.
Aggressive indentation could break things like `undo' by locking
the user in a loop, so this variable is used to control which
:type '(repeat symbol)
:package-version '(aggressive-indent . "0.1"))
- (defcustom comments-too nil
+ (defcustom aggressive-indent-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
+ (defcustom aggressive-indent-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"))
+
+ ;;; Preventing indentation
+ (defvar aggressive-indent--internal-dont-indent-if
'((memq this-command aggressive-indent-protected-commands)
(region-active-p)
buffer-read-only
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
(not (string-match "\\.[[:space:]]*$"
(thing-at-point 'line))))))
- (defcustom dont-indent-if '()
+ (defcustom aggressive-indent-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,
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"
+ (defvar aggressive-indent--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
+ (defvar aggressive-indent--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 ()
+ (defun aggressive-indent--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
+ (and aggressive-indent-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 (&optional l r)
+ (prog1 (eval (cons 'or aggressive-indent-dont-indent-if))
+ (setq aggressive-indent--has-errored nil))
+ (error (unless aggressive-indent--has-errored
+ (setq aggressive-indent--has-errored t)
+ (message aggressive-indent--error-message er))))))
+
+ ;;; Indenting defun
+ ;;;###autoload
+ (defun aggressive-indent-indent-defun (&optional l r)
"Indent current defun.
Throw an error if parentheses are unbalanced.
If L and R are provided, use them for finding the start and end of defun."
(end-of-defun 1) (point)))
(goto-char p)))
- (defun -softly-indent-defun (&optional l r)
+ (defun aggressive-indent--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'."
(cl-letf (((symbol-function 'message) #'ignore))
- (ignore-errors (indent-defun l r))))
+ (ignore-errors (aggressive-indent-indent-defun l r))))
- :autoload
- (defun indent-region-and-on (l r)
+ ;;; Indenting region
+ ;;;###autoload
+ (defun aggressive-indent-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."
(set-marker-insertion-type p t)
(unwind-protect
(progn
- (goto-char r)
- (setq was-begining-of-line
- (= r (line-beginning-position)))
+ (unless (= l r)
+ (when (= (char-before r) ?\n)
+ (cl-decf r)))
;; If L is at the end of a line, skip that line.
(unless (= l r)
- (goto-char l)
- (when (= l (line-end-position))
+ (when (= (char-after l) ?\n)
(cl-incf l)))
;; Indent the affected region.
+ (goto-char r)
(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")
+ (skip-chars-forward "[:blank:]\n\r\xc")
(let* ((eod (ignore-errors
(save-excursion (end-of-defun)
(point-marker))))
;; not at all, stop at the limit.
(< (point) point-limit))))
(forward-line 1)
- (skip-chars-forward "[:blank:]\n"))))
+ (skip-chars-forward "[:blank:]\n\r\xc"))))
(goto-char p))))
- (defun -softly-indent-region-and-on (l r &rest _)
+ (defun aggressive-indent--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."
(cl-letf (((symbol-function 'message) #'ignore))
- (ignore-errors (indent-region-and-on l r))))
+ (ignore-errors (aggressive-indent-indent-region-and-on l r))))
- (defvar -changed-list nil
+ ;;; Tracking changes
+ (defvar aggressive-indent--changed-list nil
"List of (left right) limit of regions changed in the last command loop.")
+ (make-variable-buffer-local 'aggressive-indent--changed-list)
- (defun -indent-if-changed ()
+ (defun aggressive-indent--indent-if-changed ()
"Indent any region that changed in the last command loop."
- (when -changed-list
+ (when aggressive-indent--changed-list
(unless (or (run-hook-wrapped 'aggressive-indent--internal-dont-indent-if #'eval)
(aggressive-indent--run-user-hooks))
(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 _)
+ (if (cl-member-if #'derived-mode-p aggressive-indent-modes-to-prefer-defun)
+ #'aggressive-indent--softly-indent-defun #'aggressive-indent--softly-indent-region-and-on)))
+ (while aggressive-indent--changed-list
+ (apply indent-function (car aggressive-indent--changed-list))
+ (setq aggressive-indent--changed-list
+ (cdr aggressive-indent--changed-list))))))))
+
+ (defun aggressive-indent--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))
+ (when aggressive-indent-mode
+ (push (list l r) aggressive-indent--changed-list)))
- \f
;;; Minor modes
- :autoload
- (define-minor-mode mode
+ ;;;###autoload
+ (define-minor-mode aggressive-indent-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
+ ([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 aggressive-indent-mode
(if (and global-aggressive-indent-mode
- (or (cl-member-if #'derived-mode-p excluded-modes)
+ (or (cl-member-if #'derived-mode-p aggressive-indent-excluded-modes)
(memq major-mode '(text-mode fundamental-mode))
buffer-read-only))
- (mode -1)
- ;; 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))
+ (aggressive-indent-mode -1)
+ ;; Should electric indent be ON or OFF?
+ (if (or (eq aggressive-indent-dont-electric-modes t)
+ (cl-member-if #'derived-mode-p aggressive-indent-dont-electric-modes))
+ (aggressive-indent--local-electric nil)
+ (aggressive-indent--local-electric t))
+ (add-hook 'after-change-functions #'aggressive-indent--keep-track-of-changes nil 'local)
+ (add-hook 'post-command-hook #'aggressive-indent--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)))
+ (remove-hook 'after-change-functions #'aggressive-indent--keep-track-of-changes 'local)
+ (remove-hook 'post-command-hook #'aggressive-indent--indent-if-changed 'local)
+ (remove-hook 'post-command-hook #'aggressive-indent--softly-indent-defun 'local)))
- (defun -local-electric (on)
+ (defun aggressive-indent--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
+ ;;;###autoload
(define-globalized-minor-mode global-aggressive-indent-mode
- mode mode)
+ aggressive-indent-mode aggressive-indent-mode)
- :autoload
+ ;;;###autoload
(defalias 'aggressive-indent-global-mode
#'global-aggressive-indent-mode)
- )
(provide 'aggressive-indent)
;;; aggressive-indent.el ends here