| blob | cb6195dec3bc53722198807662033ecb0468ef3f |
1 ;; Perl code editing commands for GNU Emacs
2 ;; Copyright (C) 1990 William F. Mann
3 ;; Adapted from C code editing commands 'c-mode.el', Copyright 1987 by the
4 ;; Free Software Foundation, under terms of its General Public License.
6 ;; This file may be made part of GNU Emacs at the option of the FSF, or
7 ;; of the perl distribution at the option of Larry Wall.
9 ;; This code is distributed in the hope that it will be useful,
10 ;; but WITHOUT ANY WARRANTY. No author or distributor
11 ;; accepts responsibility to anyone for the consequences of using it
12 ;; or for whether it serves any particular purpose or works at all,
13 ;; unless he says so in writing. Refer to the GNU Emacs General Public
14 ;; License for full details.
16 ;; Everyone is granted permission to copy, modify and redistribute
17 ;; this code, but only under the conditions described in the
18 ;; GNU Emacs General Public License. A copy of this license is
19 ;; supposed to have been given to you along with GNU Emacs so you
20 ;; can know your rights and responsibilities. It should be in a
21 ;; file named COPYING. Among other things, the copyright notice
22 ;; and this notice must be preserved on all copies.
24 ;; To enter perl-mode automatically, add (autoload 'perl-mode "perl-mode")
25 ;; to your .emacs file and change the first line of your perl script to:
26 ;; #!/usr/bin/perl -- # -*-Perl-*-
27 ;; With argments to perl:
28 ;; #!/usr/bin/perl -P- # -*-Perl-*-
29 ;; To handle files included with do 'filename.pl';, add something like
30 ;; (setq auto-mode-alist (append (list (cons "\\.pl$" 'perl-mode))
31 ;; auto-mode-alist))
32 ;; to your .emacs file; otherwise the .pl suffix defaults to prolog-mode.
34 ;; This code is based on the 18.53 version c-mode.el, with extensive
35 ;; rewriting. Most of the features of c-mode survived intact.
37 ;; I added a new feature which adds functionality to TAB; it is controlled
38 ;; by the variable perl-tab-to-comment. With it enabled, TAB does the
39 ;; first thing it can from the following list: change the indentation;
40 ;; move past leading white space; delete an empty comment; reindent a
41 ;; comment; move to end of line; create an empty comment; tell you that
42 ;; the line ends in a quoted string, or has a # which should be a \#.
44 ;; If your machine is slow, you may want to remove some of the bindings
45 ;; to electric-perl-terminator. I changed the indenting defaults to be
46 ;; what Larry Wall uses in perl/lib, but left in all the options.
48 ;; I also tuned a few things: comments and labels starting in column
49 ;; zero are left there by indent-perl-exp; perl-beginning-of-function
50 ;; goes back to the first open brace/paren in column zero, the open brace
51 ;; in 'sub ... {', or the equal sign in 'format ... ='; indent-perl-exp
52 ;; (meta-^q) indents from the current line through the close of the next
53 ;; brace/paren, so you don't need to start exactly at a brace or paren.
55 ;; It may be good style to put a set of redundant braces around your
56 ;; main program. This will let you reindent it with meta-^q.
58 ;; Known problems (these are all caused by limitations in the elisp
59 ;; parsing routine (parse-partial-sexp), which was not designed for such
60 ;; a rich language; writing a more suitable parser would be a big job):
61 ;; 1) Regular expression delimitors do not act as quotes, so special
62 ;; characters such as `'"#:;[](){} may need to be backslashed
63 ;; in regular expressions and in both parts of s/// and tr///.
64 ;; 2) The globbing syntax <pattern> is not recognized, so special
65 ;; characters in the pattern string must be backslashed.
66 ;; 3) The q, qq, and << quoting operators are not recognized; see below.
67 ;; 4) \ (backslash) always quotes the next character, so '\' is
68 ;; treated as the start of a string. Use "\\" as a work-around.
69 ;; 5) To make variables such a $' and $#array work, perl-mode treats
70 ;; $ just like backslash, so '$' is the same as problem 5.
71 ;; 6) Unfortunately, treating $ like \ makes ${var} be treated as an
72 ;; unmatched }. See below.
73 ;; 7) When ' (quote) is used as a package name separator, perl-mode
74 ;; doesn't understand, and thinks it is seeing a quoted string.
76 ;; Here are some ugly tricks to bypass some of these problems: the perl
77 ;; expression /`/ (that's a back-tick) usually evaluates harmlessly,
78 ;; but will trick perl-mode into starting a quoted string, which
79 ;; can be ended with another /`/. Assuming you have no embedded
80 ;; back-ticks, this can used to help solve problem 3:
81 ;;
82 ;; /`/; $ugly = q?"'$?; /`/;
83 ;;
84 ;; To solve problem 6, add a /{/; before each use of ${var}:
85 ;; /{/; while (<${glob_me}>) ...
86 ;;
87 ;; Problem 7 is even worse, but this 'fix' does work :-(
88 ;; $DB'stop#'
89 ;; [$DB'line#'
90 ;; ] =~ s/;9$//;
100 ()
114 "Display the result of expanding all C macros occurring in the region.
115 The expansion is entirely correct because it uses the C preprocessor."
116 t)
122 ()
140 )
147 "*Extra indent for substatements that start with open-braces.
157 "*Non-nil means TAB in Perl mode should always indent the current line,
161 "*Non-nil means that for lines which don't need indenting, TAB will
162 either indent an existing comment, move to end-of-line, or if at end-of-line
167 \f
169 "Major mode for editing Perl code.
170 Expression and list commands understand all Perl brackets.
171 Tab indents for Perl code.
173 Paragraphs are separated by blank lines only.
174 Delete converts tabs to spaces as it moves back.
176 Variables controlling indentation style:
177 perl-tab-always-indent
178 Non-nil means TAB in Perl mode should always indent the current line,
179 regardless of where in the line point is when the TAB command is used.
180 perl-tab-to-comment
181 Non-nil means that for lines which don't need indenting, TAB will
182 either delete an empty comment, indent an existing comment, move
183 to end-of-line, or if at end-of-line already, create a new comment.
184 perl-nochange
185 Lines starting with this regular expression will not be auto-indented.
186 perl-indent-level
187 Indentation of Perl statements within surrounding block.
188 The surrounding block's indentation is the indentation
189 of the line on which the open-brace appears.
190 perl-continued-statement-offset
191 Extra indentation given to a substatement, such as the
192 then-clause of an if or body of a while.
193 perl-continued-brace-offset
194 Extra indentation given to a brace that starts a substatement.
195 This is in addition to perl-continued-statement-offset.
196 perl-brace-offset
197 Extra indentation for line if it starts with an open brace.
198 perl-brace-imaginary-offset
199 An open brace following other text is treated as if it were
200 this far to the right of the start of its line.
201 perl-label-offset
202 Extra indentation for line that is a label.
204 Various indentation styles: K&R BSD BLK GNU LW
205 perl-indent-level 5 8 0 2 4
206 perl-continued-statement-offset 5 8 4 2 4
207 perl-continued-brace-offset 0 0 0 0 -4
208 perl-brace-offset -5 -8 0 0 0
209 perl-brace-imaginary-offset 0 0 4 0 0
210 perl-label-offset -5 -8 -2 -2 -2
212 Turning on Perl mode calls the value of the variable perl-mode-hook with no
213 args, if that value is non-nil."
244 \f
245 ;; This is used by indent-for-comment
246 ;; to decide how much to indent a comment in Perl code
247 ;; based on its context.
257 "Insert character. If at end-of-line, and not in a comment or a quote,
258 correct the line's indentation."
268 ;; Colon is special only after a label ....
279 ;; not used anymore, but may be useful someday:
280 ;;(defun perl-inside-parens-p ()
281 ;; (condition-case ()
282 ;; (save-excursion
283 ;; (save-restriction
284 ;; (narrow-to-region (point)
285 ;; (perl-beginning-of-function))
286 ;; (goto-char (point-max))
287 ;; (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
288 ;; (error nil)))
289 \f
291 "Indent current line as Perl code, or optionally, insert a tab character.
293 With an argument, indent the current line, regardless of other options.
295 If perl-tab-always-indent is nil and point is not in the indentation
296 area at the beginning of the line, simply insert a tab.
298 Otherwise, indent the current line. If point was within the indentation
299 area it is moved to the end of the indentation area. If the line was
300 already indented properly and point was not within the indentation area,
301 and if perl-tab-to-comment is non-nil (the default), then do the first
302 possible action from the following list:
304 1) delete an empty comment
305 2) move forward to start of comment, indenting if necessary
306 3) move forward to end of line
307 4) create an empty comment
308 5) move backward to start of comment, indenting if necessary."
356 "Indent current line as Perl code. Return the amount the indentation
357 changed by, or (parse-state) if line starts in a quoted string."
361 beg indent shift-amt)
381 ;; If initial point was within line's indentation,
382 ;; position after the indentation. Else stay at same point in text.
385 shift-amt))
388 "Return appropriate indentation for current line as Perl code.
389 In usual case returns an integer: the column to indent to.
390 Returns (parse-state) if line starts inside a string."
396 state containing-sexp)
403 ; state = (depth_in_parens innermost_containing_list last_complete_sexp
404 ; string_terminator_or_nil inside_commentp following_quotep
405 ; minimum_paren-depth_this_scan)
406 ; Parsing stops if depth in parentheses becomes equal to third arg.
413 ;; indent a little if this is a continuation line
419 ;; line is expression, not statement:
420 ;; indent to just after the surrounding open.
424 ;; Statement level. Is it a continuation or a new statement?
425 ;; Find previous non-comment character.
427 ;; Back up over label lines, since they don't
428 ;; affect whether our line is a continuation.
437 ;; Now we get the answer.
439 ;; This line is continuation of preceding line's statement;
440 ;; indent perl-continued-statement-offset more than the
441 ;; previous line of the statement.
448 ;; This line starts a new statement.
449 ;; Position at last unclosed open.
452 ;; If open paren is in col 0, close brace is special
456 perl-indent-level)
457 ;; Is line first statement after an open-brace?
458 ;; If no, find that first statement and indent like it.
461 ;; Skip over comments and labels following openbrace.
471 ;; The first following code counts
472 ;; if it is before the line we want to indent.
477 ;; If no previous statement,
478 ;; indent it relative to line brace is on.
479 ;; For open paren in column zero, don't let statement
480 ;; start there too. If perl-indent-level is zero,
481 ;; use perl-brace-offset + perl-continued-statement-offset
482 ;; For open-braces not the first thing in a line,
483 ;; add in perl-brace-imaginary-offset.
486 perl-indent-level)
487 ;; Move back over whitespace before the openbrace.
488 ;; If openbrace is not first nonwhite thing on the line,
489 ;; add the perl-brace-imaginary-offset.
492 ;; If the openbrace is preceded by a parenthesized exp,
493 ;; move to the beginning of that;
494 ;; possibly a different line
498 ;; Get initial indentation of the line we are on.
502 "Move point backward to after the first non-white-space, skipping comments."
523 \f
524 ;; note: this may be slower than the c-mode version, but I can understand it.
526 "Indent each line of the Perl grouping following point."
534 eol last-mark lsexp-mark delta)
566 \f
568 "Move backward to next beginning-of-function, or as far as possible.
569 With argument, repeat that many times; negative args move forward.
570 Returns new value of point in all cases."
580 ;; note: this routine is adapted directly from emacs lisp.el, end-of-defun;
581 ;; no bugs have been removed :-)
583 "Move forward to next end-of-function.
584 The end of a function is found by moving forward from the beginning of one.
585 With argument, repeat that many times; negative args move backward."
597 nil
623 "Put mark at end of Perl function, point at beginning."
631 ;;;;;;;; That's all, folks! ;;;;;;;;;