1 ;;; perl-mode.el --- Perl code editing commands for GNU Emacs
3 ;; Copyright (C) 1990, 1994, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 ;; Free Software Foundation, Inc.
6 ;; Author: William F. Mann
11 ;; Adapted from C code editing commands 'c-mode.el', Copyright 1987 by the
12 ;; Free Software Foundation, under terms of its General Public License.
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software; you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation; either version 3, or (at your option)
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs; see the file COPYING. If not, write to the
28 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
29 ;; Boston, MA 02110-1301, USA.
33 ;; To enter perl-mode automatically, add (autoload 'perl-mode "perl-mode")
34 ;; to your .emacs file and change the first line of your perl script to:
35 ;; #!/usr/bin/perl -- # -*-Perl-*-
36 ;; With arguments to perl:
37 ;; #!/usr/bin/perl -P- # -*-Perl-*-
38 ;; To handle files included with do 'filename.pl';, add something like
39 ;; (setq auto-mode-alist (append (list (cons "\\.pl\\'" 'perl-mode))
41 ;; to your .emacs file; otherwise the .pl suffix defaults to prolog-mode.
43 ;; This code is based on the 18.53 version c-mode.el, with extensive
44 ;; rewriting. Most of the features of c-mode survived intact.
46 ;; I added a new feature which adds functionality to TAB; it is controlled
47 ;; by the variable perl-tab-to-comment. With it enabled, TAB does the
48 ;; first thing it can from the following list: change the indentation;
49 ;; move past leading white space; delete an empty comment; reindent a
50 ;; comment; move to end of line; create an empty comment; tell you that
51 ;; the line ends in a quoted string, or has a # which should be a \#.
53 ;; If your machine is slow, you may want to remove some of the bindings
54 ;; to perl-electric-terminator. I changed the indenting defaults to be
55 ;; what Larry Wall uses in perl/lib, but left in all the options.
57 ;; I also tuned a few things: comments and labels starting in column
58 ;; zero are left there by perl-indent-exp; perl-beginning-of-function
59 ;; goes back to the first open brace/paren in column zero, the open brace
60 ;; in 'sub ... {', or the equal sign in 'format ... ='; perl-indent-exp
61 ;; (meta-^q) indents from the current line through the close of the next
62 ;; brace/paren, so you don't need to start exactly at a brace or paren.
64 ;; It may be good style to put a set of redundant braces around your
65 ;; main program. This will let you reindent it with meta-^q.
67 ;; Known problems (these are all caused by limitations in the Emacs Lisp
68 ;; parsing routine (parse-partial-sexp), which was not designed for such
69 ;; a rich language; writing a more suitable parser would be a big job):
70 ;; 2) The globbing syntax <pattern> is not recognized, so special
71 ;; characters in the pattern string must be backslashed.
72 ;; 3) The << quoting operators are not recognized; see below.
73 ;; 5) To make '$' work correctly, $' is not recognized as a variable.
74 ;; Use "$'" or $POSTMATCH instead.
76 ;; If you don't use font-lock, additional problems will appear:
77 ;; 1) Regular expression delimiters do not act as quotes, so special
78 ;; characters such as `'"#:;[](){} may need to be backslashed
79 ;; in regular expressions and in both parts of s/// and tr///.
80 ;; 4) The q and qq quoting operators are not recognized; see below.
81 ;; 5) To make variables such a $' and $#array work, perl-mode treats
82 ;; $ just like backslash, so '$' is not treated correctly.
83 ;; 6) Unfortunately, treating $ like \ makes ${var} be treated as an
84 ;; unmatched }. See below.
85 ;; 7) When ' (quote) is used as a package name separator, perl-mode
86 ;; doesn't understand, and thinks it is seeing a quoted string.
88 ;; Here are some ugly tricks to bypass some of these problems: the perl
89 ;; expression /`/ (that's a back-tick) usually evaluates harmlessly,
90 ;; but will trick perl-mode into starting a quoted string, which
91 ;; can be ended with another /`/. Assuming you have no embedded
92 ;; back-ticks, this can used to help solve problem 3:
94 ;; /`/; $ugly = q?"'$?; /`/;
96 ;; The same trick can be used for problem 6 as in:
97 ;; /{/; while (<${glob_me}>)
98 ;; but a simpler solution is to add a space between the $ and the {:
99 ;; while (<$ {glob_me}>)
101 ;; Problem 7 is even worse, but this 'fix' does work :-(
108 (eval-when-compile (require 'cl))
110 (defvar font-lock-comment-face)
111 (defvar font-lock-doc-face)
112 (defvar font-lock-string-face)
115 "Major mode for editing Perl code."
116 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
120 (defvar perl-mode-abbrev-table nil
121 "Abbrev table in use in perl-mode buffers.")
122 (define-abbrev-table 'perl-mode-abbrev-table ())
124 (defvar perl-mode-map
125 (let ((map (make-sparse-keymap)))
126 (define-key map "{" 'perl-electric-terminator)
127 (define-key map "}" 'perl-electric-terminator)
128 (define-key map ";" 'perl-electric-terminator)
129 (define-key map ":" 'perl-electric-terminator)
130 (define-key map "\e\C-a" 'perl-beginning-of-function)
131 (define-key map "\e\C-e" 'perl-end-of-function)
132 (define-key map "\e\C-h" 'perl-mark-function)
133 (define-key map "\e\C-q" 'perl-indent-exp)
134 (define-key map "\177" 'backward-delete-char-untabify)
135 (define-key map "\t" 'perl-indent-command)
137 "Keymap used in Perl mode.")
139 (autoload 'c-macro-expand "cmacexp"
140 "Display the result of expanding all C macros occurring in the region.
141 The expansion is entirely correct because it uses the C preprocessor."
144 (defvar perl-mode-syntax-table
145 (let ((st (make-syntax-table (standard-syntax-table))))
146 (modify-syntax-entry ?\n ">" st)
147 (modify-syntax-entry ?# "<" st)
148 ;; `$' is also a prefix char so I was tempted to say "/ p",
149 ;; but the `p' thingy basically overrides the `/' :-( --stef
150 (modify-syntax-entry ?$ "/" st)
151 (modify-syntax-entry ?% ". p" st)
152 (modify-syntax-entry ?@ ". p" st)
153 (modify-syntax-entry ?& "." st)
154 (modify-syntax-entry ?\' "\"" st)
155 (modify-syntax-entry ?* "." st)
156 (modify-syntax-entry ?+ "." st)
157 (modify-syntax-entry ?- "." st)
158 (modify-syntax-entry ?/ "." st)
159 (modify-syntax-entry ?< "." st)
160 (modify-syntax-entry ?= "." st)
161 (modify-syntax-entry ?> "." st)
162 (modify-syntax-entry ?\\ "\\" st)
163 (modify-syntax-entry ?` "\"" st)
164 (modify-syntax-entry ?| "." st)
166 "Syntax table in use in `perl-mode' buffers.")
168 (defvar perl-imenu-generic-expression
170 (nil "^sub\\s-+\\([-A-Za-z0-9+_:]+\\)" 1)
172 ("Variables" "^\\([$@%][-A-Za-z0-9+_:]+\\)\\s-*=" 1)
173 ("Packages" "^package\\s-+\\([-A-Za-z0-9+_:]+\\);" 1)
174 ("Doc sections" "^=head[0-9][ \t]+\\(.*\\)" 1))
175 "Imenu generic expression for Perl mode. See `imenu-generic-expression'.")
177 ;; Regexps updated with help from Tom Tromey <tromey@cambric.colorado.edu> and
178 ;; Jim Campbell <jec@murzim.ca.boeing.com>.
180 (defconst perl-font-lock-keywords-1
181 '(;; What is this for?
182 ;;("\\(--- .* ---\\|=== .* ===\\)" . font-lock-string-face)
184 ;; Fontify preprocessor statements as we do in `c-font-lock-keywords'.
185 ;; Ilya Zakharevich <ilya@math.ohio-state.edu> thinks this is a bad idea.
186 ;; ("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
187 ;; ("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
189 ;; ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
190 ;; (1 font-lock-constant-face) (2 font-lock-variable-name-face nil t)))
191 ;; ("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
192 ;; (1 font-lock-constant-face) (2 font-lock-variable-name-face nil t))
194 ;; Fontify function and package names in declarations.
195 ("\\<\\(package\\|sub\\)\\>[ \t]*\\(\\sw+\\)?"
196 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
197 ("\\<\\(import\\|no\\|require\\|use\\)\\>[ \t]*\\(\\sw+\\)?"
198 (1 font-lock-keyword-face) (2 font-lock-constant-face nil t)))
199 "Subdued level highlighting for Perl mode.")
201 (defconst perl-font-lock-keywords-2
202 (append perl-font-lock-keywords-1
205 ;; Fontify keywords, except those fontified otherwise.
207 (regexp-opt '("if" "until" "while" "elsif" "else" "unless"
208 "do" "dump" "for" "foreach" "exit" "die"
209 "BEGIN" "END" "return" "exec" "eval") t)
212 ;; Fontify local and my keywords as types.
213 '("\\<\\(local\\|my\\)\\>" . font-lock-type-face)
215 ;; Fontify function, variable and file name references.
216 '("&\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-function-name-face)
217 ;; Additionally underline non-scalar variables. Maybe this is a bad idea.
218 ;;'("[$@%*][#{]?\\(\\sw+\\)" 1 font-lock-variable-name-face)
219 '("[$*]{?\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-variable-name-face)
220 '("\\([@%]\\|\\$#\\)\\(\\sw+\\(::\\sw+\\)*\\)"
221 (2 (cons font-lock-variable-name-face '(underline))))
222 '("<\\(\\sw+\\)>" 1 font-lock-constant-face)
224 ;; Fontify keywords with/and labels as we do in `c++-font-lock-keywords'.
225 '("\\<\\(continue\\|goto\\|last\\|next\\|redo\\)\\>[ \t]*\\(\\sw+\\)?"
226 (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
227 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-constant-face)))
228 "Gaudy level highlighting for Perl mode.")
230 (defvar perl-font-lock-keywords perl-font-lock-keywords-1
231 "Default expressions to highlight in Perl mode.")
233 (defvar perl-quote-like-pairs
234 '((?\( . ?\)) (?\[ . ?\]) (?\{ . ?\}) (?\< . ?\>)))
236 ;; FIXME: handle here-docs and regexps.
237 ;; <<EOF <<"EOF" <<'EOF' (no space)
246 ;; qr /.../ = precompiled regexp =~=~ m/.../
255 (defvar perl-font-lock-syntactic-keywords
256 ;; TODO: here-documents ("<<\\(\\sw\\|['\"]\\)")
257 '(;; Turn POD into b-style comments
258 ("^\\(=\\)\\sw" (1 "< b"))
259 ("^=cut[ \t]*\\(\n\\)" (1 "> b"))
260 ;; Catch ${ so that ${var} doesn't screw up indentation.
261 ;; This also catches $' to handle 'foo$', although it should really
262 ;; check that it occurs inside a '..' string.
263 ("\\(\\$\\)[{']" (1 ". p"))
264 ;; Handle funny names like $DB'stop.
265 ("\\$ ?{?^?[_a-zA-Z][_a-zA-Z0-9]*\\('\\)[_a-zA-Z]" (1 "_"))
267 ("^[ \t]*format.*=[ \t]*\\(\n\\)" (1 '(7)))
268 ;; Funny things in sub arg specifications like `sub myfunc ($$)'
269 ;; Be careful not to match "sub { (...) ... }".
270 ("\\<sub[[:space:]]+[^{}[:punct:][:space:]]+[[:space:]]*(\\([^)]+\\))"
272 ;; Regexp and funny quotes.
273 ("\\(?:[?:.,;=!~({[]\\|\\(^\\)\\)[ \t\n]*\\(/\\)"
274 (2 (if (and (match-end 1)
276 (goto-char (match-end 1))
277 (skip-chars-backward " \t\n")
278 (not (memq (char-before)
279 '(?? ?: ?. ?, ?\; ?= ?! ?~ ?\( ?\[)))))
280 nil ;; A division sign instead of a regexp-match.
282 ("\\(^\\|[?:.,;=!~({[ \t]\\)\\([msy]\\|q[qxrw]?\\|tr\\)\\>\\s-*\\([^])}> \n\t]\\)"
284 ;; /foo/m $a->m $#m $m @m %m
285 ;; \s (appears often in regexps).
287 (3 (if (assoc (char-after (match-beginning 3))
288 perl-quote-like-pairs)
290 ;; Find and mark the end of funny quotes and format statements.
291 (perl-font-lock-special-syntactic-constructs)
294 (defvar perl-empty-syntax-table
295 (let ((st (copy-syntax-table)))
296 ;; Make all chars be of punctuation syntax.
297 (dotimes (i 256) (aset st i '(1)))
298 (modify-syntax-entry ?\\ "\\" st)
300 "Syntax table used internally for processing quote-like operators.")
302 (defun perl-quote-syntax-table (char)
303 (let ((close (cdr (assq char perl-quote-like-pairs)))
304 (st (copy-syntax-table perl-empty-syntax-table)))
306 (modify-syntax-entry char "\"" st)
307 (modify-syntax-entry char "(" st)
308 (modify-syntax-entry close ")" st))
311 (defun perl-font-lock-special-syntactic-constructs (limit)
312 ;; We used to do all this in a font-lock-syntactic-face-function, which
313 ;; did not work correctly because sometimes some parts of the buffer are
314 ;; treated with font-lock-syntactic-keywords but not with
315 ;; font-lock-syntactic-face-function (mostly because of
316 ;; font-lock-syntactically-fontified). That meant that some syntax-table
317 ;; properties were missing. So now we do the parse-partial-sexp loop
318 ;; ourselves directly from font-lock-syntactic-keywords, so we're sure
319 ;; it's done when necessary.
320 (let ((state (syntax-ppss))
322 (while (< (point) limit)
324 ((or (null (setq char (nth 3 state)))
325 (and (characterp char) (eq (char-syntax (nth 3 state)) ?\")))
326 ;; Normal text, or comment, or docstring, or normal string.
328 ((eq (nth 3 state) ?\n)
329 ;; A `format' command.
331 (when (and (re-search-forward "^\\s *\\.\\s *$" nil t)
333 (put-text-property (point) (1+ (point)) 'syntax-table '(7)))))
335 ;; This is regexp like quote thingy.
336 (setq char (char-after (nth 8 state)))
338 (let ((twoargs (save-excursion
339 (goto-char (nth 8 state))
340 (skip-syntax-backward " ")
341 (skip-syntax-backward "w")
342 (member (buffer-substring
343 (point) (progn (forward-word 1) (point)))
345 (close (cdr (assq char perl-quote-like-pairs)))
347 (st (perl-quote-syntax-table char)))
349 ;; The closing char is the same as the opening char.
350 (with-syntax-table st
351 (parse-partial-sexp (point) (point-max)
352 nil nil state 'syntax-table)
354 (parse-partial-sexp (point) (point-max)
355 nil nil state 'syntax-table)))
356 ;; The open/close chars are matched like () [] {} and <>.
357 (let ((parse-sexp-lookup-properties nil))
360 (with-syntax-table st
361 (goto-char (nth 8 state)) (forward-sexp 1))
364 ;; Skip whitespace and make sure that font-lock will
365 ;; refontify the second part in the proper context.
367 (point) (progn (forward-comment (point-max)) (point))
368 'font-lock-multiline t)
373 (perl-quote-syntax-table (char-after))
375 (put-text-property pos (line-end-position)
376 'jit-lock-defer-multiline t)
377 (looking-at "\\s-*\\sw*e"))
378 (put-text-property (point) (1+ (point))
380 (if (assoc (char-after)
381 perl-quote-like-pairs)
383 ;; The arg(s) is not terminated, so it extends until EOB.
384 (scan-error (goto-char (point-max))))))
385 ;; Point is now right after the arg(s).
386 ;; Erase any syntactic marks within the quoted text.
387 (put-text-property pos (1- (point)) 'syntax-table nil)
388 (when (eq (char-before (1- (point))) ?$)
389 (put-text-property (- (point) 2) (1- (point))
391 (put-text-property (1- (point)) (point)
392 'syntax-table (if close '(15) '(7)))))))
394 (setq state (parse-partial-sexp (point) limit nil nil state
396 ;; Tell font-lock that this needs not further processing.
400 (defcustom perl-indent-level 4
401 "*Indentation of Perl statements with respect to containing block."
405 ;; Is is not unusual to put both perl-indent-level and
406 ;; cperl-indent-level in the local variable section of a file. If only
407 ;; one of perl-mode and cperl-mode is in use, a warning will be issued
408 ;; about the variable. Autoload this here, so that no warning is
409 ;; issued when using either perl-mode or cperl-mode.
410 ;;;###autoload(put 'perl-indent-level 'safe-local-variable 'integerp)
412 (defcustom perl-continued-statement-offset 4
413 "*Extra indent for lines not starting new statements."
416 (defcustom perl-continued-brace-offset -4
417 "*Extra indent for substatements that start with open-braces.
418 This is in addition to `perl-continued-statement-offset'."
421 (defcustom perl-brace-offset 0
422 "*Extra indentation for braces, compared with other text in same context."
425 (defcustom perl-brace-imaginary-offset 0
426 "*Imagined indentation of an open brace that actually follows a statement."
429 (defcustom perl-label-offset -2
430 "*Offset of Perl label lines relative to usual indentation."
433 (defcustom perl-indent-continued-arguments nil
434 "*If non-nil offset of argument lines relative to usual indentation.
435 If nil, continued arguments are aligned with the first argument."
436 :type '(choice integer (const nil))
439 (defcustom perl-tab-always-indent tab-always-indent
440 "Non-nil means TAB in Perl mode always indents the current line.
441 Otherwise it inserts a tab character if you type it past the first
442 nonwhite character on the line."
446 ;; I changed the default to nil for consistency with general Emacs
447 ;; conventions -- rms.
448 (defcustom perl-tab-to-comment nil
449 "*Non-nil means TAB moves to eol or makes a comment in some cases.
450 For lines which don't need indenting, TAB either indents an
451 existing comment, moves to end-of-line, or if at end-of-line already,
452 create a new comment."
456 (defcustom perl-nochange ";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:[^:]"
457 "*Lines starting with this regular expression are not auto-indented."
463 (defvar perl-outline-regexp
464 (concat (mapconcat 'cadr perl-imenu-generic-expression "\\|")
467 (defun perl-outline-level ()
469 ((looking-at "package\\s-") 0)
470 ((looking-at "sub\\s-") 1)
471 ((looking-at "=head[0-9]") (- (char-before (match-end 0)) ?0))
472 ((looking-at "=cut") 1)
475 (defvar perl-mode-hook nil
476 "Normal hook to run when entering Perl mode.")
480 "Major mode for editing Perl code.
481 Expression and list commands understand all Perl brackets.
482 Tab indents for Perl code.
483 Comments are delimited with # ... \\n.
484 Paragraphs are separated by blank lines only.
485 Delete converts tabs to spaces as it moves back.
487 Variables controlling indentation style:
488 `perl-tab-always-indent'
489 Non-nil means TAB in Perl mode should always indent the current line,
490 regardless of where in the line point is when the TAB command is used.
491 `perl-tab-to-comment'
492 Non-nil means that for lines which don't need indenting, TAB will
493 either delete an empty comment, indent an existing comment, move
494 to end-of-line, or if at end-of-line already, create a new comment.
496 Lines starting with this regular expression are not auto-indented.
498 Indentation of Perl statements within surrounding block.
499 The surrounding block's indentation is the indentation
500 of the line on which the open-brace appears.
501 `perl-continued-statement-offset'
502 Extra indentation given to a substatement, such as the
503 then-clause of an if or body of a while.
504 `perl-continued-brace-offset'
505 Extra indentation given to a brace that starts a substatement.
506 This is in addition to `perl-continued-statement-offset'.
508 Extra indentation for line if it starts with an open brace.
509 `perl-brace-imaginary-offset'
510 An open brace following other text is treated as if it were
511 this far to the right of the start of its line.
513 Extra indentation for line that is a label.
514 `perl-indent-continued-arguments'
515 Offset of argument lines relative to usual indentation.
517 Various indentation styles: K&R BSD BLK GNU LW
518 perl-indent-level 5 8 0 2 4
519 perl-continued-statement-offset 5 8 4 2 4
520 perl-continued-brace-offset 0 0 0 0 -4
521 perl-brace-offset -5 -8 0 0 0
522 perl-brace-imaginary-offset 0 0 4 0 0
523 perl-label-offset -5 -8 -2 -2 -2
525 Turning on Perl mode runs the normal hook `perl-mode-hook'."
527 (kill-all-local-variables)
528 (use-local-map perl-mode-map)
529 (setq major-mode 'perl-mode)
530 (setq mode-name "Perl")
531 (setq local-abbrev-table perl-mode-abbrev-table)
532 (set-syntax-table perl-mode-syntax-table)
533 (make-local-variable 'paragraph-start)
534 (setq paragraph-start (concat "$\\|" page-delimiter))
535 (make-local-variable 'paragraph-separate)
536 (setq paragraph-separate paragraph-start)
537 (make-local-variable 'paragraph-ignore-fill-prefix)
538 (setq paragraph-ignore-fill-prefix t)
539 (make-local-variable 'indent-line-function)
540 (setq indent-line-function 'perl-indent-line)
541 (make-local-variable 'require-final-newline)
542 (setq require-final-newline mode-require-final-newline)
543 (make-local-variable 'comment-start)
544 (setq comment-start "# ")
545 (make-local-variable 'comment-end)
546 (setq comment-end "")
547 (make-local-variable 'comment-start-skip)
548 (setq comment-start-skip "\\(^\\|\\s-\\);?#+ *")
549 (make-local-variable 'comment-indent-function)
550 (setq comment-indent-function 'perl-comment-indent)
551 (make-local-variable 'parse-sexp-ignore-comments)
552 (setq parse-sexp-ignore-comments t)
553 ;; Tell font-lock.el how to handle Perl.
554 (setq font-lock-defaults '((perl-font-lock-keywords
555 perl-font-lock-keywords-1
556 perl-font-lock-keywords-2)
557 nil nil ((?\_ . "w")) nil
558 (font-lock-syntactic-keywords
559 . perl-font-lock-syntactic-keywords)
560 (parse-sexp-lookup-properties . t)))
561 ;; Tell imenu how to handle Perl.
562 (set (make-local-variable 'imenu-generic-expression)
563 perl-imenu-generic-expression)
564 (setq imenu-case-fold-search nil)
565 ;; Setup outline-minor-mode.
566 (set (make-local-variable 'outline-regexp) perl-outline-regexp)
567 (set (make-local-variable 'outline-level) 'perl-outline-level)
568 (run-mode-hooks 'perl-mode-hook))
570 ;; This is used by indent-for-comment
571 ;; to decide how much to indent a comment in Perl code
572 ;; based on its context.
573 (defun perl-comment-indent ()
574 (if (and (bolp) (not (eolp)))
575 0 ;Existing comment at bol stays there.
578 (defalias 'electric-perl-terminator 'perl-electric-terminator)
579 (defun perl-electric-terminator (arg)
580 "Insert character and adjust indentation.
581 If at end-of-line, and not in a comment or a quote, correct the's indentation."
583 (let ((insertpos (point)))
584 (and (not arg) ; decide whether to indent
588 (and (not ; eliminate comments quickly
589 (and comment-start-skip
590 (re-search-forward comment-start-skip insertpos t)) )
591 (or (/= last-command-char ?:)
592 ;; Colon is special only after a label ....
593 (looking-at "\\s-*\\(\\w\\|\\s_\\)+$"))
594 (let ((pps (parse-partial-sexp
595 (perl-beginning-of-function) insertpos)))
596 (not (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))
597 (progn ; must insert, indent, delete
598 (insert-char last-command-char 1)
601 (self-insert-command (prefix-numeric-value arg)))
603 ;; not used anymore, but may be useful someday:
604 ;;(defun perl-inside-parens-p ()
605 ;; (condition-case ()
608 ;; (narrow-to-region (point)
609 ;; (perl-beginning-of-function))
610 ;; (goto-char (point-max))
611 ;; (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
614 (defun perl-indent-command (&optional arg)
615 "Indent current line as Perl code, or optionally, insert a tab character.
617 With an argument, indent the current line, regardless of other options.
619 If `perl-tab-always-indent' is nil and point is not in the indentation
620 area at the beginning of the line, simply insert a tab.
622 Otherwise, indent the current line. If point was within the indentation
623 area it is moved to the end of the indentation area. If the line was
624 already indented properly and point was not within the indentation area,
625 and if `perl-tab-to-comment' is non-nil (the default), then do the first
626 possible action from the following list:
628 1) delete an empty comment
629 2) move forward to start of comment, indenting if necessary
630 3) move forward to end of line
631 4) create an empty comment
632 5) move backward to start of comment, indenting if necessary."
634 (if arg ; If arg, just indent this line
635 (perl-indent-line "\f")
636 (if (and (not perl-tab-always-indent)
637 (> (current-column) (current-indentation)))
639 (let* ((oldpnt (point))
640 (lsexp (progn (beginning-of-line) (point)))
641 (bof (perl-beginning-of-function))
644 (perl-indent-line "\f\\|;?#" bof))))
645 (and perl-tab-to-comment
646 (= oldpnt (point)) ; done if point moved
647 (if (listp delta) ; if line starts in a quoted string
648 (setq lsexp (or (nth 2 delta) bof))
649 (= delta 0)) ; done if indenting occurred
650 (let ((eol (progn (end-of-line) (point)))
652 (if (= (char-after bof) ?=)
654 (message "In a format statement"))
655 (setq state (parse-partial-sexp lsexp eol))
657 (if (= oldpnt eol) ; already at eol in a string
658 (message "In a string which starts with a %c."
660 (if (not (nth 4 state))
661 (if (= oldpnt eol) ; no comment, create one?
662 (indent-for-comment))
664 (if (and comment-start-skip
665 (re-search-forward comment-start-skip eol 'move))
667 (progn ; delete existing comment
668 (goto-char (match-beginning 0))
669 (skip-chars-backward " \t")
670 (delete-region (point) eol))
671 (if (or (< oldpnt (point)) (= oldpnt eol))
672 (indent-for-comment) ; indent existing comment
676 (message "Use backslash to quote # characters.")
679 (defun perl-indent-line (&optional nochange parse-start)
680 "Indent current line as Perl code.
681 Return the amount the indentation
682 changed by, or (parse-state) if line starts in a quoted string."
683 (let ((case-fold-search nil)
684 (pos (- (point-max) (point)))
685 (bof (or parse-start (save-excursion (perl-beginning-of-function))))
686 beg indent shift-amt)
690 (cond ((eq (char-after bof) ?=) 0)
691 ((listp (setq indent (perl-calculate-indent bof))) indent)
692 ((looking-at (or nochange perl-nochange)) 0)
694 (skip-chars-forward " \t\f")
695 (setq indent (perl-indent-new-calculate nil indent bof))
696 (- indent (current-column)))))
697 (skip-chars-forward " \t\f")
698 (if (and (numberp shift-amt) (/= 0 shift-amt))
699 (progn (delete-region beg (point))
701 ;; If initial point was within line's indentation,
702 ;; position after the indentation. Else stay at same point in text.
703 (if (> (- (point-max) pos) (point))
704 (goto-char (- (point-max) pos)))
707 (defun perl-continuation-line-p (limit)
708 "Move to end of previous line and return non-nil if continued."
709 ;; Statement level. Is it a continuation or a new statement?
710 ;; Find previous non-comment character.
711 (perl-backward-to-noncomment)
712 ;; Back up over label lines, since they don't
713 ;; affect whether our line is a continuation.
714 (while (or (eq (preceding-char) ?\,)
715 (and (eq (preceding-char) ?:)
716 (memq (char-syntax (char-after (- (point) 2)))
718 (if (eq (preceding-char) ?\,)
719 (perl-backward-to-start-of-continued-exp limit)
721 (perl-backward-to-noncomment))
722 ;; Now we get the answer.
723 (not (memq (preceding-char) '(?\; ?\} ?\{))))
725 (defun perl-hanging-paren-p ()
726 "Non-nil if we are right after a hanging parenthesis-like char."
727 (and (looking-at "[ \t]*$")
729 (skip-syntax-backward " (") (not (bolp)))))
731 (defun perl-indent-new-calculate (&optional virtual default parse-start)
733 (and virtual (save-excursion (skip-chars-backward " \t") (bolp))
735 (and (looking-at "\\(\\w\\|\\s_\\)+:[^:]")
736 (max 1 (+ (or default (perl-calculate-indent parse-start))
738 (and (= (char-syntax (following-char)) ?\))
742 (perl-indent-new-calculate
743 ;; Recalculate the parsing-start, since we may have jumped
744 ;; dangerously close (typically in the case of nested functions).
745 'virtual nil (save-excursion (perl-beginning-of-function)))))
746 (and (and (= (following-char) ?{)
747 (save-excursion (forward-char) (perl-hanging-paren-p)))
748 (+ (or default (perl-calculate-indent parse-start))
750 (or default (perl-calculate-indent parse-start))))
752 (defun perl-calculate-indent (&optional parse-start)
753 "Return appropriate indentation for current line as Perl code.
754 In usual case returns an integer: the column to indent to.
755 Returns (parse-state) if line starts inside a string.
756 Optional argument PARSE-START should be the position of `beginning-of-defun'."
758 (let ((indent-point (point))
759 (case-fold-search nil)
761 state containing-sexp)
762 (if parse-start ;used to avoid searching
763 (goto-char parse-start)
764 (perl-beginning-of-function))
765 ;; We might be now looking at a local function that has nothing to
766 ;; do with us because `indent-point' is past it. In this case
767 ;; look further back up for another `perl-beginning-of-function'.
768 (while (and (looking-at "{")
771 (looking-at "\\s-+sub\\>"))
772 (> indent-point (save-excursion (forward-sexp 1) (point))))
773 (perl-beginning-of-function))
774 (while (< (point) indent-point) ;repeat until right sexp
775 (setq state (parse-partial-sexp (point) indent-point 0))
776 ;; state = (depth_in_parens innermost_containing_list
777 ;; last_complete_sexp string_terminator_or_nil inside_commentp
778 ;; following_quotep minimum_paren-depth_this_scan)
779 ;; Parsing stops if depth in parentheses becomes equal to third arg.
780 (setq containing-sexp (nth 1 state)))
781 (cond ((nth 3 state) state) ; In a quoted string?
782 ((null containing-sexp) ; Line is at top level.
783 (skip-chars-forward " \t\f")
784 (if (= (following-char) ?{)
785 0 ; move to beginning of line if it starts a function body
786 ;; indent a little if this is a continuation line
787 (perl-backward-to-noncomment)
789 (memq (preceding-char) '(?\; ?\})))
790 0 perl-continued-statement-offset)))
791 ((/= (char-after containing-sexp) ?{)
792 ;; line is expression, not statement:
793 ;; indent to just after the surrounding open.
794 (goto-char (1+ containing-sexp))
795 (if (perl-hanging-paren-p)
796 ;; We're indenting an arg of a call like:
797 ;; $a = foobarlongnamefun (
802 (skip-syntax-backward "(")
804 (while (save-excursion
805 (skip-syntax-backward " ") (not (bolp)))
808 (+ (current-column) perl-indent-level))
809 (if perl-indent-continued-arguments
810 (+ perl-indent-continued-arguments (current-indentation))
811 (skip-chars-forward " \t")
814 ;; Statement level. Is it a continuation or a new statement?
815 (if (perl-continuation-line-p containing-sexp)
816 ;; This line is continuation of preceding line's statement;
817 ;; indent perl-continued-statement-offset more than the
818 ;; previous line of the statement.
820 (perl-backward-to-start-of-continued-exp containing-sexp)
821 (+ (if (save-excursion
822 (perl-continuation-line-p containing-sexp))
823 ;; If the continued line is itself a continuation
824 ;; line, then align, otherwise add an offset.
825 0 perl-continued-statement-offset)
827 (if (save-excursion (goto-char indent-point)
828 (looking-at "[ \t]*{"))
829 perl-continued-brace-offset 0)))
830 ;; This line starts a new statement.
831 ;; Position at last unclosed open.
832 (goto-char containing-sexp)
834 ;; Is line first statement after an open-brace?
835 ;; If no, find that first statement and indent like it.
838 ;; Skip over comments and labels following openbrace.
840 (skip-chars-forward " \t\f\n")
841 (cond ((looking-at ";?#")
843 ((looking-at "\\(\\w\\|\\s_\\)+:[^:]")
846 (setq colon-line-end (point)))
847 (search-forward ":")))))
848 ;; The first following code counts
849 ;; if it is before the line we want to indent.
850 (and (< (point) indent-point)
851 (if (> colon-line-end (point))
852 (- (current-indentation) perl-label-offset)
854 ;; If no previous statement,
855 ;; indent it relative to line brace is on.
856 ;; For open paren in column zero, don't let statement
857 ;; start there too. If perl-indent-level is zero,
858 ;; use perl-brace-offset + perl-continued-statement-offset
859 ;; For open-braces not the first thing in a line,
860 ;; add in perl-brace-imaginary-offset.
861 (+ (if (and (bolp) (zerop perl-indent-level))
862 (+ perl-brace-offset perl-continued-statement-offset)
864 ;; Move back over whitespace before the openbrace.
865 ;; If openbrace is not first nonwhite thing on the line,
866 ;; add the perl-brace-imaginary-offset.
867 (progn (skip-chars-backward " \t")
868 (if (bolp) 0 perl-brace-imaginary-offset))
869 ;; If the openbrace is preceded by a parenthesized exp,
870 ;; move to the beginning of that;
871 ;; possibly a different line
873 (if (eq (preceding-char) ?\))
875 ;; Get initial indentation of the line we are on.
876 (current-indentation))))))))))
878 (defun perl-backward-to-noncomment ()
879 "Move point backward to after the first non-white-space, skipping comments."
881 (forward-comment (- (point-max))))
883 (defun perl-backward-to-start-of-continued-exp (lim)
884 (if (= (preceding-char) ?\))
888 (goto-char (1+ lim)))
889 (skip-chars-forward " \t\f"))
891 ;; note: this may be slower than the c-mode version, but I can understand it.
892 (defalias 'indent-perl-exp 'perl-indent-exp)
893 (defun perl-indent-exp ()
894 "Indent each line of the Perl grouping following point."
896 (let* ((case-fold-search nil)
897 (oldpnt (point-marker))
898 (bof-mark (save-excursion
900 (perl-beginning-of-function)
902 eol last-mark lsexp-mark delta)
903 (if (= (char-after (marker-position bof-mark)) ?=)
904 (message "Can't indent a format statement")
905 (message "Indenting Perl expression...")
906 (save-excursion (end-of-line) (setq eol (point)))
907 (save-excursion ; locate matching close paren
908 (while (and (not (eobp)) (<= (point) eol))
909 (parse-partial-sexp (point) (point-max) 0))
910 (setq last-mark (point-marker)))
911 (setq lsexp-mark bof-mark)
913 (while (< (point) (marker-position last-mark))
914 (setq delta (perl-indent-line nil (marker-position bof-mark)))
915 (if (numberp delta) ; unquoted start-of-line?
918 (delete-horizontal-space))
919 (setq lsexp-mark (point-marker))))
922 (if (nth 4 (parse-partial-sexp (marker-position lsexp-mark) eol))
923 (progn ; line ends in a comment
925 (if (or (not (looking-at "\\s-*;?#"))
928 (= (- (current-indentation) delta) comment-column)))
929 (if (and comment-start-skip
930 (re-search-forward comment-start-skip eol t))
931 (indent-for-comment))))) ; indent existing comment
933 (goto-char (marker-position oldpnt))
934 (message "Indenting Perl expression...done"))))
936 (defun perl-beginning-of-function (&optional arg)
937 "Move backward to next beginning-of-function, or as far as possible.
938 With argument, repeat that many times; negative args move forward.
939 Returns new value of point in all cases."
941 (or arg (setq arg 1))
942 (if (< arg 0) (forward-char 1))
945 "^\\s(\\|^\\s-*sub\\b[ \t\n]*\\_<[^{]+{\\|^\\s-*format\\b[^=]*=\\|^\\."
947 (goto-char (1- (match-end 0))))
950 ;; note: this routine is adapted directly from emacs lisp.el, end-of-defun;
951 ;; no bugs have been removed :-)
952 (defun perl-end-of-function (&optional arg)
953 "Move forward to next end-of-function.
954 The end of a function is found by moving forward from the beginning of one.
955 With argument, repeat that many times; negative args move backward."
957 (or arg (setq arg 1))
959 (while (and (> arg 0) (< (point) (point-max)))
965 (perl-beginning-of-function 1)
968 (or (bobp) (forward-char -1))
969 (perl-beginning-of-function -1))
972 (skip-chars-forward " \t")
973 (if (looking-at "[#\n]")
979 (perl-beginning-of-function 1)
983 (if (progn (perl-beginning-of-function 2) (not (bobp)))
986 (skip-chars-forward " \t")
987 (if (looking-at "[#\n]")
989 (goto-char (point-min)))))
990 (setq arg (1+ arg)))))
992 (defalias 'mark-perl-function 'perl-mark-function)
993 (defun perl-mark-function ()
994 "Put mark at end of Perl function, point at beginning."
997 (perl-end-of-function)
999 (perl-beginning-of-function)
1000 (backward-paragraph))
1002 (provide 'perl-mode)
1004 ;; arch-tag: 8c7ff68d-15f3-46a2-ade2-b7c41f176826
1005 ;;; perl-mode.el ends here