Commit | Line | Data |
---|---|---|
4821e2af ER |
1 | ;;; perl-mode.el --- Perl code editing commands for GNU Emacs |
2 | ||
034babe1 NR |
3 | ;; Copyright (C) 1990, 1994, 2001, 2002, 2003, 2004, 2005 |
4 | ;; Free Software Foundation, Inc. | |
3a801d0c | 5 | |
4821e2af | 6 | ;; Author: William F. Mann |
012733b3 | 7 | ;; Maintainer: FSF |
4821e2af | 8 | ;; Adapted-By: ESR |
d7b4d18f | 9 | ;; Keywords: languages |
4821e2af | 10 | |
2076c87c JB |
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. | |
13 | ||
4da31937 RS |
14 | ;; This file is part of GNU Emacs. |
15 | ||
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 2, or (at your option) | |
19 | ;; any later version. | |
20 | ||
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. | |
25 | ||
26 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 27 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
3a35cf56 LK |
28 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
29 | ;; Boston, MA 02110-1301, USA. | |
2076c87c | 30 | |
4821e2af ER |
31 | ;;; Commentary: |
32 | ||
2076c87c JB |
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-*- | |
a7acbbe4 | 36 | ;; With arguments to perl: |
2076c87c JB |
37 | ;; #!/usr/bin/perl -P- # -*-Perl-*- |
38 | ;; To handle files included with do 'filename.pl';, add something like | |
c6818db9 | 39 | ;; (setq auto-mode-alist (append (list (cons "\\.pl\\'" 'perl-mode)) |
2076c87c JB |
40 | ;; auto-mode-alist)) |
41 | ;; to your .emacs file; otherwise the .pl suffix defaults to prolog-mode. | |
42 | ||
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. | |
45 | ||
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 \#. | |
52 | ||
53 | ;; If your machine is slow, you may want to remove some of the bindings | |
4b8dfb43 | 54 | ;; to perl-electric-terminator. I changed the indenting defaults to be |
2076c87c JB |
55 | ;; what Larry Wall uses in perl/lib, but left in all the options. |
56 | ||
57 | ;; I also tuned a few things: comments and labels starting in column | |
4b8dfb43 | 58 | ;; zero are left there by perl-indent-exp; perl-beginning-of-function |
2076c87c | 59 | ;; goes back to the first open brace/paren in column zero, the open brace |
4b8dfb43 | 60 | ;; in 'sub ... {', or the equal sign in 'format ... ='; perl-indent-exp |
2076c87c JB |
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. | |
63 | ||
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. | |
66 | ||
282d89c0 | 67 | ;; Known problems (these are all caused by limitations in the Emacs Lisp |
2076c87c JB |
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): | |
2076c87c JB |
70 | ;; 2) The globbing syntax <pattern> is not recognized, so special |
71 | ;; characters in the pattern string must be backslashed. | |
d3627c47 | 72 | ;; 3) The << quoting operators are not recognized; see below. |
4a0aa1d9 SM |
73 | ;; 5) To make '$' work correctly, $' is not recognized as a variable. |
74 | ;; Use "$'" or $POSTMATCH instead. | |
4a0aa1d9 SM |
75 | ;; |
76 | ;; If you don't use font-lock, additional problems will appear: | |
d3627c47 SM |
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. | |
2076c87c | 81 | ;; 5) To make variables such a $' and $#array work, perl-mode treats |
4a0aa1d9 | 82 | ;; $ just like backslash, so '$' is not treated correctly. |
2076c87c JB |
83 | ;; 6) Unfortunately, treating $ like \ makes ${var} be treated as an |
84 | ;; unmatched }. See below. | |
d3627c47 SM |
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. | |
2076c87c JB |
87 | |
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: | |
93 | ;; | |
94 | ;; /`/; $ugly = q?"'$?; /`/; | |
95 | ;; | |
d3627c47 SM |
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}>) | |
a1506d29 | 100 | ;; |
2076c87c JB |
101 | ;; Problem 7 is even worse, but this 'fix' does work :-( |
102 | ;; $DB'stop#' | |
103 | ;; [$DB'line#' | |
104 | ;; ] =~ s/;9$//; | |
105 | ||
4821e2af | 106 | ;;; Code: |
2076c87c | 107 | |
4b8dfb43 SM |
108 | (eval-when-compile (require 'cl)) |
109 | ||
a69add87 JB |
110 | (defvar font-lock-comment-face) |
111 | (defvar font-lock-doc-face) | |
112 | (defvar font-lock-string-face) | |
113 | ||
5636765c SE |
114 | (defgroup perl nil |
115 | "Major mode for editing Perl code." | |
8ec3bce0 | 116 | :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces) |
5636765c SE |
117 | :prefix "perl-" |
118 | :group 'languages) | |
119 | ||
9f2e5ef3 RS |
120 | (defvar perl-mode-abbrev-table nil |
121 | "Abbrev table in use in perl-mode buffers.") | |
122 | (define-abbrev-table 'perl-mode-abbrev-table ()) | |
123 | ||
4b8dfb43 SM |
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) | |
136 | map) | |
4a0aa1d9 | 137 | "Keymap used in Perl mode.") |
2076c87c JB |
138 | |
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." | |
142 | t) | |
143 | ||
4b8dfb43 SM |
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) | |
42be8f2e SM |
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) | |
d3627c47 SM |
151 | (modify-syntax-entry ?% ". p" st) |
152 | (modify-syntax-entry ?@ ". p" st) | |
4b8dfb43 SM |
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) | |
165 | st) | |
166 | "Syntax table in use in `perl-mode' buffers.") | |
2076c87c | 167 | |
f42484a2 | 168 | (defvar perl-imenu-generic-expression |
4b8dfb43 | 169 | '(;; Functions |
35c5f5d3 | 170 | (nil "^sub\\s-+\\([-A-Za-z0-9+_:]+\\)" 1) |
f42484a2 | 171 | ;;Variables |
35c5f5d3 SM |
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)) | |
f42484a2 RS |
175 | "Imenu generic expression for Perl mode. See `imenu-generic-expression'.") |
176 | ||
3e7fc8bd SM |
177 | ;; Regexps updated with help from Tom Tromey <tromey@cambric.colorado.edu> and |
178 | ;; Jim Campbell <jec@murzim.ca.boeing.com>. | |
179 | ||
180 | (defconst perl-font-lock-keywords-1 | |
181 | '(;; What is this for? | |
182 | ;;("\\(--- .* ---\\|=== .* ===\\)" . font-lock-string-face) | |
183 | ;; | |
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. | |
4b8dfb43 SM |
186 | ;; ("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face) |
187 | ;; ("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face) | |
188 | ;; ("^#[ \t]*if\\>" | |
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)) | |
3e7fc8bd SM |
193 | ;; |
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+\\)?" | |
883212ce | 198 | (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))) |
3e7fc8bd SM |
199 | "Subdued level highlighting for Perl mode.") |
200 | ||
201 | (defconst perl-font-lock-keywords-2 | |
202 | (append perl-font-lock-keywords-1 | |
203 | (list | |
204 | ;; | |
205 | ;; Fontify keywords, except those fontified otherwise. | |
d3627c47 SM |
206 | (concat "\\<" |
207 | (regexp-opt '("if" "until" "while" "elsif" "else" "unless" | |
208 | "do" "dump" "for" "foreach" "exit" "die" | |
209 | "BEGIN" "END" "return" "exec" "eval") t) | |
210 | "\\>") | |
3e7fc8bd SM |
211 | ;; |
212 | ;; Fontify local and my keywords as types. | |
213 | '("\\<\\(local\\|my\\)\\>" . font-lock-type-face) | |
214 | ;; | |
215 | ;; Fontify function, variable and file name references. | |
44ebeb1b | 216 | '("&\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-function-name-face) |
3e7fc8bd SM |
217 | ;; Additionally underline non-scalar variables. Maybe this is a bad idea. |
218 | ;;'("[$@%*][#{]?\\(\\sw+\\)" 1 font-lock-variable-name-face) | |
44ebeb1b SM |
219 | '("[$*]{?\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-variable-name-face) |
220 | '("\\([@%]\\|\\$#\\)\\(\\sw+\\(::\\sw+\\)*\\)" | |
3e7fc8bd | 221 | (2 (cons font-lock-variable-name-face '(underline)))) |
883212ce | 222 | '("<\\(\\sw+\\)>" 1 font-lock-constant-face) |
3e7fc8bd SM |
223 | ;; |
224 | ;; Fontify keywords with/and labels as we do in `c++-font-lock-keywords'. | |
225 | '("\\<\\(continue\\|goto\\|last\\|next\\|redo\\)\\>[ \t]*\\(\\sw+\\)?" | |
883212ce SM |
226 | (1 font-lock-keyword-face) (2 font-lock-constant-face nil t)) |
227 | '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-constant-face))) | |
3e7fc8bd SM |
228 | "Gaudy level highlighting for Perl mode.") |
229 | ||
230 | (defvar perl-font-lock-keywords perl-font-lock-keywords-1 | |
231 | "Default expressions to highlight in Perl mode.") | |
232 | ||
d3627c47 SM |
233 | (defvar perl-quote-like-pairs |
234 | '((?\( . ?\)) (?\[ . ?\]) (?\{ . ?\}) (?\< . ?\>))) | |
235 | ||
236 | ;; FIXME: handle here-docs and regexps. | |
237 | ;; <<EOF <<"EOF" <<'EOF' (no space) | |
238 | ;; see `man perlop' | |
239 | ;; ?...? | |
240 | ;; /.../ | |
241 | ;; m [...] | |
242 | ;; m /.../ | |
243 | ;; q /.../ = '...' | |
244 | ;; qq /.../ = "..." | |
245 | ;; qx /.../ = `...` | |
246 | ;; qr /.../ = precompiled regexp =~=~ m/.../ | |
247 | ;; qw /.../ | |
248 | ;; s /.../.../ | |
249 | ;; s <...> /.../ | |
250 | ;; s '...'...' | |
251 | ;; tr /.../.../ | |
252 | ;; y /.../.../ | |
253 | ;; | |
254 | ;; <file*glob> | |
4a0aa1d9 | 255 | (defvar perl-font-lock-syntactic-keywords |
8b9e43d1 SM |
256 | ;; TODO: here-documents ("<<\\(\\sw\\|['\"]\\)") |
257 | '(;; Turn POD into b-style comments | |
258 | ("^\\(=\\)\\sw" (1 "< b")) | |
4a0aa1d9 SM |
259 | ("^=cut[ \t]*\\(\n\\)" (1 "> b")) |
260 | ;; Catch ${ so that ${var} doesn't screw up indentation. | |
d3627c47 SM |
261 | ;; This also catches $' to handle 'foo$', although it should really |
262 | ;; check that it occurs inside a '..' string. | |
42be8f2e | 263 | ("\\(\\$\\)[{']" (1 ". p")) |
d3627c47 SM |
264 | ;; Handle funny names like $DB'stop. |
265 | ("\\$ ?{?^?[_a-zA-Z][_a-zA-Z0-9]*\\('\\)[_a-zA-Z]" (1 "_")) | |
266 | ;; format statements | |
267 | ("^[ \t]*format.*=[ \t]*\\(\n\\)" (1 '(7))) | |
268 | ;; Funny things in sub arg specifications like `sub myfunc ($$)' | |
269 | ("\\<sub\\s-+\\S-+\\s-*(\\([^)]+\\))" 1 '(1)) | |
270 | ;; regexp and funny quotes | |
8bee1018 | 271 | ("[?:.,;=!~({[][ \t\n]*\\(/\\)" (1 '(7))) |
dcc6da3a | 272 | ("\\(^\\|[?:.,;=!~({[ \t]\\)\\([msy]\\|q[qxrw]?\\|tr\\)\\>\\s-*\\([^])}> \n\t]\\)" |
d3627c47 SM |
273 | ;; Nasty cases: |
274 | ;; /foo/m $a->m $#m $m @m %m | |
275 | ;; \s (appears often in regexps). | |
276 | ;; -s file | |
dcc6da3a | 277 | (3 (if (assoc (char-after (match-beginning 3)) |
d3627c47 | 278 | perl-quote-like-pairs) |
8bee1018 | 279 | '(15) '(7)))) |
8b9e43d1 SM |
280 | ;; Find and mark the end of funny quotes and format statements. |
281 | (perl-font-lock-special-syntactic-constructs) | |
8bee1018 | 282 | )) |
d3627c47 SM |
283 | |
284 | (defvar perl-empty-syntax-table | |
285 | (let ((st (copy-syntax-table))) | |
286 | ;; Make all chars be of punctuation syntax. | |
287 | (dotimes (i 256) (aset st i '(1))) | |
288 | (modify-syntax-entry ?\\ "\\" st) | |
289 | st) | |
290 | "Syntax table used internally for processing quote-like operators.") | |
291 | ||
292 | (defun perl-quote-syntax-table (char) | |
293 | (let ((close (cdr (assq char perl-quote-like-pairs))) | |
294 | (st (copy-syntax-table perl-empty-syntax-table))) | |
295 | (if (not close) | |
296 | (modify-syntax-entry char "\"" st) | |
297 | (modify-syntax-entry char "(" st) | |
298 | (modify-syntax-entry close ")" st)) | |
299 | st)) | |
4a0aa1d9 | 300 | |
8b9e43d1 SM |
301 | (defun perl-font-lock-special-syntactic-constructs (limit) |
302 | ;; We used to do all this in a font-lock-syntactic-face-function, which | |
303 | ;; did not work correctly because sometimes some parts of the buffer are | |
304 | ;; treated with font-lock-syntactic-keywords but not with | |
305 | ;; font-lock-syntactic-face-function (mostly because of | |
306 | ;; font-lock-syntactically-fontified). That meant that some syntax-table | |
307 | ;; properties were missing. So now we do the parse-partial-sexp loop | |
308 | ;; ourselves directly from font-lock-syntactic-keywords, so we're sure | |
309 | ;; it's done when necessary. | |
310 | (let ((state (syntax-ppss)) | |
311 | char) | |
312 | (while (< (point) limit) | |
313 | (cond | |
314 | ((or (null (setq char (nth 3 state))) | |
315 | (and (char-valid-p char) (eq (char-syntax (nth 3 state)) ?\"))) | |
316 | ;; Normal text, or comment, or docstring, or normal string. | |
317 | nil) | |
318 | ((eq (nth 3 state) ?\n) | |
319 | ;; A `format' command. | |
320 | (save-excursion | |
321 | (when (and (re-search-forward "^\\s *\\.\\s *$" nil t) | |
322 | (not (eobp))) | |
323 | (put-text-property (point) (1+ (point)) 'syntax-table '(7))))) | |
324 | (t | |
325 | ;; This is regexp like quote thingy. | |
326 | (setq char (char-after (nth 8 state))) | |
327 | (save-excursion | |
328 | (let ((twoargs (save-excursion | |
329 | (goto-char (nth 8 state)) | |
330 | (skip-syntax-backward " ") | |
331 | (skip-syntax-backward "w") | |
332 | (member (buffer-substring | |
333 | (point) (progn (forward-word 1) (point))) | |
334 | '("tr" "s" "y")))) | |
335 | (close (cdr (assq char perl-quote-like-pairs))) | |
336 | (pos (point)) | |
337 | (st (perl-quote-syntax-table char))) | |
338 | (if (not close) | |
339 | ;; The closing char is the same as the opening char. | |
340 | (with-syntax-table st | |
341 | (parse-partial-sexp (point) (point-max) | |
342 | nil nil state 'syntax-table) | |
343 | (when twoargs | |
344 | (parse-partial-sexp (point) (point-max) | |
345 | nil nil state 'syntax-table))) | |
346 | ;; The open/close chars are matched like () [] {} and <>. | |
347 | (let ((parse-sexp-lookup-properties nil)) | |
348 | (condition-case err | |
349 | (progn | |
350 | (with-syntax-table st | |
351 | (goto-char (nth 8 state)) (forward-sexp 1)) | |
352 | (when twoargs | |
353 | (save-excursion | |
354 | ;; Skip whitespace and make sure that font-lock will | |
355 | ;; refontify the second part in the proper context. | |
356 | (put-text-property | |
357 | (point) (progn (forward-comment (point-max)) (point)) | |
358 | 'font-lock-multiline t) | |
359 | ;; | |
360 | (unless | |
361 | (save-excursion | |
362 | (with-syntax-table | |
363 | (perl-quote-syntax-table (char-after)) | |
364 | (forward-sexp 1)) | |
365 | (put-text-property pos (line-end-position) | |
366 | 'jit-lock-defer-multiline t) | |
367 | (looking-at "\\s-*\\sw*e")) | |
368 | (put-text-property (point) (1+ (point)) | |
369 | 'syntax-table | |
370 | (if (assoc (char-after) | |
371 | perl-quote-like-pairs) | |
372 | '(15) '(7))))))) | |
373 | ;; The arg(s) is not terminated, so it extends until EOB. | |
374 | (scan-error (goto-char (point-max)))))) | |
375 | ;; Point is now right after the arg(s). | |
376 | ;; Erase any syntactic marks within the quoted text. | |
377 | (put-text-property pos (1- (point)) 'syntax-table nil) | |
378 | (when (eq (char-before (1- (point))) ?$) | |
379 | (put-text-property (- (point) 2) (1- (point)) | |
380 | 'syntax-table '(1))) | |
381 | (put-text-property (1- (point)) (point) | |
382 | 'syntax-table (if close '(15) '(7))))))) | |
383 | ||
384 | (setq state (parse-partial-sexp (point) limit nil nil state | |
385 | 'syntax-table)))) | |
386 | ;; Tell font-lock that this needs not further processing. | |
387 | nil) | |
a1506d29 | 388 | |
9e551477 | 389 | |
5636765c SE |
390 | (defcustom perl-indent-level 4 |
391 | "*Indentation of Perl statements with respect to containing block." | |
f5307782 JB |
392 | :type 'integer |
393 | :group 'perl) | |
5636765c SE |
394 | (defcustom perl-continued-statement-offset 4 |
395 | "*Extra indent for lines not starting new statements." | |
f5307782 JB |
396 | :type 'integer |
397 | :group 'perl) | |
5636765c | 398 | (defcustom perl-continued-brace-offset -4 |
2076c87c | 399 | "*Extra indent for substatements that start with open-braces. |
5636765c | 400 | This is in addition to `perl-continued-statement-offset'." |
f5307782 JB |
401 | :type 'integer |
402 | :group 'perl) | |
5636765c SE |
403 | (defcustom perl-brace-offset 0 |
404 | "*Extra indentation for braces, compared with other text in same context." | |
f5307782 JB |
405 | :type 'integer |
406 | :group 'perl) | |
5636765c SE |
407 | (defcustom perl-brace-imaginary-offset 0 |
408 | "*Imagined indentation of an open brace that actually follows a statement." | |
f5307782 JB |
409 | :type 'integer |
410 | :group 'perl) | |
5636765c SE |
411 | (defcustom perl-label-offset -2 |
412 | "*Offset of Perl label lines relative to usual indentation." | |
f5307782 JB |
413 | :type 'integer |
414 | :group 'perl) | |
df3fd736 GM |
415 | (defcustom perl-indent-continued-arguments nil |
416 | "*If non-nil offset of argument lines relative to usual indentation. | |
417 | If nil, continued arguments are aligned with the first argument." | |
f5307782 JB |
418 | :type '(choice integer (const nil)) |
419 | :group 'perl) | |
5636765c | 420 | |
bbce4eb4 SM |
421 | (defcustom perl-tab-always-indent tab-always-indent |
422 | "Non-nil means TAB in Perl mode always indents the current line. | |
10e6ca88 | 423 | Otherwise it inserts a tab character if you type it past the first |
5636765c | 424 | nonwhite character on the line." |
f5307782 JB |
425 | :type 'boolean |
426 | :group 'perl) | |
2076c87c | 427 | |
15cb2300 RS |
428 | ;; I changed the default to nil for consistency with general Emacs |
429 | ;; conventions -- rms. | |
5636765c | 430 | (defcustom perl-tab-to-comment nil |
10e6ca88 RS |
431 | "*Non-nil means TAB moves to eol or makes a comment in some cases. |
432 | For lines which don't need indenting, TAB either indents an | |
433 | existing comment, moves to end-of-line, or if at end-of-line already, | |
5636765c | 434 | create a new comment." |
f5307782 JB |
435 | :type 'boolean |
436 | :group 'perl) | |
5636765c | 437 | |
8a525646 | 438 | (defcustom perl-nochange ";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:[^:]" |
5636765c | 439 | "*Lines starting with this regular expression are not auto-indented." |
f5307782 JB |
440 | :type 'regexp |
441 | :group 'perl) | |
35c5f5d3 SM |
442 | |
443 | ;; Outline support | |
444 | ||
445 | (defvar perl-outline-regexp | |
446 | (concat (mapconcat 'cadr perl-imenu-generic-expression "\\|") | |
447 | "\\|^=cut\\>")) | |
448 | ||
449 | (defun perl-outline-level () | |
450 | (cond | |
451 | ((looking-at "package\\s-") 0) | |
452 | ((looking-at "sub\\s-") 1) | |
453 | ((looking-at "=head[0-9]") (- (char-before (match-end 0)) ?0)) | |
454 | ((looking-at "=cut") 1) | |
455 | (t 3))) | |
2076c87c | 456 | \f |
8eac6e91 RS |
457 | (defvar perl-mode-hook nil |
458 | "Normal hook to run when entering Perl mode.") | |
459 | ||
d06ad999 | 460 | ;;;###autoload |
23d107d7 | 461 | (defun perl-mode () |
2076c87c JB |
462 | "Major mode for editing Perl code. |
463 | Expression and list commands understand all Perl brackets. | |
464 | Tab indents for Perl code. | |
465 | Comments are delimited with # ... \\n. | |
466 | Paragraphs are separated by blank lines only. | |
467 | Delete converts tabs to spaces as it moves back. | |
468 | \\{perl-mode-map} | |
469 | Variables controlling indentation style: | |
df3fd736 | 470 | `perl-tab-always-indent' |
2076c87c JB |
471 | Non-nil means TAB in Perl mode should always indent the current line, |
472 | regardless of where in the line point is when the TAB command is used. | |
df3fd736 | 473 | `perl-tab-to-comment' |
2076c87c | 474 | Non-nil means that for lines which don't need indenting, TAB will |
a1506d29 | 475 | either delete an empty comment, indent an existing comment, move |
2076c87c | 476 | to end-of-line, or if at end-of-line already, create a new comment. |
df3fd736 | 477 | `perl-nochange' |
10e6ca88 | 478 | Lines starting with this regular expression are not auto-indented. |
df3fd736 | 479 | `perl-indent-level' |
2076c87c JB |
480 | Indentation of Perl statements within surrounding block. |
481 | The surrounding block's indentation is the indentation | |
482 | of the line on which the open-brace appears. | |
df3fd736 | 483 | `perl-continued-statement-offset' |
2076c87c JB |
484 | Extra indentation given to a substatement, such as the |
485 | then-clause of an if or body of a while. | |
df3fd736 | 486 | `perl-continued-brace-offset' |
2076c87c | 487 | Extra indentation given to a brace that starts a substatement. |
10e6ca88 | 488 | This is in addition to `perl-continued-statement-offset'. |
df3fd736 | 489 | `perl-brace-offset' |
2076c87c | 490 | Extra indentation for line if it starts with an open brace. |
df3fd736 | 491 | `perl-brace-imaginary-offset' |
2076c87c JB |
492 | An open brace following other text is treated as if it were |
493 | this far to the right of the start of its line. | |
df3fd736 | 494 | `perl-label-offset' |
2076c87c | 495 | Extra indentation for line that is a label. |
df3fd736 GM |
496 | `perl-indent-continued-arguments' |
497 | Offset of argument lines relative to usual indentation. | |
2076c87c JB |
498 | |
499 | Various indentation styles: K&R BSD BLK GNU LW | |
500 | perl-indent-level 5 8 0 2 4 | |
501 | perl-continued-statement-offset 5 8 4 2 4 | |
502 | perl-continued-brace-offset 0 0 0 0 -4 | |
503 | perl-brace-offset -5 -8 0 0 0 | |
504 | perl-brace-imaginary-offset 0 0 4 0 0 | |
505 | perl-label-offset -5 -8 -2 -2 -2 | |
506 | ||
10e6ca88 | 507 | Turning on Perl mode runs the normal hook `perl-mode-hook'." |
23d107d7 RS |
508 | (interactive) |
509 | (kill-all-local-variables) | |
510 | (use-local-map perl-mode-map) | |
511 | (setq major-mode 'perl-mode) | |
512 | (setq mode-name "Perl") | |
513 | (setq local-abbrev-table perl-mode-abbrev-table) | |
514 | (set-syntax-table perl-mode-syntax-table) | |
2076c87c | 515 | (make-local-variable 'paragraph-start) |
edae0c55 | 516 | (setq paragraph-start (concat "$\\|" page-delimiter)) |
2076c87c JB |
517 | (make-local-variable 'paragraph-separate) |
518 | (setq paragraph-separate paragraph-start) | |
519 | (make-local-variable 'paragraph-ignore-fill-prefix) | |
520 | (setq paragraph-ignore-fill-prefix t) | |
521 | (make-local-variable 'indent-line-function) | |
522 | (setq indent-line-function 'perl-indent-line) | |
523 | (make-local-variable 'require-final-newline) | |
d473a4f9 | 524 | (setq require-final-newline mode-require-final-newline) |
2076c87c JB |
525 | (make-local-variable 'comment-start) |
526 | (setq comment-start "# ") | |
527 | (make-local-variable 'comment-end) | |
528 | (setq comment-end "") | |
2076c87c JB |
529 | (make-local-variable 'comment-start-skip) |
530 | (setq comment-start-skip "\\(^\\|\\s-\\);?#+ *") | |
e41b2db1 ER |
531 | (make-local-variable 'comment-indent-function) |
532 | (setq comment-indent-function 'perl-comment-indent) | |
2076c87c | 533 | (make-local-variable 'parse-sexp-ignore-comments) |
7ac7f4c2 | 534 | (setq parse-sexp-ignore-comments t) |
3e7fc8bd | 535 | ;; Tell font-lock.el how to handle Perl. |
3e7fc8bd SM |
536 | (setq font-lock-defaults '((perl-font-lock-keywords |
537 | perl-font-lock-keywords-1 | |
538 | perl-font-lock-keywords-2) | |
4a0aa1d9 SM |
539 | nil nil ((?\_ . "w")) nil |
540 | (font-lock-syntactic-keywords | |
541 | . perl-font-lock-syntactic-keywords) | |
4a0aa1d9 | 542 | (parse-sexp-lookup-properties . t))) |
f42484a2 | 543 | ;; Tell imenu how to handle Perl. |
35c5f5d3 SM |
544 | (set (make-local-variable 'imenu-generic-expression) |
545 | perl-imenu-generic-expression) | |
23d107d7 | 546 | (setq imenu-case-fold-search nil) |
35c5f5d3 SM |
547 | ;; Setup outline-minor-mode. |
548 | (set (make-local-variable 'outline-regexp) perl-outline-regexp) | |
549 | (set (make-local-variable 'outline-level) 'perl-outline-level) | |
8eac6e91 | 550 | (run-mode-hooks 'perl-mode-hook)) |
2076c87c JB |
551 | \f |
552 | ;; This is used by indent-for-comment | |
553 | ;; to decide how much to indent a comment in Perl code | |
554 | ;; based on its context. | |
555 | (defun perl-comment-indent () | |
556 | (if (and (bolp) (not (eolp))) | |
557 | 0 ;Existing comment at bol stays there. | |
4b8dfb43 SM |
558 | comment-column)) |
559 | ||
560 | (defalias 'electric-perl-terminator 'perl-electric-terminator) | |
561 | (defun perl-electric-terminator (arg) | |
10e6ca88 RS |
562 | "Insert character and adjust indentation. |
563 | If at end-of-line, and not in a comment or a quote, correct the's indentation." | |
2076c87c JB |
564 | (interactive "P") |
565 | (let ((insertpos (point))) | |
566 | (and (not arg) ; decide whether to indent | |
567 | (eolp) | |
568 | (save-excursion | |
569 | (beginning-of-line) | |
570 | (and (not ; eliminate comments quickly | |
5b1bdb5f RS |
571 | (and comment-start-skip |
572 | (re-search-forward comment-start-skip insertpos t)) ) | |
2076c87c JB |
573 | (or (/= last-command-char ?:) |
574 | ;; Colon is special only after a label .... | |
575 | (looking-at "\\s-*\\(\\w\\|\\s_\\)+$")) | |
a1506d29 | 576 | (let ((pps (parse-partial-sexp |
2076c87c JB |
577 | (perl-beginning-of-function) insertpos))) |
578 | (not (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))) | |
579 | (progn ; must insert, indent, delete | |
580 | (insert-char last-command-char 1) | |
581 | (perl-indent-line) | |
582 | (delete-char -1)))) | |
583 | (self-insert-command (prefix-numeric-value arg))) | |
584 | ||
585 | ;; not used anymore, but may be useful someday: | |
586 | ;;(defun perl-inside-parens-p () | |
587 | ;; (condition-case () | |
588 | ;; (save-excursion | |
589 | ;; (save-restriction | |
590 | ;; (narrow-to-region (point) | |
591 | ;; (perl-beginning-of-function)) | |
592 | ;; (goto-char (point-max)) | |
593 | ;; (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\())) | |
594 | ;; (error nil))) | |
595 | \f | |
596 | (defun perl-indent-command (&optional arg) | |
597 | "Indent current line as Perl code, or optionally, insert a tab character. | |
598 | ||
599 | With an argument, indent the current line, regardless of other options. | |
600 | ||
10e6ca88 | 601 | If `perl-tab-always-indent' is nil and point is not in the indentation |
2076c87c JB |
602 | area at the beginning of the line, simply insert a tab. |
603 | ||
604 | Otherwise, indent the current line. If point was within the indentation | |
605 | area it is moved to the end of the indentation area. If the line was | |
606 | already indented properly and point was not within the indentation area, | |
10e6ca88 | 607 | and if `perl-tab-to-comment' is non-nil (the default), then do the first |
2076c87c JB |
608 | possible action from the following list: |
609 | ||
610 | 1) delete an empty comment | |
611 | 2) move forward to start of comment, indenting if necessary | |
612 | 3) move forward to end of line | |
613 | 4) create an empty comment | |
614 | 5) move backward to start of comment, indenting if necessary." | |
615 | (interactive "P") | |
616 | (if arg ; If arg, just indent this line | |
617 | (perl-indent-line "\f") | |
618 | (if (and (not perl-tab-always-indent) | |
c1033e00 | 619 | (> (current-column) (current-indentation))) |
2076c87c | 620 | (insert-tab) |
df3fd736 GM |
621 | (let* ((oldpnt (point)) |
622 | (lsexp (progn (beginning-of-line) (point))) | |
623 | (bof (perl-beginning-of-function)) | |
624 | (delta (progn | |
625 | (goto-char oldpnt) | |
626 | (perl-indent-line "\f\\|;?#" bof)))) | |
2076c87c JB |
627 | (and perl-tab-to-comment |
628 | (= oldpnt (point)) ; done if point moved | |
629 | (if (listp delta) ; if line starts in a quoted string | |
630 | (setq lsexp (or (nth 2 delta) bof)) | |
631 | (= delta 0)) ; done if indenting occurred | |
df3fd736 GM |
632 | (let ((eol (progn (end-of-line) (point))) |
633 | state) | |
2076c87c JB |
634 | (if (= (char-after bof) ?=) |
635 | (if (= oldpnt eol) | |
df3fd736 | 636 | (message "In a format statement")) |
2076c87c JB |
637 | (setq state (parse-partial-sexp lsexp eol)) |
638 | (if (nth 3 state) | |
639 | (if (= oldpnt eol) ; already at eol in a string | |
640 | (message "In a string which starts with a %c." | |
641 | (nth 3 state))) | |
642 | (if (not (nth 4 state)) | |
643 | (if (= oldpnt eol) ; no comment, create one? | |
644 | (indent-for-comment)) | |
645 | (beginning-of-line) | |
5b1bdb5f RS |
646 | (if (and comment-start-skip |
647 | (re-search-forward comment-start-skip eol 'move)) | |
2076c87c JB |
648 | (if (eolp) |
649 | (progn ; kill existing comment | |
650 | (goto-char (match-beginning 0)) | |
651 | (skip-chars-backward " \t") | |
652 | (kill-region (point) eol)) | |
653 | (if (or (< oldpnt (point)) (= oldpnt eol)) | |
654 | (indent-for-comment) ; indent existing comment | |
655 | (end-of-line))) | |
656 | (if (/= oldpnt eol) | |
657 | (end-of-line) | |
658 | (message "Use backslash to quote # characters.") | |
659 | (ding t)))))))))))) | |
660 | ||
661 | (defun perl-indent-line (&optional nochange parse-start) | |
10e6ca88 | 662 | "Indent current line as Perl code. |
a1506d29 | 663 | Return the amount the indentation |
2076c87c JB |
664 | changed by, or (parse-state) if line starts in a quoted string." |
665 | (let ((case-fold-search nil) | |
666 | (pos (- (point-max) (point))) | |
667 | (bof (or parse-start (save-excursion (perl-beginning-of-function)))) | |
668 | beg indent shift-amt) | |
669 | (beginning-of-line) | |
670 | (setq beg (point)) | |
671 | (setq shift-amt | |
8ab2646a | 672 | (cond ((eq (char-after bof) ?=) 0) |
4b8dfb43 | 673 | ((listp (setq indent (perl-calculate-indent bof))) indent) |
2076c87c JB |
674 | ((looking-at (or nochange perl-nochange)) 0) |
675 | (t | |
676 | (skip-chars-forward " \t\f") | |
92aba9ab | 677 | (setq indent (perl-indent-new-calculate nil indent bof)) |
2076c87c JB |
678 | (- indent (current-column))))) |
679 | (skip-chars-forward " \t\f") | |
680 | (if (and (numberp shift-amt) (/= 0 shift-amt)) | |
681 | (progn (delete-region beg (point)) | |
682 | (indent-to indent))) | |
683 | ;; If initial point was within line's indentation, | |
684 | ;; position after the indentation. Else stay at same point in text. | |
685 | (if (> (- (point-max) pos) (point)) | |
686 | (goto-char (- (point-max) pos))) | |
687 | shift-amt)) | |
688 | ||
4a0aa1d9 SM |
689 | (defun perl-continuation-line-p (limit) |
690 | "Move to end of previous line and return non-nil if continued." | |
691 | ;; Statement level. Is it a continuation or a new statement? | |
692 | ;; Find previous non-comment character. | |
693 | (perl-backward-to-noncomment) | |
694 | ;; Back up over label lines, since they don't | |
695 | ;; affect whether our line is a continuation. | |
696 | (while (or (eq (preceding-char) ?\,) | |
697 | (and (eq (preceding-char) ?:) | |
698 | (memq (char-syntax (char-after (- (point) 2))) | |
699 | '(?w ?_)))) | |
700 | (if (eq (preceding-char) ?\,) | |
701 | (perl-backward-to-start-of-continued-exp limit) | |
702 | (beginning-of-line)) | |
703 | (perl-backward-to-noncomment)) | |
704 | ;; Now we get the answer. | |
705 | (not (memq (preceding-char) '(?\; ?\} ?\{)))) | |
706 | ||
2a4407be SM |
707 | (defun perl-hanging-paren-p () |
708 | "Non-nil if we are right after a hanging parenthesis-like char." | |
709 | (and (looking-at "[ \t]*$") | |
710 | (save-excursion | |
711 | (skip-syntax-backward " (") (not (bolp))))) | |
712 | ||
92aba9ab SM |
713 | (defun perl-indent-new-calculate (&optional virtual default parse-start) |
714 | (or | |
715 | (and virtual (save-excursion (skip-chars-backward " \t") (bolp)) | |
716 | (current-column)) | |
717 | (and (looking-at "\\(\\w\\|\\s_\\)+:[^:]") | |
718 | (max 1 (+ (or default (perl-calculate-indent parse-start)) | |
719 | perl-label-offset))) | |
720 | (and (= (char-syntax (following-char)) ?\)) | |
721 | (save-excursion | |
722 | (forward-char 1) | |
723 | (forward-sexp -1) | |
724 | (perl-indent-new-calculate 'virtual nil parse-start))) | |
725 | (and (and (= (following-char) ?{) | |
726 | (save-excursion (forward-char) (perl-hanging-paren-p))) | |
727 | (+ (or default (perl-calculate-indent parse-start)) | |
728 | perl-brace-offset)) | |
729 | (or default (perl-calculate-indent parse-start)))) | |
730 | ||
4b8dfb43 | 731 | (defun perl-calculate-indent (&optional parse-start) |
2076c87c JB |
732 | "Return appropriate indentation for current line as Perl code. |
733 | In usual case returns an integer: the column to indent to. | |
d3627c47 SM |
734 | Returns (parse-state) if line starts inside a string. |
735 | Optional argument PARSE-START should be the position of `beginning-of-defun'." | |
2076c87c | 736 | (save-excursion |
2076c87c JB |
737 | (let ((indent-point (point)) |
738 | (case-fold-search nil) | |
739 | (colon-line-end 0) | |
740 | state containing-sexp) | |
741 | (if parse-start ;used to avoid searching | |
742 | (goto-char parse-start) | |
743 | (perl-beginning-of-function)) | |
4b8dfb43 SM |
744 | ;; We might be now looking at a local function that has nothing to |
745 | ;; do with us because `indent-point' is past it. In this case | |
746 | ;; look further back up for another `perl-beginning-of-function'. | |
747 | (while (and (looking-at "{") | |
748 | (save-excursion | |
749 | (beginning-of-line) | |
750 | (looking-at "\\s-+sub\\>")) | |
751 | (> indent-point (save-excursion (forward-sexp 1) (point)))) | |
752 | (perl-beginning-of-function)) | |
2076c87c | 753 | (while (< (point) indent-point) ;repeat until right sexp |
2076c87c | 754 | (setq state (parse-partial-sexp (point) indent-point 0)) |
d3627c47 SM |
755 | ;; state = (depth_in_parens innermost_containing_list |
756 | ;; last_complete_sexp string_terminator_or_nil inside_commentp | |
757 | ;; following_quotep minimum_paren-depth_this_scan) | |
758 | ;; Parsing stops if depth in parentheses becomes equal to third arg. | |
2076c87c JB |
759 | (setq containing-sexp (nth 1 state))) |
760 | (cond ((nth 3 state) state) ; In a quoted string? | |
761 | ((null containing-sexp) ; Line is at top level. | |
762 | (skip-chars-forward " \t\f") | |
763 | (if (= (following-char) ?{) | |
d3627c47 | 764 | 0 ; move to beginning of line if it starts a function body |
2076c87c JB |
765 | ;; indent a little if this is a continuation line |
766 | (perl-backward-to-noncomment) | |
767 | (if (or (bobp) | |
768 | (memq (preceding-char) '(?\; ?\}))) | |
769 | 0 perl-continued-statement-offset))) | |
770 | ((/= (char-after containing-sexp) ?{) | |
771 | ;; line is expression, not statement: | |
772 | ;; indent to just after the surrounding open. | |
773 | (goto-char (1+ containing-sexp)) | |
2a4407be SM |
774 | (if (perl-hanging-paren-p) |
775 | ;; We're indenting an arg of a call like: | |
776 | ;; $a = foobarlongnamefun ( | |
777 | ;; arg1 | |
778 | ;; arg2 | |
779 | ;; ); | |
780 | (progn | |
781 | (skip-syntax-backward "(") | |
782 | (condition-case err | |
783 | (while (save-excursion | |
784 | (skip-syntax-backward " ") (not (bolp))) | |
785 | (forward-sexp -1)) | |
786 | (scan-error nil)) | |
787 | (+ (current-column) perl-indent-level)) | |
788 | (if perl-indent-continued-arguments | |
789 | (+ perl-indent-continued-arguments (current-indentation)) | |
790 | (skip-chars-forward " \t") | |
791 | (current-column)))) | |
2076c87c JB |
792 | (t |
793 | ;; Statement level. Is it a continuation or a new statement? | |
4a0aa1d9 | 794 | (if (perl-continuation-line-p containing-sexp) |
2076c87c JB |
795 | ;; This line is continuation of preceding line's statement; |
796 | ;; indent perl-continued-statement-offset more than the | |
797 | ;; previous line of the statement. | |
798 | (progn | |
799 | (perl-backward-to-start-of-continued-exp containing-sexp) | |
4a0aa1d9 SM |
800 | (+ (if (save-excursion |
801 | (perl-continuation-line-p containing-sexp)) | |
802 | ;; If the continued line is itself a continuation | |
803 | ;; line, then align, otherwise add an offset. | |
804 | 0 perl-continued-statement-offset) | |
805 | (current-column) | |
2076c87c JB |
806 | (if (save-excursion (goto-char indent-point) |
807 | (looking-at "[ \t]*{")) | |
808 | perl-continued-brace-offset 0))) | |
809 | ;; This line starts a new statement. | |
810 | ;; Position at last unclosed open. | |
811 | (goto-char containing-sexp) | |
812 | (or | |
2a4407be SM |
813 | ;; Is line first statement after an open-brace? |
814 | ;; If no, find that first statement and indent like it. | |
815 | (save-excursion | |
d3627c47 SM |
816 | (forward-char 1) |
817 | ;; Skip over comments and labels following openbrace. | |
818 | (while (progn | |
819 | (skip-chars-forward " \t\f\n") | |
820 | (cond ((looking-at ";?#") | |
821 | (forward-line 1) t) | |
8a525646 | 822 | ((looking-at "\\(\\w\\|\\s_\\)+:[^:]") |
d3627c47 SM |
823 | (save-excursion |
824 | (end-of-line) | |
825 | (setq colon-line-end (point))) | |
826 | (search-forward ":"))))) | |
827 | ;; The first following code counts | |
828 | ;; if it is before the line we want to indent. | |
829 | (and (< (point) indent-point) | |
830 | (if (> colon-line-end (point)) | |
831 | (- (current-indentation) perl-label-offset) | |
832 | (current-column)))) | |
833 | ;; If no previous statement, | |
834 | ;; indent it relative to line brace is on. | |
835 | ;; For open paren in column zero, don't let statement | |
836 | ;; start there too. If perl-indent-level is zero, | |
837 | ;; use perl-brace-offset + perl-continued-statement-offset | |
838 | ;; For open-braces not the first thing in a line, | |
839 | ;; add in perl-brace-imaginary-offset. | |
840 | (+ (if (and (bolp) (zerop perl-indent-level)) | |
841 | (+ perl-brace-offset perl-continued-statement-offset) | |
842 | perl-indent-level) | |
843 | ;; Move back over whitespace before the openbrace. | |
844 | ;; If openbrace is not first nonwhite thing on the line, | |
845 | ;; add the perl-brace-imaginary-offset. | |
846 | (progn (skip-chars-backward " \t") | |
847 | (if (bolp) 0 perl-brace-imaginary-offset)) | |
848 | ;; If the openbrace is preceded by a parenthesized exp, | |
849 | ;; move to the beginning of that; | |
850 | ;; possibly a different line | |
851 | (progn | |
852 | (if (eq (preceding-char) ?\)) | |
853 | (forward-sexp -1)) | |
854 | ;; Get initial indentation of the line we are on. | |
855 | (current-indentation)))))))))) | |
2076c87c JB |
856 | |
857 | (defun perl-backward-to-noncomment () | |
858 | "Move point backward to after the first non-white-space, skipping comments." | |
d3627c47 | 859 | (interactive) |
df3fd736 | 860 | (forward-comment (- (point-max)))) |
2076c87c JB |
861 | |
862 | (defun perl-backward-to-start-of-continued-exp (lim) | |
863 | (if (= (preceding-char) ?\)) | |
864 | (forward-sexp -1)) | |
865 | (beginning-of-line) | |
866 | (if (<= (point) lim) | |
867 | (goto-char (1+ lim))) | |
868 | (skip-chars-forward " \t\f")) | |
869 | \f | |
870 | ;; note: this may be slower than the c-mode version, but I can understand it. | |
4b8dfb43 SM |
871 | (defalias 'indent-perl-exp 'perl-indent-exp) |
872 | (defun perl-indent-exp () | |
2076c87c JB |
873 | "Indent each line of the Perl grouping following point." |
874 | (interactive) | |
875 | (let* ((case-fold-search nil) | |
876 | (oldpnt (point-marker)) | |
877 | (bof-mark (save-excursion | |
878 | (end-of-line 2) | |
879 | (perl-beginning-of-function) | |
880 | (point-marker))) | |
881 | eol last-mark lsexp-mark delta) | |
882 | (if (= (char-after (marker-position bof-mark)) ?=) | |
883 | (message "Can't indent a format statement") | |
884 | (message "Indenting Perl expression...") | |
885 | (save-excursion (end-of-line) (setq eol (point))) | |
886 | (save-excursion ; locate matching close paren | |
887 | (while (and (not (eobp)) (<= (point) eol)) | |
888 | (parse-partial-sexp (point) (point-max) 0)) | |
889 | (setq last-mark (point-marker))) | |
890 | (setq lsexp-mark bof-mark) | |
891 | (beginning-of-line) | |
892 | (while (< (point) (marker-position last-mark)) | |
893 | (setq delta (perl-indent-line nil (marker-position bof-mark))) | |
894 | (if (numberp delta) ; unquoted start-of-line? | |
a1506d29 | 895 | (progn |
2076c87c JB |
896 | (if (eolp) |
897 | (delete-horizontal-space)) | |
898 | (setq lsexp-mark (point-marker)))) | |
899 | (end-of-line) | |
900 | (setq eol (point)) | |
901 | (if (nth 4 (parse-partial-sexp (marker-position lsexp-mark) eol)) | |
902 | (progn ; line ends in a comment | |
903 | (beginning-of-line) | |
904 | (if (or (not (looking-at "\\s-*;?#")) | |
905 | (listp delta) | |
906 | (and (/= 0 delta) | |
907 | (= (- (current-indentation) delta) comment-column))) | |
5b1bdb5f RS |
908 | (if (and comment-start-skip |
909 | (re-search-forward comment-start-skip eol t)) | |
2076c87c JB |
910 | (indent-for-comment))))) ; indent existing comment |
911 | (forward-line 1)) | |
912 | (goto-char (marker-position oldpnt)) | |
913 | (message "Indenting Perl expression...done")))) | |
914 | \f | |
915 | (defun perl-beginning-of-function (&optional arg) | |
916 | "Move backward to next beginning-of-function, or as far as possible. | |
917 | With argument, repeat that many times; negative args move forward. | |
918 | Returns new value of point in all cases." | |
919 | (interactive "p") | |
920 | (or arg (setq arg 1)) | |
921 | (if (< arg 0) (forward-char 1)) | |
922 | (and (/= arg 0) | |
923 | (re-search-backward "^\\s(\\|^\\s-*sub\\b[^{]+{\\|^\\s-*format\\b[^=]*=\\|^\\." | |
924 | nil 'move arg) | |
925 | (goto-char (1- (match-end 0)))) | |
926 | (point)) | |
927 | ||
928 | ;; note: this routine is adapted directly from emacs lisp.el, end-of-defun; | |
929 | ;; no bugs have been removed :-) | |
930 | (defun perl-end-of-function (&optional arg) | |
931 | "Move forward to next end-of-function. | |
932 | The end of a function is found by moving forward from the beginning of one. | |
933 | With argument, repeat that many times; negative args move backward." | |
934 | (interactive "p") | |
935 | (or arg (setq arg 1)) | |
936 | (let ((first t)) | |
937 | (while (and (> arg 0) (< (point) (point-max))) | |
bbce4eb4 | 938 | (let ((pos (point))) |
2076c87c JB |
939 | (while (progn |
940 | (if (and first | |
941 | (progn | |
942 | (forward-char 1) | |
943 | (perl-beginning-of-function 1) | |
944 | (not (bobp)))) | |
945 | nil | |
946 | (or (bobp) (forward-char -1)) | |
947 | (perl-beginning-of-function -1)) | |
948 | (setq first nil) | |
949 | (forward-list 1) | |
950 | (skip-chars-forward " \t") | |
951 | (if (looking-at "[#\n]") | |
952 | (forward-line 1)) | |
953 | (<= (point) pos)))) | |
954 | (setq arg (1- arg))) | |
955 | (while (< arg 0) | |
956 | (let ((pos (point))) | |
957 | (perl-beginning-of-function 1) | |
958 | (forward-sexp 1) | |
959 | (forward-line 1) | |
960 | (if (>= (point) pos) | |
961 | (if (progn (perl-beginning-of-function 2) (not (bobp))) | |
962 | (progn | |
963 | (forward-list 1) | |
964 | (skip-chars-forward " \t") | |
965 | (if (looking-at "[#\n]") | |
966 | (forward-line 1))) | |
967 | (goto-char (point-min))))) | |
968 | (setq arg (1+ arg))))) | |
969 | ||
4b8dfb43 SM |
970 | (defalias 'mark-perl-function 'perl-mark-function) |
971 | (defun perl-mark-function () | |
2076c87c JB |
972 | "Put mark at end of Perl function, point at beginning." |
973 | (interactive) | |
974 | (push-mark (point)) | |
975 | (perl-end-of-function) | |
976 | (push-mark (point)) | |
977 | (perl-beginning-of-function) | |
978 | (backward-paragraph)) | |
979 | ||
86175613 RS |
980 | (provide 'perl-mode) |
981 | ||
8a525646 | 982 | ;; arch-tag: 8c7ff68d-15f3-46a2-ade2-b7c41f176826 |
86175613 | 983 | ;;; perl-mode.el ends here |