HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| c7fbbc3c CY |
1 | ;;; ruby-mode.el --- Major mode for editing Ruby files |
| 2 | ||
| acaf905b | 3 | ;; Copyright (C) 1994-2012 Free Software Foundation, Inc. |
| c7fbbc3c | 4 | |
| c5220417 GM |
5 | ;; Authors: Yukihiro Matsumoto |
| 6 | ;; Nobuyoshi Nakada | |
| c7fbbc3c CY |
7 | ;; URL: http://www.emacswiki.org/cgi-bin/wiki/RubyMode |
| 8 | ;; Created: Fri Feb 4 14:49:13 JST 1994 | |
| 9 | ;; Keywords: languages ruby | |
| 10 | ;; Version: 1.0 | |
| 11 | ||
| 12 | ;; This file is part of GNU Emacs. | |
| 13 | ||
| 14 | ;; GNU Emacs is free software: you can redistribute it and/or modify | |
| 15 | ;; it under the terms of the GNU General Public License as published by | |
| 16 | ;; the Free Software Foundation, either version 3 of the License, or | |
| 17 | ;; (at your option) any later version. | |
| 18 | ||
| 19 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
| 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 22 | ;; GNU General Public License for more details. | |
| 23 | ||
| 24 | ;; You should have received a copy of the GNU General Public License | |
| 25 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. | |
| 26 | ||
| 27 | ;;; Commentary: | |
| 28 | ||
| 29 | ;; Provides font-locking, indentation support, and navigation for Ruby code. | |
| 30 | ;; | |
| 31 | ;; If you're installing manually, you should add this to your .emacs | |
| 32 | ;; file after putting it on your load path: | |
| 33 | ;; | |
| 34 | ;; (autoload 'ruby-mode "ruby-mode" "Major mode for ruby files" t) | |
| 35 | ;; (add-to-list 'auto-mode-alist '("\\.rb$" . ruby-mode)) | |
| 36 | ;; (add-to-list 'interpreter-mode-alist '("ruby" . ruby-mode)) | |
| 37 | ;; | |
| 38 | ;; Still needs more docstrings; search below for TODO. | |
| 39 | ||
| 40 | ;;; Code: | |
| 41 | ||
| 42 | (eval-when-compile (require 'cl)) | |
| 43 | ||
| 44a41a47 KR |
44 | (defgroup ruby nil |
| 45 | "Major mode for editing Ruby code." | |
| 46 | :prefix "ruby-" | |
| 47 | :group 'languages) | |
| 48 | ||
| c7fbbc3c CY |
49 | (defconst ruby-keyword-end-re |
| 50 | (if (string-match "\\_>" "ruby") | |
| 51 | "\\_>" | |
| 52 | "\\>")) | |
| 53 | ||
| 54 | (defconst ruby-block-beg-keywords | |
| 55 | '("class" "module" "def" "if" "unless" "case" "while" "until" "for" "begin" "do") | |
| 56 | "Keywords at the beginning of blocks.") | |
| 57 | ||
| 58 | (defconst ruby-block-beg-re | |
| 59 | (regexp-opt ruby-block-beg-keywords) | |
| 60 | "Regexp to match the beginning of blocks.") | |
| 61 | ||
| 62 | (defconst ruby-non-block-do-re | |
| 63 | (concat (regexp-opt '("while" "until" "for" "rescue") t) ruby-keyword-end-re) | |
| 64 | "Regexp to match keywords that nest without blocks.") | |
| 65 | ||
| 66 | (defconst ruby-indent-beg-re | |
| 67 | (concat "\\(\\s *" (regexp-opt '("class" "module" "def") t) "\\)\\|" | |
| 68 | (regexp-opt '("if" "unless" "case" "while" "until" "for" "begin"))) | |
| 69 | "Regexp to match where the indentation gets deeper.") | |
| 70 | ||
| 71 | (defconst ruby-modifier-beg-keywords | |
| 72 | '("if" "unless" "while" "until") | |
| 73 | "Modifiers that are the same as the beginning of blocks.") | |
| 74 | ||
| 75 | (defconst ruby-modifier-beg-re | |
| 76 | (regexp-opt ruby-modifier-beg-keywords) | |
| 77 | "Regexp to match modifiers same as the beginning of blocks.") | |
| 78 | ||
| 79 | (defconst ruby-modifier-re | |
| 80 | (regexp-opt (cons "rescue" ruby-modifier-beg-keywords)) | |
| 81 | "Regexp to match modifiers.") | |
| 82 | ||
| 83 | (defconst ruby-block-mid-keywords | |
| 84 | '("then" "else" "elsif" "when" "rescue" "ensure") | |
| 85 | "Keywords where the indentation gets shallower in middle of block statements.") | |
| 86 | ||
| 87 | (defconst ruby-block-mid-re | |
| 88 | (regexp-opt ruby-block-mid-keywords) | |
| 89 | "Regexp to match where the indentation gets shallower in middle of block statements.") | |
| 90 | ||
| 91 | (defconst ruby-block-op-keywords | |
| 92 | '("and" "or" "not") | |
| 93 | "Regexp to match boolean keywords.") | |
| 94 | ||
| 95 | (defconst ruby-block-hanging-re | |
| 96 | (regexp-opt (append ruby-modifier-beg-keywords ruby-block-op-keywords)) | |
| 97 | "Regexp to match hanging block modifiers.") | |
| 98 | ||
| 39675016 | 99 | (defconst ruby-block-end-re "\\_<end\\_>") |
| c7fbbc3c | 100 | |
| cf38dd42 SM |
101 | (eval-and-compile |
| 102 | (defconst ruby-here-doc-beg-re | |
| c7fbbc3c | 103 | "\\(<\\)<\\(-\\)?\\(\\([a-zA-Z0-9_]+\\)\\|[\"]\\([^\"]+\\)[\"]\\|[']\\([^']+\\)[']\\)" |
| cf38dd42 | 104 | "Regexp to match the beginning of a heredoc.")) |
| c7fbbc3c CY |
105 | |
| 106 | (defun ruby-here-doc-end-match () | |
| 107 | "Return a regexp to find the end of a heredoc. | |
| 108 | ||
| 109 | This should only be called after matching against `ruby-here-doc-beg-re'." | |
| 110 | (concat "^" | |
| 111 | (if (match-string 2) "[ \t]*" nil) | |
| 112 | (regexp-quote | |
| 113 | (or (match-string 4) | |
| 114 | (match-string 5) | |
| 115 | (match-string 6))))) | |
| 116 | ||
| c7fbbc3c | 117 | (defconst ruby-delimiter |
| 39675016 | 118 | (concat "[?$/%(){}#\"'`.:]\\|<<\\|\\[\\|\\]\\|\\_<\\(" |
| c7fbbc3c | 119 | ruby-block-beg-re |
| 39675016 | 120 | "\\)\\_>\\|" ruby-block-end-re |
| c7fbbc3c CY |
121 | "\\|^=begin\\|" ruby-here-doc-beg-re)) |
| 122 | ||
| 123 | (defconst ruby-negative | |
| 124 | (concat "^[ \t]*\\(\\(" ruby-block-mid-re "\\)\\>\\|" | |
| 125 | ruby-block-end-re "\\|}\\|\\]\\)") | |
| 126 | "Regexp to match where the indentation gets shallower.") | |
| 127 | ||
| 128 | (defconst ruby-operator-re "[-,.+*/%&|^~=<>:]" | |
| 129 | "Regexp to match operators.") | |
| 130 | ||
| 131 | (defconst ruby-symbol-chars "a-zA-Z0-9_" | |
| 132 | "List of characters that symbol names may contain.") | |
| 133 | (defconst ruby-symbol-re (concat "[" ruby-symbol-chars "]") | |
| 134 | "Regexp to match symbols.") | |
| 135 | ||
| 2122161f | 136 | (define-abbrev-table 'ruby-mode-abbrev-table () |
| ee61fe97 | 137 | "Abbrev table in use in Ruby mode buffers.") |
| c7fbbc3c | 138 | |
| c7fbbc3c CY |
139 | (defvar ruby-mode-map |
| 140 | (let ((map (make-sparse-keymap))) | |
| 141 | (define-key map "{" 'ruby-electric-brace) | |
| 142 | (define-key map "}" 'ruby-electric-brace) | |
| 143 | (define-key map (kbd "M-C-a") 'ruby-beginning-of-defun) | |
| 144 | (define-key map (kbd "M-C-e") 'ruby-end-of-defun) | |
| 145 | (define-key map (kbd "M-C-b") 'ruby-backward-sexp) | |
| 146 | (define-key map (kbd "M-C-f") 'ruby-forward-sexp) | |
| 147 | (define-key map (kbd "M-C-p") 'ruby-beginning-of-block) | |
| 148 | (define-key map (kbd "M-C-n") 'ruby-end-of-block) | |
| 149 | (define-key map (kbd "M-C-h") 'ruby-mark-defun) | |
| 150 | (define-key map (kbd "M-C-q") 'ruby-indent-exp) | |
| c7fbbc3c CY |
151 | (define-key map (kbd "C-M-h") 'backward-kill-word) |
| 152 | (define-key map (kbd "C-j") 'reindent-then-newline-and-indent) | |
| 153 | (define-key map (kbd "C-m") 'newline) | |
| cc9c9831 | 154 | (define-key map (kbd "C-c C-c") 'comment-region) |
| c7fbbc3c | 155 | map) |
| ee61fe97 | 156 | "Keymap used in Ruby mode.") |
| c7fbbc3c CY |
157 | |
| 158 | (defvar ruby-mode-syntax-table | |
| 159 | (let ((table (make-syntax-table))) | |
| 160 | (modify-syntax-entry ?\' "\"" table) | |
| 161 | (modify-syntax-entry ?\" "\"" table) | |
| 162 | (modify-syntax-entry ?\` "\"" table) | |
| 163 | (modify-syntax-entry ?# "<" table) | |
| 164 | (modify-syntax-entry ?\n ">" table) | |
| 165 | (modify-syntax-entry ?\\ "\\" table) | |
| 166 | (modify-syntax-entry ?$ "." table) | |
| 167 | (modify-syntax-entry ?? "_" table) | |
| 168 | (modify-syntax-entry ?_ "_" table) | |
| 39675016 | 169 | (modify-syntax-entry ?: "_" table) |
| c7fbbc3c CY |
170 | (modify-syntax-entry ?< "." table) |
| 171 | (modify-syntax-entry ?> "." table) | |
| 172 | (modify-syntax-entry ?& "." table) | |
| 173 | (modify-syntax-entry ?| "." table) | |
| 174 | (modify-syntax-entry ?% "." table) | |
| 175 | (modify-syntax-entry ?= "." table) | |
| 176 | (modify-syntax-entry ?/ "." table) | |
| 177 | (modify-syntax-entry ?+ "." table) | |
| 178 | (modify-syntax-entry ?* "." table) | |
| 179 | (modify-syntax-entry ?- "." table) | |
| 180 | (modify-syntax-entry ?\; "." table) | |
| 181 | (modify-syntax-entry ?\( "()" table) | |
| 182 | (modify-syntax-entry ?\) ")(" table) | |
| 183 | (modify-syntax-entry ?\{ "(}" table) | |
| 184 | (modify-syntax-entry ?\} "){" table) | |
| 185 | (modify-syntax-entry ?\[ "(]" table) | |
| 186 | (modify-syntax-entry ?\] ")[" table) | |
| 187 | table) | |
| ee61fe97 | 188 | "Syntax table to use in Ruby mode.") |
| c7fbbc3c CY |
189 | |
| 190 | (defcustom ruby-indent-tabs-mode nil | |
| ee61fe97 | 191 | "Indentation can insert tabs in Ruby mode if this is non-nil." |
| c7fbbc3c CY |
192 | :type 'boolean :group 'ruby) |
| 193 | ||
| 194 | (defcustom ruby-indent-level 2 | |
| ee61fe97 | 195 | "Indentation of Ruby statements." |
| c7fbbc3c CY |
196 | :type 'integer :group 'ruby) |
| 197 | ||
| 198 | (defcustom ruby-comment-column 32 | |
| 199 | "Indentation column of comments." | |
| 200 | :type 'integer :group 'ruby) | |
| 201 | ||
| 202 | (defcustom ruby-deep-arglist t | |
| 203 | "Deep indent lists in parenthesis when non-nil. | |
| 204 | Also ignores spaces after parenthesis when 'space." | |
| 205 | :group 'ruby) | |
| 206 | ||
| 207 | (defcustom ruby-deep-indent-paren '(?\( ?\[ ?\] t) | |
| ee61fe97 JB |
208 | "Deep indent lists in parenthesis when non-nil. |
| 209 | The value t means continuous line. | |
| c7fbbc3c CY |
210 | Also ignores spaces after parenthesis when 'space." |
| 211 | :group 'ruby) | |
| 212 | ||
| 213 | (defcustom ruby-deep-indent-paren-style 'space | |
| 214 | "Default deep indent style." | |
| 215 | :options '(t nil space) :group 'ruby) | |
| 216 | ||
| 217 | (defcustom ruby-encoding-map '((shift_jis . cp932) (shift-jis . cp932)) | |
| 218 | "Alist to map encoding name from Emacs to Ruby." | |
| 219 | :group 'ruby) | |
| 220 | ||
| 221 | (defcustom ruby-insert-encoding-magic-comment t | |
| ee61fe97 | 222 | "Insert a magic Emacs 'coding' comment upon save if this is non-nil." |
| c7fbbc3c CY |
223 | :type 'boolean :group 'ruby) |
| 224 | ||
| 225 | (defcustom ruby-use-encoding-map t | |
| 226 | "Use `ruby-encoding-map' to set encoding magic comment if this is non-nil." | |
| 227 | :type 'boolean :group 'ruby) | |
| 228 | ||
| 229 | ;; Safe file variables | |
| 230 | (put 'ruby-indent-tabs-mode 'safe-local-variable 'booleanp) | |
| 231 | (put 'ruby-indent-level 'safe-local-variable 'integerp) | |
| 232 | (put 'ruby-comment-column 'safe-local-variable 'integerp) | |
| 233 | (put 'ruby-deep-arglist 'safe-local-variable 'booleanp) | |
| 234 | ||
| 235 | (defun ruby-imenu-create-index-in-block (prefix beg end) | |
| 236 | "Create an imenu index of methods inside a block." | |
| 237 | (let ((index-alist '()) (case-fold-search nil) | |
| 238 | name next pos decl sing) | |
| 239 | (goto-char beg) | |
| 240 | (while (re-search-forward "^\\s *\\(\\(class\\s +\\|\\(class\\s *<<\\s *\\)\\|module\\s +\\)\\([^\(<\n ]+\\)\\|\\(def\\|alias\\)\\s +\\([^\(\n ]+\\)\\)" end t) | |
| 241 | (setq sing (match-beginning 3)) | |
| 242 | (setq decl (match-string 5)) | |
| 243 | (setq next (match-end 0)) | |
| 244 | (setq name (or (match-string 4) (match-string 6))) | |
| 245 | (setq pos (match-beginning 0)) | |
| 246 | (cond | |
| 247 | ((string= "alias" decl) | |
| 248 | (if prefix (setq name (concat prefix name))) | |
| 249 | (push (cons name pos) index-alist)) | |
| 250 | ((string= "def" decl) | |
| 251 | (if prefix | |
| 252 | (setq name | |
| 253 | (cond | |
| 254 | ((string-match "^self\." name) | |
| 255 | (concat (substring prefix 0 -1) (substring name 4))) | |
| 256 | (t (concat prefix name))))) | |
| 257 | (push (cons name pos) index-alist) | |
| 258 | (ruby-accurate-end-of-block end)) | |
| 259 | (t | |
| 260 | (if (string= "self" name) | |
| 261 | (if prefix (setq name (substring prefix 0 -1))) | |
| 262 | (if prefix (setq name (concat (substring prefix 0 -1) "::" name))) | |
| 263 | (push (cons name pos) index-alist)) | |
| 264 | (ruby-accurate-end-of-block end) | |
| 265 | (setq beg (point)) | |
| 266 | (setq index-alist | |
| 267 | (nconc (ruby-imenu-create-index-in-block | |
| 268 | (concat name (if sing "." "#")) | |
| 269 | next beg) index-alist)) | |
| 270 | (goto-char beg)))) | |
| 271 | index-alist)) | |
| 272 | ||
| 273 | (defun ruby-imenu-create-index () | |
| 274 | "Create an imenu index of all methods in the buffer." | |
| 275 | (nreverse (ruby-imenu-create-index-in-block nil (point-min) nil))) | |
| 276 | ||
| 277 | (defun ruby-accurate-end-of-block (&optional end) | |
| 278 | "TODO: document." | |
| 279 | (let (state | |
| 280 | (end (or end (point-max)))) | |
| 281 | (while (and (setq state (apply 'ruby-parse-partial end state)) | |
| 282 | (>= (nth 2 state) 0) (< (point) end))))) | |
| 283 | ||
| 284 | (defun ruby-mode-variables () | |
| ee61fe97 | 285 | "Set up initial buffer-local variables for Ruby mode." |
| c7fbbc3c CY |
286 | (set-syntax-table ruby-mode-syntax-table) |
| 287 | (setq local-abbrev-table ruby-mode-abbrev-table) | |
| 288 | (setq indent-tabs-mode ruby-indent-tabs-mode) | |
| 289 | (set (make-local-variable 'indent-line-function) 'ruby-indent-line) | |
| 290 | (set (make-local-variable 'require-final-newline) t) | |
| 291 | (set (make-local-variable 'comment-start) "# ") | |
| 292 | (set (make-local-variable 'comment-end) "") | |
| 293 | (set (make-local-variable 'comment-column) ruby-comment-column) | |
| 294 | (set (make-local-variable 'comment-start-skip) "#+ *") | |
| 295 | (set (make-local-variable 'parse-sexp-ignore-comments) t) | |
| 296 | (set (make-local-variable 'parse-sexp-lookup-properties) t) | |
| 297 | (set (make-local-variable 'paragraph-start) (concat "$\\|" page-delimiter)) | |
| 298 | (set (make-local-variable 'paragraph-separate) paragraph-start) | |
| 299 | (set (make-local-variable 'paragraph-ignore-fill-prefix) t)) | |
| 300 | ||
| 301 | (defun ruby-mode-set-encoding () | |
| 302 | "Insert a magic comment header with the proper encoding if necessary." | |
| 303 | (save-excursion | |
| 304 | (widen) | |
| 305 | (goto-char (point-min)) | |
| 306 | (when (re-search-forward "[^\0-\177]" nil t) | |
| 307 | (goto-char (point-min)) | |
| 308 | (let ((coding-system | |
| 309 | (or coding-system-for-write | |
| 310 | buffer-file-coding-system))) | |
| 311 | (if coding-system | |
| 312 | (setq coding-system | |
| 313 | (or (coding-system-get coding-system 'mime-charset) | |
| 314 | (coding-system-change-eol-conversion coding-system nil)))) | |
| 315 | (setq coding-system | |
| 316 | (if coding-system | |
| 317 | (symbol-name | |
| 318 | (or (and ruby-use-encoding-map | |
| 319 | (cdr (assq coding-system ruby-encoding-map))) | |
| 320 | coding-system)) | |
| 321 | "ascii-8bit")) | |
| cc9c9831 | 322 | (if (looking-at "^#!") (beginning-of-line 2)) |
| c7fbbc3c CY |
323 | (cond ((looking-at "\\s *#.*-\*-\\s *\\(en\\)?coding\\s *:\\s *\\([-a-z0-9_]*\\)\\s *\\(;\\|-\*-\\)") |
| 324 | (unless (string= (match-string 2) coding-system) | |
| 325 | (goto-char (match-beginning 2)) | |
| 326 | (delete-region (point) (match-end 2)) | |
| 327 | (and (looking-at "-\*-") | |
| 328 | (let ((n (skip-chars-backward " "))) | |
| 329 | (cond ((= n 0) (insert " ") (backward-char)) | |
| 330 | ((= n -1) (insert " ")) | |
| 331 | ((forward-char))))) | |
| 332 | (insert coding-system))) | |
| 333 | ((looking-at "\\s *#.*coding\\s *[:=]")) | |
| 334 | (t (when ruby-insert-encoding-magic-comment | |
| 335 | (insert "# -*- coding: " coding-system " -*-\n")))))))) | |
| 336 | ||
| 337 | (defun ruby-current-indentation () | |
| 338 | "Return the indentation level of current line." | |
| 339 | (save-excursion | |
| 340 | (beginning-of-line) | |
| 341 | (back-to-indentation) | |
| 342 | (current-column))) | |
| 343 | ||
| cf38dd42 | 344 | (defun ruby-indent-line (&optional ignored) |
| ee61fe97 | 345 | "Correct the indentation of the current Ruby line." |
| c7fbbc3c CY |
346 | (interactive) |
| 347 | (ruby-indent-to (ruby-calculate-indent))) | |
| 348 | ||
| 349 | (defun ruby-indent-to (column) | |
| 350 | "Indent the current line to COLUMN." | |
| 351 | (when column | |
| 352 | (let (shift top beg) | |
| 353 | (and (< column 0) (error "invalid nest")) | |
| 354 | (setq shift (current-column)) | |
| 355 | (beginning-of-line) | |
| 356 | (setq beg (point)) | |
| 357 | (back-to-indentation) | |
| 358 | (setq top (current-column)) | |
| 359 | (skip-chars-backward " \t") | |
| 360 | (if (>= shift top) (setq shift (- shift top)) | |
| 361 | (setq shift 0)) | |
| 362 | (if (and (bolp) | |
| 363 | (= column top)) | |
| 364 | (move-to-column (+ column shift)) | |
| 365 | (move-to-column top) | |
| 366 | (delete-region beg (point)) | |
| 367 | (beginning-of-line) | |
| 368 | (indent-to column) | |
| 369 | (move-to-column (+ column shift)))))) | |
| 370 | ||
| 371 | (defun ruby-special-char-p (&optional pos) | |
| 372 | "Return t if the character before POS is a special character. | |
| 373 | If omitted, POS defaults to the current point. | |
| 374 | Special characters are `?', `$', `:' when preceded by whitespace, | |
| 375 | and `\\' when preceded by `?'." | |
| 376 | (setq pos (or pos (point))) | |
| 377 | (let ((c (char-before pos)) (b (and (< (point-min) pos) | |
| 378 | (char-before (1- pos))))) | |
| 379 | (cond ((or (eq c ??) (eq c ?$))) | |
| 380 | ((and (eq c ?:) (or (not b) (eq (char-syntax b) ? )))) | |
| 381 | ((eq c ?\\) (eq b ??))))) | |
| 382 | ||
| 383 | (defun ruby-expr-beg (&optional option) | |
| 384 | "TODO: document." | |
| 385 | (save-excursion | |
| 386 | (store-match-data nil) | |
| cf38dd42 | 387 | (let ((space (skip-chars-backward " \t"))) |
| c7fbbc3c CY |
388 | (cond |
| 389 | ((bolp) t) | |
| 390 | ((progn | |
| 391 | (forward-char -1) | |
| 392 | (and (looking-at "\\?") | |
| 393 | (or (eq (char-syntax (char-before (point))) ?w) | |
| 394 | (ruby-special-char-p)))) | |
| 395 | nil) | |
| 396 | ((and (eq option 'heredoc) (< space 0)) t) | |
| 397 | ((or (looking-at ruby-operator-re) | |
| 398 | (looking-at "[\\[({,;]") | |
| 399 | (and (looking-at "[!?]") | |
| 400 | (or (not (eq option 'modifier)) | |
| 401 | (bolp) | |
| 402 | (save-excursion (forward-char -1) (looking-at "\\Sw$")))) | |
| 403 | (and (looking-at ruby-symbol-re) | |
| 404 | (skip-chars-backward ruby-symbol-chars) | |
| 405 | (cond | |
| 406 | ((looking-at (regexp-opt | |
| 407 | (append ruby-block-beg-keywords | |
| 408 | ruby-block-op-keywords | |
| 409 | ruby-block-mid-keywords) | |
| 410 | 'words)) | |
| 411 | (goto-char (match-end 0)) | |
| 412 | (not (looking-at "\\s_"))) | |
| 413 | ((eq option 'expr-qstr) | |
| 414 | (looking-at "[a-zA-Z][a-zA-z0-9_]* +%[^ \t]")) | |
| 415 | ((eq option 'expr-re) | |
| 416 | (looking-at "[a-zA-Z][a-zA-z0-9_]* +/[^ \t]")) | |
| 417 | (t nil))))))))) | |
| 418 | ||
| 419 | (defun ruby-forward-string (term &optional end no-error expand) | |
| 420 | "TODO: document." | |
| 421 | (let ((n 1) (c (string-to-char term)) | |
| 422 | (re (if expand | |
| 423 | (concat "[^\\]\\(\\\\\\\\\\)*\\([" term "]\\|\\(#{\\)\\)") | |
| 424 | (concat "[^\\]\\(\\\\\\\\\\)*[" term "]")))) | |
| 425 | (while (and (re-search-forward re end no-error) | |
| 426 | (if (match-beginning 3) | |
| 427 | (ruby-forward-string "}{" end no-error nil) | |
| 428 | (> (setq n (if (eq (char-before (point)) c) | |
| 429 | (1- n) (1+ n))) 0))) | |
| 430 | (forward-char -1)) | |
| 431 | (cond ((zerop n)) | |
| 432 | (no-error nil) | |
| 433 | ((error "unterminated string"))))) | |
| 434 | ||
| 435 | (defun ruby-deep-indent-paren-p (c) | |
| ee61fe97 | 436 | "TODO: document." |
| c7fbbc3c CY |
437 | (cond ((listp ruby-deep-indent-paren) |
| 438 | (let ((deep (assoc c ruby-deep-indent-paren))) | |
| 439 | (cond (deep | |
| 440 | (or (cdr deep) ruby-deep-indent-paren-style)) | |
| 441 | ((memq c ruby-deep-indent-paren) | |
| 442 | ruby-deep-indent-paren-style)))) | |
| 443 | ((eq c ruby-deep-indent-paren) ruby-deep-indent-paren-style) | |
| 444 | ((eq c ?\( ) ruby-deep-arglist))) | |
| 445 | ||
| 446 | (defun ruby-parse-partial (&optional end in-string nest depth pcol indent) | |
| ee61fe97 | 447 | "TODO: document throughout function body." |
| c7fbbc3c CY |
448 | (or depth (setq depth 0)) |
| 449 | (or indent (setq indent 0)) | |
| 450 | (when (re-search-forward ruby-delimiter end 'move) | |
| 451 | (let ((pnt (point)) w re expand) | |
| 452 | (goto-char (match-beginning 0)) | |
| 453 | (cond | |
| 454 | ((and (memq (char-before) '(?@ ?$)) (looking-at "\\sw")) | |
| 455 | (goto-char pnt)) | |
| 456 | ((looking-at "[\"`]") ;skip string | |
| 457 | (cond | |
| 458 | ((and (not (eobp)) | |
| 459 | (ruby-forward-string (buffer-substring (point) (1+ (point))) end t t)) | |
| 460 | nil) | |
| 461 | (t | |
| 462 | (setq in-string (point)) | |
| 463 | (goto-char end)))) | |
| 464 | ((looking-at "'") | |
| 465 | (cond | |
| 466 | ((and (not (eobp)) | |
| 467 | (re-search-forward "[^\\]\\(\\\\\\\\\\)*'" end t)) | |
| 468 | nil) | |
| 469 | (t | |
| 470 | (setq in-string (point)) | |
| 471 | (goto-char end)))) | |
| 472 | ((looking-at "/=") | |
| 473 | (goto-char pnt)) | |
| 474 | ((looking-at "/") | |
| 475 | (cond | |
| 476 | ((and (not (eobp)) (ruby-expr-beg 'expr-re)) | |
| 477 | (if (ruby-forward-string "/" end t t) | |
| 478 | nil | |
| 479 | (setq in-string (point)) | |
| 480 | (goto-char end))) | |
| 481 | (t | |
| 482 | (goto-char pnt)))) | |
| 483 | ((looking-at "%") | |
| 484 | (cond | |
| 485 | ((and (not (eobp)) | |
| 486 | (ruby-expr-beg 'expr-qstr) | |
| 487 | (not (looking-at "%=")) | |
| 488 | (looking-at "%[QqrxWw]?\\([^a-zA-Z0-9 \t\n]\\)")) | |
| 489 | (goto-char (match-beginning 1)) | |
| 490 | (setq expand (not (memq (char-before) '(?q ?w)))) | |
| 491 | (setq w (match-string 1)) | |
| 492 | (cond | |
| 493 | ((string= w "[") (setq re "][")) | |
| 494 | ((string= w "{") (setq re "}{")) | |
| 495 | ((string= w "(") (setq re ")(")) | |
| 496 | ((string= w "<") (setq re "><")) | |
| 497 | ((and expand (string= w "\\")) | |
| 498 | (setq w (concat "\\" w)))) | |
| 499 | (unless (cond (re (ruby-forward-string re end t expand)) | |
| 500 | (expand (ruby-forward-string w end t t)) | |
| 501 | (t (re-search-forward | |
| 502 | (if (string= w "\\") | |
| 503 | "\\\\[^\\]*\\\\" | |
| 504 | (concat "[^\\]\\(\\\\\\\\\\)*" w)) | |
| 505 | end t))) | |
| 506 | (setq in-string (point)) | |
| 507 | (goto-char end))) | |
| 508 | (t | |
| 509 | (goto-char pnt)))) | |
| 510 | ((looking-at "\\?") ;skip ?char | |
| 511 | (cond | |
| 512 | ((and (ruby-expr-beg) | |
| 513 | (looking-at "?\\(\\\\C-\\|\\\\M-\\)*\\\\?.")) | |
| 514 | (goto-char (match-end 0))) | |
| 515 | (t | |
| 516 | (goto-char pnt)))) | |
| 517 | ((looking-at "\\$") ;skip $char | |
| 518 | (goto-char pnt) | |
| 519 | (forward-char 1)) | |
| 520 | ((looking-at "#") ;skip comment | |
| 521 | (forward-line 1) | |
| 522 | (goto-char (point)) | |
| 523 | ) | |
| 524 | ((looking-at "[\\[{(]") | |
| 525 | (let ((deep (ruby-deep-indent-paren-p (char-after)))) | |
| 526 | (if (and deep (or (not (eq (char-after) ?\{)) (ruby-expr-beg))) | |
| 527 | (progn | |
| 528 | (and (eq deep 'space) (looking-at ".\\s +[^# \t\n]") | |
| 529 | (setq pnt (1- (match-end 0)))) | |
| 530 | (setq nest (cons (cons (char-after (point)) pnt) nest)) | |
| 531 | (setq pcol (cons (cons pnt depth) pcol)) | |
| 532 | (setq depth 0)) | |
| 533 | (setq nest (cons (cons (char-after (point)) pnt) nest)) | |
| 534 | (setq depth (1+ depth)))) | |
| 535 | (goto-char pnt) | |
| 536 | ) | |
| 537 | ((looking-at "[])}]") | |
| 538 | (if (ruby-deep-indent-paren-p (matching-paren (char-after))) | |
| 539 | (setq depth (cdr (car pcol)) pcol (cdr pcol)) | |
| 540 | (setq depth (1- depth))) | |
| 541 | (setq nest (cdr nest)) | |
| 542 | (goto-char pnt)) | |
| 543 | ((looking-at ruby-block-end-re) | |
| 544 | (if (or (and (not (bolp)) | |
| 545 | (progn | |
| 546 | (forward-char -1) | |
| 547 | (setq w (char-after (point))) | |
| 548 | (or (eq ?_ w) | |
| 549 | (eq ?. w)))) | |
| 550 | (progn | |
| 551 | (goto-char pnt) | |
| 552 | (setq w (char-after (point))) | |
| 553 | (or (eq ?_ w) | |
| 554 | (eq ?! w) | |
| 555 | (eq ?? w)))) | |
| 556 | nil | |
| 557 | (setq nest (cdr nest)) | |
| 558 | (setq depth (1- depth))) | |
| 559 | (goto-char pnt)) | |
| 560 | ((looking-at "def\\s +[^(\n;]*") | |
| 561 | (if (or (bolp) | |
| 562 | (progn | |
| 563 | (forward-char -1) | |
| 564 | (not (eq ?_ (char-after (point)))))) | |
| 565 | (progn | |
| 566 | (setq nest (cons (cons nil pnt) nest)) | |
| 567 | (setq depth (1+ depth)))) | |
| 568 | (goto-char (match-end 0))) | |
| 39675016 | 569 | ((looking-at (concat "\\_<\\(" ruby-block-beg-re "\\)\\_>")) |
| c7fbbc3c CY |
570 | (and |
| 571 | (save-match-data | |
| 572 | (or (not (looking-at (concat "do" ruby-keyword-end-re))) | |
| 573 | (save-excursion | |
| 574 | (back-to-indentation) | |
| 575 | (not (looking-at ruby-non-block-do-re))))) | |
| 576 | (or (bolp) | |
| 577 | (progn | |
| 578 | (forward-char -1) | |
| 579 | (setq w (char-after (point))) | |
| 580 | (not (or (eq ?_ w) | |
| 581 | (eq ?. w))))) | |
| 582 | (goto-char pnt) | |
| 583 | (setq w (char-after (point))) | |
| 584 | (not (eq ?_ w)) | |
| 585 | (not (eq ?! w)) | |
| 586 | (not (eq ?? w)) | |
| 587 | (skip-chars-forward " \t") | |
| 588 | (goto-char (match-beginning 0)) | |
| 589 | (or (not (looking-at ruby-modifier-re)) | |
| 590 | (ruby-expr-beg 'modifier)) | |
| 591 | (goto-char pnt) | |
| 592 | (setq nest (cons (cons nil pnt) nest)) | |
| 593 | (setq depth (1+ depth))) | |
| 594 | (goto-char pnt)) | |
| 595 | ((looking-at ":\\(['\"]\\)") | |
| 596 | (goto-char (match-beginning 1)) | |
| 597 | (ruby-forward-string (buffer-substring (match-beginning 1) (match-end 1)) end)) | |
| 11473529 | 598 | ((looking-at ":\\([-,.+*/%&|^~<>]=?\\|===?\\|<=>\\|![~=]?\\)") |
| c7fbbc3c CY |
599 | (goto-char (match-end 0))) |
| 600 | ((looking-at ":\\([a-zA-Z_][a-zA-Z_0-9]*[!?=]?\\)?") | |
| 601 | (goto-char (match-end 0))) | |
| 602 | ((or (looking-at "\\.\\.\\.?") | |
| 603 | (looking-at "\\.[0-9]+") | |
| 604 | (looking-at "\\.[a-zA-Z_0-9]+") | |
| 605 | (looking-at "\\.")) | |
| 606 | (goto-char (match-end 0))) | |
| 607 | ((looking-at "^=begin") | |
| 608 | (if (re-search-forward "^=end" end t) | |
| 609 | (forward-line 1) | |
| 610 | (setq in-string (match-end 0)) | |
| 611 | (goto-char end))) | |
| 612 | ((looking-at "<<") | |
| 613 | (cond | |
| 614 | ((and (ruby-expr-beg 'heredoc) | |
| 615 | (looking-at "<<\\(-\\)?\\(\\([\"'`]\\)\\([^\n]+?\\)\\3\\|\\(?:\\sw\\|\\s_\\)+\\)")) | |
| 616 | (setq re (regexp-quote (or (match-string 4) (match-string 2)))) | |
| 617 | (if (match-beginning 1) (setq re (concat "\\s *" re))) | |
| 618 | (let* ((id-end (goto-char (match-end 0))) | |
| e180ab9f | 619 | (line-end-position (point-at-eol)) |
| c7fbbc3c CY |
620 | (state (list in-string nest depth pcol indent))) |
| 621 | ;; parse the rest of the line | |
| 622 | (while (and (> line-end-position (point)) | |
| 623 | (setq state (apply 'ruby-parse-partial | |
| 624 | line-end-position state)))) | |
| 625 | (setq in-string (car state) | |
| 626 | nest (nth 1 state) | |
| 627 | depth (nth 2 state) | |
| 628 | pcol (nth 3 state) | |
| 629 | indent (nth 4 state)) | |
| 630 | ;; skip heredoc section | |
| 631 | (if (re-search-forward (concat "^" re "$") end 'move) | |
| 632 | (forward-line 1) | |
| 633 | (setq in-string id-end) | |
| 634 | (goto-char end)))) | |
| 635 | (t | |
| 636 | (goto-char pnt)))) | |
| 637 | ((looking-at "^__END__$") | |
| 638 | (goto-char pnt)) | |
| 639 | ((and (looking-at ruby-here-doc-beg-re) | |
| 640 | (boundp 'ruby-indent-point)) | |
| 641 | (if (re-search-forward (ruby-here-doc-end-match) | |
| 642 | ruby-indent-point t) | |
| 643 | (forward-line 1) | |
| 644 | (setq in-string (match-end 0)) | |
| 645 | (goto-char ruby-indent-point))) | |
| 646 | (t | |
| 647 | (error (format "bad string %s" | |
| 648 | (buffer-substring (point) pnt) | |
| 649 | )))))) | |
| 650 | (list in-string nest depth pcol)) | |
| 651 | ||
| 652 | (defun ruby-parse-region (start end) | |
| 653 | "TODO: document." | |
| 654 | (let (state) | |
| 655 | (save-excursion | |
| 656 | (if start | |
| 657 | (goto-char start) | |
| 658 | (ruby-beginning-of-indent)) | |
| 659 | (save-restriction | |
| 660 | (narrow-to-region (point) end) | |
| 661 | (while (and (> end (point)) | |
| 662 | (setq state (apply 'ruby-parse-partial end state)))))) | |
| 663 | (list (nth 0 state) ; in-string | |
| 664 | (car (nth 1 state)) ; nest | |
| 665 | (nth 2 state) ; depth | |
| 666 | (car (car (nth 3 state))) ; pcol | |
| 667 | ;(car (nth 5 state)) ; indent | |
| 668 | ))) | |
| 669 | ||
| 670 | (defun ruby-indent-size (pos nest) | |
| ee61fe97 | 671 | "Return the indentation level in spaces NEST levels deeper than POS." |
| c7fbbc3c CY |
672 | (+ pos (* (or nest 1) ruby-indent-level))) |
| 673 | ||
| 674 | (defun ruby-calculate-indent (&optional parse-start) | |
| ee61fe97 | 675 | "Return the proper indentation level of the current line." |
| c7fbbc3c CY |
676 | ;; TODO: Document body |
| 677 | (save-excursion | |
| 678 | (beginning-of-line) | |
| 679 | (let ((ruby-indent-point (point)) | |
| 680 | (case-fold-search nil) | |
| cf38dd42 | 681 | state eol begin op-end |
| c7fbbc3c CY |
682 | (paren (progn (skip-syntax-forward " ") |
| 683 | (and (char-after) (matching-paren (char-after))))) | |
| 684 | (indent 0)) | |
| 685 | (if parse-start | |
| 686 | (goto-char parse-start) | |
| 687 | (ruby-beginning-of-indent) | |
| 688 | (setq parse-start (point))) | |
| 689 | (back-to-indentation) | |
| 690 | (setq indent (current-column)) | |
| 691 | (setq state (ruby-parse-region parse-start ruby-indent-point)) | |
| 692 | (cond | |
| 693 | ((nth 0 state) ; within string | |
| 694 | (setq indent nil)) ; do nothing | |
| 695 | ((car (nth 1 state)) ; in paren | |
| 696 | (goto-char (setq begin (cdr (nth 1 state)))) | |
| 697 | (let ((deep (ruby-deep-indent-paren-p (car (nth 1 state))))) | |
| 698 | (if deep | |
| 699 | (cond ((and (eq deep t) (eq (car (nth 1 state)) paren)) | |
| 700 | (skip-syntax-backward " ") | |
| 701 | (setq indent (1- (current-column)))) | |
| 702 | ((let ((s (ruby-parse-region (point) ruby-indent-point))) | |
| 703 | (and (nth 2 s) (> (nth 2 s) 0) | |
| 704 | (or (goto-char (cdr (nth 1 s))) t))) | |
| 705 | (forward-word -1) | |
| 706 | (setq indent (ruby-indent-size (current-column) | |
| 707 | (nth 2 state)))) | |
| 708 | (t | |
| 709 | (setq indent (current-column)) | |
| 710 | (cond ((eq deep 'space)) | |
| 711 | (paren (setq indent (1- indent))) | |
| 712 | (t (setq indent (ruby-indent-size (1- indent) 1)))))) | |
| 713 | (if (nth 3 state) (goto-char (nth 3 state)) | |
| 714 | (goto-char parse-start) (back-to-indentation)) | |
| 715 | (setq indent (ruby-indent-size (current-column) (nth 2 state)))) | |
| 716 | (and (eq (car (nth 1 state)) paren) | |
| 717 | (ruby-deep-indent-paren-p (matching-paren paren)) | |
| 718 | (search-backward (char-to-string paren)) | |
| 719 | (setq indent (current-column))))) | |
| 720 | ((and (nth 2 state) (> (nth 2 state) 0)) ; in nest | |
| 721 | (if (null (cdr (nth 1 state))) | |
| 722 | (error "invalid nest")) | |
| 723 | (goto-char (cdr (nth 1 state))) | |
| 724 | (forward-word -1) ; skip back a keyword | |
| 725 | (setq begin (point)) | |
| 726 | (cond | |
| 727 | ((looking-at "do\\>[^_]") ; iter block is a special case | |
| 728 | (if (nth 3 state) (goto-char (nth 3 state)) | |
| 729 | (goto-char parse-start) (back-to-indentation)) | |
| 730 | (setq indent (ruby-indent-size (current-column) (nth 2 state)))) | |
| 731 | (t | |
| 732 | (setq indent (+ (current-column) ruby-indent-level))))) | |
| ee61fe97 | 733 | |
| c7fbbc3c CY |
734 | ((and (nth 2 state) (< (nth 2 state) 0)) ; in negative nest |
| 735 | (setq indent (ruby-indent-size (current-column) (nth 2 state))))) | |
| 736 | (when indent | |
| 737 | (goto-char ruby-indent-point) | |
| 738 | (end-of-line) | |
| 739 | (setq eol (point)) | |
| 740 | (beginning-of-line) | |
| 741 | (cond | |
| 742 | ((and (not (ruby-deep-indent-paren-p paren)) | |
| 743 | (re-search-forward ruby-negative eol t)) | |
| 744 | (and (not (eq ?_ (char-after (match-end 0)))) | |
| 745 | (setq indent (- indent ruby-indent-level)))) | |
| 746 | ((and | |
| 747 | (save-excursion | |
| 748 | (beginning-of-line) | |
| 749 | (not (bobp))) | |
| 750 | (or (ruby-deep-indent-paren-p t) | |
| 751 | (null (car (nth 1 state))))) | |
| 752 | ;; goto beginning of non-empty no-comment line | |
| 753 | (let (end done) | |
| 754 | (while (not done) | |
| 755 | (skip-chars-backward " \t\n") | |
| 756 | (setq end (point)) | |
| 757 | (beginning-of-line) | |
| 758 | (if (re-search-forward "^\\s *#" end t) | |
| 759 | (beginning-of-line) | |
| 760 | (setq done t)))) | |
| c7fbbc3c CY |
761 | (end-of-line) |
| 762 | ;; skip the comment at the end | |
| 763 | (skip-chars-backward " \t") | |
| 764 | (let (end (pos (point))) | |
| 765 | (beginning-of-line) | |
| 766 | (while (and (re-search-forward "#" pos t) | |
| 767 | (setq end (1- (point))) | |
| 768 | (or (ruby-special-char-p end) | |
| 769 | (and (setq state (ruby-parse-region parse-start end)) | |
| 770 | (nth 0 state)))) | |
| 771 | (setq end nil)) | |
| 772 | (goto-char (or end pos)) | |
| 773 | (skip-chars-backward " \t") | |
| 774 | (setq begin (if (and end (nth 0 state)) pos (cdr (nth 1 state)))) | |
| 775 | (setq state (ruby-parse-region parse-start (point)))) | |
| 776 | (or (bobp) (forward-char -1)) | |
| 777 | (and | |
| 778 | (or (and (looking-at ruby-symbol-re) | |
| 779 | (skip-chars-backward ruby-symbol-chars) | |
| 780 | (looking-at (concat "\\<\\(" ruby-block-hanging-re "\\)\\>")) | |
| 781 | (not (eq (point) (nth 3 state))) | |
| 782 | (save-excursion | |
| 783 | (goto-char (match-end 0)) | |
| 784 | (not (looking-at "[a-z_]")))) | |
| 785 | (and (looking-at ruby-operator-re) | |
| 786 | (not (ruby-special-char-p)) | |
| 787 | ;; operator at the end of line | |
| 788 | (let ((c (char-after (point)))) | |
| 789 | (and | |
| 790 | ;; (or (null begin) | |
| 791 | ;; (save-excursion | |
| 792 | ;; (goto-char begin) | |
| 793 | ;; (skip-chars-forward " \t") | |
| 794 | ;; (not (or (eolp) (looking-at "#") | |
| 795 | ;; (and (eq (car (nth 1 state)) ?{) | |
| 796 | ;; (looking-at "|")))))) | |
| 85222d44 DG |
797 | ;; not a regexp or general delimited literal |
| 798 | (null (nth 0 (ruby-parse-region (or begin parse-start) (point)))) | |
| c7fbbc3c CY |
799 | (or (not (eq ?| (char-after (point)))) |
| 800 | (save-excursion | |
| 801 | (or (eolp) (forward-char -1)) | |
| 802 | (cond | |
| 803 | ((search-backward "|" nil t) | |
| 804 | (skip-chars-backward " \t\n") | |
| 805 | (and (not (eolp)) | |
| 806 | (progn | |
| 807 | (forward-char -1) | |
| 808 | (not (looking-at "{"))) | |
| 809 | (progn | |
| 810 | (forward-word -1) | |
| 811 | (not (looking-at "do\\>[^_]"))))) | |
| 812 | (t t)))) | |
| 813 | (not (eq ?, c)) | |
| 814 | (setq op-end t))))) | |
| 815 | (setq indent | |
| 816 | (cond | |
| 817 | ((and | |
| 818 | (null op-end) | |
| 819 | (not (looking-at (concat "\\<\\(" ruby-block-hanging-re "\\)\\>"))) | |
| 820 | (eq (ruby-deep-indent-paren-p t) 'space) | |
| 821 | (not (bobp))) | |
| 822 | (widen) | |
| 823 | (goto-char (or begin parse-start)) | |
| 824 | (skip-syntax-forward " ") | |
| 825 | (current-column)) | |
| 826 | ((car (nth 1 state)) indent) | |
| 827 | (t | |
| 828 | (+ indent ruby-indent-level)))))))) | |
| 829 | (goto-char ruby-indent-point) | |
| 830 | (beginning-of-line) | |
| 831 | (skip-syntax-forward " ") | |
| 832 | (if (looking-at "\\.[^.]") | |
| 833 | (+ indent ruby-indent-level) | |
| 834 | indent)))) | |
| 835 | ||
| 836 | (defun ruby-electric-brace (arg) | |
| ee61fe97 | 837 | "Insert a brace and re-indent the current line." |
| c7fbbc3c CY |
838 | (interactive "P") |
| 839 | (self-insert-command (prefix-numeric-value arg)) | |
| 840 | (ruby-indent-line t)) | |
| 841 | ||
| 842 | ;; TODO: Why isn't one ruby-*-of-defun written in terms of the other? | |
| 843 | (defun ruby-beginning-of-defun (&optional arg) | |
| 844 | "Move backward to the beginning of the current top-level defun. | |
| ee61fe97 | 845 | With ARG, move backward multiple defuns. Negative ARG means |
| c7fbbc3c CY |
846 | move forward." |
| 847 | (interactive "p") | |
| 848 | (and (re-search-backward (concat "^\\(" ruby-block-beg-re "\\)\\b") | |
| 849 | nil 'move (or arg 1)) | |
| 850 | (beginning-of-line))) | |
| 851 | ||
| 852 | (defun ruby-end-of-defun (&optional arg) | |
| 853 | "Move forward to the end of the current top-level defun. | |
| ee61fe97 | 854 | With ARG, move forward multiple defuns. Negative ARG means |
| c7fbbc3c CY |
855 | move backward." |
| 856 | (interactive "p") | |
| 857 | (and (re-search-forward (concat "^\\(" ruby-block-end-re "\\)\\($\\|\\b[^_]\\)") | |
| 858 | nil 'move (or arg 1)) | |
| 859 | (beginning-of-line)) | |
| 860 | (forward-line 1)) | |
| 861 | ||
| 862 | (defun ruby-beginning-of-indent () | |
| 863 | "TODO: document" | |
| 864 | ;; I don't understand this function. | |
| 865 | ;; It seems like it should move to the line where indentation should deepen, | |
| 866 | ;; but ruby-indent-beg-re only accounts for whitespace before class, module and def, | |
| 867 | ;; so this will only match other block beginners at the beginning of the line. | |
| 39675016 | 868 | (and (re-search-backward (concat "^\\(" ruby-indent-beg-re "\\)\\_>") nil 'move) |
| c7fbbc3c CY |
869 | (beginning-of-line))) |
| 870 | ||
| 871 | (defun ruby-move-to-block (n) | |
| ee61fe97 | 872 | "Move to the beginning (N < 0) or the end (N > 0) of the current block |
| c7fbbc3c CY |
873 | or blocks containing the current block." |
| 874 | ;; TODO: Make this work for n > 1, | |
| 875 | ;; make it not loop for n = 0, | |
| 876 | ;; document body | |
| 877 | (let (start pos done down) | |
| 878 | (setq start (ruby-calculate-indent)) | |
| 879 | (setq down (looking-at (if (< n 0) ruby-block-end-re | |
| 880 | (concat "\\<\\(" ruby-block-beg-re "\\)\\>")))) | |
| 881 | (while (and (not done) (not (if (< n 0) (bobp) (eobp)))) | |
| 882 | (forward-line n) | |
| 883 | (cond | |
| 884 | ((looking-at "^\\s *$")) | |
| 885 | ((looking-at "^\\s *#")) | |
| 886 | ((and (> n 0) (looking-at "^=begin\\>")) | |
| 887 | (re-search-forward "^=end\\>")) | |
| 888 | ((and (< n 0) (looking-at "^=end\\>")) | |
| 889 | (re-search-backward "^=begin\\>")) | |
| 890 | (t | |
| 891 | (setq pos (current-indentation)) | |
| 892 | (cond | |
| 893 | ((< start pos) | |
| 894 | (setq down t)) | |
| 895 | ((and down (= pos start)) | |
| 896 | (setq done t)) | |
| 897 | ((> start pos) | |
| 898 | (setq done t))))) | |
| 899 | (if done | |
| 900 | (save-excursion | |
| 901 | (back-to-indentation) | |
| 902 | (if (looking-at (concat "\\<\\(" ruby-block-mid-re "\\)\\>")) | |
| 903 | (setq done nil)))))) | |
| 904 | (back-to-indentation)) | |
| 905 | ||
| 906 | (defun ruby-beginning-of-block (&optional arg) | |
| 907 | "Move backward to the beginning of the current block. | |
| 908 | With ARG, move up multiple blocks." | |
| 909 | (interactive "p") | |
| 910 | (ruby-move-to-block (- (or arg 1)))) | |
| 911 | ||
| 912 | (defun ruby-end-of-block (&optional arg) | |
| 913 | "Move forward to the end of the current block. | |
| 914 | With ARG, move out of multiple blocks." | |
| 915 | ;; Passing a value > 1 to ruby-move-to-block currently doesn't work. | |
| 916 | (interactive) | |
| 917 | (ruby-move-to-block (or arg 1))) | |
| 918 | ||
| 919 | (defun ruby-forward-sexp (&optional arg) | |
| 920 | "Move forward across one balanced expression (sexp). | |
| ee61fe97 | 921 | With ARG, do it many times. Negative ARG means move backward." |
| c7fbbc3c CY |
922 | ;; TODO: Document body |
| 923 | (interactive "p") | |
| 924 | (if (and (numberp arg) (< arg 0)) | |
| 925 | (ruby-backward-sexp (- arg)) | |
| 926 | (let ((i (or arg 1))) | |
| 927 | (condition-case nil | |
| 928 | (while (> i 0) | |
| 929 | (skip-syntax-forward " ") | |
| cc9c9831 | 930 | (if (looking-at ",\\s *") (goto-char (match-end 0))) |
| c7fbbc3c CY |
931 | (cond ((looking-at "\\?\\(\\\\[CM]-\\)*\\\\?\\S ") |
| 932 | (goto-char (match-end 0))) | |
| 933 | ((progn | |
| 934 | (skip-chars-forward ",.:;|&^~=!?\\+\\-\\*") | |
| 935 | (looking-at "\\s(")) | |
| 936 | (goto-char (scan-sexps (point) 1))) | |
| 937 | ((and (looking-at (concat "\\<\\(" ruby-block-beg-re "\\)\\>")) | |
| 938 | (not (eq (char-before (point)) ?.)) | |
| 939 | (not (eq (char-before (point)) ?:))) | |
| 940 | (ruby-end-of-block) | |
| 941 | (forward-word 1)) | |
| 942 | ((looking-at "\\(\\$\\|@@?\\)?\\sw") | |
| 943 | (while (progn | |
| 944 | (while (progn (forward-word 1) (looking-at "_"))) | |
| 945 | (cond ((looking-at "::") (forward-char 2) t) | |
| 946 | ((> (skip-chars-forward ".") 0)) | |
| 947 | ((looking-at "\\?\\|!\\(=[~=>]\\|[^~=]\\)") | |
| 948 | (forward-char 1) nil))))) | |
| 949 | ((let (state expr) | |
| 950 | (while | |
| 951 | (progn | |
| 952 | (setq expr (or expr (ruby-expr-beg) | |
| 953 | (looking-at "%\\sw?\\Sw\\|[\"'`/]"))) | |
| 954 | (nth 1 (setq state (apply 'ruby-parse-partial nil state)))) | |
| 955 | (setq expr t) | |
| 956 | (skip-chars-forward "<")) | |
| 957 | (not expr)))) | |
| 958 | (setq i (1- i))) | |
| 959 | ((error) (forward-word 1))) | |
| 960 | i))) | |
| 961 | ||
| 962 | (defun ruby-backward-sexp (&optional arg) | |
| 963 | "Move backward across one balanced expression (sexp). | |
| ee61fe97 | 964 | With ARG, do it many times. Negative ARG means move forward." |
| c7fbbc3c CY |
965 | ;; TODO: Document body |
| 966 | (interactive "p") | |
| 967 | (if (and (numberp arg) (< arg 0)) | |
| 968 | (ruby-forward-sexp (- arg)) | |
| 969 | (let ((i (or arg 1))) | |
| 970 | (condition-case nil | |
| 971 | (while (> i 0) | |
| 972 | (skip-chars-backward " \t\n,.:;|&^~=!?\\+\\-\\*") | |
| 973 | (forward-char -1) | |
| 974 | (cond ((looking-at "\\s)") | |
| 975 | (goto-char (scan-sexps (1+ (point)) -1)) | |
| 976 | (case (char-before) | |
| 977 | (?% (forward-char -1)) | |
| 0adf5618 | 978 | ((?q ?Q ?w ?W ?r ?x) |
| c7fbbc3c CY |
979 | (if (eq (char-before (1- (point))) ?%) (forward-char -2)))) |
| 980 | nil) | |
| 981 | ((looking-at "\\s\"\\|\\\\\\S_") | |
| 982 | (let ((c (char-to-string (char-before (match-end 0))))) | |
| 983 | (while (and (search-backward c) | |
| 984 | (eq (logand (skip-chars-backward "\\") 1) | |
| 985 | 1)))) | |
| 986 | nil) | |
| 987 | ((looking-at "\\s.\\|\\s\\") | |
| 988 | (if (ruby-special-char-p) (forward-char -1))) | |
| 989 | ((looking-at "\\s(") nil) | |
| 990 | (t | |
| 991 | (forward-char 1) | |
| 992 | (while (progn (forward-word -1) | |
| 993 | (case (char-before) | |
| 994 | (?_ t) | |
| 995 | (?. (forward-char -1) t) | |
| 996 | ((?$ ?@) | |
| 997 | (forward-char -1) | |
| 998 | (and (eq (char-before) (char-after)) (forward-char -1))) | |
| 999 | (?: | |
| 1000 | (forward-char -1) | |
| 1001 | (eq (char-before) :))))) | |
| 1002 | (if (looking-at ruby-block-end-re) | |
| 1003 | (ruby-beginning-of-block)) | |
| 1004 | nil)) | |
| 1005 | (setq i (1- i))) | |
| 1006 | ((error))) | |
| 1007 | i))) | |
| 1008 | ||
| 1009 | (defun ruby-mark-defun () | |
| 1010 | "Put mark at end of this Ruby function, point at beginning." | |
| 1011 | (interactive) | |
| 1012 | (push-mark (point)) | |
| 1013 | (ruby-end-of-defun) | |
| 1014 | (push-mark (point) nil t) | |
| 1015 | (ruby-beginning-of-defun) | |
| 1016 | (re-search-backward "^\n" (- (point) 1) t)) | |
| 1017 | ||
| cf38dd42 SM |
1018 | (defun ruby-indent-exp (&optional ignored) |
| 1019 | "Indent each line in the balanced expression following the point." | |
| c7fbbc3c CY |
1020 | (interactive "*P") |
| 1021 | (let ((here (point-marker)) start top column (nest t)) | |
| 1022 | (set-marker-insertion-type here t) | |
| 1023 | (unwind-protect | |
| 1024 | (progn | |
| 1025 | (beginning-of-line) | |
| 1026 | (setq start (point) top (current-indentation)) | |
| 1027 | (while (and (not (eobp)) | |
| 1028 | (progn | |
| 1029 | (setq column (ruby-calculate-indent start)) | |
| 1030 | (cond ((> column top) | |
| 1031 | (setq nest t)) | |
| 1032 | ((and (= column top) nest) | |
| 1033 | (setq nest nil) t)))) | |
| 1034 | (ruby-indent-to column) | |
| 1035 | (beginning-of-line 2))) | |
| 1036 | (goto-char here) | |
| 1037 | (set-marker here nil)))) | |
| 1038 | ||
| 1039 | (defun ruby-add-log-current-method () | |
| ee61fe97 | 1040 | "Return the current method name as a string. |
| c7fbbc3c CY |
1041 | This string includes all namespaces. |
| 1042 | ||
| 1043 | For example: | |
| 1044 | ||
| 1045 | #exit | |
| 1046 | String#gsub | |
| 1047 | Net::HTTP#active? | |
| 1048 | File::open. | |
| 1049 | ||
| 1050 | See `add-log-current-defun-function'." | |
| 1051 | ;; TODO: Document body | |
| 1052 | ;; Why does this append a period to class methods? | |
| 1053 | (condition-case nil | |
| 1054 | (save-excursion | |
| 1055 | (let (mname mlist (indent 0)) | |
| 1056 | ;; get current method (or class/module) | |
| 1057 | (if (re-search-backward | |
| 1058 | (concat "^[ \t]*\\(def\\|class\\|module\\)[ \t]+" | |
| 1059 | "\\(" | |
| 1060 | ;; \\. and :: for class method | |
| 1061 | "\\([A-Za-z_]" ruby-symbol-re "*\\|\\.\\|::" "\\)" | |
| 1062 | "+\\)") | |
| 1063 | nil t) | |
| 1064 | (progn | |
| 1065 | (setq mname (match-string 2)) | |
| 1066 | (unless (string-equal "def" (match-string 1)) | |
| 1067 | (setq mlist (list mname) mname nil)) | |
| 1068 | (goto-char (match-beginning 1)) | |
| 1069 | (setq indent (current-column)) | |
| 1070 | (beginning-of-line))) | |
| 1071 | ;; nest class/module | |
| 1072 | (while (and (> indent 0) | |
| 1073 | (re-search-backward | |
| 1074 | (concat | |
| 1075 | "^[ \t]*\\(class\\|module\\)[ \t]+" | |
| 1076 | "\\([A-Z]" ruby-symbol-re "*\\)") | |
| 1077 | nil t)) | |
| 1078 | (goto-char (match-beginning 1)) | |
| 1079 | (if (< (current-column) indent) | |
| 1080 | (progn | |
| 1081 | (setq mlist (cons (match-string 2) mlist)) | |
| 1082 | (setq indent (current-column)) | |
| 1083 | (beginning-of-line)))) | |
| 1084 | (when mname | |
| 1085 | (let ((mn (split-string mname "\\.\\|::"))) | |
| 1086 | (if (cdr mn) | |
| 1087 | (progn | |
| 1088 | (cond | |
| 1089 | ((string-equal "" (car mn)) | |
| 1090 | (setq mn (cdr mn) mlist nil)) | |
| 1091 | ((string-equal "self" (car mn)) | |
| 1092 | (setq mn (cdr mn))) | |
| 1093 | ((let ((ml (nreverse mlist))) | |
| 1094 | (while ml | |
| 1095 | (if (string-equal (car ml) (car mn)) | |
| 1096 | (setq mlist (nreverse (cdr ml)) ml nil)) | |
| 1097 | (or (setq ml (cdr ml)) (nreverse mlist)))))) | |
| 1098 | (if mlist | |
| 1099 | (setcdr (last mlist) mn) | |
| 1100 | (setq mlist mn)) | |
| 1101 | (setq mn (last mn 2)) | |
| 1102 | (setq mname (concat "." (cadr mn))) | |
| 1103 | (setcdr mn nil)) | |
| 1104 | (setq mname (concat "#" mname))))) | |
| 1105 | ;; generate string | |
| 1106 | (if (consp mlist) | |
| 1107 | (setq mlist (mapconcat (function identity) mlist "::"))) | |
| 1108 | (if mname | |
| 1109 | (if mlist (concat mlist mname) mname) | |
| 1110 | mlist))))) | |
| 1111 | ||
| f4ff702e GM |
1112 | (declare-function ruby-syntax-propertize-heredoc "ruby-mode" (limit)) |
| 1113 | ||
| cf38dd42 SM |
1114 | (if (eval-when-compile (fboundp #'syntax-propertize-rules)) |
| 1115 | ;; New code that works independently from font-lock. | |
| 1116 | (progn | |
| 1117 | (defun ruby-syntax-propertize-function (start end) | |
| 1118 | "Syntactic keywords for Ruby mode. See `syntax-propertize-function'." | |
| 1119 | (goto-char start) | |
| 1120 | (ruby-syntax-propertize-heredoc end) | |
| 85222d44 | 1121 | (ruby-syntax-general-delimiters-goto-beg) |
| cf38dd42 SM |
1122 | (funcall |
| 1123 | (syntax-propertize-rules | |
| 1124 | ;; #{ }, #$hoge, #@foo are not comments | |
| 1125 | ("\\(#\\)[{$@]" (1 ".")) | |
| cf38dd42 SM |
1126 | ;; $' $" $` .... are variables |
| 1127 | ;; ?' ?" ?` are ascii codes | |
| 21bb5ce0 SM |
1128 | ("\\([?$]\\)[#\"'`]" |
| 1129 | (1 (unless (save-excursion | |
| 1130 | ;; Not within a string. | |
| 1131 | (nth 3 (syntax-ppss (match-beginning 0)))) | |
| 1132 | (string-to-syntax "\\")))) | |
| cf38dd42 | 1133 | ;; regexps |
| 89fdaac7 | 1134 | ("\\(^\\|[[=(,~?:;<>]\\|\\(^\\|\\s \\)\\(if\\|elsif\\|unless\\|while\\|until\\|when\\|and\\|or\\|&&\\|||\\)\\|g?sub!?\\|scan\\|split!?\\)\\s *\\(/\\)[^/\n\\\\]*\\(\\\\.[^/\n\\\\]*\\)*\\(/\\)" |
| cf38dd42 SM |
1135 | (4 "\"/") |
| 1136 | (6 "\"/")) | |
| 1137 | ("^=en\\(d\\)\\_>" (1 "!")) | |
| 1138 | ("^\\(=\\)begin\\_>" (1 "!")) | |
| 1139 | ;; Handle here documents. | |
| 1140 | ((concat ruby-here-doc-beg-re ".*\\(\n\\)") | |
| 85222d44 DG |
1141 | (7 (prog1 "\"" (ruby-syntax-propertize-heredoc end)))) |
| 1142 | ;; Handle percent literals: %w(), %q{}, etc. | |
| 1143 | ("\\(?:^\\|[[ \t\n<+(,=]\\)\\(%\\)[qQrswWx]?\\([[:punct:]]\\)" | |
| 1144 | (1 (prog1 "|" (ruby-syntax-propertize-general-delimiters end))))) | |
| cf38dd42 SM |
1145 | (point) end)) |
| 1146 | ||
| 1147 | (defun ruby-syntax-propertize-heredoc (limit) | |
| 1148 | (let ((ppss (syntax-ppss)) | |
| 1149 | (res '())) | |
| 1150 | (when (eq ?\n (nth 3 ppss)) | |
| 1151 | (save-excursion | |
| 1152 | (goto-char (nth 8 ppss)) | |
| 1153 | (beginning-of-line) | |
| 1154 | (while (re-search-forward ruby-here-doc-beg-re | |
| 1155 | (line-end-position) t) | |
| 1156 | (push (concat (ruby-here-doc-end-match) "\n") res))) | |
| 1157 | (let ((start (point))) | |
| 1158 | ;; With multiple openers on the same line, we don't know in which | |
| 1159 | ;; part `start' is, so we have to go back to the beginning. | |
| 1160 | (when (cdr res) | |
| 1161 | (goto-char (nth 8 ppss)) | |
| 1162 | (setq res (nreverse res))) | |
| 1163 | (while (and res (re-search-forward (pop res) limit 'move)) | |
| 1164 | (if (null res) | |
| 1165 | (put-text-property (1- (point)) (point) | |
| 1166 | 'syntax-table (string-to-syntax "\"")))) | |
| 1167 | ;; Make extra sure we don't move back, lest we could fall into an | |
| 1168 | ;; inf-loop. | |
| 1169 | (if (< (point) start) (goto-char start)))))) | |
| 85222d44 DG |
1170 | |
| 1171 | (defun ruby-syntax-general-delimiters-goto-beg () | |
| 1172 | (let ((state (syntax-ppss))) | |
| 1173 | ;; Move to the start of the literal, in case it's multiline. | |
| 1174 | ;; TODO: determine the literal type more reliably here? | |
| 1175 | (when (eq t (nth 3 state)) | |
| 1176 | (goto-char (nth 8 state)) | |
| 1177 | (beginning-of-line)))) | |
| 1178 | ||
| 1179 | (defun ruby-syntax-propertize-general-delimiters (limit) | |
| 1180 | (goto-char (match-beginning 2)) | |
| 1181 | (let* ((op (char-after)) | |
| 1182 | (ops (char-to-string op)) | |
| 1183 | (cl (or (cdr (aref (syntax-table) op)) | |
| 1184 | (cdr (assoc op '((?< . ?>)))))) | |
| 1185 | parse-sexp-lookup-properties) | |
| 1186 | (ignore-errors | |
| 1187 | (if cl | |
| 1188 | (progn ; paired delimiters | |
| 1189 | ;; Delimiter pairs of the same kind can be nested | |
| 1190 | ;; inside the literal, as long as they are balanced. | |
| 1191 | ;; Create syntax table that ignores other characters. | |
| 1192 | (with-syntax-table (make-char-table 'syntax-table nil) | |
| 1193 | (modify-syntax-entry op (concat "(" (char-to-string cl))) | |
| 1194 | (modify-syntax-entry cl (concat ")" ops)) | |
| 1195 | (modify-syntax-entry ?\\ "\\") | |
| 1196 | (save-restriction | |
| 1197 | (narrow-to-region (point) limit) | |
| 1198 | (forward-list)))) ; skip to the paired character | |
| 1199 | ;; single character delimiter | |
| 1200 | (re-search-forward (concat "[^\\]\\(?:\\\\\\\\\\)*" | |
| 1201 | (regexp-quote ops)) limit nil)) | |
| 1202 | ;; if we reached here, the closing delimiter was found | |
| 1203 | (put-text-property (1- (point)) (point) | |
| 1204 | 'syntax-table (string-to-syntax "|"))))) | |
| cf38dd42 | 1205 | ) |
| f4ff702e | 1206 | |
| cf38dd42 SM |
1207 | ;; For Emacsen where syntax-propertize-rules is not (yet) available, |
| 1208 | ;; fallback on the old font-lock-syntactic-keywords stuff. | |
| 1209 | ||
| 1210 | (defconst ruby-here-doc-end-re | |
| 1211 | "^\\([ \t]+\\)?\\(.*\\)\\(\n\\)" | |
| 1212 | "Regexp to match the end of heredocs. | |
| 1213 | ||
| 1214 | This will actually match any line with one or more characters. | |
| 1215 | It's useful in that it divides up the match string so that | |
| 1216 | `ruby-here-doc-beg-match' can search for the beginning of the heredoc.") | |
| 1217 | ||
| 1218 | (defun ruby-here-doc-beg-match () | |
| 1219 | "Return a regexp to find the beginning of a heredoc. | |
| 1220 | ||
| 1221 | This should only be called after matching against `ruby-here-doc-end-re'." | |
| 06d8ace5 GM |
1222 | (let ((contents (concat |
| 1223 | (regexp-quote (concat (match-string 2) (match-string 3))) | |
| 1224 | (if (string= (match-string 3) "_") "\\B" "\\b")))) | |
| cf38dd42 SM |
1225 | (concat "<<" |
| 1226 | (let ((match (match-string 1))) | |
| 1227 | (if (and match (> (length match) 0)) | |
| 06d8ace5 GM |
1228 | (concat "\\(?:-\\([\"']?\\)\\|\\([\"']\\)" |
| 1229 | (match-string 1) "\\)" | |
| 1230 | contents "\\(\\1\\|\\2\\)") | |
| 1231 | (concat "-?\\([\"']\\|\\)" contents "\\1")))))) | |
| cf38dd42 SM |
1232 | |
| 1233 | (defconst ruby-font-lock-syntactic-keywords | |
| 1234 | `( ;; #{ }, #$hoge, #@foo are not comments | |
| c7fbbc3c CY |
1235 | ("\\(#\\)[{$@]" 1 (1 . nil)) |
| 1236 | ;; the last $', $", $` in the respective string is not variable | |
| 1237 | ;; the last ?', ?", ?` in the respective string is not ascii code | |
| 1238 | ("\\(^\\|[\[ \t\n<+\(,=]\\)\\(['\"`]\\)\\(\\\\.\\|\\2\\|[^'\"`\n\\\\]\\)*?\\\\?[?$]\\(\\2\\)" | |
| 1239 | (2 (7 . nil)) | |
| 1240 | (4 (7 . nil))) | |
| 1241 | ;; $' $" $` .... are variables | |
| 1242 | ;; ?' ?" ?` are ascii codes | |
| 1243 | ("\\(^\\|[^\\\\]\\)\\(\\\\\\\\\\)*[?$]\\([#\"'`]\\)" 3 (1 . nil)) | |
| 1244 | ;; regexps | |
| cc9c9831 | 1245 | ("\\(^\\|[[=(,~?:;<>]\\|\\(^\\|\\s \\)\\(if\\|elsif\\|unless\\|while\\|until\\|when\\|and\\|or\\|&&\\|||\\)\\|g?sub!?\\|scan\\|split!?\\)\\s *\\(/\\)[^/\n\\\\]*\\(\\\\.[^/\n\\\\]*\\)*\\(/\\)" |
| c7fbbc3c CY |
1246 | (4 (7 . ?/)) |
| 1247 | (6 (7 . ?/))) | |
| 1248 | ("^=en\\(d\\)\\_>" 1 "!") | |
| 85222d44 DG |
1249 | ;; general delimited string |
| 1250 | ("\\(^\\|[[ \t\n<+(,=]\\)\\(%[xrqQwW]?\\([^<[{(a-zA-Z0-9 \n]\\)[^\n\\\\]*\\(\\\\.[^\n\\\\]*\\)*\\(\\3\\)\\)" | |
| 1251 | (3 "\"") | |
| 1252 | (5 "\"")) | |
| c7fbbc3c CY |
1253 | ("^\\(=\\)begin\\_>" 1 (ruby-comment-beg-syntax)) |
| 1254 | ;; Currently, the following case is highlighted incorrectly: | |
| 1255 | ;; | |
| 1256 | ;; <<FOO | |
| 1257 | ;; FOO | |
| 1258 | ;; <<BAR | |
| 1259 | ;; <<BAZ | |
| 1260 | ;; BAZ | |
| 1261 | ;; BAR | |
| 1262 | ;; | |
| 1263 | ;; This is because all here-doc beginnings are highlighted before any endings, | |
| 1264 | ;; so although <<BAR is properly marked as a beginning, when we get to <<BAZ | |
| 1265 | ;; it thinks <<BAR is part of a string so it's marked as well. | |
| 1266 | ;; | |
| 1267 | ;; This may be fixable by modifying ruby-in-here-doc-p to use | |
| 1268 | ;; ruby-in-non-here-doc-string-p rather than syntax-ppss-context, | |
| 1269 | ;; but I don't want to try that until we've got unit tests set up | |
| 1270 | ;; to make sure I don't break anything else. | |
| 1271 | (,(concat ruby-here-doc-beg-re ".*\\(\n\\)") | |
| 1272 | ,(+ 1 (regexp-opt-depth ruby-here-doc-beg-re)) | |
| 1273 | (ruby-here-doc-beg-syntax)) | |
| 1274 | (,ruby-here-doc-end-re 3 (ruby-here-doc-end-syntax))) | |
| 94584c34 | 1275 | "Syntactic keywords for Ruby mode. See `font-lock-syntactic-keywords'.") |
| cf38dd42 SM |
1276 | |
| 1277 | (defun ruby-comment-beg-syntax () | |
| ee61fe97 | 1278 | "Return the syntax cell for a the first character of a =begin. |
| c7fbbc3c CY |
1279 | See the definition of `ruby-font-lock-syntactic-keywords'. |
| 1280 | ||
| 1281 | This returns a comment-delimiter cell as long as the =begin | |
| 1282 | isn't in a string or another comment." | |
| cf38dd42 SM |
1283 | (when (not (nth 3 (syntax-ppss))) |
| 1284 | (string-to-syntax "!"))) | |
| 1285 | ||
| 1286 | (defun ruby-in-here-doc-p () | |
| 1287 | "Return whether or not the point is in a heredoc." | |
| 1288 | (save-excursion | |
| 1289 | (let ((old-point (point)) (case-fold-search nil)) | |
| 1290 | (beginning-of-line) | |
| 1291 | (catch 'found-beg | |
| 1292 | (while (re-search-backward ruby-here-doc-beg-re nil t) | |
| 1293 | (if (not (or (ruby-in-ppss-context-p 'anything) | |
| 1294 | (ruby-here-doc-find-end old-point))) | |
| 1295 | (throw 'found-beg t))))))) | |
| 1296 | ||
| 1297 | (defun ruby-here-doc-find-end (&optional limit) | |
| 1298 | "Expects the point to be on a line with one or more heredoc openers. | |
| 1299 | Returns the buffer position at which all heredocs on the line | |
| 1300 | are terminated, or nil if they aren't terminated before the | |
| 1301 | buffer position `limit' or the end of the buffer." | |
| 1302 | (save-excursion | |
| 1303 | (beginning-of-line) | |
| 1304 | (catch 'done | |
| e180ab9f | 1305 | (let ((eol (point-at-eol)) |
| cf38dd42 SM |
1306 | (case-fold-search nil) |
| 1307 | ;; Fake match data such that (match-end 0) is at eol | |
| 1308 | (end-match-data (progn (looking-at ".*$") (match-data))) | |
| 1309 | beg-match-data end-re) | |
| 1310 | (while (re-search-forward ruby-here-doc-beg-re eol t) | |
| 1311 | (setq beg-match-data (match-data)) | |
| 1312 | (setq end-re (ruby-here-doc-end-match)) | |
| 1313 | ||
| 1314 | (set-match-data end-match-data) | |
| 1315 | (goto-char (match-end 0)) | |
| 1316 | (unless (re-search-forward end-re limit t) (throw 'done nil)) | |
| 1317 | (setq end-match-data (match-data)) | |
| 1318 | ||
| 1319 | (set-match-data beg-match-data) | |
| 1320 | (goto-char (match-end 0))) | |
| 1321 | (set-match-data end-match-data) | |
| 1322 | (goto-char (match-end 0)) | |
| 1323 | (point))))) | |
| 1324 | ||
| 1325 | (defun ruby-here-doc-beg-syntax () | |
| 1326 | "Return the syntax cell for a line that may begin a heredoc. | |
| 1327 | See the definition of `ruby-font-lock-syntactic-keywords'. | |
| 1328 | ||
| 1329 | This sets the syntax cell for the newline ending the line | |
| 1330 | containing the heredoc beginning so that cases where multiple | |
| 1331 | heredocs are started on one line are handled correctly." | |
| 1332 | (save-excursion | |
| 1333 | (goto-char (match-beginning 0)) | |
| 1334 | (unless (or (ruby-in-ppss-context-p 'non-heredoc) | |
| 1335 | (ruby-in-here-doc-p)) | |
| 1336 | (string-to-syntax "\"")))) | |
| 1337 | ||
| 1338 | (defun ruby-here-doc-end-syntax () | |
| 1339 | "Return the syntax cell for a line that may end a heredoc. | |
| 1340 | See the definition of `ruby-font-lock-syntactic-keywords'." | |
| 1341 | (let ((pss (syntax-ppss)) (case-fold-search nil)) | |
| 1342 | ;; If we aren't in a string, we definitely aren't ending a heredoc, | |
| 1343 | ;; so we can just give up. | |
| 1344 | ;; This means we aren't doing a full-document search | |
| 1345 | ;; every time we enter a character. | |
| 1346 | (when (ruby-in-ppss-context-p 'heredoc pss) | |
| 1347 | (save-excursion | |
| 1348 | (goto-char (nth 8 pss)) ; Go to the beginning of heredoc. | |
| 1349 | (let ((eol (point))) | |
| 1350 | (beginning-of-line) | |
| 1351 | (if (and (re-search-forward (ruby-here-doc-beg-match) eol t) ; If there is a heredoc that matches this line... | |
| 1352 | (not (ruby-in-ppss-context-p 'anything)) ; And that's not inside a heredoc/string/comment... | |
| 1353 | (progn (goto-char (match-end 0)) ; And it's the last heredoc on its line... | |
| 1354 | (not (re-search-forward ruby-here-doc-beg-re eol t)))) | |
| 1355 | (string-to-syntax "\""))))))) | |
| c7fbbc3c | 1356 | |
| cf38dd42 SM |
1357 | (unless (functionp 'syntax-ppss) |
| 1358 | (defun syntax-ppss (&optional pos) | |
| 1359 | (parse-partial-sexp (point-min) (or pos (point))))) | |
| 1360 | ) | |
| c7fbbc3c CY |
1361 | |
| 1362 | (defun ruby-in-ppss-context-p (context &optional ppss) | |
| 1363 | (let ((ppss (or ppss (syntax-ppss (point))))) | |
| 1364 | (if (cond | |
| 1365 | ((eq context 'anything) | |
| 1366 | (or (nth 3 ppss) | |
| 1367 | (nth 4 ppss))) | |
| 1368 | ((eq context 'string) | |
| 1369 | (nth 3 ppss)) | |
| 1370 | ((eq context 'heredoc) | |
| cf38dd42 | 1371 | (eq ?\n (nth 3 ppss))) |
| c7fbbc3c CY |
1372 | ((eq context 'non-heredoc) |
| 1373 | (and (ruby-in-ppss-context-p 'anything) | |
| 1374 | (not (ruby-in-ppss-context-p 'heredoc)))) | |
| 1375 | ((eq context 'comment) | |
| 1376 | (nth 4 ppss)) | |
| 1377 | (t | |
| 1378 | (error (concat | |
| 1379 | "Internal error on `ruby-in-ppss-context-p': " | |
| 1380 | "context name `" (symbol-name context) "' is unknown")))) | |
| 1381 | t))) | |
| 1382 | ||
| c7fbbc3c CY |
1383 | (if (featurep 'xemacs) |
| 1384 | (put 'ruby-mode 'font-lock-defaults | |
| 1385 | '((ruby-font-lock-keywords) | |
| 1386 | nil nil nil | |
| 1387 | beginning-of-line | |
| 1388 | (font-lock-syntactic-keywords | |
| 1389 | . ruby-font-lock-syntactic-keywords)))) | |
| 1390 | ||
| 1391 | (defvar ruby-font-lock-syntax-table | |
| 1392 | (let ((tbl (copy-syntax-table ruby-mode-syntax-table))) | |
| 1393 | (modify-syntax-entry ?_ "w" tbl) | |
| 1394 | tbl) | |
| ee61fe97 | 1395 | "The syntax table to use for fontifying Ruby mode buffers. |
| c7fbbc3c CY |
1396 | See `font-lock-syntax-table'.") |
| 1397 | ||
| 1398 | (defconst ruby-font-lock-keywords | |
| 1399 | (list | |
| 1400 | ;; functions | |
| 1401 | '("^\\s *def\\s +\\([^( \t\n]+\\)" | |
| 1402 | 1 font-lock-function-name-face) | |
| 1403 | ;; keywords | |
| 1404 | (cons (concat | |
| 1405 | "\\(^\\|[^_:.@$]\\|\\.\\.\\)\\b\\(defined\\?\\|" | |
| 1406 | (regexp-opt | |
| 1407 | '("alias_method" | |
| 1408 | "alias" | |
| 1409 | "and" | |
| 1410 | "begin" | |
| 1411 | "break" | |
| 1412 | "case" | |
| 1413 | "catch" | |
| 1414 | "class" | |
| 1415 | "def" | |
| 1416 | "do" | |
| 1417 | "elsif" | |
| 1418 | "else" | |
| 1419 | "fail" | |
| 1420 | "ensure" | |
| 1421 | "for" | |
| 1422 | "end" | |
| 1423 | "if" | |
| 1424 | "in" | |
| 1425 | "module_function" | |
| 1426 | "module" | |
| 1427 | "next" | |
| 1428 | "not" | |
| 1429 | "or" | |
| 1430 | "public" | |
| 1431 | "private" | |
| 1432 | "protected" | |
| 1433 | "raise" | |
| 1434 | "redo" | |
| 1435 | "rescue" | |
| 1436 | "retry" | |
| 1437 | "return" | |
| 1438 | "then" | |
| 1439 | "throw" | |
| 1440 | "super" | |
| 1441 | "unless" | |
| 1442 | "undef" | |
| 1443 | "until" | |
| 1444 | "when" | |
| 1445 | "while" | |
| 1446 | "yield") | |
| 1447 | t) | |
| 1448 | "\\)" | |
| 1449 | ruby-keyword-end-re) | |
| 1450 | 2) | |
| 1451 | ;; here-doc beginnings | |
| 1452 | (list ruby-here-doc-beg-re 0 'font-lock-string-face) | |
| 1453 | ;; variables | |
| 1454 | '("\\(^\\|[^_:.@$]\\|\\.\\.\\)\\b\\(nil\\|self\\|true\\|false\\)\\>" | |
| 1455 | 2 font-lock-variable-name-face) | |
| 1456 | ;; variables | |
| 1457 | '("\\(\\$\\([^a-zA-Z0-9 \n]\\|[0-9]\\)\\)\\W" | |
| 1458 | 1 font-lock-variable-name-face) | |
| 1459 | '("\\(\\$\\|@\\|@@\\)\\(\\w\\|_\\)+" | |
| 1460 | 0 font-lock-variable-name-face) | |
| c7fbbc3c CY |
1461 | ;; constants |
| 1462 | '("\\(^\\|[^_]\\)\\b\\([A-Z]+\\(\\w\\|_\\)*\\)" | |
| 1463 | 2 font-lock-type-face) | |
| 1464 | ;; symbols | |
| 11473529 | 1465 | '("\\(^\\|[^:]\\)\\(:\\([-+~]@?\\|[/%&|^`]\\|\\*\\*?\\|<\\(<\\|=>?\\)?\\|>[>=]?\\|===?\\|=~\\|![~=]?\\|\\[\\]=?\\|\\(\\w\\|_\\)+\\([!?=]\\|\\b_*\\)\\|#{[^}\n\\\\]*\\(\\\\.[^}\n\\\\]*\\)*}\\)\\)" |
| c7fbbc3c | 1466 | 2 font-lock-reference-face) |
| cc9c9831 | 1467 | '("\\(^\\s *\\|[\[\{\(,]\\s *\\|\\sw\\s +\\)\\(\\(\\sw\\|_\\)+\\):[^:]" 2 font-lock-reference-face) |
| c7fbbc3c CY |
1468 | ;; expression expansion |
| 1469 | '("#\\({[^}\n\\\\]*\\(\\\\.[^}\n\\\\]*\\)*}\\|\\(\\$\\|@\\|@@\\)\\(\\w\\|_\\)+\\)" | |
| 1470 | 0 font-lock-variable-name-face t) | |
| 1471 | ;; warn lower camel case | |
| 1472 | ;'("\\<[a-z]+[a-z0-9]*[A-Z][A-Za-z0-9]*\\([!?]?\\|\\>\\)" | |
| 1473 | ; 0 font-lock-warning-face) | |
| 1474 | ) | |
| ee61fe97 | 1475 | "Additional expressions to highlight in Ruby mode.") |
| c7fbbc3c CY |
1476 | |
| 1477 | ;;;###autoload | |
| cf38dd42 | 1478 | (define-derived-mode ruby-mode prog-mode "Ruby" |
| c7fbbc3c CY |
1479 | "Major mode for editing Ruby scripts. |
| 1480 | \\[ruby-indent-line] properly indents subexpressions of multi-line | |
| 1481 | class, module, def, if, while, for, do, and case statements, taking | |
| 1482 | nesting into account. | |
| 1483 | ||
| ee61fe97 JB |
1484 | The variable `ruby-indent-level' controls the amount of indentation. |
| 1485 | ||
| c7fbbc3c | 1486 | \\{ruby-mode-map}" |
| c7fbbc3c CY |
1487 | (ruby-mode-variables) |
| 1488 | ||
| 1489 | (set (make-local-variable 'imenu-create-index-function) | |
| 1490 | 'ruby-imenu-create-index) | |
| 1491 | (set (make-local-variable 'add-log-current-defun-function) | |
| 1492 | 'ruby-add-log-current-method) | |
| 1493 | ||
| 1494 | (add-hook | |
| cf38dd42 | 1495 | (cond ((boundp 'before-save-hook) 'before-save-hook) |
| c7fbbc3c CY |
1496 | ((boundp 'write-contents-functions) 'write-contents-functions) |
| 1497 | ((boundp 'write-contents-hooks) 'write-contents-hooks)) | |
| cf38dd42 SM |
1498 | 'ruby-mode-set-encoding nil 'local) |
| 1499 | ||
| 1500 | (set (make-local-variable 'electric-indent-chars) | |
| 2122161f | 1501 | (append '(?\{ ?\}) electric-indent-chars)) |
| c7fbbc3c CY |
1502 | |
| 1503 | (set (make-local-variable 'font-lock-defaults) | |
| 1504 | '((ruby-font-lock-keywords) nil nil)) | |
| 1505 | (set (make-local-variable 'font-lock-keywords) | |
| 1506 | ruby-font-lock-keywords) | |
| 1507 | (set (make-local-variable 'font-lock-syntax-table) | |
| 1508 | ruby-font-lock-syntax-table) | |
| c7fbbc3c | 1509 | |
| cf38dd42 SM |
1510 | (if (eval-when-compile (fboundp 'syntax-propertize-rules)) |
| 1511 | (set (make-local-variable 'syntax-propertize-function) | |
| 1512 | #'ruby-syntax-propertize-function) | |
| 1513 | (set (make-local-variable 'font-lock-syntactic-keywords) | |
| 1514 | ruby-font-lock-syntactic-keywords))) | |
| c7fbbc3c CY |
1515 | |
| 1516 | ;;; Invoke ruby-mode when appropriate | |
| 1517 | ||
| 1518 | ;;;###autoload | |
| a7610c52 | 1519 | (add-to-list 'auto-mode-alist (cons (purecopy "\\.rb\\'") 'ruby-mode)) |
| c7fbbc3c CY |
1520 | |
| 1521 | ;;;###autoload | |
| 4d270537 | 1522 | (dolist (name (list "ruby" "rbx" "jruby" "ruby1.9" "ruby1.8")) |
| a7610c52 | 1523 | (add-to-list 'interpreter-mode-alist (cons (purecopy name) 'ruby-mode))) |
| c7fbbc3c CY |
1524 | |
| 1525 | (provide 'ruby-mode) | |
| 1526 | ||
| 1527 | ;;; ruby-mode.el ends here |