[elpa] master 482f49e 103/108: Add 'packages/aggressive-indent/' from commit '72796c652f0eb29902c3d95b7a5411757606b074'

[Artur Malabarba]

branch: master
commit 482f49e93cabd932c1357225934b92f65dadd489
Merge: addec68 72796c6
Author: Artur Malabarba <address@hidden>
Commit: Artur Malabarba <address@hidden>

    Add 'packages/aggressive-indent/' from commit 
'72796c652f0eb29902c3d95b7a5411757606b074'
    
    git-subtree-dir: packages/aggressive-indent
    git-subtree-mainline: addec68b2d8490523dfffd04be8997d8b1840303
    git-subtree-split: 72796c652f0eb29902c3d95b7a5411757606b074
---
 packages/aggressive-indent/README.md            |   64 ++++
 packages/aggressive-indent/aggressive-indent.el |  386 +++++++++++++++++++++++
 packages/aggressive-indent/c-example.gif        |  Bin 0 -> 88739 bytes
 packages/aggressive-indent/lisp-example.gif     |  Bin 0 -> 493302 bytes
 4 files changed, 450 insertions(+), 0 deletions(-)

diff --git a/packages/aggressive-indent/README.md 
b/packages/aggressive-indent/README.md
new file mode 100644
index 0000000..8abb380
--- /dev/null
+++ b/packages/aggressive-indent/README.md
@@ -0,0 +1,64 @@
+aggressive-indent-mode
+======================
+(_[Wanna say thank you?](https://gratipay.com/Malabarba/)_)
+
+`electric-indent-mode` is enough to keep your code nicely aligned when
+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
+than `electric-indent-mode`.
+
+### Demonstration ###
+
+- An example of Lisp mode (Emacs Lisp):
+![Lisp Code Example](lisp-example.gif)
+
+- An example of non-Lisp mode (C):
+![C Code Example](c-example.gif)
+
+### 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
+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` along with its two dependencies:
+
+- [Names](https://github.com/Bruce-Connor/names/)
+- and `cl-lib` (which you should already have if your `emacs-version` is at 
least 24.3).
+
+Then require it with:
+
+    (require 'aggressive-indent)
+
+### Customization ###
+
+The variable `aggressive-indent-dont-indent-if` lets you customize
+when you **don't** want indentation to happen.
+For instance, if you think it's annoying that lines jump around in
+`c++-mode` because you haven't typed the `;` yet, you could add the
+following clause:
+
+    (add-to-list
+     'aggressive-indent-dont-indent-if
+     '(and (derived-mode-p 'c++-mode)
+           (null (string-match "\\([;{}]\\|\\b\\(if\\|for\\|while\\)\\b\\)"
+                               (thing-at-point 'line)))))
diff --git a/packages/aggressive-indent/aggressive-indent.el 
b/packages/aggressive-indent/aggressive-indent.el
new file mode 100644
index 0000000..8ee2c1c
--- /dev/null
+++ b/packages/aggressive-indent/aggressive-indent.el
@@ -0,0 +1,386 @@
+;;; aggressive-indent.el --- Minor mode to aggressively keep your code always 
indented
+
+;; Copyright (C) 2014 Artur Malabarba <address@hidden>
+
+;; Author: Artur Malabarba <address@hidden>
+;; URL: http://github.com/Malabarba/aggressive-indent-mode
+;; Version: 1.0
+;; 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,
+;; 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
+;; 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
+;; 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:
+;;
+;; INSTALLATION
+;;
+;; 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)
+;;
+;; You can also use an equivalent hook for another mode,
+;; `aggressive-indent' is not exclusive to emacs-lisp code.
+;;
+;; Alternatively, you can download it manually, place it in your
+;; `load-path' and require it with
+;;
+;;     (require 'aggressive-indent)
+
+;;; License:
+;;
+;; This file is NOT part of GNU Emacs.
+;;
+;; 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
+;; of the License, or (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+
+;;; Change Log:
+;; 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)
+
+;;;###autoload
+(define-namespace aggressive-indent-
+:group indent
+
+(defconst version (lm-version) "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."
+  (interactive)
+  (message "Your `aggressive-indent-version' is: %s, and your emacs version 
is: %s.
+Please include this in your report!"
+    version emacs-version)
+  (browse-url 
"https://github.com/Bruce-Connor/aggressive-indent-mode/issues/new";))
+
+
+;;; 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
+  '(
+    bibtex-mode
+    cider-repl-mode
+    coffee-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,
+`aggressive-indent-mode', this variable is ignored."
+  :type '(repeat symbol)
+  :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.
+Aggressive indentation could break things like `undo' by locking
+the user in a loop, so this variable is used to control which
+commands will NOT be followed by a re-indent."
+  :type '(repeat symbol)
+  :package-version '(aggressive-indent . "0.1"))
+
+(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)
+    (string-match "\\`[[:blank:]]*\n?\\'" (or (thing-at-point 'line) ""))
+    (let ((sp (syntax-ppss)))
+      ;; Comments.
+      (or (and (not aggresive-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)))
+
+(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))))))
+
+:autoload
+(defun indent-defun ()
+  "Indent current defun.
+Throw an error if parentheses are unbalanced."
+  (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)))
+    (goto-char p)))
+
+(defun -softly-indent-defun ()
+  "Indent current defun unobstrusively.
+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))
+    (cl-letf (((symbol-function 'message) #'ignore))
+      (ignore-errors (indent-defun)))))
+
+:autoload
+(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)
+          (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 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-right nil
+  "List of right limit of regions changed in the last command loop.")
+
+(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
+      (-softly-indent-region-and-on
+       (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 (L and R) of each change in the buffer."
+  (push l -changed-list-left)
+  (push r -changed-list-right))
+
+
+;;; Minor modes
+:autoload
+(define-minor-mode mode
+  nil nil " =>"
+  '(("" . 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)
+        ;; 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)
+          (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
+  #'global-aggressive-indent-mode)
+)
+
+(provide 'aggressive-indent)
+;;; aggressive-indent.el ends here
diff --git a/packages/aggressive-indent/c-example.gif 
b/packages/aggressive-indent/c-example.gif
new file mode 100644
index 0000000..f72e143
Binary files /dev/null and b/packages/aggressive-indent/c-example.gif differ
diff --git a/packages/aggressive-indent/lisp-example.gif 
b/packages/aggressive-indent/lisp-example.gif
new file mode 100644
index 0000000..220289a
Binary files /dev/null and b/packages/aggressive-indent/lisp-example.gif differ