(eval-when-compile (require 'cl))
(defgroup perl nil
"Major mode for editing Perl code."
:prefix "perl-"
:group 'languages)
(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)
"Keymap used in Perl mode.")
(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)
(defvar perl-mode-syntax-table
(let ((st (make-syntax-table (standard-syntax-table))))
(modify-syntax-entry ?\n ">" 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)
(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.")
(defvar perl-imenu-generic-expression
'( (nil "^sub\\s-+\\([-A-Za-z0-9+_:]+\\)\\(\\s-\\|\n\\)*{" 1 )
("Variables" "^\\([$@%][-A-Za-z0-9+_:]+\\)\\s-*=" 1 )
("Packages" "^package\\s-+\\([-A-Za-z0-9+_:]+\\);" 1 ))
"Imenu generic expression for Perl mode. See `imenu-generic-expression'.")
(defconst perl-font-lock-keywords-1
'( ("\\<\\(package\\|sub\\)\\>[ \t]*\\(\\sw+\\)?"
(1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
("\\<\\(import\\|no\\|require\\|use\\)\\>[ \t]*\\(\\sw+\\)?"
(1 font-lock-keyword-face) (2 font-lock-constant-face nil t)))
"Subdued level highlighting for Perl mode.")
(defconst perl-font-lock-keywords-2
(append perl-font-lock-keywords-1
(list
(concat "\\<\\("
"BEGIN\\|END\\|d\\(ie\\|o\\|ump\\)\\|"
"e\\(ls\\(e\\|if\\)\\|val\\|x\\(ec\\|it\\)\\)\\|"
"for\\(\\|each\\)\\|if\\|return\\|un\\(less\\|til\\)\\|while"
"\\)\\>")
'("\\<\\(local\\|my\\)\\>" . font-lock-type-face)
'("&\\(\\sw+\\)" 1 font-lock-function-name-face)
'("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
'("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
(2 (cons font-lock-variable-name-face '(underline))))
'("<\\(\\sw+\\)>" 1 font-lock-constant-face)
'("\\<\\(continue\\|goto\\|last\\|next\\|redo\\)\\>[ \t]*\\(\\sw+\\)?"
(1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
'("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-constant-face)))
"Gaudy level highlighting for Perl mode.")
(defvar perl-font-lock-keywords perl-font-lock-keywords-1
"Default expressions to highlight in Perl mode.")
(defvar perl-font-lock-syntactic-keywords
'(("^\\(=\\)\\(head1\\|pod\\)\\([ \t]\\|$\\)" (1 "< b"))
("^=cut[ \t]*\\(\n\\)" (1 "> b"))
("\\(\\$\\)[{']" (1 "."))))
(defun perl-font-lock-syntactic-face-function (state)
(if (nth 3 state)
font-lock-string-face
(if (nth 7 state) font-lock-doc-face font-lock-comment-face)))
(defcustom perl-indent-level 4
"*Indentation of Perl statements with respect to containing block."
:type 'integer
:group 'perl)
(defcustom perl-continued-statement-offset 4
"*Extra indent for lines not starting new statements."
:type 'integer
:group 'perl)
(defcustom perl-continued-brace-offset -4
"*Extra indent for substatements that start with open-braces.
This is in addition to `perl-continued-statement-offset'."
:type 'integer
:group 'perl)
(defcustom perl-brace-offset 0
"*Extra indentation for braces, compared with other text in same context."
:type 'integer
:group 'perl)
(defcustom perl-brace-imaginary-offset 0
"*Imagined indentation of an open brace that actually follows a statement."
:type 'integer
:group 'perl)
(defcustom perl-label-offset -2
"*Offset of Perl label lines relative to usual indentation."
:type 'integer
:group 'perl)
(defcustom perl-tab-always-indent t
"*Non-nil means TAB in Perl mode always indents the current line.
Otherwise it inserts a tab character if you type it past the first
nonwhite character on the line."
:type 'boolean
:group 'perl)
(defcustom perl-tab-to-comment nil
"*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,
create a new comment."
:type 'boolean
:group 'perl)
(defcustom perl-nochange ";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:"
"*Lines starting with this regular expression are not auto-indented."
:type 'regexp
:group 'perl)
(define-derived-mode perl-mode nil "Perl"
"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:
perl-tab-always-indent
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.
perl-tab-to-comment
Non-nil means that for lines which don't need indenting, TAB will
either delete an empty comment, indent an existing comment, move
to end-of-line, or if at end-of-line already, create a new comment.
perl-nochange
Lines starting with this regular expression are not auto-indented.
perl-indent-level
Indentation of Perl statements within surrounding block.
The surrounding block's indentation is the indentation
of the line on which the open-brace appears.
perl-continued-statement-offset
Extra indentation given to a substatement, such as the
then-clause of an if or body of a while.
perl-continued-brace-offset
Extra indentation given to a brace that starts a substatement.
This is in addition to `perl-continued-statement-offset'.
perl-brace-offset
Extra indentation for line if it starts with an open brace.
perl-brace-imaginary-offset
An open brace following other text is treated as if it were
this far to the right of the start of its line.
perl-label-offset
Extra indentation for line that is a label.
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
Turning on Perl mode runs the normal hook `perl-mode-hook'."
(make-local-variable 'paragraph-start)
(setq paragraph-start (concat "$\\|" page-delimiter))
(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)
(setq require-final-newline t)
(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-\\);?#+ *")
(make-local-variable 'comment-indent-function)
(setq comment-indent-function 'perl-comment-indent)
(make-local-variable 'parse-sexp-ignore-comments)
(setq parse-sexp-ignore-comments t)
(setq font-lock-defaults '((perl-font-lock-keywords
perl-font-lock-keywords-1
perl-font-lock-keywords-2)
nil nil ((?\_ . "w")) nil
(font-lock-syntactic-keywords
. perl-font-lock-syntactic-keywords)
(font-lock-syntactic-face-function
. perl-font-lock-syntactic-face-function)
(parse-sexp-lookup-properties . t)))
(make-local-variable 'imenu-generic-expression)
(setq imenu-generic-expression perl-imenu-generic-expression)
(setq imenu-case-fold-search nil))
(defun perl-comment-indent ()
(if (and (bolp) (not (eolp)))
0 comment-column))
(defalias 'electric-perl-terminator 'perl-electric-terminator)
(defun perl-electric-terminator (arg)
"Insert character and adjust indentation.
If at end-of-line, and not in a comment or a quote, correct the's indentation."
(interactive "P")
(let ((insertpos (point)))
(and (not arg) (eolp)
(save-excursion
(beginning-of-line)
(and (not (and comment-start-skip
(re-search-forward comment-start-skip insertpos t)) )
(or (/= last-command-char ?:)
(looking-at "\\s-*\\(\\w\\|\\s_\\)+$"))
(let ((pps (parse-partial-sexp
(perl-beginning-of-function) insertpos)))
(not (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))
(progn (insert-char last-command-char 1)
(perl-indent-line)
(delete-char -1))))
(self-insert-command (prefix-numeric-value arg)))
(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.
If `perl-tab-always-indent' is nil and point is not in the indentation
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,
and if `perl-tab-to-comment' is non-nil (the default), then do the first
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 (perl-indent-line "\f")
(if (and (not perl-tab-always-indent)
(> (current-column) (current-indentation)))
(insert-tab)
(let (bof lsexp delta (oldpnt (point)))
(beginning-of-line)
(setq lsexp (point))
(setq bof (perl-beginning-of-function))
(goto-char oldpnt)
(setq delta (perl-indent-line "\f\\|;?#" bof))
(and perl-tab-to-comment
(= oldpnt (point)) (if (listp delta) (setq lsexp (or (nth 2 delta) bof))
(= delta 0)) (let (eol state)
(end-of-line)
(setq eol (point))
(if (= (char-after bof) ?=)
(if (= oldpnt eol)
(message "In a format statement"))
(setq state (parse-partial-sexp lsexp eol))
(if (nth 3 state)
(if (= oldpnt eol) (message "In a string which starts with a %c."
(nth 3 state)))
(if (not (nth 4 state))
(if (= oldpnt eol) (indent-for-comment))
(beginning-of-line)
(if (and comment-start-skip
(re-search-forward comment-start-skip eol 'move))
(if (eolp)
(progn (goto-char (match-beginning 0))
(skip-chars-backward " \t")
(kill-region (point) eol))
(if (or (< oldpnt (point)) (= oldpnt eol))
(indent-for-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)
"Indent current line as Perl code.
Return the amount the indentation
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
(cond ((eq (char-after bof) ?=) 0)
((listp (setq indent (perl-calculate-indent bof))) indent)
((looking-at (or nochange perl-nochange)) 0)
(t
(skip-chars-forward " \t\f")
(cond ((looking-at "\\(\\w\\|\\s_\\)+:[^:]")
(setq indent (max 1 (+ indent perl-label-offset))))
((= (following-char) ?})
(setq indent (- indent perl-indent-level)))
((= (following-char) ?{)
(setq indent (+ indent perl-brace-offset))))
(- 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 (> (- (point-max) pos) (point))
(goto-char (- (point-max) pos)))
shift-amt))
(defun perl-continuation-line-p (limit)
"Move to end of previous line and return non-nil if continued."
(perl-backward-to-noncomment)
(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))
(not (memq (preceding-char) '(?\
(defun perl-calculate-indent (&optional parse-start)
"Return appropriate indentation for current line as Perl code.
In usual case returns an integer: the column to indent to.
Returns (parse-state) if line starts inside a string."
(save-excursion
(beginning-of-line)
(let ((indent-point (point))
(case-fold-search nil)
(colon-line-end 0)
state containing-sexp)
(if parse-start (goto-char parse-start)
(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))
(while (< (point) indent-point) (setq parse-start (point))
(setq state (parse-partial-sexp (point) indent-point 0))
(setq containing-sexp (nth 1 state)))
(cond ((nth 3 state) state) ((null containing-sexp) (skip-chars-forward " \t\f")
(if (= (following-char) ?{)
0 (perl-backward-to-noncomment)
(if (or (bobp)
(memq (preceding-char) '(?\ 0 perl-continued-statement-offset)))
((/= (char-after containing-sexp) ?{)
(goto-char (1+ containing-sexp))
(skip-chars-forward " \t")
(current-column))
(t
(if (perl-continuation-line-p containing-sexp)
(progn
(perl-backward-to-start-of-continued-exp containing-sexp)
(+ (if (save-excursion
(perl-continuation-line-p containing-sexp))
0 perl-continued-statement-offset)
(current-column)
(if (save-excursion (goto-char indent-point)
(looking-at "[ \t]*{"))
perl-continued-brace-offset 0)))
(goto-char containing-sexp)
(or
(and (bolp)
(save-excursion (goto-char indent-point)
(looking-at "[ \t]*}"))
perl-indent-level)
(save-excursion
(forward-char 1)
(while (progn
(skip-chars-forward " \t\f\n")
(cond ((looking-at ";?#")
(forward-line 1) t)
((looking-at "\\(\\w\\|\\s_\\)+:")
(save-excursion
(end-of-line)
(setq colon-line-end (point)))
(search-forward ":")))))
(and (< (point) indent-point)
(if (> colon-line-end (point))
(- (current-indentation) perl-label-offset)
(current-column))))
(+ (if (and (bolp) (zerop perl-indent-level))
(+ perl-brace-offset perl-continued-statement-offset)
perl-indent-level)
(progn (skip-chars-backward " \t")
(if (bolp) 0 perl-brace-imaginary-offset))
(progn
(if (eq (preceding-char) ?\))
(forward-sexp -1))
(current-indentation))))))))))
(defun perl-backward-to-noncomment ()
"Move point backward to after the first non-white-space, skipping comments."
(interactive)
(let (opoint stop)
(while (not stop)
(setq opoint (point))
(beginning-of-line)
(if (and comment-start-skip
(re-search-forward comment-start-skip opoint 'move 1))
(progn (goto-char (match-end 1))
(skip-chars-forward ";")))
(skip-chars-backward " \t\f")
(setq stop (or (bobp)
(not (bolp))
(forward-char -1))))))
(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"))
(defalias 'indent-perl-exp 'perl-indent-exp)
(defun perl-indent-exp ()
"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 (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) (progn
(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 (beginning-of-line)
(if (or (not (looking-at "\\s-*;?#"))
(listp delta)
(and (/= 0 delta)
(= (- (current-indentation) delta) comment-column)))
(if (and comment-start-skip
(re-search-forward comment-start-skip eol t))
(indent-for-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)
(re-search-backward "^\\s(\\|^\\s-*sub\\b[^{]+{\\|^\\s-*format\\b[^=]*=\\|^\\."
nil 'move arg)
(goto-char (1- (match-end 0))))
(point))
(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)))
(let ((pos (point)) npos)
(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)))))
(defalias 'mark-perl-function 'perl-mark-function)
(defun perl-mark-function ()
"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))
(provide 'perl-mode)