;;; 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.3.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.0.2
+;; 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 command, making it more reliable
;; than `electric-indent-mode'.
;;
;; ### Instructions ###
;; (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)
;;
;;; Change Log:
-;; 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.
+;; 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.3.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!"
- 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
- yaml-mode jabber-chat-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.2"))
+ :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.
(region-active-p)
buffer-read-only
(null (buffer-modified-p))
- (string-match "\\`[[:blank:]]*\n?\\'" (thing-at-point 'line))
- (and (not aggressive-indent-comments-too)
- (aggressive-indent--in-comment-p)))
+ (and (boundp 'smerge-mode) smerge-mode)
+ (string-match "\\`[[:blank:]]*\n?\\'" (or (thing-at-point '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
+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)
+(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-mode' will call
-`aggressive-indent-indent-defun' after every command. Otherwise,
-it will call `aggressive-indent-indent-region-and-on' after every
-buffer change."
+`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)
- :group 'aggressive-indent
:package-version '(aggressive-indent . "0.3"))
(eval-after-load 'yasnippet
'(when (boundp 'ac-completing)
(add-to-list 'aggressive-indent--internal-dont-indent-if
'ac-completing)))
-
-(eval-after-load 'css-mode
- '(add-hook
- 'css-mode-hook
- (lambda () (unless defun-prompt-regexp
- (setq-local defun-prompt-regexp "^[^[:blank:]].*")))))
+(eval-after-load 'iedit
+ '(when (boundp 'iedit-mode)
+ (add-to-list 'aggressive-indent--internal-dont-indent-if
+ 'iedit-mode)))
(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.
+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.
(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))))))
-
-(defmacro -do-softly (&rest body)
- "Execute body unobstrusively.
-This means: do nothing if mark is active (to avoid deactivaing
-it), or if buffer is not modified (to avoid creating accidental
-modifications), or if any of the forms in
-`aggressive-indent-dont-indent-if' evaluates to non-nil.
-
-Also, never throw errors nor messages.
-Meant for use in functions which go in hooks."
- (declare (debug t))
- `(unless (or (run-hook-wrapped
- 'aggressive-indent--internal-dont-indent-if
- #'eval)
- (aggressive-indent--run-user-hooks))
- (ignore-errors
- (cl-letf (((symbol-function 'message) #'ignore))
- ,@body))))
+ (error (unless -has-errored
+ (setq -has-errored t)
+ (message -error-message er))))))
:autoload
(defun indent-defun ()
(defun -softly-indent-defun ()
"Indent current defun unobstrusively.
-Like `aggressive-indent-indent-defun', but wrapped in a
-`aggressive-indent--do-softly'."
+Like `aggressive-indent-indent-defun', but without errors or
+messages."
(unless (or (run-hook-wrapped
'aggressive-indent--internal-dont-indent-if
#'eval)
(aggressive-indent--run-user-hooks))
- (ignore-errors
- (cl-letf (((symbol-function 'message) #'ignore))
- (indent-defun)))))
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (ignore-errors (indent-defun)))))
:autoload
(defun indent-region-and-on (l r)
(let ((p (point-marker))
was-begining-of-line)
(set-marker-insertion-type p t)
- (goto-char r)
- (setq was-begining-of-line
- (= r (line-beginning-position)))
- ;; 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)
- (while (/= (progn (skip-chars-forward "[:blank:]\n")
- (point))
- (progn (indent-according-to-mode)
- (point)))
- (forward-line 1))
- (goto-char p)))
+ (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)
+ (while (and (null (eobp))
+ (/= (progn (skip-chars-forward "[:blank:]\n")
+ (point))
+ (progn (indent-according-to-mode)
+ (point))))
+ (forward-line 1)))
+ (goto-char p))))
(defun -softly-indent-region-and-on (l r &rest _)
- "Indent current defun unobstrusively.
-Like `aggressive-indent-indent-region-and-on', but wrapped in a
-`aggressive-indent--do-softly'."
+ "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))
- (ignore-errors
- (cl-letf (((symbol-function 'message) #'ignore))
- (indent-region-and-on l r)))))
+ (cl-letf (((symbol-function 'message) #'ignore))
+ (ignore-errors (indent-region-and-on l r)))))
-(defvar changed-list-right nil
+(defvar -changed-list-right nil
"List of right limit of regions changed in the last command loop.")
-(defvar changed-list-left nil
+(defvar -changed-list-left nil
"List of left limit of regions changed in the last command loop.")
(defun -indent-if-changed ()
"Indent any region that changed in the last command loop."
(let ((inhibit-modification-hooks t))
- (when changed-list-left
+ (when -changed-list-left
(-softly-indent-region-and-on
- (apply #'min changed-list-left)
- (apply #'max changed-list-right))
- (setq changed-list-left nil
- changed-list-right nil))))
+ (apply #'min -changed-list-left)
+ (apply #'max -changed-list-right))
+ (setq -changed-list-left nil
+ -changed-list-right nil))))
(defun -keep-track-of-changes (l r &rest _)
- "Store the limits of each change that happens in the buffer."
- (push l changed-list-left)
- (push r changed-list-right))
-
-(defun -in-comment-p ()
- "Return non-nil if point is inside a comment.
-Assumes that the syntax table is sufficient to find comments."
- (nth 4 (syntax-ppss)))
+ "Store the limits (L and R) of each change in the buffer."
+ (push l -changed-list-left)
+ (push r -changed-list-right))
\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)
- (when (fboundp 'electric-indent-local-mode)
- (electric-indent-local-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))
(if (cl-member-if #'derived-mode-p modes-to-prefer-defun)
(add-hook 'post-command-hook #'-softly-indent-defun nil 'local)
(add-hook 'after-change-functions #'-keep-track-of-changes nil '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)
)
(provide 'aggressive-indent)
-;;; aggressive-indent.el ends here.
+;;; aggressive-indent.el ends here