1 ;;; perl-mode.el --- Perl code editing commands for GNU Emacs
3 ;; Copyright (C) 1990, 1994, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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 of the License, or
19 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
31 ;; To enter perl-mode automatically, add (autoload 'perl-mode "perl-mode")
32 ;; to your .emacs file and change the first line of your perl script to:
33 ;; #!/usr/bin/perl -- # -*-Perl-*-
34 ;; With arguments to perl:
35 ;; #!/usr/bin/perl -P- # -*-Perl-*-
36 ;; To handle files included with do 'filename.pl';, add something like
37 ;; (setq auto-mode-alist (append (list (cons "\\.pl\\'" 'perl-mode))
39 ;; to your .emacs file; otherwise the .pl suffix defaults to prolog-mode.
41 ;; This code is based on the 18.53 version c-mode.el, with extensive
42 ;; rewriting. Most of the features of c-mode survived intact.
44 ;; I added a new feature which adds functionality to TAB; it is controlled
45 ;; by the variable perl-tab-to-comment. With it enabled, TAB does the
46 ;; first thing it can from the following list: change the indentation;
47 ;; move past leading white space; delete an empty comment; reindent a
48 ;; comment; move to end of line; create an empty comment; tell you that
49 ;; the line ends in a quoted string, or has a # which should be a \#.
51 ;; If your machine is slow, you may want to remove some of the bindings
52 ;; to perl-electric-terminator. I changed the indenting defaults to be
53 ;; what Larry Wall uses in perl/lib, but left in all the options.
55 ;; I also tuned a few things: comments and labels starting in column
56 ;; zero are left there by perl-indent-exp; perl-beginning-of-function
57 ;; goes back to the first open brace/paren in column zero, the open brace
58 ;; in 'sub ... {', or the equal sign in 'format ... ='; perl-indent-exp
59 ;; (meta-^q) indents from the current line through the close of the next
60 ;; brace/paren, so you don't need to start exactly at a brace or paren.
62 ;; It may be good style to put a set of redundant braces around your
63 ;; main program. This will let you reindent it with meta-^q.
65 ;; Known problems (these are all caused by limitations in the Emacs Lisp
66 ;; parsing routine (parse-partial-sexp), which was not designed for such
67 ;; a rich language; writing a more suitable parser would be a big job):
68 ;; 2) The globbing syntax <pattern> is not recognized, so special
69 ;; characters in the pattern string must be backslashed.
70 ;; 3) The << quoting operators are not recognized; see below.
71 ;; 5) To make '$' work correctly, $' is not recognized as a variable.
72 ;; Use "$'" or $POSTMATCH instead.
74 ;; If you don't use font-lock, additional problems will appear:
75 ;; 1) Regular expression delimiters do not act as quotes, so special
76 ;; characters such as `'"#:;[](){} may need to be backslashed
77 ;; in regular expressions and in both parts of s/// and tr///.
78 ;; 4) The q and qq quoting operators are not recognized; see below.
79 ;; 5) To make variables such a $' and $#array work, perl-mode treats
80 ;; $ just like backslash, so '$' is not treated correctly.
81 ;; 6) Unfortunately, treating $ like \ makes ${var} be treated as an
82 ;; unmatched }. See below.
83 ;; 7) When ' (quote) is used as a package name separator, perl-mode
84 ;; doesn't understand, and thinks it is seeing a quoted string.
86 ;; Here are some ugly tricks to bypass some of these problems: the perl
87 ;; expression /`/ (that's a back-tick) usually evaluates harmlessly,
88 ;; but will trick perl-mode into starting a quoted string, which
89 ;; can be ended with another /`/. Assuming you have no embedded
90 ;; back-ticks, this can used to help solve problem 3:
92 ;; /`/; $ugly = q?"'$?; /`/;
94 ;; The same trick can be used for problem 6 as in:
95 ;; /{/; while (<${glob_me}>)
96 ;; but a simpler solution is to add a space between the $ and the {:
97 ;; while (<$ {glob_me}>)
99 ;; Problem 7 is even worse, but this 'fix' does work :-(
106 (eval-when-compile (require 'cl
))
108 (defvar font-lock-comment-face
)
109 (defvar font-lock-doc-face
)
110 (defvar font-lock-string-face
)
113 "Major mode for editing Perl code."
114 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
118 (defvar perl-mode-abbrev-table nil
119 "Abbrev table in use in perl-mode buffers.")
120 (define-abbrev-table 'perl-mode-abbrev-table
())
122 (defvar perl-mode-map
123 (let ((map (make-sparse-keymap)))
124 (define-key map
"{" 'perl-electric-terminator
)
125 (define-key map
"}" 'perl-electric-terminator
)
126 (define-key map
";" 'perl-electric-terminator
)
127 (define-key map
":" 'perl-electric-terminator
)
128 (define-key map
"\e\C-a" 'perl-beginning-of-function
)
129 (define-key map
"\e\C-e" 'perl-end-of-function
)
130 (define-key map
"\e\C-h" 'perl-mark-function
)
131 (define-key map
"\e\C-q" 'perl-indent-exp
)
132 (define-key map
"\177" 'backward-delete-char-untabify
)
133 (define-key map
"\t" 'perl-indent-command
)
135 "Keymap used in Perl mode.")
137 (autoload 'c-macro-expand
"cmacexp"
138 "Display the result of expanding all C macros occurring in the region.
139 The expansion is entirely correct because it uses the C preprocessor."
142 (defvar perl-mode-syntax-table
143 (let ((st (make-syntax-table (standard-syntax-table))))
144 (modify-syntax-entry ?
\n ">" st
)
145 (modify-syntax-entry ?
# "<" st
)
146 ;; `$' is also a prefix char so I was tempted to say "/ p",
147 ;; but the `p' thingy basically overrides the `/' :-( --stef
148 (modify-syntax-entry ?$
"/" st
)
149 (modify-syntax-entry ?%
". p" st
)
150 (modify-syntax-entry ?
@ ". p" st
)
151 (modify-syntax-entry ?
& "." st
)
152 (modify-syntax-entry ?
\' "\"" 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
)
164 "Syntax table in use in `perl-mode' buffers.")
166 (defvar perl-imenu-generic-expression
168 (nil "^sub\\s-+\\([-A-Za-z0-9+_:]+\\)" 1)
170 ("Variables" "^\\([$@%][-A-Za-z0-9+_:]+\\)\\s-*=" 1)
171 ("Packages" "^package\\s-+\\([-A-Za-z0-9+_:]+\\);" 1)
172 ("Doc sections" "^=head[0-9][ \t]+\\(.*\\)" 1))
173 "Imenu generic expression for Perl mode. See `imenu-generic-expression'.")
175 ;; Regexps updated with help from Tom Tromey <tromey@cambric.colorado.edu> and
176 ;; Jim Campbell <jec@murzim.ca.boeing.com>.
178 (defconst perl-font-lock-keywords-1
179 '(;; What is this for?
180 ;;("\\(--- .* ---\\|=== .* ===\\)" . font-lock-string-face)
182 ;; Fontify preprocessor statements as we do in `c-font-lock-keywords'.
183 ;; Ilya Zakharevich <ilya@math.ohio-state.edu> thinks this is a bad idea.
184 ;; ("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
185 ;; ("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
187 ;; ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
188 ;; (1 font-lock-constant-face) (2 font-lock-variable-name-face nil t)))
189 ;; ("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
190 ;; (1 font-lock-constant-face) (2 font-lock-variable-name-face nil t))
192 ;; Fontify function and package names in declarations.
193 ("\\<\\(package\\|sub\\)\\>[ \t]*\\(\\sw+\\)?"
194 (1 font-lock-keyword-face
) (2 font-lock-function-name-face nil t
))
195 ("\\<\\(import\\|no\\|require\\|use\\)\\>[ \t]*\\(\\sw+\\)?"
196 (1 font-lock-keyword-face
) (2 font-lock-constant-face nil t
)))
197 "Subdued level highlighting for Perl mode.")
199 (defconst perl-font-lock-keywords-2
200 (append perl-font-lock-keywords-1
203 ;; Fontify keywords, except those fontified otherwise.
205 (regexp-opt '("if" "until" "while" "elsif" "else" "unless"
206 "do" "dump" "for" "foreach" "exit" "die"
207 "BEGIN" "END" "return" "exec" "eval") t
)
210 ;; Fontify local and my keywords as types.
211 '("\\<\\(local\\|my\\)\\>" . font-lock-type-face
)
213 ;; Fontify function, variable and file name references.
214 '("&\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-function-name-face
)
215 ;; Additionally underline non-scalar variables. Maybe this is a bad idea.
216 ;;'("[$@%*][#{]?\\(\\sw+\\)" 1 font-lock-variable-name-face)
217 '("[$*]{?\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-variable-name-face
)
218 '("\\([@%]\\|\\$#\\)\\(\\sw+\\(::\\sw+\\)*\\)"
219 (2 (cons font-lock-variable-name-face
'(underline))))
220 '("<\\(\\sw+\\)>" 1 font-lock-constant-face
)
222 ;; Fontify keywords with/and labels as we do in `c++-font-lock-keywords'.
223 '("\\<\\(continue\\|goto\\|last\\|next\\|redo\\)\\>[ \t]*\\(\\sw+\\)?"
224 (1 font-lock-keyword-face
) (2 font-lock-constant-face nil t
))
225 '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-constant-face
)))
226 "Gaudy level highlighting for Perl mode.")
228 (defvar perl-font-lock-keywords perl-font-lock-keywords-1
229 "Default expressions to highlight in Perl mode.")
231 (defvar perl-quote-like-pairs
232 '((?\
( . ?\
)) (?\
[ . ?\
]) (?\
{ . ?\
}) (?\
< . ?\
>)))
234 ;; FIXME: handle here-docs and regexps.
235 ;; <<EOF <<"EOF" <<'EOF' (no space)
244 ;; qr /.../ = precompiled regexp =~=~ m/.../
253 (defvar perl-font-lock-syntactic-keywords
254 ;; TODO: here-documents ("<<\\(\\sw\\|['\"]\\)")
255 '(;; Turn POD into b-style comments
256 ("^\\(=\\)\\sw" (1 "< b"))
257 ("^=cut[ \t]*\\(\n\\)" (1 "> b"))
258 ;; Catch ${ so that ${var} doesn't screw up indentation.
259 ;; This also catches $' to handle 'foo$', although it should really
260 ;; check that it occurs inside a '..' string.
261 ("\\(\\$\\)[{']" (1 ". p"))
262 ;; Handle funny names like $DB'stop.
263 ("\\$ ?{?^?[_a-zA-Z][_a-zA-Z0-9]*\\('\\)[_a-zA-Z]" (1 "_"))
265 ("^[ \t]*format.*=[ \t]*\\(\n\\)" (1 '(7)))
266 ;; Funny things in `sub' arg-specs like `sub myfun ($)' or `sub ($)'.
267 ;; Be careful not to match "sub { (...) ... }".
268 ("\\<sub\\(?:[[:space:]]+[^{}[:punct:][:space:]]+\\)?[[:space:]]*(\\([^)]+\\))"
270 ;; Regexp and funny quotes.
271 ("\\(?:[?:.,;=!~({[]\\|\\(^\\)\\)[ \t\n]*\\(/\\)"
272 (2 (if (and (match-end 1)
274 (goto-char (match-end 1))
275 (skip-chars-backward " \t\n")
276 (not (memq (char-before)
277 '(?? ?
: ?. ?
, ?\
; ?= ?! ?~ ?\( ?\[)))))
278 nil
;; A division sign instead of a regexp-match.
280 ("\\(^\\|[?:.,;=!~({[ \t]\\)\\([msy]\\|q[qxrw]?\\|tr\\)\\>\\s-*\\([^])}> \n\t]\\)"
282 ;; /foo/m $a->m $#m $m @m %m
283 ;; \s (appears often in regexps).
285 (3 (if (assoc (char-after (match-beginning 3))
286 perl-quote-like-pairs
)
288 ;; Find and mark the end of funny quotes and format statements.
289 (perl-font-lock-special-syntactic-constructs)
292 (defvar perl-empty-syntax-table
293 (let ((st (copy-syntax-table)))
294 ;; Make all chars be of punctuation syntax.
295 (dotimes (i 256) (aset st i
'(1)))
296 (modify-syntax-entry ?
\\ "\\" st
)
298 "Syntax table used internally for processing quote-like operators.")
300 (defun perl-quote-syntax-table (char)
301 (let ((close (cdr (assq char perl-quote-like-pairs
)))
302 (st (copy-syntax-table perl-empty-syntax-table
)))
304 (modify-syntax-entry char
"\"" st
)
305 (modify-syntax-entry char
"(" st
)
306 (modify-syntax-entry close
")" st
))
309 (defun perl-font-lock-special-syntactic-constructs (limit)
310 ;; We used to do all this in a font-lock-syntactic-face-function, which
311 ;; did not work correctly because sometimes some parts of the buffer are
312 ;; treated with font-lock-syntactic-keywords but not with
313 ;; font-lock-syntactic-face-function (mostly because of
314 ;; font-lock-syntactically-fontified). That meant that some syntax-table
315 ;; properties were missing. So now we do the parse-partial-sexp loop
316 ;; ourselves directly from font-lock-syntactic-keywords, so we're sure
317 ;; it's done when necessary.
318 (let ((state (syntax-ppss))
320 (while (< (point) limit
)
322 ((or (null (setq char
(nth 3 state
)))
323 (and (characterp char
) (eq (char-syntax (nth 3 state
)) ?
\")))
324 ;; Normal text, or comment, or docstring, or normal string.
326 ((eq (nth 3 state
) ?
\n)
327 ;; A `format' command.
329 (when (and (re-search-forward "^\\s *\\.\\s *$" nil t
)
331 (put-text-property (point) (1+ (point)) 'syntax-table
'(7)))))
333 ;; This is regexp like quote thingy.
334 (setq char
(char-after (nth 8 state
)))
336 (let ((twoargs (save-excursion
337 (goto-char (nth 8 state
))
338 (skip-syntax-backward " ")
339 (skip-syntax-backward "w")
340 (member (buffer-substring
341 (point) (progn (forward-word 1) (point)))
343 (close (cdr (assq char perl-quote-like-pairs
)))
345 (st (perl-quote-syntax-table char
)))
347 ;; The closing char is the same as the opening char.
348 (with-syntax-table st
349 (parse-partial-sexp (point) (point-max)
350 nil nil state
'syntax-table
)
352 (parse-partial-sexp (point) (point-max)
353 nil nil state
'syntax-table
)))
354 ;; The open/close chars are matched like () [] {} and <>.
355 (let ((parse-sexp-lookup-properties nil
))
358 (with-syntax-table st
359 (goto-char (nth 8 state
)) (forward-sexp 1))
362 ;; Skip whitespace and make sure that font-lock will
363 ;; refontify the second part in the proper context.
365 (point) (progn (forward-comment (point-max)) (point))
366 'font-lock-multiline t
)
371 (perl-quote-syntax-table (char-after))
373 (put-text-property pos
(line-end-position)
374 'jit-lock-defer-multiline t
)
375 (looking-at "\\s-*\\sw*e"))
376 (put-text-property (point) (1+ (point))
378 (if (assoc (char-after)
379 perl-quote-like-pairs
)
381 ;; The arg(s) is not terminated, so it extends until EOB.
382 (scan-error (goto-char (point-max))))))
383 ;; Point is now right after the arg(s).
384 ;; Erase any syntactic marks within the quoted text.
385 (put-text-property pos
(1- (point)) 'syntax-table nil
)
386 (when (eq (char-before (1- (point))) ?$
)
387 (put-text-property (- (point) 2) (1- (point))
389 (put-text-property (1- (point)) (point)
390 'syntax-table
(if close
'(15) '(7)))))))
392 (setq state
(parse-partial-sexp (point) limit nil nil state
394 ;; Tell font-lock that this needs not further processing.
398 (defcustom perl-indent-level
4
399 "*Indentation of Perl statements with respect to containing block."
403 ;; Is is not unusual to put both things like perl-indent-level and
404 ;; cperl-indent-level in the local variable section of a file. If only
405 ;; one of perl-mode and cperl-mode is in use, a warning will be issued
406 ;; about the variable. Autoload these here, so that no warning is
407 ;; issued when using either perl-mode or cperl-mode.
408 ;;;###autoload(put 'perl-indent-level 'safe-local-variable 'integerp)
409 ;;;###autoload(put 'perl-continued-statement-offset 'safe-local-variable 'integerp)
410 ;;;###autoload(put 'perl-continued-brace-offset 'safe-local-variable 'integerp)
411 ;;;###autoload(put 'perl-brace-offset 'safe-local-variable 'integerp)
412 ;;;###autoload(put 'perl-brace-imaginary-offset 'safe-local-variable 'integerp)
413 ;;;###autoload(put 'perl-label-offset 'safe-local-variable 'integerp)
415 (defcustom perl-continued-statement-offset
4
416 "*Extra indent for lines not starting new statements."
419 (defcustom perl-continued-brace-offset -
4
420 "*Extra indent for substatements that start with open-braces.
421 This is in addition to `perl-continued-statement-offset'."
424 (defcustom perl-brace-offset
0
425 "*Extra indentation for braces, compared with other text in same context."
428 (defcustom perl-brace-imaginary-offset
0
429 "*Imagined indentation of an open brace that actually follows a statement."
432 (defcustom perl-label-offset -
2
433 "*Offset of Perl label lines relative to usual indentation."
436 (defcustom perl-indent-continued-arguments nil
437 "*If non-nil offset of argument lines relative to usual indentation.
438 If nil, continued arguments are aligned with the first argument."
439 :type
'(choice integer
(const nil
))
442 (defcustom perl-tab-always-indent tab-always-indent
443 "Non-nil means TAB in Perl mode always indents the current line.
444 Otherwise it inserts a tab character if you type it past the first
445 nonwhite character on the line."
449 ;; I changed the default to nil for consistency with general Emacs
450 ;; conventions -- rms.
451 (defcustom perl-tab-to-comment nil
452 "*Non-nil means TAB moves to eol or makes a comment in some cases.
453 For lines which don't need indenting, TAB either indents an
454 existing comment, moves to end-of-line, or if at end-of-line already,
455 create a new comment."
459 (defcustom perl-nochange
";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:[^:]"
460 "*Lines starting with this regular expression are not auto-indented."
466 (defvar perl-outline-regexp
467 (concat (mapconcat 'cadr perl-imenu-generic-expression
"\\|")
470 (defun perl-outline-level ()
472 ((looking-at "package\\s-") 0)
473 ((looking-at "sub\\s-") 1)
474 ((looking-at "=head[0-9]") (- (char-before (match-end 0)) ?
0))
475 ((looking-at "=cut") 1)
478 (defvar perl-mode-hook nil
479 "Normal hook to run when entering Perl mode.")
483 "Major mode for editing Perl code.
484 Expression and list commands understand all Perl brackets.
485 Tab indents for Perl code.
486 Comments are delimited with # ... \\n.
487 Paragraphs are separated by blank lines only.
488 Delete converts tabs to spaces as it moves back.
490 Variables controlling indentation style:
491 `perl-tab-always-indent'
492 Non-nil means TAB in Perl mode should always indent the current line,
493 regardless of where in the line point is when the TAB command is used.
494 `perl-tab-to-comment'
495 Non-nil means that for lines which don't need indenting, TAB will
496 either delete an empty comment, indent an existing comment, move
497 to end-of-line, or if at end-of-line already, create a new comment.
499 Lines starting with this regular expression are not auto-indented.
501 Indentation of Perl statements within surrounding block.
502 The surrounding block's indentation is the indentation
503 of the line on which the open-brace appears.
504 `perl-continued-statement-offset'
505 Extra indentation given to a substatement, such as the
506 then-clause of an if or body of a while.
507 `perl-continued-brace-offset'
508 Extra indentation given to a brace that starts a substatement.
509 This is in addition to `perl-continued-statement-offset'.
511 Extra indentation for line if it starts with an open brace.
512 `perl-brace-imaginary-offset'
513 An open brace following other text is treated as if it were
514 this far to the right of the start of its line.
516 Extra indentation for line that is a label.
517 `perl-indent-continued-arguments'
518 Offset of argument lines relative to usual indentation.
520 Various indentation styles: K&R BSD BLK GNU LW
521 perl-indent-level 5 8 0 2 4
522 perl-continued-statement-offset 5 8 4 2 4
523 perl-continued-brace-offset 0 0 0 0 -4
524 perl-brace-offset -5 -8 0 0 0
525 perl-brace-imaginary-offset 0 0 4 0 0
526 perl-label-offset -5 -8 -2 -2 -2
528 Turning on Perl mode runs the normal hook `perl-mode-hook'."
530 (kill-all-local-variables)
531 (use-local-map perl-mode-map
)
532 (setq major-mode
'perl-mode
)
533 (setq mode-name
"Perl")
534 (setq local-abbrev-table perl-mode-abbrev-table
)
535 (set-syntax-table perl-mode-syntax-table
)
536 (make-local-variable 'paragraph-start
)
537 (setq paragraph-start
(concat "$\\|" page-delimiter
))
538 (make-local-variable 'paragraph-separate
)
539 (setq paragraph-separate paragraph-start
)
540 (make-local-variable 'paragraph-ignore-fill-prefix
)
541 (setq paragraph-ignore-fill-prefix t
)
542 (make-local-variable 'indent-line-function
)
543 (setq indent-line-function
'perl-indent-line
)
544 (make-local-variable 'require-final-newline
)
545 (setq require-final-newline mode-require-final-newline
)
546 (make-local-variable 'comment-start
)
547 (setq comment-start
"# ")
548 (make-local-variable 'comment-end
)
549 (setq comment-end
"")
550 (make-local-variable 'comment-start-skip
)
551 (setq comment-start-skip
"\\(^\\|\\s-\\);?#+ *")
552 (make-local-variable 'comment-indent-function
)
553 (setq comment-indent-function
'perl-comment-indent
)
554 (make-local-variable 'parse-sexp-ignore-comments
)
555 (setq parse-sexp-ignore-comments t
)
556 ;; Tell font-lock.el how to handle Perl.
557 (setq font-lock-defaults
'((perl-font-lock-keywords
558 perl-font-lock-keywords-1
559 perl-font-lock-keywords-2
)
560 nil nil
((?\_ .
"w")) nil
561 (font-lock-syntactic-keywords
562 . perl-font-lock-syntactic-keywords
)
563 (parse-sexp-lookup-properties . t
)))
564 ;; Tell imenu how to handle Perl.
565 (set (make-local-variable 'imenu-generic-expression
)
566 perl-imenu-generic-expression
)
567 (setq imenu-case-fold-search nil
)
568 ;; Setup outline-minor-mode.
569 (set (make-local-variable 'outline-regexp
) perl-outline-regexp
)
570 (set (make-local-variable 'outline-level
) 'perl-outline-level
)
571 (run-mode-hooks 'perl-mode-hook
))
573 ;; This is used by indent-for-comment
574 ;; to decide how much to indent a comment in Perl code
575 ;; based on its context.
576 (defun perl-comment-indent ()
577 (if (and (bolp) (not (eolp)))
578 0 ;Existing comment at bol stays there.
581 (defalias 'electric-perl-terminator
'perl-electric-terminator
)
582 (defun perl-electric-terminator (arg)
583 "Insert character and adjust indentation.
584 If at end-of-line, and not in a comment or a quote, correct the's indentation."
586 (let ((insertpos (point)))
587 (and (not arg
) ; decide whether to indent
591 (and (not ; eliminate comments quickly
592 (and comment-start-skip
593 (re-search-forward comment-start-skip insertpos t
)) )
594 (or (/= last-command-char ?
:)
595 ;; Colon is special only after a label ....
596 (looking-at "\\s-*\\(\\w\\|\\s_\\)+$"))
597 (let ((pps (parse-partial-sexp
598 (perl-beginning-of-function) insertpos
)))
599 (not (or (nth 3 pps
) (nth 4 pps
) (nth 5 pps
))))))
600 (progn ; must insert, indent, delete
601 (insert-char last-command-char
1)
604 (self-insert-command (prefix-numeric-value arg
)))
606 ;; not used anymore, but may be useful someday:
607 ;;(defun perl-inside-parens-p ()
608 ;; (condition-case ()
611 ;; (narrow-to-region (point)
612 ;; (perl-beginning-of-function))
613 ;; (goto-char (point-max))
614 ;; (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
617 (defun perl-indent-command (&optional arg
)
618 "Indent current line as Perl code, or optionally, insert a tab character.
620 With an argument, indent the current line, regardless of other options.
622 If `perl-tab-always-indent' is nil and point is not in the indentation
623 area at the beginning of the line, simply insert a tab.
625 Otherwise, indent the current line. If point was within the indentation
626 area it is moved to the end of the indentation area. If the line was
627 already indented properly and point was not within the indentation area,
628 and if `perl-tab-to-comment' is non-nil (the default), then do the first
629 possible action from the following list:
631 1) delete an empty comment
632 2) move forward to start of comment, indenting if necessary
633 3) move forward to end of line
634 4) create an empty comment
635 5) move backward to start of comment, indenting if necessary."
637 (if arg
; If arg, just indent this line
638 (perl-indent-line "\f")
639 (if (and (not perl-tab-always-indent
)
640 (> (current-column) (current-indentation)))
642 (let* ((oldpnt (point))
643 (lsexp (progn (beginning-of-line) (point)))
644 (bof (perl-beginning-of-function))
647 (perl-indent-line "\f\\|;?#" bof
))))
648 (and perl-tab-to-comment
649 (= oldpnt
(point)) ; done if point moved
650 (if (listp delta
) ; if line starts in a quoted string
651 (setq lsexp
(or (nth 2 delta
) bof
))
652 (= delta
0)) ; done if indenting occurred
653 (let ((eol (progn (end-of-line) (point)))
655 (if (= (char-after bof
) ?
=)
657 (message "In a format statement"))
658 (setq state
(parse-partial-sexp lsexp eol
))
660 (if (= oldpnt eol
) ; already at eol in a string
661 (message "In a string which starts with a %c."
663 (if (not (nth 4 state
))
664 (if (= oldpnt eol
) ; no comment, create one?
665 (indent-for-comment))
667 (if (and comment-start-skip
668 (re-search-forward comment-start-skip eol
'move
))
670 (progn ; delete existing comment
671 (goto-char (match-beginning 0))
672 (skip-chars-backward " \t")
673 (delete-region (point) eol
))
674 (if (or (< oldpnt
(point)) (= oldpnt eol
))
675 (indent-for-comment) ; indent existing comment
679 (message "Use backslash to quote # characters.")
682 (defun perl-indent-line (&optional nochange parse-start
)
683 "Indent current line as Perl code.
684 Return the amount the indentation
685 changed by, or (parse-state) if line starts in a quoted string."
686 (let ((case-fold-search nil
)
687 (pos (- (point-max) (point)))
688 (bof (or parse-start
(save-excursion (perl-beginning-of-function))))
689 beg indent shift-amt
)
693 (cond ((eq (char-after bof
) ?
=) 0)
694 ((listp (setq indent
(perl-calculate-indent bof
))) indent
)
695 ((looking-at (or nochange perl-nochange
)) 0)
697 (skip-chars-forward " \t\f")
698 (setq indent
(perl-indent-new-calculate nil indent bof
))
699 (- indent
(current-column)))))
700 (skip-chars-forward " \t\f")
701 (if (and (numberp shift-amt
) (/= 0 shift-amt
))
702 (progn (delete-region beg
(point))
704 ;; If initial point was within line's indentation,
705 ;; position after the indentation. Else stay at same point in text.
706 (if (> (- (point-max) pos
) (point))
707 (goto-char (- (point-max) pos
)))
710 (defun perl-continuation-line-p (limit)
711 "Move to end of previous line and return non-nil if continued."
712 ;; Statement level. Is it a continuation or a new statement?
713 ;; Find previous non-comment character.
714 (perl-backward-to-noncomment)
715 ;; Back up over label lines, since they don't
716 ;; affect whether our line is a continuation.
717 (while (or (eq (preceding-char) ?\
,)
718 (and (eq (preceding-char) ?
:)
719 (memq (char-syntax (char-after (- (point) 2)))
721 (if (eq (preceding-char) ?\
,)
722 (perl-backward-to-start-of-continued-exp limit
)
724 (perl-backward-to-noncomment))
725 ;; Now we get the answer.
726 (not (memq (preceding-char) '(?\
; ?\} ?\{))))
728 (defun perl-hanging-paren-p ()
729 "Non-nil if we are right after a hanging parenthesis-like char."
730 (and (looking-at "[ \t]*$")
732 (skip-syntax-backward " (") (not (bolp)))))
734 (defun perl-indent-new-calculate (&optional virtual default parse-start
)
736 (and virtual
(save-excursion (skip-chars-backward " \t") (bolp))
738 (and (looking-at "\\(\\w\\|\\s_\\)+:[^:]")
739 (max 1 (+ (or default
(perl-calculate-indent parse-start
))
741 (and (= (char-syntax (following-char)) ?\
))
745 (perl-indent-new-calculate
746 ;; Recalculate the parsing-start, since we may have jumped
747 ;; dangerously close (typically in the case of nested functions).
748 'virtual nil
(save-excursion (perl-beginning-of-function)))))
749 (and (and (= (following-char) ?
{)
750 (save-excursion (forward-char) (perl-hanging-paren-p)))
751 (+ (or default
(perl-calculate-indent parse-start
))
753 (or default
(perl-calculate-indent parse-start
))))
755 (defun perl-calculate-indent (&optional parse-start
)
756 "Return appropriate indentation for current line as Perl code.
757 In usual case returns an integer: the column to indent to.
758 Returns (parse-state) if line starts inside a string.
759 Optional argument PARSE-START should be the position of `beginning-of-defun'."
761 (let ((indent-point (point))
762 (case-fold-search nil
)
764 state containing-sexp
)
765 (if parse-start
;used to avoid searching
766 (goto-char parse-start
)
767 (perl-beginning-of-function))
768 ;; We might be now looking at a local function that has nothing to
769 ;; do with us because `indent-point' is past it. In this case
770 ;; look further back up for another `perl-beginning-of-function'.
771 (while (and (looking-at "{")
774 (looking-at "\\s-+sub\\>"))
775 (> indent-point
(save-excursion (forward-sexp 1) (point))))
776 (perl-beginning-of-function))
777 (while (< (point) indent-point
) ;repeat until right sexp
778 (setq state
(parse-partial-sexp (point) indent-point
0))
779 ;; state = (depth_in_parens innermost_containing_list
780 ;; last_complete_sexp string_terminator_or_nil inside_commentp
781 ;; following_quotep minimum_paren-depth_this_scan)
782 ;; Parsing stops if depth in parentheses becomes equal to third arg.
783 (setq containing-sexp
(nth 1 state
)))
784 (cond ((nth 3 state
) state
) ; In a quoted string?
785 ((null containing-sexp
) ; Line is at top level.
786 (skip-chars-forward " \t\f")
787 (if (= (following-char) ?
{)
788 0 ; move to beginning of line if it starts a function body
789 ;; indent a little if this is a continuation line
790 (perl-backward-to-noncomment)
792 (memq (preceding-char) '(?\
; ?\})))
793 0 perl-continued-statement-offset
)))
794 ((/= (char-after containing-sexp
) ?
{)
795 ;; line is expression, not statement:
796 ;; indent to just after the surrounding open.
797 (goto-char (1+ containing-sexp
))
798 (if (perl-hanging-paren-p)
799 ;; We're indenting an arg of a call like:
800 ;; $a = foobarlongnamefun (
805 (skip-syntax-backward "(")
807 (while (save-excursion
808 (skip-syntax-backward " ") (not (bolp)))
811 (+ (current-column) perl-indent-level
))
812 (if perl-indent-continued-arguments
813 (+ perl-indent-continued-arguments
(current-indentation))
814 (skip-chars-forward " \t")
817 ;; Statement level. Is it a continuation or a new statement?
818 (if (perl-continuation-line-p containing-sexp
)
819 ;; This line is continuation of preceding line's statement;
820 ;; indent perl-continued-statement-offset more than the
821 ;; previous line of the statement.
823 (perl-backward-to-start-of-continued-exp containing-sexp
)
824 (+ (if (save-excursion
825 (perl-continuation-line-p containing-sexp
))
826 ;; If the continued line is itself a continuation
827 ;; line, then align, otherwise add an offset.
828 0 perl-continued-statement-offset
)
830 (if (save-excursion (goto-char indent-point
)
831 (looking-at "[ \t]*{"))
832 perl-continued-brace-offset
0)))
833 ;; This line starts a new statement.
834 ;; Position at last unclosed open.
835 (goto-char containing-sexp
)
837 ;; Is line first statement after an open-brace?
838 ;; If no, find that first statement and indent like it.
841 ;; Skip over comments and labels following openbrace.
843 (skip-chars-forward " \t\f\n")
844 (cond ((looking-at ";?#")
846 ((looking-at "\\(\\w\\|\\s_\\)+:[^:]")
849 (setq colon-line-end
(point)))
850 (search-forward ":")))))
851 ;; The first following code counts
852 ;; if it is before the line we want to indent.
853 (and (< (point) indent-point
)
854 (if (> colon-line-end
(point))
855 (- (current-indentation) perl-label-offset
)
857 ;; If no previous statement,
858 ;; indent it relative to line brace is on.
859 ;; For open paren in column zero, don't let statement
860 ;; start there too. If perl-indent-level is zero,
861 ;; use perl-brace-offset + perl-continued-statement-offset
862 ;; For open-braces not the first thing in a line,
863 ;; add in perl-brace-imaginary-offset.
864 (+ (if (and (bolp) (zerop perl-indent-level
))
865 (+ perl-brace-offset perl-continued-statement-offset
)
867 ;; Move back over whitespace before the openbrace.
868 ;; If openbrace is not first nonwhite thing on the line,
869 ;; add the perl-brace-imaginary-offset.
870 (progn (skip-chars-backward " \t")
871 (if (bolp) 0 perl-brace-imaginary-offset
))
872 ;; If the openbrace is preceded by a parenthesized exp,
873 ;; move to the beginning of that;
874 ;; possibly a different line
876 (if (eq (preceding-char) ?\
))
878 ;; Get initial indentation of the line we are on.
879 (current-indentation))))))))))
881 (defun perl-backward-to-noncomment ()
882 "Move point backward to after the first non-white-space, skipping comments."
884 (forward-comment (- (point-max))))
886 (defun perl-backward-to-start-of-continued-exp (lim)
887 (if (= (preceding-char) ?\
))
891 (goto-char (1+ lim
)))
892 (skip-chars-forward " \t\f"))
894 ;; note: this may be slower than the c-mode version, but I can understand it.
895 (defalias 'indent-perl-exp
'perl-indent-exp
)
896 (defun perl-indent-exp ()
897 "Indent each line of the Perl grouping following point."
899 (let* ((case-fold-search nil
)
900 (oldpnt (point-marker))
901 (bof-mark (save-excursion
903 (perl-beginning-of-function)
905 eol last-mark lsexp-mark delta
)
906 (if (= (char-after (marker-position bof-mark
)) ?
=)
907 (message "Can't indent a format statement")
908 (message "Indenting Perl expression...")
909 (save-excursion (end-of-line) (setq eol
(point)))
910 (save-excursion ; locate matching close paren
911 (while (and (not (eobp)) (<= (point) eol
))
912 (parse-partial-sexp (point) (point-max) 0))
913 (setq last-mark
(point-marker)))
914 (setq lsexp-mark bof-mark
)
916 (while (< (point) (marker-position last-mark
))
917 (setq delta
(perl-indent-line nil
(marker-position bof-mark
)))
918 (if (numberp delta
) ; unquoted start-of-line?
921 (delete-horizontal-space))
922 (setq lsexp-mark
(point-marker))))
925 (if (nth 4 (parse-partial-sexp (marker-position lsexp-mark
) eol
))
926 (progn ; line ends in a comment
928 (if (or (not (looking-at "\\s-*;?#"))
931 (= (- (current-indentation) delta
) comment-column
)))
932 (if (and comment-start-skip
933 (re-search-forward comment-start-skip eol t
))
934 (indent-for-comment))))) ; indent existing comment
936 (goto-char (marker-position oldpnt
))
937 (message "Indenting Perl expression...done"))))
939 (defun perl-beginning-of-function (&optional arg
)
940 "Move backward to next beginning-of-function, or as far as possible.
941 With argument, repeat that many times; negative args move forward.
942 Returns new value of point in all cases."
944 (or arg
(setq arg
1))
945 (if (< arg
0) (forward-char 1))
948 "^\\s(\\|^\\s-*sub\\b[ \t\n]*\\_<[^{]+{\\|^\\s-*format\\b[^=]*=\\|^\\."
950 (goto-char (1- (match-end 0))))
953 ;; note: this routine is adapted directly from emacs lisp.el, end-of-defun;
954 ;; no bugs have been removed :-)
955 (defun perl-end-of-function (&optional arg
)
956 "Move forward to next end-of-function.
957 The end of a function is found by moving forward from the beginning of one.
958 With argument, repeat that many times; negative args move backward."
960 (or arg
(setq arg
1))
962 (while (and (> arg
0) (< (point) (point-max)))
968 (perl-beginning-of-function 1)
971 (or (bobp) (forward-char -
1))
972 (perl-beginning-of-function -
1))
975 (skip-chars-forward " \t")
976 (if (looking-at "[#\n]")
982 (perl-beginning-of-function 1)
986 (if (progn (perl-beginning-of-function 2) (not (bobp)))
989 (skip-chars-forward " \t")
990 (if (looking-at "[#\n]")
992 (goto-char (point-min)))))
993 (setq arg
(1+ arg
)))))
995 (defalias 'mark-perl-function
'perl-mark-function
)
996 (defun perl-mark-function ()
997 "Put mark at end of Perl function, point at beginning."
1000 (perl-end-of-function)
1002 (perl-beginning-of-function)
1003 (backward-paragraph))
1005 (provide 'perl-mode
)
1007 ;; arch-tag: 8c7ff68d-15f3-46a2-ade2-b7c41f176826
1008 ;;; perl-mode.el ends here