perl-mode.el 38.7 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; perl-mode.el --- Perl code editing commands for GNU Emacs

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1990, 1994, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4
;; Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Author: William F. Mann
7
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
8
;; Adapted-By: ESR
Eric S. Raymond's avatar
Eric S. Raymond committed
9
;; Keywords: languages
Eric S. Raymond's avatar
Eric S. Raymond committed
10

Jim Blandy's avatar
Jim Blandy committed
11 12 13
;; Adapted from C code editing commands 'c-mode.el', Copyright 1987 by the
;; Free Software Foundation, under terms of its General Public License.

Richard M. Stallman's avatar
Richard M. Stallman committed
14 15 16 17 18 19 20 21 22 23 24 25 26
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
27
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
28 29
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
30

Eric S. Raymond's avatar
Eric S. Raymond committed
31 32
;;; Commentary:

Jim Blandy's avatar
Jim Blandy committed
33 34 35
;; To enter perl-mode automatically, add (autoload 'perl-mode "perl-mode")
;; to your .emacs file and change the first line of your perl script to:
;; #!/usr/bin/perl --	 # -*-Perl-*-
Karl Heuer's avatar
Karl Heuer committed
36
;; With arguments to perl:
Jim Blandy's avatar
Jim Blandy committed
37 38
;; #!/usr/bin/perl -P-	 # -*-Perl-*-
;; To handle files included with do 'filename.pl';, add something like
Richard M. Stallman's avatar
Richard M. Stallman committed
39
;; (setq auto-mode-alist (append (list (cons "\\.pl\\'" 'perl-mode))
Jim Blandy's avatar
Jim Blandy committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53
;;                               auto-mode-alist))
;; to your .emacs file; otherwise the .pl suffix defaults to prolog-mode.

;; This code is based on the 18.53 version c-mode.el, with extensive
;; rewriting.  Most of the features of c-mode survived intact.

;; I added a new feature which adds functionality to TAB; it is controlled
;; by the variable perl-tab-to-comment.  With it enabled, TAB does the
;; first thing it can from the following list:  change the indentation;
;; move past leading white space; delete an empty comment; reindent a
;; comment; move to end of line; create an empty comment; tell you that
;; the line ends in a quoted string, or has a # which should be a \#.

;; If your machine is slow, you may want to remove some of the bindings
54
;; to perl-electric-terminator.  I changed the indenting defaults to be
Jim Blandy's avatar
Jim Blandy committed
55 56 57
;; what Larry Wall uses in perl/lib, but left in all the options.

;; I also tuned a few things:  comments and labels starting in column
58
;; zero are left there by perl-indent-exp; perl-beginning-of-function
Jim Blandy's avatar
Jim Blandy committed
59
;; goes back to the first open brace/paren in column zero, the open brace
60
;; in 'sub ... {', or the equal sign in 'format ... ='; perl-indent-exp
Jim Blandy's avatar
Jim Blandy committed
61 62 63 64 65 66
;; (meta-^q) indents from the current line through the close of the next
;; brace/paren, so you don't need to start exactly at a brace or paren.

;; It may be good style to put a set of redundant braces around your
;; main program.  This will let you reindent it with meta-^q.

Eric S. Raymond's avatar
Eric S. Raymond committed
67
;; Known problems (these are all caused by limitations in the Emacs Lisp
Jim Blandy's avatar
Jim Blandy committed
68 69 70 71
;; parsing routine (parse-partial-sexp), which was not designed for such
;; a rich language; writing a more suitable parser would be a big job):
;; 2)  The globbing syntax <pattern> is not recognized, so special
;;       characters in the pattern string must be backslashed.
72
;; 3)  The << quoting operators are not recognized; see below.
73 74 75 76
;; 5)  To make '$' work correctly, $' is not recognized as a variable.
;;     Use "$'" or $POSTMATCH instead.
;;
;; If you don't use font-lock, additional problems will appear:
77 78 79 80
;; 1)  Regular expression delimiters do not act as quotes, so special
;;       characters such as `'"#:;[](){} may need to be backslashed
;;       in regular expressions and in both parts of s/// and tr///.
;; 4)  The q and qq quoting operators are not recognized; see below.
Jim Blandy's avatar
Jim Blandy committed
81
;; 5)  To make variables such a $' and $#array work, perl-mode treats
82
;;       $ just like backslash, so '$' is not treated correctly.
Jim Blandy's avatar
Jim Blandy committed
83 84
;; 6)  Unfortunately, treating $ like \ makes ${var} be treated as an
;;       unmatched }.  See below.
85 86
;; 7)  When ' (quote) is used as a package name separator, perl-mode
;;       doesn't understand, and thinks it is seeing a quoted string.
Jim Blandy's avatar
Jim Blandy committed
87 88 89 90 91 92 93 94 95

;; Here are some ugly tricks to bypass some of these problems:  the perl
;; expression /`/ (that's a back-tick) usually evaluates harmlessly,
;; but will trick perl-mode into starting a quoted string, which
;; can be ended with another /`/.  Assuming you have no embedded
;; back-ticks, this can used to help solve problem 3:
;;
;;     /`/; $ugly = q?"'$?; /`/;
;;
96 97 98 99
;; The same trick can be used for problem 6 as in:
;;     /{/; while (<${glob_me}>)
;; but a simpler solution is to add a space between the $ and the {:
;;     while (<$ {glob_me}>)
100
;;
Jim Blandy's avatar
Jim Blandy committed
101 102 103 104 105
;; Problem 7 is even worse, but this 'fix' does work :-(
;;     $DB'stop#'
;;         [$DB'line#'
;;          ] =~ s/;9$//;

Eric S. Raymond's avatar
Eric S. Raymond committed
106
;;; Code:
Jim Blandy's avatar
Jim Blandy committed
107

108 109
(eval-when-compile (require 'cl))

110 111 112 113
(defvar font-lock-comment-face)
(defvar font-lock-doc-face)
(defvar font-lock-string-face)

Stephen Eglen's avatar
Stephen Eglen committed
114 115
(defgroup perl nil
  "Major mode for editing Perl code."
116
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Stephen Eglen's avatar
Stephen Eglen committed
117 118 119
  :prefix "perl-"
  :group 'languages)

120 121 122 123
(defvar perl-mode-abbrev-table nil
  "Abbrev table in use in perl-mode buffers.")
(define-abbrev-table 'perl-mode-abbrev-table ())

124 125 126 127 128 129 130 131 132 133 134 135 136
(defvar perl-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map "{" 'perl-electric-terminator)
    (define-key map "}" 'perl-electric-terminator)
    (define-key map ";" 'perl-electric-terminator)
    (define-key map ":" 'perl-electric-terminator)
    (define-key map "\e\C-a" 'perl-beginning-of-function)
    (define-key map "\e\C-e" 'perl-end-of-function)
    (define-key map "\e\C-h" 'perl-mark-function)
    (define-key map "\e\C-q" 'perl-indent-exp)
    (define-key map "\177" 'backward-delete-char-untabify)
    (define-key map "\t" 'perl-indent-command)
    map)
137
  "Keymap used in Perl mode.")
Jim Blandy's avatar
Jim Blandy committed
138 139 140 141 142 143

(autoload 'c-macro-expand "cmacexp"
  "Display the result of expanding all C macros occurring in the region.
The expansion is entirely correct because it uses the C preprocessor."
  t)

144 145 146 147
(defvar perl-mode-syntax-table
  (let ((st (make-syntax-table (standard-syntax-table))))
    (modify-syntax-entry ?\n ">" st)
    (modify-syntax-entry ?# "<" st)
148 149 150
    ;; `$' is also a prefix char so I was tempted to say "/ p",
    ;; but the `p' thingy basically overrides the `/' :-(   --stef
    (modify-syntax-entry ?$ "/" st)
151 152
    (modify-syntax-entry ?% ". p" st)
    (modify-syntax-entry ?@ ". p" st)
153 154 155 156 157 158 159 160 161 162 163 164 165 166
    (modify-syntax-entry ?& "." st)
    (modify-syntax-entry ?\' "\"" st)
    (modify-syntax-entry ?* "." st)
    (modify-syntax-entry ?+ "." st)
    (modify-syntax-entry ?- "." st)
    (modify-syntax-entry ?/ "." st)
    (modify-syntax-entry ?< "." st)
    (modify-syntax-entry ?= "." st)
    (modify-syntax-entry ?> "." st)
    (modify-syntax-entry ?\\ "\\" st)
    (modify-syntax-entry ?` "\"" st)
    (modify-syntax-entry ?| "." st)
    st)
  "Syntax table in use in `perl-mode' buffers.")
Jim Blandy's avatar
Jim Blandy committed
167

168
(defvar perl-imenu-generic-expression
169
  '(;; Functions
170
    (nil "^sub\\s-+\\([-A-Za-z0-9+_:]+\\)" 1)
171
    ;;Variables
172 173 174
    ("Variables" "^\\([$@%][-A-Za-z0-9+_:]+\\)\\s-*=" 1)
    ("Packages" "^package\\s-+\\([-A-Za-z0-9+_:]+\\);" 1)
    ("Doc sections" "^=head[0-9][ \t]+\\(.*\\)" 1))
175 176
  "Imenu generic expression for Perl mode.  See `imenu-generic-expression'.")

Simon Marshall's avatar
Simon Marshall committed
177 178 179 180 181 182 183 184 185
;; Regexps updated with help from Tom Tromey <tromey@cambric.colorado.edu> and
;; Jim Campbell <jec@murzim.ca.boeing.com>.

(defconst perl-font-lock-keywords-1
  '(;; What is this for?
    ;;("\\(--- .* ---\\|=== .* ===\\)" . font-lock-string-face)
    ;;
    ;; Fontify preprocessor statements as we do in `c-font-lock-keywords'.
    ;; Ilya Zakharevich <ilya@math.ohio-state.edu> thinks this is a bad idea.
186 187 188 189 190 191 192
    ;; ("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
    ;; ("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
    ;; ("^#[ \t]*if\\>"
    ;;  ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
    ;;   (1 font-lock-constant-face) (2 font-lock-variable-name-face nil t)))
    ;; ("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
    ;;  (1 font-lock-constant-face) (2 font-lock-variable-name-face nil t))
Simon Marshall's avatar
Simon Marshall committed
193 194 195 196 197
    ;;
    ;; Fontify function and package names in declarations.
    ("\\<\\(package\\|sub\\)\\>[ \t]*\\(\\sw+\\)?"
     (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
    ("\\<\\(import\\|no\\|require\\|use\\)\\>[ \t]*\\(\\sw+\\)?"
198
     (1 font-lock-keyword-face) (2 font-lock-constant-face nil t)))
Simon Marshall's avatar
Simon Marshall committed
199 200 201 202 203 204 205
  "Subdued level highlighting for Perl mode.")

(defconst perl-font-lock-keywords-2
  (append perl-font-lock-keywords-1
   (list
    ;;
    ;; Fontify keywords, except those fontified otherwise.
206 207 208 209 210
    (concat "\\<"
	    (regexp-opt '("if" "until" "while" "elsif" "else" "unless"
			  "do" "dump" "for" "foreach" "exit" "die"
			  "BEGIN" "END" "return" "exec" "eval") t)
	    "\\>")
Simon Marshall's avatar
Simon Marshall committed
211 212 213 214 215
    ;;
    ;; Fontify local and my keywords as types.
    '("\\<\\(local\\|my\\)\\>" . font-lock-type-face)
    ;;
    ;; Fontify function, variable and file name references.
Stefan Monnier's avatar
Stefan Monnier committed
216
    '("&\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-function-name-face)
Simon Marshall's avatar
Simon Marshall committed
217 218
    ;; Additionally underline non-scalar variables.  Maybe this is a bad idea.
    ;;'("[$@%*][#{]?\\(\\sw+\\)" 1 font-lock-variable-name-face)
Stefan Monnier's avatar
Stefan Monnier committed
219 220
    '("[$*]{?\\(\\sw+\\(::\\sw+\\)*\\)" 1 font-lock-variable-name-face)
    '("\\([@%]\\|\\$#\\)\\(\\sw+\\(::\\sw+\\)*\\)"
Simon Marshall's avatar
Simon Marshall committed
221
      (2 (cons font-lock-variable-name-face '(underline))))
222
    '("<\\(\\sw+\\)>" 1 font-lock-constant-face)
Simon Marshall's avatar
Simon Marshall committed
223 224 225
    ;;
    ;; Fontify keywords with/and labels as we do in `c++-font-lock-keywords'.
    '("\\<\\(continue\\|goto\\|last\\|next\\|redo\\)\\>[ \t]*\\(\\sw+\\)?"
226 227
      (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
    '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-constant-face)))
Simon Marshall's avatar
Simon Marshall committed
228 229 230 231 232
  "Gaudy level highlighting for Perl mode.")

(defvar perl-font-lock-keywords perl-font-lock-keywords-1
  "Default expressions to highlight in Perl mode.")

233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
(defvar perl-quote-like-pairs
  '((?\( . ?\)) (?\[ . ?\]) (?\{ . ?\}) (?\< . ?\>)))

;; FIXME: handle here-docs and regexps.
;; <<EOF <<"EOF" <<'EOF' (no space)
;; see `man perlop'
;; ?...?
;; /.../
;; m [...]
;; m /.../
;; q /.../ = '...'
;; qq /.../ = "..."
;; qx /.../ = `...`
;; qr /.../ = precompiled regexp =~=~ m/.../
;; qw /.../
;; s /.../.../
;; s <...> /.../
;; s '...'...'
;; tr /.../.../
;; y /.../.../
;;
;; <file*glob>
255
(defvar perl-font-lock-syntactic-keywords
256 257 258
  ;; TODO: here-documents ("<<\\(\\sw\\|['\"]\\)")
  '(;; Turn POD into b-style comments
    ("^\\(=\\)\\sw" (1 "< b"))
259 260
    ("^=cut[ \t]*\\(\n\\)" (1 "> b"))
    ;; Catch ${ so that ${var} doesn't screw up indentation.
261 262
    ;; This also catches $' to handle 'foo$', although it should really
    ;; check that it occurs inside a '..' string.
263
    ("\\(\\$\\)[{']" (1 ". p"))
264 265 266 267 268 269 270
    ;; Handle funny names like $DB'stop.
    ("\\$ ?{?^?[_a-zA-Z][_a-zA-Z0-9]*\\('\\)[_a-zA-Z]" (1 "_"))
    ;; format statements
    ("^[ \t]*format.*=[ \t]*\\(\n\\)" (1 '(7)))
    ;; Funny things in sub arg specifications like `sub myfunc ($$)'
    ("\\<sub\\s-+\\S-+\\s-*(\\([^)]+\\))" 1 '(1))
    ;; regexp and funny quotes
271
    ("[?:.,;=!~({[][ \t\n]*\\(/\\)" (1 '(7)))
272
    ("\\(^\\|[?:.,;=!~({[ \t]\\)\\([msy]\\|q[qxrw]?\\|tr\\)\\>\\s-*\\([^])}> \n\t]\\)"
273 274 275 276
     ;; Nasty cases:
     ;; /foo/m  $a->m  $#m $m @m %m
     ;; \s (appears often in regexps).
     ;; -s file
277
     (3 (if (assoc (char-after (match-beginning 3))
278
		   perl-quote-like-pairs)
279
	    '(15) '(7))))
280 281
    ;; Find and mark the end of funny quotes and format statements.
    (perl-font-lock-special-syntactic-constructs)
282
    ))
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299

(defvar perl-empty-syntax-table
  (let ((st (copy-syntax-table)))
    ;; Make all chars be of punctuation syntax.
    (dotimes (i 256) (aset st i '(1)))
    (modify-syntax-entry ?\\ "\\" st)
    st)
  "Syntax table used internally for processing quote-like operators.")

(defun perl-quote-syntax-table (char)
  (let ((close (cdr (assq char perl-quote-like-pairs)))
	(st (copy-syntax-table perl-empty-syntax-table)))
    (if (not close)
	(modify-syntax-entry char "\"" st)
      (modify-syntax-entry char "(" st)
      (modify-syntax-entry close ")" st))
    st))
300

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
(defun perl-font-lock-special-syntactic-constructs (limit)
  ;; We used to do all this in a font-lock-syntactic-face-function, which
  ;; did not work correctly because sometimes some parts of the buffer are
  ;; treated with font-lock-syntactic-keywords but not with
  ;; font-lock-syntactic-face-function (mostly because of
  ;; font-lock-syntactically-fontified).  That meant that some syntax-table
  ;; properties were missing.  So now we do the parse-partial-sexp loop
  ;; ourselves directly from font-lock-syntactic-keywords, so we're sure
  ;; it's done when necessary.
  (let ((state (syntax-ppss))
        char)
    (while (< (point) limit)
      (cond
       ((or (null (setq char (nth 3 state)))
            (and (char-valid-p char) (eq (char-syntax (nth 3 state)) ?\")))
        ;; Normal text, or comment, or docstring, or normal string.
        nil)
       ((eq (nth 3 state) ?\n)
        ;; A `format' command.
        (save-excursion
          (when (and (re-search-forward "^\\s *\\.\\s *$" nil t)
                     (not (eobp)))
            (put-text-property (point) (1+ (point)) 'syntax-table '(7)))))
       (t
        ;; This is regexp like quote thingy.
        (setq char (char-after (nth 8 state)))
        (save-excursion
          (let ((twoargs (save-excursion
                           (goto-char (nth 8 state))
                           (skip-syntax-backward " ")
                           (skip-syntax-backward "w")
                           (member (buffer-substring
                                    (point) (progn (forward-word 1) (point)))
                                   '("tr" "s" "y"))))
                (close (cdr (assq char perl-quote-like-pairs)))
                (pos (point))
                (st (perl-quote-syntax-table char)))
            (if (not close)
                ;; The closing char is the same as the opening char.
                (with-syntax-table st
                  (parse-partial-sexp (point) (point-max)
                                      nil nil state 'syntax-table)
                  (when twoargs
                    (parse-partial-sexp (point) (point-max)
                                        nil nil state 'syntax-table)))
              ;; The open/close chars are matched like () [] {} and <>.
              (let ((parse-sexp-lookup-properties nil))
                (condition-case err
                    (progn
                      (with-syntax-table st
                        (goto-char (nth 8 state)) (forward-sexp 1))
                      (when twoargs
                        (save-excursion
                          ;; Skip whitespace and make sure that font-lock will
                          ;; refontify the second part in the proper context.
                          (put-text-property
                           (point) (progn (forward-comment (point-max)) (point))
                           'font-lock-multiline t)
                          ;;
                          (unless
                              (save-excursion
                                (with-syntax-table
                                    (perl-quote-syntax-table (char-after))
                                  (forward-sexp 1))
                                (put-text-property pos (line-end-position)
                                                   'jit-lock-defer-multiline t)
                                (looking-at "\\s-*\\sw*e"))
                            (put-text-property (point) (1+ (point))
                                               'syntax-table
                                               (if (assoc (char-after)
                                                          perl-quote-like-pairs)
                                                   '(15) '(7)))))))
                  ;; The arg(s) is not terminated, so it extends until EOB.
                  (scan-error (goto-char (point-max))))))
            ;; Point is now right after the arg(s).
            ;; Erase any syntactic marks within the quoted text.
            (put-text-property pos (1- (point)) 'syntax-table nil)
            (when (eq (char-before (1- (point))) ?$)
              (put-text-property (- (point) 2) (1- (point))
                                 'syntax-table '(1)))
            (put-text-property (1- (point)) (point)
                               'syntax-table (if close '(15) '(7)))))))

      (setq state (parse-partial-sexp (point) limit nil nil state
				      'syntax-table))))
  ;; Tell font-lock that this needs not further processing.
  nil)
388

389

Stephen Eglen's avatar
Stephen Eglen committed
390 391
(defcustom perl-indent-level 4
  "*Indentation of Perl statements with respect to containing block."
392 393
  :type 'integer
  :group 'perl)
394
(put 'perl-indent-level 'safe-local-variable 'integerp)
Stephen Eglen's avatar
Stephen Eglen committed
395 396
(defcustom perl-continued-statement-offset 4
  "*Extra indent for lines not starting new statements."
397 398
  :type 'integer
  :group 'perl)
Stephen Eglen's avatar
Stephen Eglen committed
399
(defcustom perl-continued-brace-offset -4
Jim Blandy's avatar
Jim Blandy committed
400
  "*Extra indent for substatements that start with open-braces.
Stephen Eglen's avatar
Stephen Eglen committed
401
This is in addition to `perl-continued-statement-offset'."
402 403
  :type 'integer
  :group 'perl)
Stephen Eglen's avatar
Stephen Eglen committed
404 405
(defcustom perl-brace-offset 0
  "*Extra indentation for braces, compared with other text in same context."
406 407
  :type 'integer
  :group 'perl)
Stephen Eglen's avatar
Stephen Eglen committed
408 409
(defcustom perl-brace-imaginary-offset 0
  "*Imagined indentation of an open brace that actually follows a statement."
410 411
  :type 'integer
  :group 'perl)
Stephen Eglen's avatar
Stephen Eglen committed
412 413
(defcustom perl-label-offset -2
  "*Offset of Perl label lines relative to usual indentation."
414 415
  :type 'integer
  :group 'perl)
416 417 418
(defcustom perl-indent-continued-arguments nil
  "*If non-nil offset of argument lines relative to usual indentation.
If nil, continued arguments are aligned with the first argument."
419 420
  :type '(choice integer (const nil))
  :group 'perl)
Stephen Eglen's avatar
Stephen Eglen committed
421

422 423
(defcustom perl-tab-always-indent tab-always-indent
  "Non-nil means TAB in Perl mode always indents the current line.
424
Otherwise it inserts a tab character if you type it past the first
Stephen Eglen's avatar
Stephen Eglen committed
425
nonwhite character on the line."
426 427
  :type 'boolean
  :group 'perl)
Jim Blandy's avatar
Jim Blandy committed
428

429 430
;; I changed the default to nil for consistency with general Emacs
;; conventions -- rms.
Stephen Eglen's avatar
Stephen Eglen committed
431
(defcustom perl-tab-to-comment nil
432 433 434
  "*Non-nil means TAB moves to eol or makes a comment in some cases.
For lines which don't need indenting, TAB either indents an
existing comment, moves to end-of-line, or if at end-of-line already,
Stephen Eglen's avatar
Stephen Eglen committed
435
create a new comment."
436 437
  :type 'boolean
  :group 'perl)
Stephen Eglen's avatar
Stephen Eglen committed
438

439
(defcustom perl-nochange ";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:[^:]"
Stephen Eglen's avatar
Stephen Eglen committed
440
  "*Lines starting with this regular expression are not auto-indented."
441 442
  :type 'regexp
  :group 'perl)
443 444 445 446 447 448 449 450 451 452 453 454 455 456

;; Outline support

(defvar perl-outline-regexp
  (concat (mapconcat 'cadr perl-imenu-generic-expression "\\|")
	  "\\|^=cut\\>"))

(defun perl-outline-level ()
  (cond
   ((looking-at "package\\s-") 0)
   ((looking-at "sub\\s-") 1)
   ((looking-at "=head[0-9]") (- (char-before (match-end 0)) ?0))
   ((looking-at "=cut") 1)
   (t 3)))
Jim Blandy's avatar
Jim Blandy committed
457

458 459 460
(defvar perl-mode-hook nil
  "Normal hook to run when entering Perl mode.")

461
;;;###autoload
462
(defun perl-mode ()
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468 469 470
  "Major mode for editing Perl code.
Expression and list commands understand all Perl brackets.
Tab indents for Perl code.
Comments are delimited with # ... \\n.
Paragraphs are separated by blank lines only.
Delete converts tabs to spaces as it moves back.
\\{perl-mode-map}
Variables controlling indentation style:
471
 `perl-tab-always-indent'
Jim Blandy's avatar
Jim Blandy committed
472 473
    Non-nil means TAB in Perl mode should always indent the current line,
    regardless of where in the line point is when the TAB command is used.
474
 `perl-tab-to-comment'
Jim Blandy's avatar
Jim Blandy committed
475
    Non-nil means that for lines which don't need indenting, TAB will
476
    either delete an empty comment, indent an existing comment, move
Jim Blandy's avatar
Jim Blandy committed
477
    to end-of-line, or if at end-of-line already, create a new comment.
478
 `perl-nochange'
479
    Lines starting with this regular expression are not auto-indented.
480
 `perl-indent-level'
Jim Blandy's avatar
Jim Blandy committed
481 482 483
    Indentation of Perl statements within surrounding block.
    The surrounding block's indentation is the indentation
    of the line on which the open-brace appears.
484
 `perl-continued-statement-offset'
Jim Blandy's avatar
Jim Blandy committed
485 486
    Extra indentation given to a substatement, such as the
    then-clause of an if or body of a while.
487
 `perl-continued-brace-offset'
Jim Blandy's avatar
Jim Blandy committed
488
    Extra indentation given to a brace that starts a substatement.
489
    This is in addition to `perl-continued-statement-offset'.
490
 `perl-brace-offset'
Jim Blandy's avatar
Jim Blandy committed
491
    Extra indentation for line if it starts with an open brace.
492
 `perl-brace-imaginary-offset'
Jim Blandy's avatar
Jim Blandy committed
493 494
    An open brace following other text is treated as if it were
    this far to the right of the start of its line.
495
 `perl-label-offset'
Jim Blandy's avatar
Jim Blandy committed
496
    Extra indentation for line that is a label.
497 498
 `perl-indent-continued-arguments'
    Offset of argument lines relative to usual indentation.
Jim Blandy's avatar
Jim Blandy committed
499 500 501 502 503 504 505 506 507

Various indentation styles:       K&R  BSD  BLK  GNU  LW
  perl-indent-level                5    8    0    2    4
  perl-continued-statement-offset  5    8    4    2    4
  perl-continued-brace-offset      0    0    0    0   -4
  perl-brace-offset               -5   -8    0    0    0
  perl-brace-imaginary-offset      0    0    4    0    0
  perl-label-offset               -5   -8   -2   -2   -2

508
Turning on Perl mode runs the normal hook `perl-mode-hook'."
509 510 511 512 513 514 515
  (interactive)
  (kill-all-local-variables)
  (use-local-map perl-mode-map)
  (setq major-mode 'perl-mode)
  (setq mode-name "Perl")
  (setq local-abbrev-table perl-mode-abbrev-table)
  (set-syntax-table perl-mode-syntax-table)
Jim Blandy's avatar
Jim Blandy committed
516
  (make-local-variable 'paragraph-start)
517
  (setq paragraph-start (concat "$\\|" page-delimiter))
Jim Blandy's avatar
Jim Blandy committed
518 519 520 521 522 523 524
  (make-local-variable 'paragraph-separate)
  (setq paragraph-separate paragraph-start)
  (make-local-variable 'paragraph-ignore-fill-prefix)
  (setq paragraph-ignore-fill-prefix t)
  (make-local-variable 'indent-line-function)
  (setq indent-line-function 'perl-indent-line)
  (make-local-variable 'require-final-newline)
525
  (setq require-final-newline mode-require-final-newline)
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530 531
  (make-local-variable 'comment-start)
  (setq comment-start "# ")
  (make-local-variable 'comment-end)
  (setq comment-end "")
  (make-local-variable 'comment-start-skip)
  (setq comment-start-skip "\\(^\\|\\s-\\);?#+ *")
532 533
  (make-local-variable 'comment-indent-function)
  (setq comment-indent-function 'perl-comment-indent)
Jim Blandy's avatar
Jim Blandy committed
534
  (make-local-variable 'parse-sexp-ignore-comments)
535
  (setq parse-sexp-ignore-comments t)
Simon Marshall's avatar
Simon Marshall committed
536 537 538 539
  ;; Tell font-lock.el how to handle Perl.
  (setq font-lock-defaults '((perl-font-lock-keywords
			      perl-font-lock-keywords-1
			      perl-font-lock-keywords-2)
540 541 542 543
			     nil nil ((?\_ . "w")) nil
			     (font-lock-syntactic-keywords
			      . perl-font-lock-syntactic-keywords)
			     (parse-sexp-lookup-properties . t)))
544
  ;; Tell imenu how to handle Perl.
545 546
  (set (make-local-variable 'imenu-generic-expression)
       perl-imenu-generic-expression)
547
  (setq imenu-case-fold-search nil)
548 549 550
  ;; Setup outline-minor-mode.
  (set (make-local-variable 'outline-regexp) perl-outline-regexp)
  (set (make-local-variable 'outline-level) 'perl-outline-level)
551
  (run-mode-hooks 'perl-mode-hook))
Jim Blandy's avatar
Jim Blandy committed
552 553 554 555 556 557 558

;; This is used by indent-for-comment
;; to decide how much to indent a comment in Perl code
;; based on its context.
(defun perl-comment-indent ()
  (if (and (bolp) (not (eolp)))
      0					;Existing comment at bol stays there.
559 560 561 562
    comment-column))

(defalias 'electric-perl-terminator 'perl-electric-terminator)
(defun perl-electric-terminator (arg)
563 564
  "Insert character and adjust indentation.
If at end-of-line, and not in a comment or a quote, correct the's indentation."
Jim Blandy's avatar
Jim Blandy committed
565 566 567 568 569 570 571
  (interactive "P")
  (let ((insertpos (point)))
    (and (not arg)			; decide whether to indent
	 (eolp)
	 (save-excursion
	   (beginning-of-line)
	   (and (not			; eliminate comments quickly
572 573
		 (and comment-start-skip
		      (re-search-forward comment-start-skip insertpos t)) )
Jim Blandy's avatar
Jim Blandy committed
574 575 576
		(or (/= last-command-char ?:)
		    ;; Colon is special only after a label ....
		    (looking-at "\\s-*\\(\\w\\|\\s_\\)+$"))
577
		(let ((pps (parse-partial-sexp
Jim Blandy's avatar
Jim Blandy committed
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
			    (perl-beginning-of-function) insertpos)))
		  (not (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))
	 (progn				; must insert, indent, delete
	   (insert-char last-command-char 1)
	   (perl-indent-line)
	   (delete-char -1))))
  (self-insert-command (prefix-numeric-value arg)))

;; not used anymore, but may be useful someday:
;;(defun perl-inside-parens-p ()
;;  (condition-case ()
;;      (save-excursion
;;	(save-restriction
;;	  (narrow-to-region (point)
;;			    (perl-beginning-of-function))
;;	  (goto-char (point-max))
;;	  (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
;;    (error nil)))

(defun perl-indent-command (&optional arg)
  "Indent current line as Perl code, or optionally, insert a tab character.

With an argument, indent the current line, regardless of other options.

602
If `perl-tab-always-indent' is nil and point is not in the indentation
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606 607
area at the beginning of the line, simply insert a tab.

Otherwise, indent the current line.  If point was within the indentation
area it is moved to the end of the indentation area.  If the line was
already indented properly and point was not within the indentation area,
608
and if `perl-tab-to-comment' is non-nil (the default), then do the first
Jim Blandy's avatar
Jim Blandy committed
609 610 611 612 613 614 615 616 617 618 619
possible action from the following list:

  1) delete an empty comment
  2) move forward to start of comment, indenting if necessary
  3) move forward to end of line
  4) create an empty comment
  5) move backward to start of comment, indenting if necessary."
  (interactive "P")
  (if arg				; If arg, just indent this line
      (perl-indent-line "\f")
    (if (and (not perl-tab-always-indent)
620
	     (> (current-column) (current-indentation)))
Jim Blandy's avatar
Jim Blandy committed
621
	(insert-tab)
622 623 624 625 626 627
      (let* ((oldpnt (point))
	     (lsexp (progn (beginning-of-line) (point)))
	     (bof (perl-beginning-of-function))
	     (delta (progn
		      (goto-char oldpnt)
		      (perl-indent-line "\f\\|;?#" bof))))
Jim Blandy's avatar
Jim Blandy committed
628 629 630 631 632
	(and perl-tab-to-comment
	     (= oldpnt (point))		; done if point moved
	     (if (listp delta)		; if line starts in a quoted string
		 (setq lsexp (or (nth 2 delta) bof))
	       (= delta 0))		; done if indenting occurred
633 634
	     (let ((eol (progn (end-of-line) (point)))
		   state)
Jim Blandy's avatar
Jim Blandy committed
635 636
	       (if (= (char-after bof) ?=)
		   (if (= oldpnt eol)
637
		       (message "In a format statement"))
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641 642 643 644 645 646
		 (setq state (parse-partial-sexp lsexp eol))
		 (if (nth 3 state)
		     (if (= oldpnt eol)	; already at eol in a string
			 (message "In a string which starts with a %c."
				  (nth 3 state)))
		   (if (not (nth 4 state))
		       (if (= oldpnt eol) ; no comment, create one?
			   (indent-for-comment))
		     (beginning-of-line)
647 648
		     (if (and comment-start-skip
			      (re-search-forward comment-start-skip eol 'move))
Jim Blandy's avatar
Jim Blandy committed
649
			 (if (eolp)
650
			     (progn	; delete existing comment
Jim Blandy's avatar
Jim Blandy committed
651 652
			       (goto-char (match-beginning 0))
			       (skip-chars-backward " \t")
653
			       (delete-region (point) eol))
Jim Blandy's avatar
Jim Blandy committed
654 655 656 657 658 659 660 661 662
			   (if (or (< oldpnt (point)) (= oldpnt eol))
			       (indent-for-comment) ; indent existing comment
			     (end-of-line)))
		       (if (/= oldpnt eol)
			   (end-of-line)
			 (message "Use backslash to quote # characters.")
			 (ding t))))))))))))

(defun perl-indent-line (&optional nochange parse-start)
663
  "Indent current line as Perl code.
664
Return the amount the indentation
Jim Blandy's avatar
Jim Blandy committed
665 666 667 668 669 670 671 672
changed by, or (parse-state) if line starts in a quoted string."
  (let ((case-fold-search nil)
	(pos (- (point-max) (point)))
	(bof (or parse-start (save-excursion (perl-beginning-of-function))))
	beg indent shift-amt)
    (beginning-of-line)
    (setq beg (point))
    (setq shift-amt
673
	  (cond ((eq (char-after bof) ?=) 0)
674
		((listp (setq indent (perl-calculate-indent bof))) indent)
Jim Blandy's avatar
Jim Blandy committed
675 676 677
		((looking-at (or nochange perl-nochange)) 0)
		(t
		 (skip-chars-forward " \t\f")
678
		 (setq indent (perl-indent-new-calculate nil indent bof))
Jim Blandy's avatar
Jim Blandy committed
679 680 681 682 683 684 685 686 687 688 689
		 (- indent (current-column)))))
    (skip-chars-forward " \t\f")
    (if (and (numberp shift-amt) (/= 0 shift-amt))
	(progn (delete-region beg (point))
	       (indent-to indent)))
    ;; If initial point was within line's indentation,
    ;; position after the indentation.  Else stay at same point in text.
    (if (> (- (point-max) pos) (point))
	(goto-char (- (point-max) pos)))
    shift-amt))

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
(defun perl-continuation-line-p (limit)
  "Move to end of previous line and return non-nil if continued."
  ;; Statement level.  Is it a continuation or a new statement?
  ;; Find previous non-comment character.
  (perl-backward-to-noncomment)
  ;; Back up over label lines, since they don't
  ;; affect whether our line is a continuation.
  (while (or (eq (preceding-char) ?\,)
	     (and (eq (preceding-char) ?:)
		  (memq (char-syntax (char-after (- (point) 2)))
			'(?w ?_))))
    (if (eq (preceding-char) ?\,)
	(perl-backward-to-start-of-continued-exp limit)
      (beginning-of-line))
    (perl-backward-to-noncomment))
  ;; Now we get the answer.
  (not (memq (preceding-char) '(?\; ?\} ?\{))))

708 709 710 711 712 713
(defun perl-hanging-paren-p ()
  "Non-nil if we are right after a hanging parenthesis-like char."
  (and (looking-at "[ \t]*$")
       (save-excursion
	 (skip-syntax-backward " (") (not (bolp)))))

714 715 716 717 718 719 720 721 722 723 724
(defun perl-indent-new-calculate (&optional virtual default parse-start)
  (or
   (and virtual (save-excursion (skip-chars-backward " \t") (bolp))
	(current-column))
   (and (looking-at "\\(\\w\\|\\s_\\)+:[^:]")
	(max 1 (+ (or default (perl-calculate-indent parse-start))
		  perl-label-offset)))
   (and (= (char-syntax (following-char)) ?\))
	(save-excursion
	  (forward-char 1)
	  (forward-sexp -1)
725 726 727 728
	  (perl-indent-new-calculate
           ;; Recalculate the parsing-start, since we may have jumped
           ;; dangerously close (typically in the case of nested functions).
           'virtual nil (save-excursion (perl-beginning-of-function)))))
729 730 731 732 733 734
   (and (and (= (following-char) ?{)
	     (save-excursion (forward-char) (perl-hanging-paren-p)))
	(+ (or default (perl-calculate-indent parse-start))
	   perl-brace-offset))
   (or default (perl-calculate-indent parse-start))))

735
(defun perl-calculate-indent (&optional parse-start)
Jim Blandy's avatar
Jim Blandy committed
736 737
  "Return appropriate indentation for current line as Perl code.
In usual case returns an integer: the column to indent to.
738 739
Returns (parse-state) if line starts inside a string.
Optional argument PARSE-START should be the position of `beginning-of-defun'."
Jim Blandy's avatar
Jim Blandy committed
740 741 742 743 744 745 746 747
  (save-excursion
    (let ((indent-point (point))
	  (case-fold-search nil)
	  (colon-line-end 0)
	  state containing-sexp)
      (if parse-start			;used to avoid searching
	  (goto-char parse-start)
	(perl-beginning-of-function))
748 749 750 751 752 753 754 755 756
      ;; We might be now looking at a local function that has nothing to
      ;; do with us because `indent-point' is past it.  In this case
      ;; look further back up for another `perl-beginning-of-function'.
      (while (and (looking-at "{")
		  (save-excursion
		    (beginning-of-line)
		    (looking-at "\\s-+sub\\>"))
		  (> indent-point (save-excursion (forward-sexp 1) (point))))
	(perl-beginning-of-function))
Jim Blandy's avatar
Jim Blandy committed
757 758
      (while (< (point) indent-point)	;repeat until right sexp
	(setq state (parse-partial-sexp (point) indent-point 0))
759 760 761 762
	;; state = (depth_in_parens innermost_containing_list
	;;          last_complete_sexp string_terminator_or_nil inside_commentp
	;;          following_quotep minimum_paren-depth_this_scan)
	;; Parsing stops if depth in parentheses becomes equal to third arg.
Jim Blandy's avatar
Jim Blandy committed
763 764 765 766 767
	(setq containing-sexp (nth 1 state)))
      (cond ((nth 3 state) state)	; In a quoted string?
	    ((null containing-sexp)	; Line is at top level.
	     (skip-chars-forward " \t\f")
	     (if (= (following-char) ?{)
768
		 0  ; move to beginning of line if it starts a function body
Jim Blandy's avatar
Jim Blandy committed
769 770 771 772 773 774 775 776 777
	       ;; indent a little if this is a continuation line
	       (perl-backward-to-noncomment)
	       (if (or (bobp)
		       (memq (preceding-char) '(?\; ?\})))
		   0 perl-continued-statement-offset)))
	    ((/= (char-after containing-sexp) ?{)
	     ;; line is expression, not statement:
	     ;; indent to just after the surrounding open.
	     (goto-char (1+ containing-sexp))
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
	     (if (perl-hanging-paren-p)
		 ;; We're indenting an arg of a call like:
		 ;;    $a = foobarlongnamefun (
		 ;;             arg1
		 ;;             arg2
		 ;;         );
		 (progn
		   (skip-syntax-backward "(")
		   (condition-case err
		       (while (save-excursion
				(skip-syntax-backward " ") (not (bolp)))
			 (forward-sexp -1))
		     (scan-error nil))
		   (+ (current-column) perl-indent-level))
	       (if perl-indent-continued-arguments
		   (+ perl-indent-continued-arguments (current-indentation))
		 (skip-chars-forward " \t")
		 (current-column))))
Jim Blandy's avatar
Jim Blandy committed
796 797
	    (t
	     ;; Statement level.  Is it a continuation or a new statement?
798
	     (if (perl-continuation-line-p containing-sexp)
Jim Blandy's avatar
Jim Blandy committed
799 800 801 802 803
		 ;; This line is continuation of preceding line's statement;
		 ;; indent  perl-continued-statement-offset  more than the
		 ;; previous line of the statement.
		 (progn
		   (perl-backward-to-start-of-continued-exp containing-sexp)
804 805 806 807 808 809
		   (+ (if (save-excursion
			    (perl-continuation-line-p containing-sexp))
			  ;; If the continued line is itself a continuation
			  ;; line, then align, otherwise add an offset.
			  0 perl-continued-statement-offset)
		      (current-column)
Jim Blandy's avatar
Jim Blandy committed
810 811 812 813 814 815 816
		      (if (save-excursion (goto-char indent-point)
					  (looking-at "[ \t]*{"))
			  perl-continued-brace-offset 0)))
	       ;; This line starts a new statement.
	       ;; Position at last unclosed open.
	       (goto-char containing-sexp)
	       (or
817 818 819
		;; Is line first statement after an open-brace?
		;; If no, find that first statement and indent like it.
		(save-excursion
820 821 822 823 824 825
		  (forward-char 1)
		  ;; Skip over comments and labels following openbrace.
		  (while (progn
			   (skip-chars-forward " \t\f\n")
			   (cond ((looking-at ";?#")
				  (forward-line 1) t)
826
				 ((looking-at "\\(\\w\\|\\s_\\)+:[^:]")
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
				  (save-excursion
				    (end-of-line)
				    (setq colon-line-end (point)))
				  (search-forward ":")))))
		  ;; The first following code counts
		  ;; if it is before the line we want to indent.
		  (and (< (point) indent-point)
		       (if (> colon-line-end (point))
			   (- (current-indentation) perl-label-offset)
			 (current-column))))
		;; If no previous statement,
		;; indent it relative to line brace is on.
		;; For open paren in column zero, don't let statement
		;; start there too.  If perl-indent-level is zero,
		;; use perl-brace-offset + perl-continued-statement-offset
		;; For open-braces not the first thing in a line,
		;; add in perl-brace-imaginary-offset.
		(+ (if (and (bolp) (zerop perl-indent-level))
		       (+ perl-brace-offset perl-continued-statement-offset)
		     perl-indent-level)
		   ;; Move back over whitespace before the openbrace.
		   ;; If openbrace is not first nonwhite thing on the line,
		   ;; add the perl-brace-imaginary-offset.
		   (progn (skip-chars-backward " \t")
			  (if (bolp) 0 perl-brace-imaginary-offset))
		   ;; If the openbrace is preceded by a parenthesized exp,
		   ;; move to the beginning of that;
		   ;; possibly a different line
		   (progn
		     (if (eq (preceding-char) ?\))
			 (forward-sexp -1))
		     ;; Get initial indentation of the line we are on.
		     (current-indentation))))))))))
Jim Blandy's avatar
Jim Blandy committed
860 861 862

(defun perl-backward-to-noncomment ()
  "Move point backward to after the first non-white-space, skipping comments."
863
  (interactive)
864
  (forward-comment (- (point-max))))
Jim Blandy's avatar
Jim Blandy committed
865 866 867 868 869 870 871 872 873 874

(defun perl-backward-to-start-of-continued-exp (lim)
  (if (= (preceding-char) ?\))
      (forward-sexp -1))
  (beginning-of-line)
  (if (<= (point) lim)
      (goto-char (1+ lim)))
  (skip-chars-forward " \t\f"))

;; note: this may be slower than the c-mode version, but I can understand it.
875 876
(defalias 'indent-perl-exp 'perl-indent-exp)
(defun perl-indent-exp ()
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
  "Indent each line of the Perl grouping following point."
  (interactive)
  (let* ((case-fold-search nil)
	 (oldpnt (point-marker))
	 (bof-mark (save-excursion
		     (end-of-line 2)
		     (perl-beginning-of-function)
		     (point-marker)))
	 eol last-mark lsexp-mark delta)
    (if (= (char-after (marker-position bof-mark)) ?=)
	(message "Can't indent a format statement")
      (message "Indenting Perl expression...")
      (save-excursion (end-of-line) (setq eol (point)))
      (save-excursion			; locate matching close paren
	(while (and (not (eobp)) (<= (point) eol))
	  (parse-partial-sexp (point) (point-max) 0))
	(setq last-mark (point-marker)))
      (setq lsexp-mark bof-mark)
      (beginning-of-line)
      (while (< (point) (marker-position last-mark))
	(setq delta (perl-indent-line nil (marker-position bof-mark)))
	(if (numberp delta)		; unquoted start-of-line?
899
	    (progn
Jim Blandy's avatar
Jim Blandy committed
900 901 902 903 904 905 906 907 908 909 910 911
	      (if (eolp)
		  (delete-horizontal-space))
	      (setq lsexp-mark (point-marker))))
	(end-of-line)
	(setq eol (point))
	(if (nth 4 (parse-partial-sexp (marker-position lsexp-mark) eol))
	    (progn			; line ends in a comment
	      (beginning-of-line)
	      (if (or (not (looking-at "\\s-*;?#"))
		      (listp delta)
		      (and (/= 0 delta)
			   (= (- (current-indentation) delta) comment-column)))
912 913
		  (if (and comment-start-skip
			   (re-search-forward comment-start-skip eol t))
Jim Blandy's avatar
Jim Blandy committed
914 915 916 917 918 919 920 921 922 923 924 925 926
		      (indent-for-comment))))) ; indent existing comment
	(forward-line 1))
      (goto-char (marker-position oldpnt))
      (message "Indenting Perl expression...done"))))

(defun perl-beginning-of-function (&optional arg)
  "Move backward to next beginning-of-function, or as far as possible.
With argument, repeat that many times; negative args move forward.
Returns new value of point in all cases."
  (interactive "p")
  (or arg (setq arg 1))
  (if (< arg 0) (forward-char 1))
  (and (/= arg 0)
927 928 929
       (re-search-backward
        "^\\s(\\|^\\s-*sub\\b[ \t\n]*\\_<[^{]+{\\|^\\s-*format\\b[^=]*=\\|^\\."
        nil 'move arg)
Jim Blandy's avatar
Jim Blandy committed
930 931 932 933 934 935 936 937 938 939 940 941 942
       (goto-char (1- (match-end 0))))
  (point))

;; note: this routine is adapted directly from emacs lisp.el, end-of-defun;
;; no bugs have been removed :-)
(defun perl-end-of-function (&optional arg)
  "Move forward to next end-of-function.
The end of a function is found by moving forward from the beginning of one.
With argument, repeat that many times; negative args move backward."
  (interactive "p")
  (or arg (setq arg 1))
  (let ((first t))
    (while (and (> arg 0) (< (point) (point-max)))
943
      (let ((pos (point)))
Jim Blandy's avatar
Jim Blandy committed
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
	(while (progn
		(if (and first
			 (progn
			  (forward-char 1)
			  (perl-beginning-of-function 1)
			  (not (bobp))))
		    nil
		  (or (bobp) (forward-char -1))
		  (perl-beginning-of-function -1))
		(setq first nil)
		(forward-list 1)
		(skip-chars-forward " \t")
		(if (looking-at "[#\n]")
		    (forward-line 1))
		(<= (point) pos))))
      (setq arg (1- arg)))
    (while (< arg 0)
      (let ((pos (point)))
	(perl-beginning-of-function 1)
	(forward-sexp 1)
	(forward-line 1)
	(if (>= (point) pos)
	    (if (progn (perl-beginning-of-function 2) (not (bobp)))
		(progn
		  (forward-list 1)
		  (skip-chars-forward " \t")
		  (if (looking-at "[#\n]")
		      (forward-line 1)))
	      (goto-char (point-min)))))
      (setq arg (1+ arg)))))

975 976
(defalias 'mark-perl-function 'perl-mark-function)
(defun perl-mark-function ()
Jim Blandy's avatar
Jim Blandy committed
977 978 979 980 981 982 983 984
  "Put mark at end of Perl function, point at beginning."
  (interactive)
  (push-mark (point))
  (perl-end-of-function)
  (push-mark (point))
  (perl-beginning-of-function)
  (backward-paragraph))

Richard M. Stallman's avatar
Richard M. Stallman committed
985 986
(provide 'perl-mode)

987
;; arch-tag: 8c7ff68d-15f3-46a2-ade2-b7c41f176826
Richard M. Stallman's avatar
Richard M. Stallman committed
988
;;; perl-mode.el ends here