mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-29 07:58:28 +00:00
2015 lines
76 KiB
EmacsLisp
2015 lines
76 KiB
EmacsLisp
;;; ruby-mode.el --- Major mode for editing Ruby files
|
|
|
|
;; Copyright (C) 1994-2013 Free Software Foundation, Inc.
|
|
|
|
;; Authors: Yukihiro Matsumoto
|
|
;; Nobuyoshi Nakada
|
|
;; URL: http://www.emacswiki.org/cgi-bin/wiki/RubyMode
|
|
;; Created: Fri Feb 4 14:49:13 JST 1994
|
|
;; Keywords: languages ruby
|
|
;; Version: 1.2
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs 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 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs 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.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Provides font-locking, indentation support, and navigation for Ruby code.
|
|
;;
|
|
;; If you're installing manually, you should add this to your .emacs
|
|
;; file after putting it on your load path:
|
|
;;
|
|
;; (autoload 'ruby-mode "ruby-mode" "Major mode for ruby files" t)
|
|
;; (add-to-list 'auto-mode-alist '("\\.rb$" . ruby-mode))
|
|
;; (add-to-list 'interpreter-mode-alist '("ruby" . ruby-mode))
|
|
;;
|
|
;; Still needs more docstrings; search below for TODO.
|
|
|
|
;;; Code:
|
|
|
|
(defgroup ruby nil
|
|
"Major mode for editing Ruby code."
|
|
:prefix "ruby-"
|
|
:group 'languages)
|
|
|
|
(defconst ruby-block-beg-keywords
|
|
'("class" "module" "def" "if" "unless" "case" "while" "until" "for" "begin" "do")
|
|
"Keywords at the beginning of blocks.")
|
|
|
|
(defconst ruby-block-beg-re
|
|
(regexp-opt ruby-block-beg-keywords)
|
|
"Regexp to match the beginning of blocks.")
|
|
|
|
(defconst ruby-non-block-do-re
|
|
(regexp-opt '("while" "until" "for" "rescue") 'symbols)
|
|
"Regexp to match keywords that nest without blocks.")
|
|
|
|
(defconst ruby-indent-beg-re
|
|
(concat "^\\(\\s *" (regexp-opt '("class" "module" "def")) "\\|"
|
|
(regexp-opt '("if" "unless" "case" "while" "until" "for" "begin"))
|
|
"\\)\\_>")
|
|
"Regexp to match where the indentation gets deeper.")
|
|
|
|
(defconst ruby-modifier-beg-keywords
|
|
'("if" "unless" "while" "until")
|
|
"Modifiers that are the same as the beginning of blocks.")
|
|
|
|
(defconst ruby-modifier-beg-re
|
|
(regexp-opt ruby-modifier-beg-keywords)
|
|
"Regexp to match modifiers same as the beginning of blocks.")
|
|
|
|
(defconst ruby-modifier-re
|
|
(regexp-opt (cons "rescue" ruby-modifier-beg-keywords))
|
|
"Regexp to match modifiers.")
|
|
|
|
(defconst ruby-block-mid-keywords
|
|
'("then" "else" "elsif" "when" "rescue" "ensure")
|
|
"Keywords where the indentation gets shallower in middle of block statements.")
|
|
|
|
(defconst ruby-block-mid-re
|
|
(regexp-opt ruby-block-mid-keywords)
|
|
"Regexp to match where the indentation gets shallower in middle of block statements.")
|
|
|
|
(defconst ruby-block-op-keywords
|
|
'("and" "or" "not")
|
|
"Regexp to match boolean keywords.")
|
|
|
|
(defconst ruby-block-hanging-re
|
|
(regexp-opt (append ruby-modifier-beg-keywords ruby-block-op-keywords))
|
|
"Regexp to match hanging block modifiers.")
|
|
|
|
(defconst ruby-block-end-re "\\_<end\\_>")
|
|
|
|
(defconst ruby-defun-beg-re
|
|
'"\\(def\\|class\\|module\\)"
|
|
"Regexp to match the beginning of a defun, in the general sense.")
|
|
|
|
(defconst ruby-singleton-class-re
|
|
"class\\s *<<"
|
|
"Regexp to match the beginning of a singleton class context.")
|
|
|
|
(eval-and-compile
|
|
(defconst ruby-here-doc-beg-re
|
|
"\\(<\\)<\\(-\\)?\\(\\([a-zA-Z0-9_]+\\)\\|[\"]\\([^\"]+\\)[\"]\\|[']\\([^']+\\)[']\\)"
|
|
"Regexp to match the beginning of a heredoc.")
|
|
|
|
(defconst ruby-expression-expansion-re
|
|
"\\(?:[^\\]\\|\\=\\)\\(\\\\\\\\\\)*\\(#\\({[^}\n\\\\]*\\(\\\\.[^}\n\\\\]*\\)*}\\|\\(\\$\\|@\\|@@\\)\\(\\w\\|_\\)+\\)\\)"))
|
|
|
|
(defun ruby-here-doc-end-match ()
|
|
"Return a regexp to find the end of a heredoc.
|
|
|
|
This should only be called after matching against `ruby-here-doc-beg-re'."
|
|
(concat "^"
|
|
(if (match-string 2) "[ \t]*" nil)
|
|
(regexp-quote
|
|
(or (match-string 4)
|
|
(match-string 5)
|
|
(match-string 6)))))
|
|
|
|
(defconst ruby-delimiter
|
|
(concat "[?$/%(){}#\"'`.:]\\|<<\\|\\[\\|\\]\\|\\_<\\("
|
|
ruby-block-beg-re
|
|
"\\)\\_>\\|" ruby-block-end-re
|
|
"\\|^=begin\\|" ruby-here-doc-beg-re))
|
|
|
|
(defconst ruby-negative
|
|
(concat "^[ \t]*\\(\\(" ruby-block-mid-re "\\)\\>\\|"
|
|
ruby-block-end-re "\\|}\\|\\]\\)")
|
|
"Regexp to match where the indentation gets shallower.")
|
|
|
|
(defconst ruby-operator-re "[-,.+*/%&|^~=<>:]\\|\\\\$"
|
|
"Regexp to match operators.")
|
|
|
|
(defconst ruby-symbol-chars "a-zA-Z0-9_"
|
|
"List of characters that symbol names may contain.")
|
|
|
|
(defconst ruby-symbol-re (concat "[" ruby-symbol-chars "]")
|
|
"Regexp to match symbols.")
|
|
|
|
(defvar ruby-use-smie t)
|
|
|
|
(defvar ruby-mode-map
|
|
(let ((map (make-sparse-keymap)))
|
|
(unless ruby-use-smie
|
|
(define-key map (kbd "M-C-b") 'ruby-backward-sexp)
|
|
(define-key map (kbd "M-C-f") 'ruby-forward-sexp)
|
|
(define-key map (kbd "M-C-q") 'ruby-indent-exp))
|
|
(when ruby-use-smie
|
|
(define-key map (kbd "M-C-d") 'smie-down-list))
|
|
(define-key map (kbd "M-C-p") 'ruby-beginning-of-block)
|
|
(define-key map (kbd "M-C-n") 'ruby-end-of-block)
|
|
(define-key map (kbd "C-c {") 'ruby-toggle-block)
|
|
map)
|
|
"Keymap used in Ruby mode.")
|
|
|
|
(easy-menu-define
|
|
ruby-mode-menu
|
|
ruby-mode-map
|
|
"Ruby Mode Menu"
|
|
'("Ruby"
|
|
["Beginning of Block" ruby-beginning-of-block t]
|
|
["End of Block" ruby-end-of-block t]
|
|
["Toggle Block" ruby-toggle-block t]
|
|
"--"
|
|
["Backward Sexp" ruby-backward-sexp
|
|
:visible (not ruby-use-smie)]
|
|
["Backward Sexp" backward-sexp
|
|
:visible ruby-use-smie]
|
|
["Forward Sexp" ruby-forward-sexp
|
|
:visible (not ruby-use-smie)]
|
|
["Forward Sexp" forward-sexp
|
|
:visible ruby-use-smie]
|
|
["Indent Sexp" ruby-indent-exp
|
|
:visible (not ruby-use-smie)]
|
|
["Indent Sexp" prog-indent-sexp
|
|
:visible ruby-use-smie]))
|
|
|
|
(defvar ruby-mode-syntax-table
|
|
(let ((table (make-syntax-table)))
|
|
(modify-syntax-entry ?\' "\"" table)
|
|
(modify-syntax-entry ?\" "\"" table)
|
|
(modify-syntax-entry ?\` "\"" table)
|
|
(modify-syntax-entry ?# "<" table)
|
|
(modify-syntax-entry ?\n ">" table)
|
|
(modify-syntax-entry ?\\ "\\" table)
|
|
(modify-syntax-entry ?$ "." table)
|
|
(modify-syntax-entry ?? "_" table)
|
|
(modify-syntax-entry ?_ "_" table)
|
|
(modify-syntax-entry ?: "_" table)
|
|
(modify-syntax-entry ?< "." table)
|
|
(modify-syntax-entry ?> "." table)
|
|
(modify-syntax-entry ?& "." table)
|
|
(modify-syntax-entry ?| "." table)
|
|
(modify-syntax-entry ?% "." table)
|
|
(modify-syntax-entry ?= "." table)
|
|
(modify-syntax-entry ?/ "." table)
|
|
(modify-syntax-entry ?+ "." table)
|
|
(modify-syntax-entry ?* "." table)
|
|
(modify-syntax-entry ?- "." table)
|
|
(modify-syntax-entry ?\; "." table)
|
|
(modify-syntax-entry ?\( "()" table)
|
|
(modify-syntax-entry ?\) ")(" table)
|
|
(modify-syntax-entry ?\{ "(}" table)
|
|
(modify-syntax-entry ?\} "){" table)
|
|
(modify-syntax-entry ?\[ "(]" table)
|
|
(modify-syntax-entry ?\] ")[" table)
|
|
table)
|
|
"Syntax table to use in Ruby mode.")
|
|
|
|
(defcustom ruby-indent-tabs-mode nil
|
|
"Indentation can insert tabs in Ruby mode if this is non-nil."
|
|
:type 'boolean
|
|
:group 'ruby
|
|
:safe 'booleanp)
|
|
|
|
(defcustom ruby-indent-level 2
|
|
"Indentation of Ruby statements."
|
|
:type 'integer
|
|
:group 'ruby
|
|
:safe 'integerp)
|
|
|
|
(defcustom ruby-comment-column (default-value 'comment-column)
|
|
"Indentation column of comments."
|
|
:type 'integer
|
|
:group 'ruby
|
|
:safe 'integerp)
|
|
|
|
(defcustom ruby-deep-arglist t
|
|
"Deep indent lists in parenthesis when non-nil.
|
|
Also ignores spaces after parenthesis when 'space."
|
|
:type 'boolean
|
|
:group 'ruby
|
|
:safe 'booleanp)
|
|
|
|
(defcustom ruby-deep-indent-paren '(?\( ?\[ ?\] t)
|
|
"Deep indent lists in parenthesis when non-nil.
|
|
The value t means continuous line.
|
|
Also ignores spaces after parenthesis when 'space."
|
|
:group 'ruby)
|
|
|
|
(defcustom ruby-deep-indent-paren-style 'space
|
|
"Default deep indent style."
|
|
:options '(t nil space) :group 'ruby)
|
|
|
|
(defcustom ruby-encoding-map
|
|
'((us-ascii . nil) ;; Do not put coding: us-ascii
|
|
(shift-jis . cp932) ;; Emacs charset name of Shift_JIS
|
|
(shift_jis . cp932) ;; MIME charset name of Shift_JIS
|
|
(japanese-cp932 . cp932)) ;; Emacs charset name of CP932
|
|
"Alist to map encoding name from Emacs to Ruby.
|
|
Associating an encoding name with nil means it needs not be
|
|
explicitly declared in magic comment."
|
|
:type '(repeat (cons (symbol :tag "From") (symbol :tag "To")))
|
|
:group 'ruby)
|
|
|
|
(defcustom ruby-insert-encoding-magic-comment t
|
|
"Insert a magic Ruby encoding comment upon save if this is non-nil.
|
|
The encoding will be auto-detected. The format of the encoding comment
|
|
is customizable via `ruby-encoding-magic-comment-style'.
|
|
|
|
When set to `always-utf8' an utf-8 comment will always be added,
|
|
even if it's not required."
|
|
:type 'boolean :group 'ruby)
|
|
|
|
(defcustom ruby-encoding-magic-comment-style 'ruby
|
|
"The style of the magic encoding comment to use."
|
|
:type '(choice
|
|
(const :tag "Emacs Style" emacs)
|
|
(const :tag "Ruby Style" ruby)
|
|
(const :tag "Custom Style" custom))
|
|
:group 'ruby)
|
|
|
|
(defcustom ruby-custom-encoding-magic-comment-template "# coding: %s"
|
|
"The encoding comment template to be used when
|
|
`ruby-encoding-magic-comment-style' is set to `custom'."
|
|
:type 'string
|
|
:group 'ruby)
|
|
|
|
(defcustom ruby-use-encoding-map t
|
|
"Use `ruby-encoding-map' to set encoding magic comment if this is non-nil."
|
|
:type 'boolean :group 'ruby)
|
|
|
|
;;; SMIE support
|
|
|
|
(require 'smie)
|
|
|
|
;; Here's a simplified BNF grammar, for reference:
|
|
;; http://www.cse.buffalo.edu/~regan/cse305/RubyBNF.pdf
|
|
(defconst ruby-smie-grammar
|
|
(smie-prec2->grammar
|
|
(smie-merge-prec2s
|
|
(smie-bnf->prec2
|
|
'((id)
|
|
(insts (inst) (insts ";" insts))
|
|
(inst (exp) (inst "iuwu-mod" exp)
|
|
;; Somewhat incorrect (both can be used multiple times),
|
|
;; but avoids lots of conflicts:
|
|
(exp "and" exp) (exp "or" exp))
|
|
(exp (exp1) (exp "," exp) (exp "=" exp)
|
|
(id " @ " exp)
|
|
(exp "." id))
|
|
(exp1 (exp2) (exp2 "?" exp1 ":" exp1))
|
|
(exp2 ("def" insts "end")
|
|
("begin" insts-rescue-insts "end")
|
|
("do" insts "end")
|
|
("class" insts "end") ("module" insts "end")
|
|
("for" for-body "end")
|
|
("[" expseq "]")
|
|
("{" hashvals "}")
|
|
("{" insts "}")
|
|
("while" insts "end")
|
|
("until" insts "end")
|
|
("unless" insts "end")
|
|
("if" if-body "end")
|
|
("case" cases "end"))
|
|
(formal-params ("opening-|" exp "closing-|"))
|
|
(for-body (for-head ";" insts))
|
|
(for-head (id "in" exp))
|
|
(cases (exp "then" insts)
|
|
(cases "when" cases) (insts "else" insts))
|
|
(expseq (exp) );;(expseq "," expseq)
|
|
(hashvals (id "=>" exp1) (hashvals "," hashvals))
|
|
(insts-rescue-insts (insts)
|
|
(insts-rescue-insts "rescue" insts-rescue-insts)
|
|
(insts-rescue-insts "ensure" insts-rescue-insts))
|
|
(itheni (insts) (exp "then" insts))
|
|
(ielsei (itheni) (itheni "else" insts))
|
|
(if-body (ielsei) (if-body "elsif" if-body)))
|
|
'((nonassoc "in") (assoc ";") (right " @ ")
|
|
(assoc ",") (right "=") (assoc "."))
|
|
'((assoc "when"))
|
|
'((assoc "elsif"))
|
|
'((assoc "rescue" "ensure"))
|
|
'((assoc ",")))
|
|
|
|
(smie-precs->prec2
|
|
'((right "=")
|
|
(right "+=" "-=" "*=" "/=" "%=" "**=" "&=" "|=" "^="
|
|
"<<=" ">>=" "&&=" "||=")
|
|
(left ".." "...")
|
|
(left "+" "-")
|
|
(left "*" "/" "%" "**")
|
|
(left "&&" "||")
|
|
(left "^" "&" "|")
|
|
(nonassoc "<=>")
|
|
(nonassoc ">" ">=" "<" "<=")
|
|
(nonassoc "==" "===" "!=")
|
|
(nonassoc "=~" "!~")
|
|
(left "<<" ">>"))))))
|
|
|
|
(defun ruby-smie--bosp ()
|
|
(save-excursion (skip-chars-backward " \t")
|
|
(or (bolp) (memq (char-before) '(?\; ?=)))))
|
|
|
|
(defun ruby-smie--implicit-semi-p ()
|
|
(save-excursion
|
|
(skip-chars-backward " \t")
|
|
(not (or (bolp)
|
|
(and (memq (char-before)
|
|
'(?\; ?- ?+ ?* ?/ ?: ?. ?, ?\[ ?\( ?\{ ?\\ ?& ?> ?< ?%
|
|
?~ ?^))
|
|
;; Make sure it's not the end of a regexp.
|
|
(not (eq (car (syntax-after (1- (point)))) 7)))
|
|
(and (eq (char-before) ?\?)
|
|
(equal (save-excursion (ruby-smie--backward-token)) "?"))
|
|
(and (eq (char-before) ?=)
|
|
(string-match "\\`\\s." (save-excursion
|
|
(ruby-smie--backward-token))))
|
|
(and (eq (char-before) ?|)
|
|
(member (save-excursion (ruby-smie--backward-token))
|
|
'("|" "||")))
|
|
(and (eq (car (syntax-after (1- (point)))) 2)
|
|
(member (save-excursion (ruby-smie--backward-token))
|
|
'("iuwu-mod" "and" "or")))
|
|
(save-excursion
|
|
(forward-comment 1)
|
|
(eq (char-after) ?.))))))
|
|
|
|
(defun ruby-smie--redundant-do-p (&optional skip)
|
|
(save-excursion
|
|
(if skip (backward-word 1))
|
|
(member (nth 2 (smie-backward-sexp ";")) '("while" "until" "for"))))
|
|
|
|
(defun ruby-smie--opening-pipe-p ()
|
|
(save-excursion
|
|
(if (eq ?| (char-before)) (forward-char -1))
|
|
(skip-chars-backward " \t\n")
|
|
(or (eq ?\{ (char-before))
|
|
(looking-back "\\_<do" (- (point) 2)))))
|
|
|
|
(defun ruby-smie--closing-pipe-p ()
|
|
(save-excursion
|
|
(if (eq ?| (char-before)) (forward-char -1))
|
|
(and (re-search-backward "|" (line-beginning-position) t)
|
|
(ruby-smie--opening-pipe-p))))
|
|
|
|
(defun ruby-smie--args-separator-p (pos)
|
|
(and
|
|
(< pos (line-end-position))
|
|
(or (eq (char-syntax (preceding-char)) '?w)
|
|
;; FIXME: Check that the preceding token is not a keyword.
|
|
;; This isn't very important most of the time, though.
|
|
(and (memq (preceding-char) '(?! ??))
|
|
(eq (char-syntax (char-before (1- (point)))) '?w)))
|
|
(save-excursion
|
|
(goto-char pos)
|
|
(or (and (eq (char-syntax (char-after)) ?w)
|
|
(not (looking-at (regexp-opt '("unless" "if" "while" "until" "or"
|
|
"else" "elsif" "do" "end" "and")
|
|
'symbols))))
|
|
(memq (syntax-after pos) '(7 15))
|
|
(looking-at "[([]\\|[-+!~:]\\sw")))))
|
|
|
|
(defun ruby-smie--at-dot-call ()
|
|
(and (eq ?w (char-syntax (following-char)))
|
|
(eq (char-before) ?.)
|
|
(not (eq (char-before (1- (point))) ?.))))
|
|
|
|
(defun ruby-smie--forward-token ()
|
|
(let ((pos (point)))
|
|
(skip-chars-forward " \t")
|
|
(cond
|
|
((looking-at "\\s\"") ;A heredoc or a string.
|
|
(if (not (looking-at "\n"))
|
|
""
|
|
;; Tokenize the whole heredoc as semicolon.
|
|
(goto-char (scan-sexps (point) 1))
|
|
";"))
|
|
((and (looking-at "[\n#]")
|
|
(ruby-smie--implicit-semi-p)) ;Only add implicit ; when needed.
|
|
(if (eolp) (forward-char 1) (forward-comment 1))
|
|
";")
|
|
(t
|
|
(forward-comment (point-max))
|
|
(cond
|
|
((looking-at ":\\s.+")
|
|
(goto-char (match-end 0)) (match-string 0)) ;; bug#15208.
|
|
((and (< pos (point))
|
|
(save-excursion
|
|
(ruby-smie--args-separator-p (prog1 (point) (goto-char pos)))))
|
|
" @ ")
|
|
(t
|
|
(let ((dot (ruby-smie--at-dot-call))
|
|
(tok (smie-default-forward-token)))
|
|
(when dot
|
|
(setq tok (concat "." tok)))
|
|
(cond
|
|
((member tok '("unless" "if" "while" "until"))
|
|
(if (save-excursion (forward-word -1) (ruby-smie--bosp))
|
|
tok "iuwu-mod"))
|
|
((string-match-p "\\`|[*&]?\\'" tok)
|
|
(forward-char (- 1 (length tok)))
|
|
(setq tok "|")
|
|
(cond
|
|
((ruby-smie--opening-pipe-p) "opening-|")
|
|
((ruby-smie--closing-pipe-p) "closing-|")
|
|
(t tok)))
|
|
((and (equal tok "") (looking-at "\\\\\n"))
|
|
(goto-char (match-end 0)) (ruby-smie--forward-token))
|
|
((equal tok "do")
|
|
(cond
|
|
((not (ruby-smie--redundant-do-p 'skip)) tok)
|
|
((> (save-excursion (forward-comment (point-max)) (point))
|
|
(line-end-position))
|
|
(ruby-smie--forward-token)) ;Fully redundant.
|
|
(t ";")))
|
|
(t tok)))))))))
|
|
|
|
(defun ruby-smie--backward-token ()
|
|
(let ((pos (point)))
|
|
(forward-comment (- (point)))
|
|
(cond
|
|
((and (> pos (line-end-position)) (ruby-smie--implicit-semi-p))
|
|
(skip-chars-forward " \t") ";")
|
|
((and (bolp) (not (bobp))) ;Presumably a heredoc.
|
|
;; Tokenize the whole heredoc as semicolon.
|
|
(goto-char (scan-sexps (point) -1))
|
|
";")
|
|
((and (> pos (point)) (not (bolp))
|
|
(ruby-smie--args-separator-p pos))
|
|
;; We have "ID SPC ID", which is a method call, but it binds less tightly
|
|
;; than commas, since a method call can also be "ID ARG1, ARG2, ARG3".
|
|
;; In some textbooks, "e1 @ e2" is used to mean "call e1 with arg e2".
|
|
" @ ")
|
|
(t
|
|
(let ((tok (smie-default-backward-token))
|
|
(dot (ruby-smie--at-dot-call)))
|
|
(when dot
|
|
(setq tok (concat "." tok)))
|
|
(when (and (eq ?: (char-before)) (string-match "\\`\\s." tok))
|
|
(forward-char -1) (setq tok (concat ":" tok))) ;; bug#15208.
|
|
(cond
|
|
((member tok '("unless" "if" "while" "until"))
|
|
(if (ruby-smie--bosp)
|
|
tok "iuwu-mod"))
|
|
((equal tok "|")
|
|
(cond
|
|
((ruby-smie--opening-pipe-p) "opening-|")
|
|
((ruby-smie--closing-pipe-p) "closing-|")
|
|
(t tok)))
|
|
((string-match-p "\\`|[*&]\\'" tok)
|
|
(forward-char 1)
|
|
(substring tok 1))
|
|
((and (equal tok "") (eq ?\\ (char-before)) (looking-at "\n"))
|
|
(forward-char -1) (ruby-smie--backward-token))
|
|
((equal tok "do")
|
|
(cond
|
|
((not (ruby-smie--redundant-do-p)) tok)
|
|
((> (save-excursion (forward-word 1)
|
|
(forward-comment (point-max)) (point))
|
|
(line-end-position))
|
|
(ruby-smie--backward-token)) ;Fully redundant.
|
|
(t ";")))
|
|
(t tok)))))))
|
|
|
|
(defun ruby-smie--indent-to-stmt ()
|
|
(save-excursion
|
|
(smie-backward-sexp ";")
|
|
(cons 'column (smie-indent-virtual))))
|
|
|
|
(defun ruby-smie-rules (kind token)
|
|
(pcase (cons kind token)
|
|
(`(:elem . basic) ruby-indent-level)
|
|
;; "foo" "bar" is the concatenation of the two strings, so the second
|
|
;; should be aligned with the first.
|
|
(`(:elem . args) (if (looking-at "\\s\"") 0))
|
|
;; (`(:after . ",") (smie-rule-separator kind))
|
|
(`(:before . ";")
|
|
(cond
|
|
((smie-rule-parent-p "def" "begin" "do" "class" "module" "for"
|
|
"while" "until" "unless"
|
|
"if" "then" "elsif" "else" "when"
|
|
"rescue" "ensure" "{")
|
|
(smie-rule-parent ruby-indent-level))
|
|
;; For (invalid) code between switch and case.
|
|
;; (if (smie-parent-p "switch") 4)
|
|
))
|
|
(`(:before . ,(or `"(" `"[" `"{"))
|
|
(cond
|
|
((and (equal token "{")
|
|
(not (smie-rule-prev-p "(" "{" "[" "," "=>" "=" "return" ";"))
|
|
(save-excursion
|
|
(forward-comment -1)
|
|
(not (eq (preceding-char) ?:))))
|
|
;; Curly block opener.
|
|
(ruby-smie--indent-to-stmt))
|
|
((smie-rule-hanging-p)
|
|
;; Treat purely syntactic block-constructs as being part of their parent,
|
|
;; when the opening statement is hanging.
|
|
(let ((state (smie-backward-sexp 'halfsexp)))
|
|
(when (eq t (car state)) (goto-char (cadr state))))
|
|
(cons 'column (smie-indent-virtual)))))
|
|
(`(:after . " @ ") (smie-rule-parent))
|
|
(`(:before . "do") (ruby-smie--indent-to-stmt))
|
|
(`(,(or :before :after) . ".")
|
|
(unless (smie-rule-parent-p ".")
|
|
(smie-rule-parent ruby-indent-level)))
|
|
(`(:before . ,(or `"else" `"then" `"elsif" `"rescue" `"ensure")) 0)
|
|
(`(:before . ,(or `"when"))
|
|
(if (not (smie-rule-sibling-p)) 0)) ;; ruby-indent-level
|
|
(`(:after . ,(or "=" "iuwu-mod" "+" "-" "*" "/" "&&" "||" "%" "**" "^" "&"
|
|
"<=>" ">" "<" ">=" "<=" "==" "===" "!=" "<<" ">>"
|
|
"+=" "-=" "*=" "/=" "%=" "**=" "&=" "|=" "^=" "|"
|
|
"<<=" ">>=" "&&=" "||=" "and" "or"))
|
|
(if (smie-rule-parent-p ";" nil) ruby-indent-level))
|
|
(`(:before . "begin")
|
|
(unless (save-excursion (skip-chars-backward " \t") (bolp))
|
|
(smie-rule-parent)))
|
|
))
|
|
|
|
(defun ruby-imenu-create-index-in-block (prefix beg end)
|
|
"Create an imenu index of methods inside a block."
|
|
(let ((index-alist '()) (case-fold-search nil)
|
|
name next pos decl sing)
|
|
(goto-char beg)
|
|
(while (re-search-forward "^\\s *\\(\\(class\\s +\\|\\(class\\s *<<\\s *\\)\\|module\\s +\\)\\([^\(<\n ]+\\)\\|\\(def\\|alias\\)\\s +\\([^\(\n ]+\\)\\)" end t)
|
|
(setq sing (match-beginning 3))
|
|
(setq decl (match-string 5))
|
|
(setq next (match-end 0))
|
|
(setq name (or (match-string 4) (match-string 6)))
|
|
(setq pos (match-beginning 0))
|
|
(cond
|
|
((string= "alias" decl)
|
|
(if prefix (setq name (concat prefix name)))
|
|
(push (cons name pos) index-alist))
|
|
((string= "def" decl)
|
|
(if prefix
|
|
(setq name
|
|
(cond
|
|
((string-match "^self\." name)
|
|
(concat (substring prefix 0 -1) (substring name 4)))
|
|
(t (concat prefix name)))))
|
|
(push (cons name pos) index-alist)
|
|
(ruby-accurate-end-of-block end))
|
|
(t
|
|
(if (string= "self" name)
|
|
(if prefix (setq name (substring prefix 0 -1)))
|
|
(if prefix (setq name (concat (substring prefix 0 -1) "::" name)))
|
|
(push (cons name pos) index-alist))
|
|
(ruby-accurate-end-of-block end)
|
|
(setq beg (point))
|
|
(setq index-alist
|
|
(nconc (ruby-imenu-create-index-in-block
|
|
(concat name (if sing "." "#"))
|
|
next beg) index-alist))
|
|
(goto-char beg))))
|
|
index-alist))
|
|
|
|
(defun ruby-imenu-create-index ()
|
|
"Create an imenu index of all methods in the buffer."
|
|
(nreverse (ruby-imenu-create-index-in-block nil (point-min) nil)))
|
|
|
|
(defun ruby-accurate-end-of-block (&optional end)
|
|
"TODO: document."
|
|
(let (state
|
|
(end (or end (point-max))))
|
|
(while (and (setq state (apply 'ruby-parse-partial end state))
|
|
(>= (nth 2 state) 0) (< (point) end)))))
|
|
|
|
(defun ruby-mode-variables ()
|
|
"Set up initial buffer-local variables for Ruby mode."
|
|
(setq indent-tabs-mode ruby-indent-tabs-mode)
|
|
(if ruby-use-smie
|
|
(smie-setup ruby-smie-grammar #'ruby-smie-rules
|
|
:forward-token #'ruby-smie--forward-token
|
|
:backward-token #'ruby-smie--backward-token)
|
|
(setq-local indent-line-function 'ruby-indent-line))
|
|
(setq-local require-final-newline t)
|
|
(setq-local comment-start "# ")
|
|
(setq-local comment-end "")
|
|
(setq-local comment-column ruby-comment-column)
|
|
(setq-local comment-start-skip "#+ *")
|
|
(setq-local parse-sexp-ignore-comments t)
|
|
(setq-local parse-sexp-lookup-properties t)
|
|
(setq-local paragraph-start (concat "$\\|" page-delimiter))
|
|
(setq-local paragraph-separate paragraph-start)
|
|
(setq-local paragraph-ignore-fill-prefix t))
|
|
|
|
(defun ruby--insert-coding-comment (encoding)
|
|
"Insert a magic coding comment for ENCODING.
|
|
The style of the comment is controlled by `ruby-encoding-magic-comment-style'."
|
|
(let ((encoding-magic-comment-template
|
|
(pcase ruby-encoding-magic-comment-style
|
|
(`ruby "# coding: %s")
|
|
(`emacs "# -*- coding: %s -*-")
|
|
(`custom
|
|
ruby-custom-encoding-magic-comment-template))))
|
|
(insert
|
|
(format encoding-magic-comment-template encoding)
|
|
"\n")))
|
|
|
|
(defun ruby--detect-encoding ()
|
|
(if (eq ruby-insert-encoding-magic-comment 'always-utf8)
|
|
"utf-8"
|
|
(let ((coding-system
|
|
(or save-buffer-coding-system
|
|
buffer-file-coding-system)))
|
|
(if coding-system
|
|
(setq coding-system
|
|
(or (coding-system-get coding-system 'mime-charset)
|
|
(coding-system-change-eol-conversion coding-system nil))))
|
|
(if coding-system
|
|
(symbol-name
|
|
(if ruby-use-encoding-map
|
|
(let ((elt (assq coding-system ruby-encoding-map)))
|
|
(if elt (cdr elt) coding-system))
|
|
coding-system))
|
|
"ascii-8bit"))))
|
|
|
|
(defun ruby--encoding-comment-required-p ()
|
|
(or (eq ruby-insert-encoding-magic-comment 'always-utf8)
|
|
(re-search-forward "[^\0-\177]" nil t)))
|
|
|
|
(defun ruby-mode-set-encoding ()
|
|
"Insert a magic comment header with the proper encoding if necessary."
|
|
(save-excursion
|
|
(widen)
|
|
(goto-char (point-min))
|
|
(when (ruby--encoding-comment-required-p)
|
|
(goto-char (point-min))
|
|
(let ((coding-system (ruby--detect-encoding)))
|
|
(when coding-system
|
|
(if (looking-at "^#!") (beginning-of-line 2))
|
|
(cond ((looking-at "\\s *#\\s *.*\\(en\\)?coding\\s *:\\s *\\([-a-z0-9_]*\\)")
|
|
;; update existing encoding comment if necessary
|
|
(unless (string= (match-string 2) coding-system)
|
|
(goto-char (match-beginning 2))
|
|
(delete-region (point) (match-end 2))
|
|
(insert coding-system)))
|
|
((looking-at "\\s *#.*coding\\s *[:=]"))
|
|
(t (when ruby-insert-encoding-magic-comment
|
|
(ruby--insert-coding-comment coding-system))))
|
|
(when (buffer-modified-p)
|
|
(basic-save-buffer-1)))))))
|
|
|
|
(defun ruby-current-indentation ()
|
|
"Return the indentation level of current line."
|
|
(save-excursion
|
|
(beginning-of-line)
|
|
(back-to-indentation)
|
|
(current-column)))
|
|
|
|
(defun ruby-indent-line (&optional ignored)
|
|
"Correct the indentation of the current Ruby line."
|
|
(interactive)
|
|
(ruby-indent-to (ruby-calculate-indent)))
|
|
|
|
(defun ruby-indent-to (column)
|
|
"Indent the current line to COLUMN."
|
|
(when column
|
|
(let (shift top beg)
|
|
(and (< column 0) (error "Invalid nesting"))
|
|
(setq shift (current-column))
|
|
(beginning-of-line)
|
|
(setq beg (point))
|
|
(back-to-indentation)
|
|
(setq top (current-column))
|
|
(skip-chars-backward " \t")
|
|
(if (>= shift top) (setq shift (- shift top))
|
|
(setq shift 0))
|
|
(if (and (bolp)
|
|
(= column top))
|
|
(move-to-column (+ column shift))
|
|
(move-to-column top)
|
|
(delete-region beg (point))
|
|
(beginning-of-line)
|
|
(indent-to column)
|
|
(move-to-column (+ column shift))))))
|
|
|
|
(defun ruby-special-char-p (&optional pos)
|
|
"Return t if the character before POS is a special character.
|
|
If omitted, POS defaults to the current point.
|
|
Special characters are `?', `$', `:' when preceded by whitespace,
|
|
and `\\' when preceded by `?'."
|
|
(setq pos (or pos (point)))
|
|
(let ((c (char-before pos)) (b (and (< (point-min) pos)
|
|
(char-before (1- pos)))))
|
|
(cond ((or (eq c ??) (eq c ?$)))
|
|
((and (eq c ?:) (or (not b) (eq (char-syntax b) ? ))))
|
|
((eq c ?\\) (eq b ??)))))
|
|
|
|
(defun ruby-singleton-class-p (&optional pos)
|
|
(save-excursion
|
|
(when pos (goto-char pos))
|
|
(forward-word -1)
|
|
(and (or (bolp) (not (eq (char-before (point)) ?_)))
|
|
(looking-at ruby-singleton-class-re))))
|
|
|
|
(defun ruby-expr-beg (&optional option)
|
|
"Check if point is possibly at the beginning of an expression.
|
|
OPTION specifies the type of the expression.
|
|
Can be one of `heredoc', `modifier', `expr-qstr', `expr-re'."
|
|
(save-excursion
|
|
(store-match-data nil)
|
|
(let ((space (skip-chars-backward " \t"))
|
|
(start (point)))
|
|
(cond
|
|
((bolp) t)
|
|
((progn
|
|
(forward-char -1)
|
|
(and (looking-at "\\?")
|
|
(or (eq (char-syntax (char-before (point))) ?w)
|
|
(ruby-special-char-p))))
|
|
nil)
|
|
((looking-at ruby-operator-re))
|
|
((eq option 'heredoc)
|
|
(and (< space 0) (not (ruby-singleton-class-p start))))
|
|
((or (looking-at "[\\[({,;]")
|
|
(and (looking-at "[!?]")
|
|
(or (not (eq option 'modifier))
|
|
(bolp)
|
|
(save-excursion (forward-char -1) (looking-at "\\Sw$"))))
|
|
(and (looking-at ruby-symbol-re)
|
|
(skip-chars-backward ruby-symbol-chars)
|
|
(cond
|
|
((looking-at (regexp-opt
|
|
(append ruby-block-beg-keywords
|
|
ruby-block-op-keywords
|
|
ruby-block-mid-keywords)
|
|
'words))
|
|
(goto-char (match-end 0))
|
|
(not (looking-at "\\s_\\|!")))
|
|
((eq option 'expr-qstr)
|
|
(looking-at "[a-zA-Z][a-zA-z0-9_]* +%[^ \t]"))
|
|
((eq option 'expr-re)
|
|
(looking-at "[a-zA-Z][a-zA-z0-9_]* +/[^ \t]"))
|
|
(t nil)))))))))
|
|
|
|
(defun ruby-forward-string (term &optional end no-error expand)
|
|
"TODO: document."
|
|
(let ((n 1) (c (string-to-char term))
|
|
(re (if expand
|
|
(concat "[^\\]\\(\\\\\\\\\\)*\\([" term "]\\|\\(#{\\)\\)")
|
|
(concat "[^\\]\\(\\\\\\\\\\)*[" term "]"))))
|
|
(while (and (re-search-forward re end no-error)
|
|
(if (match-beginning 3)
|
|
(ruby-forward-string "}{" end no-error nil)
|
|
(> (setq n (if (eq (char-before (point)) c)
|
|
(1- n) (1+ n))) 0)))
|
|
(forward-char -1))
|
|
(cond ((zerop n))
|
|
(no-error nil)
|
|
((error "Unterminated string")))))
|
|
|
|
(defun ruby-deep-indent-paren-p (c)
|
|
"TODO: document."
|
|
(cond ((listp ruby-deep-indent-paren)
|
|
(let ((deep (assoc c ruby-deep-indent-paren)))
|
|
(cond (deep
|
|
(or (cdr deep) ruby-deep-indent-paren-style))
|
|
((memq c ruby-deep-indent-paren)
|
|
ruby-deep-indent-paren-style))))
|
|
((eq c ruby-deep-indent-paren) ruby-deep-indent-paren-style)
|
|
((eq c ?\( ) ruby-deep-arglist)))
|
|
|
|
(defun ruby-parse-partial (&optional end in-string nest depth pcol indent)
|
|
"TODO: document throughout function body."
|
|
(or depth (setq depth 0))
|
|
(or indent (setq indent 0))
|
|
(when (re-search-forward ruby-delimiter end 'move)
|
|
(let ((pnt (point)) w re expand)
|
|
(goto-char (match-beginning 0))
|
|
(cond
|
|
((and (memq (char-before) '(?@ ?$)) (looking-at "\\sw"))
|
|
(goto-char pnt))
|
|
((looking-at "[\"`]") ;skip string
|
|
(cond
|
|
((and (not (eobp))
|
|
(ruby-forward-string (buffer-substring (point) (1+ (point)))
|
|
end t t))
|
|
nil)
|
|
(t
|
|
(setq in-string (point))
|
|
(goto-char end))))
|
|
((looking-at "'")
|
|
(cond
|
|
((and (not (eobp))
|
|
(re-search-forward "[^\\]\\(\\\\\\\\\\)*'" end t))
|
|
nil)
|
|
(t
|
|
(setq in-string (point))
|
|
(goto-char end))))
|
|
((looking-at "/=")
|
|
(goto-char pnt))
|
|
((looking-at "/")
|
|
(cond
|
|
((and (not (eobp)) (ruby-expr-beg 'expr-re))
|
|
(if (ruby-forward-string "/" end t t)
|
|
nil
|
|
(setq in-string (point))
|
|
(goto-char end)))
|
|
(t
|
|
(goto-char pnt))))
|
|
((looking-at "%")
|
|
(cond
|
|
((and (not (eobp))
|
|
(ruby-expr-beg 'expr-qstr)
|
|
(not (looking-at "%="))
|
|
(looking-at "%[QqrxWw]?\\([^a-zA-Z0-9 \t\n]\\)"))
|
|
(goto-char (match-beginning 1))
|
|
(setq expand (not (memq (char-before) '(?q ?w))))
|
|
(setq w (match-string 1))
|
|
(cond
|
|
((string= w "[") (setq re "]["))
|
|
((string= w "{") (setq re "}{"))
|
|
((string= w "(") (setq re ")("))
|
|
((string= w "<") (setq re "><"))
|
|
((and expand (string= w "\\"))
|
|
(setq w (concat "\\" w))))
|
|
(unless (cond (re (ruby-forward-string re end t expand))
|
|
(expand (ruby-forward-string w end t t))
|
|
(t (re-search-forward
|
|
(if (string= w "\\")
|
|
"\\\\[^\\]*\\\\"
|
|
(concat "[^\\]\\(\\\\\\\\\\)*" w))
|
|
end t)))
|
|
(setq in-string (point))
|
|
(goto-char end)))
|
|
(t
|
|
(goto-char pnt))))
|
|
((looking-at "\\?") ;skip ?char
|
|
(cond
|
|
((and (ruby-expr-beg)
|
|
(looking-at "?\\(\\\\C-\\|\\\\M-\\)*\\\\?."))
|
|
(goto-char (match-end 0)))
|
|
(t
|
|
(goto-char pnt))))
|
|
((looking-at "\\$") ;skip $char
|
|
(goto-char pnt)
|
|
(forward-char 1))
|
|
((looking-at "#") ;skip comment
|
|
(forward-line 1)
|
|
(goto-char (point))
|
|
)
|
|
((looking-at "[\\[{(]")
|
|
(let ((deep (ruby-deep-indent-paren-p (char-after))))
|
|
(if (and deep (or (not (eq (char-after) ?\{)) (ruby-expr-beg)))
|
|
(progn
|
|
(and (eq deep 'space) (looking-at ".\\s +[^# \t\n]")
|
|
(setq pnt (1- (match-end 0))))
|
|
(setq nest (cons (cons (char-after (point)) pnt) nest))
|
|
(setq pcol (cons (cons pnt depth) pcol))
|
|
(setq depth 0))
|
|
(setq nest (cons (cons (char-after (point)) pnt) nest))
|
|
(setq depth (1+ depth))))
|
|
(goto-char pnt)
|
|
)
|
|
((looking-at "[])}]")
|
|
(if (ruby-deep-indent-paren-p (matching-paren (char-after)))
|
|
(setq depth (cdr (car pcol)) pcol (cdr pcol))
|
|
(setq depth (1- depth)))
|
|
(setq nest (cdr nest))
|
|
(goto-char pnt))
|
|
((looking-at ruby-block-end-re)
|
|
(if (or (and (not (bolp))
|
|
(progn
|
|
(forward-char -1)
|
|
(setq w (char-after (point)))
|
|
(or (eq ?_ w)
|
|
(eq ?. w))))
|
|
(progn
|
|
(goto-char pnt)
|
|
(setq w (char-after (point)))
|
|
(or (eq ?_ w)
|
|
(eq ?! w)
|
|
(eq ?? w))))
|
|
nil
|
|
(setq nest (cdr nest))
|
|
(setq depth (1- depth)))
|
|
(goto-char pnt))
|
|
((looking-at "def\\s +[^(\n;]*")
|
|
(if (or (bolp)
|
|
(progn
|
|
(forward-char -1)
|
|
(not (eq ?_ (char-after (point))))))
|
|
(progn
|
|
(setq nest (cons (cons nil pnt) nest))
|
|
(setq depth (1+ depth))))
|
|
(goto-char (match-end 0)))
|
|
((looking-at (concat "\\_<\\(" ruby-block-beg-re "\\)\\_>"))
|
|
(and
|
|
(save-match-data
|
|
(or (not (looking-at "do\\_>"))
|
|
(save-excursion
|
|
(back-to-indentation)
|
|
(not (looking-at ruby-non-block-do-re)))))
|
|
(or (bolp)
|
|
(progn
|
|
(forward-char -1)
|
|
(setq w (char-after (point)))
|
|
(not (or (eq ?_ w)
|
|
(eq ?. w)))))
|
|
(goto-char pnt)
|
|
(not (eq ?! (char-after (point))))
|
|
(skip-chars-forward " \t")
|
|
(goto-char (match-beginning 0))
|
|
(or (not (looking-at ruby-modifier-re))
|
|
(ruby-expr-beg 'modifier))
|
|
(goto-char pnt)
|
|
(setq nest (cons (cons nil pnt) nest))
|
|
(setq depth (1+ depth)))
|
|
(goto-char pnt))
|
|
((looking-at ":\\(['\"]\\)")
|
|
(goto-char (match-beginning 1))
|
|
(ruby-forward-string (match-string 1) end t))
|
|
((looking-at ":\\([-,.+*/%&|^~<>]=?\\|===?\\|<=>\\|![~=]?\\)")
|
|
(goto-char (match-end 0)))
|
|
((looking-at ":\\([a-zA-Z_][a-zA-Z_0-9]*[!?=]?\\)?")
|
|
(goto-char (match-end 0)))
|
|
((or (looking-at "\\.\\.\\.?")
|
|
(looking-at "\\.[0-9]+")
|
|
(looking-at "\\.[a-zA-Z_0-9]+")
|
|
(looking-at "\\."))
|
|
(goto-char (match-end 0)))
|
|
((looking-at "^=begin")
|
|
(if (re-search-forward "^=end" end t)
|
|
(forward-line 1)
|
|
(setq in-string (match-end 0))
|
|
(goto-char end)))
|
|
((looking-at "<<")
|
|
(cond
|
|
((and (ruby-expr-beg 'heredoc)
|
|
(looking-at "<<\\(-\\)?\\(\\([\"'`]\\)\\([^\n]+?\\)\\3\\|\\(?:\\sw\\|\\s_\\)+\\)"))
|
|
(setq re (regexp-quote (or (match-string 4) (match-string 2))))
|
|
(if (match-beginning 1) (setq re (concat "\\s *" re)))
|
|
(let* ((id-end (goto-char (match-end 0)))
|
|
(line-end-position (point-at-eol))
|
|
(state (list in-string nest depth pcol indent)))
|
|
;; parse the rest of the line
|
|
(while (and (> line-end-position (point))
|
|
(setq state (apply 'ruby-parse-partial
|
|
line-end-position state))))
|
|
(setq in-string (car state)
|
|
nest (nth 1 state)
|
|
depth (nth 2 state)
|
|
pcol (nth 3 state)
|
|
indent (nth 4 state))
|
|
;; skip heredoc section
|
|
(if (re-search-forward (concat "^" re "$") end 'move)
|
|
(forward-line 1)
|
|
(setq in-string id-end)
|
|
(goto-char end))))
|
|
(t
|
|
(goto-char pnt))))
|
|
((looking-at "^__END__$")
|
|
(goto-char pnt))
|
|
((and (looking-at ruby-here-doc-beg-re)
|
|
(boundp 'ruby-indent-point))
|
|
(if (re-search-forward (ruby-here-doc-end-match)
|
|
ruby-indent-point t)
|
|
(forward-line 1)
|
|
(setq in-string (match-end 0))
|
|
(goto-char ruby-indent-point)))
|
|
(t
|
|
(error (format "Bad string %s"
|
|
(buffer-substring (point) pnt)
|
|
))))))
|
|
(list in-string nest depth pcol))
|
|
|
|
(defun ruby-parse-region (start end)
|
|
"TODO: document."
|
|
(let (state)
|
|
(save-excursion
|
|
(if start
|
|
(goto-char start)
|
|
(ruby-beginning-of-indent))
|
|
(save-restriction
|
|
(narrow-to-region (point) end)
|
|
(while (and (> end (point))
|
|
(setq state (apply 'ruby-parse-partial end state))))))
|
|
(list (nth 0 state) ; in-string
|
|
(car (nth 1 state)) ; nest
|
|
(nth 2 state) ; depth
|
|
(car (car (nth 3 state))) ; pcol
|
|
;(car (nth 5 state)) ; indent
|
|
)))
|
|
|
|
(defun ruby-indent-size (pos nest)
|
|
"Return the indentation level in spaces NEST levels deeper than POS."
|
|
(+ pos (* (or nest 1) ruby-indent-level)))
|
|
|
|
(defun ruby-calculate-indent (&optional parse-start)
|
|
"Return the proper indentation level of the current line."
|
|
;; TODO: Document body
|
|
(save-excursion
|
|
(beginning-of-line)
|
|
(let ((ruby-indent-point (point))
|
|
(case-fold-search nil)
|
|
state eol begin op-end
|
|
(paren (progn (skip-syntax-forward " ")
|
|
(and (char-after) (matching-paren (char-after)))))
|
|
(indent 0))
|
|
(if parse-start
|
|
(goto-char parse-start)
|
|
(ruby-beginning-of-indent)
|
|
(setq parse-start (point)))
|
|
(back-to-indentation)
|
|
(setq indent (current-column))
|
|
(setq state (ruby-parse-region parse-start ruby-indent-point))
|
|
(cond
|
|
((nth 0 state) ; within string
|
|
(setq indent nil)) ; do nothing
|
|
((car (nth 1 state)) ; in paren
|
|
(goto-char (setq begin (cdr (nth 1 state))))
|
|
(let ((deep (ruby-deep-indent-paren-p (car (nth 1 state)))))
|
|
(if deep
|
|
(cond ((and (eq deep t) (eq (car (nth 1 state)) paren))
|
|
(skip-syntax-backward " ")
|
|
(setq indent (1- (current-column))))
|
|
((let ((s (ruby-parse-region (point) ruby-indent-point)))
|
|
(and (nth 2 s) (> (nth 2 s) 0)
|
|
(or (goto-char (cdr (nth 1 s))) t)))
|
|
(forward-word -1)
|
|
(setq indent (ruby-indent-size (current-column)
|
|
(nth 2 state))))
|
|
(t
|
|
(setq indent (current-column))
|
|
(cond ((eq deep 'space))
|
|
(paren (setq indent (1- indent)))
|
|
(t (setq indent (ruby-indent-size (1- indent) 1))))))
|
|
(if (nth 3 state) (goto-char (nth 3 state))
|
|
(goto-char parse-start) (back-to-indentation))
|
|
(setq indent (ruby-indent-size (current-column) (nth 2 state))))
|
|
(and (eq (car (nth 1 state)) paren)
|
|
(ruby-deep-indent-paren-p (matching-paren paren))
|
|
(search-backward (char-to-string paren))
|
|
(setq indent (current-column)))))
|
|
((and (nth 2 state) (> (nth 2 state) 0)) ; in nest
|
|
(if (null (cdr (nth 1 state)))
|
|
(error "Invalid nesting"))
|
|
(goto-char (cdr (nth 1 state)))
|
|
(forward-word -1) ; skip back a keyword
|
|
(setq begin (point))
|
|
(cond
|
|
((looking-at "do\\>[^_]") ; iter block is a special case
|
|
(if (nth 3 state) (goto-char (nth 3 state))
|
|
(goto-char parse-start) (back-to-indentation))
|
|
(setq indent (ruby-indent-size (current-column) (nth 2 state))))
|
|
(t
|
|
(setq indent (+ (current-column) ruby-indent-level)))))
|
|
|
|
((and (nth 2 state) (< (nth 2 state) 0)) ; in negative nest
|
|
(setq indent (ruby-indent-size (current-column) (nth 2 state)))))
|
|
(when indent
|
|
(goto-char ruby-indent-point)
|
|
(end-of-line)
|
|
(setq eol (point))
|
|
(beginning-of-line)
|
|
(cond
|
|
((and (not (ruby-deep-indent-paren-p paren))
|
|
(re-search-forward ruby-negative eol t))
|
|
(and (not (eq ?_ (char-after (match-end 0))))
|
|
(setq indent (- indent ruby-indent-level))))
|
|
((and
|
|
(save-excursion
|
|
(beginning-of-line)
|
|
(not (bobp)))
|
|
(or (ruby-deep-indent-paren-p t)
|
|
(null (car (nth 1 state)))))
|
|
;; goto beginning of non-empty no-comment line
|
|
(let (end done)
|
|
(while (not done)
|
|
(skip-chars-backward " \t\n")
|
|
(setq end (point))
|
|
(beginning-of-line)
|
|
(if (re-search-forward "^\\s *#" end t)
|
|
(beginning-of-line)
|
|
(setq done t))))
|
|
(end-of-line)
|
|
;; skip the comment at the end
|
|
(skip-chars-backward " \t")
|
|
(let (end (pos (point)))
|
|
(beginning-of-line)
|
|
(while (and (re-search-forward "#" pos t)
|
|
(setq end (1- (point)))
|
|
(or (ruby-special-char-p end)
|
|
(and (setq state (ruby-parse-region
|
|
parse-start end))
|
|
(nth 0 state))))
|
|
(setq end nil))
|
|
(goto-char (or end pos))
|
|
(skip-chars-backward " \t")
|
|
(setq begin (if (and end (nth 0 state)) pos (cdr (nth 1 state))))
|
|
(setq state (ruby-parse-region parse-start (point))))
|
|
(or (bobp) (forward-char -1))
|
|
(and
|
|
(or (and (looking-at ruby-symbol-re)
|
|
(skip-chars-backward ruby-symbol-chars)
|
|
(looking-at (concat "\\<\\(" ruby-block-hanging-re
|
|
"\\)\\>"))
|
|
(not (eq (point) (nth 3 state)))
|
|
(save-excursion
|
|
(goto-char (match-end 0))
|
|
(not (looking-at "[a-z_]"))))
|
|
(and (looking-at ruby-operator-re)
|
|
(not (ruby-special-char-p))
|
|
(save-excursion
|
|
(forward-char -1)
|
|
(or (not (looking-at ruby-operator-re))
|
|
(not (eq (char-before) ?:))))
|
|
;; Operator at the end of line.
|
|
(let ((c (char-after (point))))
|
|
(and
|
|
;; (or (null begin)
|
|
;; (save-excursion
|
|
;; (goto-char begin)
|
|
;; (skip-chars-forward " \t")
|
|
;; (not (or (eolp) (looking-at "#")
|
|
;; (and (eq (car (nth 1 state)) ?{)
|
|
;; (looking-at "|"))))))
|
|
;; Not a regexp or percent literal.
|
|
(null (nth 0 (ruby-parse-region (or begin parse-start)
|
|
(point))))
|
|
(or (not (eq ?| (char-after (point))))
|
|
(save-excursion
|
|
(or (eolp) (forward-char -1))
|
|
(cond
|
|
((search-backward "|" nil t)
|
|
(skip-chars-backward " \t\n")
|
|
(and (not (eolp))
|
|
(progn
|
|
(forward-char -1)
|
|
(not (looking-at "{")))
|
|
(progn
|
|
(forward-word -1)
|
|
(not (looking-at "do\\>[^_]")))))
|
|
(t t))))
|
|
(not (eq ?, c))
|
|
(setq op-end t)))))
|
|
(setq indent
|
|
(cond
|
|
((and
|
|
(null op-end)
|
|
(not (looking-at (concat "\\<\\(" ruby-block-hanging-re
|
|
"\\)\\>")))
|
|
(eq (ruby-deep-indent-paren-p t) 'space)
|
|
(not (bobp)))
|
|
(widen)
|
|
(goto-char (or begin parse-start))
|
|
(skip-syntax-forward " ")
|
|
(current-column))
|
|
((car (nth 1 state)) indent)
|
|
(t
|
|
(+ indent ruby-indent-level))))))))
|
|
(goto-char ruby-indent-point)
|
|
(beginning-of-line)
|
|
(skip-syntax-forward " ")
|
|
(if (looking-at "\\.[^.]")
|
|
(+ indent ruby-indent-level)
|
|
indent))))
|
|
|
|
(defun ruby-beginning-of-defun (&optional arg)
|
|
"Move backward to the beginning of the current defun.
|
|
With ARG, move backward multiple defuns. Negative ARG means
|
|
move forward."
|
|
(interactive "p")
|
|
(let (case-fold-search)
|
|
(and (re-search-backward (concat "^\\s *" ruby-defun-beg-re "\\_>")
|
|
nil t (or arg 1))
|
|
(beginning-of-line))))
|
|
|
|
(defun ruby-end-of-defun ()
|
|
"Move point to the end of the current defun.
|
|
The defun begins at or after the point. This function is called
|
|
by `end-of-defun'."
|
|
(interactive "p")
|
|
(ruby-forward-sexp)
|
|
(let (case-fold-search)
|
|
(when (looking-back (concat "^\\s *" ruby-block-end-re))
|
|
(forward-line 1))))
|
|
|
|
(defun ruby-beginning-of-indent ()
|
|
"Backtrack to a line which can be used as a reference for
|
|
calculating indentation on the lines after it."
|
|
(while (and (re-search-backward ruby-indent-beg-re nil 'move)
|
|
(if (ruby-in-ppss-context-p 'anything)
|
|
t
|
|
;; We can stop, then.
|
|
(beginning-of-line)))))
|
|
|
|
(defun ruby-move-to-block (n)
|
|
"Move to the beginning (N < 0) or the end (N > 0) of the
|
|
current block, a sibling block, or an outer block. Do that (abs N) times."
|
|
(back-to-indentation)
|
|
(let ((signum (if (> n 0) 1 -1))
|
|
(backward (< n 0))
|
|
(depth (or (nth 2 (ruby-parse-region (point) (line-end-position))) 0))
|
|
case-fold-search
|
|
down done)
|
|
(when (looking-at ruby-block-mid-re)
|
|
(setq depth (+ depth signum)))
|
|
(when (< (* depth signum) 0)
|
|
;; Moving end -> end or beginning -> beginning.
|
|
(setq depth 0))
|
|
(dotimes (_ (abs n))
|
|
(setq done nil)
|
|
(setq down (save-excursion
|
|
(back-to-indentation)
|
|
;; There is a block start or block end keyword on this
|
|
;; line, don't need to look for another block.
|
|
(and (re-search-forward
|
|
(if backward ruby-block-end-re
|
|
(concat "\\_<\\(" ruby-block-beg-re "\\)\\_>"))
|
|
(line-end-position) t)
|
|
(not (nth 8 (syntax-ppss))))))
|
|
(while (and (not done) (not (if backward (bobp) (eobp))))
|
|
(forward-line signum)
|
|
(cond
|
|
;; Skip empty and commented out lines.
|
|
((looking-at "^\\s *$"))
|
|
((looking-at "^\\s *#"))
|
|
;; Skip block comments;
|
|
((and (not backward) (looking-at "^=begin\\>"))
|
|
(re-search-forward "^=end\\>"))
|
|
((and backward (looking-at "^=end\\>"))
|
|
(re-search-backward "^=begin\\>"))
|
|
;; Jump over a multiline literal.
|
|
((ruby-in-ppss-context-p 'string)
|
|
(goto-char (nth 8 (syntax-ppss)))
|
|
(unless backward
|
|
(forward-sexp)
|
|
(when (bolp) (forward-char -1)))) ; After a heredoc.
|
|
(t
|
|
(let ((state (ruby-parse-region (point) (line-end-position))))
|
|
(unless (car state) ; Line ends with unfinished string.
|
|
(setq depth (+ (nth 2 state) depth))))
|
|
(cond
|
|
;; Increased depth, we found a block.
|
|
((> (* signum depth) 0)
|
|
(setq down t))
|
|
;; We're at the same depth as when we started, and we've
|
|
;; encountered a block before. Stop.
|
|
((and down (zerop depth))
|
|
(setq done t))
|
|
;; Lower depth, means outer block, can stop now.
|
|
((< (* signum depth) 0)
|
|
(setq done t)))))))
|
|
(back-to-indentation)))
|
|
|
|
(defun ruby-beginning-of-block (&optional arg)
|
|
"Move backward to the beginning of the current block.
|
|
With ARG, move up multiple blocks."
|
|
(interactive "p")
|
|
(ruby-move-to-block (- (or arg 1))))
|
|
|
|
(defun ruby-end-of-block (&optional arg)
|
|
"Move forward to the end of the current block.
|
|
With ARG, move out of multiple blocks."
|
|
(interactive "p")
|
|
(ruby-move-to-block (or arg 1)))
|
|
|
|
(defun ruby-forward-sexp (&optional arg)
|
|
"Move forward across one balanced expression (sexp).
|
|
With ARG, do it many times. Negative ARG means move backward."
|
|
;; TODO: Document body
|
|
(interactive "p")
|
|
(cond
|
|
(ruby-use-smie (forward-sexp arg))
|
|
((and (numberp arg) (< arg 0)) (ruby-backward-sexp (- arg)))
|
|
(t
|
|
(let ((i (or arg 1)))
|
|
(condition-case nil
|
|
(while (> i 0)
|
|
(skip-syntax-forward " ")
|
|
(if (looking-at ",\\s *") (goto-char (match-end 0)))
|
|
(cond ((looking-at "\\?\\(\\\\[CM]-\\)*\\\\?\\S ")
|
|
(goto-char (match-end 0)))
|
|
((progn
|
|
(skip-chars-forward ",.:;|&^~=!?\\+\\-\\*")
|
|
(looking-at "\\s("))
|
|
(goto-char (scan-sexps (point) 1)))
|
|
((and (looking-at (concat "\\<\\(" ruby-block-beg-re
|
|
"\\)\\>"))
|
|
(not (eq (char-before (point)) ?.))
|
|
(not (eq (char-before (point)) ?:)))
|
|
(ruby-end-of-block)
|
|
(forward-word 1))
|
|
((looking-at "\\(\\$\\|@@?\\)?\\sw")
|
|
(while (progn
|
|
(while (progn (forward-word 1) (looking-at "_")))
|
|
(cond ((looking-at "::") (forward-char 2) t)
|
|
((> (skip-chars-forward ".") 0))
|
|
((looking-at "\\?\\|!\\(=[~=>]\\|[^~=]\\)")
|
|
(forward-char 1) nil)))))
|
|
((let (state expr)
|
|
(while
|
|
(progn
|
|
(setq expr (or expr (ruby-expr-beg)
|
|
(looking-at "%\\sw?\\Sw\\|[\"'`/]")))
|
|
(nth 1 (setq state (apply #'ruby-parse-partial
|
|
nil state))))
|
|
(setq expr t)
|
|
(skip-chars-forward "<"))
|
|
(not expr))))
|
|
(setq i (1- i)))
|
|
((error) (forward-word 1)))
|
|
i))))
|
|
|
|
(defun ruby-backward-sexp (&optional arg)
|
|
"Move backward across one balanced expression (sexp).
|
|
With ARG, do it many times. Negative ARG means move forward."
|
|
;; TODO: Document body
|
|
(interactive "p")
|
|
(cond
|
|
(ruby-use-smie (backward-sexp arg))
|
|
((and (numberp arg) (< arg 0)) (ruby-forward-sexp (- arg)))
|
|
(t
|
|
(let ((i (or arg 1)))
|
|
(condition-case nil
|
|
(while (> i 0)
|
|
(skip-chars-backward " \t\n,.:;|&^~=!?\\+\\-\\*")
|
|
(forward-char -1)
|
|
(cond ((looking-at "\\s)")
|
|
(goto-char (scan-sexps (1+ (point)) -1))
|
|
(pcase (char-before)
|
|
(`?% (forward-char -1))
|
|
((or `?q `?Q `?w `?W `?r `?x)
|
|
(if (eq (char-before (1- (point))) ?%)
|
|
(forward-char -2))))
|
|
nil)
|
|
((looking-at "\\s\"\\|\\\\\\S_")
|
|
(let ((c (char-to-string (char-before (match-end 0)))))
|
|
(while (and (search-backward c)
|
|
(eq (logand (skip-chars-backward "\\") 1)
|
|
1))))
|
|
nil)
|
|
((looking-at "\\s.\\|\\s\\")
|
|
(if (ruby-special-char-p) (forward-char -1)))
|
|
((looking-at "\\s(") nil)
|
|
(t
|
|
(forward-char 1)
|
|
(while (progn (forward-word -1)
|
|
(pcase (char-before)
|
|
(`?_ t)
|
|
(`?. (forward-char -1) t)
|
|
((or `?$ `?@)
|
|
(forward-char -1)
|
|
(and (eq (char-before) (char-after))
|
|
(forward-char -1)))
|
|
(`?:
|
|
(forward-char -1)
|
|
(eq (char-before) :)))))
|
|
(if (looking-at ruby-block-end-re)
|
|
(ruby-beginning-of-block))
|
|
nil))
|
|
(setq i (1- i)))
|
|
((error)))
|
|
i))))
|
|
|
|
(defun ruby-indent-exp (&optional ignored)
|
|
"Indent each line in the balanced expression following the point."
|
|
(interactive "*P")
|
|
(let ((here (point-marker)) start top column (nest t))
|
|
(set-marker-insertion-type here t)
|
|
(unwind-protect
|
|
(progn
|
|
(beginning-of-line)
|
|
(setq start (point) top (current-indentation))
|
|
(while (and (not (eobp))
|
|
(progn
|
|
(setq column (ruby-calculate-indent start))
|
|
(cond ((> column top)
|
|
(setq nest t))
|
|
((and (= column top) nest)
|
|
(setq nest nil) t))))
|
|
(ruby-indent-to column)
|
|
(beginning-of-line 2)))
|
|
(goto-char here)
|
|
(set-marker here nil))))
|
|
|
|
(defun ruby-add-log-current-method ()
|
|
"Return the current method name as a string.
|
|
This string includes all namespaces.
|
|
|
|
For example:
|
|
|
|
#exit
|
|
String#gsub
|
|
Net::HTTP#active?
|
|
File.open
|
|
|
|
See `add-log-current-defun-function'."
|
|
(condition-case nil
|
|
(save-excursion
|
|
(let* ((indent 0) mname mlist
|
|
(start (point))
|
|
(make-definition-re
|
|
(lambda (re)
|
|
(concat "^[ \t]*" re "[ \t]+"
|
|
"\\("
|
|
;; \\. and :: for class methods
|
|
"\\([A-Za-z_]" ruby-symbol-re "*\\|\\.\\|::" "\\)"
|
|
"+\\)")))
|
|
(definition-re (funcall make-definition-re ruby-defun-beg-re))
|
|
(module-re (funcall make-definition-re "\\(class\\|module\\)")))
|
|
;; Get the current method definition (or class/module).
|
|
(when (re-search-backward definition-re nil t)
|
|
(goto-char (match-beginning 1))
|
|
(if (not (string-equal "def" (match-string 1)))
|
|
(setq mlist (list (match-string 2)))
|
|
;; We're inside the method. For classes and modules,
|
|
;; this check is skipped for performance.
|
|
(when (ruby-block-contains-point start)
|
|
(setq mname (match-string 2))))
|
|
(setq indent (current-column))
|
|
(beginning-of-line))
|
|
;; Walk up the class/module nesting.
|
|
(while (and (> indent 0)
|
|
(re-search-backward module-re nil t))
|
|
(goto-char (match-beginning 1))
|
|
(when (< (current-column) indent)
|
|
(setq mlist (cons (match-string 2) mlist))
|
|
(setq indent (current-column))
|
|
(beginning-of-line)))
|
|
;; Process the method name.
|
|
(when mname
|
|
(let ((mn (split-string mname "\\.\\|::")))
|
|
(if (cdr mn)
|
|
(progn
|
|
(unless (string-equal "self" (car mn)) ; def self.foo
|
|
;; def C.foo
|
|
(let ((ml (nreverse mlist)))
|
|
;; If the method name references one of the
|
|
;; containing modules, drop the more nested ones.
|
|
(while ml
|
|
(if (string-equal (car ml) (car mn))
|
|
(setq mlist (nreverse (cdr ml)) ml nil))
|
|
(or (setq ml (cdr ml)) (nreverse mlist))))
|
|
(if mlist
|
|
(setcdr (last mlist) (butlast mn))
|
|
(setq mlist (butlast mn))))
|
|
(setq mname (concat "." (car (last mn)))))
|
|
;; See if the method is in singleton class context.
|
|
(let ((in-singleton-class
|
|
(when (re-search-forward ruby-singleton-class-re start t)
|
|
(goto-char (match-beginning 0))
|
|
;; FIXME: Optimize it out, too?
|
|
;; This can be slow in a large file, but
|
|
;; unlike class/module declaration
|
|
;; indentations, method definitions can be
|
|
;; intermixed with these, and may or may not
|
|
;; be additionally indented after visibility
|
|
;; keywords.
|
|
(ruby-block-contains-point start))))
|
|
(setq mname (concat
|
|
(if in-singleton-class "." "#")
|
|
mname))))))
|
|
;; Generate the string.
|
|
(if (consp mlist)
|
|
(setq mlist (mapconcat (function identity) mlist "::")))
|
|
(if mname
|
|
(if mlist (concat mlist mname) mname)
|
|
mlist)))))
|
|
|
|
(defun ruby-block-contains-point (pt)
|
|
(save-excursion
|
|
(save-match-data
|
|
(ruby-forward-sexp)
|
|
(> (point) pt))))
|
|
|
|
(defun ruby-brace-to-do-end (orig end)
|
|
(let (beg-marker end-marker)
|
|
(goto-char end)
|
|
(when (eq (char-before) ?\})
|
|
(delete-char -1)
|
|
(when (save-excursion
|
|
(skip-chars-backward " \t")
|
|
(not (bolp)))
|
|
(insert "\n"))
|
|
(insert "end")
|
|
(setq end-marker (point-marker))
|
|
(when (and (not (eobp)) (eq (char-syntax (char-after)) ?w))
|
|
(insert " "))
|
|
(goto-char orig)
|
|
(delete-char 1)
|
|
(when (eq (char-syntax (char-before)) ?w)
|
|
(insert " "))
|
|
(insert "do")
|
|
(setq beg-marker (point-marker))
|
|
(when (looking-at "\\(\\s \\)*|")
|
|
(unless (match-beginning 1)
|
|
(insert " "))
|
|
(goto-char (1+ (match-end 0)))
|
|
(search-forward "|"))
|
|
(unless (looking-at "\\s *$")
|
|
(insert "\n"))
|
|
(indent-region beg-marker end-marker)
|
|
(goto-char beg-marker)
|
|
t)))
|
|
|
|
(defun ruby-do-end-to-brace (orig end)
|
|
(let (beg-marker end-marker beg-pos end-pos)
|
|
(goto-char (- end 3))
|
|
(when (looking-at ruby-block-end-re)
|
|
(delete-char 3)
|
|
(setq end-marker (point-marker))
|
|
(insert "}")
|
|
(goto-char orig)
|
|
(delete-char 2)
|
|
;; Maybe this should be customizable, let's see if anyone asks.
|
|
(insert "{ ")
|
|
(setq beg-marker (point-marker))
|
|
(when (looking-at "\\s +|")
|
|
(delete-char (- (match-end 0) (match-beginning 0) 1))
|
|
(forward-char)
|
|
(re-search-forward "|" (line-end-position) t))
|
|
(save-excursion
|
|
(skip-chars-forward " \t\n\r")
|
|
(setq beg-pos (point))
|
|
(goto-char end-marker)
|
|
(skip-chars-backward " \t\n\r")
|
|
(setq end-pos (point)))
|
|
(when (or
|
|
(< end-pos beg-pos)
|
|
(and (= (line-number-at-pos beg-pos) (line-number-at-pos end-pos))
|
|
(< (+ (current-column) (- end-pos beg-pos) 2) fill-column)))
|
|
(just-one-space -1)
|
|
(goto-char end-marker)
|
|
(just-one-space -1))
|
|
(goto-char beg-marker)
|
|
t)))
|
|
|
|
(defun ruby-toggle-block ()
|
|
"Toggle block type from do-end to braces or back.
|
|
The block must begin on the current line or above it and end after the point.
|
|
If the result is do-end block, it will always be multiline."
|
|
(interactive)
|
|
(let ((start (point)) beg end)
|
|
(end-of-line)
|
|
(unless
|
|
(if (and (re-search-backward "\\(?:[^#]\\)\\({\\)\\|\\(\\_<do\\_>\\)")
|
|
(progn
|
|
(goto-char (or (match-beginning 1) (match-beginning 2)))
|
|
(setq beg (point))
|
|
(save-match-data (ruby-forward-sexp))
|
|
(setq end (point))
|
|
(> end start)))
|
|
(if (match-beginning 1)
|
|
(ruby-brace-to-do-end beg end)
|
|
(ruby-do-end-to-brace beg end)))
|
|
(goto-char start))))
|
|
|
|
(eval-and-compile
|
|
(defconst ruby-percent-literal-beg-re
|
|
"\\(%\\)[qQrswWxIi]?\\([[:punct:]]\\)"
|
|
"Regexp to match the beginning of percent literal.")
|
|
|
|
(defconst ruby-syntax-methods-before-regexp
|
|
'("gsub" "gsub!" "sub" "sub!" "scan" "split" "split!" "index" "match"
|
|
"assert_match" "Given" "Then" "When")
|
|
"Methods that can take regexp as the first argument.
|
|
It will be properly highlighted even when the call omits parens.")
|
|
|
|
(defvar ruby-syntax-before-regexp-re
|
|
(concat
|
|
;; Special tokens that can't be followed by a division operator.
|
|
"\\(^\\|[[=(,~;<>]"
|
|
;; Distinguish ternary operator tokens.
|
|
;; FIXME: They don't really have to be separated with spaces.
|
|
"\\|[?:] "
|
|
;; Control flow keywords and operators following bol or whitespace.
|
|
"\\|\\(?:^\\|\\s \\)"
|
|
(regexp-opt '("if" "elsif" "unless" "while" "until" "when" "and"
|
|
"or" "not" "&&" "||"))
|
|
;; Method name from the list.
|
|
"\\|\\_<"
|
|
(regexp-opt ruby-syntax-methods-before-regexp)
|
|
"\\)\\s *")
|
|
"Regexp to match text that can be followed by a regular expression."))
|
|
|
|
(defun ruby-syntax-propertize-function (start end)
|
|
"Syntactic keywords for Ruby mode. See `syntax-propertize-function'."
|
|
(let (case-fold-search)
|
|
(goto-char start)
|
|
(remove-text-properties start end '(ruby-expansion-match-data))
|
|
(ruby-syntax-propertize-heredoc end)
|
|
(ruby-syntax-enclosing-percent-literal end)
|
|
(funcall
|
|
(syntax-propertize-rules
|
|
;; $' $" $` .... are variables.
|
|
;; ?' ?" ?` are character literals (one-char strings in 1.9+).
|
|
("\\([?$]\\)[#\"'`]"
|
|
(1 (unless (save-excursion
|
|
;; Not within a string.
|
|
(nth 3 (syntax-ppss (match-beginning 0))))
|
|
(string-to-syntax "\\"))))
|
|
;; Regular expressions. Start with matching unescaped slash.
|
|
("\\(?:\\=\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\(/\\)"
|
|
(1 (let ((state (save-excursion (syntax-ppss (match-beginning 1)))))
|
|
(when (or
|
|
;; Beginning of a regexp.
|
|
(and (null (nth 8 state))
|
|
(save-excursion
|
|
(forward-char -1)
|
|
(looking-back ruby-syntax-before-regexp-re
|
|
(point-at-bol))))
|
|
;; End of regexp. We don't match the whole
|
|
;; regexp at once because it can have
|
|
;; string interpolation inside, or span
|
|
;; several lines.
|
|
(eq ?/ (nth 3 state)))
|
|
(string-to-syntax "\"/")))))
|
|
;; Expression expansions in strings. We're handling them
|
|
;; here, so that the regexp rule never matches inside them.
|
|
(ruby-expression-expansion-re
|
|
(0 (ignore (ruby-syntax-propertize-expansion))))
|
|
("^=en\\(d\\)\\_>" (1 "!"))
|
|
("^\\(=\\)begin\\_>" (1 "!"))
|
|
;; Handle here documents.
|
|
((concat ruby-here-doc-beg-re ".*\\(\n\\)")
|
|
(7 (unless (or (nth 8 (save-excursion
|
|
(syntax-ppss (match-beginning 0))))
|
|
(ruby-singleton-class-p (match-beginning 0)))
|
|
(put-text-property (match-beginning 7) (match-end 7)
|
|
'syntax-table (string-to-syntax "\""))
|
|
(ruby-syntax-propertize-heredoc end))))
|
|
;; Handle percent literals: %w(), %q{}, etc.
|
|
((concat "\\(?:^\\|[[ \t\n<+(,=]\\)" ruby-percent-literal-beg-re)
|
|
(1 (prog1 "|" (ruby-syntax-propertize-percent-literal end)))))
|
|
(point) end)))
|
|
|
|
(defun ruby-syntax-propertize-heredoc (limit)
|
|
(let ((ppss (syntax-ppss))
|
|
(res '()))
|
|
(when (eq ?\n (nth 3 ppss))
|
|
(save-excursion
|
|
(goto-char (nth 8 ppss))
|
|
(beginning-of-line)
|
|
(while (re-search-forward ruby-here-doc-beg-re
|
|
(line-end-position) t)
|
|
(unless (ruby-singleton-class-p (match-beginning 0))
|
|
(push (concat (ruby-here-doc-end-match) "\n") res))))
|
|
(save-excursion
|
|
;; With multiple openers on the same line, we don't know in which
|
|
;; part `start' is, so we have to go back to the beginning.
|
|
(when (cdr res)
|
|
(goto-char (nth 8 ppss))
|
|
(setq res (nreverse res)))
|
|
(while (and res (re-search-forward (pop res) limit 'move))
|
|
(if (null res)
|
|
(put-text-property (1- (point)) (point)
|
|
'syntax-table (string-to-syntax "\""))))
|
|
;; End up at bol following the heredoc openers.
|
|
;; Propertize expression expansions from this point forward.
|
|
))))
|
|
|
|
(defun ruby-syntax-enclosing-percent-literal (limit)
|
|
(let ((state (syntax-ppss))
|
|
(start (point)))
|
|
;; When already inside percent literal, re-propertize it.
|
|
(when (eq t (nth 3 state))
|
|
(goto-char (nth 8 state))
|
|
(when (looking-at ruby-percent-literal-beg-re)
|
|
(ruby-syntax-propertize-percent-literal limit))
|
|
(when (< (point) start) (goto-char start)))))
|
|
|
|
(defun ruby-syntax-propertize-percent-literal (limit)
|
|
(goto-char (match-beginning 2))
|
|
;; Not inside a simple string or comment.
|
|
(when (eq t (nth 3 (syntax-ppss)))
|
|
(let* ((op (char-after))
|
|
(ops (char-to-string op))
|
|
(cl (or (cdr (aref (syntax-table) op))
|
|
(cdr (assoc op '((?< . ?>))))))
|
|
parse-sexp-lookup-properties)
|
|
(save-excursion
|
|
(condition-case nil
|
|
(progn
|
|
(if cl ; Paired delimiters.
|
|
;; Delimiter pairs of the same kind can be nested
|
|
;; inside the literal, as long as they are balanced.
|
|
;; Create syntax table that ignores other characters.
|
|
(with-syntax-table (make-char-table 'syntax-table nil)
|
|
(modify-syntax-entry op (concat "(" (char-to-string cl)))
|
|
(modify-syntax-entry cl (concat ")" ops))
|
|
(modify-syntax-entry ?\\ "\\")
|
|
(save-restriction
|
|
(narrow-to-region (point) limit)
|
|
(forward-list))) ; skip to the paired character
|
|
;; Single character delimiter.
|
|
(re-search-forward (concat "[^\\]\\(?:\\\\\\\\\\)*"
|
|
(regexp-quote ops)) limit nil))
|
|
;; Found the closing delimiter.
|
|
(put-text-property (1- (point)) (point) 'syntax-table
|
|
(string-to-syntax "|")))
|
|
;; Unclosed literal, do nothing.
|
|
((scan-error search-failed)))))))
|
|
|
|
(defun ruby-syntax-propertize-expansion ()
|
|
;; Save the match data to a text property, for font-locking later.
|
|
;; Set the syntax of all double quotes and backticks to punctuation.
|
|
(let* ((beg (match-beginning 2))
|
|
(end (match-end 2))
|
|
(state (and beg (save-excursion (syntax-ppss beg)))))
|
|
(when (ruby-syntax-expansion-allowed-p state)
|
|
(put-text-property beg (1+ beg) 'ruby-expansion-match-data
|
|
(match-data))
|
|
(goto-char beg)
|
|
(while (re-search-forward "[\"`]" end 'move)
|
|
(put-text-property (match-beginning 0) (match-end 0)
|
|
'syntax-table (string-to-syntax "."))))))
|
|
|
|
(defun ruby-syntax-expansion-allowed-p (parse-state)
|
|
"Return non-nil if expression expansion is allowed."
|
|
(let ((term (nth 3 parse-state)))
|
|
(cond
|
|
((memq term '(?\" ?` ?\n ?/)))
|
|
((eq term t)
|
|
(save-match-data
|
|
(save-excursion
|
|
(goto-char (nth 8 parse-state))
|
|
(looking-at "%\\(?:[QWrxI]\\|\\W\\)")))))))
|
|
|
|
(defun ruby-syntax-propertize-expansions (start end)
|
|
(save-excursion
|
|
(goto-char start)
|
|
(while (re-search-forward ruby-expression-expansion-re end 'move)
|
|
(ruby-syntax-propertize-expansion))))
|
|
|
|
(defun ruby-in-ppss-context-p (context &optional ppss)
|
|
(let ((ppss (or ppss (syntax-ppss (point)))))
|
|
(if (cond
|
|
((eq context 'anything)
|
|
(or (nth 3 ppss)
|
|
(nth 4 ppss)))
|
|
((eq context 'string)
|
|
(nth 3 ppss))
|
|
((eq context 'heredoc)
|
|
(eq ?\n (nth 3 ppss)))
|
|
((eq context 'non-heredoc)
|
|
(and (ruby-in-ppss-context-p 'anything)
|
|
(not (ruby-in-ppss-context-p 'heredoc))))
|
|
((eq context 'comment)
|
|
(nth 4 ppss))
|
|
(t
|
|
(error (concat
|
|
"Internal error on `ruby-in-ppss-context-p': "
|
|
"context name `" (symbol-name context) "' is unknown"))))
|
|
t)))
|
|
|
|
(defvar ruby-font-lock-syntax-table
|
|
(let ((tbl (copy-syntax-table ruby-mode-syntax-table)))
|
|
(modify-syntax-entry ?_ "w" tbl)
|
|
tbl)
|
|
"The syntax table to use for fontifying Ruby mode buffers.
|
|
See `font-lock-syntax-table'.")
|
|
|
|
(defconst ruby-font-lock-keyword-beg-re "\\(?:^\\|[^.@$]\\|\\.\\.\\)")
|
|
|
|
(defconst ruby-font-lock-keywords
|
|
`(;; Functions.
|
|
("^\\s *def\\s +\\(?:[^( \t\n.]*\\.\\)?\\([^( \t\n]+\\)"
|
|
1 font-lock-function-name-face)
|
|
;; Keywords.
|
|
(,(concat
|
|
ruby-font-lock-keyword-beg-re
|
|
(regexp-opt
|
|
'("alias"
|
|
"and"
|
|
"begin"
|
|
"break"
|
|
"case"
|
|
"class"
|
|
"def"
|
|
"defined?"
|
|
"do"
|
|
"elsif"
|
|
"else"
|
|
"fail"
|
|
"ensure"
|
|
"for"
|
|
"end"
|
|
"if"
|
|
"in"
|
|
"module"
|
|
"next"
|
|
"not"
|
|
"or"
|
|
"redo"
|
|
"rescue"
|
|
"retry"
|
|
"return"
|
|
"then"
|
|
"super"
|
|
"unless"
|
|
"undef"
|
|
"until"
|
|
"when"
|
|
"while"
|
|
"yield")
|
|
'symbols))
|
|
(1 font-lock-keyword-face))
|
|
;; Some core methods.
|
|
(,(concat
|
|
ruby-font-lock-keyword-beg-re
|
|
(regexp-opt
|
|
'( ;; built-in methods on Kernel
|
|
"__callee__"
|
|
"__dir__"
|
|
"__method__"
|
|
"abort"
|
|
"at_exit"
|
|
"autoload"
|
|
"autoload?"
|
|
"binding"
|
|
"block_given?"
|
|
"caller"
|
|
"catch"
|
|
"eval"
|
|
"exec"
|
|
"exit"
|
|
"exit!"
|
|
"fail"
|
|
"fork"
|
|
"format"
|
|
"lambda"
|
|
"load"
|
|
"loop"
|
|
"open"
|
|
"p"
|
|
"print"
|
|
"printf"
|
|
"proc"
|
|
"putc"
|
|
"puts"
|
|
"raise"
|
|
"rand"
|
|
"readline"
|
|
"readlines"
|
|
"require"
|
|
"require_relative"
|
|
"sleep"
|
|
"spawn"
|
|
"sprintf"
|
|
"srand"
|
|
"syscall"
|
|
"system"
|
|
"throw"
|
|
"trap"
|
|
"warn"
|
|
;; keyword-like private methods on Module
|
|
"alias_method"
|
|
"attr"
|
|
"attr_accessor"
|
|
"attr_reader"
|
|
"attr_writer"
|
|
"define_method"
|
|
"extend"
|
|
"include"
|
|
"module_function"
|
|
"prepend"
|
|
"private"
|
|
"protected"
|
|
"public"
|
|
"refine"
|
|
"using")
|
|
'symbols))
|
|
(1 font-lock-builtin-face))
|
|
;; Here-doc beginnings.
|
|
(,ruby-here-doc-beg-re
|
|
(0 (unless (ruby-singleton-class-p (match-beginning 0))
|
|
'font-lock-string-face)))
|
|
;; Perl-ish keywords.
|
|
"\\_<\\(?:BEGIN\\|END\\)\\_>\\|^__END__$"
|
|
;; Variables.
|
|
(,(concat ruby-font-lock-keyword-beg-re
|
|
"\\_<\\(nil\\|self\\|true\\|false\\)\\_>")
|
|
1 font-lock-variable-name-face)
|
|
;; Keywords that evaluate to certain values.
|
|
("\\_<__\\(?:LINE\\|ENCODING\\|FILE\\)__\\_>"
|
|
(0 font-lock-variable-name-face))
|
|
;; Symbols.
|
|
("\\(^\\|[^:]\\)\\(:\\([-+~]@?\\|[/%&|^`]\\|\\*\\*?\\|<\\(<\\|=>?\\)?\\|>[>=]?\\|===?\\|=~\\|![~=]?\\|\\[\\]=?\\|@?\\(\\w\\|_\\)+\\([!?=]\\|\\b_*\\)\\|#{[^}\n\\\\]*\\(\\\\.[^}\n\\\\]*\\)*}\\)\\)"
|
|
2 font-lock-constant-face)
|
|
;; Variables.
|
|
("\\(\\$\\([^a-zA-Z0-9 \n]\\|[0-9]\\)\\)\\W"
|
|
1 font-lock-variable-name-face)
|
|
("\\(\\$\\|@\\|@@\\)\\(\\w\\|_\\)+"
|
|
0 font-lock-variable-name-face)
|
|
;; Constants.
|
|
("\\(?:\\_<\\|::\\)\\([A-Z]+\\(\\w\\|_\\)*\\)"
|
|
1 (unless (eq ?\( (char-after)) font-lock-type-face))
|
|
("\\(^\\s *\\|[\[\{\(,]\\s *\\|\\sw\\s +\\)\\(\\(\\sw\\|_\\)+\\):[^:]"
|
|
(2 font-lock-constant-face))
|
|
;; Conversion methods on Kernel.
|
|
(,(concat ruby-font-lock-keyword-beg-re
|
|
(regexp-opt '("Array" "Complex" "Float" "Hash"
|
|
"Integer" "Rational" "String") 'symbols))
|
|
(1 font-lock-builtin-face))
|
|
;; Expression expansion.
|
|
(ruby-match-expression-expansion
|
|
2 font-lock-variable-name-face t)
|
|
;; Negation char.
|
|
("[^[:alnum:]_]\\(!\\)[^=]"
|
|
1 font-lock-negation-char-face)
|
|
;; Character literals.
|
|
;; FIXME: Support longer escape sequences.
|
|
("\\_<\\?\\\\?\\S " 0 font-lock-string-face)
|
|
)
|
|
"Additional expressions to highlight in Ruby mode.")
|
|
|
|
(defun ruby-match-expression-expansion (limit)
|
|
(let* ((prop 'ruby-expansion-match-data)
|
|
(pos (next-single-char-property-change (point) prop nil limit))
|
|
value)
|
|
(when (and pos (> pos (point)))
|
|
(goto-char pos)
|
|
(or (and (setq value (get-text-property pos prop))
|
|
(progn (set-match-data value) t))
|
|
(ruby-match-expression-expansion limit)))))
|
|
|
|
;;;###autoload
|
|
(define-derived-mode ruby-mode prog-mode "Ruby"
|
|
"Major mode for editing Ruby code.
|
|
|
|
\\{ruby-mode-map}"
|
|
(ruby-mode-variables)
|
|
|
|
(setq-local imenu-create-index-function 'ruby-imenu-create-index)
|
|
(setq-local add-log-current-defun-function 'ruby-add-log-current-method)
|
|
(setq-local beginning-of-defun-function 'ruby-beginning-of-defun)
|
|
(setq-local end-of-defun-function 'ruby-end-of-defun)
|
|
|
|
(add-hook 'after-save-hook 'ruby-mode-set-encoding nil 'local)
|
|
|
|
(setq-local electric-indent-chars (append '(?\{ ?\}) electric-indent-chars))
|
|
|
|
(setq-local font-lock-defaults '((ruby-font-lock-keywords) nil nil))
|
|
(setq-local font-lock-keywords ruby-font-lock-keywords)
|
|
(setq-local font-lock-syntax-table ruby-font-lock-syntax-table)
|
|
|
|
(setq-local syntax-propertize-function #'ruby-syntax-propertize-function))
|
|
|
|
;;; Invoke ruby-mode when appropriate
|
|
|
|
;;;###autoload
|
|
(add-to-list 'auto-mode-alist
|
|
(cons (purecopy (concat "\\(?:\\."
|
|
"rb\\|ru\\|rake\\|thor"
|
|
"\\|jbuilder\\|gemspec"
|
|
"\\|/"
|
|
"\\(?:Gem\\|Rake\\|Cap\\|Thor"
|
|
"Vagrant\\|Guard\\)file"
|
|
"\\)\\'")) 'ruby-mode))
|
|
|
|
;;;###autoload
|
|
(dolist (name (list "ruby" "rbx" "jruby" "ruby1.9" "ruby1.8"))
|
|
(add-to-list 'interpreter-mode-alist (cons (purecopy name) 'ruby-mode)))
|
|
|
|
(provide 'ruby-mode)
|
|
|
|
;;; ruby-mode.el ends here
|