diff options
Diffstat (limited to 'misc/ruby-electric.el')
| -rw-r--r-- | misc/ruby-electric.el | 300 |
1 files changed, 0 insertions, 300 deletions
diff --git a/misc/ruby-electric.el b/misc/ruby-electric.el deleted file mode 100644 index 1e43de4b5f..0000000000 --- a/misc/ruby-electric.el +++ /dev/null @@ -1,300 +0,0 @@ -;; -*-Emacs-Lisp-*- -;; -;; ruby-electric.el --- electric editing commands for ruby files -;; -;; Copyright (C) 2005 by Dee Zsombor <dee dot zsombor at gmail dot com>. -;; Released under same license terms as Ruby. -;; -;; Due credit: this work was inspired by a code snippet posted by -;; Frederick Ros at http://rubygarden.org/ruby?EmacsExtensions. -;; -;; Following improvements where added: -;; -;; - handling of strings of type 'here document' -;; - more keywords, with special handling for 'do' -;; - packaged into a minor mode -;; -;; Usage: -;; -;; 0) copy ruby-electric.el into directory where emacs can find it. -;; -;; 1) modify your startup file (.emacs or whatever) by adding -;; following line: -;; -;; (require 'ruby-electric) -;; -;; note that you need to have font lock enabled beforehand. -;; -;; 2) toggle Ruby Electric Mode on/off with ruby-electric-mode. -;; -;; Changelog: -;; -;; 2005/Jan/14: inserts matching pair delimiters like {, [, (, ', ", -;; ' and | . -;; -;; 2005/Jan/14: added basic Custom support for configuring keywords -;; with electric closing. -;; -;; 2005/Jan/18: more Custom support for configuring characters for -;; which matching expansion should occur. -;; -;; 2005/Jan/18: no longer uses 'looking-back' or regexp character -;; classes like [:space:] since they are not implemented on XEmacs. -;; -;; 2005/Feb/01: explicitly provide default argument of 1 to -;; 'backward-word' as it requires it on Emacs 21.3 -;; -;; 2005/Mar/06: now stored inside ruby CVS; customize pages now have -;; ruby as parent; cosmetic fixes. - - -(require 'ruby-mode) - -(defgroup ruby-electric nil - "Minor mode providing electric editing commands for ruby files" - :group 'ruby) - -(defconst ruby-electric-expandable-do-re - "do\\s-$") - -(defconst ruby-electric-expandable-bar - "\\s-\\(do\\|{\\)\\s-+|") - -(defvar ruby-electric-matching-delimeter-alist - '((?\[ . ?\]) - (?\( . ?\)) - (?\' . ?\') - (?\` . ?\`) - (?\" . ?\"))) - -(defcustom ruby-electric-simple-keywords-re - (regexp-opt '("def" "if" "class" "module" "unless" "case" "while" "do" "until" "for" "begin") t) - "*Regular expresion matching keywords for which closing 'end' -is to be inserted." - :type 'regexp :group 'ruby-electric) - -(defcustom ruby-electric-expand-delimiters-list '(all) - "*List of contexts where matching delimiter should be -inserted. The word 'all' will do all insertions." - :type '(set :extra-offset 8 - (const :tag "Everything" all ) - (const :tag "Curly brace" ?\{ ) - (const :tag "Square brace" ?\[ ) - (const :tag "Round brace" ?\( ) - (const :tag "Quote" ?\' ) - (const :tag "Double quote" ?\" ) - (const :tag "Back quote" ?\` ) - (const :tag "Vertical bar" ?\| ) - (const :tag "Hash" ?\# )) - :group 'ruby-electric) - -(defcustom ruby-electric-newline-before-closing-bracket nil - "*Controls whether a newline should be inserted before the -closing bracket or not." - :type 'boolean :group 'ruby-electric) - -(define-minor-mode ruby-electric-mode - "Toggle Ruby Electric minor mode. -With no argument, this command toggles the mode. Non-null prefix -argument turns on the mode. Null prefix argument turns off the -mode. - -When Ruby Electric mode is enabled, an indented 'end' is -heuristicaly inserted whenever typing a word like 'module', -'class', 'def', 'if', 'unless', 'case', 'until', 'for', 'begin', -'do'. Simple, double and back quotes as well as braces are paired -auto-magically. Expansion does not occur inside comments and -strings. Note that you must have Font Lock enabled." - ;; initial value. - nil - ;;indicator for the mode line. - " REl" - ;;keymap - ruby-mode-map - (ruby-electric-setup-keymap)) - -(defun ruby-electric-setup-keymap() - (define-key ruby-mode-map " " 'ruby-electric-space) - (define-key ruby-mode-map "{" 'ruby-electric-curlies) - (define-key ruby-mode-map "(" 'ruby-electric-matching-char) - (define-key ruby-mode-map "[" 'ruby-electric-matching-char) - (define-key ruby-mode-map "\"" 'ruby-electric-matching-char) - (define-key ruby-mode-map "\'" 'ruby-electric-matching-char) - (define-key ruby-mode-map "}" 'ruby-electric-closing-char) - (define-key ruby-mode-map ")" 'ruby-electric-closing-char) - (define-key ruby-mode-map "]" 'ruby-electric-closing-char) - (define-key ruby-mode-map "|" 'ruby-electric-bar) - (define-key ruby-mode-map "#" 'ruby-electric-hash)) - -(defun ruby-electric-space (arg) - (interactive "P") - (self-insert-command (prefix-numeric-value arg)) - (if (ruby-electric-space-can-be-expanded-p) - (save-excursion - (ruby-indent-line t) - (newline) - (ruby-insert-end)))) - -(defun ruby-electric-code-at-point-p() - (and ruby-electric-mode - (let* ((properties (text-properties-at (point)))) - (and (null (memq 'font-lock-string-face properties)) - (null (memq 'font-lock-comment-face properties)))))) - -(defun ruby-electric-string-at-point-p() - (and ruby-electric-mode - (consp (memq 'font-lock-string-face (text-properties-at (point)))))) - -(defun ruby-electric-escaped-p() - (let ((f nil)) - (save-excursion - (while (char-equal ?\\ (preceding-char)) - (backward-char 1) - (setq f (not f)))) - f)) - -(defun ruby-electric-command-char-expandable-punct-p(char) - (or (memq 'all ruby-electric-expand-delimiters-list) - (memq char ruby-electric-expand-delimiters-list))) - -(defun ruby-electric-is-last-command-char-expandable-punct-p() - (or (memq 'all ruby-electric-expand-delimiters-list) - (memq last-command-event ruby-electric-expand-delimiters-list))) - -(defun ruby-electric-space-can-be-expanded-p() - (if (ruby-electric-code-at-point-p) - (let* ((ruby-electric-keywords-re - (concat ruby-electric-simple-keywords-re "\\s-$")) - (ruby-electric-single-keyword-in-line-re - (concat "\\s-*" ruby-electric-keywords-re))) - (save-excursion - (backward-word 1) - (or (looking-at ruby-electric-expandable-do-re) - (and (looking-at ruby-electric-keywords-re) - (not (string= "do" (match-string 1))) - (progn - (beginning-of-line) - (looking-at ruby-electric-single-keyword-in-line-re)))))))) - -(defun ruby-electric-cua-replace-region-p() - (eq (key-binding "a") 'cua-replace-region)) - -(defun ruby-electric-cua-replace-region() - (setq this-original-command 'self-insert-command) - (setq this-command 'cua-replace-region) - (cua-replace-region)) - -(defmacro ruby-electric-insert (arg &rest body) - `(cond ((ruby-electric-cua-replace-region-p) - (ruby-electric-cua-replace-region)) - ((and - (null ,arg) - (ruby-electric-is-last-command-char-expandable-punct-p)) - (self-insert-command 1) - ,@body) - (t - (setq this-command 'self-insert-command) - (self-insert-command (prefix-numeric-value ,arg))))) - -(defun ruby-electric-curlies(arg) - (interactive "P") - (ruby-electric-insert - arg - (cond - ((ruby-electric-code-at-point-p) - (insert "}") - (backward-char 1) - (redisplay) - (cond - ((ruby-electric-string-at-point-p) ;; %w{}, %r{}, etc. - t) - (ruby-electric-newline-before-closing-bracket - (insert " ") - (save-excursion - (newline) - (ruby-indent-line t))) - (t - (insert " ") - (backward-char 1)))) - ((ruby-electric-string-at-point-p) - (save-excursion - (backward-char 1) - (cond - ((char-equal ?\# (preceding-char)) - (unless (save-excursion - (backward-char 1) - (ruby-electric-escaped-p)) - (forward-char 1) - (insert "}"))) - ((or - (ruby-electric-command-char-expandable-punct-p ?\#) - (ruby-electric-escaped-p)) - (setq this-command 'self-insert-command)) - (t - (insert "#") - (forward-char 1) - (insert "}")))))))) - -(defun ruby-electric-hash(arg) - (interactive "P") - (ruby-electric-insert - arg - (and (ruby-electric-string-at-point-p) - (or (char-equal (following-char) ?') ;; likely to be in '' - (save-excursion - (backward-char 1) - (ruby-electric-escaped-p)) - (progn - (insert "{}") - (backward-char 1)))))) - -(defun ruby-electric-matching-char(arg) - (interactive "P") - (ruby-electric-insert - arg - (cond - ((and - (eq last-command 'ruby-electric-matching-char) - (char-equal last-command-event (following-char))) ;; repeated ' or " - (setq this-command 'self-insert-command) - (delete-forward-char 1)) - (t - (and (ruby-electric-code-at-point-p) - (save-excursion (insert (cdr (assoc last-command-event - ruby-electric-matching-delimeter-alist))))))))) - -(defun ruby-electric-closing-char(arg) - (interactive "P") - (cond - ((ruby-electric-cua-replace-region-p) - (ruby-electric-cua-replace-region)) - (arg - (setq this-command 'self-insert-command) - (self-insert-command (prefix-numeric-value arg))) - ((and - (eq last-command 'ruby-electric-curlies) - (= last-command-event ?})) ;; {} - (if (char-equal (following-char) ?\n) (delete-char 1)) - (delete-horizontal-space) - (forward-char)) - ((and - (= last-command-event (following-char)) - (memq last-command '(ruby-electric-matching-char - ruby-electric-closing-char))) ;; ()/[] and (())/[[]] - (forward-char)) - (t - (setq this-command 'self-insert-command) - (self-insert-command 1)))) - -(defun ruby-electric-bar(arg) - (interactive "P") - (ruby-electric-insert - arg - (and (ruby-electric-code-at-point-p) - (save-excursion (re-search-backward ruby-electric-expandable-bar nil t)) - (= (point) (match-end 0)) ;; looking-back is missing on XEmacs - (save-excursion - (insert "|"))))) - - -(provide 'ruby-electric) |