Refill some copyright headers.
[bpt/emacs.git] / lisp / progmodes / cperl-mode.el
CommitLineData
f83d2997
KH
1;;; cperl-mode.el --- Perl code editing commands for Emacs
2
e9bffc61
GM
3;; Copyright (C) 1985, 1986, 1987, 1991, 1992, 1993, 1994, 1995, 1996,
4;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5;; 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
f83d2997 6
5858f68c
GM
7;; Author: Ilya Zakharevich
8;; Bob Olson
4ab89e7b 9;; Maintainer: Ilya Zakharevich <ilyaz@cpan.org>
f83d2997
KH
10;; Keywords: languages, Perl
11
12;; This file is part of GNU Emacs.
13
b1fc2b50 14;; GNU Emacs is free software: you can redistribute it and/or modify
f83d2997 15;; it under the terms of the GNU General Public License as published by
b1fc2b50
GM
16;; the Free Software Foundation, either version 3 of the License, or
17;; (at your option) any later version.
f83d2997
KH
18
19;; GNU Emacs is distributed in the hope that it will be useful,
20;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22;; GNU General Public License for more details.
23
24;; You should have received a copy of the GNU General Public License
b1fc2b50 25;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
f83d2997 26
4ab89e7b 27;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
f83d2997
KH
28
29;;; Commentary:
30
83261a2f
SM
31;; You can either fine-tune the bells and whistles of this mode or
32;; bulk enable them by putting
f83d2997
KH
33
34;; (setq cperl-hairy t)
35
83261a2f
SM
36;; in your .emacs file. (Emacs rulers do not consider it politically
37;; correct to make whistles enabled by default.)
f83d2997 38
83261a2f
SM
39;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
40;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
15ca5699 41;; `cperl-praise', `cperl-speed'. <<<<<<
f83d2997 42
83261a2f
SM
43;; The mode information (on C-h m) provides some customization help.
44;; If you use font-lock feature of this mode, it is advisable to use
45;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
f83d2997 46
83261a2f
SM
47;; Faces used now: three faces for first-class and second-class keywords
48;; and control flow words, one for each: comments, string, labels,
49;; functions definitions and packages, arrays, hashes, and variable
50;; definitions. If you do not see all these faces, your font-lock does
51;; not define them, so you need to define them manually.
f83d2997 52
83261a2f
SM
53;; This mode supports font-lock, imenu and mode-compile. In the
54;; hairy version font-lock is on, but you should activate imenu
55;; yourself (note that mode-compile is not standard yet). Well, you
56;; can use imenu from keyboard anyway (M-x imenu), but it is better
57;; to bind it like that:
f83d2997
KH
58
59;; (define-key global-map [M-S-down-mouse-3] 'imenu)
60
83261a2f
SM
61;;; Font lock bugs as of v4.32:
62
63;; The following kinds of Perl code erroneously start strings:
64;; \$` \$' \$"
65;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
66;; likewise with m, tr, y, q, qX instead of s
67
f83d2997 68;;; Code:
4ab89e7b 69\f
b5b0cb34
JB
70(defvar vc-rcs-header)
71(defvar vc-sccs-header)
72
80585273 73(eval-when-compile
4ab89e7b
SM
74 (condition-case nil
75 (require 'custom)
76 (error nil))
77 (condition-case nil
78 (require 'man)
79 (error nil))
4ab89e7b 80 (defvar cperl-can-font-lock
6546555e 81 (or (featurep 'xemacs)
4ab89e7b
SM
82 (and (boundp 'emacs-major-version)
83 (or window-system
84 (> emacs-major-version 20)))))
85 (if cperl-can-font-lock
86 (require 'font-lock))
87 (defvar msb-menu-cond)
88 (defvar gud-perldb-history)
89 (defvar font-lock-background-mode) ; not in Emacs
90 (defvar font-lock-display-type) ; ditto
91 (defvar paren-backwards-message) ; Not in newer XEmacs?
92 (or (fboundp 'defgroup)
93 (defmacro defgroup (name val doc &rest arr)
94 nil))
95 (or (fboundp 'custom-declare-variable)
96 (defmacro defcustom (name val doc &rest arr)
9edd6ee6 97 `(defvar ,name ,val ,doc)))
4ab89e7b
SM
98 (or (and (fboundp 'custom-declare-variable)
99 (string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
100 (defmacro defface (&rest arr)
101 nil))
102 ;; Avoid warning (tmp definitions)
103 (or (fboundp 'x-color-defined-p)
104 (defmacro x-color-defined-p (col)
9edd6ee6 105 (cond ((fboundp 'color-defined-p) `(color-defined-p ,col))
4ab89e7b 106 ;; XEmacs >= 19.12
9edd6ee6 107 ((fboundp 'valid-color-name-p) `(valid-color-name-p ,col))
4ab89e7b 108 ;; XEmacs 19.11
9edd6ee6 109 ((fboundp 'x-valid-color-name-p) `(x-valid-color-name-p ,col))
4ab89e7b
SM
110 (t '(error "Cannot implement color-defined-p")))))
111 (defmacro cperl-is-face (arg) ; Takes quoted arg
112 (cond ((fboundp 'find-face)
9edd6ee6 113 `(find-face ,arg))
4ab89e7b
SM
114 (;;(and (fboundp 'face-list)
115 ;; (face-list))
116 (fboundp 'face-list)
9edd6ee6
SM
117 `(member ,arg (and (fboundp 'face-list)
118 (face-list))))
4ab89e7b 119 (t
9edd6ee6 120 `(boundp ,arg))))
4ab89e7b
SM
121 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
122 (cond ((fboundp 'make-face)
9edd6ee6 123 `(make-face (quote ,arg)))
4ab89e7b 124 (t
9edd6ee6 125 `(defvar ,arg (quote ,arg) ,descr))))
4ab89e7b 126 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
9edd6ee6
SM
127 `(progn
128 (or (cperl-is-face (quote ,arg))
129 (cperl-make-face ,arg ,descr))
130 (or (boundp (quote ,arg)) ; We use unquoted variants too
131 (defvar ,arg (quote ,arg) ,descr))))
6546555e 132 (if (featurep 'xemacs)
4ab89e7b 133 (defmacro cperl-etags-snarf-tag (file line)
9edd6ee6
SM
134 `(progn
135 (beginning-of-line 2)
136 (list ,file ,line)))
4ab89e7b 137 (defmacro cperl-etags-snarf-tag (file line)
9edd6ee6 138 `(etags-snarf-tag)))
6546555e 139 (if (featurep 'xemacs)
4ab89e7b 140 (defmacro cperl-etags-goto-tag-location (elt)
9edd6ee6
SM
141 ;;(progn
142 ;; (switch-to-buffer (get-file-buffer (elt ,elt 0)))
143 ;; (set-buffer (get-file-buffer (elt ,elt 0)))
144 ;; Probably will not work due to some save-excursion???
145 ;; Or save-file-position?
146 ;; (message "Did I get to line %s?" (elt ,elt 1))
147 `(goto-line (string-to-int (elt ,elt 1))))
4ab89e7b
SM
148 ;;)
149 (defmacro cperl-etags-goto-tag-location (elt)
9edd6ee6 150 `(etags-goto-tag-location ,elt))))
5bd52f0e 151
83261a2f 152(defvar cperl-can-font-lock
6546555e 153 (or (featurep 'xemacs)
83261a2f
SM
154 (and (boundp 'emacs-major-version)
155 (or window-system
156 (> emacs-major-version 20)))))
157
5bd52f0e
RS
158(defun cperl-choose-color (&rest list)
159 (let (answer)
160 (while list
161 (or answer
162 (if (or (x-color-defined-p (car list))
163 (null (cdr list)))
164 (setq answer (car list))))
165 (setq list (cdr list)))
166 answer))
167
ccc3ce39
SE
168(defgroup cperl nil
169 "Major mode for editing Perl code."
170 :prefix "cperl-"
db133cb6
RS
171 :group 'languages
172 :version "20.3")
173
174(defgroup cperl-indentation-details nil
175 "Indentation."
176 :prefix "cperl-"
177 :group 'cperl)
178
179(defgroup cperl-affected-by-hairy nil
180 "Variables affected by `cperl-hairy'."
181 :prefix "cperl-"
182 :group 'cperl)
183
184(defgroup cperl-autoinsert-details nil
185 "Auto-insert tuneup."
186 :prefix "cperl-"
187 :group 'cperl)
188
189(defgroup cperl-faces nil
190 "Fontification colors."
8ec3bce0 191 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
db133cb6
RS
192 :prefix "cperl-"
193 :group 'cperl)
194
195(defgroup cperl-speed nil
196 "Speed vs. validity tuneup."
197 :prefix "cperl-"
198 :group 'cperl)
199
200(defgroup cperl-help-system nil
201 "Help system tuneup."
202 :prefix "cperl-"
203 :group 'cperl)
ccc3ce39 204
f83d2997 205\f
ccc3ce39 206(defcustom cperl-extra-newline-before-brace nil
f83d2997
KH
207 "*Non-nil means that if, elsif, while, until, else, for, foreach
208and do constructs look like:
209
210 if ()
211 {
212 }
213
214instead of:
215
216 if () {
83261a2f 217 }"
ccc3ce39 218 :type 'boolean
db133cb6
RS
219 :group 'cperl-autoinsert-details)
220
5c8b7eaf 221(defcustom cperl-extra-newline-before-brace-multiline
db133cb6
RS
222 cperl-extra-newline-before-brace
223 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
224for constructs with multiline if/unless/while/until/for/foreach condition."
225 :type 'boolean
226 :group 'cperl-autoinsert-details)
ccc3ce39
SE
227
228(defcustom cperl-indent-level 2
229 "*Indentation of CPerl statements with respect to containing block."
230 :type 'integer
db133cb6 231 :group 'cperl-indentation-details)
f152a898 232
2d5590e0 233;; Is is not unusual to put both things like perl-indent-level and
f152a898
DN
234;; cperl-indent-level in the local variable section of a file. If only
235;; one of perl-mode and cperl-mode is in use, a warning will be issued
2d5590e0 236;; about the variable. Autoload these here, so that no warning is
f152a898
DN
237;; issued when using either perl-mode or cperl-mode.
238;;;###autoload(put 'cperl-indent-level 'safe-local-variable 'integerp)
2d5590e0
DN
239;;;###autoload(put 'cperl-brace-offset 'safe-local-variable 'integerp)
240;;;###autoload(put 'cperl-continued-brace-offset 'safe-local-variable 'integerp)
241;;;###autoload(put 'cperl-label-offset 'safe-local-variable 'integerp)
242;;;###autoload(put 'cperl-continued-statement-offset 'safe-local-variable 'integerp)
243;;;###autoload(put 'cperl-extra-newline-before-brace 'safe-local-variable 'booleanp)
244;;;###autoload(put 'cperl-merge-trailing-else 'safe-local-variable 'booleanp)
f83d2997 245
ccc3ce39 246(defcustom cperl-lineup-step nil
f83d2997 247 "*`cperl-lineup' will always lineup at multiple of this number.
029cb4d5 248If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 249 :type '(choice (const nil) integer)
db133cb6
RS
250 :group 'cperl-indentation-details)
251
ccc3ce39 252(defcustom cperl-brace-imaginary-offset 0
f83d2997
KH
253 "*Imagined indentation of a Perl open brace that actually follows a statement.
254An open brace following other text is treated as if it were this far
ccc3ce39
SE
255to the right of the start of its line."
256 :type 'integer
db133cb6 257 :group 'cperl-indentation-details)
ccc3ce39
SE
258
259(defcustom cperl-brace-offset 0
260 "*Extra indentation for braces, compared with other text in same context."
261 :type 'integer
db133cb6 262 :group 'cperl-indentation-details)
ccc3ce39
SE
263(defcustom cperl-label-offset -2
264 "*Offset of CPerl label lines relative to usual indentation."
265 :type 'integer
db133cb6 266 :group 'cperl-indentation-details)
ccc3ce39
SE
267(defcustom cperl-min-label-indent 1
268 "*Minimal offset of CPerl label lines."
269 :type 'integer
db133cb6 270 :group 'cperl-indentation-details)
ccc3ce39
SE
271(defcustom cperl-continued-statement-offset 2
272 "*Extra indent for lines not starting new statements."
273 :type 'integer
db133cb6 274 :group 'cperl-indentation-details)
ccc3ce39 275(defcustom cperl-continued-brace-offset 0
f83d2997 276 "*Extra indent for substatements that start with open-braces.
ccc3ce39
SE
277This is in addition to cperl-continued-statement-offset."
278 :type 'integer
db133cb6 279 :group 'cperl-indentation-details)
ccc3ce39
SE
280(defcustom cperl-close-paren-offset -1
281 "*Extra indent for substatements that start with close-parenthesis."
282 :type 'integer
db133cb6 283 :group 'cperl-indentation-details)
ccc3ce39 284
4ab89e7b
SM
285(defcustom cperl-indent-wrt-brace t
286 "*Non-nil means indent statements in if/etc block relative brace, not if/etc.
287Versions 5.2 ... 5.20 behaved as if this were `nil'."
288 :type 'boolean
289 :group 'cperl-indentation-details)
290
ccc3ce39 291(defcustom cperl-auto-newline nil
f83d2997
KH
292 "*Non-nil means automatically newline before and after braces,
293and after colons and semicolons, inserted in CPerl code. The following
294\\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf 295Insertion after colons requires both this variable and
ccc3ce39
SE
296`cperl-auto-newline-after-colon' set."
297 :type 'boolean
db133cb6 298 :group 'cperl-autoinsert-details)
f83d2997 299
6c389151
SM
300(defcustom cperl-autoindent-on-semi nil
301 "*Non-nil means automatically indent after insertion of (semi)colon.
302Active if `cperl-auto-newline' is false."
303 :type 'boolean
304 :group 'cperl-autoinsert-details)
305
ccc3ce39 306(defcustom cperl-auto-newline-after-colon nil
f83d2997 307 "*Non-nil means automatically newline even after colons.
ccc3ce39
SE
308Subject to `cperl-auto-newline' setting."
309 :type 'boolean
db133cb6 310 :group 'cperl-autoinsert-details)
f83d2997 311
ccc3ce39 312(defcustom cperl-tab-always-indent t
f83d2997 313 "*Non-nil means TAB in CPerl mode should always reindent the current line,
ccc3ce39
SE
314regardless of where in the line point is when the TAB command is used."
315 :type 'boolean
db133cb6 316 :group 'cperl-indentation-details)
f83d2997 317
ccc3ce39 318(defcustom cperl-font-lock nil
029cb4d5 319 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
ccc3ce39 320Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
321 :type '(choice (const null) boolean)
322 :group 'cperl-affected-by-hairy)
f83d2997 323
ccc3ce39 324(defcustom cperl-electric-lbrace-space nil
029cb4d5 325 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
ccc3ce39 326Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
327 :type '(choice (const null) boolean)
328 :group 'cperl-affected-by-hairy)
f83d2997 329
ccc3ce39 330(defcustom cperl-electric-parens-string "({[]})<"
f83d2997 331 "*String of parentheses that should be electric in CPerl.
ccc3ce39
SE
332Closing ones are electric only if the region is highlighted."
333 :type 'string
db133cb6 334 :group 'cperl-affected-by-hairy)
f83d2997 335
ccc3ce39 336(defcustom cperl-electric-parens nil
f83d2997 337 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
ccc3ce39 338Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
339 :type '(choice (const null) boolean)
340 :group 'cperl-affected-by-hairy)
341
342(defvar zmacs-regions) ; Avoid warning
343
5c8b7eaf 344(defcustom cperl-electric-parens-mark
f83d2997
KH
345 (and window-system
346 (or (and (boundp 'transient-mark-mode) ; For Emacs
347 transient-mark-mode)
348 (and (boundp 'zmacs-regions) ; For XEmacs
349 zmacs-regions)))
350 "*Not-nil means that electric parens look for active mark.
ccc3ce39
SE
351Default is yes if there is visual feedback on mark."
352 :type 'boolean
db133cb6 353 :group 'cperl-autoinsert-details)
f83d2997 354
ccc3ce39 355(defcustom cperl-electric-linefeed nil
f83d2997
KH
356 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
357In any case these two mean plain and hairy linefeeds together.
ccc3ce39 358Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
359 :type '(choice (const null) boolean)
360 :group 'cperl-affected-by-hairy)
f83d2997 361
ccc3ce39 362(defcustom cperl-electric-keywords nil
f83d2997 363 "*Not-nil (and non-null) means keywords are electric in CPerl.
350b4cb9
EZ
364Can be overwritten by `cperl-hairy' if nil.
365
366Uses `abbrev-mode' to do the expansion. If you want to use your
367own abbrevs in cperl-mode, but do not want keywords to be
368electric, you must redefine `cperl-mode-abbrev-table': do
369\\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in
370that paragraph, delete the words that appear at the ends of lines and
371that begin with \"cperl-electric\".
372"
db133cb6
RS
373 :type '(choice (const null) boolean)
374 :group 'cperl-affected-by-hairy)
ccc3ce39 375
f739b53b
SM
376(defcustom cperl-electric-backspace-untabify t
377 "*Not-nil means electric-backspace will untabify in CPerl."
378 :type 'boolean
379 :group 'cperl-autoinsert-details)
380
ccc3ce39 381(defcustom cperl-hairy nil
db133cb6 382 "*Not-nil means most of the bells and whistles are enabled in CPerl.
5c8b7eaf 383Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
db133cb6
RS
384`cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
385`cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
386`cperl-lazy-help-time'."
ccc3ce39 387 :type 'boolean
db133cb6 388 :group 'cperl-affected-by-hairy)
ccc3ce39
SE
389
390(defcustom cperl-comment-column 32
391 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
392 :type 'integer
db133cb6 393 :group 'cperl-indentation-details)
ccc3ce39 394
4ab89e7b
SM
395(defcustom cperl-indent-comment-at-column-0 nil
396 "*Non-nil means that comment started at column 0 should be indentable."
397 :type 'boolean
398 :group 'cperl-indentation-details)
e1a5828f
AS
399
400(defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
401 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
402 :type '(repeat string)
403 :group 'cperl)
404
4ab89e7b 405(defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
e1a5828f
AS
406 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
407 :type '(repeat string)
4ab89e7b
SM
408 :group 'cperl)
409
410;; This became obsolete...
411(defvar cperl-vc-header-alist nil)
412(make-obsolete-variable
413 'cperl-vc-header-alist
cb5b40ee
SM
414 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead."
415 "22.1")
ccc3ce39 416
5c8b7eaf 417(defcustom cperl-clobber-mode-lists
5bd52f0e
RS
418 (not
419 (and
420 (boundp 'interpreter-mode-alist)
421 (assoc "miniperl" interpreter-mode-alist)
422 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
423 "*Whether to install us into `interpreter-' and `extension' mode lists."
424 :type 'boolean
425 :group 'cperl)
426
ccc3ce39 427(defcustom cperl-info-on-command-no-prompt nil
f83d2997 428 "*Not-nil (and non-null) means not to prompt on C-h f.
6292d528 429The opposite behavior is always available if prefixed with C-c.
ccc3ce39 430Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
431 :type '(choice (const null) boolean)
432 :group 'cperl-affected-by-hairy)
433
434(defcustom cperl-clobber-lisp-bindings nil
435 "*Not-nil (and non-null) means not overwrite C-h f.
436The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
437Can be overwritten by `cperl-hairy' if nil."
438 :type '(choice (const null) boolean)
439 :group 'cperl-affected-by-hairy)
f83d2997 440
ccc3ce39 441(defcustom cperl-lazy-help-time nil
db133cb6
RS
442 "*Not-nil (and non-null) means to show lazy help after given idle time.
443Can be overwritten by `cperl-hairy' to be 5 sec if nil."
300f7bb3 444 :type '(choice (const null) (const nil) integer)
db133cb6 445 :group 'cperl-affected-by-hairy)
f83d2997 446
ccc3ce39 447(defcustom cperl-pod-face 'font-lock-comment-face
83261a2f 448 "*Face for POD highlighting."
ccc3ce39 449 :type 'face
db133cb6 450 :group 'cperl-faces)
f83d2997 451
ccc3ce39 452(defcustom cperl-pod-head-face 'font-lock-variable-name-face
83261a2f 453 "*Face for POD highlighting.
ccc3ce39
SE
454Font for POD headers."
455 :type 'face
db133cb6 456 :group 'cperl-faces)
f83d2997 457
ccc3ce39 458(defcustom cperl-here-face 'font-lock-string-face
80585273 459 "*Face for here-docs highlighting."
ccc3ce39 460 :type 'face
db133cb6 461 :group 'cperl-faces)
f83d2997 462
4ab89e7b 463;;; Some double-evaluation happened with font-locks... Needed with 21.2...
6546555e 464(defvar cperl-singly-quote-face (featurep 'xemacs))
4ab89e7b 465
224ca9c9
CY
466(defcustom cperl-invalid-face 'underline
467 "*Face for highlighting trailing whitespace."
80585273 468 :type 'face
ac6857fb 469 :version "21.1"
5bd52f0e
RS
470 :group 'cperl-faces)
471
ccc3ce39 472(defcustom cperl-pod-here-fontify '(featurep 'font-lock)
83261a2f 473 "*Not-nil after evaluation means to highlight POD and here-docs sections."
ccc3ce39 474 :type 'boolean
db133cb6 475 :group 'cperl-faces)
f83d2997 476
5bd52f0e
RS
477(defcustom cperl-fontify-m-as-s t
478 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
479 :type 'boolean
480 :group 'cperl-faces)
481
6c389151
SM
482(defcustom cperl-highlight-variables-indiscriminately nil
483 "*Non-nil means perform additional highlighting on variables.
484Currently only changes how scalar variables are highlighted.
485Note that that variable is only read at initialization time for
486the variable `cperl-font-lock-keywords-2', so changing it after you've
f94a632a 487entered CPerl mode the first time will have no effect."
6c389151
SM
488 :type 'boolean
489 :group 'cperl)
490
ccc3ce39 491(defcustom cperl-pod-here-scan t
83261a2f 492 "*Not-nil means look for POD and here-docs sections during startup.
ccc3ce39
SE
493You can always make lookup from menu or using \\[cperl-find-pods-heres]."
494 :type 'boolean
db133cb6 495 :group 'cperl-speed)
f83d2997 496
6c389151
SM
497(defcustom cperl-regexp-scan t
498 "*Not-nil means make marking of regular expression more thorough.
4ab89e7b
SM
499Effective only with `cperl-pod-here-scan'."
500 :type 'boolean
501 :group 'cperl-speed)
502
503(defcustom cperl-hook-after-change t
504 "*Not-nil means install hook to know which regions of buffer are changed.
505May significantly speed up delayed fontification. Changes take effect
506after reload."
6c389151
SM
507 :type 'boolean
508 :group 'cperl-speed)
509
ccc3ce39 510(defcustom cperl-imenu-addback nil
f83d2997 511 "*Not-nil means add backreferences to generated `imenu's.
db133cb6 512May require patched `imenu' and `imenu-go'. Obsolete."
ccc3ce39 513 :type 'boolean
db133cb6 514 :group 'cperl-help-system)
f83d2997 515
ccc3ce39
SE
516(defcustom cperl-max-help-size 66
517 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
518 :type '(choice integer (const nil))
db133cb6 519 :group 'cperl-help-system)
f83d2997 520
ccc3ce39
SE
521(defcustom cperl-shrink-wrap-info-frame t
522 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
523 :type 'boolean
db133cb6 524 :group 'cperl-help-system)
f83d2997 525
ccc3ce39 526(defcustom cperl-info-page "perl"
f83d2997 527 "*Name of the info page containing perl docs.
ccc3ce39
SE
528Older version of this page was called `perl5', newer `perl'."
529 :type 'string
db133cb6 530 :group 'cperl-help-system)
f83d2997 531
5c8b7eaf 532(defcustom cperl-use-syntax-table-text-property
f83d2997 533 (boundp 'parse-sexp-lookup-properties)
ccc3ce39
SE
534 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
535 :type 'boolean
db133cb6 536 :group 'cperl-speed)
f83d2997 537
5c8b7eaf 538(defcustom cperl-use-syntax-table-text-property-for-tags
f83d2997 539 cperl-use-syntax-table-text-property
ccc3ce39
SE
540 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
541 :type 'boolean
db133cb6 542 :group 'cperl-speed)
ccc3ce39
SE
543
544(defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
545 "*Regexp to match files to scan when generating TAGS."
546 :type 'regexp
547 :group 'cperl)
548
8937f01b
RS
549(defcustom cperl-noscan-files-regexp
550 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
ccc3ce39
SE
551 "*Regexp to match files/dirs to skip when generating TAGS."
552 :type 'regexp
553 :group 'cperl)
554
555(defcustom cperl-regexp-indent-step nil
556 "*Indentation used when beautifying regexps.
029cb4d5 557If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 558 :type '(choice integer (const nil))
db133cb6 559 :group 'cperl-indentation-details)
ccc3ce39
SE
560
561(defcustom cperl-indent-left-aligned-comments t
562 "*Non-nil means that the comment starting in leftmost column should indent."
563 :type 'boolean
db133cb6 564 :group 'cperl-indentation-details)
ccc3ce39 565
8f222248 566(defcustom cperl-under-as-char nil
ccc3ce39
SE
567 "*Non-nil means that the _ (underline) should be treated as word char."
568 :type 'boolean
569 :group 'cperl)
f83d2997 570
db133cb6
RS
571(defcustom cperl-extra-perl-args ""
572 "*Extra arguments to use when starting Perl.
573Currently used with `cperl-check-syntax' only."
574 :type 'string
575 :group 'cperl)
576
577(defcustom cperl-message-electric-keyword t
578 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
579 :type 'boolean
580 :group 'cperl-help-system)
581
582(defcustom cperl-indent-region-fix-constructs 1
583 "*Amount of space to insert between `}' and `else' or `elsif'
584in `cperl-indent-region'. Set to nil to leave as is. Values other
585than 1 and nil will probably not work."
586 :type '(choice (const nil) (const 1))
587 :group 'cperl-indentation-details)
588
589(defcustom cperl-break-one-line-blocks-when-indent t
590 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
2022c546 591need to be reformatted into multiline ones when indenting a region."
db133cb6
RS
592 :type 'boolean
593 :group 'cperl-indentation-details)
594
595(defcustom cperl-fix-hanging-brace-when-indent t
596 "*Non-nil means that BLOCK-end `}' may be put on a separate line
5c8b7eaf 597when indenting a region.
db133cb6
RS
598Braces followed by else/elsif/while/until are excepted."
599 :type 'boolean
600 :group 'cperl-indentation-details)
601
602(defcustom cperl-merge-trailing-else t
5c8b7eaf 603 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
db133cb6
RS
604may be merged to be on the same line when indenting a region."
605 :type 'boolean
606 :group 'cperl-indentation-details)
607
6c389151
SM
608(defcustom cperl-indent-parens-as-block nil
609 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
610but for trailing \",\" inside the group, which won't increase indentation.
611One should tune up `cperl-close-paren-offset' as well."
612 :type 'boolean
613 :group 'cperl-indentation-details)
614
a1506d29 615(defcustom cperl-syntaxify-by-font-lock
83261a2f 616 (and cperl-can-font-lock
5bd52f0e 617 (boundp 'parse-sexp-lookup-properties))
6c389151 618 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
5bd52f0e
RS
619 :type '(choice (const message) boolean)
620 :group 'cperl-speed)
621
622(defcustom cperl-syntaxify-unwind
623 t
f94a632a 624 "*Non-nil means that CPerl unwinds to a start of a long construction
5bd52f0e 625when syntaxifying a chunk of buffer."
db133cb6
RS
626 :type 'boolean
627 :group 'cperl-speed)
628
4ab89e7b
SM
629(defcustom cperl-syntaxify-for-menu
630 t
631 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
632This way enabling/disabling of menu items is more correct."
633 :type 'boolean
634 :group 'cperl-speed)
635
5bd52f0e
RS
636(defcustom cperl-ps-print-face-properties
637 '((font-lock-keyword-face nil nil bold shadow)
638 (font-lock-variable-name-face nil nil bold)
639 (font-lock-function-name-face nil nil bold italic box)
640 (font-lock-constant-face nil "LightGray" bold)
4ab89e7b 641 (cperl-array-face nil "LightGray" bold underline)
8c777c8d 642 (cperl-hash-face nil "LightGray" bold italic underline)
5bd52f0e
RS
643 (font-lock-comment-face nil "LightGray" italic)
644 (font-lock-string-face nil nil italic underline)
4ab89e7b 645 (cperl-nonoverridable-face nil nil italic underline)
5bd52f0e 646 (font-lock-type-face nil nil underline)
4ab89e7b 647 (font-lock-warning-face nil "LightGray" bold italic box)
5bd52f0e
RS
648 (underline nil "LightGray" strikeout))
649 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
5c8b7eaf 650 :type '(repeat (cons symbol
5bd52f0e
RS
651 (cons (choice (const nil) string)
652 (cons (choice (const nil) string)
653 (repeat symbol)))))
654 :group 'cperl-faces)
655
5cc679ab
JB
656(defvar cperl-dark-background
657 (cperl-choose-color "navy" "os2blue" "darkgreen"))
658(defvar cperl-dark-foreground
659 (cperl-choose-color "orchid1" "orange"))
660
4ab89e7b 661(defface cperl-nonoverridable-face
5cc679ab
JB
662 `((((class grayscale) (background light))
663 (:background "Gray90" :slant italic :underline t))
664 (((class grayscale) (background dark))
665 (:foreground "Gray80" :slant italic :underline t :weight bold))
666 (((class color) (background light))
667 (:foreground "chartreuse3"))
668 (((class color) (background dark))
669 (:foreground ,cperl-dark-foreground))
670 (t (:weight bold :underline t)))
c73fce9a 671 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
5cc679ab
JB
672 :group 'cperl-faces)
673
4ab89e7b 674(defface cperl-array-face
5cc679ab
JB
675 `((((class grayscale) (background light))
676 (:background "Gray90" :weight bold))
677 (((class grayscale) (background dark))
678 (:foreground "Gray80" :weight bold))
679 (((class color) (background light))
680 (:foreground "Blue" :background "lightyellow2" :weight bold))
681 (((class color) (background dark))
682 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
683 (t (:weight bold)))
684 "Font Lock mode face used to highlight array names."
685 :group 'cperl-faces)
686
4ab89e7b 687(defface cperl-hash-face
5cc679ab
JB
688 `((((class grayscale) (background light))
689 (:background "Gray90" :weight bold :slant italic))
690 (((class grayscale) (background dark))
691 (:foreground "Gray80" :weight bold :slant italic))
692 (((class color) (background light))
693 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
694 (((class color) (background dark))
695 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
696 (t (:weight bold :slant italic)))
697 "Font Lock mode face used to highlight hash names."
698 :group 'cperl-faces)
5bd52f0e 699
f83d2997
KH
700\f
701
702;;; Short extra-docs.
703
704(defvar cperl-tips 'please-ignore-this-line
83261a2f 705 "Get maybe newer version of this package from
4ab89e7b 706 http://ilyaz.org/software/emacs
db133cb6
RS
707Subdirectory `cperl-mode' may contain yet newer development releases and/or
708patches to related files.
f83d2997 709
5bd52f0e
RS
710For best results apply to an older Emacs the patches from
711 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
83261a2f 712\(this upgrades syntax-parsing abilities of Emacsen v19.34 and
8e3acc66 713v20.2 up to the level of Emacs v20.3 - a must for a good Perl
83261a2f 714mode.) As of beginning of 2003, XEmacs may provide a similar ability.
5bd52f0e 715
f83d2997
KH
716Get support packages choose-color.el (or font-lock-extra.el before
71719.30), imenu-go.el from the same place. \(Look for other files there
718too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
5c8b7eaf 719later you should use choose-color.el *instead* of font-lock-extra.el
f83d2997
KH
720\(and you will not get smart highlighting in C :-().
721
722Note that to enable Compile choices in the menu you need to install
723mode-compile.el.
724
5efe6a56
SM
725If your Emacs does not default to `cperl-mode' on Perl files, and you
726want it to: put the following into your .emacs file:
727
728 (defalias 'perl-mode 'cperl-mode)
729
a1506d29 730Get perl5-info from
4ab89e7b
SM
731 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
732Also, one can generate a newer documentation running `pod2texi' converter
733 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
f83d2997
KH
734
735If you use imenu-go, run imenu on perl5-info buffer (you can do it
5bd52f0e
RS
736from Perl menu). If many files are related, generate TAGS files from
737Tools/Tags submenu in Perl menu.
f83d2997
KH
738
739If some class structure is too complicated, use Tools/Hierarchy-view
029cb4d5 740from Perl menu, or hierarchic view of imenu. The second one uses the
f83d2997 741current buffer only, the first one requires generation of TAGS from
5bd52f0e
RS
742Perl/Tools/Tags menu beforehand.
743
744Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
745
746Switch auto-help on/off with Perl/Tools/Auto-help.
747
748Though with contemporary Emaxen CPerl mode should maintain the correct
749parsing of Perl even when editing, sometimes it may be lost. Fix this by
750
029cb4d5 751 \\[normal-mode]
f83d2997 752
5bd52f0e 753In cases of more severe confusion sometimes it is helpful to do
f83d2997 754
029cb4d5
SM
755 \\[load-library] cperl-mode RET
756 \\[normal-mode]
f83d2997 757
5bd52f0e
RS
758Before reporting (non-)problems look in the problem section of online
759micro-docs on what I know about CPerl problems.")
f83d2997
KH
760
761(defvar cperl-problems 'please-ignore-this-line
f94a632a
RS
762 "Description of problems in CPerl mode.
763Some faces will not be shown on some versions of Emacs unless you
bab27c0c 764install choose-color.el, available from
4ab89e7b 765 http://ilyaz.org/software/emacs
bab27c0c 766
6c389151 767`fill-paragraph' on a comment may leave the point behind the
4ab89e7b
SM
768paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
769to detect it and bulk out).
770
771See documentation of a variable `cperl-problems-old-emaxen' for the
772problems which disappear if you upgrade Emacs to a reasonably new
773version (20.3 for Emacs, and those of 2004 for XEmacs).")
774
775(defvar cperl-problems-old-emaxen 'please-ignore-this-line
776 "Description of problems in CPerl mode specific for older Emacs versions.
6c389151 777
8e3acc66 778Emacs had a _very_ restricted syntax parsing engine until version
5bd52f0e 77920.1. Most problems below are corrected starting from this version of
8e3acc66 780Emacs, and all of them should be fixed in version 20.3. (Or apply
83261a2f
SM
781patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
782this respect (until 2003).
5bd52f0e 783
6c389151
SM
784Note that even with newer Emacsen in some very rare cases the details
785of interaction of `font-lock' and syntaxification may be not cleaned
786up yet. You may get slightly different colors basing on the order of
787fontification and syntaxification. Say, the initial faces is correct,
788but editing the buffer breaks this.
f83d2997 789
db133cb6
RS
790Even with older Emacsen CPerl mode tries to corrects some Emacs
791misunderstandings, however, for efficiency reasons the degree of
792correction is different for different operations. The partially
793corrected problems are: POD sections, here-documents, regexps. The
794operations are: highlighting, indentation, electric keywords, electric
795braces.
f83d2997
KH
796
797This may be confusing, since the regexp s#//#/#\; may be highlighted
798as a comment, but it will be recognized as a regexp by the indentation
83261a2f 799code. Or the opposite case, when a POD section is highlighted, but
f83d2997
KH
800may break the indentation of the following code (though indentation
801should work if the balance of delimiters is not broken by POD).
802
803The main trick (to make $ a \"backslash\") makes constructions like
804${aaa} look like unbalanced braces. The only trick I can think of is
2e8b9c7d 805to insert it as $ {aaa} (valid in perl5, not in perl4).
f83d2997
KH
806
807Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
db133cb6
RS
808as /($|\\s)/. Note that such a transposition is not always possible.
809
5bd52f0e 810The solution is to upgrade your Emacs or patch an older one. Note
8e3acc66 811that Emacs 20.2 has some bugs related to `syntax-table' text
5bd52f0e
RS
812properties. Patches are available on the main CPerl download site,
813and on CPAN.
db133cb6
RS
814
815If these bugs cannot be fixed on your machine (say, you have an inferior
816environment and cannot recompile), you may still disable all the fancy stuff
83261a2f 817via `cperl-use-syntax-table-text-property'.")
f83d2997 818
f83d2997 819(defvar cperl-praise 'please-ignore-this-line
8e3acc66 820 "Advantages of CPerl mode.
f83d2997
KH
821
8220) It uses the newest `syntax-table' property ;-);
823
8241) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
5c8b7eaf 825mode - but the latter number may have improved too in last years) even
5bd52f0e
RS
826with old Emaxen which do not support `syntax-table' property.
827
828When using `syntax-table' property for syntax assist hints, it should
829handle 99.995% of lines correct - or somesuch. It automatically
830updates syntax assist hints when you edit your script.
f83d2997 831
bab27c0c 8322) It is generally believed to be \"the most user-friendly Emacs
f83d2997
KH
833package\" whatever it may mean (I doubt that the people who say similar
834things tried _all_ the rest of Emacs ;-), but this was not a lonely
835voice);
836
8373) Everything is customizable, one-by-one or in a big sweep;
838
549c0a96 8394) It has many easily-accessible \"tools\":
f83d2997
KH
840 a) Can run program, check syntax, start debugger;
841 b) Can lineup vertically \"middles\" of rows, like `=' in
842 a = b;
843 cc = d;
844 c) Can insert spaces where this impoves readability (in one
845 interactive sweep over the buffer);
846 d) Has support for imenu, including:
847 1) Separate unordered list of \"interesting places\";
848 2) Separate TOC of POD sections;
849 3) Separate list of packages;
850 4) Hierarchical view of methods in (sub)packages;
851 5) and functions (by the full name - with package);
852 e) Has an interface to INFO docs for Perl; The interface is
853 very flexible, including shrink-wrapping of
854 documentation buffer/frame;
855 f) Has a builtin list of one-line explanations for perl constructs.
856 g) Can show these explanations if you stay long enough at the
857 corresponding place (or on demand);
858 h) Has an enhanced fontification (using 3 or 4 additional faces
859 comparing to font-lock - basically, different
860 namespaces in Perl have different colors);
861 i) Can construct TAGS basing on its knowledge of Perl syntax,
862 the standard menu has 6 different way to generate
db133cb6 863 TAGS (if \"by directory\", .xs files - with C-language
f83d2997
KH
864 bindings - are included in the scan);
865 j) Can build a hierarchical view of classes (via imenu) basing
866 on generated TAGS file;
867 k) Has electric parentheses, electric newlines, uses Abbrev
868 for electric logical constructs
869 while () {}
870 with different styles of expansion (context sensitive
871 to be not so bothering). Electric parentheses behave
872 \"as they should\" in a presence of a visible region.
873 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
db133cb6
RS
874 m) Can convert from
875 if (A) { B }
876 to
877 B if A;
f83d2997 878
5bd52f0e 879 n) Highlights (by user-choice) either 3-delimiters constructs
6c389151
SM
880 (such as tr/a/b/), or regular expressions and `y/tr';
881 o) Highlights trailing whitespace;
882 p) Is able to manipulate Perl Regular Expressions to ease
883 conversion to a more readable form.
4ab89e7b
SM
884 q) Can ispell POD sections and HERE-DOCs.
885 r) Understands comments and character classes inside regular
886 expressions; can find matching () and [] in a regular expression.
887 s) Allows indentation of //x-style regular expressions;
888 t) Highlights different symbols in regular expressions according
889 to their function; much less problems with backslashitis;
890 u) Allows to find regular expressions which contain interpolated parts.
5bd52f0e 891
f83d2997
KH
8925) The indentation engine was very smart, but most of tricks may be
893not needed anymore with the support for `syntax-table' property. Has
894progress indicator for indentation (with `imenu' loaded).
895
5c8b7eaf 8966) Indent-region improves inline-comments as well; also corrects
db133cb6 897whitespace *inside* the conditional/loop constructs.
f83d2997
KH
898
8997) Fill-paragraph correctly handles multi-line comments;
db133cb6
RS
900
9018) Can switch to different indentation styles by one command, and restore
902the settings present before the switch.
903
5c8b7eaf 9049) When doing indentation of control constructs, may correct
db133cb6 905line-breaks/spacing between elements of the construct.
029cb4d5
SM
906
90710) Uses a linear-time algorith for indentation of regions (on Emaxen with
4ab89e7b
SM
908capable syntax engines).
909
91011) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
911")
db133cb6
RS
912
913(defvar cperl-speed 'please-ignore-this-line
914 "This is an incomplete compendium of what is available in other parts
915of CPerl documentation. (Please inform me if I skept anything.)
916
917There is a perception that CPerl is slower than alternatives. This part
918of documentation is designed to overcome this misconception.
919
920*By default* CPerl tries to enable the most comfortable settings.
921From most points of view, correctly working package is infinitely more
922comfortable than a non-correctly working one, thus by default CPerl
923prefers correctness over speed. Below is the guide how to change
924settings if your preferences are different.
925
926A) Speed of loading the file. When loading file, CPerl may perform a
927scan which indicates places which cannot be parsed by primitive Emacs
928syntax-parsing routines, and marks them up so that either
929
930 A1) CPerl may work around these deficiencies (for big chunks, mostly
931 PODs and HERE-documents), or
932 A2) On capable Emaxen CPerl will use improved syntax-handlings
933 which reads mark-up hints directly.
934
935 The scan in case A2 is much more comprehensive, thus may be slower.
936
937 User can disable syntax-engine-helping scan of A2 by setting
938 `cperl-use-syntax-table-text-property'
939 variable to nil (if it is set to t).
940
941 One can disable the scan altogether (both A1 and A2) by setting
942 `cperl-pod-here-scan'
943 to nil.
944
5c8b7eaf 945B) Speed of editing operations.
db133cb6
RS
946
947 One can add a (minor) speedup to editing operations by setting
948 `cperl-use-syntax-table-text-property'
949 variable to nil (if it is set to t). This will disable
950 syntax-engine-helping scan, thus will make many more Perl
951 constructs be wrongly recognized by CPerl, thus may lead to
952 wrongly matched parentheses, wrong indentation, etc.
5bd52f0e
RS
953
954 One can unset `cperl-syntaxify-unwind'. This might speed up editing
83261a2f 955 of, say, long POD sections.")
f83d2997 956
5bd52f0e
RS
957(defvar cperl-tips-faces 'please-ignore-this-line
958 "CPerl mode uses following faces for highlighting:
959
4ab89e7b
SM
960 `cperl-array-face' Array names
961 `cperl-hash-face' Hash names
8661c643 962 `font-lock-comment-face' Comments, PODs and whatever is considered
5bd52f0e 963 syntaxically to be not code
8661c643 964 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
5bd52f0e 965 2-arg operators s/y/tr/ or of RExen,
4ab89e7b
SM
966 `font-lock-warning-face' Special-cased m// and s//foo/,
967 `font-lock-function-name-face' _ as a target of a file tests, file tests,
5bd52f0e
RS
968 subroutine names at the moment of definition
969 (except those conflicting with Perl operators),
970 package names (when recognized), format names
8661c643 971 `font-lock-keyword-face' Control flow switch constructs, declarators
4ab89e7b 972 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
8661c643 973 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
5bd52f0e
RS
974 literal parts and the terminator of formats
975 and whatever is syntaxically considered
976 as string literals
8661c643
DL
977 `font-lock-type-face' Overridable keywords
978 `font-lock-variable-name-face' Variable declarations, indirect array and
5bd52f0e 979 hash names, POD headers/item names
8c777c8d 980 `cperl-invalid-face' Trailing whitespace
5bd52f0e
RS
981
982Note that in several situations the highlighting tries to inform about
983possible confusion, such as different colors for function names in
984declarations depending on what they (do not) override, or special cases
985m// and s/// which do not do what one would expect them to do.
986
5c8b7eaf 987Help with best setup of these faces for printout requested (for each of
5bd52f0e
RS
988the faces: please specify bold, italic, underline, shadow and box.)
989
8c777c8d 990In regular expressions (including character classes):
4ab89e7b
SM
991 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
992 `font-lock-constant-face': Delimiters
993 `font-lock-warning-face' Special-cased m// and s//foo/,
994 Mismatched closing delimiters, parens
995 we couldn't match, misplaced quantifiers,
996 unrecognized escape sequences
997 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
8c777c8d 998 `font-lock-type-face' escape sequences with arguments (\\x \\23 \\p \\N)
4ab89e7b
SM
999 and others match-a-char escape sequences
1000 `font-lock-keyword-face' Capturing parens, and |
1001 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
8c777c8d
CY
1002 \"Range -\" in character classes
1003 `font-lock-builtin-face' \"Remaining\" 0-length constructs, multipliers
1004 ?+*{}, not-capturing parens, leading
1005 backslashes of escape sequences
1006 `font-lock-variable-name-face' Interpolated constructs, embedded code,
1007 POSIX classes (inside charclasses)
4ab89e7b
SM
1008 `font-lock-comment-face' Embedded comments
1009
1010")
5bd52f0e 1011
f83d2997
KH
1012\f
1013
1014;;; Portability stuff:
1015
1016(defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
b787fc05
GM
1017 `(define-key cperl-mode-map
1018 ,(if xemacs-key
6546555e 1019 `(if (featurep 'xemacs) ,xemacs-key ,emacs-key)
b787fc05
GM
1020 emacs-key)
1021 ,definition))
f83d2997
KH
1022
1023(defvar cperl-del-back-ch
1024 (car (append (where-is-internal 'delete-backward-char)
1025 (where-is-internal 'backward-delete-char-untabify)))
029cb4d5 1026 "Character generated by key bound to `delete-backward-char'.")
f83d2997 1027
5c8b7eaf 1028(and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
f83d2997
KH
1029 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
1030
db133cb6 1031(defun cperl-mark-active () (mark)) ; Avoid undefined warning
6546555e 1032(if (featurep 'xemacs)
f83d2997
KH
1033 (progn
1034 ;; "Active regions" are on: use region only if active
1035 ;; "Active regions" are off: use region unconditionally
1036 (defun cperl-use-region-p ()
db133cb6 1037 (if zmacs-regions (mark) t)))
f83d2997
KH
1038 (defun cperl-use-region-p ()
1039 (if transient-mark-mode mark-active t))
1040 (defun cperl-mark-active () mark-active))
1041
1042(defsubst cperl-enable-font-lock ()
83261a2f 1043 cperl-can-font-lock)
f83d2997 1044
83261a2f 1045(defun cperl-putback-char (c) ; Emacs 19
db133cb6
RS
1046 (set 'unread-command-events (list c))) ; Avoid undefined warning
1047
6546555e 1048(if (featurep 'xemacs)
0ce7de92
RS
1049 (defun cperl-putback-char (c) ; XEmacs >= 19.12
1050 (setq unread-command-events (list (eval '(character-to-event c))))))
f83d2997
KH
1051
1052(or (fboundp 'uncomment-region)
1053 (defun uncomment-region (beg end)
1054 (interactive "r")
1055 (comment-region beg end -1)))
1056
1057(defvar cperl-do-not-fontify
1058 (if (string< emacs-version "19.30")
1059 'fontified
1060 'lazy-lock)
1061 "Text property which inhibits refontification.")
1062
5bd52f0e
RS
1063(defsubst cperl-put-do-not-fontify (from to &optional post)
1064 ;; If POST, do not do it with postponed fontification
1065 (if (and post cperl-syntaxify-by-font-lock)
1066 nil
8c777c8d 1067 (put-text-property (max (point-min) (1- from))
5bd52f0e 1068 to cperl-do-not-fontify t)))
f83d2997 1069
ccc3ce39 1070(defcustom cperl-mode-hook nil
f94a632a 1071 "Hook run by CPerl mode."
ccc3ce39
SE
1072 :type 'hook
1073 :group 'cperl)
f83d2997 1074
db133cb6
RS
1075(defvar cperl-syntax-state nil)
1076(defvar cperl-syntax-done-to nil)
5bd52f0e 1077(defvar cperl-emacs-can-parse (> (length (save-excursion
ce22dd53 1078 (parse-partial-sexp (point) (point)))) 9))
db133cb6
RS
1079\f
1080;; Make customization possible "in reverse"
1081(defsubst cperl-val (symbol &optional default hairy)
1082 (cond
1083 ((eq (symbol-value symbol) 'null) default)
1084 (cperl-hairy (or hairy t))
1085 (t (symbol-value symbol))))
f83d2997 1086\f
4ab89e7b
SM
1087
1088(defun cperl-make-indent (column &optional minimum keep)
1089 "Makes indent of the current line the requested amount.
1090Unless KEEP, removes the old indentation. Works around a bug in ancient
1091versions of Emacs."
1092 (let ((prop (get-text-property (point) 'syntax-type)))
1093 (or keep
1094 (delete-horizontal-space))
1095 (indent-to column minimum)
1096 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1097 (and prop
1098 (> (current-column) 0)
1099 (save-excursion
1100 (beginning-of-line)
1101 (or (get-text-property (point) 'syntax-type)
1102 (and (looking-at "\\=[ \t]")
1103 (put-text-property (point) (match-end 0)
1104 'syntax-type prop)))))))
1105
f83d2997
KH
1106;;; Probably it is too late to set these guys already, but it can help later:
1107
5bd52f0e 1108;;;(and cperl-clobber-mode-lists
f83d2997
KH
1109;;;(setq auto-mode-alist
1110;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1111;;;(and (boundp 'interpreter-mode-alist)
1112;;; (setq interpreter-mode-alist (append interpreter-mode-alist
5bd52f0e 1113;;; '(("miniperl" . perl-mode))))))
80585273 1114(eval-when-compile
dba01120
GM
1115 (mapc (lambda (p)
1116 (condition-case nil
1117 (require p)
1118 (error nil)))
1119 '(imenu easymenu etags timer man info))
80585273
DL
1120 (if (fboundp 'ps-extend-face-list)
1121 (defmacro cperl-ps-extend-face-list (arg)
1122 `(ps-extend-face-list ,arg))
1123 (defmacro cperl-ps-extend-face-list (arg)
e8af40ee 1124 `(error "This version of Emacs has no `ps-extend-face-list'")))
80585273
DL
1125 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1126 ;; macros instead of defsubsts don't work on Emacs, so we do the
1127 ;; expansion manually. Any other suggestions?
1128 (require 'cl))
f83d2997
KH
1129
1130(defvar cperl-mode-abbrev-table nil
f94a632a 1131 "Abbrev table in use in CPerl mode buffers.")
f83d2997
KH
1132
1133(add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1134
1135(defvar cperl-mode-map () "Keymap used in CPerl mode.")
1136
1137(if cperl-mode-map nil
1138 (setq cperl-mode-map (make-sparse-keymap))
1139 (cperl-define-key "{" 'cperl-electric-lbrace)
1140 (cperl-define-key "[" 'cperl-electric-paren)
1141 (cperl-define-key "(" 'cperl-electric-paren)
1142 (cperl-define-key "<" 'cperl-electric-paren)
1143 (cperl-define-key "}" 'cperl-electric-brace)
1144 (cperl-define-key "]" 'cperl-electric-rparen)
1145 (cperl-define-key ")" 'cperl-electric-rparen)
1146 (cperl-define-key ";" 'cperl-electric-semi)
1147 (cperl-define-key ":" 'cperl-electric-terminator)
1148 (cperl-define-key "\C-j" 'newline-and-indent)
1149 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
db133cb6 1150 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
f83d2997
KH
1151 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1152 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
db133cb6
RS
1153 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1154 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
f83d2997 1155 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
4ab89e7b
SM
1156 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
1157 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
1158 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
1159 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
1160 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx)
1161 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0)
1162 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1)
db133cb6 1163 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
4ab89e7b
SM
1164 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
1165 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
f83d2997
KH
1166 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1167 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1168 [(control meta |)])
1169 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1170 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1171 (cperl-define-key "\177" 'cperl-electric-backspace)
1172 (cperl-define-key "\t" 'cperl-indent-command)
1173 ;; don't clobber the backspace binding:
db133cb6
RS
1174 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1175 [(control c) (control h) F])
db133cb6
RS
1176 (if (cperl-val 'cperl-clobber-lisp-bindings)
1177 (progn
1178 (cperl-define-key "\C-hf"
1179 ;;(concat (char-to-string help-char) "f") ; does not work
1180 'cperl-info-on-command
1181 [(control h) f])
1182 (cperl-define-key "\C-hv"
1183 ;;(concat (char-to-string help-char) "v") ; does not work
1184 'cperl-get-help
5bd52f0e
RS
1185 [(control h) v])
1186 (cperl-define-key "\C-c\C-hf"
1187 ;;(concat (char-to-string help-char) "f") ; does not work
1188 (key-binding "\C-hf")
1189 [(control c) (control h) f])
1190 (cperl-define-key "\C-c\C-hv"
1191 ;;(concat (char-to-string help-char) "v") ; does not work
1192 (key-binding "\C-hv")
1193 [(control c) (control h) v]))
1194 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1195 [(control c) (control h) f])
1196 (cperl-define-key "\C-c\C-hv"
1197 ;;(concat (char-to-string help-char) "v") ; does not work
1198 'cperl-get-help
1199 [(control c) (control h) v]))
6546555e 1200 (if (and (featurep 'xemacs)
f83d2997
KH
1201 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1202 (progn
1203 ;; substitute-key-definition is usefulness-deenhanced...
4ab89e7b 1204 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
f83d2997
KH
1205 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1206 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
4ab89e7b
SM
1207 (or (boundp 'fill-paragraph-function)
1208 (substitute-key-definition
1209 'fill-paragraph 'cperl-fill-paragraph
1210 cperl-mode-map global-map))
f83d2997
KH
1211 (substitute-key-definition
1212 'indent-sexp 'cperl-indent-exp
1213 cperl-mode-map global-map)
f83d2997
KH
1214 (substitute-key-definition
1215 'indent-region 'cperl-indent-region
1216 cperl-mode-map global-map)
1217 (substitute-key-definition
1218 'indent-for-comment 'cperl-indent-for-comment
1219 cperl-mode-map global-map)))
1220
1221(defvar cperl-menu)
db133cb6
RS
1222(defvar cperl-lazy-installed)
1223(defvar cperl-old-style nil)
f83d2997
KH
1224(condition-case nil
1225 (progn
1226 (require 'easymenu)
83261a2f 1227 (easy-menu-define
4ab89e7b
SM
1228 cperl-menu cperl-mode-map "Menu for CPerl mode"
1229 '("Perl"
1230 ["Beginning of function" beginning-of-defun t]
1231 ["End of function" end-of-defun t]
1232 ["Mark function" mark-defun t]
1233 ["Indent expression" cperl-indent-exp t]
82eb0dae 1234 ["Fill paragraph/comment" fill-paragraph t]
4ab89e7b
SM
1235 "----"
1236 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1237 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1238 ("Regexp"
1239 ["Beautify" cperl-beautify-regexp
1240 cperl-use-syntax-table-text-property]
1241 ["Beautify one level deep" (cperl-beautify-regexp 1)
1242 cperl-use-syntax-table-text-property]
1243 ["Beautify a group" cperl-beautify-level
1244 cperl-use-syntax-table-text-property]
1245 ["Beautify a group one level deep" (cperl-beautify-level 1)
1246 cperl-use-syntax-table-text-property]
1247 ["Contract a group" cperl-contract-level
1248 cperl-use-syntax-table-text-property]
1249 ["Contract groups" cperl-contract-levels
1250 cperl-use-syntax-table-text-property]
83261a2f 1251 "----"
cb5bf6ba 1252 ["Find next interpolated" cperl-next-interpolated-REx
4ab89e7b
SM
1253 (next-single-property-change (point-min) 'REx-interpolated)]
1254 ["Find next interpolated (no //o)"
1255 cperl-next-interpolated-REx-0
1256 (or (text-property-any (point-min) (point-max) 'REx-interpolated t)
1257 (text-property-any (point-min) (point-max) 'REx-interpolated 1))]
1258 ["Find next interpolated (neither //o nor whole-REx)"
1259 cperl-next-interpolated-REx-1
1260 (text-property-any (point-min) (point-max) 'REx-interpolated t)])
1261 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
1262 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1263 "----"
1264 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1265 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1266 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1267 "----"
1268 ["Run" mode-compile (fboundp 'mode-compile)]
1269 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1270 (get-buffer "*compilation*"))]
1271 ["Next error" next-error (get-buffer "*compilation*")]
1272 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1273 "----"
1274 ["Debugger" cperl-db t]
1275 "----"
1276 ("Tools"
1277 ["Imenu" imenu (fboundp 'imenu)]
1278 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
83261a2f 1279 "----"
4ab89e7b
SM
1280 ["Ispell PODs" cperl-pod-spell
1281 ;; Better not to update syntaxification here:
1282 ;; debugging syntaxificatio can be broken by this???
1283 (or
1284 (get-text-property (point-min) 'in-pod)
1285 (< (progn
1286 (and cperl-syntaxify-for-menu
1287 (cperl-update-syntaxification (point-max) (point-max)))
1288 (next-single-property-change (point-min) 'in-pod nil (point-max)))
1289 (point-max)))]
1290 ["Ispell HERE-DOCs" cperl-here-doc-spell
1291 (< (progn
1292 (and cperl-syntaxify-for-menu
1293 (cperl-update-syntaxification (point-max) (point-max)))
1294 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
1295 (point-max))]
1296 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
1297 (eq 'here-doc (progn
1298 (and cperl-syntaxify-for-menu
1299 (cperl-update-syntaxification (point) (point)))
1300 (get-text-property (point) 'syntax-type)))]
1301 ["Select this HERE-DOC or POD section"
1302 cperl-select-this-pod-or-here-doc
1303 (memq (progn
1304 (and cperl-syntaxify-for-menu
1305 (cperl-update-syntaxification (point) (point)))
1306 (get-text-property (point) 'syntax-type))
1307 '(here-doc pod))]
83261a2f 1308 "----"
4ab89e7b
SM
1309 ["CPerl pretty print (exprmntl)" cperl-ps-print
1310 (fboundp 'ps-extend-face-list)]
83261a2f 1311 "----"
4ab89e7b
SM
1312 ["Syntaxify region" cperl-find-pods-heres-region
1313 (cperl-use-region-p)]
1314 ["Profile syntaxification" cperl-time-fontification t]
1315 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
1316 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
1317 ["Debug backtrace on syntactic scan (BEWARE!!!)"
1318 (cperl-toggle-set-debug-unwind nil t) t]
83261a2f 1319 "----"
4ab89e7b
SM
1320 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1321 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1322 ("Tags"
f83d2997
KH
1323;;; ["Create tags for current file" cperl-etags t]
1324;;; ["Add tags for current file" (cperl-etags t) t]
1325;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1326;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
5c8b7eaf 1327;;; ["Create tags for Perl files in (sub)directories"
f83d2997
KH
1328;;; (cperl-etags nil 'recursive) t]
1329;;; ["Add tags for Perl files in (sub)directories"
5c8b7eaf 1330;;; (cperl-etags t 'recursive) t])
f83d2997 1331;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
f739b53b
SM
1332 ["Create tags for current file" (cperl-write-tags nil t) t]
1333 ["Add tags for current file" (cperl-write-tags) t]
1334 ["Create tags for Perl files in directory"
1335 (cperl-write-tags nil t nil t) t]
1336 ["Add tags for Perl files in directory"
1337 (cperl-write-tags nil nil nil t) t]
1338 ["Create tags for Perl files in (sub)directories"
1339 (cperl-write-tags nil t t t) t]
1340 ["Add tags for Perl files in (sub)directories"
1341 (cperl-write-tags nil nil t t) t]))
1342 ("Perl docs"
15ca5699 1343 ["Define word at point" imenu-go-find-at-position
f739b53b
SM
1344 (fboundp 'imenu-go-find-at-position)]
1345 ["Help on function" cperl-info-on-command t]
1346 ["Help on function at point" cperl-info-on-current-command t]
1347 ["Help on symbol at point" cperl-get-help t]
1348 ["Perldoc" cperl-perldoc t]
1349 ["Perldoc on word at point" cperl-perldoc-at-point t]
1350 ["View manpage of POD in this file" cperl-build-manpage t]
15ca5699 1351 ["Auto-help on" cperl-lazy-install
f739b53b
SM
1352 (and (fboundp 'run-with-idle-timer)
1353 (not cperl-lazy-installed))]
1354 ["Auto-help off" cperl-lazy-unstall
1355 (and (fboundp 'run-with-idle-timer)
1356 cperl-lazy-installed)])
1357 ("Toggle..."
1358 ["Auto newline" cperl-toggle-auto-newline t]
1359 ["Electric parens" cperl-toggle-electric t]
1360 ["Electric keywords" cperl-toggle-abbrev t]
1361 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1362 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
15ca5699 1363 ["Auto fill" auto-fill-mode t])
f739b53b
SM
1364 ("Indent styles..."
1365 ["CPerl" (cperl-set-style "CPerl") t]
1366 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1367 ["GNU" (cperl-set-style "GNU") t]
1368 ["C++" (cperl-set-style "C++") t]
4ab89e7b 1369 ["K&R" (cperl-set-style "K&R") t]
f739b53b
SM
1370 ["BSD" (cperl-set-style "BSD") t]
1371 ["Whitesmith" (cperl-set-style "Whitesmith") t]
4ab89e7b 1372 ["Memorize Current" (cperl-set-style "Current") t]
f739b53b
SM
1373 ["Memorized" (cperl-set-style-back) cperl-old-style])
1374 ("Micro-docs"
1375 ["Tips" (describe-variable 'cperl-tips) t]
1376 ["Problems" (describe-variable 'cperl-problems) t]
1377 ["Speed" (describe-variable 'cperl-speed) t]
1378 ["Praise" (describe-variable 'cperl-praise) t]
1379 ["Faces" (describe-variable 'cperl-tips-faces) t]
1380 ["CPerl mode" (describe-function 'cperl-mode) t]
1381 ["CPerl version"
1382 (message "The version of master-file for this CPerl is %s-Emacs"
1383 cperl-version) t]))))
f83d2997
KH
1384 (error nil))
1385
1386(autoload 'c-macro-expand "cmacexp"
1387 "Display the result of expanding all C macros occurring in the region.
1388The expansion is entirely correct because it uses the C preprocessor."
1389 t)
1390
4ab89e7b
SM
1391;;; These two must be unwound, otherwise take exponential time
1392(defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
1393"Regular expression to match optional whitespace with interpspersed comments.
1394Should contain exactly one group.")
1395
1396;;; This one is tricky to unwind; still very inefficient...
1397(defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
1398"Regular expression to match whitespace with interpspersed comments.
1399Should contain exactly one group.")
1400
1401
1402;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1403;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1404;;; Details of groups in this may be used in several functions; see comments
1405;;; near mentioned above variable(s)...
1406;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1407(defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
1408 "Match the text after `sub' in a subroutine declaration.
1409If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
1410of attributes (if present), or end of the name or prototype (whatever is
1411the last)."
1412 (concat ; Assume n groups before this...
1413 "\\(" ; n+1=name-group
1414 cperl-white-and-comment-rex ; n+2=pre-name
1415 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
1416 "\\)" ; END n+1=name-group
1417 (if named "" "?")
1418 "\\(" ; n+4=proto-group
1419 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
1420 "\\(([^()]*)\\)" ; n+6=prototype
1421 "\\)?" ; END n+4=proto-group
1422 "\\(" ; n+7=attr-group
1423 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
1424 "\\(" ; n+9=start-attr
1425 ":"
1426 (if attr (concat
1427 "\\("
1428 cperl-maybe-white-and-comment-rex ; whitespace-comments
1429 "\\(\\sw\\|_\\)+" ; attr-name
1430 ;; attr-arg (1 level of internal parens allowed!)
1431 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
1432 "\\(" ; optional : (XXX allows trailing???)
1433 cperl-maybe-white-and-comment-rex ; whitespace-comments
1434 ":\\)?"
1435 "\\)+")
1436 "[^:]")
1437 "\\)"
1438 "\\)?" ; END n+6=proto-group
1439 ))
1440
1441;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1442;;; and `cperl-outline-level'.
1443;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
95f433f4
RS
1444(defvar cperl-imenu--function-name-regexp-perl
1445 (concat
4ab89e7b
SM
1446 "^\\(" ; 1 = all
1447 "\\([ \t]*package" ; 2 = package-group
1448 "\\(" ; 3 = package-name-group
1449 cperl-white-and-comment-rex ; 4 = pre-package-name
1450 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
1451 "\\|"
1452 "[ \t]*sub"
1453 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1454 cperl-maybe-white-and-comment-rex ; 15=pre-block
1455 "\\|"
1456 "=head\\([1-4]\\)[ \t]+" ; 16=level
1457 "\\([^\n]+\\)$" ; 17=text
95f433f4
RS
1458 "\\)"))
1459
8dd511f6
RS
1460(defvar cperl-outline-regexp
1461 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1462
f83d2997 1463(defvar cperl-mode-syntax-table nil
f94a632a 1464 "Syntax table in use in CPerl mode buffers.")
f83d2997
KH
1465
1466(defvar cperl-string-syntax-table nil
f94a632a 1467 "Syntax table in use in CPerl mode string-like chunks.")
f83d2997 1468
4ab89e7b
SM
1469(defsubst cperl-1- (p)
1470 (max (point-min) (1- p)))
1471
1472(defsubst cperl-1+ (p)
1473 (min (point-max) (1+ p)))
1474
f83d2997
KH
1475(if cperl-mode-syntax-table
1476 ()
1477 (setq cperl-mode-syntax-table (make-syntax-table))
1478 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1479 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1480 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1481 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1482 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1483 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1484 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1485 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1486 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1487 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1488 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1489 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
1490 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1491 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1492 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1493 (if cperl-under-as-char
1494 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1495 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1496 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1497 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1498 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
4ab89e7b
SM
1499 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
1500 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
8c777c8d
CY
1501 (modify-syntax-entry ?\" "." cperl-string-syntax-table)
1502 (modify-syntax-entry ?' "." cperl-string-syntax-table)
1503 (modify-syntax-entry ?` "." cperl-string-syntax-table)
83261a2f 1504 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
f83d2997
KH
1505
1506
1507\f
db133cb6 1508(defvar cperl-faces-init nil)
f83d2997
KH
1509;; Fix for msb.el
1510(defvar cperl-msb-fixed nil)
83261a2f 1511(defvar cperl-use-major-mode 'cperl-mode)
4ab89e7b
SM
1512(defvar cperl-font-lock-multiline-start nil)
1513(defvar cperl-font-lock-multiline nil)
4ab89e7b 1514(defvar cperl-font-locking nil)
83261a2f 1515
e9bfd3a3
GM
1516;; NB as it stands the code in cperl-mode assumes this only has one
1517;; element. If Xemacs 19 support were dropped, this could all be simplified.
1518(defvar cperl-compilation-error-regexp-alist
1519 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1520 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
1521 2 3))
1522 "Alist that specifies how to match errors in perl output.")
1523
73e72da4
DN
1524(defvar compilation-error-regexp-alist)
1525
f83d2997
KH
1526;;;###autoload
1527(defun cperl-mode ()
1528 "Major mode for editing Perl code.
1529Expression and list commands understand all C brackets.
1530Tab indents for Perl code.
1531Paragraphs are separated by blank lines only.
1532Delete converts tabs to spaces as it moves back.
1533
1534Various characters in Perl almost always come in pairs: {}, (), [],
1535sometimes <>. When the user types the first, she gets the second as
1536well, with optional special formatting done on {}. (Disabled by
1537default.) You can always quote (with \\[quoted-insert]) the left
1538\"paren\" to avoid the expansion. The processing of < is special,
f94a632a 1539since most the time you mean \"less\". CPerl mode tries to guess
f83d2997
KH
1540whether you want to type pair <>, and inserts is if it
1541appropriate. You can set `cperl-electric-parens-string' to the string that
1542contains the parenths from the above list you want to be electrical.
1543Electricity of parenths is controlled by `cperl-electric-parens'.
1544You may also set `cperl-electric-parens-mark' to have electric parens
1545look for active mark and \"embrace\" a region if possible.'
1546
1547CPerl mode provides expansion of the Perl control constructs:
db133cb6 1548
5c8b7eaf 1549 if, else, elsif, unless, while, until, continue, do,
db133cb6
RS
1550 for, foreach, formy and foreachmy.
1551
1552and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1553
1554The user types the keyword immediately followed by a space, which
1555causes the construct to be expanded, and the point is positioned where
1556she is most likely to want to be. eg. when the user types a space
1557following \"if\" the following appears in the buffer: if () { or if ()
1558} { } and the cursor is between the parentheses. The user can then
1559type some boolean expression within the parens. Having done that,
1560typing \\[cperl-linefeed] places you - appropriately indented - on a
1561new line between the braces (if you typed \\[cperl-linefeed] in a POD
5c8b7eaf 1562directive line, then appropriate number of new lines is inserted).
db133cb6
RS
1563
1564If CPerl decides that you want to insert \"English\" style construct like
1565
f83d2997 1566 bite if angry;
db133cb6
RS
1567
1568it will not do any expansion. See also help on variable
1569`cperl-extra-newline-before-brace'. (Note that one can switch the
1570help message on expansion by setting `cperl-message-electric-keyword'
1571to nil.)
f83d2997
KH
1572
1573\\[cperl-linefeed] is a convenience replacement for typing carriage
1574return. It places you in the next line with proper indentation, or if
1575you type it inside the inline block of control construct, like
db133cb6 1576
f83d2997 1577 foreach (@lines) {print; print}
db133cb6 1578
f83d2997
KH
1579and you are on a boundary of a statement inside braces, it will
1580transform the construct into a multiline and will place you into an
5c8b7eaf 1581appropriately indented blank line. If you need a usual
6292d528 1582`newline-and-indent' behavior, it is on \\[newline-and-indent],
f83d2997
KH
1583see documentation on `cperl-electric-linefeed'.
1584
db133cb6
RS
1585Use \\[cperl-invert-if-unless] to change a construction of the form
1586
1587 if (A) { B }
1588
1589into
1590
1591 B if A;
1592
f83d2997
KH
1593\\{cperl-mode-map}
1594
db133cb6
RS
1595Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1596\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1597on electric space between $ and {, `cperl-electric-parens-string' is
1598the string that contains parentheses that should be electric in CPerl
1599\(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
f83d2997
KH
1600setting `cperl-electric-keywords' enables electric expansion of
1601control structures in CPerl. `cperl-electric-linefeed' governs which
1602one of two linefeed behavior is preferable. You can enable all these
1603options simultaneously (recommended mode of use) by setting
1604`cperl-hairy' to t. In this case you can switch separate options off
db133cb6
RS
1605by setting them to `null'. Note that one may undo the extra
1606whitespace inserted by semis and braces in `auto-newline'-mode by
1607consequent \\[cperl-electric-backspace].
f83d2997
KH
1608
1609If your site has perl5 documentation in info format, you can use commands
1610\\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1611These keys run commands `cperl-info-on-current-command' and
1612`cperl-info-on-command', which one is which is controlled by variable
5c8b7eaf 1613`cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
db133cb6 1614\(in turn affected by `cperl-hairy').
f83d2997
KH
1615
1616Even if you have no info-format documentation, short one-liner-style
db133cb6
RS
1617help is available on \\[cperl-get-help], and one can run perldoc or
1618man via menu.
f83d2997 1619
db133cb6
RS
1620It is possible to show this help automatically after some idle time.
1621This is regulated by variable `cperl-lazy-help-time'. Default with
1622`cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1623secs idle time . It is also possible to switch this on/off from the
1624menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
f83d2997
KH
1625
1626Use \\[cperl-lineup] to vertically lineup some construction - put the
1627beginning of the region at the start of construction, and make region
1628span the needed amount of lines.
1629
1630Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
83261a2f 1631`cperl-pod-face', `cperl-pod-head-face' control processing of POD and
db133cb6
RS
1632here-docs sections. With capable Emaxen results of scan are used
1633for indentation too, otherwise they are used for highlighting only.
f83d2997
KH
1634
1635Variables controlling indentation style:
1636 `cperl-tab-always-indent'
1637 Non-nil means TAB in CPerl mode should always reindent the current line,
1638 regardless of where in the line point is when the TAB command is used.
db133cb6
RS
1639 `cperl-indent-left-aligned-comments'
1640 Non-nil means that the comment starting in leftmost column should indent.
f83d2997
KH
1641 `cperl-auto-newline'
1642 Non-nil means automatically newline before and after braces,
1643 and after colons and semicolons, inserted in Perl code. The following
1644 \\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf
SS
1645 Insertion after colons requires both this variable and
1646 `cperl-auto-newline-after-colon' set.
f83d2997
KH
1647 `cperl-auto-newline-after-colon'
1648 Non-nil means automatically newline even after colons.
1649 Subject to `cperl-auto-newline' setting.
1650 `cperl-indent-level'
1651 Indentation of Perl statements within surrounding block.
1652 The surrounding block's indentation is the indentation
1653 of the line on which the open-brace appears.
1654 `cperl-continued-statement-offset'
1655 Extra indentation given to a substatement, such as the
1656 then-clause of an if, or body of a while, or just a statement continuation.
1657 `cperl-continued-brace-offset'
1658 Extra indentation given to a brace that starts a substatement.
1659 This is in addition to `cperl-continued-statement-offset'.
1660 `cperl-brace-offset'
1661 Extra indentation for line if it starts with an open brace.
1662 `cperl-brace-imaginary-offset'
1663 An open brace following other text is treated as if it the line started
1664 this far to the right of the actual line indentation.
1665 `cperl-label-offset'
1666 Extra indentation for line that is a label.
1667 `cperl-min-label-indent'
1668 Minimal indentation for line that is a label.
1669
4ab89e7b
SM
1670Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1671 `cperl-indent-level' 5 4 2 4
1672 `cperl-brace-offset' 0 0 0 0
1673 `cperl-continued-brace-offset' -5 -4 0 0
1674 `cperl-label-offset' -5 -4 -2 -4
1675 `cperl-continued-statement-offset' 5 4 2 4
f83d2997 1676
db133cb6
RS
1677CPerl knows several indentation styles, and may bulk set the
1678corresponding variables. Use \\[cperl-set-style] to do this. Use
1679\\[cperl-set-style-back] to restore the memorized preexisting values
4ab89e7b
SM
1680\(both available from menu). See examples in `cperl-style-examples'.
1681
1682Part of the indentation style is how different parts of if/elsif/else
1683statements are broken into lines; in CPerl, this is reflected on how
1684templates for these constructs are created (controlled by
8c777c8d
CY
1685`cperl-extra-newline-before-brace'), and how reflow-logic should treat
1686\"continuation\" blocks of else/elsif/continue, controlled by the same
1687variable, and by `cperl-extra-newline-before-brace-multiline',
4ab89e7b 1688`cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
db133cb6
RS
1689
1690If `cperl-indent-level' is 0, the statement after opening brace in
5c8b7eaf 1691column 0 is indented on
db133cb6 1692`cperl-brace-offset'+`cperl-continued-statement-offset'.
f83d2997
KH
1693
1694Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
db133cb6
RS
1695with no args.
1696
1697DO NOT FORGET to read micro-docs (available from `Perl' menu)
1698or as help on variables `cperl-tips', `cperl-problems',
f94a632a 1699`cperl-praise', `cperl-speed'."
f83d2997
KH
1700 (interactive)
1701 (kill-all-local-variables)
f83d2997
KH
1702 (use-local-map cperl-mode-map)
1703 (if (cperl-val 'cperl-electric-linefeed)
1704 (progn
1705 (local-set-key "\C-J" 'cperl-linefeed)
1706 (local-set-key "\C-C\C-J" 'newline-and-indent)))
db133cb6
RS
1707 (if (and
1708 (cperl-val 'cperl-clobber-lisp-bindings)
1709 (cperl-val 'cperl-info-on-command-no-prompt))
f83d2997
KH
1710 (progn
1711 ;; don't clobber the backspace binding:
1712 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1713 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1714 [(control c) (control h) f])))
83261a2f 1715 (setq major-mode cperl-use-major-mode)
f83d2997 1716 (setq mode-name "CPerl")
449657e8
GM
1717 (let ((prev-a-c abbrevs-changed))
1718 (define-abbrev-table 'cperl-mode-abbrev-table '(
f83d2997
KH
1719 ("if" "if" cperl-electric-keyword 0)
1720 ("elsif" "elsif" cperl-electric-keyword 0)
1721 ("while" "while" cperl-electric-keyword 0)
1722 ("until" "until" cperl-electric-keyword 0)
1723 ("unless" "unless" cperl-electric-keyword 0)
1724 ("else" "else" cperl-electric-else 0)
db133cb6 1725 ("continue" "continue" cperl-electric-else 0)
f83d2997
KH
1726 ("for" "for" cperl-electric-keyword 0)
1727 ("foreach" "foreach" cperl-electric-keyword 0)
db133cb6
RS
1728 ("formy" "formy" cperl-electric-keyword 0)
1729 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1730 ("do" "do" cperl-electric-keyword 0)
6c389151
SM
1731 ("=pod" "=pod" cperl-electric-pod 0)
1732 ("=over" "=over" cperl-electric-pod 0)
1733 ("=head1" "=head1" cperl-electric-pod 0)
1734 ("=head2" "=head2" cperl-electric-pod 0)
db133cb6
RS
1735 ("pod" "pod" cperl-electric-pod 0)
1736 ("over" "over" cperl-electric-pod 0)
1737 ("head1" "head1" cperl-electric-pod 0)
1738 ("head2" "head2" cperl-electric-pod 0)))
449657e8 1739 (setq abbrevs-changed prev-a-c))
f83d2997 1740 (setq local-abbrev-table cperl-mode-abbrev-table)
4ab89e7b
SM
1741 (if (cperl-val 'cperl-electric-keywords)
1742 (abbrev-mode 1))
f83d2997 1743 (set-syntax-table cperl-mode-syntax-table)
4ab89e7b
SM
1744 ;; Until Emacs is multi-threaded, we do not actually need it local:
1745 (make-local-variable 'cperl-font-lock-multiline-start)
1746 (make-local-variable 'cperl-font-locking)
6c389151
SM
1747 (make-local-variable 'outline-regexp)
1748 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1749 (setq outline-regexp cperl-outline-regexp)
1750 (make-local-variable 'outline-level)
1751 (setq outline-level 'cperl-outline-level)
f83d2997
KH
1752 (make-local-variable 'paragraph-start)
1753 (setq paragraph-start (concat "^$\\|" page-delimiter))
1754 (make-local-variable 'paragraph-separate)
1755 (setq paragraph-separate paragraph-start)
1756 (make-local-variable 'paragraph-ignore-fill-prefix)
1757 (setq paragraph-ignore-fill-prefix t)
6546555e 1758 (if (featurep 'xemacs)
4ab89e7b
SM
1759 (progn
1760 (make-local-variable 'paren-backwards-message)
1761 (set 'paren-backwards-message t)))
f83d2997
KH
1762 (make-local-variable 'indent-line-function)
1763 (setq indent-line-function 'cperl-indent-line)
1764 (make-local-variable 'require-final-newline)
7d441781 1765 (setq require-final-newline mode-require-final-newline)
f83d2997
KH
1766 (make-local-variable 'comment-start)
1767 (setq comment-start "# ")
1768 (make-local-variable 'comment-end)
1769 (setq comment-end "")
1770 (make-local-variable 'comment-column)
1771 (setq comment-column cperl-comment-column)
1772 (make-local-variable 'comment-start-skip)
1773 (setq comment-start-skip "#+ *")
1774 (make-local-variable 'defun-prompt-regexp)
4ab89e7b
SM
1775;;; "[ \t]*sub"
1776;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1777;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1778 (setq defun-prompt-regexp
1779 (concat "^[ \t]*\\(sub"
1780 (cperl-after-sub-regexp 'named 'attr-groups)
1781 "\\|" ; per toke.c
1782 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
1783 "\\)"
1784 cperl-maybe-white-and-comment-rex))
f83d2997
KH
1785 (make-local-variable 'comment-indent-function)
1786 (setq comment-indent-function 'cperl-comment-indent)
4ab89e7b
SM
1787 (and (boundp 'fill-paragraph-function)
1788 (progn
1789 (make-local-variable 'fill-paragraph-function)
1790 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
f83d2997
KH
1791 (make-local-variable 'parse-sexp-ignore-comments)
1792 (setq parse-sexp-ignore-comments t)
1793 (make-local-variable 'indent-region-function)
1794 (setq indent-region-function 'cperl-indent-region)
1795 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1796 (make-local-variable 'imenu-create-index-function)
1797 (setq imenu-create-index-function
80585273 1798 (function cperl-imenu--create-perl-index))
f83d2997
KH
1799 (make-local-variable 'imenu-sort-function)
1800 (setq imenu-sort-function nil)
e1a5828f
AS
1801 (make-local-variable 'vc-rcs-header)
1802 (set 'vc-rcs-header cperl-vc-rcs-header)
1803 (make-local-variable 'vc-sccs-header)
1804 (set 'vc-sccs-header cperl-vc-sccs-header)
67141a37
GM
1805 (when (featurep 'xemacs)
1806 ;; This one is obsolete...
1807 (make-local-variable 'vc-header-alist)
1808 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
1809 `((SCCS ,(car cperl-vc-sccs-header))
1810 (RCS ,(car cperl-vc-rcs-header))))))
4ab89e7b
SM
1811 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
1812 (make-local-variable 'compilation-error-regexp-alist-alist)
1813 (set 'compilation-error-regexp-alist-alist
e9bfd3a3 1814 (cons (cons 'cperl (car cperl-compilation-error-regexp-alist))
4ab89e7b 1815 (symbol-value 'compilation-error-regexp-alist-alist)))
8c777c8d
CY
1816 (if (fboundp 'compilation-build-compilation-error-regexp-alist)
1817 (let ((f 'compilation-build-compilation-error-regexp-alist))
1818 (funcall f))
1819 (make-local-variable 'compilation-error-regexp-alist)
1820 (push 'cperl compilation-error-regexp-alist)))
4ab89e7b
SM
1821 ((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
1822 (make-local-variable 'compilation-error-regexp-alist)
1823 (set 'compilation-error-regexp-alist
10715960
RS
1824 (append cperl-compilation-error-regexp-alist
1825 (symbol-value 'compilation-error-regexp-alist)))))
f83d2997
KH
1826 (make-local-variable 'font-lock-defaults)
1827 (setq font-lock-defaults
db133cb6
RS
1828 (cond
1829 ((string< emacs-version "19.30")
4ab89e7b 1830 '(cperl-font-lock-keywords-2 nil nil ((?_ . "w"))))
db133cb6 1831 ((string< emacs-version "19.33") ; Which one to use?
5efe6a56
SM
1832 '((cperl-font-lock-keywords
1833 cperl-font-lock-keywords-1
4ab89e7b 1834 cperl-font-lock-keywords-2) nil nil ((?_ . "w"))))
db133cb6
RS
1835 (t
1836 '((cperl-load-font-lock-keywords
1837 cperl-load-font-lock-keywords-1
4ab89e7b 1838 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
db133cb6 1839 (make-local-variable 'cperl-syntax-state)
4ab89e7b 1840 (setq cperl-syntax-state nil) ; reset syntaxification cache
f83d2997 1841 (if cperl-use-syntax-table-text-property
cf38dd42
SM
1842 (if (boundp 'syntax-propertize-function)
1843 (progn
1844 ;; Reset syntaxification cache.
1845 (set (make-local-variable 'cperl-syntax-done-to) nil)
1846 (set (make-local-variable 'syntax-propertize-function)
1847 (lambda (start end)
1848 (goto-char start) (cperl-fontify-syntaxically end))))
029cb4d5 1849 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997 1850 ;; Do not introduce variable if not needed, we check it!
db133cb6
RS
1851 (set 'parse-sexp-lookup-properties t)
1852 ;; Fix broken font-lock:
1853 (or (boundp 'font-lock-unfontify-region-function)
1854 (set 'font-lock-unfontify-region-function
83261a2f 1855 'font-lock-default-unfontify-region))
6546555e 1856 (unless (featurep 'xemacs) ; Our: just a plug for wrong font-lock
4ab89e7b
SM
1857 (make-local-variable 'font-lock-unfontify-region-function)
1858 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1859 'cperl-font-lock-unfontify-region-function))
029cb4d5 1860 (make-local-variable 'cperl-syntax-done-to)
4ab89e7b 1861 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
029cb4d5 1862 (make-local-variable 'font-lock-syntactic-keywords)
5c8b7eaf 1863 (setq font-lock-syntactic-keywords
db133cb6 1864 (if cperl-syntaxify-by-font-lock
11b41e6f
SM
1865 '((cperl-fontify-syntaxically))
1866 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1867 ;; used to ignore syntax-table text-properties. (t) is a hack
1868 ;; to make font-lock think that font-lock-syntactic-keywords
1869 ;; are defined.
db133cb6 1870 '(t)))))
4ab89e7b
SM
1871 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
1872 (progn
1873 (setq cperl-font-lock-multiline t) ; Not localized...
f453f5a8 1874 (set (make-local-variable 'font-lock-multiline) t))
4ab89e7b
SM
1875 (make-local-variable 'font-lock-fontify-region-function)
1876 (set 'font-lock-fontify-region-function ; not present with old Emacs
1877 'cperl-font-lock-fontify-region-function))
1878 (make-local-variable 'font-lock-fontify-region-function)
1879 (set 'font-lock-fontify-region-function ; not present with old Emacs
1880 'cperl-font-lock-fontify-region-function)
db133cb6 1881 (make-local-variable 'cperl-old-style)
83261a2f
SM
1882 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1883 (set (make-local-variable 'normal-auto-fill-function)
4ab89e7b 1884 'cperl-do-auto-fill)
83261a2f
SM
1885 (or (fboundp 'cperl-old-auto-fill-mode)
1886 (progn
1887 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1888 (defun auto-fill-mode (&optional arg)
1889 (interactive "P")
1890 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1891 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1892 (setq auto-fill-function 'cperl-do-auto-fill))))))
f83d2997 1893 (if (cperl-enable-font-lock)
5c8b7eaf 1894 (if (cperl-val 'cperl-font-lock)
f83d2997
KH
1895 (progn (or cperl-faces-init (cperl-init-faces))
1896 (font-lock-mode 1))))
4ab89e7b
SM
1897 (set (make-local-variable 'facemenu-add-face-function)
1898 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
f83d2997
KH
1899 (and (boundp 'msb-menu-cond)
1900 (not cperl-msb-fixed)
1901 (cperl-msb-fix))
1902 (if (featurep 'easymenu)
46c72468 1903 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
a3c328ee 1904 (run-mode-hooks 'cperl-mode-hook)
4ab89e7b 1905 (if cperl-hook-after-change
39234e39 1906 (add-hook 'after-change-functions 'cperl-after-change-function nil t))
f83d2997 1907 ;; After hooks since fontification will break this
5c8b7eaf 1908 (if cperl-pod-here-scan
83261a2f 1909 (or cperl-syntaxify-by-font-lock
5bd52f0e
RS
1910 (progn (or cperl-faces-init (cperl-init-faces-weak))
1911 (cperl-find-pods-heres)))))
f83d2997
KH
1912\f
1913;; Fix for perldb - make default reasonable
1914(defun cperl-db ()
1915 (interactive)
1916 (require 'gud)
1917 (perldb (read-from-minibuffer "Run perldb (like this): "
1918 (if (consp gud-perldb-history)
1919 (car gud-perldb-history)
1920 (concat "perl " ;;(file-name-nondirectory
83261a2f
SM
1921 ;; I have problems
1922 ;; in OS/2
1923 ;; otherwise
1924 (buffer-file-name)))
f83d2997
KH
1925 nil nil
1926 '(gud-perldb-history . 1))))
1927\f
f83d2997
KH
1928(defun cperl-msb-fix ()
1929 ;; Adds perl files to msb menu, supposes that msb is already loaded
1930 (setq cperl-msb-fixed t)
1931 (let* ((l (length msb-menu-cond))
1932 (last (nth (1- l) msb-menu-cond))
1933 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1934 (handle (1- (nth 1 last))))
1935 (setcdr precdr (list
1936 (list
996e2616 1937 '(memq major-mode '(cperl-mode perl-mode))
f83d2997
KH
1938 handle
1939 "Perl Files (%d)")
1940 last))))
1941\f
1942;; This is used by indent-for-comment
1943;; to decide how much to indent a comment in CPerl code
1944;; based on its context. Do fallback if comment is found wrong.
1945
1946(defvar cperl-wrong-comment)
5bd52f0e
RS
1947(defvar cperl-st-cfence '(14)) ; Comment-fence
1948(defvar cperl-st-sfence '(15)) ; String-fence
1949(defvar cperl-st-punct '(1))
1950(defvar cperl-st-word '(2))
1951(defvar cperl-st-bra '(4 . ?\>))
1952(defvar cperl-st-ket '(5 . ?\<))
1953
f83d2997 1954
4ab89e7b 1955(defun cperl-comment-indent () ; called at point at supposed comment
5bd52f0e 1956 (let ((p (point)) (c (current-column)) was phony)
4ab89e7b
SM
1957 (if (and (not cperl-indent-comment-at-column-0)
1958 (looking-at "^#"))
1959 0 ; Existing comment at bol stays there.
f83d2997
KH
1960 ;; Wrong comment found
1961 (save-excursion
5bd52f0e
RS
1962 (setq was (cperl-to-comment-or-eol)
1963 phony (eq (get-text-property (point) 'syntax-table)
1964 cperl-st-cfence))
1965 (if phony
4ab89e7b 1966 (progn ; Too naive???
5bd52f0e
RS
1967 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1968 (if (eq (preceding-char) ?\#)
1969 (forward-char -1))
1970 (setq was nil)))
4ab89e7b 1971 (if (= (point) p) ; Our caller found a correct place
f83d2997
KH
1972 (progn
1973 (skip-chars-backward " \t")
4ab89e7b
SM
1974 (setq was (current-column))
1975 (if (eq was 0)
1976 comment-column
1977 (max (1+ was) ; Else indent at comment column
1978 comment-column)))
1979 ;; No, the caller found a random place; we need to edit ourselves
f83d2997
KH
1980 (if was nil
1981 (insert comment-start)
1982 (backward-char (length comment-start)))
1983 (setq cperl-wrong-comment t)
4ab89e7b
SM
1984 (cperl-make-indent comment-column 1) ; Indent min 1
1985 c)))))
f83d2997
KH
1986
1987;;;(defun cperl-comment-indent-fallback ()
1988;;; "Is called if the standard comment-search procedure fails.
1989;;;Point is at start of real comment."
1990;;; (let ((c (current-column)) target cnt prevc)
1991;;; (if (= c comment-column) nil
1992;;; (setq cnt (skip-chars-backward "[ \t]"))
5c8b7eaf 1993;;; (setq target (max (1+ (setq prevc
f83d2997
KH
1994;;; (current-column))) ; Else indent at comment column
1995;;; comment-column))
1996;;; (if (= c comment-column) nil
1997;;; (delete-backward-char cnt)
1998;;; (while (< prevc target)
1999;;; (insert "\t")
2000;;; (setq prevc (current-column)))
2001;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2002;;; (while (< prevc target)
2003;;; (insert " ")
2004;;; (setq prevc (current-column)))))))
2005
2006(defun cperl-indent-for-comment ()
2007 "Substitute for `indent-for-comment' in CPerl."
2008 (interactive)
2009 (let (cperl-wrong-comment)
2010 (indent-for-comment)
4ab89e7b 2011 (if cperl-wrong-comment ; set by `cperl-comment-indent'
f83d2997
KH
2012 (progn (cperl-to-comment-or-eol)
2013 (forward-char (length comment-start))))))
2014
2015(defun cperl-comment-region (b e arg)
2016 "Comment or uncomment each line in the region in CPerl mode.
2017See `comment-region'."
2018 (interactive "r\np")
2019 (let ((comment-start "#"))
2020 (comment-region b e arg)))
2021
2022(defun cperl-uncomment-region (b e arg)
2023 "Uncomment or comment each line in the region in CPerl mode.
2024See `comment-region'."
2025 (interactive "r\np")
2026 (let ((comment-start "#"))
2027 (comment-region b e (- arg))))
2028
2029(defvar cperl-brace-recursing nil)
2030
2031(defun cperl-electric-brace (arg &optional only-before)
2032 "Insert character and correct line's indentation.
2033If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2034place (even in empty line), but not after. If after \")\" and the inserted
5c8b7eaf 2035char is \"{\", insert extra newline before only if
f83d2997
KH
2036`cperl-extra-newline-before-brace'."
2037 (interactive "P")
2038 (let (insertpos
2039 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2040 (cperl-mark-active)
f83d2997 2041 (< (mark) (point)))
5c8b7eaf 2042 (mark)
f83d2997
KH
2043 nil)))
2044 (if (and other-end
2045 (not cperl-brace-recursing)
2046 (cperl-val 'cperl-electric-parens)
2047 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2048 ;; Need to insert a matching pair
2049 (progn
2050 (save-excursion
2051 (setq insertpos (point-marker))
2052 (goto-char other-end)
1ba983e8 2053 (setq last-command-event ?\{)
f83d2997
KH
2054 (cperl-electric-lbrace arg insertpos))
2055 (forward-char 1))
83261a2f 2056 ;; Check whether we close something "usual" with `}'
1ba983e8 2057 (if (and (eq last-command-event ?\})
5c8b7eaf 2058 (not
db133cb6
RS
2059 (condition-case nil
2060 (save-excursion
2061 (up-list (- (prefix-numeric-value arg)))
2062 ;;(cperl-after-block-p (point-min))
f739b53b
SM
2063 (or (cperl-after-expr-p nil "{;)")
2064 ;; after sub, else, continue
2065 (cperl-after-block-p nil 'pre)))
db133cb6
RS
2066 (error nil))))
2067 ;; Just insert the guy
2068 (self-insert-command (prefix-numeric-value arg))
2069 (if (and (not arg) ; No args, end (of empty line or auto)
2070 (eolp)
2071 (or (and (null only-before)
2072 (save-excursion
2073 (skip-chars-backward " \t")
2074 (bolp)))
1ba983e8 2075 (and (eq last-command-event ?\{) ; Do not insert newline
db133cb6
RS
2076 ;; if after ")" and `cperl-extra-newline-before-brace'
2077 ;; is nil, do not insert extra newline.
2078 (not cperl-extra-newline-before-brace)
2079 (save-excursion
2080 (skip-chars-backward " \t")
2081 (eq (preceding-char) ?\))))
5c8b7eaf 2082 (if cperl-auto-newline
db133cb6
RS
2083 (progn (cperl-indent-line) (newline) t) nil)))
2084 (progn
2085 (self-insert-command (prefix-numeric-value arg))
2086 (cperl-indent-line)
2087 (if cperl-auto-newline
2088 (setq insertpos (1- (point))))
2089 (if (and cperl-auto-newline (null only-before))
2090 (progn
2091 (newline)
2092 (cperl-indent-line)))
2093 (save-excursion
2094 (if insertpos (progn (goto-char insertpos)
5c8b7eaf 2095 (search-forward (make-string
1ba983e8 2096 1 last-command-event))
db133cb6
RS
2097 (setq insertpos (1- (point)))))
2098 (delete-char -1))))
2099 (if insertpos
f83d2997 2100 (save-excursion
db133cb6
RS
2101 (goto-char insertpos)
2102 (self-insert-command (prefix-numeric-value arg)))
2103 (self-insert-command (prefix-numeric-value arg)))))))
f83d2997
KH
2104
2105(defun cperl-electric-lbrace (arg &optional end)
2106 "Insert character, correct line's indentation, correct quoting by space."
2107 (interactive "P")
83261a2f
SM
2108 (let ((cperl-brace-recursing t)
2109 (cperl-auto-newline cperl-auto-newline)
2110 (other-end (or end
2111 (if (and cperl-electric-parens-mark
2112 (cperl-mark-active)
2113 (> (mark) (point)))
2114 (save-excursion
2115 (goto-char (mark))
2116 (point-marker))
2117 nil)))
2118 pos after)
f83d2997
KH
2119 (and (cperl-val 'cperl-electric-lbrace-space)
2120 (eq (preceding-char) ?$)
2121 (save-excursion
2122 (skip-chars-backward "$")
2123 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
b5b0cb34 2124 (insert ?\s))
bab27c0c 2125 ;; Check whether we are in comment
5c8b7eaf 2126 (if (and
bab27c0c
RS
2127 (save-excursion
2128 (beginning-of-line)
2129 (not (looking-at "[ \t]*#")))
2130 (cperl-after-expr-p nil "{;)"))
2131 nil
2132 (setq cperl-auto-newline nil))
f83d2997
KH
2133 (cperl-electric-brace arg)
2134 (and (cperl-val 'cperl-electric-parens)
1ba983e8
GM
2135 (eq last-command-event ?{)
2136 (memq last-command-event
f83d2997
KH
2137 (append cperl-electric-parens-string nil))
2138 (or (if other-end (goto-char (marker-position other-end)))
2139 t)
1ba983e8 2140 (setq last-command-event ?} pos (point))
f83d2997
KH
2141 (progn (cperl-electric-brace arg t)
2142 (goto-char pos)))))
2143
2144(defun cperl-electric-paren (arg)
f739b53b
SM
2145 "Insert an opening parenthesis or a matching pair of parentheses.
2146See `cperl-electric-parens'."
f83d2997 2147 (interactive "P")
e180ab9f 2148 (let ((beg (point-at-bol))
f83d2997 2149 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2150 (cperl-mark-active)
f83d2997 2151 (> (mark) (point)))
83261a2f
SM
2152 (save-excursion
2153 (goto-char (mark))
2154 (point-marker))
f83d2997
KH
2155 nil)))
2156 (if (and (cperl-val 'cperl-electric-parens)
1ba983e8 2157 (memq last-command-event
f83d2997
KH
2158 (append cperl-electric-parens-string nil))
2159 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2160 ;;(not (save-excursion (search-backward "#" beg t)))
1ba983e8 2161 (if (eq last-command-event ?<)
f83d2997 2162 (progn
7a55c78b
CY
2163 ;; This code is too electric, see Bug#3943.
2164 ;; (and abbrev-mode ; later it is too late, may be after `for'
2165 ;; (expand-abbrev))
f83d2997
KH
2166 (cperl-after-expr-p nil "{;(,:="))
2167 1))
2168 (progn
2169 (self-insert-command (prefix-numeric-value arg))
2170 (if other-end (goto-char (marker-position other-end)))
5c8b7eaf 2171 (insert (make-string
f83d2997 2172 (prefix-numeric-value arg)
1ba983e8 2173 (cdr (assoc last-command-event '((?{ .?})
f83d2997
KH
2174 (?[ . ?])
2175 (?( . ?))
2176 (?< . ?>))))))
2177 (forward-char (- (prefix-numeric-value arg))))
2178 (self-insert-command (prefix-numeric-value arg)))))
2179
2180(defun cperl-electric-rparen (arg)
2181 "Insert a matching pair of parentheses if marking is active.
f739b53b
SM
2182If not, or if we are not at the end of marking range, would self-insert.
2183Affected by `cperl-electric-parens'."
f83d2997 2184 (interactive "P")
e180ab9f 2185 (let ((beg (point-at-bol))
f83d2997
KH
2186 (other-end (if (and cperl-electric-parens-mark
2187 (cperl-val 'cperl-electric-parens)
1ba983e8 2188 (memq last-command-event
f83d2997 2189 (append cperl-electric-parens-string nil))
5c8b7eaf 2190 (cperl-mark-active)
f83d2997 2191 (< (mark) (point)))
5c8b7eaf 2192 (mark)
f83d2997
KH
2193 nil))
2194 p)
2195 (if (and other-end
2196 (cperl-val 'cperl-electric-parens)
1ba983e8 2197 (memq last-command-event '( ?\) ?\] ?\} ?\> ))
f83d2997
KH
2198 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2199 ;;(not (save-excursion (search-backward "#" beg t)))
2200 )
2201 (progn
2202 (self-insert-command (prefix-numeric-value arg))
2203 (setq p (point))
2204 (if other-end (goto-char other-end))
2205 (insert (make-string
2206 (prefix-numeric-value arg)
1ba983e8 2207 (cdr (assoc last-command-event '((?\} . ?\{)
83261a2f
SM
2208 (?\] . ?\[)
2209 (?\) . ?\()
2210 (?\> . ?\<))))))
f83d2997
KH
2211 (goto-char (1+ p)))
2212 (self-insert-command (prefix-numeric-value arg)))))
2213
2214(defun cperl-electric-keyword ()
db133cb6
RS
2215 "Insert a construction appropriate after a keyword.
2216Help message may be switched off by setting `cperl-message-electric-keyword'
2217to nil."
e180ab9f 2218 (let ((beg (point-at-bol))
1ba983e8 2219 (dollar (and (eq last-command-event ?$)
f83d2997 2220 (eq this-command 'self-insert-command)))
1ba983e8 2221 (delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
db133cb6
RS
2222 (memq this-command '(self-insert-command newline))))
2223 my do)
f83d2997 2224 (and (save-excursion
db133cb6
RS
2225 (condition-case nil
2226 (progn
2227 (backward-sexp 1)
2228 (setq do (looking-at "do\\>")))
2229 (error nil))
f83d2997 2230 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2231 (save-excursion
2232 (not
f83d2997 2233 (re-search-backward
5bd52f0e 2234 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2235 beg t)))
2236 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2237 (or
2238 (looking-at "=cut")
2239 (and cperl-use-syntax-table-text-property
2240 (not (eq (get-text-property (point)
2241 'syntax-type)
2242 'pod))))))
f739b53b
SM
2243 (save-excursion (forward-sexp -1)
2244 (not (memq (following-char) (append "$@%&*" nil))))
f83d2997 2245 (progn
db133cb6
RS
2246 (and (eq (preceding-char) ?y)
2247 (progn ; "foreachmy"
2248 (forward-char -2)
2249 (insert " ")
2250 (forward-char 2)
5c8b7eaf
SS
2251 (setq my t dollar t
2252 delete
db133cb6 2253 (memq this-command '(self-insert-command newline)))))
f83d2997
KH
2254 (and dollar (insert " $"))
2255 (cperl-indent-line)
2256 ;;(insert " () {\n}")
2257 (cond
2258 (cperl-extra-newline-before-brace
db133cb6 2259 (insert (if do "\n" " ()\n"))
f83d2997
KH
2260 (insert "{")
2261 (cperl-indent-line)
2262 (insert "\n")
2263 (cperl-indent-line)
db133cb6
RS
2264 (insert "\n}")
2265 (and do (insert " while ();")))
f83d2997 2266 (t
83261a2f 2267 (insert (if do " {\n} while ();" " () {\n}"))))
f83d2997
KH
2268 (or (looking-at "[ \t]\\|$") (insert " "))
2269 (cperl-indent-line)
2270 (if dollar (progn (search-backward "$")
5c8b7eaf 2271 (if my
db133cb6
RS
2272 (forward-char 1)
2273 (delete-char 1)))
f739b53b 2274 (search-backward ")")
1ba983e8 2275 (if (eq last-command-event ?\()
f739b53b
SM
2276 (progn ; Avoid "if (())"
2277 (delete-backward-char 1)
2278 (delete-backward-char -1))))
f83d2997 2279 (if delete
db133cb6
RS
2280 (cperl-putback-char cperl-del-back-ch))
2281 (if cperl-message-electric-keyword
2282 (message "Precede char by C-q to avoid expansion"))))))
2283
2284(defun cperl-ensure-newlines (n &optional pos)
2285 "Make sure there are N newlines after the point."
2286 (or pos (setq pos (point)))
2287 (if (looking-at "\n")
2288 (forward-char 1)
2289 (insert "\n"))
2290 (if (> n 1)
2291 (cperl-ensure-newlines (1- n) pos)
2292 (goto-char pos)))
2293
2294(defun cperl-electric-pod ()
2295 "Insert a POD chunk appropriate after a =POD directive."
1ba983e8 2296 (let ((delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
db133cb6
RS
2297 (memq this-command '(self-insert-command newline))))
2298 head1 notlast name p really-delete over)
2299 (and (save-excursion
6c389151 2300 (forward-word -1)
a1506d29 2301 (and
db133cb6
RS
2302 (eq (preceding-char) ?=)
2303 (progn
6c389151
SM
2304 (setq head1 (looking-at "head1\\>[ \t]*$"))
2305 (setq over (and (looking-at "over\\>[ \t]*$")
2306 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
db133cb6
RS
2307 (forward-char -1)
2308 (bolp))
5c8b7eaf 2309 (or
5bd52f0e 2310 (get-text-property (point) 'in-pod)
db133cb6 2311 (cperl-after-expr-p nil "{;:")
4ab89e7b
SM
2312 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
2313 (not (looking-at "\n*=cut"))
2314 (or (not cperl-use-syntax-table-text-property)
2315 (eq (get-text-property (point) 'syntax-type) 'pod))))))
db133cb6
RS
2316 (progn
2317 (save-excursion
6c389151 2318 (setq notlast (re-search-forward "^\n=" nil t)))
db133cb6
RS
2319 (or notlast
2320 (progn
2321 (insert "\n\n=cut")
2322 (cperl-ensure-newlines 2)
6c389151 2323 (forward-word -2)
a1506d29
JB
2324 (if (and head1
2325 (not
db133cb6
RS
2326 (save-excursion
2327 (forward-char -1)
2328 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
83261a2f 2329 nil t)))) ; Only one
a1506d29 2330 (progn
6c389151 2331 (forward-word 1)
db133cb6
RS
2332 (setq name (file-name-sans-extension
2333 (file-name-nondirectory (buffer-file-name)))
2334 p (point))
5c8b7eaf 2335 (insert " NAME\n\n" name
029cb4d5 2336 " - \n\n=head1 SYNOPSIS\n\n\n\n"
db133cb6
RS
2337 "=head1 DESCRIPTION")
2338 (cperl-ensure-newlines 4)
2339 (goto-char p)
6c389151 2340 (forward-word 2)
db133cb6
RS
2341 (end-of-line)
2342 (setq really-delete t))
6c389151 2343 (forward-word 1))))
db133cb6
RS
2344 (if over
2345 (progn
2346 (setq p (point))
2347 (insert "\n\n=item \n\n\n\n"
2348 "=back")
2349 (cperl-ensure-newlines 2)
2350 (goto-char p)
6c389151 2351 (forward-word 1)
db133cb6
RS
2352 (end-of-line)
2353 (setq really-delete t)))
2354 (if (and delete really-delete)
f83d2997
KH
2355 (cperl-putback-char cperl-del-back-ch))))))
2356
2357(defun cperl-electric-else ()
db133cb6
RS
2358 "Insert a construction appropriate after a keyword.
2359Help message may be switched off by setting `cperl-message-electric-keyword'
2360to nil."
e180ab9f 2361 (let ((beg (point-at-bol)))
f83d2997
KH
2362 (and (save-excursion
2363 (backward-sexp 1)
2364 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2365 (save-excursion
2366 (not
f83d2997 2367 (re-search-backward
5bd52f0e 2368 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2369 beg t)))
2370 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2371 (looking-at "=cut")
2372 (and cperl-use-syntax-table-text-property
2373 (not (eq (get-text-property (point)
2374 'syntax-type)
2375 'pod)))))
f83d2997
KH
2376 (progn
2377 (cperl-indent-line)
2378 ;;(insert " {\n\n}")
2379 (cond
2380 (cperl-extra-newline-before-brace
2381 (insert "\n")
2382 (insert "{")
2383 (cperl-indent-line)
2384 (insert "\n\n}"))
2385 (t
83261a2f 2386 (insert " {\n\n}")))
f83d2997
KH
2387 (or (looking-at "[ \t]\\|$") (insert " "))
2388 (cperl-indent-line)
2389 (forward-line -1)
2390 (cperl-indent-line)
db133cb6
RS
2391 (cperl-putback-char cperl-del-back-ch)
2392 (setq this-command 'cperl-electric-else)
2393 (if cperl-message-electric-keyword
2394 (message "Precede char by C-q to avoid expansion"))))))
f83d2997
KH
2395
2396(defun cperl-linefeed ()
db133cb6
RS
2397 "Go to end of line, open a new line and indent appropriately.
2398If in POD, insert appropriate lines."
f83d2997 2399 (interactive)
e180ab9f
GM
2400 (let ((beg (point-at-bol))
2401 (end (point-at-eol))
db133cb6 2402 (pos (point)) start over cut res)
f83d2997 2403 (if (and ; Check if we need to split:
5c8b7eaf 2404 ; i.e., on a boundary and inside "{...}"
f83d2997 2405 (save-excursion (cperl-to-comment-or-eol)
83261a2f 2406 (>= (point) pos)) ; Not in a comment
f83d2997
KH
2407 (or (save-excursion
2408 (skip-chars-backward " \t" beg)
2409 (forward-char -1)
2410 (looking-at "[;{]")) ; After { or ; + spaces
2411 (looking-at "[ \t]*}") ; Before }
2412 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2413 (save-excursion
2414 (and
5c8b7eaf 2415 (eq (car (parse-partial-sexp pos end -1)) -1)
f83d2997
KH
2416 ; Leave the level of parens
2417 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2418 ; Are at end
6c389151 2419 (cperl-after-block-p (point-min))
f83d2997
KH
2420 (progn
2421 (backward-sexp 1)
2422 (setq start (point-marker))
db133cb6 2423 (<= start pos))))) ; Redundant? Are after the
f83d2997
KH
2424 ; start of parens group.
2425 (progn
2426 (skip-chars-backward " \t")
2427 (or (memq (preceding-char) (append ";{" nil))
2428 (insert ";"))
2429 (insert "\n")
2430 (forward-line -1)
2431 (cperl-indent-line)
2432 (goto-char start)
2433 (or (looking-at "{[ \t]*$") ; If there is a statement
2434 ; before, move it to separate line
2435 (progn
2436 (forward-char 1)
2437 (insert "\n")
2438 (cperl-indent-line)))
2439 (forward-line 1) ; We are on the target line
2440 (cperl-indent-line)
2441 (beginning-of-line)
2442 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
83261a2f 2443 ; after, move it to separate line
f83d2997
KH
2444 (progn
2445 (end-of-line)
2446 (search-backward "}" beg)
2447 (skip-chars-backward " \t")
2448 (or (memq (preceding-char) (append ";{" nil))
2449 (insert ";"))
2450 (insert "\n")
2451 (cperl-indent-line)
2452 (forward-line -1)))
5c8b7eaf 2453 (forward-line -1) ; We are on the line before target
f83d2997
KH
2454 (end-of-line)
2455 (newline-and-indent))
db133cb6 2456 (end-of-line) ; else - no splitting
f83d2997
KH
2457 (cond
2458 ((and (looking-at "\n[ \t]*{$")
2459 (save-excursion
2460 (skip-chars-backward " \t")
2461 (eq (preceding-char) ?\)))) ; Probably if () {} group
83261a2f 2462 ; with an extra newline.
f83d2997
KH
2463 (forward-line 2)
2464 (cperl-indent-line))
db133cb6
RS
2465 ((save-excursion ; In POD header
2466 (forward-paragraph -1)
2467 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2468 ;; We are after \n now, so look for the rest
2469 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
5c8b7eaf 2470 (progn
db133cb6
RS
2471 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2472 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2473 t)))
2474 (if (and over
2475 (progn
2476 (forward-paragraph -1)
2477 (forward-word 1)
2478 (setq pos (point))
e180ab9f
GM
2479 (setq cut (buffer-substring (point) (point-at-eol)))
2480 (delete-char (- (point-at-eol) (point)))
db133cb6
RS
2481 (setq res (expand-abbrev))
2482 (save-excursion
2483 (goto-char pos)
2484 (insert cut))
2485 res))
2486 nil
2487 (cperl-ensure-newlines (if cut 2 4))
2488 (forward-line 2)))
2489 ((get-text-property (point) 'in-pod) ; In POD section
2490 (cperl-ensure-newlines 4)
2491 (forward-line 2))
f83d2997
KH
2492 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2493 (forward-line 1)
2494 (cperl-indent-line))
2495 (t
2496 (newline-and-indent))))))
2497
2498(defun cperl-electric-semi (arg)
2499 "Insert character and correct line's indentation."
2500 (interactive "P")
2501 (if cperl-auto-newline
2502 (cperl-electric-terminator arg)
6c389151
SM
2503 (self-insert-command (prefix-numeric-value arg))
2504 (if cperl-autoindent-on-semi
2505 (cperl-indent-line))))
f83d2997
KH
2506
2507(defun cperl-electric-terminator (arg)
2508 "Insert character and correct line's indentation."
2509 (interactive "P")
83261a2f
SM
2510 (let ((end (point))
2511 (auto (and cperl-auto-newline
1ba983e8 2512 (or (not (eq last-command-event ?:))
83261a2f
SM
2513 cperl-auto-newline-after-colon)))
2514 insertpos)
5c8b7eaf 2515 (if (and ;;(not arg)
f83d2997
KH
2516 (eolp)
2517 (not (save-excursion
2518 (beginning-of-line)
2519 (skip-chars-forward " \t")
2520 (or
2521 ;; Ignore in comment lines
2522 (= (following-char) ?#)
2523 ;; Colon is special only after a label
2524 ;; So quickly rule out most other uses of colon
2525 ;; and do no indentation for them.
1ba983e8 2526 (and (eq last-command-event ?:)
f83d2997
KH
2527 (save-excursion
2528 (forward-word 1)
2529 (skip-chars-forward " \t")
2530 (and (< (point) end)
2531 (progn (goto-char (- end 1))
2532 (not (looking-at ":"))))))
2533 (progn
2534 (beginning-of-defun)
2535 (let ((pps (parse-partial-sexp (point) end)))
2536 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2537 (progn
2538 (self-insert-command (prefix-numeric-value arg))
2539 ;;(forward-char -1)
2540 (if auto (setq insertpos (point-marker)))
2541 ;;(forward-char 1)
2542 (cperl-indent-line)
2543 (if auto
2544 (progn
2545 (newline)
2546 (cperl-indent-line)))
f83d2997
KH
2547 (save-excursion
2548 (if insertpos (goto-char (1- (marker-position insertpos)))
2549 (forward-char -1))
2550 (delete-char 1))))
2551 (if insertpos
2552 (save-excursion
2553 (goto-char insertpos)
2554 (self-insert-command (prefix-numeric-value arg)))
2555 (self-insert-command (prefix-numeric-value arg)))))
2556
2557(defun cperl-electric-backspace (arg)
8c777c8d
CY
2558 "Backspace, or remove whitespace around the point inserted by an electric key.
2559Will untabify if `cperl-electric-backspace-untabify' is non-nil."
f83d2997 2560 (interactive "p")
5c8b7eaf
SS
2561 (if (and cperl-auto-newline
2562 (memq last-command '(cperl-electric-semi
f83d2997
KH
2563 cperl-electric-terminator
2564 cperl-electric-lbrace))
b5b0cb34 2565 (memq (preceding-char) '(?\s ?\t ?\n)))
f83d2997 2566 (let (p)
5c8b7eaf 2567 (if (eq last-command 'cperl-electric-lbrace)
f83d2997
KH
2568 (skip-chars-forward " \t\n"))
2569 (setq p (point))
2570 (skip-chars-backward " \t\n")
2571 (delete-region (point) p))
db133cb6
RS
2572 (and (eq last-command 'cperl-electric-else)
2573 ;; We are removing the whitespace *inside* cperl-electric-else
2574 (setq this-command 'cperl-electric-else-really))
5c8b7eaf 2575 (if (and cperl-auto-newline
db133cb6 2576 (eq last-command 'cperl-electric-else-really)
b5b0cb34 2577 (memq (preceding-char) '(?\s ?\t ?\n)))
db133cb6
RS
2578 (let (p)
2579 (skip-chars-forward " \t\n")
2580 (setq p (point))
2581 (skip-chars-backward " \t\n")
2582 (delete-region (point) p))
f739b53b
SM
2583 (if cperl-electric-backspace-untabify
2584 (backward-delete-char-untabify arg)
2585 (delete-backward-char arg)))))
f83d2997 2586
d6156ce8
KS
2587(put 'cperl-electric-backspace 'delete-selection 'supersede)
2588
4ab89e7b 2589(defun cperl-inside-parens-p () ;; NOT USED????
f83d2997
KH
2590 (condition-case ()
2591 (save-excursion
2592 (save-restriction
2593 (narrow-to-region (point)
2594 (progn (beginning-of-defun) (point)))
2595 (goto-char (point-max))
2596 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2597 (error nil)))
2598\f
2599(defun cperl-indent-command (&optional whole-exp)
2600 "Indent current line as Perl code, or in some cases insert a tab character.
5c8b7eaf 2601If `cperl-tab-always-indent' is non-nil (the default), always indent current
db133cb6 2602line. Otherwise, indent the current line only if point is at the left margin
f83d2997
KH
2603or in the line's indentation; otherwise insert a tab.
2604
2605A numeric argument, regardless of its value,
2606means indent rigidly all the lines of the expression starting after point
2607so that this line becomes properly indented.
2608The relative indentation among the lines of the expression are preserved."
2609 (interactive "P")
5bd52f0e 2610 (cperl-update-syntaxification (point) (point))
f83d2997
KH
2611 (if whole-exp
2612 ;; If arg, always indent this line as Perl
2613 ;; and shift remaining lines of expression the same amount.
2614 (let ((shift-amt (cperl-indent-line))
2615 beg end)
2616 (save-excursion
2617 (if cperl-tab-always-indent
2618 (beginning-of-line))
2619 (setq beg (point))
2620 (forward-sexp 1)
2621 (setq end (point))
2622 (goto-char beg)
2623 (forward-line 1)
2624 (setq beg (point)))
db133cb6 2625 (if (and shift-amt (> end beg))
f83d2997
KH
2626 (indent-code-rigidly beg end shift-amt "#")))
2627 (if (and (not cperl-tab-always-indent)
2628 (save-excursion
2629 (skip-chars-backward " \t")
2630 (not (bolp))))
2631 (insert-tab)
2632 (cperl-indent-line))))
2633
5bd52f0e 2634(defun cperl-indent-line (&optional parse-data)
f83d2997
KH
2635 "Indent current line as Perl code.
2636Return the amount the indentation changed by."
83261a2f
SM
2637 (let ((case-fold-search nil)
2638 (pos (- (point-max) (point)))
2639 indent i beg shift-amt)
5bd52f0e 2640 (setq indent (cperl-calculate-indent parse-data)
db133cb6 2641 i indent)
f83d2997
KH
2642 (beginning-of-line)
2643 (setq beg (point))
2644 (cond ((or (eq indent nil) (eq indent t))
db133cb6 2645 (setq indent (current-indentation) i nil))
f83d2997
KH
2646 ;;((eq indent t) ; Never?
2647 ;; (setq indent (cperl-calculate-indent-within-comment)))
2648 ;;((looking-at "[ \t]*#")
2649 ;; (setq indent 0))
2650 (t
2651 (skip-chars-forward " \t")
2652 (if (listp indent) (setq indent (car indent)))
82d9a08d
SM
2653 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2654 (not (looking-at "[smy]:\\|tr:")))
f83d2997
KH
2655 (and (> indent 0)
2656 (setq indent (max cperl-min-label-indent
2657 (+ indent cperl-label-offset)))))
2658 ((= (following-char) ?})
2659 (setq indent (- indent cperl-indent-level)))
2660 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2661 (setq indent (+ indent cperl-close-paren-offset)))
2662 ((= (following-char) ?{)
2663 (setq indent (+ indent cperl-brace-offset))))))
2664 (skip-chars-forward " \t")
db133cb6
RS
2665 (setq shift-amt (and i (- indent (current-column))))
2666 (if (or (not shift-amt)
2667 (zerop shift-amt))
f83d2997
KH
2668 (if (> (- (point-max) pos) (point))
2669 (goto-char (- (point-max) pos)))
4ab89e7b
SM
2670 ;;;(delete-region beg (point))
2671 ;;;(indent-to indent)
2672 (cperl-make-indent indent)
f83d2997
KH
2673 ;; If initial point was within line's indentation,
2674 ;; position after the indentation. Else stay at same point in text.
2675 (if (> (- (point-max) pos) (point))
2676 (goto-char (- (point-max) pos))))
2677 shift-amt))
2678
2679(defun cperl-after-label ()
2680 ;; Returns true if the point is after label. Does not do save-excursion.
2681 (and (eq (preceding-char) ?:)
2682 (memq (char-syntax (char-after (- (point) 2)))
2683 '(?w ?_))
2684 (progn
2685 (backward-sexp)
2686 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2687
2688(defun cperl-get-state (&optional parse-start start-state)
5bd52f0e
RS
2689 ;; returns list (START STATE DEPTH PRESTART),
2690 ;; START is a good place to start parsing, or equal to
5c8b7eaf 2691 ;; PARSE-START if preset,
5bd52f0e
RS
2692 ;; STATE is what is returned by `parse-partial-sexp'.
2693 ;; DEPTH is true is we are immediately after end of block
2694 ;; which contains START.
2695 ;; PRESTART is the position basing on which START was found.
f83d2997
KH
2696 (save-excursion
2697 (let ((start-point (point)) depth state start prestart)
5bd52f0e
RS
2698 (if (and parse-start
2699 (<= parse-start start-point))
f83d2997 2700 (goto-char parse-start)
5bd52f0e
RS
2701 (beginning-of-defun)
2702 (setq start-state nil))
f83d2997
KH
2703 (setq prestart (point))
2704 (if start-state nil
2705 ;; Try to go out, if sub is not on the outermost level
2706 (while (< (point) start-point)
2707 (setq start (point) parse-start start depth nil
2708 state (parse-partial-sexp start start-point -1))
2709 (if (> (car state) -1) nil
2710 ;; The current line could start like }}}, so the indentation
2711 ;; corresponds to a different level than what we reached
2712 (setq depth t)
2713 (beginning-of-line 2))) ; Go to the next line.
2714 (if start (goto-char start))) ; Not at the start of file
2715 (setq start (point))
f83d2997
KH
2716 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2717 (list start state depth prestart))))
2718
f83d2997
KH
2719(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2720
4ab89e7b
SM
2721(defun cperl-beginning-of-property (p prop &optional lim)
2722 "Given that P has a property PROP, find where the property starts.
2723Will not look before LIM."
2724 ;;; XXXX What to do at point-max???
2725 (or (previous-single-property-change (cperl-1+ p) prop lim)
2726 (point-min))
2727;;; (cond ((eq p (point-min))
2728;;; p)
2729;;; ((and lim (<= p lim))
2730;;; p)
2731;;; ((not (get-text-property (1- p) prop))
2732;;; p)
2733;;; (t (or (previous-single-property-change p look-prop lim)
2734;;; (point-min))))
2735 )
2736
2737(defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
8c777c8d 2738 ;; the sniffer logic to understand what the current line MEANS.
f739b53b 2739 (cperl-update-syntaxification (point) (point))
4ab89e7b
SM
2740 (let ((res (get-text-property (point) 'syntax-type)))
2741 (save-excursion
2742 (cond
2743 ((and (memq res '(pod here-doc here-doc-delim format))
2744 (not (get-text-property (point) 'indentable)))
2745 (vector res))
2746 ;; before start of POD - whitespace found since do not have 'pod!
2747 ((looking-at "[ \t]*\n=")
2748 (error "Spaces before POD section!"))
2749 ((and (not cperl-indent-left-aligned-comments)
2750 (looking-at "^#"))
2751 [comment-special:at-beginning-of-line])
2752 ((get-text-property (point) 'in-pod)
2753 [in-pod])
2754 (t
2755 (beginning-of-line)
2756 (let* ((indent-point (point))
2757 (char-after-pos (save-excursion
2758 (skip-chars-forward " \t")
2759 (point)))
2760 (char-after (char-after char-after-pos))
2761 (pre-indent-point (point))
2762 p prop look-prop is-block delim)
2763 (save-excursion ; Know we are not in POD, find appropriate pos before
83261a2f
SM
2764 (cperl-backward-to-noncomment nil)
2765 (setq p (max (point-min) (1- (point)))
2766 prop (get-text-property p 'syntax-type)
2767 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2768 'syntax-type))
2769 (if (memq prop '(pod here-doc format here-doc-delim))
2770 (progn
4ab89e7b 2771 (goto-char (cperl-beginning-of-property p look-prop))
83261a2f 2772 (beginning-of-line)
4ab89e7b
SM
2773 (setq pre-indent-point (point)))))
2774 (goto-char pre-indent-point) ; Orig line skipping preceeding pod/etc
2775 (let* ((case-fold-search nil)
2776 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2777 (start (or (nth 2 parse-data) ; last complete sexp terminated
2778 (nth 0 s-s))) ; Good place to start parsing
2779 (state (nth 1 s-s))
2780 (containing-sexp (car (cdr state)))
2781 old-indent)
2782 (if (and
2783 ;;containing-sexp ;; We are buggy at toplevel :-(
2784 parse-data)
2785 (progn
2786 (setcar parse-data pre-indent-point)
2787 (setcar (cdr parse-data) state)
2788 (or (nth 2 parse-data)
2789 (setcar (cddr parse-data) start))
2790 ;; Before this point: end of statement
2791 (setq old-indent (nth 3 parse-data))))
2792 (cond ((get-text-property (point) 'indentable)
2793 ;; indent to "after" the surrounding open
2794 ;; (same offset as `cperl-beautify-regexp-piece'),
2795 ;; skip blanks if we do not close the expression.
2796 (setq delim ; We do not close the expression
2797 (get-text-property
2798 (cperl-1+ char-after-pos) 'indentable)
2799 p (1+ (cperl-beginning-of-property
2800 (point) 'indentable))
2801 is-block ; misused for: preceeding line in REx
2802 (save-excursion ; Find preceeding line
2803 (cperl-backward-to-noncomment p)
2804 (beginning-of-line)
2805 (if (<= (point) p)
2806 (progn ; get indent from the first line
2807 (goto-char p)
2808 (skip-chars-forward " \t")
2809 (if (memq (char-after (point))
2810 (append "#\n" nil))
2811 nil ; Can't use intentation of this line...
2812 (point)))
2813 (skip-chars-forward " \t")
2814 (point)))
2815 prop (parse-partial-sexp p char-after-pos))
2816 (cond ((not delim) ; End the REx, ignore is-block
2817 (vector 'indentable 'terminator p is-block))
2818 (is-block ; Indent w.r.t. preceeding line
2819 (vector 'indentable 'cont-line char-after-pos
2820 is-block char-after p))
2821 (t ; No preceeding line...
2822 (vector 'indentable 'first-line p))))
2823 ((get-text-property char-after-pos 'REx-part2)
2824 (vector 'REx-part2 (point)))
4ab89e7b 2825 ((nth 4 state)
82d9a08d
SM
2826 [comment])
2827 ((nth 3 state)
4ab89e7b
SM
2828 [string])
2829 ;; XXXX Do we need to special-case this?
2830 ((null containing-sexp)
2831 ;; Line is at top level. May be data or function definition,
2832 ;; or may be function argument declaration.
2833 ;; Indent like the previous top level line
2834 ;; unless that ends in a closeparen without semicolon,
2835 ;; in which case this line is the first argument decl.
2836 (skip-chars-forward " \t")
2837 (cperl-backward-to-noncomment (or old-indent (point-min)))
2838 (setq state
2839 (or (bobp)
2840 (eq (point) old-indent) ; old-indent was at comment
2841 (eq (preceding-char) ?\;)
2842 ;; Had ?\) too
2843 (and (eq (preceding-char) ?\})
2844 (cperl-after-block-and-statement-beg
2845 (point-min))) ; Was start - too close
2846 (memq char-after (append ")]}" nil))
2847 (and (eq (preceding-char) ?\:) ; label
83261a2f
SM
2848 (progn
2849 (forward-sexp -1)
4ab89e7b
SM
2850 (skip-chars-backward " \t")
2851 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2852 (get-text-property (point) 'first-format-line)))
cb5bf6ba 2853
4ab89e7b
SM
2854 ;; Look at previous line that's at column 0
2855 ;; to determine whether we are in top-level decls
2856 ;; or function's arg decls. Set basic-indent accordingly.
2857 ;; Now add a little if this is a continuation line.
2858 (and state
2859 parse-data
2860 (not (eq char-after ?\C-j))
2861 (setcdr (cddr parse-data)
2862 (list pre-indent-point)))
2863 (vector 'toplevel start char-after state (nth 2 s-s)))
2864 ((not
2865 (or (setq is-block
2866 (and (setq delim (= (char-after containing-sexp) ?{))
2867 (save-excursion ; Is it a hash?
2868 (goto-char containing-sexp)
2869 (cperl-block-p))))
2870 cperl-indent-parens-as-block))
2871 ;; group is an expression, not a block:
2872 ;; indent to just after the surrounding open parens,
2873 ;; skip blanks if we do not close the expression.
2874 (goto-char (1+ containing-sexp))
2875 (or (memq char-after
2876 (append (if delim "}" ")]}") nil))
2877 (looking-at "[ \t]*\\(#\\|$\\)")
2878 (skip-chars-forward " \t"))
2879 (setq old-indent (point)) ; delim=is-brace
2880 (vector 'in-parens char-after (point) delim containing-sexp))
2881 (t
2882 ;; Statement level. Is it a continuation or a new statement?
2883 ;; Find previous non-comment character.
2884 (goto-char pre-indent-point) ; Skip one level of POD/etc
2885 (cperl-backward-to-noncomment containing-sexp)
2886 ;; Back up over label lines, since they don't
2887 ;; affect whether our line is a continuation.
2888 ;; (Had \, too)
2889 (while;;(or (eq (preceding-char) ?\,)
2890 (and (eq (preceding-char) ?:)
2891 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2892 (memq (char-syntax (char-after (- (point) 2)))
2893 '(?w ?_))))
2894 ;;)
2895 ;; This is always FALSE?
2896 (if (eq (preceding-char) ?\,)
2897 ;; Will go to beginning of line, essentially.
2898 ;; Will ignore embedded sexpr XXXX.
2899 (cperl-backward-to-start-of-continued-exp containing-sexp))
2900 (beginning-of-line)
2901 (cperl-backward-to-noncomment containing-sexp))
2902 ;; Now we get non-label preceeding the indent point
2903 (if (not (or (eq (1- (point)) containing-sexp)
2904 (memq (preceding-char)
2905 (append (if is-block " ;{" " ,;{") '(nil)))
2906 (and (eq (preceding-char) ?\})
2907 (cperl-after-block-and-statement-beg
2908 containing-sexp))
2909 (get-text-property (point) 'first-format-line)))
2910 ;; This line is continuation of preceding line's statement;
2911 ;; indent `cperl-continued-statement-offset' more than the
2912 ;; previous line of the statement.
2913 ;;
2914 ;; There might be a label on this line, just
2915 ;; consider it bad style and ignore it.
2916 (progn
2917 (cperl-backward-to-start-of-continued-exp containing-sexp)
2918 (vector 'continuation (point) char-after is-block delim))
2919 ;; This line starts a new statement.
2920 ;; Position following last unclosed open brace
2921 (goto-char containing-sexp)
2922 ;; Is line first statement after an open-brace?
2923 (or
2924 ;; If no, find that first statement and indent like
2925 ;; it. If the first statement begins with label, do
2926 ;; not believe when the indentation of the label is too
2927 ;; small.
2928 (save-excursion
2929 (forward-char 1)
2930 (let ((colon-line-end 0))
2931 (while
2932 (progn (skip-chars-forward " \t\n")
82d9a08d
SM
2933 ;; s: foo : bar :x is NOT label
2934 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2935 (not (looking-at "[sym]:\\|tr:"))))
4ab89e7b
SM
2936 ;; Skip over comments and labels following openbrace.
2937 (cond ((= (following-char) ?\#)
2938 (forward-line 1))
2939 ((= (following-char) ?\=)
2940 (goto-char
2941 (or (next-single-property-change (point) 'in-pod)
2942 (point-max)))) ; do not loop if no syntaxification
2943 ;; label:
2944 (t
e180ab9f 2945 (setq colon-line-end (point-at-eol))
4ab89e7b
SM
2946 (search-forward ":"))))
2947 ;; We are at beginning of code (NOT label or comment)
2948 ;; First, the following code counts
2949 ;; if it is before the line we want to indent.
2950 (and (< (point) indent-point)
2951 (vector 'have-prev-sibling (point) colon-line-end
2952 containing-sexp))))
2953 (progn
2954 ;; If no previous statement,
2955 ;; indent it relative to line brace is on.
2956
2957 ;; For open-braces not the first thing in a line,
2958 ;; add in cperl-brace-imaginary-offset.
2959
2960 ;; If first thing on a line: ?????
2961 ;; Move back over whitespace before the openbrace.
2962 (setq ; brace first thing on a line
2963 old-indent (progn (skip-chars-backward " \t") (bolp)))
2964 ;; Should we indent w.r.t. earlier than start?
2965 ;; Move to start of control group, possibly on a different line
2966 (or cperl-indent-wrt-brace
2967 (cperl-backward-to-noncomment (point-min)))
2968 ;; If the openbrace is preceded by a parenthesized exp,
2969 ;; move to the beginning of that;
2970 (if (eq (preceding-char) ?\))
2971 (progn
2972 (forward-sexp -1)
2973 (cperl-backward-to-noncomment (point-min))))
2974 ;; In the case it starts a subroutine, indent with
2975 ;; respect to `sub', not with respect to the
2976 ;; first thing on the line, say in the case of
2977 ;; anonymous sub in a hash.
2978 (if (and;; Is it a sub in group starting on this line?
2979 (cond ((get-text-property (point) 'attrib-group)
2980 (goto-char (cperl-beginning-of-property
2981 (point) 'attrib-group)))
2982 ((eq (preceding-char) ?b)
2983 (forward-sexp -1)
2984 (looking-at "sub\\>")))
2985 (setq p (nth 1 ; start of innermost containing list
2986 (parse-partial-sexp
9b026d9f 2987 (point-at-bol)
4ab89e7b
SM
2988 (point)))))
2989 (progn
2990 (goto-char (1+ p)) ; enclosing block on the same line
2991 (skip-chars-forward " \t")
2992 (vector 'code-start-in-block containing-sexp char-after
2993 (and delim (not is-block)) ; is a HASH
2994 old-indent ; brace first thing on a line
2995 t (point) ; have something before...
2996 )
2997 ;;(current-column)
2998 )
2999 ;; Get initial indentation of the line we are on.
3000 ;; If line starts with label, calculate label indentation
3001 (vector 'code-start-in-block containing-sexp char-after
3002 (and delim (not is-block)) ; is a HASH
3003 old-indent ; brace first thing on a line
82d9a08d 3004 nil (point))))))))))))))) ; nothing interesting before
4ab89e7b
SM
3005
3006(defvar cperl-indent-rules-alist
3007 '((pod nil) ; via `syntax-type' property
3008 (here-doc nil) ; via `syntax-type' property
3009 (here-doc-delim nil) ; via `syntax-type' property
3010 (format nil) ; via `syntax-type' property
3011 (in-pod nil) ; via `in-pod' property
3012 (comment-special:at-beginning-of-line nil)
3013 (string t)
3014 (comment nil))
3015 "Alist of indentation rules for CPerl mode.
3016The values mean:
3017 nil: do not indent;
82d9a08d 3018 number: add this amount of indentation.")
4ab89e7b
SM
3019
3020(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3021 "Return appropriate indentation for current line as Perl code.
3022In usual case returns an integer: the column to indent to.
3023Returns nil if line starts inside a string, t if in a comment.
3024
3025Will not correct the indentation for labels, but will correct it for braces
3026and closing parentheses and brackets."
3027 ;; This code is still a broken architecture: in some cases we need to
3028 ;; compensate for some modifications which `cperl-indent-line' will add later
3029 (save-excursion
3030 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3031 (cond
3032 ;;((or (null i) (eq i t) (numberp i))
3033 ;; i)
3034 ((vectorp i)
3035 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3036 (cond
3037 (what (cadr what)) ; Load from table
3038 ;;
3039 ;; Indenters for regular expressions with //x and qw()
3040 ;;
3041 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3042 (goto-char (elt i 1))
3043 (condition-case nil ; Use indentation of the 1st part
3044 (forward-sexp -1))
3045 (current-column))
3046 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3047 (cond ;;; [indentable terminator start-pos is-block]
3048 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3049 (goto-char (elt i 2)) ; After opening parens
3050 (1- (current-column)))
3051 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3052 (goto-char (elt i 2))
3053 (+ (or cperl-regexp-indent-step cperl-indent-level)
3054 -1
3055 (current-column)))
3056 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3057 ;; Indent as the level after closing parens
3058 (goto-char (elt i 2)) ; indent line
3059 (skip-chars-forward " \t)") ; Skip closing parens
3060 (setq p (point))
3061 (goto-char (elt i 3)) ; previous line
3062 (skip-chars-forward " \t)") ; Skip closing parens
3063 ;; Number of parens in between:
3064 (setq p (nth 0 (parse-partial-sexp (point) p))
3065 what (elt i 4)) ; First char on current line
3066 (goto-char (elt i 3)) ; previous line
3067 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3068 (cond ((eq what ?\) )
3069 (- cperl-close-paren-offset)) ; compensate
3070 ((eq what ?\| )
3071 (- (or cperl-regexp-indent-step cperl-indent-level)))
3072 (t 0))
3073 (if (eq (following-char) ?\| )
3074 (or cperl-regexp-indent-step cperl-indent-level)
3075 0)
3076 (current-column)))
3077 (t
3078 (error "Unrecognized value of indent: %s" i))))
3079 ;;
3080 ;; Indenter for stuff at toplevel
3081 ;;
3082 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3083 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3084 (goto-char (elt i 1)) ; start = Good place to start parsing
cb5bf6ba 3085 (- (current-indentation) ;
4ab89e7b
SM
3086 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3087 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3088 ;; Look at previous line that's at column 0
3089 ;; to determine whether we are in top-level decls
3090 ;; or function's arg decls. Set basic-indent accordingly.
3091 ;; Now add a little if this is a continuation line.
3092 (if (elt i 3) ; state (XXX What is the semantic???)
3093 0
3094 cperl-continued-statement-offset)))
3095 ;;
3096 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3097 ;;
3098 ((eq 'in-parens (elt i 0))
3099 ;; in-parens char-after old-indent-point is-brace containing-sexp
3100
3101 ;; group is an expression, not a block:
3102 ;; indent to just after the surrounding open parens,
3103 ;; skip blanks if we do not close the expression.
3104 (+ (progn
3105 (goto-char (elt i 2)) ; old-indent-point
3106 (current-column))
3107 (if (and (elt i 3) ; is-brace
3108 (eq (elt i 1) ?\})) ; char-after
3109 ;; Correct indentation of trailing ?\}
3110 (+ cperl-indent-level cperl-close-paren-offset)
3111 0)))
3112 ;;
3113 ;; Indenter for continuation lines
3114 ;;
3115 ((eq 'continuation (elt i 0))
3116 ;; [continuation statement-start char-after is-block is-brace]
3117 (goto-char (elt i 1)) ; statement-start
3118 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
3119 0 ; Closing parenth
3120 cperl-continued-statement-offset)
3121 (if (or (elt i 3) ; is-block
3122 (not (elt i 4)) ; is-brace
3123 (not (eq (elt i 2) ?\}))) ; char-after
3124 0
3125 ;; Now it is a hash reference
3126 (+ cperl-indent-level cperl-close-paren-offset))
3127 ;; Labels do not take :: ...
3128 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3129 (if (> (current-indentation) cperl-min-label-indent)
3130 (- (current-indentation) cperl-label-offset)
3131 ;; Do not move `parse-data', this should
3132 ;; be quick anyway (this comment comes
3133 ;; from different location):
3134 (cperl-calculate-indent))
3135 (current-column))
3136 (if (eq (elt i 2) ?\{) ; char-after
3137 cperl-continued-brace-offset 0)))
3138 ;;
3139 ;; Indenter for lines in a block which are not leading lines
3140 ;;
3141 ((eq 'have-prev-sibling (elt i 0))
3142 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
82d9a08d
SM
3143 (goto-char (elt i 1)) ; sibling-beg
3144 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
4ab89e7b
SM
3145 (if (> (current-indentation)
3146 cperl-min-label-indent)
3147 (- (current-indentation) cperl-label-offset)
3148 ;; Do not believe: `max' was involved in calculation of indent
3149 (+ cperl-indent-level
3150 (save-excursion
3151 (goto-char (elt i 3)) ; block-start
3152 (current-indentation))))
3153 (current-column)))
3154 ;;
3155 ;; Indenter for the first line in a block
3156 ;;
3157 ((eq 'code-start-in-block (elt i 0))
3158 ;;[code-start-in-block before-brace char-after
3159 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3160 ;; group-starts-before-start-of-sub start-of-control-group]
3161 (goto-char (elt i 1))
3162 ;; For open brace in column zero, don't let statement
3163 ;; start there too. If cperl-indent-level=0,
3164 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3165 (+ (if (and (bolp) (zerop cperl-indent-level))
3166 (+ cperl-brace-offset cperl-continued-statement-offset)
3167 cperl-indent-level)
3168 (if (and (elt i 3) ; is-a-HASH-ref
3169 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3170 (+ cperl-indent-level cperl-close-paren-offset)
3171 0)
3172 ;; Unless openbrace is the first nonwhite thing on the line,
3173 ;; add the cperl-brace-imaginary-offset.
3174 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3175 cperl-brace-imaginary-offset)
3176 (progn
3177 (goto-char (elt i 6)) ; start-of-control-group
3178 (if (elt i 5) ; group-starts-before-start-of-sub
3179 (current-column)
3180 ;; Get initial indentation of the line we are on.
3181 ;; If line starts with label, calculate label indentation
3182 (if (save-excursion
3183 (beginning-of-line)
3184 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3185 (if (> (current-indentation) cperl-min-label-indent)
3186 (- (current-indentation) cperl-label-offset)
3187 ;; Do not move `parse-data', this should
3188 ;; be quick anyway:
3189 (cperl-calculate-indent))
3190 (current-indentation))))))
3191 (t
3192 (error "Unrecognized value of indent: %s" i))))
3193 (t
3194 (error "Got strange value of indent: %s" i))))))
3195
f83d2997
KH
3196(defun cperl-calculate-indent-within-comment ()
3197 "Return the indentation amount for line, assuming that
3198the current line is to be regarded as part of a block comment."
3199 (let (end star-start)
3200 (save-excursion
3201 (beginning-of-line)
3202 (skip-chars-forward " \t")
3203 (setq end (point))
3204 (and (= (following-char) ?#)
3205 (forward-line -1)
3206 (cperl-to-comment-or-eol)
3207 (setq end (point)))
3208 (goto-char end)
3209 (current-column))))
3210
3211
3212(defun cperl-to-comment-or-eol ()
029cb4d5 3213 "Go to position before comment on the current line, or to end of line.
4ab89e7b
SM
3214Returns true if comment is found. In POD will not move the point."
3215 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3216 ;; then looks for literal # or end-of-line.
e180ab9f 3217 (let (state stop-in cpoint (lim (point-at-eol)) pr e)
4ab89e7b
SM
3218 (or cperl-font-locking
3219 (cperl-update-syntaxification lim lim))
83261a2f 3220 (beginning-of-line)
4ab89e7b
SM
3221 (if (setq pr (get-text-property (point) 'syntax-type))
3222 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3223 (if (or (eq pr 'pod)
3224 (if (or (not e) (> e lim)) ; deep inside a group
3225 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
83261a2f 3226 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
4ab89e7b
SM
3227 ;; Else - need to do it the hard way
3228 (and (and e (<= e lim))
3229 (goto-char e))
83261a2f
SM
3230 (while (not stop-in)
3231 (setq state (parse-partial-sexp (point) lim nil nil nil t))
f83d2997 3232 ; stop at comment
83261a2f
SM
3233 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3234 (if (nth 4 state) ; After `#';
f83d2997
KH
3235 ; (nth 2 state) can be
3236 ; beginning of m,s,qq and so
3237 ; on
83261a2f
SM
3238 (if (nth 2 state)
3239 (progn
3240 (setq cpoint (point))
3241 (goto-char (nth 2 state))
3242 (cond
3243 ((looking-at "\\(s\\|tr\\)\\>")
3244 (or (re-search-forward
3245 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3246 lim 'move)
3247 (setq stop-in t)))
3248 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3249 (or (re-search-forward
3250 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3251 lim 'move)
3252 (setq stop-in t)))
3253 (t ; It was fair comment
3254 (setq stop-in t) ; Finish
3255 (goto-char (1- cpoint)))))
3256 (setq stop-in t) ; Finish
3257 (forward-char -1))
15ca5699 3258 (setq stop-in t))) ; Finish
83261a2f 3259 (nth 4 state))))
f83d2997 3260
f83d2997
KH
3261(defsubst cperl-modify-syntax-type (at how)
3262 (if (< at (point-max))
3263 (progn
3264 (put-text-property at (1+ at) 'syntax-table how)
4ab89e7b 3265 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
f83d2997
KH
3266
3267(defun cperl-protect-defun-start (s e)
3268 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3269 (save-excursion
3270 (goto-char s)
3271 (while (re-search-forward "^\\s(" e 'to-end)
3272 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3273
5bd52f0e 3274(defun cperl-commentify (bb e string &optional noface)
5c8b7eaf 3275 (if cperl-use-syntax-table-text-property
5bd52f0e
RS
3276 (if (eq noface 'n) ; Only immediate
3277 nil
f83d2997
KH
3278 ;; We suppose that e is _after_ the end of construction, as after eol.
3279 (setq string (if string cperl-st-sfence cperl-st-cfence))
6c389151
SM
3280 (if (> bb (- e 2))
3281 ;; one-char string/comment?!
3282 (cperl-modify-syntax-type bb cperl-st-punct)
3283 (cperl-modify-syntax-type bb string)
3284 (cperl-modify-syntax-type (1- e) string))
f83d2997 3285 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
5c8b7eaf 3286 (put-text-property (1+ bb) (1- e)
f83d2997 3287 'syntax-table cperl-string-syntax-table))
5bd52f0e
RS
3288 (cperl-protect-defun-start bb e))
3289 ;; Fontify
3290 (or noface
3291 (not cperl-pod-here-fontify)
3292 (put-text-property bb e 'face (if string 'font-lock-string-face
3293 'font-lock-comment-face)))))
6c389151 3294
5bd52f0e
RS
3295(defvar cperl-starters '(( ?\( . ?\) )
3296 ( ?\[ . ?\] )
3297 ( ?\{ . ?\} )
3298 ( ?\< . ?\> )))
f83d2997 3299
4ab89e7b
SM
3300(defun cperl-cached-syntax-table (st)
3301 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3302All the entries of the syntax table are \".\", except for a backslash, which
3303is quoting."
3304 (if (car-safe st)
3305 (car st)
3306 (setcar st (make-syntax-table))
3307 (setq st (car st))
3308 (let ((i 0))
3309 (while (< i 256)
3310 (modify-syntax-entry i "." st)
3311 (setq i (1+ i))))
3312 (modify-syntax-entry ?\\ "\\" st)
3313 st))
3314
3315(defun cperl-forward-re (lim end is-2arg st-l err-l argument
f83d2997 3316 &optional ostart oend)
4ab89e7b
SM
3317"Find the end of a regular expression or a stringish construct (q[] etc).
3318The point should be before the starting delimiter.
3319
3320Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3321is s/// or tr/// like expression. If END is nil, generates an error
3322message if needed. If SET-ST is non-nil, will use (or generate) a
3323cached syntax table in ST-L. If ERR-L is non-nil, will store the
3324error message in its CAR (unless it already contains some error
3325message). ARGUMENT should be the name of the construct (used in error
3326messages). OSTART, OEND may be set in recursive calls when processing
3327the second argument of 2ARG construct.
3328
3329Works *before* syntax recognition is done. In IS-2ARG situation may
3330modify syntax-type text property if the situation is too hard."
3331 (let (b starter ender st i i2 go-forward reset-st set-st)
f83d2997
KH
3332 (skip-chars-forward " \t")
3333 ;; ender means matching-char matcher.
5c8b7eaf 3334 (setq b (point)
5bd52f0e
RS
3335 starter (if (eobp) 0 (char-after b))
3336 ender (cdr (assoc starter cperl-starters)))
f83d2997 3337 ;; What if starter == ?\\ ????
4ab89e7b 3338 (setq st (cperl-cached-syntax-table st-l))
f83d2997
KH
3339 (setq set-st t)
3340 ;; Whether we have an intermediate point
3341 (setq i nil)
3342 ;; Prepare the syntax table:
4ab89e7b
SM
3343 (if (not ender) ; m/blah/, s/x//, s/x/y/
3344 (modify-syntax-entry starter "$" st)
3345 (modify-syntax-entry starter (concat "(" (list ender)) st)
3346 (modify-syntax-entry ender (concat ")" (list starter)) st))
f83d2997
KH
3347 (condition-case bb
3348 (progn
5bd52f0e
RS
3349 ;; We use `$' syntax class to find matching stuff, but $$
3350 ;; is recognized the same as $, so we need to check this manually.
f83d2997
KH
3351 (if (and (eq starter (char-after (cperl-1+ b)))
3352 (not ender))
3353 ;; $ has TeXish matching rules, so $$ equiv $...
3354 (forward-char 2)
6c389151 3355 (setq reset-st (syntax-table))
f83d2997
KH
3356 (set-syntax-table st)
3357 (forward-sexp 1)
6c389151
SM
3358 (if (<= (point) (1+ b))
3359 (error "Unfinished regular expression"))
3360 (set-syntax-table reset-st)
3361 (setq reset-st nil)
f83d2997
KH
3362 ;; Now the problem is with m;blah;;
3363 (and (not ender)
3364 (eq (preceding-char)
3365 (char-after (- (point) 2)))
3366 (save-excursion
3367 (forward-char -2)
3368 (= 0 (% (skip-chars-backward "\\\\") 2)))
3369 (forward-char -1)))
5bd52f0e 3370 ;; Now we are after the first part.
f83d2997
KH
3371 (and is-2arg ; Have trailing part
3372 (not ender)
3373 (eq (following-char) starter) ; Empty trailing part
3374 (progn
3375 (or (eq (char-syntax (following-char)) ?.)
3376 ;; Make trailing letter into punctuation
3377 (cperl-modify-syntax-type (point) cperl-st-punct))
3378 (setq is-2arg nil go-forward t))) ; Ignore the tail
3379 (if is-2arg ; Not number => have second part
3380 (progn
3381 (setq i (point) i2 i)
3382 (if ender
b5b0cb34 3383 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
f83d2997
KH
3384 (progn
3385 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3386 (goto-char (match-end 0))
3387 (skip-chars-forward " \t\n\f"))
3388 (setq i2 (point))))
3389 (forward-char -1))
3390 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
5c8b7eaf 3391 (if ender (modify-syntax-entry ender "." st))
f83d2997 3392 (setq set-st nil)
4ab89e7b 3393 (setq ender (cperl-forward-re lim end nil st-l err-l
5bd52f0e 3394 argument starter ender)
8c777c8d 3395 ender (nth 2 ender)))))
f83d2997
KH
3396 (error (goto-char lim)
3397 (setq set-st nil)
6c389151
SM
3398 (if reset-st
3399 (set-syntax-table reset-st))
f83d2997 3400 (or end
8c777c8d
CY
3401 (and cperl-brace-recursing
3402 (or (eq ostart ?\{)
3403 (eq starter ?\{)))
f83d2997 3404 (message
5bd52f0e 3405 "End of `%s%s%c ... %c' string/RE not found: %s"
f83d2997
KH
3406 argument
3407 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3408 starter (or ender starter) bb)
3409 (or (car err-l) (setcar err-l b)))))
3410 (if set-st
3411 (progn
3412 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3413 (if ender (modify-syntax-entry ender "." st))))
5bd52f0e 3414 ;; i: have 2 args, after end of the first arg
e7f767c2 3415 ;; i2: start of the second arg, if any (before delim if `ender').
5bd52f0e
RS
3416 ;; ender: the last arg bounded by parens-like chars, the second one of them
3417 ;; starter: the starting delimiter of the first arg
5efe6a56 3418 ;; go-forward: has 2 args, and the second part is empty
f83d2997
KH
3419 (list i i2 ender starter go-forward)))
3420
4ab89e7b
SM
3421(defun cperl-forward-group-in-re (&optional st-l)
3422 "Find the end of a group in a REx.
3423Return the error message (if any). Does not work if delimiter is `)'.
3424Works before syntax recognition is done."
3425 ;; Works *before* syntax recognition is done
3426 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3427 (let (st b reset-st)
3428 (condition-case b
3429 (progn
3430 (setq st (cperl-cached-syntax-table st-l))
3431 (modify-syntax-entry ?\( "()" st)
3432 (modify-syntax-entry ?\) ")(" st)
3433 (setq reset-st (syntax-table))
3434 (set-syntax-table st)
3435 (forward-sexp 1))
3436 (error (message
3437 "cperl-forward-group-in-re: error %s" b)))
3438 ;; now restore the initial state
3439 (if st
3440 (progn
3441 (modify-syntax-entry ?\( "." st)
3442 (modify-syntax-entry ?\) "." st)))
3443 (if reset-st
3444 (set-syntax-table reset-st))
3445 b))
3446
3447
83261a2f
SM
3448(defvar font-lock-string-face)
3449;;(defvar font-lock-reference-face)
3450(defvar font-lock-constant-face)
5c8b7eaf 3451(defsubst cperl-postpone-fontification (b e type val &optional now)
5bd52f0e
RS
3452 ;; Do after syntactic fontification?
3453 (if cperl-syntaxify-by-font-lock
3454 (or now (put-text-property b e 'cperl-postpone (cons type val)))
83261a2f 3455 (put-text-property b e type val)))
5bd52f0e
RS
3456
3457;;; Here is how the global structures (those which cannot be
3458;;; recognized locally) are marked:
5c8b7eaf 3459;; a) PODs:
5bd52f0e
RS
3460;; Start-to-end is marked `in-pod' ==> t
3461;; Each non-literal part is marked `syntax-type' ==> `pod'
3462;; Each literal part is marked `syntax-type' ==> `in-pod'
5c8b7eaf 3463;; b) HEREs:
5bd52f0e
RS
3464;; Start-to-end is marked `here-doc-group' ==> t
3465;; The body is marked `syntax-type' ==> `here-doc'
3466;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
5c8b7eaf 3467;; c) FORMATs:
f739b53b
SM
3468;; First line (to =) marked `first-format-line' ==> t
3469;; After-this--to-end is marked `syntax-type' ==> `format'
5c8b7eaf 3470;; d) 'Q'uoted string:
5bd52f0e 3471;; part between markers inclusive is marked `syntax-type' ==> `string'
6c389151 3472;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
4ab89e7b
SM
3473;; second part of s///e is marked `syntax-type' ==> `multiline'
3474;; e) Attributes of subroutines: `attrib-group' ==> t
3475;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3476;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3477
3478;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3479;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
5bd52f0e
RS
3480
3481(defun cperl-unwind-to-safe (before &optional end)
3482 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3483 (let ((pos (point)) opos)
4ab89e7b
SM
3484 (while (and pos (progn
3485 (beginning-of-line)
3486 (get-text-property (setq pos (point)) 'syntax-type)))
3487 (setq opos pos
3488 pos (cperl-beginning-of-property pos 'syntax-type))
3489 (if (eq pos (point-min))
3490 (setq pos nil))
5bd52f0e
RS
3491 (if pos
3492 (if before
3493 (progn
3494 (goto-char (cperl-1- pos))
3495 (beginning-of-line)
3496 (setq pos (point)))
3497 (goto-char (setq pos (cperl-1- pos))))
3498 ;; Up to the start
3499 (goto-char (point-min))))
6c389151
SM
3500 ;; Skip empty lines
3501 (and (looking-at "\n*=")
3502 (/= 0 (skip-chars-backward "\n"))
3503 (forward-char))
3504 (setq pos (point))
5bd52f0e
RS
3505 (if end
3506 ;; Do the same for end, going small steps
4ab89e7b 3507 (save-excursion
5bd52f0e
RS
3508 (while (and end (get-text-property end 'syntax-type))
3509 (setq pos end
4ab89e7b
SM
3510 end (next-single-property-change end 'syntax-type nil (point-max)))
3511 (if end (progn (goto-char end)
3512 (or (bolp) (forward-line 1))
3513 (setq end (point)))))
5bd52f0e
RS
3514 (or end pos)))))
3515
4ab89e7b 3516;;; These are needed for byte-compile (at least with v19)
6c389151 3517(defvar cperl-nonoverridable-face)
4ab89e7b 3518(defvar font-lock-variable-name-face)
6c389151 3519(defvar font-lock-function-name-face)
4ab89e7b
SM
3520(defvar font-lock-keyword-face)
3521(defvar font-lock-builtin-face)
3522(defvar font-lock-type-face)
6c389151 3523(defvar font-lock-comment-face)
4ab89e7b 3524(defvar font-lock-warning-face)
6c389151 3525
4ab89e7b
SM
3526(defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3527 "Syntaxically mark (and fontify) attributes of a subroutine.
3528Should be called with the point before leading colon of an attribute."
3529 ;; Works *before* syntax recognition is done
3530 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3531 (let (st b p reset-st after-first (start (point)) start1 end1)
3532 (condition-case b
3533 (while (looking-at
3534 (concat
3535 "\\(" ; 1=optional? colon
3536 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3537 "\\)"
3538 (if after-first "?" "")
3539 ;; No space between name and paren allowed...
3540 "\\(\\sw+\\)" ; 3=name
3541 "\\((\\)?")) ; 4=optional paren
3542 (and (match-beginning 1)
3543 (cperl-postpone-fontification
3544 (match-beginning 0) (cperl-1+ (match-beginning 0))
3545 'face font-lock-constant-face))
3546 (setq start1 (match-beginning 3) end1 (match-end 3))
3547 (cperl-postpone-fontification start1 end1
3548 'face font-lock-constant-face)
3549 (goto-char end1) ; end or before `('
3550 (if (match-end 4) ; Have attribute arguments...
3551 (progn
3552 (if st nil
3553 (setq st (cperl-cached-syntax-table st-l))
3554 (modify-syntax-entry ?\( "()" st)
3555 (modify-syntax-entry ?\) ")(" st))
3556 (setq reset-st (syntax-table) p (point))
3557 (set-syntax-table st)
3558 (forward-sexp 1)
3559 (set-syntax-table reset-st)
3560 (setq reset-st nil)
3561 (cperl-commentify p (point) t))) ; mark as string
3562 (forward-comment (buffer-size))
3563 (setq after-first t))
3564 (error (message
3565 "L%d: attribute `%s': %s"
3566 (count-lines (point-min) (point))
3567 (and start1 end1 (buffer-substring start1 end1)) b)
3568 (setq start nil)))
3569 (and start
3570 (progn
3571 (put-text-property start (point)
3572 'attrib-group (if (looking-at "{") t 0))
3573 (and pos
3574 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3575 ;; Apparently, we do not need `multiline': faces added now
3576 (put-text-property (+ 3 pos) (cperl-1+ (point))
3577 'syntax-type 'sub-decl))
3578 (and b-fname ; Fontify here: the following condition
3579 (cperl-postpone-fontification ; is too hard to determine by
3580 b-fname e-fname 'face ; a REx, so do it here
3581 (if (looking-at "{")
3582 font-lock-function-name-face
3583 font-lock-variable-name-face)))))
3584 ;; now restore the initial state
3585 (if st
3586 (progn
3587 (modify-syntax-entry ?\( "." st)
3588 (modify-syntax-entry ?\) "." st)))
3589 (if reset-st
3590 (set-syntax-table reset-st))))
3591
3592(defsubst cperl-look-at-leading-count (is-x-REx e)
82d9a08d
SM
3593 (if (and
3594 (< (point) e)
3595 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3596 (1- e) t)) ; return nil on failure, no moving
4ab89e7b
SM
3597 (if (eq ?\{ (preceding-char)) nil
3598 (cperl-postpone-fontification
3599 (1- (point)) (point)
3600 'face font-lock-warning-face))))
3601
8c777c8d
CY
3602;; Do some smarter-highlighting
3603;; XXXX Currently ignores alphanum/dash delims,
3604(defsubst cperl-highlight-charclass (endbracket dashface bsface onec-space)
3605 (let ((l '(1 5 7)) ll lle lll
3606 ;; 2 groups, the first takes the whole match (include \[trnfabe])
3607 (singleChar (concat "\\(" "[^\\\\]" "\\|" "\\\\[^cdg-mo-qsu-zA-Z0-9_]" "\\|" "\\\\c." "\\|" "\\\\x" "\\([0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}\\)" "\\|" "\\\\0?[0-7][0-7]?[0-7]?" "\\|" "\\\\N{[^{}]*}" "\\)")))
3608 (while ; look for unescaped - between non-classes
3609 (re-search-forward
3610 ;; On 19.33, certain simplifications lead
3611 ;; to bugs (as in [^a-z] \\| [trnfabe] )
3612 (concat ; 1: SingleChar (include \[trnfabe])
3613 singleChar
3614 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^cdg-mo-qsu-zA-Z0-9_]" "\\|" "\\\\c." "\\|" "\\\\x" "\\([0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}\\)" "\\|" "\\\\0?[0-7][0-7]?[0-7]?" "\\|" "\\\\N{[^{}]*}" "\\)"
3615 "\\(" ; 3: DASH SingleChar (match optionally)
3616 "\\(-\\)" ; 4: DASH
3617 singleChar ; 5: SingleChar
3618 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^cdg-mo-qsu-zA-Z0-9_]" "\\|" "\\\\c." "\\|" "\\\\x" "\\([0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}\\)" "\\|" "\\\\0?[0-7][0-7]?[0-7]?" "\\|" "\\\\N{[^{}]*}" "\\)"
3619 "\\)?"
3620 "\\|"
3621 "\\(" ; 7: other escapes
3622 "\\\\[pP]" "\\([^{]\\|{[^{}]*}\\)"
3623 "\\|" "\\\\[^pP]" "\\)"
3624 )
3625 endbracket 'toend)
3626 (if (match-beginning 4)
3627 (cperl-postpone-fontification
3628 (match-beginning 4) (match-end 4)
3629 'face dashface))
3630 ;; save match data (for looking-at)
3631 (setq lll (mapcar (function (lambda (elt) (cons (match-beginning elt)
3632 (match-end elt)))) l))
3633 (while lll
3634 (setq ll (car lll))
3635 (setq lle (cdr ll)
3636 ll (car ll))
3637 ;; (message "Got %s of %s" ll l)
3638 (if (and ll (eq (char-after ll) ?\\ ))
3639 (save-excursion
3640 (goto-char ll)
3641 (cperl-postpone-fontification ll (1+ ll)
3642 'face bsface)
3643 (if (looking-at "\\\\[a-zA-Z0-9]")
3644 (cperl-postpone-fontification (1+ ll) lle
3645 'face onec-space))))
3646 (setq lll (cdr lll))))
3647 (goto-char endbracket) ; just in case something misbehaves???
3648 t))
3649
4ab89e7b
SM
3650;;; Debugging this may require (setq max-specpdl-size 2000)...
3651(defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
f83d2997 3652 "Scans the buffer for hard-to-parse Perl constructions.
5c8b7eaf
SS
3653If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3654the sections using `cperl-pod-head-face', `cperl-pod-face',
f83d2997
KH
3655`cperl-here-face'."
3656 (interactive)
05927f8c 3657 (or min (setq min (point-min)
db133cb6
RS
3658 cperl-syntax-state nil
3659 cperl-syntax-done-to min))
f83d2997 3660 (or max (setq max (point-max)))
83261a2f
SM
3661 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3662 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
4ab89e7b 3663 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
83261a2f 3664 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
af1d43f9 3665 (modified (buffer-modified-p)) overshoot is-o-REx name
83261a2f 3666 (after-change-functions nil)
4ab89e7b 3667 (cperl-font-locking t)
83261a2f
SM
3668 (use-syntax-state (and cperl-syntax-state
3669 (>= min (car cperl-syntax-state))))
3670 (state-point (if use-syntax-state
3671 (car cperl-syntax-state)
3672 (point-min)))
3673 (state (if use-syntax-state
3674 (cdr cperl-syntax-state)))
3675 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3676 (st-l (list nil)) (err-l (list nil))
3677 ;; Somehow font-lock may be not loaded yet...
4ab89e7b 3678 ;; (e.g., when building TAGS via command-line call)
83261a2f
SM
3679 (font-lock-string-face (if (boundp 'font-lock-string-face)
3680 font-lock-string-face
3681 'font-lock-string-face))
4ab89e7b 3682 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
83261a2f
SM
3683 font-lock-constant-face
3684 'font-lock-constant-face))
4ab89e7b 3685 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
83261a2f
SM
3686 (if (boundp 'font-lock-function-name-face)
3687 font-lock-function-name-face
3688 'font-lock-function-name-face))
4ab89e7b
SM
3689 (font-lock-variable-name-face ; interpolated vars and ({})-code
3690 (if (boundp 'font-lock-variable-name-face)
3691 font-lock-variable-name-face
3692 'font-lock-variable-name-face))
3693 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3694 (if (boundp 'font-lock-function-name-face)
3695 font-lock-function-name-face
3696 'font-lock-function-name-face))
3697 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3698 (if (boundp 'font-lock-constant-face)
3699 font-lock-constant-face
3700 'font-lock-constant-face))
3701 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3702 (if (boundp 'font-lock-builtin-face)
3703 font-lock-builtin-face
3704 'font-lock-builtin-face))
83261a2f
SM
3705 (font-lock-comment-face
3706 (if (boundp 'font-lock-comment-face)
3707 font-lock-comment-face
3708 'font-lock-comment-face))
4ab89e7b
SM
3709 (font-lock-warning-face
3710 (if (boundp 'font-lock-warning-face)
3711 font-lock-warning-face
3712 'font-lock-warning-face))
3713 (my-cperl-REx-ctl-face ; (|)
3714 (if (boundp 'font-lock-keyword-face)
3715 font-lock-keyword-face
3716 'font-lock-keyword-face))
3717 (my-cperl-REx-modifiers-face ; //gims
83261a2f
SM
3718 (if (boundp 'cperl-nonoverridable-face)
3719 cperl-nonoverridable-face
4ab89e7b
SM
3720 'cperl-nonoverridable-face))
3721 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3722 (if (boundp 'font-lock-type-face)
3723 font-lock-type-face
3724 'font-lock-type-face))
83261a2f
SM
3725 (stop-point (if ignore-max
3726 (point-max)
3727 max))
3728 (search
3729 (concat
4ab89e7b 3730 "\\(\\`\n?\\|^\n\\)=" ; POD
83261a2f
SM
3731 "\\|"
3732 ;; One extra () before this:
4ab89e7b 3733 "<<" ; HERE-DOC
83261a2f
SM
3734 "\\(" ; 1 + 1
3735 ;; First variant "BLAH" or just ``.
3736 "[ \t]*" ; Yes, whitespace is allowed!
3737 "\\([\"'`]\\)" ; 2 + 1 = 3
3738 "\\([^\"'`\n]*\\)" ; 3 + 1
3739 "\\3"
3740 "\\|"
f739b53b 3741 ;; Second variant: Identifier or \ID (same as 'ID') or empty
83261a2f
SM
3742 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3743 ;; Do not have <<= or << 30 or <<30 or << $blah.
3744 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3745 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3746 "\\)"
3747 "\\|"
3748 ;; 1+6 extra () before this:
4ab89e7b 3749 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
83261a2f 3750 (if cperl-use-syntax-table-text-property
db133cb6 3751 (concat
db133cb6 3752 "\\|"
83261a2f 3753 ;; 1+6+2=9 extra () before this:
4ab89e7b 3754 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
83261a2f
SM
3755 "\\|"
3756 ;; 1+6+2+1=10 extra () before this:
3757 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3758 "\\|"
4ab89e7b
SM
3759 ;; 1+6+2+1+1=11 extra () before this
3760 "\\<sub\\>" ; sub with proto/attr
3761 "\\("
3762 cperl-white-and-comment-rex
3763 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3764 "\\("
3765 cperl-maybe-white-and-comment-rex
3766 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
83261a2f 3767 "\\|"
4ab89e7b
SM
3768 ;; 1+6+2+1+1+6=17 extra () before this:
3769 "\\$\\(['{]\\)" ; $' or ${foo}
83261a2f 3770 "\\|"
4ab89e7b
SM
3771 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3772 ;; we do not support intervening comments...):
83261a2f 3773 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
4ab89e7b 3774 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
83261a2f 3775 "\\|"
4ab89e7b
SM
3776 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3777 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
db133cb6 3778 "\\|"
4ab89e7b 3779 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
83261a2f 3780 ""))))
f83d2997
KH
3781 (unwind-protect
3782 (progn
3783 (save-excursion
3784 (or non-inter
3785 (message "Scanning for \"hard\" Perl constructions..."))
4ab89e7b 3786 ;;(message "find: %s --> %s" min max)
db133cb6 3787 (and cperl-pod-here-fontify
83261a2f
SM
3788 ;; We had evals here, do not know why...
3789 (setq face cperl-pod-face
3790 head-face cperl-pod-head-face
3791 here-face cperl-here-face))
5c8b7eaf 3792 (remove-text-properties min max
5bd52f0e 3793 '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3794 attrib-group t
3795 REx-interpolated t
6c389151
SM
3796 cperl-postpone t
3797 syntax-subtype t
3798 rear-nonsticky t
4ab89e7b 3799 front-sticky t
f739b53b
SM
3800 here-doc-group t
3801 first-format-line t
4ab89e7b 3802 REx-part2 t
6c389151 3803 indentable t))
f83d2997
KH
3804 ;; Need to remove face as well...
3805 (goto-char min)
72bc50c0
GM
3806 ;; 'emx not supported by Emacs since at least 21.1.
3807 (and (featurep 'xemacs) (eq system-type 'emx)
4ab89e7b
SM
3808 (eq (point) 1)
3809 (let ((case-fold-search t))
3810 (looking-at "extproc[ \t]")) ; Analogue of #!
5c8b7eaf 3811 (cperl-commentify min
e180ab9f 3812 (point-at-eol)
db133cb6
RS
3813 nil))
3814 (while (and
3815 (< (point) max)
3816 (re-search-forward search max t))
5bd52f0e 3817 (setq tmpend nil) ; Valid for most cases
4ab89e7b
SM
3818 (setq b (match-beginning 0)
3819 state (save-excursion (parse-partial-sexp
3820 state-point b nil nil state))
3821 state-point b)
5c8b7eaf 3822 (cond
4ab89e7b
SM
3823 ;; 1+6+2+1+1+6=17 extra () before this:
3824 ;; "\\$\\(['{]\\)"
3825 ((match-beginning 18) ; $' or ${foo}
3826 (if (eq (preceding-char) ?\') ; $'
3827 (progn
3828 (setq b (1- (point))
3829 state (parse-partial-sexp
3830 state-point (1- b) nil nil state)
3831 state-point (1- b))
3832 (if (nth 3 state) ; in string
3833 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3834 (goto-char (1+ b)))
3835 ;; else: ${
3836 (setq bb (match-beginning 0))
3837 (cperl-modify-syntax-type bb cperl-st-punct)))
3838 ;; No processing in strings/comments beyond this point:
3839 ((or (nth 3 state) (nth 4 state))
3840 t) ; Do nothing in comment/string
f83d2997 3841 ((match-beginning 1) ; POD section
a1506d29 3842 ;; "\\(\\`\n?\\|^\n\\)="
4ab89e7b
SM
3843 (setq b (match-beginning 0)
3844 state (parse-partial-sexp
3845 state-point b nil nil state)
3846 state-point b)
3847 (if (or (nth 3 state) (nth 4 state)
3848 (looking-at "cut\\>"))
3849 (if (or (nth 3 state) (nth 4 state) ignore-max)
5bd52f0e 3850 nil ; Doing a chunk only
f83d2997
KH
3851 (message "=cut is not preceded by a POD section")
3852 (or (car err-l) (setcar err-l (point))))
3853 (beginning-of-line)
5c8b7eaf
SS
3854
3855 (setq b (point)
5bd52f0e
RS
3856 bb b
3857 tb (match-beginning 0)
3858 b1 nil) ; error condition
db133cb6
RS
3859 ;; We do not search to max, since we may be called from
3860 ;; some hook of fontification, and max is random
6c389151 3861 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
f83d2997 3862 (progn
6c389151
SM
3863 (goto-char b)
3864 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3865 (progn
3866 (message "=cut is not preceded by an empty line")
3867 (setq b1 t)
3868 (or (car err-l) (setcar err-l b))))))
f83d2997
KH
3869 (beginning-of-line 2) ; An empty line after =cut is not POD!
3870 (setq e (point))
db133cb6 3871 (and (> e max)
6c389151 3872 (progn
a1506d29 3873 (remove-text-properties
6c389151 3874 max e '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3875 attrib-group t
3876 REx-interpolated t
6c389151
SM
3877 cperl-postpone t
3878 syntax-subtype t
f739b53b 3879 here-doc-group t
6c389151 3880 rear-nonsticky t
4ab89e7b 3881 front-sticky t
f739b53b 3882 first-format-line t
4ab89e7b 3883 REx-part2 t
6c389151
SM
3884 indentable t))
3885 (setq tmpend tb)))
f83d2997 3886 (put-text-property b e 'in-pod t)
6c389151 3887 (put-text-property b e 'syntax-type 'in-pod)
f83d2997
KH
3888 (goto-char b)
3889 (while (re-search-forward "\n\n[ \t]" e t)
3890 ;; We start 'pod 1 char earlier to include the preceding line
3891 (beginning-of-line)
3892 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5efe6a56
SM
3893 (cperl-put-do-not-fontify b (point) t)
3894 ;; mark the non-literal parts as PODs
a1506d29 3895 (if cperl-pod-here-fontify
5efe6a56 3896 (cperl-postpone-fontification b (point) 'face face t))
f83d2997
KH
3897 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3898 (beginning-of-line)
3899 (setq b (point)))
3900 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5efe6a56 3901 (cperl-put-do-not-fontify (point) e t)
a1506d29
JB
3902 (if cperl-pod-here-fontify
3903 (progn
5efe6a56
SM
3904 ;; mark the non-literal parts as PODs
3905 (cperl-postpone-fontification (point) e 'face face t)
3906 (goto-char bb)
a1506d29 3907 (if (looking-at
5efe6a56
SM
3908 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3909 ;; mark the headers
a1506d29 3910 (cperl-postpone-fontification
5efe6a56 3911 (match-beginning 1) (match-end 1)
6c389151
SM
3912 'face head-face))
3913 (while (re-search-forward
3914 ;; One paragraph
3915 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3916 e 'toend)
3917 ;; mark the headers
a1506d29 3918 (cperl-postpone-fontification
5efe6a56
SM
3919 (match-beginning 1) (match-end 1)
3920 'face head-face))))
f83d2997
KH
3921 (cperl-commentify bb e nil)
3922 (goto-char e)
3923 (or (eq e (point-max))
83261a2f 3924 (forward-char -1)))) ; Prepare for immediate POD start.
f83d2997 3925 ;; Here document
4ab89e7b
SM
3926 ;; We can do many here-per-line;
3927 ;; but multiline quote on the same line as <<HERE confuses us...
5bd52f0e 3928 ;; ;; One extra () before this:
5c8b7eaf 3929 ;;"<<"
5bd52f0e
RS
3930 ;; "\\(" ; 1 + 1
3931 ;; ;; First variant "BLAH" or just ``.
f739b53b 3932 ;; "[ \t]*" ; Yes, whitespace is allowed!
5bd52f0e
RS
3933 ;; "\\([\"'`]\\)" ; 2 + 1
3934 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3935 ;; "\\3"
3936 ;; "\\|"
3937 ;; ;; Second variant: Identifier or \ID or empty
3938 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3939 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3940 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3941 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3942 ;; "\\)"
f83d2997 3943 ((match-beginning 2) ; 1 + 1
4ab89e7b 3944 (setq b (point)
5bd52f0e 3945 tb (match-beginning 0)
4ab89e7b
SM
3946 c (and ; not HERE-DOC
3947 (match-beginning 5)
3948 (save-match-data
3949 (or (looking-at "[ \t]*(") ; << function_call()
3950 (save-excursion ; 1 << func_name, or $foo << 10
3951 (condition-case nil
3952 (progn
3953 (goto-char tb)
3954 ;;; XXX What to do: foo <<bar ???
3955 ;;; XXX Need to support print {a} <<B ???
3956 (forward-sexp -1)
cb5bf6ba 3957 (save-match-data
4ab89e7b
SM
3958 ; $foo << b; $f .= <<B;
3959 ; ($f+1) << b; a($f) . <<B;
3960 ; foo 1, <<B; $x{a} <<b;
3961 (cond
3962 ((looking-at "[0-9$({]")
3963 (forward-sexp 1)
3964 (and
3965 (looking-at "[ \t]*<<")
3966 (condition-case nil
3967 ;; print $foo <<EOF
3968 (progn
3969 (forward-sexp -2)
3970 (not
3971 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
3972 (error t)))))))
3973 (error nil))) ; func(<<EOF)
3974 (and (not (match-beginning 6)) ; Empty
3975 (looking-at
3976 "[ \t]*[=0-9$@%&(]"))))))
5bd52f0e
RS
3977 (if c ; Not here-doc
3978 nil ; Skip it.
4ab89e7b 3979 (setq c (match-end 2)) ; 1 + 1
f83d2997
KH
3980 (if (match-beginning 5) ;4 + 1
3981 (setq b1 (match-beginning 5) ; 4 + 1
3982 e1 (match-end 5)) ; 4 + 1
3983 (setq b1 (match-beginning 4) ; 3 + 1
3984 e1 (match-end 4))) ; 3 + 1
3985 (setq tag (buffer-substring b1 e1)
3986 qtag (regexp-quote tag))
5c8b7eaf 3987 (cond (cperl-pod-here-fontify
5bd52f0e 3988 ;; Highlight the starting delimiter
cb5bf6ba 3989 (cperl-postpone-fontification
4ab89e7b 3990 b1 e1 'face my-cperl-delimiters-face)
5bd52f0e 3991 (cperl-put-do-not-fontify b1 e1 t)))
f83d2997 3992 (forward-line)
4ab89e7b
SM
3993 (setq i (point))
3994 (if end-of-here-doc
3995 (goto-char end-of-here-doc))
f83d2997 3996 (setq b (point))
db133cb6
RS
3997 ;; We do not search to max, since we may be called from
3998 ;; some hook of fontification, and max is random
f739b53b
SM
3999 (or (and (re-search-forward (concat "^" qtag "$")
4000 stop-point 'toend)
4ab89e7b
SM
4001 ;;;(eq (following-char) ?\n) ; XXXX WHY???
4002 )
f739b53b
SM
4003 (progn ; Pretend we matched at the end
4004 (goto-char (point-max))
4005 (re-search-forward "\\'")
4006 (message "End of here-document `%s' not found." tag)
4007 (or (car err-l) (setcar err-l b))))
4008 (if cperl-pod-here-fontify
4009 (progn
4010 ;; Highlight the ending delimiter
4ab89e7b
SM
4011 (cperl-postpone-fontification
4012 (match-beginning 0) (match-end 0)
4013 'face my-cperl-delimiters-face)
f739b53b
SM
4014 (cperl-put-do-not-fontify b (match-end 0) t)
4015 ;; Highlight the HERE-DOC
4016 (cperl-postpone-fontification b (match-beginning 0)
4017 'face here-face)))
4018 (setq e1 (cperl-1+ (match-end 0)))
4019 (put-text-property b (match-beginning 0)
4020 'syntax-type 'here-doc)
4021 (put-text-property (match-beginning 0) e1
4022 'syntax-type 'here-doc-delim)
4ab89e7b
SM
4023 (put-text-property b e1 'here-doc-group t)
4024 ;; This makes insertion at the start of HERE-DOC update
4025 ;; the whole construct:
4026 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
f739b53b
SM
4027 (cperl-commentify b e1 nil)
4028 (cperl-put-do-not-fontify b (match-end 0) t)
4ab89e7b
SM
4029 ;; Cache the syntax info...
4030 (setq cperl-syntax-state (cons state-point state))
4031 ;; ... and process the rest of the line...
4032 (setq overshoot
4033 (elt ; non-inter ignore-max
4034 (cperl-find-pods-heres c i t end t e1) 1))
4035 (if (and overshoot (> overshoot (point)))
4036 (goto-char overshoot)
4037 (setq overshoot e1))
f739b53b
SM
4038 (if (> e1 max)
4039 (setq tmpend tb))))
f83d2997
KH
4040 ;; format
4041 ((match-beginning 8)
4042 ;; 1+6=7 extra () before this:
4043 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4044 (setq b (point)
4045 name (if (match-beginning 8) ; 7 + 1
4046 (buffer-substring (match-beginning 8) ; 7 + 1
4047 (match-end 8)) ; 7 + 1
5bd52f0e
RS
4048 "")
4049 tb (match-beginning 0))
f83d2997 4050 (setq argument nil)
9b026d9f 4051 (put-text-property (point-at-bol) b 'first-format-line 't)
5c8b7eaf 4052 (if cperl-pod-here-fontify
f83d2997
KH
4053 (while (and (eq (forward-line) 0)
4054 (not (looking-at "^[.;]$")))
4055 (cond
4056 ((looking-at "^#")) ; Skip comments
4057 ((and argument ; Skip argument multi-lines
5c8b7eaf 4058 (looking-at "^[ \t]*{"))
f83d2997
KH
4059 (forward-sexp 1)
4060 (setq argument nil))
4061 (argument ; Skip argument lines
4062 (setq argument nil))
4063 (t ; Format line
4064 (setq b1 (point))
4065 (setq argument (looking-at "^[^\n]*[@^]"))
4066 (end-of-line)
5bd52f0e 4067 ;; Highlight the format line
5c8b7eaf 4068 (cperl-postpone-fontification b1 (point)
83261a2f 4069 'face font-lock-string-face)
f83d2997 4070 (cperl-commentify b1 (point) nil)
5bd52f0e 4071 (cperl-put-do-not-fontify b1 (point) t))))
db133cb6
RS
4072 ;; We do not search to max, since we may be called from
4073 ;; some hook of fontification, and max is random
4074 (re-search-forward "^[.;]$" stop-point 'toend))
f83d2997 4075 (beginning-of-line)
83261a2f 4076 (if (looking-at "^\\.$") ; ";" is not supported yet
f83d2997 4077 (progn
5bd52f0e
RS
4078 ;; Highlight the ending delimiter
4079 (cperl-postpone-fontification (point) (+ (point) 2)
83261a2f 4080 'face font-lock-string-face)
f83d2997 4081 (cperl-commentify (point) (+ (point) 2) nil)
5bd52f0e 4082 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
f83d2997
KH
4083 (message "End of format `%s' not found." name)
4084 (or (car err-l) (setcar err-l b)))
4085 (forward-line)
5bd52f0e
RS
4086 (if (> (point) max)
4087 (setq tmpend tb))
db133cb6 4088 (put-text-property b (point) 'syntax-type 'format))
4ab89e7b 4089 ;; qq-like String or Regexp:
f83d2997
KH
4090 ((or (match-beginning 10) (match-beginning 11))
4091 ;; 1+6+2=9 extra () before this:
5bd52f0e 4092 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
f83d2997 4093 ;; "\\|"
5bd52f0e 4094 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
f83d2997
KH
4095 (setq b1 (if (match-beginning 10) 10 11)
4096 argument (buffer-substring
4097 (match-beginning b1) (match-end b1))
4ab89e7b 4098 b (point) ; end of qq etc
f83d2997
KH
4099 i b
4100 c (char-after (match-beginning b1))
4ab89e7b 4101 bb (char-after (1- (match-beginning b1))) ; tmp holder
5bd52f0e
RS
4102 ;; bb == "Not a stringy"
4103 bb (if (eq b1 10) ; user variables/whatever
f739b53b
SM
4104 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4105 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4106 ((eq bb ?\:) ; $opt::s
4107 (eq (char-after
4108 (- (match-beginning b1) 2))
4109 ?\:))
4110 ((eq bb ?\>) ; $foo->s
4111 (eq (char-after
4112 (- (match-beginning b1) 2))
4113 ?\-))
4114 ((eq bb ?\&)
4ab89e7b 4115 (not (eq (char-after ; &&m/blah/
f739b53b
SM
4116 (- (match-beginning b1) 2))
4117 ?\&)))
4118 (t t)))
5bd52f0e
RS
4119 ;; <file> or <$file>
4120 (and (eq c ?\<)
6c389151 4121 ;; Do not stringify <FH>, <$fh> :
5bd52f0e 4122 (save-match-data
5c8b7eaf 4123 (looking-at
6c389151 4124 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
5bd52f0e 4125 tb (match-beginning 0))
db133cb6
RS
4126 (goto-char (match-beginning b1))
4127 (cperl-backward-to-noncomment (point-min))
f83d2997 4128 (or bb
5bd52f0e 4129 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
f83d2997 4130 (setq argument ""
f739b53b 4131 b1 nil
db133cb6 4132 bb ; Not a regexp?
4ab89e7b
SM
4133 (not
4134 ;; What is below: regexp-p?
4135 (and
4136 (or (memq (preceding-char)
4137 (append (if (memq c '(?\? ?\<))
4138 ;; $a++ ? 1 : 2
4139 "~{(=|&*!,;:["
4140 "~{(=|&+-*!,;:[") nil))
4141 (and (eq (preceding-char) ?\})
4142 (cperl-after-block-p (point-min)))
4143 (and (eq (char-syntax (preceding-char)) ?w)
4144 (progn
4145 (forward-sexp -1)
6c389151
SM
4146;; After these keywords `/' starts a RE. One should add all the
4147;; functions/builtins which expect an argument, but ...
4ab89e7b
SM
4148 (if (eq (preceding-char) ?-)
4149 ;; -d ?foo? is a RE
4150 (looking-at "[a-zA-Z]\\>")
4151 (and
4152 (not (memq (preceding-char)
4153 '(?$ ?@ ?& ?%)))
4154 (looking-at
4155 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4156 (and (eq (preceding-char) ?.)
4157 (eq (char-after (- (point) 2)) ?.))
4158 (bobp))
4159 ;; m|blah| ? foo : bar;
4160 (not
4161 (and (eq c ?\?)
4162 cperl-use-syntax-table-text-property
4163 (not (bobp))
4164 (progn
4165 (forward-char -1)
4166 (looking-at "\\s|"))))))
db133cb6
RS
4167 b (1- b))
4168 ;; s y tr m
f739b53b
SM
4169 ;; Check for $a -> y
4170 (setq b1 (preceding-char)
4171 go (point))
4172 (if (and (eq b1 ?>)
4173 (eq (char-after (- go 2)) ?-))
db133cb6
RS
4174 ;; Not a regexp
4175 (setq bb t))))
f739b53b
SM
4176 (or bb
4177 (progn
4ab89e7b 4178 (goto-char b)
f739b53b
SM
4179 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4180 (goto-char (match-end 0))
4181 (skip-chars-forward " \t\n\f"))
4182 (cond ((and (eq (following-char) ?\})
4183 (eq b1 ?\{))
4184 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4185 (goto-char (1- go))
4186 (skip-chars-backward " \t\n\f")
4187 (if (memq (preceding-char) (append "$@%&*" nil))
4188 (setq bb t) ; @{y}
4189 (condition-case nil
4190 (forward-sexp -1)
4191 (error nil)))
4192 (if (or bb
4193 (looking-at ; $foo -> {s}
4194 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4195 (and ; $foo[12] -> {s}
4196 (memq (following-char) '(?\{ ?\[))
4197 (progn
4198 (forward-sexp 1)
4199 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4200 (setq bb t)
4201 (goto-char b)))
4202 ((and (eq (following-char) ?=)
4203 (eq (char-after (1+ (point))) ?\>))
4204 ;; Check for { foo => 1, s => 2 }
4205 ;; Apparently s=> is never a substitution...
4206 (setq bb t))
4207 ((and (eq (following-char) ?:)
4208 (eq b1 ?\{) ; Check for $ { s::bar }
4209 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
15ca5699 4210 (progn
f739b53b
SM
4211 (goto-char (1- go))
4212 (skip-chars-backward " \t\n\f")
4213 (memq (preceding-char)
4214 (append "$@%&*" nil))))
4ab89e7b
SM
4215 (setq bb t))
4216 ((eobp)
f739b53b
SM
4217 (setq bb t)))))
4218 (if bb
f83d2997 4219 (goto-char i)
6c389151 4220 ;; Skip whitespace and comments...
f83d2997
KH
4221 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4222 (goto-char (match-end 0))
4223 (skip-chars-forward " \t\n\f"))
6c389151
SM
4224 (if (> (point) b)
4225 (put-text-property b (point) 'syntax-type 'prestring))
f83d2997
KH
4226 ;; qtag means two-arg matcher, may be reset to
4227 ;; 2 or 3 later if some special quoting is needed.
4228 ;; e1 means matching-char matcher.
4ab89e7b 4229 (setq b (point) ; before the first delimiter
5bd52f0e
RS
4230 ;; has 2 args
4231 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
db133cb6
RS
4232 ;; We do not search to max, since we may be called from
4233 ;; some hook of fontification, and max is random
4234 i (cperl-forward-re stop-point end
5bd52f0e 4235 i2
4ab89e7b
SM
4236 st-l err-l argument)
4237 ;; If `go', then it is considered as 1-arg, `b1' is nil
4238 ;; as in s/foo//x; the point is before final "slash"
5bd52f0e 4239 b1 (nth 1 i) ; start of the second part
5c8b7eaf 4240 tag (nth 2 i) ; ender-char, true if second part
5bd52f0e 4241 ; is with matching chars []
f83d2997
KH
4242 go (nth 4 i) ; There is a 1-char part after the end
4243 i (car i) ; intermediate point
5c8b7eaf 4244 e1 (point) ; end
5bd52f0e 4245 ;; Before end of the second part if non-matching: ///
5c8b7eaf 4246 tail (if (and i (not tag))
5bd52f0e
RS
4247 (1- e1))
4248 e (if i i e1) ; end of the first part
6c389151 4249 qtag nil ; need to preserve backslashitis
4ab89e7b
SM
4250 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4251 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
f83d2997
KH
4252 ;; Commenting \\ is dangerous, what about ( ?
4253 (and i tail
4254 (eq (char-after i) ?\\)
5bd52f0e 4255 (setq qtag t))
4ab89e7b
SM
4256 (and (if go (looking-at ".\\sw*x")
4257 (looking-at "\\sw*x")) ; qr//x
4258 (setq is-x-REx t))
4259 (and (if go (looking-at ".\\sw*o")
4260 (looking-at "\\sw*o")) ; //o
4261 (setq is-o-REx t))
f83d2997 4262 (if (null i)
5bd52f0e 4263 ;; Considered as 1arg form
f83d2997
KH
4264 (progn
4265 (cperl-commentify b (point) t)
5bd52f0e 4266 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4267 (if (or is-x-REx
4268 ;; ignore other text properties:
4269 (string-match "^qw$" argument))
4270 (put-text-property b (point) 'indentable t))
5bd52f0e
RS
4271 (and go
4272 (setq e1 (cperl-1+ e1))
4273 (or (eobp)
4274 (forward-char 1))))
f83d2997
KH
4275 (cperl-commentify b i t)
4276 (if (looking-at "\\sw*e") ; s///e
4277 (progn
4ab89e7b
SM
4278 ;; Cache the syntax info...
4279 (setq cperl-syntax-state (cons state-point state))
f83d2997
KH
4280 (and
4281 ;; silent:
4ab89e7b 4282 (car (cperl-find-pods-heres b1 (1- (point)) t end))
f83d2997
KH
4283 ;; Error
4284 (goto-char (1+ max)))
5bd52f0e 4285 (if (and tag (eq (preceding-char) ?\>))
f83d2997
KH
4286 (progn
4287 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5bd52f0e 4288 (cperl-modify-syntax-type i cperl-st-bra)))
6c389151 4289 (put-text-property b i 'syntax-type 'string)
4ab89e7b 4290 (put-text-property i (point) 'syntax-type 'multiline)
6c389151
SM
4291 (if is-x-REx
4292 (put-text-property b i 'indentable t)))
5bd52f0e
RS
4293 (cperl-commentify b1 (point) t)
4294 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4295 (if is-x-REx
4296 (put-text-property b i 'indentable t))
5bd52f0e 4297 (if qtag
db133cb6 4298 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
f83d2997 4299 (setq tail nil)))
5bd52f0e 4300 ;; Now: tail: if the second part is non-matching without ///e
f83d2997
KH
4301 (if (eq (char-syntax (following-char)) ?w)
4302 (progn
4303 (forward-word 1) ; skip modifiers s///s
5bd52f0e 4304 (if tail (cperl-commentify tail (point) t))
a1506d29 4305 (cperl-postpone-fontification
4ab89e7b 4306 e1 (point) 'face my-cperl-REx-modifiers-face)))
5bd52f0e
RS
4307 ;; Check whether it is m// which means "previous match"
4308 ;; and highlight differently
a1506d29 4309 (setq is-REx
6c389151
SM
4310 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4311 (or (not (= (length argument) 0))
4312 (not (eq c ?\<)))))
a1506d29 4313 (if (and is-REx
6c389151 4314 (eq e (+ 2 b))
5bd52f0e
RS
4315 ;; split // *is* using zero-pattern
4316 (save-excursion
4317 (condition-case nil
4318 (progn
4319 (goto-char tb)
4320 (forward-sexp -1)
4321 (not (looking-at "split\\>")))
4322 (error t))))
5c8b7eaf 4323 (cperl-postpone-fontification
4ab89e7b 4324 b e 'face font-lock-warning-face)
5bd52f0e
RS
4325 (if (or i2 ; Has 2 args
4326 (and cperl-fontify-m-as-s
4327 (or
4328 (string-match "^\\(m\\|qr\\)$" argument)
4329 (and (eq 0 (length argument))
4330 (not (eq ?\< (char-after b)))))))
4331 (progn
5c8b7eaf 4332 (cperl-postpone-fontification
4ab89e7b 4333 b (cperl-1+ b) 'face my-cperl-delimiters-face)
5c8b7eaf 4334 (cperl-postpone-fontification
4ab89e7b 4335 (1- e) e 'face my-cperl-delimiters-face)))
6c389151 4336 (if (and is-REx cperl-regexp-scan)
4ab89e7b
SM
4337 ;; Process RExen: embedded comments, charclasses and ]
4338;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4339;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4340;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4341;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4342;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4343;;;m^a[\^b]c^ + m.a[^b]\.c.;
6c389151
SM
4344 (save-excursion
4345 (goto-char (1+ b))
cb5bf6ba 4346 ;; First
4ab89e7b
SM
4347 (cperl-look-at-leading-count is-x-REx e)
4348 (setq hairy-RE
4349 (concat
4350 (if is-x-REx
4351 (if (eq (char-after b) ?\#)
4352 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4353 "\\((\\?#\\)\\|\\(#\\)")
4354 ;; keep the same count: add a fake group
4355 (if (eq (char-after b) ?\#)
4356 "\\((\\?\\\\#\\)\\(\\)"
4357 "\\((\\?#\\)\\(\\)"))
4358 "\\|"
4359 "\\(\\[\\)" ; 3=[
4360 "\\|"
4361 "\\(]\\)" ; 4=]
4362 "\\|"
4363 ;; XXXX Will not be able to use it in s)))
4364 (if (eq (char-after b) ?\) )
4365 "\\())))\\)" ; Will never match
4366 (if (eq (char-after b) ?? )
4367 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4368 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4369 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4370 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4371 "\\(" ;; XXXX 1-char variables, exc. |()\s
4372 "[$@]"
4373 "\\("
4374 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4375 "\\|"
4376 "{[^{}]*}" ; only one-level allowed
4377 "\\|"
4378 "[^{(|) \t\r\n\f]"
4379 "\\)"
4380 "\\(" ;;8,9:code part of array/hash elt
4381 "\\(" "->" "\\)?"
4382 "\\[[^][]*\\]"
4383 "\\|"
4384 "{[^{}]*}"
4385 "\\)*"
4386 ;; XXXX: what if u is delim?
4387 "\\|"
4388 "[)^|$.*?+]"
4389 "\\|"
4390 "{[0-9]+}"
4391 "\\|"
4392 "{[0-9]+,[0-9]*}"
4393 "\\|"
4394 "\\\\[luLUEQbBAzZG]"
4395 "\\|"
4396 "(" ; Group opener
4397 "\\(" ; 10 group opener follower
4398 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4399 "\\|"
4400 "\\?[:=!>?{]" ; "?" something
4401 "\\|"
4402 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4403 "\\|"
4404 "\\?([0-9]+)" ; (?(1)foo|bar)
4405 "\\|"
4406 "\\?<[=!]"
4407 ;;;"\\|"
4408 ;;; "\\?"
4409 "\\)?"
4410 "\\)"
4411 "\\|"
4412 "\\\\\\(.\\)" ; 12=\SYMBOL
4413 ))
6c389151 4414 (while
4ab89e7b
SM
4415 (and (< (point) (1- e))
4416 (re-search-forward hairy-RE (1- e) 'to-end))
6c389151 4417 (goto-char (match-beginning 0))
4ab89e7b
SM
4418 (setq REx-subgr-start (point)
4419 was-subgr (following-char))
4420 (cond
4421 ((match-beginning 6) ; 0-length builtins, groups
4422 (goto-char (match-end 0))
4423 (if (match-beginning 11)
4424 (goto-char (match-beginning 11)))
4425 (if (>= (point) e)
4426 (goto-char (1- e)))
4427 (cperl-postpone-fontification
4428 (match-beginning 0) (point)
4429 'face
4430 (cond
4431 ((eq was-subgr ?\) )
4432 (condition-case nil
4433 (save-excursion
4434 (forward-sexp -1)
4435 (if (> (point) b)
4436 (if (if (eq (char-after b) ?? )
4437 (looking-at "(\\\\\\?")
4438 (eq (char-after (1+ (point))) ?\?))
4439 my-cperl-REx-0length-face
4440 my-cperl-REx-ctl-face)
4441 font-lock-warning-face))
4442 (error font-lock-warning-face)))
4443 ((eq was-subgr ?\| )
4444 my-cperl-REx-ctl-face)
4445 ((eq was-subgr ?\$ )
4446 (if (> (point) (1+ REx-subgr-start))
4447 (progn
4448 (put-text-property
4449 (match-beginning 0) (point)
4450 'REx-interpolated
4451 (if is-o-REx 0
4452 (if (and (eq (match-beginning 0)
4453 (1+ b))
4454 (eq (point)
4455 (1- e))) 1 t)))
4456 font-lock-variable-name-face)
4457 my-cperl-REx-spec-char-face))
4458 ((memq was-subgr (append "^." nil) )
4459 my-cperl-REx-spec-char-face)
4460 ((eq was-subgr ?\( )
4461 (if (not (match-beginning 10))
4462 my-cperl-REx-ctl-face
4463 my-cperl-REx-0length-face))
4464 (t my-cperl-REx-0length-face)))
4465 (if (and (memq was-subgr (append "(|" nil))
4466 (not (string-match "(\\?[-imsx]+)"
4467 (match-string 0))))
4468 (cperl-look-at-leading-count is-x-REx e))
4469 (setq was-subgr nil)) ; We do stuff here
4470 ((match-beginning 12) ; \SYMBOL
4471 (forward-char 2)
4472 (if (>= (point) e)
4473 (goto-char (1- e))
4474 ;; How many chars to not highlight:
4475 ;; 0-len special-alnums in other branch =>
4476 ;; Generic: \non-alnum (1), \alnum (1+face)
4477 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4478 (setq REx-subgr-start (point)
4479 qtag (preceding-char))
4480 (cperl-postpone-fontification
4481 (- (point) 2) (- (point) 1) 'face
4482 (if (memq qtag
4483 (append "ghijkmoqvFHIJKMORTVY" nil))
4484 font-lock-warning-face
4485 my-cperl-REx-0length-face))
4486 (if (and (eq (char-after b) qtag)
4487 (memq qtag (append ".])^$|*?+" nil)))
4488 (progn
4489 (if (and cperl-use-syntax-table-text-property
4490 (eq qtag ?\) ))
4491 (put-text-property
4492 REx-subgr-start (1- (point))
4493 'syntax-table cperl-st-punct))
4494 (cperl-postpone-fontification
4495 (1- (point)) (point) 'face
4496 ; \] can't appear below
4497 (if (memq qtag (append ".]^$" nil))
4498 'my-cperl-REx-spec-char-face
4499 (if (memq qtag (append "*?+" nil))
4500 'my-cperl-REx-0length-face
4501 'my-cperl-REx-ctl-face))))) ; )|
4502 ;; Test for arguments:
4503 (cond
4504 ;; This is not pretty: the 5.8.7 logic:
4505 ;; \0numx -> octal (up to total 3 dig)
4506 ;; \DIGIT -> backref unless \0
cb5bf6ba 4507 ;; \DIGITs -> backref if valid
4ab89e7b
SM
4508 ;; otherwise up to 3 -> octal
4509 ;; Do not try to distinguish, we guess
4510 ((or (and (memq qtag (append "01234567" nil))
4511 (re-search-forward
4512 "\\=[01234567]?[01234567]?"
4513 (1- e) 'to-end))
4514 (and (memq qtag (append "89" nil))
cb5bf6ba 4515 (re-search-forward
4ab89e7b
SM
4516 "\\=[0123456789]*" (1- e) 'to-end))
4517 (and (eq qtag ?x)
4518 (re-search-forward
4519 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4520 (1- e) 'to-end))
4521 (and (memq qtag (append "pPN" nil))
4522 (re-search-forward "\\={[^{}]+}\\|."
4523 (1- e) 'to-end))
4524 (eq (char-syntax qtag) ?w))
4525 (cperl-postpone-fontification
4526 (1- REx-subgr-start) (point)
4527 'face my-cperl-REx-length1-face))))
4528 (setq was-subgr nil)) ; We do stuff here
4529 ((match-beginning 3) ; [charclass]
8c777c8d 4530 ;; Highlight leader, trailer, POSIX classes
4ab89e7b
SM
4531 (forward-char 1)
4532 (if (eq (char-after b) ?^ )
4533 (and (eq (following-char) ?\\ )
4534 (eq (char-after (cperl-1+ (point)))
4535 ?^ )
4536 (forward-char 2))
4537 (and (eq (following-char) ?^ )
4538 (forward-char 1)))
8c777c8d 4539 (setq argument b ; continue? & end of last POSIX
4ab89e7b 4540 tag nil ; list of POSIX classes
8c777c8d 4541 qtag (point)) ; after leading ^ if present
4ab89e7b
SM
4542 (if (eq (char-after b) ?\] )
4543 (and (eq (following-char) ?\\ )
4544 (eq (char-after (cperl-1+ (point)))
4545 ?\] )
4546 (setq qtag (1+ qtag))
4547 (forward-char 2))
4548 (and (eq (following-char) ?\] )
4549 (forward-char 1)))
8c777c8d 4550 (setq REx-subgr-end qtag) ;EndOf smart-highlighed
4ab89e7b
SM
4551 ;; Apparently, I can't put \] into a charclass
4552 ;; in m]]: m][\\\]\]] produces [\\]]
4553;;; POSIX? [:word:] [:^word:] only inside []
8c777c8d
CY
4554;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4555 (while ; look for unescaped ]
4ab89e7b
SM
4556 (and argument
4557 (re-search-forward
4558 (if (eq (char-after b) ?\] )
4559 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4560 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4561 (1- e) 'toend))
4562 ;; Is this ] an end of POSIX class?
4563 (if (save-excursion
4564 (and
4565 (search-backward "[" argument t)
4566 (< REx-subgr-start (point))
8c777c8d
CY
4567 (setq argument (point)) ; POSIX-start
4568 (or ; Should work with delim = \
4569 (not (eq (preceding-char) ?\\ ))
4570 ;; XXXX Double \\ is needed with 19.33
4571 (= (% (skip-chars-backward "\\\\") 2) 0))
4ab89e7b
SM
4572 (looking-at
4573 (cond
4574 ((eq (char-after b) ?\] )
4575 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4576 ((eq (char-after b) ?\: )
4577 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4578 ((eq (char-after b) ?^ )
4579 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
4580 ((eq (char-syntax (char-after b))
4581 ?w)
4582 (concat
4583 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4584 (char-to-string (char-after b))
4585 "\\|\\sw\\)+:\]"))
4586 (t "\\\\*\\[:\\^?\\sw*:]")))
8c777c8d
CY
4587 (goto-char REx-subgr-end)
4588 (cperl-highlight-charclass
4589 argument my-cperl-REx-spec-char-face
4590 my-cperl-REx-0length-face my-cperl-REx-length1-face)))
4ab89e7b
SM
4591 (setq tag (cons (cons argument (point))
4592 tag)
8c777c8d
CY
4593 argument (point)
4594 REx-subgr-end argument) ; continue
4ab89e7b
SM
4595 (setq argument nil)))
4596 (and argument
4597 (message "Couldn't find end of charclass in a REx, pos=%s"
4598 REx-subgr-start))
8c777c8d
CY
4599 (setq argument (1- (point)))
4600 (goto-char REx-subgr-end)
4601 (cperl-highlight-charclass
4602 argument my-cperl-REx-spec-char-face
4603 my-cperl-REx-0length-face my-cperl-REx-length1-face)
4604 (forward-char 1)
4605 ;; Highlight starter, trailer, POSIX
4ab89e7b
SM
4606 (if (and cperl-use-syntax-table-text-property
4607 (> (- (point) 2) REx-subgr-start))
4608 (put-text-property
4609 (1+ REx-subgr-start) (1- (point))
4610 'syntax-table cperl-st-punct))
4611 (cperl-postpone-fontification
4612 REx-subgr-start qtag
4613 'face my-cperl-REx-spec-char-face)
4614 (cperl-postpone-fontification
4615 (1- (point)) (point) 'face
4616 my-cperl-REx-spec-char-face)
4617 (if (eq (char-after b) ?\] )
4618 (cperl-postpone-fontification
4619 (- (point) 2) (1- (point))
4620 'face my-cperl-REx-0length-face))
4621 (while tag
4622 (cperl-postpone-fontification
4623 (car (car tag)) (cdr (car tag))
8c777c8d 4624 'face font-lock-variable-name-face) ;my-cperl-REx-length1-face
4ab89e7b
SM
4625 (setq tag (cdr tag)))
4626 (setq was-subgr nil)) ; did facing already
4627 ;; Now rare stuff:
4628 ((and (match-beginning 2) ; #-comment
4629 (/= (match-beginning 2) (match-end 2)))
4630 (beginning-of-line 2)
4631 (if (> (point) e)
4632 (goto-char (1- e))))
4633 ((match-beginning 4) ; character "]"
4634 (setq was-subgr nil) ; We do stuff here
4635 (goto-char (match-end 0))
4636 (if cperl-use-syntax-table-text-property
4637 (put-text-property
4638 (1- (point)) (point)
4639 'syntax-table cperl-st-punct))
4640 (cperl-postpone-fontification
4641 (1- (point)) (point)
4642 'face font-lock-warning-face))
4643 ((match-beginning 5) ; before (?{}) (??{})
4644 (setq tag (match-end 0))
4645 (if (or (setq qtag
4646 (cperl-forward-group-in-re st-l))
4647 (and (>= (point) e)
4648 (setq qtag "no matching `)' found"))
4649 (and (not (eq (char-after (- (point) 2))
4650 ?\} ))
4651 (setq qtag "Can't find })")))
a1506d29 4652 (progn
4ab89e7b 4653 (goto-char (1- e))
274f1353 4654 (message "%s" qtag))
4ab89e7b
SM
4655 (cperl-postpone-fontification
4656 (1- tag) (1- (point))
4657 'face font-lock-variable-name-face)
4658 (cperl-postpone-fontification
4659 REx-subgr-start (1- tag)
4660 'face my-cperl-REx-spec-char-face)
4661 (cperl-postpone-fontification
4662 (1- (point)) (point)
4663 'face my-cperl-REx-spec-char-face)
4664 (if cperl-use-syntax-table-text-property
4665 (progn
4666 (put-text-property
4667 (- (point) 2) (1- (point))
4668 'syntax-table cperl-st-cfence)
4669 (put-text-property
4670 (+ REx-subgr-start 2)
4671 (+ REx-subgr-start 3)
4672 'syntax-table cperl-st-cfence))))
4673 (setq was-subgr nil))
4674 (t ; (?#)-comment
4675 ;; Inside "(" and "\" arn't special in any way
4676 ;; Works also if the outside delimiters are ().
4677 (or;;(if (eq (char-after b) ?\) )
4678 ;;(re-search-forward
4679 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4680 ;; (1- e) 'toend)
4681 (search-forward ")" (1- e) 'toend)
4682 ;;)
4683 (message
4684 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4685 REx-subgr-start))))
6c389151
SM
4686 (if (>= (point) e)
4687 (goto-char (1- e)))
4ab89e7b
SM
4688 (cond
4689 (was-subgr
4690 (setq REx-subgr-end (point))
4691 (cperl-commentify
4692 REx-subgr-start REx-subgr-end nil)
4693 (cperl-postpone-fontification
4694 REx-subgr-start REx-subgr-end
4695 'face font-lock-comment-face))))))
6c389151 4696 (if (and is-REx is-x-REx)
a1506d29 4697 (put-text-property (1+ b) (1- e)
6c389151 4698 'syntax-subtype 'x-REx)))
8c777c8d 4699 (if (and i2 e1 (or (not b1) (> e1 b1)))
82d9a08d 4700 (progn ; No errors finding the second part...
5c8b7eaf 4701 (cperl-postpone-fontification
4ab89e7b 4702 (1- e1) e1 'face my-cperl-delimiters-face)
05927f8c
VJL
4703 (if (and (not (eobp))
4704 (assoc (char-after b) cperl-starters))
4ab89e7b
SM
4705 (progn
4706 (cperl-postpone-fontification
4707 b1 (1+ b1) 'face my-cperl-delimiters-face)
4708 (put-text-property b1 (1+ b1)
4709 'REx-part2 t)))))
5bd52f0e
RS
4710 (if (> (point) max)
4711 (setq tmpend tb))))
4ab89e7b
SM
4712 ((match-beginning 17) ; sub with prototype or attribute
4713 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4714 ;;"\\<sub\\>\\(" ;12
4715 ;; cperl-white-and-comment-rex ;13
4716 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4717 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4718 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4719 (setq b1 (match-beginning 14) e1 (match-end 14))
f83d2997
KH
4720 (if (memq (char-after (1- b))
4721 '(?\$ ?\@ ?\% ?\& ?\*))
4722 nil
4ab89e7b
SM
4723 (goto-char b)
4724 (if (eq (char-after (match-beginning 17)) ?\( )
4725 (progn
4726 (cperl-commentify ; Prototypes; mark as string
4727 (match-beginning 17) (match-end 17) t)
4728 (goto-char (match-end 0))
4729 ;; Now look for attributes after prototype:
4730 (forward-comment (buffer-size))
4731 (and (looking-at ":[^:]")
4732 (cperl-find-sub-attrs st-l b1 e1 b)))
4733 ;; treat attributes without prototype
4734 (goto-char (match-beginning 17))
4735 (cperl-find-sub-attrs st-l b1 e1 b))))
4736 ;; 1+6+2+1+1+6+1=18 extra () before this:
f83d2997 4737 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4ab89e7b
SM
4738 ((match-beginning 19) ; old $abc'efg syntax
4739 (setq bb (match-end 0))
4740 ;;;(if (nth 3 state) nil ; in string
4741 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
f83d2997 4742 (goto-char bb))
4ab89e7b 4743 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
f83d2997 4744 ;; "__\\(END\\|DATA\\)__"
4ab89e7b
SM
4745 ((match-beginning 20) ; __END__, __DATA__
4746 (setq bb (match-end 0))
4747 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4748 (cperl-commentify b bb nil)
4749 (setq end t))
4750 ;; "\\\\\\(['`\"($]\\)"
4751 ((match-beginning 21)
4752 ;; Trailing backslash; make non-quoting outside string/comment
4753 (setq bb (match-end 0))
6c389151
SM
4754 (goto-char b)
4755 (skip-chars-backward "\\\\")
4756 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4ab89e7b 4757 (cperl-modify-syntax-type b cperl-st-punct)
6c389151
SM
4758 (goto-char bb))
4759 (t (error "Error in regexp of the sniffer")))
db133cb6 4760 (if (> (point) stop-point)
f83d2997 4761 (progn
5c8b7eaf 4762 (if end
f83d2997
KH
4763 (message "Garbage after __END__/__DATA__ ignored")
4764 (message "Unbalanced syntax found while scanning")
4765 (or (car err-l) (setcar err-l b)))
db133cb6
RS
4766 (goto-char stop-point))))
4767 (setq cperl-syntax-state (cons state-point state)
4ab89e7b
SM
4768 ;; Do not mark syntax as done past tmpend???
4769 cperl-syntax-done-to (or tmpend (max (point) max)))
4770 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4771 )
f83d2997 4772 (if (car err-l) (goto-char (car err-l))
db133cb6
RS
4773 (or non-inter
4774 (message "Scanning for \"hard\" Perl constructions... done"))))
f83d2997
KH
4775 (and (buffer-modified-p)
4776 (not modified)
4777 (set-buffer-modified-p nil))
00424a9e
SM
4778 ;; I do not understand what this is doing here. It breaks font-locking
4779 ;; because it resets the syntax-table from font-lock-syntax-table to
4780 ;; cperl-mode-syntax-table.
4781 ;; (set-syntax-table cperl-mode-syntax-table)
4782 )
4ab89e7b
SM
4783 (list (car err-l) overshoot)))
4784
4785(defun cperl-find-pods-heres-region (min max)
4786 (interactive "r")
4787 (cperl-find-pods-heres min max))
f83d2997
KH
4788
4789(defun cperl-backward-to-noncomment (lim)
4790 ;; Stops at lim or after non-whitespace that is not in comment
4ab89e7b 4791 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
5bd52f0e 4792 (let (stop p pr)
4ab89e7b 4793 (while (and (not stop) (> (point) (or lim (point-min))))
f83d2997
KH
4794 (skip-chars-backward " \t\n\f" lim)
4795 (setq p (point))
4796 (beginning-of-line)
5bd52f0e
RS
4797 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4798 '(pod here-doc here-doc-delim))
82d9a08d
SM
4799 (progn
4800 (cperl-unwind-to-safe nil)
4801 (setq pr (get-text-property (point) 'syntax-type))))
4802 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4803 (not (memq pr '(string prestring))))
4804 (progn (cperl-to-comment-or-eol) (bolp))
4805 (progn
4806 (skip-chars-backward " \t")
4807 (if (< p (point)) (goto-char p))
4808 (setq stop t))))))
f83d2997 4809
4ab89e7b
SM
4810;; Used only in `cperl-calculate-indent'...
4811(defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4812 ;; Positions is before ?\{. Checks whether it starts a block.
4813 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4814 (cperl-backward-to-noncomment (point-min))
4815 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4816 ; Label may be mixed up with `$blah :'
4817 (save-excursion (cperl-after-label))
4818 (get-text-property (cperl-1- (point)) 'attrib-group)
4819 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4820 (progn
4821 (backward-sexp)
4822 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4823 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4824 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
4825 ;; sub bless::foo {}
4826 (progn
4827 (cperl-backward-to-noncomment (point-min))
4828 (and (eq (preceding-char) ?b)
4829 (progn
4830 (forward-sexp -1)
4831 (looking-at "sub[ \t\n\f#]")))))))))
4832
4833;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4834;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4835;;; may be a part of an in-statement construct, such as
4836;;; ${something()}, print {FH} $data.
4837;;; Moreover, one takes positive approach (looks for else,grep etc)
4838;;; another negative (looks for bless,tr etc)
f739b53b 4839(defun cperl-after-block-p (lim &optional pre-block)
4ab89e7b
SM
4840 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
4841Would not look before LIM. Assumes that LIM is a good place to begin a
4842statement. The kind of block we treat here is one after which a new
4843statement would start; thus the block in ${func()} does not count."
f83d2997
KH
4844 (save-excursion
4845 (condition-case nil
4846 (progn
f739b53b 4847 (or pre-block (forward-sexp -1))
f83d2997 4848 (cperl-backward-to-noncomment lim)
bab27c0c 4849 (or (eq (point) lim)
4ab89e7b
SM
4850 ;; if () {} // sub f () {} // sub f :a(') {}
4851 (eq (preceding-char) ?\) )
4852 ;; label: {}
4853 (save-excursion (cperl-after-label))
4854 ;; sub :attr {}
4855 (get-text-property (cperl-1- (point)) 'attrib-group)
4856 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
db133cb6
RS
4857 (save-excursion
4858 (forward-sexp -1)
4ab89e7b
SM
4859 ;; else {} but not else::func {}
4860 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4861 (not (looking-at "\\(\\sw\\|_\\)+::")))
db133cb6
RS
4862 ;; sub f {}
4863 (progn
4864 (cperl-backward-to-noncomment lim)
4ab89e7b 4865 (and (eq (preceding-char) ?b)
db133cb6
RS
4866 (progn
4867 (forward-sexp -1)
4ab89e7b
SM
4868 (looking-at "sub[ \t\n\f#]"))))))
4869 ;; What preceeds is not word... XXXX Last statement in sub???
db133cb6 4870 (cperl-after-expr-p lim))))
f83d2997
KH
4871 (error nil))))
4872
4873(defun cperl-after-expr-p (&optional lim chars test)
029cb4d5 4874 "Return true if the position is good for start of expression.
f83d2997
KH
4875TEST is the expression to evaluate at the found position. If absent,
4876CHARS is a string that contains good characters to have before us (however,
4877`}' is treated \"smartly\" if it is not in the list)."
83261a2f 4878 (let ((lim (or lim (point-min)))
f739b53b
SM
4879 stop p pr)
4880 (cperl-update-syntaxification (point) (point))
f83d2997
KH
4881 (save-excursion
4882 (while (and (not stop) (> (point) lim))
4883 (skip-chars-backward " \t\n\f" lim)
4884 (setq p (point))
4885 (beginning-of-line)
f739b53b
SM
4886 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4887 ;; '(pod here-doc here-doc-delim))
4888 (if (get-text-property (point) 'here-doc-group)
4889 (progn
4890 (goto-char
4ab89e7b 4891 (cperl-beginning-of-property (point) 'here-doc-group))
f739b53b
SM
4892 (beginning-of-line 0)))
4893 (if (get-text-property (point) 'in-pod)
4894 (progn
4895 (goto-char
4ab89e7b 4896 (cperl-beginning-of-property (point) 'in-pod))
f739b53b 4897 (beginning-of-line 0)))
f83d2997 4898 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
5bd52f0e 4899 ;; Else: last iteration, or a label
f739b53b 4900 (cperl-to-comment-or-eol) ; Will not move past "." after a format
f83d2997
KH
4901 (skip-chars-backward " \t")
4902 (if (< p (point)) (goto-char p))
5bd52f0e
RS
4903 (setq p (point))
4904 (if (and (eq (preceding-char) ?:)
4905 (progn
4906 (forward-char -1)
4907 (skip-chars-backward " \t\n\f" lim)
4ab89e7b 4908 (memq (char-syntax (preceding-char)) '(?w ?_))))
5bd52f0e
RS
4909 (forward-sexp -1) ; Possibly label. Skip it
4910 (goto-char p)
4911 (setq stop t))))
bab27c0c
RS
4912 (or (bobp) ; ???? Needed
4913 (eq (point) lim)
029cb4d5 4914 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
f83d2997
KH
4915 (progn
4916 (if test (eval test)
4917 (or (memq (preceding-char) (append (or chars "{;") nil))
4918 (and (eq (preceding-char) ?\})
f739b53b
SM
4919 (cperl-after-block-p lim))
4920 (and (eq (following-char) ?.) ; in format: see comment above
4921 (eq (get-text-property (point) 'syntax-type)
4922 'format)))))))))
f83d2997 4923
4ab89e7b
SM
4924(defun cperl-backward-to-start-of-expr (&optional lim)
4925 (condition-case nil
4926 (progn
4927 (while (and (or (not lim)
4928 (> (point) lim))
4929 (not (cperl-after-expr-p lim)))
4930 (forward-sexp -1)
4931 ;; May be after $, @, $# etc of a variable
4932 (skip-chars-backward "$@%#")))
4933 (error nil)))
4934
4935(defun cperl-at-end-of-expr (&optional lim)
4936 ;; Since the SEXP approach below is very fragile, do some overengineering
4937 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4938 (condition-case nil
4939 (save-excursion
4940 ;; If nothing interesting after, does as (forward-sexp -1);
4941 ;; otherwise fails, or ends at a start of following sexp.
4942 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4943 ;; may be stuck after @ or $; just put some stupid workaround now:
4944 (let ((p (point)))
4945 (forward-sexp 1)
4946 (forward-sexp -1)
4947 (while (memq (preceding-char) (append "%&@$*" nil))
4948 (forward-char -1))
4949 (or (< (point) p)
4950 (cperl-after-expr-p lim))))
4951 (error t))))
4952
4953(defun cperl-forward-to-end-of-expr (&optional lim)
4954 (let ((p (point))))
4955 (condition-case nil
4956 (progn
4957 (while (and (< (point) (or lim (point-max)))
4958 (not (cperl-at-end-of-expr)))
4959 (forward-sexp 1)))
4960 (error nil)))
4961
f83d2997
KH
4962(defun cperl-backward-to-start-of-continued-exp (lim)
4963 (if (memq (preceding-char) (append ")]}\"'`" nil))
4964 (forward-sexp -1))
4965 (beginning-of-line)
4966 (if (<= (point) lim)
4967 (goto-char (1+ lim)))
4968 (skip-chars-forward " \t"))
4969
db133cb6
RS
4970(defun cperl-after-block-and-statement-beg (lim)
4971 ;; We assume that we are after ?\}
5c8b7eaf 4972 (and
db133cb6
RS
4973 (cperl-after-block-p lim)
4974 (save-excursion
4975 (forward-sexp -1)
4976 (cperl-backward-to-noncomment (point-min))
4977 (or (bobp)
bab27c0c 4978 (eq (point) lim)
db133cb6
RS
4979 (not (= (char-syntax (preceding-char)) ?w))
4980 (progn
4981 (forward-sexp -1)
5c8b7eaf 4982 (not
db133cb6
RS
4983 (looking-at
4984 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
4985
f83d2997 4986\f
f83d2997
KH
4987(defun cperl-indent-exp ()
4988 "Simple variant of indentation of continued-sexp.
5bd52f0e
RS
4989
4990Will not indent comment if it starts at `comment-indent' or looks like
4991continuation of the comment on the previous line.
db133cb6 4992
5c8b7eaf 4993If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 4994conditional/loop constructs."
f83d2997
KH
4995 (interactive)
4996 (save-excursion
e180ab9f 4997 (let ((tmp-end (point-at-eol)) top done)
f83d2997
KH
4998 (save-excursion
4999 (beginning-of-line)
5000 (while (null done)
5001 (setq top (point))
4ab89e7b
SM
5002 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
5003 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
f83d2997
KH
5004 (setq top (point))) ; Get the outermost parenths in line
5005 (goto-char top)
5006 (while (< (point) tmp-end)
5007 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5008 (or (eolp) (forward-sexp 1)))
4ab89e7b
SM
5009 (if (> (point) tmp-end) ; Yes, there an unfinished block
5010 nil
5011 (if (eq ?\) (preceding-char))
5012 (progn ;; Plan B: find by REGEXP block followup this line
5013 (setq top (point))
5014 (condition-case nil
5015 (progn
5016 (forward-sexp -2)
5017 (if (eq (following-char) ?$ ) ; for my $var (list)
5018 (progn
5019 (forward-sexp -1)
5020 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5021 (forward-sexp -1))))
5022 (if (looking-at
5023 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5024 "\\|for\\(each\\)?\\>\\(\\("
5025 cperl-maybe-white-and-comment-rex
5026 "\\(my\\|local\\|our\\)\\)?"
5027 cperl-maybe-white-and-comment-rex
5028 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5029 (progn
5030 (goto-char top)
5031 (forward-sexp 1)
5032 (setq top (point)))))
5033 (error (setq done t)))
5034 (goto-char top))
5035 (if (looking-at ; Try Plan C: continuation block
5036 (concat cperl-maybe-white-and-comment-rex
5037 "\\<\\(else\\|elsif\|continue\\)\\>"))
5038 (progn
5039 (goto-char (match-end 0))
e180ab9f 5040 (setq tmp-end (point-at-eol)))
4ab89e7b 5041 (setq done t))))
e180ab9f 5042 (setq tmp-end (point-at-eol)))
f83d2997
KH
5043 (goto-char tmp-end)
5044 (setq tmp-end (point-marker)))
db133cb6
RS
5045 (if cperl-indent-region-fix-constructs
5046 (cperl-fix-line-spacing tmp-end))
f83d2997
KH
5047 (cperl-indent-region (point) tmp-end))))
5048
5bd52f0e
RS
5049(defun cperl-fix-line-spacing (&optional end parse-data)
5050 "Improve whitespace in a conditional/loop construct.
5051Returns some position at the last line."
db133cb6
RS
5052 (interactive)
5053 (or end
5054 (setq end (point-max)))
e180ab9f 5055 (let ((ee (point-at-eol))
83261a2f
SM
5056 (cperl-indent-region-fix-constructs
5057 (or cperl-indent-region-fix-constructs 1))
5058 p pp ml have-brace ret)
db133cb6
RS
5059 (save-excursion
5060 (beginning-of-line)
5bd52f0e 5061 (setq ret (point))
5c8b7eaf 5062 ;; }? continue
5bd52f0e 5063 ;; blah; }
5c8b7eaf 5064 (if (not
5bd52f0e
RS
5065 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5066 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5067 nil ; Do not need to do anything
83261a2f
SM
5068 ;; Looking at:
5069 ;; }
5070 ;; else
4ab89e7b
SM
5071 (if cperl-merge-trailing-else
5072 (if (looking-at
5073 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5074 (progn
5075 (search-forward "}")
5076 (setq p (point))
5077 (skip-chars-forward " \t\n")
5078 (delete-region p (point))
b5b0cb34 5079 (insert (make-string cperl-indent-region-fix-constructs ?\s))
4ab89e7b
SM
5080 (beginning-of-line)))
5081 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5082 (save-excursion
5083 (search-forward "}")
5084 (delete-horizontal-space)
5085 (insert "\n")
5086 (setq ret (point))
5087 (if (cperl-indent-line parse-data)
5088 (progn
5089 (cperl-fix-line-spacing end parse-data)
5090 (setq ret (point)))))))
83261a2f
SM
5091 ;; Looking at:
5092 ;; } else
5093 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5094 (progn
5095 (search-forward "}")
5096 (delete-horizontal-space)
b5b0cb34 5097 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5098 (beginning-of-line)))
5099 ;; Looking at:
5100 ;; else {
5101 (if (looking-at
5102 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5103 (progn
5104 (forward-word 1)
5105 (delete-horizontal-space)
b5b0cb34 5106 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5107 (beginning-of-line)))
5108 ;; Looking at:
5109 ;; foreach my $var
5110 (if (looking-at
5111 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5112 (progn
5113 (forward-word 2)
5114 (delete-horizontal-space)
b5b0cb34 5115 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5116 (beginning-of-line)))
5117 ;; Looking at:
5118 ;; foreach my $var (
5119 (if (looking-at
6c389151 5120 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
83261a2f 5121 (progn
f739b53b 5122 (forward-sexp 3)
83261a2f
SM
5123 (delete-horizontal-space)
5124 (insert
b5b0cb34 5125 (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f 5126 (beginning-of-line)))
4ab89e7b
SM
5127 ;; Looking at (with or without "}" at start, ending after "({"):
5128 ;; } foreach my $var () OR {
83261a2f 5129 (if (looking-at
ce22dd53 5130 "[ \t]*\\(}[ \t]*\\)?\\<\\(\\els\\(e\\|if\\)\\|continue\\|if\\|unless\\|while\\|for\\(each\\)?\\(\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\$[_a-zA-Z0-9]+\\)?\\|until\\)\\>\\([ \t]*(\\|[ \t\n]*{\\)\\|[ \t]*{")
83261a2f 5131 (progn
4ab89e7b 5132 (setq ml (match-beginning 8)) ; "(" or "{" after control word
83261a2f
SM
5133 (re-search-forward "[({]")
5134 (forward-char -1)
5135 (setq p (point))
5136 (if (eq (following-char) ?\( )
5137 (progn
5138 (forward-sexp 1)
4ab89e7b 5139 (setq pp (point))) ; past parenth-group
83261a2f
SM
5140 ;; after `else' or nothing
5141 (if ml ; after `else'
5142 (skip-chars-backward " \t\n")
5143 (beginning-of-line))
5144 (setq pp nil))
5145 ;; Now after the sexp before the brace
5146 ;; Multiline expr should be special
5147 (setq ml (and pp (save-excursion (goto-char p)
5148 (search-forward "\n" pp t))))
4ab89e7b 5149 (if (and (or (not pp) (< pp end)) ; Do not go too far...
83261a2f
SM
5150 (looking-at "[ \t\n]*{"))
5151 (progn
5152 (cond
5153 ((bolp) ; Were before `{', no if/else/etc
5154 nil)
4ab89e7b 5155 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
83261a2f
SM
5156 (delete-horizontal-space)
5157 (if (if ml
5158 cperl-extra-newline-before-brace-multiline
5159 cperl-extra-newline-before-brace)
5160 (progn
5161 (delete-horizontal-space)
5162 (insert "\n")
5163 (setq ret (point))
5164 (if (cperl-indent-line parse-data)
5165 (progn
5166 (cperl-fix-line-spacing end parse-data)
5167 (setq ret (point)))))
5168 (insert
b5b0cb34 5169 (make-string cperl-indent-region-fix-constructs ?\s))))
83261a2f
SM
5170 ((and (looking-at "[ \t]*\n")
5171 (not (if ml
5172 cperl-extra-newline-before-brace-multiline
5173 cperl-extra-newline-before-brace)))
5174 (setq pp (point))
5175 (skip-chars-forward " \t\n")
5176 (delete-region pp (point))
db133cb6 5177 (insert
4ab89e7b
SM
5178 (make-string cperl-indent-region-fix-constructs ?\ )))
5179 ((and (looking-at "[\t ]*{")
5180 (if ml cperl-extra-newline-before-brace-multiline
5181 cperl-extra-newline-before-brace))
5182 (delete-horizontal-space)
5183 (insert "\n")
5184 (setq ret (point))
5185 (if (cperl-indent-line parse-data)
5186 (progn
5187 (cperl-fix-line-spacing end parse-data)
5188 (setq ret (point))))))
83261a2f
SM
5189 ;; Now we are before `{'
5190 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5191 (progn
5192 (skip-chars-forward " \t\n")
5193 (setq pp (point))
5194 (forward-sexp 1)
5195 (setq p (point))
5196 (goto-char pp)
5197 (setq ml (search-forward "\n" p t))
5198 (if (or cperl-break-one-line-blocks-when-indent ml)
5199 ;; not good: multi-line BLOCK
5200 (progn
5201 (goto-char (1+ pp))
5202 (delete-horizontal-space)
5203 (insert "\n")
5204 (setq ret (point))
5205 (if (cperl-indent-line parse-data)
5206 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5207 (beginning-of-line)
e180ab9f 5208 (setq p (point) pp (point-at-eol)) ; May be different from ee.
83261a2f
SM
5209 ;; Now check whether there is a hanging `}'
5210 ;; Looking at:
5211 ;; } blah
5212 (if (and
5213 cperl-fix-hanging-brace-when-indent
5214 have-brace
5215 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5216 (condition-case nil
5217 (progn
5218 (up-list 1)
5219 (if (and (<= (point) pp)
5220 (eq (preceding-char) ?\} )
5221 (cperl-after-block-and-statement-beg (point-min)))
5222 t
5223 (goto-char p)
5224 nil))
5225 (error nil)))
5226 (progn
5227 (forward-char -1)
5228 (skip-chars-backward " \t")
5229 (if (bolp)
5230 ;; `}' was the first thing on the line, insert NL *after* it.
5231 (progn
5232 (cperl-indent-line parse-data)
5233 (search-forward "}")
5234 (delete-horizontal-space)
5235 (insert "\n"))
5236 (delete-horizontal-space)
5237 (or (eq (preceding-char) ?\;)
5238 (bolp)
5239 (and (eq (preceding-char) ?\} )
5240 (cperl-after-block-p (point-min)))
5241 (insert ";"))
5242 (insert "\n")
5243 (setq ret (point)))
5244 (if (cperl-indent-line parse-data)
5245 (setq ret (cperl-fix-line-spacing end parse-data)))
5246 (beginning-of-line)))))
5bd52f0e
RS
5247 ret))
5248
5249(defvar cperl-update-start) ; Do not need to make them local
5250(defvar cperl-update-end)
5251(defun cperl-delay-update-hook (beg end old-len)
5252 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5253 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
db133cb6 5254
f83d2997
KH
5255(defun cperl-indent-region (start end)
5256 "Simple variant of indentation of region in CPerl mode.
5c8b7eaf 5257Should be slow. Will not indent comment if it starts at `comment-indent'
f83d2997 5258or looks like continuation of the comment on the previous line.
5c8b7eaf
SS
5259Indents all the lines whose first character is between START and END
5260inclusive.
db133cb6 5261
5c8b7eaf 5262If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 5263conditional/loop constructs."
f83d2997 5264 (interactive "r")
5bd52f0e 5265 (cperl-update-syntaxification end end)
f83d2997 5266 (save-excursion
5bd52f0e 5267 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
83261a2f
SM
5268 (let ((indent-info (if cperl-emacs-can-parse
5269 (list nil nil nil) ; Cannot use '(), since will modify
5270 nil))
c326ddd1 5271 (pm 0)
83261a2f
SM
5272 after-change-functions ; Speed it up!
5273 st comm old-comm-indent new-comm-indent p pp i empty)
5bd52f0e 5274 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
83261a2f
SM
5275 (goto-char start)
5276 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5277 (current-column))
5278 new-comm-indent old-comm-indent)
5279 (goto-char start)
5280 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5281 (or (bolp) (beginning-of-line 2))
83261a2f 5282 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5bd52f0e
RS
5283 (setq st (point))
5284 (if (or
5285 (setq empty (looking-at "[ \t]*\n"))
5286 (and (setq comm (looking-at "[ \t]*#"))
83261a2f
SM
5287 (or (eq (current-indentation) (or old-comm-indent
5288 comment-column))
5bd52f0e 5289 (setq old-comm-indent nil))))
8c777c8d 5290 (if (and old-comm-indent
5bd52f0e 5291 (not empty)
8c777c8d 5292 (= (current-indentation) old-comm-indent)
5bd52f0e
RS
5293 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5294 (not (eq (get-text-property (point) 'syntax-table)
5295 cperl-st-cfence)))
83261a2f
SM
5296 (let ((comment-column new-comm-indent))
5297 (indent-for-comment)))
5298 (progn
5bd52f0e 5299 (setq i (cperl-indent-line indent-info))
8c777c8d
CY
5300 (or comm
5301 (not i)
5302 (progn
5303 (if cperl-indent-region-fix-constructs
5bd52f0e 5304 (goto-char (cperl-fix-line-spacing end indent-info)))
83261a2f
SM
5305 (if (setq old-comm-indent
5306 (and (cperl-to-comment-or-eol)
5307 (not (memq (get-text-property (point)
5308 'syntax-type)
5309 '(pod here-doc)))
5c8b7eaf 5310 (not (eq (get-text-property (point)
5bd52f0e
RS
5311 'syntax-table)
5312 cperl-st-cfence))
8c777c8d
CY
5313 (current-column)))
5314 (progn (indent-for-comment)
5315 (skip-chars-backward " \t")
5316 (skip-chars-backward "#")
5317 (setq new-comm-indent (current-column))))))))
5318 (beginning-of-line 2)))
5bd52f0e 5319 ;; Now run the update hooks
83261a2f
SM
5320 (and after-change-functions
5321 cperl-update-end
5322 (save-excursion
5323 (goto-char cperl-update-end)
5324 (insert " ")
5325 (delete-char -1)
5326 (goto-char cperl-update-start)
5327 (insert " ")
5328 (delete-char -1))))))
f83d2997 5329
f83d2997
KH
5330;; Stolen from lisp-mode with a lot of improvements
5331
5332(defun cperl-fill-paragraph (&optional justify iteration)
82eb0dae 5333 "Like `fill-paragraph', but handle CPerl comments.
f83d2997
KH
5334If any of the current line is a comment, fill the comment or the
5335block of it that point is in, preserving the comment's initial
5336indentation and initial hashes. Behaves usually outside of comment."
82eb0dae 5337 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
83261a2f 5338 (let (;; Non-nil if the current line contains a comment.
f83d2997 5339 has-comment
4ab89e7b 5340 fill-paragraph-function ; do not recurse
f83d2997
KH
5341 ;; If has-comment, the appropriate fill-prefix for the comment.
5342 comment-fill-prefix
5343 ;; Line that contains code and comment (or nil)
5344 start
5345 c spaces len dc (comment-column comment-column))
5346 ;; Figure out what kind of comment we are looking at.
5347 (save-excursion
5348 (beginning-of-line)
5349 (cond
5350
5351 ;; A line with nothing but a comment on it?
5352 ((looking-at "[ \t]*#[# \t]*")
5353 (setq has-comment t
5354 comment-fill-prefix (buffer-substring (match-beginning 0)
5355 (match-end 0))))
5356
5357 ;; A line with some code, followed by a comment? Remember that the
5358 ;; semi which starts the comment shouldn't be part of a string or
5359 ;; character.
5360 ((cperl-to-comment-or-eol)
5361 (setq has-comment t)
5362 (looking-at "#+[ \t]*")
5c8b7eaf 5363 (setq start (point) c (current-column)
f83d2997 5364 comment-fill-prefix
b5b0cb34 5365 (concat (make-string (current-column) ?\s)
f83d2997 5366 (buffer-substring (match-beginning 0) (match-end 0)))
5c8b7eaf 5367 spaces (progn (skip-chars-backward " \t")
f83d2997 5368 (buffer-substring (point) start))
5c8b7eaf 5369 dc (- c (current-column)) len (- start (point))
f83d2997
KH
5370 start (point-marker))
5371 (delete-char len)
4ab89e7b 5372 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
f83d2997 5373 (if (not has-comment)
83261a2f 5374 (fill-paragraph justify) ; Do the usual thing outside of comment
f83d2997
KH
5375 ;; Narrow to include only the comment, and then fill the region.
5376 (save-restriction
5377 (narrow-to-region
5378 ;; Find the first line we should include in the region to fill.
5379 (if start (progn (beginning-of-line) (point))
5380 (save-excursion
5381 (while (and (zerop (forward-line -1))
5382 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5383 ;; We may have gone to far. Go forward again.
5384 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5385 (forward-line 1))
5386 (point)))
5387 ;; Find the beginning of the first line past the region to fill.
5388 (save-excursion
5389 (while (progn (forward-line 1)
5390 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5391 (point)))
5392 ;; Remove existing hashes
4ab89e7b 5393 (goto-char (point-min))
8c777c8d
CY
5394 (save-excursion
5395 (while (progn (forward-line 1) (< (point) (point-max)))
5396 (skip-chars-forward " \t")
5397 (if (looking-at "#+")
5398 (progn
5399 (if (and (eq (point) (match-beginning 0))
5400 (not (eq (point) (match-end 0)))) nil
4ab89e7b
SM
5401 (error
5402 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5403 (delete-char (- (match-end 0) (match-beginning 0)))))))
f83d2997
KH
5404
5405 ;; Lines with only hashes on them can be paragraph boundaries.
5406 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5407 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5408 (fill-prefix comment-fill-prefix))
5409 (fill-paragraph justify)))
5410 (if (and start)
5c8b7eaf 5411 (progn
f83d2997
KH
5412 (goto-char start)
5413 (if (> dc 0)
83261a2f 5414 (progn (delete-char dc) (insert spaces)))
f83d2997
KH
5415 (if (or (= (current-column) c) iteration) nil
5416 (setq comment-column c)
5417 (indent-for-comment)
5418 ;; Repeat once more, flagging as iteration
4ab89e7b
SM
5419 (cperl-fill-paragraph justify t))))))
5420 t)
f83d2997
KH
5421
5422(defun cperl-do-auto-fill ()
5423 ;; Break out if the line is short enough
5424 (if (> (save-excursion
5425 (end-of-line)
5426 (current-column))
5427 fill-column)
83261a2f
SM
5428 (let ((c (save-excursion (beginning-of-line)
5429 (cperl-to-comment-or-eol) (point)))
8038e2cf 5430 (s (memq (following-char) '(?\s ?\t))) marker)
82eb0dae
SM
5431 (if (>= c (point))
5432 ;; Don't break line inside code: only inside comment.
5433 nil
83261a2f 5434 (setq marker (point-marker))
82eb0dae 5435 (fill-paragraph nil)
83261a2f
SM
5436 (goto-char marker)
5437 ;; Is not enough, sometimes marker is a start of line
5438 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5439 (goto-char (match-end 0))))
5440 ;; Following space could have gone:
8038e2cf 5441 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
83261a2f
SM
5442 (insert " ")
5443 (backward-char 1))
5444 ;; Previous space could have gone:
8038e2cf 5445 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
f83d2997 5446
f83d2997
KH
5447(defun cperl-imenu-addback (lst &optional isback name)
5448 ;; We suppose that the lst is a DAG, unless the first element only
5449 ;; loops back, and ISBACK is set. Thus this function cannot be
5450 ;; applied twice without ISBACK set.
5451 (cond ((not cperl-imenu-addback) lst)
5452 (t
5c8b7eaf 5453 (or name
f83d2997 5454 (setq name "+++BACK+++"))
dba01120
GM
5455 (mapc (lambda (elt)
5456 (if (and (listp elt) (listp (cdr elt)))
5457 (progn
5458 ;; In the other order it goes up
5459 ;; one level only ;-(
5460 (setcdr elt (cons (cons name lst)
5461 (cdr elt)))
5462 (cperl-imenu-addback (cdr elt) t name))))
5463 (if isback (cdr lst) lst))
f83d2997
KH
5464 lst)))
5465
80585273 5466(defun cperl-imenu--create-perl-index (&optional regexp)
f83d2997 5467 (require 'imenu) ; May be called from TAGS creator
5c8b7eaf 5468 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
f83d2997
KH
5469 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5470 (index-meth-alist '()) meth
4ab89e7b
SM
5471 packages ends-ranges p marker is-proto
5472 (prev-pos 0) is-pack index index1 name (end-range 0) package)
f83d2997 5473 (goto-char (point-min))
6c389151 5474 (cperl-update-syntaxification (point-max) (point-max))
f83d2997
KH
5475 ;; Search for the function
5476 (progn ;;save-match-data
5477 (while (re-search-forward
80585273 5478 (or regexp cperl-imenu--function-name-regexp-perl)
f83d2997 5479 nil t)
4ab89e7b 5480 ;; 2=package-group, 5=package-name 8=sub-name
f83d2997
KH
5481 (cond
5482 ((and ; Skip some noise if building tags
4ab89e7b
SM
5483 (match-beginning 5) ; package name
5484 ;;(eq (char-after (match-beginning 2)) ?p) ; package
f83d2997 5485 (not (save-match-data
83261a2f 5486 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
f83d2997
KH
5487 nil)
5488 ((and
4ab89e7b
SM
5489 (or (match-beginning 2)
5490 (match-beginning 8)) ; package or sub
6c389151 5491 ;; Skip if quoted (will not skip multi-line ''-strings :-():
f83d2997
KH
5492 (null (get-text-property (match-beginning 1) 'syntax-table))
5493 (null (get-text-property (match-beginning 1) 'syntax-type))
5494 (null (get-text-property (match-beginning 1) 'in-pod)))
4ab89e7b 5495 (setq is-pack (match-beginning 2))
f83d2997
KH
5496 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5497 ;; (goto-char (match-end 0))) ; Messes what follows
4ab89e7b 5498 (setq meth nil
f83d2997
KH
5499 p (point))
5500 (while (and ends-ranges (>= p (car ends-ranges)))
5501 ;; delete obsolete entries
5502 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5503 (setq package (or (car packages) "")
5504 end-range (or (car ends-ranges) 0))
4ab89e7b
SM
5505 (if is-pack ; doing "package"
5506 (progn
5507 (if (match-beginning 5) ; named package
5508 (setq name (buffer-substring (match-beginning 5)
5509 (match-end 5))
5510 name (progn
5511 (set-text-properties 0 (length name) nil name)
5512 name)
5513 package (concat name "::")
5514 name (concat "package " name))
5515 ;; Support nameless packages
5516 (setq name "package;" package ""))
5517 (setq end-range
5518 (save-excursion
5519 (parse-partial-sexp (point) (point-max) -1) (point))
5520 ends-ranges (cons end-range ends-ranges)
5521 packages (cons package packages)))
5522 (setq is-proto
5523 (or (eq (following-char) ?\;)
5524 (eq 0 (get-text-property (point) 'attrib-group)))))
f83d2997 5525 ;; Skip this function name if it is a prototype declaration.
4ab89e7b
SM
5526 (if (and is-proto (not is-pack)) nil
5527 (or is-pack
5528 (setq name
5529 (buffer-substring (match-beginning 8) (match-end 8)))
5530 (set-text-properties 0 (length name) nil name))
5531 (setq marker (make-marker))
5532 (set-marker marker (match-end (if is-pack 2 8)))
5533 (cond (is-pack nil)
5534 ((string-match "[:']" name)
5535 (setq meth t))
5536 ((> p end-range) nil)
5537 (t
5538 (setq name (concat package name) meth t)))
6c389151 5539 (setq index (cons name marker))
4ab89e7b 5540 (if is-pack
f83d2997
KH
5541 (push index index-pack-alist)
5542 (push index index-alist))
5543 (if meth (push index index-meth-alist))
5544 (push index index-unsorted-alist)))
4ab89e7b
SM
5545 ((match-beginning 16) ; POD section
5546 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5547 marker (make-marker))
5548 (set-marker marker (match-beginning 17))
f83d2997 5549 (set-text-properties 0 (length name) nil name)
4ab89e7b
SM
5550 (setq name (concat (make-string
5551 (* 3 (- (char-after (match-beginning 16)) ?1))
5552 ?\ )
5553 name)
5554 index (cons name marker))
f83d2997
KH
5555 (setq index1 (cons (concat "=" name) (cdr index)))
5556 (push index index-pod-alist)
5557 (push index1 index-unsorted-alist)))))
5c8b7eaf 5558 (setq index-alist
f83d2997
KH
5559 (if (default-value 'imenu-sort-function)
5560 (sort index-alist (default-value 'imenu-sort-function))
83261a2f 5561 (nreverse index-alist)))
f83d2997
KH
5562 (and index-pod-alist
5563 (push (cons "+POD headers+..."
5564 (nreverse index-pod-alist))
5565 index-alist))
5566 (and (or index-pack-alist index-meth-alist)
5567 (let ((lst index-pack-alist) hier-list pack elt group name)
5568 ;; Remove "package ", reverse and uniquify.
5569 (while lst
5570 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5571 (if (assoc name hier-list) nil
5572 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5573 (setq lst index-meth-alist)
5574 (while lst
5575 (setq elt (car lst) lst (cdr lst))
5576 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5577 (setq pack (substring (car elt) 0 (match-beginning 0)))
5c8b7eaf 5578 (if (setq group (assoc pack hier-list))
f83d2997
KH
5579 (if (listp (cdr group))
5580 ;; Have some functions already
5c8b7eaf
SS
5581 (setcdr group
5582 (cons (cons (substring
f83d2997
KH
5583 (car elt)
5584 (+ 2 (match-beginning 0)))
5585 (cdr elt))
5586 (cdr group)))
5c8b7eaf 5587 (setcdr group (list (cons (substring
f83d2997
KH
5588 (car elt)
5589 (+ 2 (match-beginning 0)))
5590 (cdr elt)))))
5c8b7eaf
SS
5591 (setq hier-list
5592 (cons (cons pack
5593 (list (cons (substring
f83d2997
KH
5594 (car elt)
5595 (+ 2 (match-beginning 0)))
5596 (cdr elt))))
5597 hier-list))))))
5598 (push (cons "+Hierarchy+..."
5599 hier-list)
5600 index-alist)))
5601 (and index-pack-alist
5602 (push (cons "+Packages+..."
5603 (nreverse index-pack-alist))
5604 index-alist))
5c8b7eaf 5605 (and (or index-pack-alist index-pod-alist
f83d2997
KH
5606 (default-value 'imenu-sort-function))
5607 index-unsorted-alist
5608 (push (cons "+Unsorted List+..."
5609 (nreverse index-unsorted-alist))
5610 index-alist))
5611 (cperl-imenu-addback index-alist)))
5612
6c389151 5613\f
6c389151
SM
5614;; Suggested by Mark A. Hershberger
5615(defun cperl-outline-level ()
5616 (looking-at outline-regexp)
5617 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4ab89e7b
SM
5618;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5619 ((match-beginning 2) 0) ; package
5620 ((match-beginning 8) 1) ; sub
5621 ((match-beginning 16)
5622 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5623 (t 5))) ; should not happen
6c389151
SM
5624
5625\f
f83d2997
KH
5626(defun cperl-windowed-init ()
5627 "Initialization under windowed version."
f453f5a8 5628 (cond ((featurep 'ps-print)
82d9a08d
SM
5629 (or cperl-faces-init
5630 (progn
5631 (and (boundp 'font-lock-multiline)
5632 (setq cperl-font-lock-multiline t))
5633 (cperl-init-faces))))
f453f5a8
CY
5634 ((not cperl-faces-init)
5635 (add-hook 'font-lock-mode-hook
5636 (function
5637 (lambda ()
5638 (if (memq major-mode '(perl-mode cperl-mode))
5639 (progn
5640 (or cperl-faces-init (cperl-init-faces)))))))
5641 (if (fboundp 'eval-after-load)
5642 (eval-after-load
5643 "ps-print"
5644 '(or cperl-faces-init (cperl-init-faces)))))))
db133cb6 5645
5efe6a56 5646(defvar cperl-font-lock-keywords-1 nil
80585273 5647 "Additional expressions to highlight in Perl mode. Minimal set.")
5efe6a56 5648(defvar cperl-font-lock-keywords nil
80585273 5649 "Additional expressions to highlight in Perl mode. Default set.")
5efe6a56 5650(defvar cperl-font-lock-keywords-2 nil
80585273
DL
5651 "Additional expressions to highlight in Perl mode. Maximal set")
5652
db133cb6
RS
5653(defun cperl-load-font-lock-keywords ()
5654 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5655 cperl-font-lock-keywords)
db133cb6
RS
5656
5657(defun cperl-load-font-lock-keywords-1 ()
5658 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5659 cperl-font-lock-keywords-1)
db133cb6
RS
5660
5661(defun cperl-load-font-lock-keywords-2 ()
5662 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5663 cperl-font-lock-keywords-2)
f83d2997 5664
5bd52f0e
RS
5665(defun cperl-init-faces-weak ()
5666 ;; Allow `cperl-find-pods-heres' to run.
5667 (or (boundp 'font-lock-constant-face)
5668 (cperl-force-face font-lock-constant-face
4ab89e7b
SM
5669 "Face for constant and label names"))
5670 (or (boundp 'font-lock-warning-face)
5671 (cperl-force-face font-lock-warning-face
5672 "Face for things which should stand out"))
5673 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5674 )
5bd52f0e 5675
f83d2997 5676(defun cperl-init-faces ()
5bd52f0e 5677 (condition-case errs
f83d2997
KH
5678 (progn
5679 (require 'font-lock)
5680 (and (fboundp 'font-lock-fontify-anchored-keywords)
5681 (featurep 'font-lock-extra)
5682 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5683 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
f83d2997
KH
5684 (if (fboundp 'font-lock-fontify-anchored-keywords)
5685 (setq font-lock-anchored t))
5c8b7eaf 5686 (setq
f83d2997
KH
5687 t-font-lock-keywords
5688 (list
1f5c1626 5689 `("[ \t]+$" 0 ',cperl-invalid-face t)
f83d2997
KH
5690 (cons
5691 (concat
5692 "\\(^\\|[^$@%&\\]\\)\\<\\("
5693 (mapconcat
5694 'identity
5695 '("if" "until" "while" "elsif" "else" "unless" "for"
5696 "foreach" "continue" "exit" "die" "last" "goto" "next"
4ab89e7b 5697 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
6c389151 5698 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
f83d2997
KH
5699 "\\|") ; Flow control
5700 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5701 ; In what follows we use `type' style
5702 ; for overwritable builtins
5703 (list
5704 (concat
5705 "\\(^\\|[^$@%&\\]\\)\\<\\("
5706 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5707 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5708 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5709 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5710 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5711 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5712 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5713 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5714 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5715 ;; "gethostbyname" "gethostent" "getlogin"
5716 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5717 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5718 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5719 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5720 ;; "getservbyport" "getservent" "getsockname"
5721 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5722 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5bd52f0e 5723 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
f83d2997
KH
5724 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5725 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5726 ;; "quotemeta" "rand" "read" "readdir" "readline"
5727 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5728 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5729 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5730 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5731 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5732 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5733 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5734 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
6c389151 5735 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
f83d2997
KH
5736 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5737 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5738 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5c8b7eaf 5739 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
f83d2997
KH
5740 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5741 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5742 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5743 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5744 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5745 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5746 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5747 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5748 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5749 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5750 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5751 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5752 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5753 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5754 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5bd52f0e 5755 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
f83d2997
KH
5756 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5757 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5758 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5759 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5760 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5761 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5762 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5763 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
6c389151 5764 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
f83d2997
KH
5765 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5766 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5767 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5768 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5769 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5770 "\\)\\>") 2 'font-lock-type-face)
5771 ;; In what follows we use `other' style
5772 ;; for nonoverwritable builtins
5773 ;; Somehow 's', 'm' are not auto-generated???
5774 (list
5775 (concat
5776 "\\(^\\|[^$@%&\\]\\)\\<\\("
6c389151 5777 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
f83d2997
KH
5778 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5779 ;; "eval" "exists" "for" "foreach" "format" "goto"
5780 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4ab89e7b 5781 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
f83d2997
KH
5782 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5783 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5784 ;; "undef" "unless" "unshift" "untie" "until" "use"
5785 ;; "while" "y"
6c389151 5786 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
f83d2997 5787 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
6c389151
SM
5788 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5789 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
f83d2997 5790 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5bd52f0e 5791 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
f83d2997
KH
5792 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5793 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5794 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5795 "\\|[sm]" ; Added manually
4ab89e7b 5796 "\\)\\>") 2 'cperl-nonoverridable-face)
f83d2997
KH
5797 ;; (mapconcat 'identity
5798 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5799 ;; "#include" "#define" "#undef")
5800 ;; "\\|")
5801 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5802 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4ab89e7b
SM
5803 ;; This highlights declarations and definitions differenty.
5804 ;; We do not try to highlight in the case of attributes:
5805 ;; it is already done by `cperl-find-pods-heres'
5806 (list (concat "\\<sub"
5807 cperl-white-and-comment-rex ; whitespace/comments
5808 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5809 "\\("
5810 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5811 "([^()]*)\\)?" ; prototype
5812 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5813 "[{;]")
5814 2 (if cperl-font-lock-multiline
5815 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5816 'font-lock-function-name-face
5817 'font-lock-variable-name-face)
5818 ;; need to manually set 'multiline' for older font-locks
5819 '(progn
5820 (if (< 1 (count-lines (match-beginning 0)
5821 (match-end 0)))
5822 (put-text-property
5823 (+ 3 (match-beginning 0)) (match-end 0)
5824 'syntax-type 'multiline))
5825 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5826 'font-lock-function-name-face
5827 'font-lock-variable-name-face))))
f83d2997
KH
5828 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5829 2 font-lock-function-name-face)
5830 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5831 1 font-lock-function-name-face)
5832 (cond ((featurep 'font-lock-extra)
5c8b7eaf 5833 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
f83d2997
KH
5834 (2 font-lock-string-face t)
5835 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5836 (font-lock-anchored
5837 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5838 (2 font-lock-string-face t)
5839 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5840 nil nil
5841 (1 font-lock-string-face t))))
5842 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5843 2 font-lock-string-face t)))
db133cb6 5844 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
f83d2997 5845 font-lock-string-face t)
5c8b7eaf 5846 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
83261a2f 5847 font-lock-constant-face) ; labels
f83d2997 5848 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
883212ce 5849 2 font-lock-constant-face)
6c389151
SM
5850 ;; Uncomment to get perl-mode-like vars
5851 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5852 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5853 ;;; (2 (cons font-lock-variable-name-face '(underline))))
f83d2997 5854 (cond ((featurep 'font-lock-extra)
6c389151 5855 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
f83d2997
KH
5856 (3 font-lock-variable-name-face)
5857 (4 '(another 4 nil
5858 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5859 (1 font-lock-variable-name-face)
5c8b7eaf 5860 (2 '(restart 2 nil) nil t)))
f83d2997
KH
5861 nil t))) ; local variables, multiple
5862 (font-lock-anchored
4ab89e7b 5863 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
9edd6ee6 5864 `(,(concat "\\<\\(my\\|local\\|our\\)"
4ab89e7b
SM
5865 cperl-maybe-white-and-comment-rex
5866 "\\(("
5867 cperl-maybe-white-and-comment-rex
9edd6ee6
SM
5868 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5869 (5 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5870 'font-lock-variable-name-face
5871 '(progn (setq cperl-font-lock-multiline-start
5872 (match-beginning 0))
9edd6ee6
SM
5873 'font-lock-variable-name-face)))
5874 (,(concat "\\="
4ab89e7b
SM
5875 cperl-maybe-white-and-comment-rex
5876 ","
5877 cperl-maybe-white-and-comment-rex
9edd6ee6 5878 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
cb5bf6ba 5879 ;; Bug in font-lock: limit is used not only to limit
4ab89e7b
SM
5880 ;; searches, but to set the "extend window for
5881 ;; facification" property. Thus we need to minimize.
9edd6ee6 5882 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5883 '(if (match-beginning 3)
5884 (save-excursion
5885 (goto-char (match-beginning 3))
5886 (condition-case nil
5887 (forward-sexp 1)
5888 (error
5889 (condition-case nil
5890 (forward-char 200)
5891 (error nil)))) ; typeahead
5892 (1- (point))) ; report limit
5893 (forward-char -2)) ; disable continued expr
5894 '(if (match-beginning 3)
5895 (point-max) ; No limit for continuation
9edd6ee6
SM
5896 (forward-char -2))) ; disable continued expr
5897 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5898 nil
5899 '(progn ; Do at end
5900 ;; "my" may be already fontified (POD),
5901 ;; so cperl-font-lock-multiline-start is nil
5902 (if (or (not cperl-font-lock-multiline-start)
5903 (> 2 (count-lines
5904 cperl-font-lock-multiline-start
5905 (point))))
5906 nil
5907 (put-text-property
5908 (1+ cperl-font-lock-multiline-start) (point)
5909 'syntax-type 'multiline))
9edd6ee6
SM
5910 (setq cperl-font-lock-multiline-start nil)))
5911 (3 font-lock-variable-name-face))))
4ab89e7b 5912 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
f83d2997 5913 3 font-lock-variable-name-face)))
6c389151 5914 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
eb6121fc 5915 4 font-lock-variable-name-face)
9ed9fd35
DP
5916 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
5917 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
eb6121fc 5918 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
a1506d29 5919 (setq
f83d2997
KH
5920 t-font-lock-keywords-1
5921 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4ab89e7b
SM
5922 ;; not yet as of XEmacs 19.12, works with 21.1.11
5923 (or
6546555e 5924 (not (featurep 'xemacs))
4ab89e7b
SM
5925 (string< "21.1.9" emacs-version)
5926 (and (string< "21.1.10" emacs-version)
5927 (string< emacs-version "21.1.2")))
f83d2997
KH
5928 '(
5929 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5930 (if (eq (char-after (match-beginning 2)) ?%)
4ab89e7b
SM
5931 'cperl-hash-face
5932 'cperl-array-face)
f83d2997
KH
5933 t) ; arrays and hashes
5934 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5935 1
5c8b7eaf 5936 (if (= (- (match-end 2) (match-beginning 2)) 1)
f83d2997 5937 (if (eq (char-after (match-beginning 3)) ?{)
4ab89e7b
SM
5938 'cperl-hash-face
5939 'cperl-array-face) ; arrays and hashes
f83d2997
KH
5940 font-lock-variable-name-face) ; Just to put something
5941 t)
4ab89e7b
SM
5942 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5943 (1 cperl-array-face)
5944 (2 font-lock-variable-name-face))
5945 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5946 (1 cperl-hash-face)
5947 (2 font-lock-variable-name-face))
f83d2997
KH
5948 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5949 ;;; Too much noise from \s* @s[ and friends
5c8b7eaf 5950 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
f83d2997
KH
5951 ;;(3 font-lock-function-name-face t t)
5952 ;;(4
5953 ;; (if (cperl-slash-is-regexp)
5954 ;; font-lock-function-name-face 'default) nil t))
5955 )))
6c389151
SM
5956 (if cperl-highlight-variables-indiscriminately
5957 (setq t-font-lock-keywords-1
5958 (append t-font-lock-keywords-1
4ab89e7b 5959 (list '("\\([$*]{?\\sw+\\)" 1
6c389151 5960 font-lock-variable-name-face)))))
a1506d29 5961 (setq cperl-font-lock-keywords-1
5bd52f0e
RS
5962 (if cperl-syntaxify-by-font-lock
5963 (cons 'cperl-fontify-update
5964 t-font-lock-keywords)
5965 t-font-lock-keywords)
5efe6a56
SM
5966 cperl-font-lock-keywords cperl-font-lock-keywords-1
5967 cperl-font-lock-keywords-2 (append
6c389151
SM
5968 cperl-font-lock-keywords-1
5969 t-font-lock-keywords-1)))
f83d2997
KH
5970 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5971 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
db133cb6 5972 (eval ; Avoid a warning
83261a2f
SM
5973 '(font-lock-require-faces
5974 (list
5975 ;; Color-light Color-dark Gray-light Gray-dark Mono
5976 (list 'font-lock-comment-face
5977 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5978 nil
5979 [nil nil t t t]
5980 [nil nil t t t]
5981 nil)
5982 (list 'font-lock-string-face
5983 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5984 nil
5985 nil
5986 [nil nil t t t]
5987 nil)
5988 (list 'font-lock-function-name-face
5989 (vector
5990 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5991 (cdr (assq 'background-color ; if mono
5992 (frame-parameters))))
5993 (vector
5994 nil nil nil nil
5995 (cdr (assq 'foreground-color ; if mono
5996 (frame-parameters))))
5997 [nil nil t t t]
5998 nil
5999 nil)
6000 (list 'font-lock-variable-name-face
6001 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6002 nil
6003 [nil nil t t t]
6004 [nil nil t t t]
6005 nil)
6006 (list 'font-lock-type-face
6007 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6008 nil
6009 [nil nil t t t]
6010 nil
6011 [nil nil t t t])
4ab89e7b
SM
6012 (list 'font-lock-warning-face
6013 ["Pink" "Red" "Gray50" "LightGray"]
6014 ["gray20" "gray90"
6015 "gray80" "gray20"]
6016 [nil nil t t t]
6017 nil
6018 [nil nil t t t]
6019 )
83261a2f
SM
6020 (list 'font-lock-constant-face
6021 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6022 nil
6023 [nil nil t t t]
6024 nil
6025 [nil nil t t t])
4ab89e7b 6026 (list 'cperl-nonoverridable-face
83261a2f
SM
6027 ["chartreuse3" ("orchid1" "orange")
6028 nil "Gray80"]
6029 [nil nil "gray90"]
6030 [nil nil nil t t]
6031 [nil nil t t]
6032 [nil nil t t t])
4ab89e7b 6033 (list 'cperl-array-face
83261a2f
SM
6034 ["blue" "yellow" nil "Gray80"]
6035 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6036 "gray90"]
6037 t
6038 nil
6039 nil)
4ab89e7b 6040 (list 'cperl-hash-face
83261a2f
SM
6041 ["red" "red" nil "Gray80"]
6042 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6043 "gray90"]
6044 t
6045 t
6046 nil))))
5bd52f0e 6047 ;; Do it the dull way, without choose-color
f83d2997
KH
6048 (defvar cperl-guessed-background nil
6049 "Display characteristics as guessed by cperl.")
83261a2f 6050 ;; (or (fboundp 'x-color-defined-p)
15ca5699 6051 ;; (defalias 'x-color-defined-p
83261a2f
SM
6052 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6053 ;; ;; XEmacs >= 19.12
6054 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6055 ;; ;; XEmacs 19.11
6056 ;; (t 'x-valid-color-name-p))))
5c8b7eaf 6057 (cperl-force-face font-lock-constant-face
5bd52f0e
RS
6058 "Face for constant and label names")
6059 (cperl-force-face font-lock-variable-name-face
6060 "Face for variable names")
6061 (cperl-force-face font-lock-type-face
6062 "Face for data types")
4ab89e7b 6063 (cperl-force-face cperl-nonoverridable-face
5bd52f0e 6064 "Face for data types from another group")
4ab89e7b
SM
6065 (cperl-force-face font-lock-warning-face
6066 "Face for things which should stand out")
5bd52f0e
RS
6067 (cperl-force-face font-lock-comment-face
6068 "Face for comments")
6069 (cperl-force-face font-lock-function-name-face
6070 "Face for function names")
4ab89e7b 6071 (cperl-force-face cperl-hash-face
5bd52f0e 6072 "Face for hashes")
4ab89e7b 6073 (cperl-force-face cperl-array-face
5bd52f0e
RS
6074 "Face for arrays")
6075 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6076 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6077 ;;(or (boundp 'font-lock-type-face)
6078 ;; (defconst font-lock-type-face
6079 ;; 'font-lock-type-face
6080 ;; "Face to use for data types."))
6081 ;;(or (boundp 'cperl-nonoverridable-face)
6082 ;; (defconst cperl-nonoverridable-face
4ab89e7b 6083 ;; 'cperl-nonoverridable-face
5bd52f0e 6084 ;; "Face to use for data types from another group."))
6546555e 6085 ;;(if (not (featurep 'xemacs)) nil
5bd52f0e
RS
6086 ;; (or (boundp 'font-lock-comment-face)
6087 ;; (defconst font-lock-comment-face
6088 ;; 'font-lock-comment-face
6089 ;; "Face to use for comments."))
6090 ;; (or (boundp 'font-lock-keyword-face)
6091 ;; (defconst font-lock-keyword-face
6092 ;; 'font-lock-keyword-face
6093 ;; "Face to use for keywords."))
6094 ;; (or (boundp 'font-lock-function-name-face)
6095 ;; (defconst font-lock-function-name-face
6096 ;; 'font-lock-function-name-face
6097 ;; "Face to use for function names.")))
6098 (if (and
4ab89e7b 6099 (not (cperl-is-face 'cperl-array-face))
5c8b7eaf 6100 (cperl-is-face 'font-lock-emphasized-face))
4ab89e7b 6101 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
5bd52f0e 6102 (if (and
4ab89e7b 6103 (not (cperl-is-face 'cperl-hash-face))
5c8b7eaf 6104 (cperl-is-face 'font-lock-other-emphasized-face))
4ab89e7b 6105 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
5bd52f0e 6106 (if (and
4ab89e7b 6107 (not (cperl-is-face 'cperl-nonoverridable-face))
5c8b7eaf 6108 (cperl-is-face 'font-lock-other-type-face))
4ab89e7b 6109 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
5bd52f0e
RS
6110 ;;(or (boundp 'cperl-hash-face)
6111 ;; (defconst cperl-hash-face
4ab89e7b 6112 ;; 'cperl-hash-face
5bd52f0e
RS
6113 ;; "Face to use for hashes."))
6114 ;;(or (boundp 'cperl-array-face)
6115 ;; (defconst cperl-array-face
4ab89e7b 6116 ;; 'cperl-array-face
5bd52f0e 6117 ;; "Face to use for arrays."))
f83d2997
KH
6118 ;; Here we try to guess background
6119 (let ((background
6120 (if (boundp 'font-lock-background-mode)
6121 font-lock-background-mode
5c8b7eaf 6122 'light))
83261a2f 6123 (face-list (and (fboundp 'face-list) (face-list))))
5bd52f0e
RS
6124;;;; (fset 'cperl-is-face
6125;;;; (cond ((fboundp 'find-face)
6126;;;; (symbol-function 'find-face))
6127;;;; (face-list
6128;;;; (function (lambda (face) (member face face-list))))
6129;;;; (t
6130;;;; (function (lambda (face) (boundp face))))))
f83d2997
KH
6131 (defvar cperl-guessed-background
6132 (if (and (boundp 'font-lock-display-type)
6133 (eq font-lock-display-type 'grayscale))
6134 'gray
6135 background)
6136 "Background as guessed by CPerl mode")
83261a2f
SM
6137 (and (not (cperl-is-face 'font-lock-constant-face))
6138 (cperl-is-face 'font-lock-reference-face)
6139 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
db133cb6 6140 (if (cperl-is-face 'font-lock-type-face) nil
f83d2997
KH
6141 (copy-face 'default 'font-lock-type-face)
6142 (cond
6143 ((eq background 'light)
6144 (set-face-foreground 'font-lock-type-face
6145 (if (x-color-defined-p "seagreen")
6146 "seagreen"
6147 "sea green")))
6148 ((eq background 'dark)
6149 (set-face-foreground 'font-lock-type-face
6150 (if (x-color-defined-p "os2pink")
6151 "os2pink"
6152 "pink")))
6153 (t
6154 (set-face-background 'font-lock-type-face "gray90"))))
4ab89e7b 6155 (if (cperl-is-face 'cperl-nonoverridable-face)
f83d2997 6156 nil
4ab89e7b 6157 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
f83d2997
KH
6158 (cond
6159 ((eq background 'light)
4ab89e7b 6160 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6161 (if (x-color-defined-p "chartreuse3")
6162 "chartreuse3"
6163 "chartreuse")))
6164 ((eq background 'dark)
4ab89e7b 6165 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6166 (if (x-color-defined-p "orchid1")
6167 "orchid1"
6168 "orange")))))
5bd52f0e
RS
6169;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6170;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6171;;; (cond
6172;;; ((eq background 'light)
6173;;; (set-face-background 'font-lock-other-emphasized-face
6174;;; (if (x-color-defined-p "lightyellow2")
6175;;; "lightyellow2"
6176;;; (if (x-color-defined-p "lightyellow")
6177;;; "lightyellow"
6178;;; "light yellow"))))
6179;;; ((eq background 'dark)
6180;;; (set-face-background 'font-lock-other-emphasized-face
6181;;; (if (x-color-defined-p "navy")
6182;;; "navy"
6183;;; (if (x-color-defined-p "darkgreen")
6184;;; "darkgreen"
6185;;; "dark green"))))
6186;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6187;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6188;;; (copy-face 'bold 'font-lock-emphasized-face)
6189;;; (cond
6190;;; ((eq background 'light)
6191;;; (set-face-background 'font-lock-emphasized-face
6192;;; (if (x-color-defined-p "lightyellow2")
6193;;; "lightyellow2"
6194;;; "lightyellow")))
6195;;; ((eq background 'dark)
6196;;; (set-face-background 'font-lock-emphasized-face
6197;;; (if (x-color-defined-p "navy")
6198;;; "navy"
6199;;; (if (x-color-defined-p "darkgreen")
6200;;; "darkgreen"
6201;;; "dark green"))))
6202;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
db133cb6 6203 (if (cperl-is-face 'font-lock-variable-name-face) nil
f83d2997 6204 (copy-face 'italic 'font-lock-variable-name-face))
db133cb6 6205 (if (cperl-is-face 'font-lock-constant-face) nil
883212ce 6206 (copy-face 'italic 'font-lock-constant-face))))
f83d2997 6207 (setq cperl-faces-init t))
5bd52f0e 6208 (error (message "cperl-init-faces (ignored): %s" errs))))
f83d2997
KH
6209
6210
6211(defun cperl-ps-print-init ()
6212 "Initialization of `ps-print' components for faces used in CPerl."
5bd52f0e
RS
6213 (eval-after-load "ps-print"
6214 '(setq ps-bold-faces
5c8b7eaf 6215 ;; font-lock-variable-name-face
5bd52f0e 6216 ;; font-lock-constant-face
4ab89e7b 6217 (append '(cperl-array-face cperl-hash-face)
5bd52f0e
RS
6218 ps-bold-faces)
6219 ps-italic-faces
6220 ;; font-lock-constant-face
4ab89e7b 6221 (append '(cperl-nonoverridable-face cperl-hash-face)
5bd52f0e
RS
6222 ps-italic-faces)
6223 ps-underlined-faces
6224 ;; font-lock-type-face
4ab89e7b 6225 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
5bd52f0e
RS
6226 ps-underlined-faces))))
6227
6228(defvar ps-print-face-extension-alist)
6229
6230(defun cperl-ps-print (&optional file)
6231 "Pretty-print in CPerl style.
6232If optional argument FILE is an empty string, prints to printer, otherwise
6233to the file FILE. If FILE is nil, prompts for a file name.
6234
6235Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6236 (interactive)
5c8b7eaf
SS
6237 (or file
6238 (setq file (read-from-minibuffer
5bd52f0e
RS
6239 "Print to file (if empty - to printer): "
6240 (concat (buffer-file-name) ".ps")
6241 nil nil 'file-name-history)))
6242 (or (> (length file) 0)
6243 (setq file nil))
6244 (require 'ps-print) ; To get ps-print-face-extension-alist
6245 (let ((ps-print-color-p t)
6246 (ps-print-face-extension-alist ps-print-face-extension-alist))
6247 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6248 (ps-print-buffer-with-faces file)))
6249
6250;;; (defun cperl-ps-print-init ()
6251;;; "Initialization of `ps-print' components for faces used in CPerl."
6252;;; ;; Guard against old versions
6253;;; (defvar ps-underlined-faces nil)
6254;;; (defvar ps-bold-faces nil)
6255;;; (defvar ps-italic-faces nil)
6256;;; (setq ps-bold-faces
6257;;; (append '(font-lock-emphasized-face
4ab89e7b 6258;;; cperl-array-face
5c8b7eaf
SS
6259;;; font-lock-keyword-face
6260;;; font-lock-variable-name-face
6261;;; font-lock-constant-face
6262;;; font-lock-reference-face
5bd52f0e 6263;;; font-lock-other-emphasized-face
4ab89e7b 6264;;; cperl-hash-face)
5bd52f0e
RS
6265;;; ps-bold-faces))
6266;;; (setq ps-italic-faces
4ab89e7b 6267;;; (append '(cperl-nonoverridable-face
5c8b7eaf
SS
6268;;; font-lock-constant-face
6269;;; font-lock-reference-face
5bd52f0e 6270;;; font-lock-other-emphasized-face
4ab89e7b 6271;;; cperl-hash-face)
5bd52f0e
RS
6272;;; ps-italic-faces))
6273;;; (setq ps-underlined-faces
6274;;; (append '(font-lock-emphasized-face
4ab89e7b 6275;;; cperl-array-face
5bd52f0e 6276;;; font-lock-other-emphasized-face
4ab89e7b
SM
6277;;; cperl-hash-face
6278;;; cperl-nonoverridable-face font-lock-type-face)
5bd52f0e
RS
6279;;; ps-underlined-faces))
6280;;; (cons 'font-lock-type-face ps-underlined-faces))
f83d2997
KH
6281
6282
6283(if (cperl-enable-font-lock) (cperl-windowed-init))
6284
db133cb6 6285(defconst cperl-styles-entries
5c8b7eaf
SS
6286 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6287 cperl-label-offset cperl-extra-newline-before-brace
4ab89e7b 6288 cperl-extra-newline-before-brace-multiline
bab27c0c 6289 cperl-merge-trailing-else
db133cb6
RS
6290 cperl-continued-statement-offset))
6291
4ab89e7b
SM
6292(defconst cperl-style-examples
6293"##### Numbers etc are: cperl-indent-level cperl-brace-offset
6294##### cperl-continued-brace-offset cperl-label-offset
6295##### cperl-continued-statement-offset
6296##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6297
6298########### (Do not forget cperl-extra-newline-before-brace-multiline)
6299
6300### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6301if (foo) {
6302 bar
6303 baz;
6304 label:
6305 {
6306 boon;
6307 }
6308} else {
6309 stop;
6310}
6311
6312### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6313if (foo) {
6314 bar
6315 baz;
6316 label:
6317 {
6318 boon;
6319 }
6320} else {
6321 stop;
6322}
6323
6324### GNU 2/0/0/-2/2/nil/t
6325if (foo)
6326 {
6327 bar
6328 baz;
6329 label:
6330 {
6331 boon;
6332 }
6333 }
6334else
6335 {
6336 stop;
6337 }
6338
6339### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6340if (foo)
6341{
6342 bar
6343 baz;
6344 label:
6345 {
6346 boon;
6347 }
6348}
6349else
6350{
6351 stop;
6352}
6353
6354### BSD (=C++, but will not change preexisting merge-trailing-else
6355### and extra-newline-before-brace ) 4/0/-4/-4/4
6356if (foo)
6357{
6358 bar
6359 baz;
6360 label:
6361 {
6362 boon;
6363 }
6364}
6365else
6366{
6367 stop;
6368}
6369
6370### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6371### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6372if (foo)
6373{
6374 bar
6375 baz;
6376 label:
6377 {
6378 boon;
6379 }
6380}
6381else
6382{
6383 stop;
6384}
6385
6386### Whitesmith (=PerlStyle, but will not change preexisting
6387### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6388if (foo)
6389 {
6390 bar
6391 baz;
6392 label:
6393 {
6394 boon;
6395 }
6396 }
6397else
6398 {
6399 stop;
6400 }
6401"
6402"Examples of if/else with different indent styles (with v4.23).")
6403
db133cb6 6404(defconst cperl-style-alist
4ab89e7b 6405 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
db133cb6
RS
6406 (cperl-indent-level . 2)
6407 (cperl-brace-offset . 0)
6408 (cperl-continued-brace-offset . 0)
6409 (cperl-label-offset . -2)
4ab89e7b 6410 (cperl-continued-statement-offset . 2)
db133cb6 6411 (cperl-extra-newline-before-brace . nil)
4ab89e7b
SM
6412 (cperl-extra-newline-before-brace-multiline . nil)
6413 (cperl-merge-trailing-else . t))
6414
83261a2f 6415 ("PerlStyle" ; CPerl with 4 as indent
db133cb6
RS
6416 (cperl-indent-level . 4)
6417 (cperl-brace-offset . 0)
6418 (cperl-continued-brace-offset . 0)
6419 (cperl-label-offset . -4)
4ab89e7b 6420 (cperl-continued-statement-offset . 4)
db133cb6 6421 (cperl-extra-newline-before-brace . nil)
4ab89e7b
SM
6422 (cperl-extra-newline-before-brace-multiline . nil)
6423 (cperl-merge-trailing-else . t))
6424
db133cb6
RS
6425 ("GNU"
6426 (cperl-indent-level . 2)
6427 (cperl-brace-offset . 0)
6428 (cperl-continued-brace-offset . 0)
6429 (cperl-label-offset . -2)
4ab89e7b 6430 (cperl-continued-statement-offset . 2)
db133cb6 6431 (cperl-extra-newline-before-brace . t)
4ab89e7b
SM
6432 (cperl-extra-newline-before-brace-multiline . t)
6433 (cperl-merge-trailing-else . nil))
6434
db133cb6
RS
6435 ("K&R"
6436 (cperl-indent-level . 5)
6437 (cperl-brace-offset . 0)
6438 (cperl-continued-brace-offset . -5)
6439 (cperl-label-offset . -5)
4ab89e7b 6440 (cperl-continued-statement-offset . 5)
db133cb6 6441 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6442 ;;(cperl-extra-newline-before-brace-multiline . nil)
6443 (cperl-merge-trailing-else . nil))
6444
db133cb6
RS
6445 ("BSD"
6446 (cperl-indent-level . 4)
6447 (cperl-brace-offset . 0)
6448 (cperl-continued-brace-offset . -4)
6449 (cperl-label-offset . -4)
4ab89e7b 6450 (cperl-continued-statement-offset . 4)
db133cb6 6451 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6452 ;;(cperl-extra-newline-before-brace-multiline . nil)
6453 ;;(cperl-merge-trailing-else . nil) ; ???
6454 )
6455
db133cb6
RS
6456 ("C++"
6457 (cperl-indent-level . 4)
6458 (cperl-brace-offset . 0)
6459 (cperl-continued-brace-offset . -4)
6460 (cperl-label-offset . -4)
6461 (cperl-continued-statement-offset . 4)
4ab89e7b
SM
6462 (cperl-extra-newline-before-brace . t)
6463 (cperl-extra-newline-before-brace-multiline . t)
6464 (cperl-merge-trailing-else . nil))
6465
db133cb6
RS
6466 ("Whitesmith"
6467 (cperl-indent-level . 4)
6468 (cperl-brace-offset . 0)
6469 (cperl-continued-brace-offset . 0)
6470 (cperl-label-offset . -4)
4ab89e7b 6471 (cperl-continued-statement-offset . 4)
db133cb6 6472 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6473 ;;(cperl-extra-newline-before-brace-multiline . nil)
6474 ;;(cperl-merge-trailing-else . nil) ; ???
6475 )
6476 ("Current"))
6477 "List of variables to set to get a particular indentation style.
6478Should be used via `cperl-set-style' or via Perl menu.
6479
6480See examples in `cperl-style-examples'.")
db133cb6 6481
f83d2997 6482(defun cperl-set-style (style)
f94a632a 6483 "Set CPerl mode variables to use one of several different indentation styles.
f83d2997 6484The arguments are a string representing the desired style.
5c8b7eaf 6485The list of styles is in `cperl-style-alist', available styles
4ab89e7b 6486are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
db133cb6
RS
6487
6488The current value of style is memorized (unless there is a memorized
6489data already), may be restored by `cperl-set-style-back'.
6490
6491Chosing \"Current\" style will not change style, so this may be used for
4ab89e7b 6492side-effect of memorizing only. Examples in `cperl-style-examples'."
5c8b7eaf 6493 (interactive
15ca5699 6494 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
db133cb6 6495 cperl-style-alist)))
f83d2997 6496 (list (completing-read "Enter style: " list nil 'insist))))
db133cb6
RS
6497 (or cperl-old-style
6498 (setq cperl-old-style
6499 (mapcar (function
6500 (lambda (name)
6501 (cons name (eval name))))
6502 cperl-styles-entries)))
6503 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
f83d2997
KH
6504 (while style
6505 (setq setting (car style) style (cdr style))
db133cb6
RS
6506 (set (car setting) (cdr setting)))))
6507
6508(defun cperl-set-style-back ()
810fb442 6509 "Restore a style memorized by `cperl-set-style'."
db133cb6
RS
6510 (interactive)
6511 (or cperl-old-style (error "The style was not changed"))
6512 (let (setting)
6513 (while cperl-old-style
5c8b7eaf 6514 (setq setting (car cperl-old-style)
db133cb6
RS
6515 cperl-old-style (cdr cperl-old-style))
6516 (set (car setting) (cdr setting)))))
f83d2997
KH
6517
6518(defun cperl-check-syntax ()
6519 (interactive)
6520 (require 'mode-compile)
db133cb6
RS
6521 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6522 (eval '(mode-compile)))) ; Avoid a warning
f83d2997
KH
6523
6524(defun cperl-info-buffer (type)
6525 ;; Returns buffer with documentation. Creates if missing.
6526 ;; If TYPE, this vars buffer.
6527 ;; Special care is taken to not stomp over an existing info buffer
6528 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6529 (info (get-buffer bname))
6530 (oldbuf (get-buffer "*info*")))
6531 (if info info
6532 (save-window-excursion
6533 ;; Get Info running
6534 (require 'info)
6535 (cond (oldbuf
6536 (set-buffer oldbuf)
6537 (rename-buffer "*info-perl-tmp*")))
6538 (save-window-excursion
6539 (info))
6540 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6541 (set-buffer "*info*")
6542 (rename-buffer bname)
6543 (cond (oldbuf
6544 (set-buffer "*info-perl-tmp*")
6545 (rename-buffer "*info*")
6546 (set-buffer bname)))
029cb4d5 6547 (make-local-variable 'window-min-height)
f83d2997
KH
6548 (setq window-min-height 2)
6549 (current-buffer)))))
6550
6551(defun cperl-word-at-point (&optional p)
f94a632a 6552 "Return the word at point or at P."
f83d2997
KH
6553 (save-excursion
6554 (if p (goto-char p))
6555 (or (cperl-word-at-point-hard)
6556 (progn
6557 (require 'etags)
6558 (funcall (or (and (boundp 'find-tag-default-function)
6559 find-tag-default-function)
6560 (get major-mode 'find-tag-default-function)
6561 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6562 ;; automatically used within `find-tag-default':
6563 'find-tag-default))))))
6564
6565(defun cperl-info-on-command (command)
f94a632a 6566 "Show documentation for Perl command COMMAND in other window.
f83d2997
KH
6567If perl-info buffer is shown in some frame, uses this frame.
6568Customized by setting variables `cperl-shrink-wrap-info-frame',
6569`cperl-max-help-size'."
5c8b7eaf 6570 (interactive
f83d2997 6571 (let* ((default (cperl-word-at-point))
5c8b7eaf 6572 (read (read-string
83261a2f
SM
6573 (format "Find doc for Perl function (default %s): "
6574 default))))
5c8b7eaf 6575 (list (if (equal read "")
83261a2f
SM
6576 default
6577 read))))
f83d2997
KH
6578
6579 (let ((buffer (current-buffer))
6580 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6581 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6582 max-height char-height buf-list)
6583 (if (string-match "^-[a-zA-Z]$" command)
6584 (setq cmd-desc "^-X[ \t\n]"))
6585 (setq isvar (string-match "^[$@%]" command)
6586 buf (cperl-info-buffer isvar)
6587 iniwin (selected-window)
6588 fr1 (window-frame iniwin))
6589 (set-buffer buf)
fc49c9c6 6590 (goto-char (point-min))
5c8b7eaf 6591 (or isvar
f83d2997
KH
6592 (progn (re-search-forward "^-X[ \t\n]")
6593 (forward-line -1)))
6594 (if (re-search-forward cmd-desc nil t)
6595 (progn
6596 ;; Go back to beginning of the group (ex, for qq)
6597 (if (re-search-backward "^[ \t\n\f]")
6598 (forward-line 1))
6599 (beginning-of-line)
5c8b7eaf 6600 ;; Get some of
f83d2997
KH
6601 (setq pos (point)
6602 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6603 (while (and (not win) buf-list)
6604 (setq win (get-buffer-window (car buf-list) t))
6605 (setq buf-list (cdr buf-list)))
6606 (or (not win)
6607 (eq (window-buffer win) buf)
6608 (set-window-buffer win buf))
6609 (and win (setq fr2 (window-frame win)))
6610 (if (or (not fr2) (eq fr1 fr2))
6611 (pop-to-buffer buf)
6612 (special-display-popup-frame buf) ; Make it visible
6613 (select-window win))
6614 (goto-char pos) ; Needed (?!).
6615 ;; Resize
6616 (setq iniheight (window-height)
6617 frheight (frame-height)
6618 not-loner (< iniheight (1- frheight))) ; Are not alone
5c8b7eaf 6619 (cond ((if not-loner cperl-max-help-size
f83d2997 6620 cperl-shrink-wrap-info-frame)
5c8b7eaf
SS
6621 (setq height
6622 (+ 2
6623 (count-lines
6624 pos
f83d2997
KH
6625 (save-excursion
6626 (if (re-search-forward
6627 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6628 (match-beginning 0) (point-max)))))
5c8b7eaf 6629 max-height
f83d2997
KH
6630 (if not-loner
6631 (/ (* (- frheight 3) cperl-max-help-size) 100)
6632 (setq char-height (frame-char-height))
6633 ;; Non-functioning under OS/2:
6634 (if (eq char-height 1) (setq char-height 18))
6635 ;; Title, menubar, + 2 for slack
d431decb 6636 (- (/ (display-pixel-height) char-height) 4)))
f83d2997
KH
6637 (if (> height max-height) (setq height max-height))
6638 ;;(message "was %s doing %s" iniheight height)
6639 (if not-loner
6640 (enlarge-window (- height iniheight))
6641 (set-frame-height (window-frame win) (1+ height)))))
6642 (set-window-start (selected-window) pos))
6643 (message "No entry for %s found." command))
6644 ;;(pop-to-buffer buffer)
6645 (select-window iniwin)))
6646
6647(defun cperl-info-on-current-command ()
029cb4d5 6648 "Show documentation for Perl command at point in other window."
f83d2997
KH
6649 (interactive)
6650 (cperl-info-on-command (cperl-word-at-point)))
6651
6652(defun cperl-imenu-info-imenu-search ()
6653 (if (looking-at "^-X[ \t\n]") nil
6654 (re-search-backward
6655 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6656 (forward-line 1)))
6657
5c8b7eaf 6658(defun cperl-imenu-info-imenu-name ()
f83d2997
KH
6659 (buffer-substring
6660 (match-beginning 1) (match-end 1)))
6661
6662(defun cperl-imenu-on-info ()
4ab89e7b
SM
6663 "Shows imenu for Perl Info Buffer.
6664Opens Perl Info buffer if needed."
f83d2997
KH
6665 (interactive)
6666 (let* ((buffer (current-buffer))
6667 imenu-create-index-function
5c8b7eaf
SS
6668 imenu-prev-index-position-function
6669 imenu-extract-index-name-function
f83d2997
KH
6670 (index-item (save-restriction
6671 (save-window-excursion
6672 (set-buffer (cperl-info-buffer nil))
5c8b7eaf 6673 (setq imenu-create-index-function
f83d2997
KH
6674 'imenu-default-create-index-function
6675 imenu-prev-index-position-function
6676 'cperl-imenu-info-imenu-search
6677 imenu-extract-index-name-function
6678 'cperl-imenu-info-imenu-name)
6679 (imenu-choose-buffer-index)))))
6680 (and index-item
6681 (progn
6682 (push-mark)
6683 (pop-to-buffer "*info-perl*")
6684 (cond
6685 ((markerp (cdr index-item))
6686 (goto-char (marker-position (cdr index-item))))
6687 (t
6688 (goto-char (cdr index-item))))
6689 (set-window-start (selected-window) (point))
6690 (pop-to-buffer buffer)))))
6691
6692(defun cperl-lineup (beg end &optional step minshift)
6693 "Lineup construction in a region.
6694Beginning of region should be at the start of a construction.
6695All first occurrences of this construction in the lines that are
6696partially contained in the region are lined up at the same column.
6697
6698MINSHIFT is the minimal amount of space to insert before the construction.
6699STEP is the tabwidth to position constructions.
029cb4d5 6700If STEP is nil, `cperl-lineup-step' will be used
15ca5699 6701\(or `cperl-indent-level', if `cperl-lineup-step' is nil).
f83d2997
KH
6702Will not move the position at the start to the left."
6703 (interactive "r")
4ab89e7b 6704 (let (search col tcol seen b)
f83d2997
KH
6705 (save-excursion
6706 (goto-char end)
6707 (end-of-line)
6708 (setq end (point-marker))
6709 (goto-char beg)
6710 (skip-chars-forward " \t\f")
6711 (setq beg (point-marker))
6712 (indent-region beg end nil)
6713 (goto-char beg)
6714 (setq col (current-column))
6715 (if (looking-at "[a-zA-Z0-9_]")
6716 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6717 (setq search
5c8b7eaf
SS
6718 (concat "\\<"
6719 (regexp-quote
f83d2997
KH
6720 (buffer-substring (match-beginning 0)
6721 (match-end 0))) "\\>"))
6722 (error "Cannot line up in a middle of the word"))
6723 (if (looking-at "$")
6724 (error "Cannot line up end of line"))
6725 (setq search (regexp-quote (char-to-string (following-char)))))
6726 (setq step (or step cperl-lineup-step cperl-indent-level))
6727 (or minshift (setq minshift 1))
6728 (while (progn
6729 (beginning-of-line 2)
5c8b7eaf 6730 (and (< (point) end)
f83d2997
KH
6731 (re-search-forward search end t)
6732 (goto-char (match-beginning 0))))
6733 (setq tcol (current-column) seen t)
6734 (if (> tcol col) (setq col tcol)))
6735 (or seen
6736 (error "The construction to line up occurred only once"))
6737 (goto-char beg)
6738 (setq col (+ col minshift))
6739 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5c8b7eaf 6740 (while
f83d2997 6741 (progn
4ab89e7b 6742 (cperl-make-indent col)
5c8b7eaf
SS
6743 (beginning-of-line 2)
6744 (and (< (point) end)
f83d2997
KH
6745 (re-search-forward search end t)
6746 (goto-char (match-beginning 0)))))))) ; No body
6747
4ab89e7b 6748(defun cperl-etags (&optional add all files) ;; NOT USED???
f83d2997
KH
6749 "Run etags with appropriate options for Perl files.
6750If optional argument ALL is `recursive', will process Perl files
6751in subdirectories too."
6752 (interactive)
6753 (let ((cmd "etags")
4ab89e7b
SM
6754 (args '("-l" "none" "-r"
6755 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6756 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6757 "-r"
6758 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6759 "-r"
6760 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
f83d2997
KH
6761 res)
6762 (if add (setq args (cons "-a" args)))
6763 (or files (setq files (list buffer-file-name)))
6764 (cond
6765 ((eq all 'recursive)
6766 ;;(error "Not implemented: recursive")
5c8b7eaf 6767 (setq args (append (list "-e"
f83d2997
KH
6768 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6769 use File::Find;
6770 find(\\&wanted, '.');
5c8b7eaf 6771 exec @ARGV;"
f83d2997
KH
6772 cmd) args)
6773 cmd "perl"))
5c8b7eaf 6774 (all
f83d2997 6775 ;;(error "Not implemented: all")
5c8b7eaf 6776 (setq args (append (list "-e"
f83d2997 6777 "push @ARGV, <*.PL *.pl *.pm>;
5c8b7eaf 6778 exec @ARGV;"
f83d2997
KH
6779 cmd) args)
6780 cmd "perl"))
6781 (t
6782 (setq args (append args files))))
6783 (setq res (apply 'call-process cmd nil nil nil args))
6784 (or (eq res 0)
6785 (message "etags returned \"%s\"" res))))
6786
6787(defun cperl-toggle-auto-newline ()
6788 "Toggle the state of `cperl-auto-newline'."
6789 (interactive)
6790 (setq cperl-auto-newline (not cperl-auto-newline))
5c8b7eaf 6791 (message "Newlines will %sbe auto-inserted now."
f83d2997
KH
6792 (if cperl-auto-newline "" "not ")))
6793
6794(defun cperl-toggle-abbrev ()
6795 "Toggle the state of automatic keyword expansion in CPerl mode."
6796 (interactive)
6797 (abbrev-mode (if abbrev-mode 0 1))
5c8b7eaf 6798 (message "Perl control structure will %sbe auto-inserted now."
f83d2997
KH
6799 (if abbrev-mode "" "not ")))
6800
6801
6802(defun cperl-toggle-electric ()
6803 "Toggle the state of parentheses doubling in CPerl mode."
6804 (interactive)
6805 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5c8b7eaf 6806 (message "Parentheses will %sbe auto-doubled now."
f83d2997
KH
6807 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6808
db133cb6 6809(defun cperl-toggle-autohelp ()
f739b53b
SM
6810 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6811Delay of auto-help controlled by `cperl-lazy-help-time'."
db133cb6
RS
6812 (interactive)
6813 (if (fboundp 'run-with-idle-timer)
6814 (progn
6815 (if cperl-lazy-installed
f739b53b 6816 (cperl-lazy-unstall)
db133cb6 6817 (cperl-lazy-install))
5c8b7eaf 6818 (message "Perl help messages will %sbe automatically shown now."
db133cb6
RS
6819 (if cperl-lazy-installed "" "not ")))
6820 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6821
6822(defun cperl-toggle-construct-fix ()
6823 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6824 (interactive)
5c8b7eaf 6825 (setq cperl-indent-region-fix-constructs
5bd52f0e
RS
6826 (if cperl-indent-region-fix-constructs
6827 nil
6828 1))
5c8b7eaf 6829 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
db133cb6
RS
6830 (if cperl-indent-region-fix-constructs "" "not ")))
6831
4ab89e7b
SM
6832(defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6833 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6834Nonpositive numeric argument disables debugging messages. The message
6835summarizes which regions it was decided to rescan for syntactic constructs.
6836
6837The message looks like this:
6838
6839 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6840
6841Numbers are character positions in the buffer. REQ provides the range to
6842rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6843for correct operation it should start and end outside any special syntactic
6844construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6845by CPerl."
6846 (interactive "P")
6847 (or arg
cb5bf6ba 6848 (setq arg (if (eq cperl-syntaxify-by-font-lock
4ab89e7b
SM
6849 (if backtrace 'backtrace 'message)) 0 1)))
6850 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6851 (setq cperl-syntaxify-by-font-lock arg)
6852 (message "Debugging messages of syntax unwind %sabled."
6853 (if (eq arg t) "dis" "en")))
6854
f83d2997
KH
6855;;;; Tags file creation.
6856
6857(defvar cperl-tmp-buffer " *cperl-tmp*")
6858
6859(defun cperl-setup-tmp-buf ()
6860 (set-buffer (get-buffer-create cperl-tmp-buffer))
6861 (set-syntax-table cperl-mode-syntax-table)
6862 (buffer-disable-undo)
6863 (auto-fill-mode 0)
6864 (if cperl-use-syntax-table-text-property-for-tags
6865 (progn
029cb4d5 6866 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997
KH
6867 ;; Do not introduce variable if not needed, we check it!
6868 (set 'parse-sexp-lookup-properties t))))
6869
47e83968
GM
6870;; Copied from imenu-example--name-and-position.
6871(defvar imenu-use-markers)
6872
6873(defun cperl-imenu-name-and-position ()
6874 "Return the current/previous sexp and its (beginning) location.
6875Does not move point."
6876 (save-excursion
6877 (forward-sexp -1)
6878 (let ((beg (if imenu-use-markers (point-marker) (point)))
6879 (end (progn (forward-sexp) (point))))
6880 (cons (buffer-substring beg end)
6881 beg))))
6882
f83d2997 6883(defun cperl-xsub-scan ()
f83d2997 6884 (require 'imenu)
5c8b7eaf 6885 (let ((index-alist '())
f83d2997
KH
6886 (prev-pos 0) index index1 name package prefix)
6887 (goto-char (point-min))
f83d2997
KH
6888 ;; Search for the function
6889 (progn ;;save-match-data
6890 (while (re-search-forward
6891 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6892 nil t)
f83d2997 6893 (cond
83261a2f 6894 ((match-beginning 2) ; SECTION
f83d2997
KH
6895 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6896 (goto-char (match-beginning 0))
6897 (skip-chars-forward " \t")
6898 (forward-char 1)
6899 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6900 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6901 (setq prefix nil)))
6902 ((not package) nil) ; C language section
6903 ((match-beginning 3) ; XSUB
6904 (goto-char (1+ (match-beginning 3)))
47e83968 6905 (setq index (cperl-imenu-name-and-position))
f83d2997
KH
6906 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6907 (if (and prefix (string-match (concat "^" prefix) name))
6908 (setq name (substring name (length prefix))))
6909 (cond ((string-match "::" name) nil)
6910 (t
6911 (setq index1 (cons (concat package "::" name) (cdr index)))
6912 (push index1 index-alist)))
6913 (setcar index name)
6914 (push index index-alist))
6915 (t ; BOOT: section
6916 ;; (beginning-of-line)
47e83968 6917 (setq index (cperl-imenu-name-and-position))
f83d2997
KH
6918 (setcar index (concat package "::BOOT:"))
6919 (push index index-alist)))))
f83d2997
KH
6920 index-alist))
6921
6c389151
SM
6922(defvar cperl-unreadable-ok nil)
6923
6924(defun cperl-find-tags (ifile xs topdir)
83261a2f
SM
6925 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6926 (cperl-pod-here-fontify nil) f file)
f83d2997
KH
6927 (save-excursion
6928 (if b (set-buffer b)
83261a2f 6929 (cperl-setup-tmp-buf))
f83d2997 6930 (erase-buffer)
6c389151
SM
6931 (condition-case err
6932 (setq file (car (insert-file-contents ifile)))
6933 (error (if cperl-unreadable-ok nil
6934 (if (y-or-n-p
6935 (format "File %s unreadable. Continue? " ifile))
6936 (setq cperl-unreadable-ok t)
6937 (error "Aborting: unreadable file %s" ifile)))))
a1506d29 6938 (if (not file)
6c389151 6939 (message "Unreadable file %s" ifile)
83261a2f
SM
6940 (message "Scanning file %s ..." file)
6941 (if (and cperl-use-syntax-table-text-property-for-tags
6942 (not xs))
6943 (condition-case err ; after __END__ may have garbage
6944 (cperl-find-pods-heres nil nil noninteractive)
6945 (error (message "While scanning for syntax: %s" err))))
6946 (if xs
6947 (setq lst (cperl-xsub-scan))
6948 (setq ind (cperl-imenu--create-perl-index))
6949 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6950 (setq lst
6951 (mapcar
6952 (function
6953 (lambda (elt)
6954 (cond ((string-match "^[_a-zA-Z]" (car elt))
6955 (goto-char (cdr elt))
6956 (beginning-of-line) ; pos should be of the start of the line
6957 (list (car elt)
6958 (point)
6959 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6960 (buffer-substring (progn
6961 (goto-char (cdr elt))
6962 ;; After name now...
6963 (or (eolp) (forward-char 1))
6964 (point))
6965 (progn
6966 (beginning-of-line)
6967 (point))))))))
6968 lst))
6969 (erase-buffer)
6970 (while lst
6971 (setq elt (car lst) lst (cdr lst))
6972 (if elt
6973 (progn
6974 (insert (elt elt 3)
6975 127
6976 (if (string-match "^package " (car elt))
6977 (substring (car elt) 8)
6978 (car elt) )
6979 1
6980 (number-to-string (elt elt 2)) ; Line
6981 ","
6982 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6983 "\n")
6984 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6985 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
6986 (elt elt 3)))
6987 ;; Need to insert the name without package as well
15ca5699 6988 (setq lst (cons (cons (substring (elt elt 3)
83261a2f
SM
6989 (match-beginning 1)
6990 (match-end 1))
6991 (cdr elt))
6992 lst))))))
6993 (setq pos (point))
6994 (goto-char 1)
6995 (setq rel file)
6996 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
6997 (set-text-properties 0 (length rel) nil rel)
6998 (and (equal topdir (substring rel 0 (length topdir)))
6999 (setq rel (substring file (length topdir))))
7000 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7001 (setq ret (buffer-substring 1 (point-max)))
7002 (erase-buffer)
7003 (or noninteractive
7004 (message "Scanning file %s finished" file))
7005 ret))))
f83d2997
KH
7006
7007(defun cperl-add-tags-recurse-noxs ()
4ab89e7b 7008 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
f83d2997
KH
7009Use as
7010 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
4ab89e7b 7011 -f cperl-add-tags-recurse-noxs
f83d2997
KH
7012"
7013 (cperl-write-tags nil nil t t nil t))
7014
4ab89e7b
SM
7015(defun cperl-add-tags-recurse-noxs-fullpath ()
7016 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7017Writes down fullpath, so TAGS is relocatable (but if the build directory
7018is relocated, the file TAGS inside it breaks). Use as
7019 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7020 -f cperl-add-tags-recurse-noxs-fullpath
7021"
7022 (cperl-write-tags nil nil t t nil t ""))
7023
f83d2997
KH
7024(defun cperl-add-tags-recurse ()
7025 "Add to TAGS file data for Perl files in the current directory and kids.
7026Use as
7027 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 7028 -f cperl-add-tags-recurse
f83d2997
KH
7029"
7030 (cperl-write-tags nil nil t t))
7031
7032(defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7033 ;; If INBUFFER, do not select buffer, and do not save
7034 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7035 (require 'etags)
7036 (if file nil
7037 (setq file (if dir default-directory (buffer-file-name)))
7038 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7039 (or topdir
7040 (setq topdir default-directory))
7041 (let ((tags-file-name "TAGS")
72bc50c0 7042 (case-fold-search (and (featurep 'xemacs) (eq system-type 'emx)))
6c389151 7043 xs rel tm)
f83d2997
KH
7044 (save-excursion
7045 (cond (inbuffer nil) ; Already there
7046 ((file-exists-p tags-file-name)
6546555e 7047 (if (featurep 'xemacs)
5bd52f0e 7048 (visit-tags-table-buffer)
83261a2f 7049 (visit-tags-table-buffer tags-file-name)))
f83d2997
KH
7050 (t (set-buffer (find-file-noselect tags-file-name))))
7051 (cond
7052 (dir
7053 (cond ((eq erase 'ignore))
7054 (erase
7055 (erase-buffer)
7056 (setq erase 'ignore)))
a1506d29 7057 (let ((files
6c389151 7058 (condition-case err
a1506d29 7059 (directory-files file t
6c389151
SM
7060 (if recurse nil cperl-scan-files-regexp)
7061 t)
7062 (error
7063 (if cperl-unreadable-ok nil
7064 (if (y-or-n-p
7065 (format "Directory %s unreadable. Continue? " file))
a1506d29 7066 (setq cperl-unreadable-ok t
83261a2f 7067 tm nil) ; Return empty list
6c389151 7068 (error "Aborting: unreadable directory %s" file)))))))
dba01120
GM
7069 (mapc (function
7070 (lambda (file)
7071 (cond
7072 ((string-match cperl-noscan-files-regexp file)
7073 nil)
7074 ((not (file-directory-p file))
7075 (if (string-match cperl-scan-files-regexp file)
7076 (cperl-write-tags file erase recurse nil t noxs topdir)))
7077 ((not recurse) nil)
7078 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7079 files)))
f83d2997
KH
7080 (t
7081 (setq xs (string-match "\\.xs$" file))
7082 (if (not (and xs noxs))
7083 (progn
7084 (cond ((eq erase 'ignore) (goto-char (point-max)))
83261a2f
SM
7085 (erase (erase-buffer))
7086 (t
7087 (goto-char 1)
7088 (setq rel file)
7089 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7090 (set-text-properties 0 (length rel) nil rel)
7091 (and (equal topdir (substring rel 0 (length topdir)))
7092 (setq rel (substring file (length topdir))))
7093 (if (search-forward (concat "\f\n" rel ",") nil t)
7094 (progn
7095 (search-backward "\f\n")
7096 (delete-region (point)
7097 (save-excursion
7098 (forward-char 1)
7099 (if (search-forward "\f\n"
7100 nil 'toend)
7101 (- (point) 2)
7102 (point-max)))))
7103 (goto-char (point-max)))))
f83d2997 7104 (insert (cperl-find-tags file xs topdir))))))
83261a2f
SM
7105 (if inbuffer nil ; Delegate to the caller
7106 (save-buffer 0) ; No backup
f83d2997
KH
7107 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7108 (initialize-new-tags-table))))))
7109
7110(defvar cperl-tags-hier-regexp-list
5c8b7eaf 7111 (concat
f83d2997
KH
7112 "^\\("
7113 "\\(package\\)\\>"
7114 "\\|"
7115 "sub\\>[^\n]+::"
7116 "\\|"
7117 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7118 "\\|"
7119 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7120 "\\)"))
7121
7122(defvar cperl-hierarchy '(() ())
f94a632a 7123 "Global hierarchy of classes.")
f83d2997
KH
7124
7125(defun cperl-tags-hier-fill ()
7126 ;; Suppose we are in a tag table cooked by cperl.
7127 (goto-char 1)
7128 (let (type pack name pos line chunk ord cons1 file str info fileind)
7129 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5c8b7eaf 7130 (setq pos (match-beginning 0)
f83d2997
KH
7131 pack (match-beginning 2))
7132 (beginning-of-line)
7133 (if (looking-at (concat
7134 "\\([^\n]+\\)"
7135 "\C-?"
7136 "\\([^\n]+\\)"
7137 "\C-a"
7138 "\\([0-9]+\\)"
7139 ","
7140 "\\([0-9]+\\)"))
7141 (progn
7142 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7143 name (buffer-substring (match-beginning 2) (match-end 2))
7144 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5bd52f0e 7145 line (buffer-substring (match-beginning 3) (match-end 3))
f83d2997 7146 ord (if pack 1 0)
f83d2997 7147 file (file-of-tag)
5bd52f0e
RS
7148 fileind (format "%s:%s" file line)
7149 ;; Moves to beginning of the next line:
7150 info (cperl-etags-snarf-tag file line))
f83d2997
KH
7151 ;; Move back
7152 (forward-char -1)
7153 ;; Make new member of hierarchy name ==> file ==> pos if needed
7154 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7155 ;; Name known
7156 (setcdr cons1 (cons (cons fileind (vector file info))
7157 (cdr cons1)))
7158 ;; First occurrence of the name, start alist
7159 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5c8b7eaf 7160 (if pack
f83d2997
KH
7161 (setcar (cdr cperl-hierarchy)
7162 (cons cons1 (nth 1 cperl-hierarchy)))
7163 (setcar cperl-hierarchy
7164 (cons cons1 (car cperl-hierarchy)))))))
7165 (end-of-line))))
7166
e8a11b22 7167(declare-function x-popup-menu "menu.c" (position menu))
f2d9c15f 7168
f83d2997
KH
7169(defun cperl-tags-hier-init (&optional update)
7170 "Show hierarchical menu of classes and methods.
7171Finds info about classes by a scan of loaded TAGS files.
7172Supposes that the TAGS files contain fully qualified function names.
7173One may build such TAGS files from CPerl mode menu."
7174 (interactive)
7175 (require 'etags)
7176 (require 'imenu)
7177 (if (or update (null (nth 2 cperl-hierarchy)))
83261a2f
SM
7178 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7179 (or (nthcdr 2 elt)
7180 ;; Only in one file
7181 (setcdr elt (cdr (nth 1 elt)))))))
7182 pack name cons1 to l1 l2 l3 l4 b)
f83d2997
KH
7183 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7184 (setq cperl-hierarchy (list l1 l2 l3))
6546555e 7185 (if (featurep 'xemacs) ; Not checked
5bd52f0e
RS
7186 (progn
7187 (or tags-file-name
7188 ;; Does this work in XEmacs?
8c777c8d
CY
7189 (call-interactively 'visit-tags-table))
7190 (message "Updating list of classes...")
5bd52f0e
RS
7191 (set-buffer (get-file-buffer tags-file-name))
7192 (cperl-tags-hier-fill))
7193 (or tags-table-list
7194 (call-interactively 'visit-tags-table))
dba01120 7195 (mapc
4ab89e7b
SM
7196 (function
7197 (lambda (tagsfile)
5bd52f0e 7198 (message "Updating list of classes... %s" tagsfile)
8c777c8d
CY
7199 (set-buffer (get-file-buffer tagsfile))
7200 (cperl-tags-hier-fill)))
dba01120 7201 tags-table-list)
5bd52f0e 7202 (message "Updating list of classes... postprocessing..."))
dba01120
GM
7203 (mapc remover (car cperl-hierarchy))
7204 (mapc remover (nth 1 cperl-hierarchy))
f83d2997
KH
7205 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7206 (cons "Methods: " (car cperl-hierarchy))))
7207 (cperl-tags-treeify to 1)
7208 (setcar (nthcdr 2 cperl-hierarchy)
7209 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7210 (message "Updating list of classes: done, requesting display...")
7211 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7212 ))
7213 (or (nth 2 cperl-hierarchy)
7214 (error "No items found"))
7215 (setq update
7216;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
83261a2f
SM
7217 (if (if (fboundp 'display-popup-menus-p)
7218 (let ((f 'display-popup-menus-p))
7219 (funcall f))
7220 window-system)
f83d2997
KH
7221 (x-popup-menu t (nth 2 cperl-hierarchy))
7222 (require 'tmm)
7223 (tmm-prompt (nth 2 cperl-hierarchy))))
7224 (if (and update (listp update))
7225 (progn (while (cdr update) (setq update (cdr update)))
7226 (setq update (car update)))) ; Get the last from the list
5c8b7eaf 7227 (if (vectorp update)
f83d2997
KH
7228 (progn
7229 (find-file (elt update 0))
5bd52f0e 7230 (cperl-etags-goto-tag-location (elt update 1))))
f83d2997
KH
7231 (if (eq update -999) (cperl-tags-hier-init t)))
7232
7233(defun cperl-tags-treeify (to level)
7234 ;; cadr of `to' is read-write. On start it is a cons
5c8b7eaf 7235 (let* ((regexp (concat "^\\(" (mapconcat
f83d2997
KH
7236 'identity
7237 (make-list level "[_a-zA-Z0-9]+")
7238 "::")
7239 "\\)\\(::\\)?"))
7240 (packages (cdr (nth 1 to)))
7241 (methods (cdr (nth 2 to)))
7242 l1 head tail cons1 cons2 ord writeto packs recurse
7243 root-packages root-functions ms many_ms same_name ps
7244 (move-deeper
5c8b7eaf 7245 (function
f83d2997
KH
7246 (lambda (elt)
7247 (cond ((and (string-match regexp (car elt))
7248 (or (eq ord 1) (match-end 2)))
7249 (setq head (substring (car elt) 0 (match-end 1))
5c8b7eaf 7250 tail (if (match-end 2) (substring (car elt)
f83d2997
KH
7251 (match-end 2)))
7252 recurse t)
7253 (if (setq cons1 (assoc head writeto)) nil
7254 ;; Need to init new head
7255 (setcdr writeto (cons (list head (list "Packages: ")
7256 (list "Methods: "))
7257 (cdr writeto)))
7258 (setq cons1 (nth 1 writeto)))
7259 (setq cons2 (nth ord cons1)) ; Either packs or meths
7260 (setcdr cons2 (cons elt (cdr cons2))))
7261 ((eq ord 2)
7262 (setq root-functions (cons elt root-functions)))
7263 (t
7264 (setq root-packages (cons elt root-packages))))))))
7265 (setcdr to l1) ; Init to dynamic space
7266 (setq writeto to)
7267 (setq ord 1)
dba01120 7268 (mapc move-deeper packages)
f83d2997 7269 (setq ord 2)
dba01120 7270 (mapc move-deeper methods)
f83d2997 7271 (if recurse
dba01120 7272 (mapc (function (lambda (elt)
f83d2997 7273 (cperl-tags-treeify elt (1+ level))))
dba01120 7274 (cdr to)))
f83d2997 7275 ;;Now clean up leaders with one child only
dba01120
GM
7276 (mapc (function (lambda (elt)
7277 (if (not (and (listp (cdr elt))
7278 (eq (length elt) 2))) nil
7279 (setcar elt (car (nth 1 elt)))
7280 (setcdr elt (cdr (nth 1 elt))))))
7281 (cdr to))
f83d2997
KH
7282 ;; Sort the roots of subtrees
7283 (if (default-value 'imenu-sort-function)
7284 (setcdr to
7285 (sort (cdr to) (default-value 'imenu-sort-function))))
7286 ;; Now add back functions removed from display
dba01120
GM
7287 (mapc (function (lambda (elt)
7288 (setcdr to (cons elt (cdr to)))))
7289 (if (default-value 'imenu-sort-function)
7290 (nreverse
7291 (sort root-functions (default-value 'imenu-sort-function)))
7292 root-functions))
f83d2997 7293 ;; Now add back packages removed from display
dba01120
GM
7294 (mapc (function (lambda (elt)
7295 (setcdr to (cons (cons (concat "package " (car elt))
7296 (cdr elt))
7297 (cdr to)))))
7298 (if (default-value 'imenu-sort-function)
7299 (nreverse
7300 (sort root-packages (default-value 'imenu-sort-function)))
7301 root-packages))))
f83d2997
KH
7302
7303;;;(x-popup-menu t
5c8b7eaf 7304;;; '(keymap "Name1"
f83d2997 7305;;; ("Ret1" "aa")
5c8b7eaf
SS
7306;;; ("Head1" "ab"
7307;;; keymap "Name2"
f83d2997
KH
7308;;; ("Tail1" "x") ("Tail2" "y"))))
7309
7310(defun cperl-list-fold (list name limit)
7311 (let (list1 list2 elt1 (num 0))
7312 (if (<= (length list) limit) list
7313 (setq list1 nil list2 nil)
7314 (while list
5c8b7eaf 7315 (setq num (1+ num)
f83d2997
KH
7316 elt1 (car list)
7317 list (cdr list))
7318 (if (<= num imenu-max-items)
7319 (setq list2 (cons elt1 list2))
7320 (setq list1 (cons (cons name
7321 (nreverse list2))
7322 list1)
7323 list2 (list elt1)
7324 num 1)))
7325 (nreverse (cons (cons name
7326 (nreverse list2))
7327 list1)))))
7328
7329(defun cperl-menu-to-keymap (menu &optional name)
7330 (let (list)
5c8b7eaf
SS
7331 (cons 'keymap
7332 (mapcar
7333 (function
f83d2997
KH
7334 (lambda (elt)
7335 (cond ((listp (cdr elt))
7336 (setq list (cperl-list-fold
7337 (cdr elt) (car elt) imenu-max-items))
7338 (cons nil
7339 (cons (car elt)
7340 (cperl-menu-to-keymap list))))
7341 (t
7342 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7343 (cperl-list-fold menu "Root" imenu-max-items)))))
7344
7345\f
7346(defvar cperl-bad-style-regexp
7347 (mapconcat 'identity
83261a2f 7348 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
15ca5699 7349 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
83261a2f 7350 "\\|")
f83d2997
KH
7351 "Finds places such that insertion of a whitespace may help a lot.")
7352
5c8b7eaf 7353(defvar cperl-not-bad-style-regexp
15ca5699 7354 (mapconcat
83261a2f 7355 'identity
f83d2997
KH
7356 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7357 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7358 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
4ab89e7b 7359 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
5bd52f0e 7360 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
f83d2997
KH
7361 "-[0-9]" ; -5
7362 "\\+\\+" ; ++var
7363 "--" ; --var
7364 ".->" ; a->b
7365 "->" ; a SPACE ->b
7366 "\\[-" ; a[-1]
5bd52f0e 7367 "\\\\[&$@*\\\\]" ; \&func
f83d2997 7368 "^=" ; =head
5bd52f0e
RS
7369 "\\$." ; $|
7370 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
f83d2997
KH
7371 "||"
7372 "&&"
7373 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
83261a2f 7374 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
f83d2997
KH
7375 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7376 ;;"[*/+-|&<.]+="
7377 )
7378 "\\|")
7379 "If matches at the start of match found by `my-bad-c-style-regexp',
7380insertion of a whitespace will not help.")
7381
7382(defvar found-bad)
7383
7384(defun cperl-find-bad-style ()
7385 "Find places in the buffer where insertion of a whitespace may help.
7386Prompts user for insertion of spaces.
7387Currently it is tuned to C and Perl syntax."
7388 (interactive)
7389 (let (found-bad (p (point)))
7390 (setq last-nonmenu-event 13) ; To disable popup
4ab89e7b 7391 (goto-char (point-min))
f83d2997 7392 (map-y-or-n-p "Insert space here? "
83261a2f 7393 (lambda (arg) (insert " "))
f83d2997 7394 'cperl-next-bad-style
5c8b7eaf 7395 '("location" "locations" "insert a space into")
f83d2997
KH
7396 '((?\C-r (lambda (arg)
7397 (let ((buffer-quit-function
7398 'exit-recursive-edit))
7399 (message "Exit with Esc Esc")
7400 (recursive-edit)
7401 t)) ; Consider acted upon
5c8b7eaf 7402 "edit, exit with Esc Esc")
f83d2997
KH
7403 (?e (lambda (arg)
7404 (let ((buffer-quit-function
7405 'exit-recursive-edit))
7406 (message "Exit with Esc Esc")
7407 (recursive-edit)
7408 t)) ; Consider acted upon
7409 "edit, exit with Esc Esc"))
7410 t)
7411 (if found-bad (goto-char found-bad)
7412 (goto-char p)
7413 (message "No appropriate place found"))))
7414
7415(defun cperl-next-bad-style ()
7416 (let (p (not-found t) (point (point)) found)
7417 (while (and not-found
7418 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7419 (setq p (point))
7420 (goto-char (match-beginning 0))
7421 (if (or
7422 (looking-at cperl-not-bad-style-regexp)
7423 ;; Check for a < -b and friends
7424 (and (eq (following-char) ?\-)
7425 (save-excursion
7426 (skip-chars-backward " \t\n")
07cb2aa3 7427 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
f83d2997
KH
7428 ;; Now check for syntax type
7429 (save-match-data
7430 (setq found (point))
7431 (beginning-of-defun)
7432 (let ((pps (parse-partial-sexp (point) found)))
7433 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7434 (goto-char (match-end 0))
7435 (goto-char (1- p))
7436 (setq not-found nil
7437 found-bad found)))
7438 (not not-found)))
7439
f1d851ae 7440\f
f83d2997 7441;;; Getting help
5c8b7eaf 7442(defvar cperl-have-help-regexp
f83d2997
KH
7443 ;;(concat "\\("
7444 (mapconcat
7445 'identity
83261a2f 7446 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
f83d2997
KH
7447 "[$@]\\^[a-zA-Z]" ; Special variable
7448 "[$@][^ \n\t]" ; Special variable
7449 "-[a-zA-Z]" ; File test
7450 "\\\\[a-zA-Z0]" ; Special chars
83261a2f 7451 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
f83d2997
KH
7452 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7453 "[a-zA-Z_0-9:]+" ; symbol or number
7454 "x="
83261a2f 7455 "#!")
f83d2997 7456 ;;"\\)\\|\\("
83261a2f
SM
7457 "\\|")
7458 ;;"\\)"
7459 ;;)
f83d2997
KH
7460 "Matches places in the buffer we can find help for.")
7461
7462(defvar cperl-message-on-help-error t)
7463(defvar cperl-help-from-timer nil)
7464
7465(defun cperl-word-at-point-hard ()
7466 ;; Does not save-excursion
7467 ;; Get to the something meaningful
7468 (or (eobp) (eolp) (forward-char 1))
5c8b7eaf 7469 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
e180ab9f 7470 (point-at-bol)
f83d2997
KH
7471 'to-beg)
7472 ;; (cond
7473 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7474 ;; (skip-chars-backward " \n\t\r({[]});,")
7475 ;; (or (bobp) (backward-char 1))))
7476 ;; Try to backtrace
7477 (cond
7478 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7479 (skip-chars-backward "a-zA-Z0-9_:")
5c8b7eaf 7480 (cond
f83d2997
KH
7481 ((and (eq (preceding-char) ?^) ; $^I
7482 (eq (char-after (- (point) 2)) ?\$))
7483 (forward-char -2))
7484 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7485 (forward-char -1))
7486 ((and (eq (preceding-char) ?\=)
7487 (eq (current-column) 1))
7488 (forward-char -1))) ; =head1
7489 (if (and (eq (preceding-char) ?\<)
7490 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7491 (forward-char -1)))
7492 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7493 (forward-char -1))
7494 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7495 (forward-char -1))
7496 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7497 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7498 (cond
7499 ((and (eq (preceding-char) ?\$)
7500 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7501 (forward-char -1))
7502 ((and (eq (following-char) ?\>)
7503 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7504 (save-excursion
7505 (forward-sexp -1)
7506 (and (eq (preceding-char) ?\<)
7507 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7508 (search-backward "<"))))
7509 ((and (eq (following-char) ?\$)
7510 (eq (preceding-char) ?\<)
7511 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7512 (forward-char -1)))
7513 (if (looking-at cperl-have-help-regexp)
7514 (buffer-substring (match-beginning 0) (match-end 0))))
7515
7516(defun cperl-get-help ()
7517 "Get one-line docs on the symbol at the point.
7518The data for these docs is a little bit obsolete and may be in fact longer
7519than a line. Your contribution to update/shorten it is appreciated."
7520 (interactive)
7521 (save-match-data ; May be called "inside" query-replace
7522 (save-excursion
7523 (let ((word (cperl-word-at-point-hard)))
7524 (if word
7525 (if (and cperl-help-from-timer ; Bail out if not in mainland
7526 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7527 (or (memq (get-text-property (point) 'face)
7528 '(font-lock-comment-face font-lock-string-face))
7529 (memq (get-text-property (point) 'syntax-type)
7530 '(pod here-doc format))))
7531 nil
7532 (cperl-describe-perl-symbol word))
7533 (if cperl-message-on-help-error
5c8b7eaf 7534 (message "Nothing found for %s..."
f83d2997
KH
7535 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7536
7537;;; Stolen from perl-descr.el by Johan Vromans:
7538
7539(defvar cperl-doc-buffer " *perl-doc*"
7540 "Where the documentation can be found.")
7541
7542(defun cperl-describe-perl-symbol (val)
7543 "Display the documentation of symbol at point, a Perl operator."
7544 (let ((enable-recursive-minibuffers t)
7545 args-file regexp)
7546 (cond
83261a2f
SM
7547 ((string-match "^[&*][a-zA-Z_]" val)
7548 (setq val (concat (substring val 0 1) "NAME")))
7549 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7550 (setq val (concat "@" (substring val 1 (match-end 1)))))
7551 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7552 (setq val (concat "%" (substring val 1 (match-end 1)))))
7553 ((and (string= val "x") (string-match "^x=" val))
7554 (setq val "x="))
7555 ((string-match "^\\$[\C-a-\C-z]" val)
7556 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7557 ((string-match "^CORE::" val)
7558 (setq val "CORE::"))
7559 ((string-match "^SUPER::" val)
7560 (setq val "SUPER::"))
7561 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7562 (setq val "<NAME>")))
5c8b7eaf 7563 (setq regexp (concat "^"
f83d2997 7564 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
5c8b7eaf 7565 (regexp-quote val)
f83d2997
KH
7566 "\\([ \t([/]\\|$\\)"))
7567
7568 ;; get the buffer with the documentation text
7569 (cperl-switch-to-doc-buffer)
7570
7571 ;; lookup in the doc
7572 (goto-char (point-min))
7573 (let ((case-fold-search nil))
5c8b7eaf 7574 (list
f83d2997
KH
7575 (if (re-search-forward regexp (point-max) t)
7576 (save-excursion
7577 (beginning-of-line 1)
7578 (let ((lnstart (point)))
7579 (end-of-line)
7580 (message "%s" (buffer-substring lnstart (point)))))
7581 (if cperl-message-on-help-error
7582 (message "No definition for %s" val)))))))
7583
83261a2f 7584(defvar cperl-short-docs 'please-ignore-this-line
f83d2997
KH
7585 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7586 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
f739b53b 7587... Range (list context); flip/flop [no flop when flip] (scalar context).
5c8b7eaf 7588! ... Logical negation.
f83d2997
KH
7589... != ... Numeric inequality.
7590... !~ ... Search pattern, substitution, or translation (negated).
7591$! In numeric context: errno. In a string context: error string.
7592$\" The separator which joins elements of arrays interpolated in strings.
f739b53b 7593$# The output format for printed numbers. Default is %.15g or close.
f83d2997
KH
7594$$ Process number of this script. Changes in the fork()ed child process.
7595$% The current page number of the currently selected output channel.
7596
7597 The following variables are always local to the current block:
7598
7599$1 Match of the 1st set of parentheses in the last match (auto-local).
7600$2 Match of the 2nd set of parentheses in the last match (auto-local).
7601$3 Match of the 3rd set of parentheses in the last match (auto-local).
7602$4 Match of the 4th set of parentheses in the last match (auto-local).
7603$5 Match of the 5th set of parentheses in the last match (auto-local).
7604$6 Match of the 6th set of parentheses in the last match (auto-local).
7605$7 Match of the 7th set of parentheses in the last match (auto-local).
7606$8 Match of the 8th set of parentheses in the last match (auto-local).
7607$9 Match of the 9th set of parentheses in the last match (auto-local).
7608$& The string matched by the last pattern match (auto-local).
7609$' The string after what was matched by the last match (auto-local).
7610$` The string before what was matched by the last match (auto-local).
7611
7612$( The real gid of this process.
7613$) The effective gid of this process.
7614$* Deprecated: Set to 1 to do multiline matching within a string.
7615$+ The last bracket matched by the last search pattern.
7616$, The output field separator for the print operator.
7617$- The number of lines left on the page.
7618$. The current input line number of the last filehandle that was read.
7619$/ The input record separator, newline by default.
f739b53b 7620$0 Name of the file containing the current perl script (read/write).
f83d2997
KH
7621$: String may be broken after these characters to fill ^-lines in a format.
7622$; Subscript separator for multi-dim array emulation. Default \"\\034\".
7623$< The real uid of this process.
7624$= The page length of the current output channel. Default is 60 lines.
7625$> The effective uid of this process.
7626$? The status returned by the last ``, pipe close or `system'.
7627$@ The perl error message from the last eval or do @var{EXPR} command.
7628$ARGV The name of the current file used with <> .
7629$[ Deprecated: The index of the first element/char in an array/string.
7630$\\ The output record separator for the print operator.
7631$] The perl version string as displayed with perl -v.
7632$^ The name of the current top-of-page format.
7633$^A The current value of the write() accumulator for format() lines.
7634$^D The value of the perl debug (-D) flags.
7635$^E Information about the last system error other than that provided by $!.
7636$^F The highest system file descriptor, ordinarily 2.
7637$^H The current set of syntax checks enabled by `use strict'.
7638$^I The value of the in-place edit extension (perl -i option).
d7584f0f 7639$^L What formats output to perform a formfeed. Default is \\f.
5bd52f0e 7640$^M A buffer for emergency memory allocation when running out of memory.
f83d2997
KH
7641$^O The operating system name under which this copy of Perl was built.
7642$^P Internal debugging flag.
7643$^T The time the script was started. Used by -A/-M/-C file tests.
7644$^W True if warnings are requested (perl -w flag).
7645$^X The name under which perl was invoked (argv[0] in C-speech).
7646$_ The default input and pattern-searching space.
5c8b7eaf 7647$| Auto-flush after write/print on current output channel? Default 0.
f83d2997
KH
7648$~ The name of the current report format.
7649... % ... Modulo division.
7650... %= ... Modulo division assignment.
7651%ENV Contains the current environment.
7652%INC List of files that have been require-d or do-ne.
7653%SIG Used to set signal handlers for various signals.
7654... & ... Bitwise and.
7655... && ... Logical and.
7656... &&= ... Logical and assignment.
7657... &= ... Bitwise and assignment.
7658... * ... Multiplication.
7659... ** ... Exponentiation.
7660*NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7661&NAME(arg0, ...) Subroutine call. Arguments go to @_.
7662... + ... Addition. +EXPR Makes EXPR into scalar context.
7663++ Auto-increment (magical on strings). ++EXPR EXPR++
7664... += ... Addition assignment.
7665, Comma operator.
7666... - ... Subtraction.
7667-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7668... -= ... Subtraction assignment.
7669-A Access time in days since script started.
7670-B File is a non-text (binary) file.
7671-C Inode change time in days since script started.
7672-M Age in days since script started.
7673-O File is owned by real uid.
7674-R File is readable by real uid.
7675-S File is a socket .
7676-T File is a text file.
7677-W File is writable by real uid.
7678-X File is executable by real uid.
7679-b File is a block special file.
7680-c File is a character special file.
7681-d File is a directory.
7682-e File exists .
7683-f File is a plain file.
7684-g File has setgid bit set.
7685-k File has sticky bit set.
7686-l File is a symbolic link.
7687-o File is owned by effective uid.
7688-p File is a named pipe (FIFO).
7689-r File is readable by effective uid.
7690-s File has non-zero size.
7691-t Tests if filehandle (STDIN by default) is opened to a tty.
7692-u File has setuid bit set.
7693-w File is writable by effective uid.
7694-x File is executable by effective uid.
7695-z File has zero size.
7696. Concatenate strings.
f739b53b 7697.. Range (list context); flip/flop (scalar context) operator.
f83d2997
KH
7698.= Concatenate assignment strings
7699... / ... Division. /PATTERN/ioxsmg Pattern match
7700... /= ... Division assignment.
7701/PATTERN/ioxsmg Pattern match.
f739b53b 7702... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
f83d2997
KH
7703<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7704<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7705<> Reads line from union of files in @ARGV (= command line) and STDIN.
7706... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7707... <= ... Numeric less than or equal to.
7708... <=> ... Numeric compare.
7709... = ... Assignment.
7710... == ... Numeric equality.
7711... =~ ... Search pattern, substitution, or translation
7712... > ... Numeric greater than.
7713... >= ... Numeric greater than or equal to.
7714... >> ... Bitwise shift right.
7715... >>= ... Bitwise shift right assignment.
7716... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7717?PATTERN? One-time pattern match.
7718@ARGV Command line arguments (not including the command name - see $0).
7719@INC List of places to look for perl scripts during do/include/use.
f739b53b 7720@_ Parameter array for subroutines; result of split() unless in list context.
d7584f0f 7721\\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
f83d2997
KH
7722\\0 Octal char, e.g. \\033.
7723\\E Case modification terminator. See \\Q, \\L, and \\U.
d7584f0f
AS
7724\\L Lowercase until \\E . See also \\l, lc.
7725\\U Upcase until \\E . See also \\u, uc.
f83d2997
KH
7726\\Q Quote metacharacters until \\E . See also quotemeta.
7727\\a Alarm character (octal 007).
7728\\b Backspace character (octal 010).
7729\\c Control character, e.g. \\c[ .
7730\\e Escape character (octal 033).
7731\\f Formfeed character (octal 014).
7732\\l Lowercase the next character. See also \\L and \\u, lcfirst.
7733\\n Newline character (octal 012 on most systems).
7734\\r Return character (octal 015 on most systems).
7735\\t Tab character (octal 011).
7736\\u Upcase the next character. See also \\U and \\l, ucfirst.
7737\\x Hex character, e.g. \\x1b.
7738... ^ ... Bitwise exclusive or.
7739__END__ Ends program source.
7740__DATA__ Ends program source.
7741__FILE__ Current (source) filename.
7742__LINE__ Current line in current source.
7743__PACKAGE__ Current package.
7744ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7745ARGVOUT Output filehandle with -i flag.
7746BEGIN { ... } Immediately executed (during compilation) piece of code.
7747END { ... } Pseudo-subroutine executed after the script finishes.
6c389151
SM
7748CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7749INIT { ... } Pseudo-subroutine executed before the script starts running.
f83d2997
KH
7750DATA Input filehandle for what follows after __END__ or __DATA__.
7751accept(NEWSOCKET,GENERICSOCKET)
7752alarm(SECONDS)
7753atan2(X,Y)
7754bind(SOCKET,NAME)
7755binmode(FILEHANDLE)
7756caller[(LEVEL)]
7757chdir(EXPR)
7758chmod(LIST)
7759chop[(LIST|VAR)]
7760chown(LIST)
7761chroot(FILENAME)
7762close(FILEHANDLE)
7763closedir(DIRHANDLE)
7764... cmp ... String compare.
7765connect(SOCKET,NAME)
7766continue of { block } continue { block }. Is executed after `next' or at end.
7767cos(EXPR)
7768crypt(PLAINTEXT,SALT)
7769dbmclose(%HASH)
7770dbmopen(%HASH,DBNAME,MODE)
7771defined(EXPR)
7772delete($HASH{KEY})
7773die(LIST)
7774do { ... }|SUBR while|until EXPR executes at least once
7775do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7776dump LABEL
7777each(%HASH)
7778endgrent
7779endhostent
7780endnetent
7781endprotoent
7782endpwent
7783endservent
7784eof[([FILEHANDLE])]
7785... eq ... String equality.
7786eval(EXPR) or eval { BLOCK }
4ab89e7b 7787exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
f83d2997
KH
7788exit(EXPR)
7789exp(EXPR)
7790fcntl(FILEHANDLE,FUNCTION,SCALAR)
7791fileno(FILEHANDLE)
7792flock(FILEHANDLE,OPERATION)
7793for (EXPR;EXPR;EXPR) { ... }
7794foreach [VAR] (@ARRAY) { ... }
7795fork
7796... ge ... String greater than or equal.
7797getc[(FILEHANDLE)]
7798getgrent
7799getgrgid(GID)
7800getgrnam(NAME)
7801gethostbyaddr(ADDR,ADDRTYPE)
7802gethostbyname(NAME)
7803gethostent
7804getlogin
7805getnetbyaddr(ADDR,ADDRTYPE)
7806getnetbyname(NAME)
7807getnetent
7808getpeername(SOCKET)
7809getpgrp(PID)
7810getppid
7811getpriority(WHICH,WHO)
7812getprotobyname(NAME)
7813getprotobynumber(NUMBER)
7814getprotoent
7815getpwent
7816getpwnam(NAME)
7817getpwuid(UID)
7818getservbyname(NAME,PROTO)
7819getservbyport(PORT,PROTO)
7820getservent
7821getsockname(SOCKET)
7822getsockopt(SOCKET,LEVEL,OPTNAME)
7823gmtime(EXPR)
7824goto LABEL
f83d2997
KH
7825... gt ... String greater than.
7826hex(EXPR)
7827if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7828index(STR,SUBSTR[,OFFSET])
7829int(EXPR)
7830ioctl(FILEHANDLE,FUNCTION,SCALAR)
7831join(EXPR,LIST)
7832keys(%HASH)
7833kill(LIST)
7834last [LABEL]
7835... le ... String less than or equal.
7836length(EXPR)
7837link(OLDFILE,NEWFILE)
7838listen(SOCKET,QUEUESIZE)
7839local(LIST)
7840localtime(EXPR)
7841log(EXPR)
7842lstat(EXPR|FILEHANDLE|VAR)
7843... lt ... String less than.
7844m/PATTERN/iogsmx
7845mkdir(FILENAME,MODE)
7846msgctl(ID,CMD,ARG)
7847msgget(KEY,FLAGS)
7848msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7849msgsnd(ID,MSG,FLAGS)
7850my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6c389151 7851our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
f83d2997
KH
7852... ne ... String inequality.
7853next [LABEL]
7854oct(EXPR)
7855open(FILEHANDLE[,EXPR])
7856opendir(DIRHANDLE,EXPR)
7857ord(EXPR) ASCII value of the first char of the string.
7858pack(TEMPLATE,LIST)
7859package NAME Introduces package context.
7860pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7861pop(ARRAY)
7862print [FILEHANDLE] [(LIST)]
7863printf [FILEHANDLE] (FORMAT,LIST)
7864push(ARRAY,LIST)
7865q/STRING/ Synonym for 'STRING'
7866qq/STRING/ Synonym for \"STRING\"
7867qx/STRING/ Synonym for `STRING`
7868rand[(EXPR)]
7869read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7870readdir(DIRHANDLE)
7871readlink(EXPR)
7872recv(SOCKET,SCALAR,LEN,FLAGS)
7873redo [LABEL]
7874rename(OLDNAME,NEWNAME)
7875require [FILENAME | PERL_VERSION]
7876reset[(EXPR)]
7877return(LIST)
7878reverse(LIST)
7879rewinddir(DIRHANDLE)
7880rindex(STR,SUBSTR[,OFFSET])
7881rmdir(FILENAME)
7882s/PATTERN/REPLACEMENT/gieoxsm
7883scalar(EXPR)
7884seek(FILEHANDLE,POSITION,WHENCE)
7885seekdir(DIRHANDLE,POS)
7886select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7887semctl(ID,SEMNUM,CMD,ARG)
7888semget(KEY,NSEMS,SIZE,FLAGS)
7889semop(KEY,...)
7890send(SOCKET,MSG,FLAGS[,TO])
7891setgrent
7892sethostent(STAYOPEN)
7893setnetent(STAYOPEN)
7894setpgrp(PID,PGRP)
7895setpriority(WHICH,WHO,PRIORITY)
7896setprotoent(STAYOPEN)
7897setpwent
7898setservent(STAYOPEN)
7899setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7900shift[(ARRAY)]
7901shmctl(ID,CMD,ARG)
7902shmget(KEY,SIZE,FLAGS)
7903shmread(ID,VAR,POS,SIZE)
7904shmwrite(ID,STRING,POS,SIZE)
7905shutdown(SOCKET,HOW)
7906sin(EXPR)
7907sleep[(EXPR)]
7908socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7909socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7910sort [SUBROUTINE] (LIST)
7911splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7912split[(/PATTERN/[,EXPR[,LIMIT]])]
7913sprintf(FORMAT,LIST)
7914sqrt(EXPR)
7915srand(EXPR)
7916stat(EXPR|FILEHANDLE|VAR)
7917study[(SCALAR)]
7918sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7919substr(EXPR,OFFSET[,LEN])
7920symlink(OLDFILE,NEWFILE)
7921syscall(LIST)
7922sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
4ab89e7b 7923system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
f83d2997
KH
7924syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7925tell[(FILEHANDLE)]
7926telldir(DIRHANDLE)
7927time
7928times
7929tr/SEARCHLIST/REPLACEMENTLIST/cds
7930truncate(FILE|EXPR,LENGTH)
7931umask[(EXPR)]
7932undef[(EXPR)]
7933unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7934unlink(LIST)
7935unpack(TEMPLATE,EXPR)
7936unshift(ARRAY,LIST)
7937until (EXPR) { ... } EXPR until EXPR
7938utime(LIST)
7939values(%HASH)
7940vec(EXPR,OFFSET,BITS)
7941wait
7942waitpid(PID,FLAGS)
7943wantarray Returns true if the sub/eval is called in list context.
7944warn(LIST)
7945while (EXPR) { ... } EXPR while EXPR
7946write[(EXPR|FILEHANDLE)]
7947... x ... Repeat string or array.
7948x= ... Repetition assignment.
7949y/SEARCHLIST/REPLACEMENTLIST/
7950... | ... Bitwise or.
7951... || ... Logical or.
7952~ ... Unary bitwise complement.
db133cb6 7953#! OS interpreter indicator. If contains `perl', used for options, and -x.
f83d2997
KH
7954AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7955CORE:: Prefix to access builtin function if imported sub obscures it.
7956SUPER:: Prefix to lookup for a method in @ISA classes.
7957DESTROY Shorthand for `sub DESTROY {...}'.
7958... EQ ... Obsolete synonym of `eq'.
7959... GE ... Obsolete synonym of `ge'.
7960... GT ... Obsolete synonym of `gt'.
7961... LE ... Obsolete synonym of `le'.
7962... LT ... Obsolete synonym of `lt'.
7963... NE ... Obsolete synonym of `ne'.
7964abs [ EXPR ] absolute value
7965... and ... Low-precedence synonym for &&.
7966bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7967chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7968chr Converts a number to char with the same ordinal.
7969else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7970elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
83261a2f 7971exists $HASH{KEY} True if the key exists.
f83d2997
KH
7972format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7973formline PICTURE, LIST Backdoor into \"format\" processing.
7974glob EXPR Synonym of <EXPR>.
7975lc [ EXPR ] Returns lowercased EXPR.
7976lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
db133cb6 7977grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
f83d2997
KH
7978map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7979no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7980not ... Low-precedence synonym for ! - negation.
7981... or ... Low-precedence synonym for ||.
7982pos STRING Set/Get end-position of the last match over this string, see \\G.
7983quotemeta [ EXPR ] Quote regexp metacharacters.
7984qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7985readline FH Synonym of <FH>.
7986readpipe CMD Synonym of `CMD`.
7987ref [ EXPR ] Type of EXPR when dereferenced.
7988sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7989tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7990tied Returns internal object for a tied data.
7991uc [ EXPR ] Returns upcased EXPR.
7992ucfirst [ EXPR ] Returns EXPR with upcased first letter.
7993untie VAR Unlink an object from a simple Perl variable.
7994use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
7995... xor ... Low-precedence synonym for exclusive or.
d7584f0f 7996prototype \\&SUB Returns prototype of the function given a reference.
f83d2997
KH
7997=head1 Top-level heading.
7998=head2 Second-level heading.
7999=head3 Third-level heading (is there such?).
8000=over [ NUMBER ] Start list.
8001=item [ TITLE ] Start new item in the list.
8002=back End list.
8003=cut Switch from POD to Perl.
8004=pod Switch from Perl to POD.
8005")
8006
21df56d5 8007(defun cperl-switch-to-doc-buffer (&optional interactive)
f83d2997 8008 "Go to the perl documentation buffer and insert the documentation."
21df56d5 8009 (interactive "p")
f83d2997 8010 (let ((buf (get-buffer-create cperl-doc-buffer)))
21df56d5 8011 (if interactive
f83d2997
KH
8012 (switch-to-buffer-other-window buf)
8013 (set-buffer buf))
8014 (if (= (buffer-size) 0)
8015 (progn
8016 (insert (documentation-property 'cperl-short-docs
8017 'variable-documentation))
8018 (setq buffer-read-only t)))))
8019
6c389151 8020(defun cperl-beautify-regexp-piece (b e embed level)
f83d2997
KH
8021 ;; b is before the starting delimiter, e before the ending
8022 ;; e should be a marker, may be changed, but remains "correct".
e7f767c2 8023 ;; EMBED is nil if we process the whole REx.
4ab89e7b 8024 ;; The REx is guaranteed to have //x
6c389151
SM
8025 ;; LEVEL shows how many levels deep to go
8026 ;; position at enter and at leave is not defined
8027 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8c777c8d
CY
8028 (if embed
8029 (progn
8030 (goto-char b)
8031 (setq c (if (eq embed t) (current-indentation) (current-column)))
8032 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8033 (forward-char 2)
8034 (delete-char 1)
8035 (forward-char 1))
8036 ((looking-at "(\\?[^a-zA-Z]")
8037 (forward-char 3))
8038 ((looking-at "(\\?") ; (?i)
8039 (forward-char 2))
8040 (t
8041 (forward-char 1))))
8042 (goto-char (1+ b))
8043 (setq c (1- (current-column))))
8044 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
f83d2997
KH
8045 (or (looking-at "[ \t]*[\n#]")
8046 (progn
8047 (insert "\n")))
8048 (goto-char e)
8049 (beginning-of-line)
8050 (if (re-search-forward "[^ \t]" e t)
83261a2f 8051 (progn ; Something before the ending delimiter
f83d2997 8052 (goto-char e)
6c389151 8053 (delete-horizontal-space)
f83d2997 8054 (insert "\n")
4ab89e7b 8055 (cperl-make-indent c)
f83d2997
KH
8056 (set-marker e (point))))
8057 (goto-char b)
8058 (end-of-line 2)
8059 (while (< (point) (marker-position e))
8060 (beginning-of-line)
8061 (setq s (point)
8062 inline t)
8063 (skip-chars-forward " \t")
8064 (delete-region s (point))
4ab89e7b 8065 (cperl-make-indent c1)
f83d2997
KH
8066 (while (and
8067 inline
5c8b7eaf 8068 (looking-at
f83d2997
KH
8069 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8070 "\\|" ; Embedded variable
8071 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8072 "\\|" ; $ ^
8073 "[$^]"
8074 "\\|" ; simple-code simple-code*?
8075 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8076 "\\|" ; Class
8077 "\\(\\[\\)" ; 6
8078 "\\|" ; Grouping
8079 "\\((\\(\\?\\)?\\)" ; 7 8
8080 "\\|" ; |
83261a2f 8081 "\\(|\\)"))) ; 9
f83d2997
KH
8082 (goto-char (match-end 0))
8083 (setq spaces t)
8084 (cond ((match-beginning 1) ; Alphanum word + junk
8085 (forward-char -1))
8086 ((or (match-beginning 3) ; $ab[12]
8087 (and (match-beginning 5) ; X* X+ X{2,3}
8088 (eq (preceding-char) ?\{)))
8089 (forward-char -1)
8090 (forward-sexp 1))
4ab89e7b
SM
8091 ((and ; [], already syntaxified
8092 (match-beginning 6)
8093 cperl-regexp-scan
8094 cperl-use-syntax-table-text-property)
8095 (forward-char -1)
8096 (forward-sexp 1)
8097 (or (eq (preceding-char) ?\])
8098 (error "[]-group not terminated"))
8099 (re-search-forward
8100 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8101 ((match-beginning 6) ; []
8102 (setq tmp (point))
8103 (if (looking-at "\\^?\\]")
8104 (goto-char (match-end 0)))
6c389151
SM
8105 ;; XXXX POSIX classes?!
8106 (while (and (not pos)
8107 (re-search-forward "\\[:\\|\\]" e t))
8108 (if (eq (preceding-char) ?:)
8109 (or (re-search-forward ":\\]" e t)
8110 (error "[:POSIX:]-group in []-group not terminated"))
8111 (setq pos t)))
8112 (or (eq (preceding-char) ?\])
8113 (error "[]-group not terminated"))
4ab89e7b
SM
8114 (re-search-forward
8115 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8116 ((match-beginning 7) ; ()
8117 (goto-char (match-beginning 0))
6c389151
SM
8118 (setq pos (current-column))
8119 (or (eq pos c1)
f83d2997 8120 (progn
6c389151 8121 (delete-horizontal-space)
f83d2997 8122 (insert "\n")
4ab89e7b 8123 (cperl-make-indent c1)))
f83d2997
KH
8124 (setq tmp (point))
8125 (forward-sexp 1)
8126 ;; (or (forward-sexp 1)
8127 ;; (progn
8128 ;; (goto-char tmp)
8129 ;; (error "()-group not terminated")))
8130 (set-marker m (1- (point)))
8131 (set-marker m1 (point))
6c389151
SM
8132 (if (= level 1)
8133 (if (progn ; indent rigidly if multiline
a1506d29 8134 ;; In fact does not make a lot of sense, since
6c389151
SM
8135 ;; the starting position can be already lost due
8136 ;; to insertion of "\n" and " "
8137 (goto-char tmp)
8138 (search-forward "\n" m1 t))
8139 (indent-rigidly (point) m1 (- c1 pos)))
8140 (setq level (1- level))
8141 (cond
8142 ((not (match-beginning 8))
8143 (cperl-beautify-regexp-piece tmp m t level))
8144 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8145 t)
8146 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8147 (goto-char (+ 2 tmp))
8148 (forward-sexp 1)
8149 (cperl-beautify-regexp-piece (point) m t level))
8150 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8151 (goto-char (+ 3 tmp))
8152 (cperl-beautify-regexp-piece (point) m t level))
8153 (t
8154 (cperl-beautify-regexp-piece tmp m t level))))
f83d2997
KH
8155 (goto-char m1)
8156 (cond ((looking-at "[*+?]\\??")
8157 (goto-char (match-end 0)))
8158 ((eq (following-char) ?\{)
8159 (forward-sexp 1)
8160 (if (eq (following-char) ?\?)
8161 (forward-char))))
8162 (skip-chars-forward " \t")
8163 (setq spaces nil)
8164 (if (looking-at "[#\n]")
8165 (progn
8166 (or (eolp) (indent-for-comment))
8167 (beginning-of-line 2))
6c389151 8168 (delete-horizontal-space)
f83d2997
KH
8169 (insert "\n"))
8170 (end-of-line)
8171 (setq inline nil))
8172 ((match-beginning 9) ; |
8173 (forward-char -1)
8174 (setq tmp (point))
8175 (beginning-of-line)
8176 (if (re-search-forward "[^ \t]" tmp t)
8177 (progn
8178 (goto-char tmp)
6c389151 8179 (delete-horizontal-space)
f83d2997
KH
8180 (insert "\n"))
8181 ;; first at line
8182 (delete-region (point) tmp))
4ab89e7b 8183 (cperl-make-indent c)
f83d2997
KH
8184 (forward-char 1)
8185 (skip-chars-forward " \t")
8186 (setq spaces nil)
8187 (if (looking-at "[#\n]")
8188 (beginning-of-line 2)
6c389151 8189 (delete-horizontal-space)
f83d2997
KH
8190 (insert "\n"))
8191 (end-of-line)
8192 (setq inline nil)))
8193 (or (looking-at "[ \t\n]")
8194 (not spaces)
8195 (insert " "))
8196 (skip-chars-forward " \t"))
83261a2f
SM
8197 (or (looking-at "[#\n]")
8198 (error "Unknown code `%s' in a regexp"
8199 (buffer-substring (point) (1+ (point)))))
8200 (and inline (end-of-line 2)))
f83d2997
KH
8201 ;; Special-case the last line of group
8202 (if (and (>= (point) (marker-position e))
8203 (/= (current-indentation) c))
8204 (progn
83261a2f 8205 (beginning-of-line)
4ab89e7b 8206 (cperl-make-indent c)))))
f83d2997
KH
8207
8208(defun cperl-make-regexp-x ()
db133cb6 8209 ;; Returns position of the start
6c389151 8210 ;; XXX this is called too often! Need to cache the result!
f83d2997
KH
8211 (save-excursion
8212 (or cperl-use-syntax-table-text-property
5bd52f0e 8213 (error "I need to have a regexp marked!"))
f83d2997 8214 ;; Find the start
db133cb6
RS
8215 (if (looking-at "\\s|")
8216 nil ; good already
8c777c8d
CY
8217 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8218 (and (eq (preceding-char) ?q)
8219 (looking-at "\\(r\\)\\s|")))
8220 (goto-char (match-end 1))
83261a2f 8221 (re-search-backward "\\s|"))) ; Assume it is scanned already.
f83d2997
KH
8222 ;;(forward-char 1)
8223 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8224 (sub-p (eq (preceding-char) ?s)) s)
8225 (forward-sexp 1)
8226 (set-marker e (1- (point)))
8227 (setq delim (preceding-char))
8228 (if (and sub-p (eq delim (char-after (- (point) 2))))
8229 (error "Possible s/blah// - do not know how to deal with"))
8230 (if sub-p (forward-sexp 1))
5c8b7eaf 8231 (if (looking-at "\\sw*x")
f83d2997
KH
8232 (setq have-x t)
8233 (insert "x"))
8234 ;; Protect fragile " ", "#"
8235 (if have-x nil
8236 (goto-char (1+ b))
8237 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8238 (forward-char -1)
8239 (insert "\\")
8240 (forward-char 1)))
8241 b)))
8242
6c389151 8243(defun cperl-beautify-regexp (&optional deep)
f94a632a 8244 "Do it. (Experimental, may change semantics, recheck the result.)
f83d2997 8245We suppose that the regexp is scanned already."
6c389151 8246 (interactive "P")
0c602a0f 8247 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8248 (save-excursion
8249 (goto-char (cperl-make-regexp-x))
8250 (let ((b (point)) (e (make-marker)))
8251 (forward-sexp 1)
8252 (set-marker e (1- (point)))
8253 (cperl-beautify-regexp-piece b e nil deep))))
f83d2997 8254
db133cb6
RS
8255(defun cperl-regext-to-level-start ()
8256 "Goto start of an enclosing group in regexp.
f83d2997
KH
8257We suppose that the regexp is scanned already."
8258 (interactive)
db133cb6 8259 (let ((limit (cperl-make-regexp-x)) done)
f83d2997
KH
8260 (while (not done)
8261 (or (eq (following-char) ?\()
db133cb6 8262 (search-backward "(" (1+ limit) t)
f83d2997
KH
8263 (error "Cannot find `(' which starts a group"))
8264 (setq done
8265 (save-excursion
8266 (skip-chars-backward "\\")
8267 (looking-at "\\(\\\\\\\\\\)*(")))
db133cb6
RS
8268 (or done (forward-char -1)))))
8269
8270(defun cperl-contract-level ()
5bd52f0e 8271 "Find an enclosing group in regexp and contract it.
db133cb6
RS
8272\(Experimental, may change semantics, recheck the result.)
8273We suppose that the regexp is scanned already."
8274 (interactive)
6c389151 8275 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
83261a2f 8276 (cperl-regext-to-level-start)
4ab89e7b 8277 (let ((b (point)) (e (make-marker)) c)
83261a2f
SM
8278 (forward-sexp 1)
8279 (set-marker e (1- (point)))
8280 (goto-char b)
8281 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8282 (cond
8283 ((match-beginning 1) ; #-comment
8284 (or c (setq c (current-indentation)))
8285 (beginning-of-line 2) ; Skip
4ab89e7b 8286 (cperl-make-indent c))
83261a2f
SM
8287 (t
8288 (delete-char -1)
8289 (just-one-space))))))
db133cb6
RS
8290
8291(defun cperl-contract-levels ()
5bd52f0e 8292 "Find an enclosing group in regexp and contract all the kids.
db133cb6
RS
8293\(Experimental, may change semantics, recheck the result.)
8294We suppose that the regexp is scanned already."
8295 (interactive)
6c389151
SM
8296 (save-excursion
8297 (condition-case nil
8298 (cperl-regext-to-level-start)
8299 (error ; We are outside outermost group
5efe6a56
SM
8300 (goto-char (cperl-make-regexp-x))))
8301 (let ((b (point)) (e (make-marker)) s c)
8302 (forward-sexp 1)
8303 (set-marker e (1- (point)))
8304 (goto-char (1+ b))
8305 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
a1506d29 8306 (cond
6c389151
SM
8307 ((match-beginning 1) ; Skip
8308 nil)
8309 (t ; Group
8310 (cperl-contract-level)))))))
f83d2997 8311
6c389151 8312(defun cperl-beautify-level (&optional deep)
f83d2997
KH
8313 "Find an enclosing group in regexp and beautify it.
8314\(Experimental, may change semantics, recheck the result.)
8315We suppose that the regexp is scanned already."
6c389151 8316 (interactive "P")
0c602a0f 8317 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8318 (save-excursion
8319 (cperl-regext-to-level-start)
8320 (let ((b (point)) (e (make-marker)))
8321 (forward-sexp 1)
8322 (set-marker e (1- (point)))
8c777c8d 8323 (cperl-beautify-regexp-piece b e 'level deep))))
db133cb6 8324
4ab89e7b
SM
8325(defun cperl-invert-if-unless-modifiers ()
8326 "Change `B if A;' into `if (A) {B}' etc if possible.
8327\(Unfinished.)"
8c777c8d 8328 (interactive)
4ab89e7b
SM
8329 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8330 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8331 (and (= (char-syntax (preceding-char)) ?w)
8332 (forward-sexp -1))
8333 (setq pre-if (point))
8334 (cperl-backward-to-start-of-expr)
8335 (setq pre-B (point))
8336 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8337 (cperl-forward-to-end-of-expr)
8338 (setq post-A (point))
8339 (goto-char pre-if)
8340 (or (looking-at w-rex)
8341 ;; Find the position
8342 (progn (goto-char post-A)
8343 (while (and
8344 (not (looking-at w-rex))
8345 (> (point) pre-B))
8346 (forward-sexp -1))
8347 (setq pre-if (point))))
8348 (or (looking-at w-rex)
8349 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8350 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8351 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8352 ;; First, simple part: find code boundaries
8353 (forward-sexp 1)
8354 (setq post-if (point))
8355 (forward-sexp -2)
8356 (forward-sexp 1)
8357 (setq post-B (point))
8358 (cperl-backward-to-start-of-expr)
8359 (setq pre-B (point))
8360 (setq B (buffer-substring pre-B post-B))
8361 (goto-char pre-if)
8362 (forward-sexp 2)
8363 (forward-sexp -1)
8364 ;; May be after $, @, $# etc of a variable
8365 (skip-chars-backward "$@%#")
8366 (setq pre-A (point))
8367 (cperl-forward-to-end-of-expr)
8368 (setq post-A (point))
8369 (setq A (buffer-substring pre-A post-A))
8370 ;; Now modify (from end, to not break the stuff)
8371 (skip-chars-forward " \t;")
8372 (delete-region pre-A (point)) ; we move to pre-A
8373 (insert "\n" B ";\n}")
8374 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8375 (delete-region pre-if post-if)
8376 (delete-region pre-B post-B)
8377 (goto-char pre-B)
8378 (insert if-string " (" A ") {")
8379 (setq post-B (point))
8380 (if (looking-at "[ \t]+$")
8381 (delete-horizontal-space)
8382 (if (looking-at "[ \t]*#")
8383 (cperl-indent-for-comment)
8384 (just-one-space)))
8385 (forward-line 1)
8386 (if (looking-at "[ \t]*$")
8387 (progn ; delete line
8388 (delete-horizontal-space)
8389 (delete-region (point) (1+ (point)))))
8390 (cperl-indent-line)
8391 (goto-char (1- post-B))
8392 (forward-sexp 1)
8393 (cperl-indent-line)
8394 (goto-char pre-B)))
8395
db133cb6 8396(defun cperl-invert-if-unless ()
4ab89e7b
SM
8397 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8398If the cursor is not on the leading keyword of the BLOCK flavor of
8399construct, will assume it is the STATEMENT flavor, so will try to find
8400the appropriate statement modifier."
db133cb6 8401 (interactive)
4ab89e7b
SM
8402 (and (= (char-syntax (preceding-char)) ?w)
8403 (forward-sexp -1))
6c389151 8404 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
4ab89e7b
SM
8405 (let ((pre-if (point))
8406 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8407 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
db133cb6 8408 (forward-sexp 2)
4ab89e7b 8409 (setq post-A (point))
db133cb6 8410 (forward-sexp -1)
4ab89e7b
SM
8411 (setq pre-A (point))
8412 (setq is-block (and (eq (following-char) ?\( )
8413 (save-excursion
8414 (condition-case nil
8415 (progn
8416 (forward-sexp 2)
8417 (forward-sexp -1)
8418 (eq (following-char) ?\{ ))
8419 (error nil)))))
8420 (if is-block
db133cb6 8421 (progn
4ab89e7b 8422 (goto-char post-A)
db133cb6 8423 (forward-sexp 1)
4ab89e7b 8424 (setq post-B (point))
db133cb6 8425 (forward-sexp -1)
4ab89e7b 8426 (setq pre-B (point))
db133cb6
RS
8427 (if (and (eq (following-char) ?\{ )
8428 (progn
4ab89e7b 8429 (cperl-backward-to-noncomment post-A)
db133cb6
RS
8430 (eq (preceding-char) ?\) )))
8431 (if (condition-case nil
8432 (progn
4ab89e7b 8433 (goto-char post-B)
db133cb6
RS
8434 (forward-sexp 1)
8435 (forward-sexp -1)
8436 (looking-at "\\<els\\(e\\|if\\)\\>"))
8437 (error nil))
8438 (error
4ab89e7b
SM
8439 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8440 (goto-char (1- post-B))
8441 (cperl-backward-to-noncomment pre-B)
db133cb6
RS
8442 (if (eq (preceding-char) ?\;)
8443 (forward-char -1))
4ab89e7b
SM
8444 (setq end-B-code (point))
8445 (goto-char pre-B)
8446 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
db133cb6 8447 (setq p (match-beginning 0)
4ab89e7b
SM
8448 A (buffer-substring p (match-end 0))
8449 state (parse-partial-sexp pre-B p))
5c8b7eaf 8450 (or (nth 3 state)
db133cb6
RS
8451 (nth 4 state)
8452 (nth 5 state)
4ab89e7b 8453 (error "`%s' inside `%s' BLOCK" A if-string))
db133cb6
RS
8454 (goto-char (match-end 0)))
8455 ;; Finally got it
4ab89e7b 8456 (goto-char (1+ pre-B))
db133cb6 8457 (skip-chars-forward " \t\n")
4ab89e7b
SM
8458 (setq B (buffer-substring (point) end-B-code))
8459 (goto-char end-B-code)
db133cb6
RS
8460 (or (looking-at ";?[ \t\n]*}")
8461 (progn
8462 (skip-chars-forward "; \t\n")
4ab89e7b
SM
8463 (setq B-comment
8464 (buffer-substring (point) (1- post-B)))))
8465 (and (equal B "")
8466 (setq B "1"))
8467 (goto-char (1- post-A))
8468 (cperl-backward-to-noncomment pre-A)
db133cb6 8469 (or (looking-at "[ \t\n]*)")
4ab89e7b 8470 (goto-char (1- post-A)))
db133cb6 8471 (setq p (point))
4ab89e7b 8472 (goto-char (1+ pre-A))
db133cb6 8473 (skip-chars-forward " \t\n")
4ab89e7b
SM
8474 (setq A (buffer-substring (point) p))
8475 (delete-region pre-B post-B)
8476 (delete-region pre-A post-A)
8477 (goto-char pre-if)
8478 (insert B " ")
8479 (and B-comment (insert B-comment " "))
db133cb6
RS
8480 (just-one-space)
8481 (forward-word 1)
4ab89e7b
SM
8482 (setq pre-A (point))
8483 (insert " " A ";")
6c389151 8484 (delete-horizontal-space)
4ab89e7b
SM
8485 (setq post-B (point))
8486 (if (looking-at "#")
8487 (indent-for-comment))
8488 (goto-char post-B)
db133cb6
RS
8489 (forward-char -1)
8490 (delete-horizontal-space)
4ab89e7b 8491 (goto-char pre-A)
db133cb6 8492 (just-one-space)
4ab89e7b
SM
8493 (goto-char pre-if)
8494 (setq pre-A (set-marker (make-marker) pre-A))
8495 (while (<= (point) (marker-position pre-A))
8496 (cperl-indent-line)
8497 (forward-line 1))
8498 (goto-char (marker-position pre-A))
8499 (if B-comment
8500 (progn
8501 (forward-line -1)
8502 (indent-for-comment)
8503 (goto-char (marker-position pre-A)))))
8504 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8505 ;; (error "`%s' not with an (EXPR)" if-string)
8506 (forward-sexp -1)
8507 (cperl-invert-if-unless-modifiers)))
8508 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8509 (cperl-invert-if-unless-modifiers)))
db133cb6 8510
5bd52f0e 8511;;; By Anthony Foiani <afoiani@uswest.com>
b7ec9e59
RS
8512;;; Getting help on modules in C-h f ?
8513;;; This is a modified version of `man'.
8514;;; Need to teach it how to lookup functions
4ab89e7b 8515;;;###autoload
b7ec9e59
RS
8516(defun cperl-perldoc (word)
8517 "Run `perldoc' on WORD."
8518 (interactive
8519 (list (let* ((default-entry (cperl-word-at-point))
8520 (input (read-string
8521 (format "perldoc entry%s: "
8522 (if (string= default-entry "")
8523 ""
8524 (format " (default %s)" default-entry))))))
8525 (if (string= input "")
8526 (if (string= default-entry "")
8527 (error "No perldoc args given")
8528 default-entry)
8529 input))))
a8e1e57f 8530 (require 'man)
f739b53b
SM
8531 (let* ((case-fold-search nil)
8532 (is-func (and
b7ec9e59
RS
8533 (string-match "^[a-z]+$" word)
8534 (string-match (concat "^" word "\\>")
8535 (documentation-property
8536 'cperl-short-docs
8537 'variable-documentation))))
8c777c8d 8538 (Man-switches "")
b7ec9e59 8539 (manual-program (if is-func "perldoc -f" "perldoc")))
f739b53b 8540 (cond
6546555e 8541 ((featurep 'xemacs)
f739b53b
SM
8542 (let ((Manual-program "perldoc")
8543 (Manual-switches (if is-func (list "-f"))))
8544 (manual-entry word)))
8545 (t
8546 (Man-getpage-in-background word)))))
b7ec9e59 8547
4ab89e7b 8548;;;###autoload
b7ec9e59
RS
8549(defun cperl-perldoc-at-point ()
8550 "Run a `perldoc' on the word around point."
8551 (interactive)
8552 (cperl-perldoc (cperl-word-at-point)))
8553
8554(defcustom pod2man-program "pod2man"
8555 "*File name for `pod2man'."
8556 :type 'file
8557 :group 'cperl)
8558
5bd52f0e 8559;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
b7ec9e59
RS
8560(defun cperl-pod-to-manpage ()
8561 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8562 (interactive)
8563 (require 'man)
8564 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8565 (bufname (concat "Man " buffer-file-name))
8566 (buffer (generate-new-buffer bufname)))
9a529312 8567 (with-current-buffer buffer
b7ec9e59
RS
8568 (let ((process-environment (copy-sequence process-environment)))
8569 ;; Prevent any attempt to use display terminal fanciness.
8570 (setenv "TERM" "dumb")
8571 (set-process-sentinel
8572 (start-process pod2man-program buffer "sh" "-c"
8573 (format (cperl-pod2man-build-command) pod2man-args))
8574 'Man-bgproc-sentinel)))))
8575
f739b53b
SM
8576;;; Updated version by him too
8577(defun cperl-build-manpage ()
8578 "Create a virtual manpage in Emacs from the POD in the file."
8579 (interactive)
8580 (require 'man)
8581 (cond
6546555e 8582 ((featurep 'xemacs)
f739b53b
SM
8583 (let ((Manual-program "perldoc"))
8584 (manual-entry buffer-file-name)))
8585 (t
8c777c8d
CY
8586 (let* ((manual-program "perldoc")
8587 (Man-switches ""))
f739b53b
SM
8588 (Man-getpage-in-background buffer-file-name)))))
8589
b7ec9e59
RS
8590(defun cperl-pod2man-build-command ()
8591 "Builds the entire background manpage and cleaning command."
8592 (let ((command (concat pod2man-program " %s 2>/dev/null"))
4ab89e7b 8593 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
b7ec9e59
RS
8594 (while (and flist (car flist))
8595 (let ((pcom (car (car flist)))
8596 (pargs (cdr (car flist))))
8597 (setq command
8598 (concat command " | " pcom " "
8599 (mapconcat '(lambda (phrase)
8600 (if (not (stringp phrase))
8601 (error "Malformed Man-filter-list"))
8602 phrase)
8603 pargs " ")))
8604 (setq flist (cdr flist))))
8605 command))
db133cb6 8606
4ab89e7b
SM
8607
8608(defun cperl-next-interpolated-REx-1 ()
8609 "Move point to next REx which has interpolated parts without //o.
8610Skips RExes consisting of one interpolated variable.
8611
8612Note that skipped RExen are not performance hits."
8613 (interactive "")
8614 (cperl-next-interpolated-REx 1))
8615
8616(defun cperl-next-interpolated-REx-0 ()
8617 "Move point to next REx which has interpolated parts without //o."
8618 (interactive "")
8619 (cperl-next-interpolated-REx 0))
8620
8621(defun cperl-next-interpolated-REx (&optional skip beg limit)
8622 "Move point to next REx which has interpolated parts.
8623SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8624point and the limit of search (default to point and end of buffer).
8625
8626SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8627semantic may be used as a numeric argument.
8628
8629Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8630a result of qr//, this is not a performance hit), t for the rest."
8631 (interactive "P")
8632 (if (numberp skip) (setq skip (list 0 skip)))
8633 (or beg (setq beg (point)))
8634 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8635 (let (pp)
8636 (and (eq (get-text-property beg 'syntax-type) 'string)
8637 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8638 (cperl-map-pods-heres
8639 (function (lambda (s e p)
8640 (if (memq (get-text-property s 'REx-interpolated) skip)
8641 t
8642 (setq pp s)
8643 nil))) ; nil stops
8644 'REx-interpolated beg limit)
8645 (if pp (goto-char pp)
8646 (message "No more interpolated REx"))))
8647
8648;;; Initial version contributed by Trey Belew
8649(defun cperl-here-doc-spell (&optional beg end)
8650 "Spell-check HERE-documents in the Perl buffer.
8651If a region is highlighted, restricts to the region."
8652 (interactive "")
8653 (cperl-pod-spell t beg end))
8654
8655(defun cperl-pod-spell (&optional do-heres beg end)
8656 "Spell-check POD documentation.
8657If invoked with prefix argument, will do HERE-DOCs instead.
8658If a region is highlighted, restricts to the region."
8659 (interactive "P")
8660 (save-excursion
8661 (let (beg end)
8662 (if (cperl-mark-active)
8663 (setq beg (min (mark) (point))
8664 end (max (mark) (point)))
8665 (setq beg (point-min)
8666 end (point-max)))
8667 (cperl-map-pods-heres (function
8668 (lambda (s e p)
8669 (if do-heres
8670 (setq e (save-excursion
8671 (goto-char e)
8672 (forward-line -1)
8673 (point))))
8674 (ispell-region s e)
8675 t))
8676 (if do-heres 'here-doc-group 'in-pod)
8677 beg end))))
8678
8679(defun cperl-map-pods-heres (func &optional prop s end)
8680 "Executes a function over regions of pods or here-documents.
8681PROP is the text-property to search for; default to `in-pod'. Stop when
8682function returns nil."
8683 (let (pos posend has-prop (cont t))
8684 (or prop (setq prop 'in-pod))
8685 (or s (setq s (point-min)))
8686 (or end (setq end (point-max)))
8687 (cperl-update-syntaxification end end)
8688 (save-excursion
8689 (goto-char (setq pos s))
8690 (while (and cont (< pos end))
8691 (setq has-prop (get-text-property pos prop))
8692 (setq posend (next-single-property-change pos prop nil end))
8693 (and has-prop
8694 (setq cont (funcall func pos posend prop)))
8695 (setq pos posend)))))
8696
8697;;; Based on code by Masatake YAMATO:
8698(defun cperl-get-here-doc-region (&optional pos pod)
8699 "Return HERE document region around the point.
8700Return nil if the point is not in a HERE document region. If POD is non-nil,
8701will return a POD section if point is in a POD section."
8702 (or pos (setq pos (point)))
8703 (cperl-update-syntaxification pos pos)
8704 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8705 (and pod
8706 (eq 'pod (get-text-property pos 'syntax-type))))
8707 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8708 (e (next-single-property-change pos 'syntax-type)))
8709 (cons b (or e (point-max))))))
8710
8711(defun cperl-narrow-to-here-doc (&optional pos)
8712 "Narrows editing region to the HERE-DOC at POS.
8713POS defaults to the point."
8714 (interactive "d")
8715 (or pos (setq pos (point)))
8716 (let ((p (cperl-get-here-doc-region pos)))
8717 (or p (error "Not inside a HERE document"))
8718 (narrow-to-region (car p) (cdr p))
8719 (message
8720 "When you are finished with narrow editing, type C-x n w")))
8721
8722(defun cperl-select-this-pod-or-here-doc (&optional pos)
8723 "Select the HERE-DOC (or POD section) at POS.
8724POS defaults to the point."
8725 (interactive "d")
8726 (let ((p (cperl-get-here-doc-region pos t)))
8727 (if p
8728 (progn
8729 (goto-char (car p))
8730 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8731 (message "I do not think POS is in POD or a HERE-doc..."))))
8732
8733(defun cperl-facemenu-add-face-function (face end)
8734 "A callback to process user-initiated font-change requests.
8735Translates `bold', `italic', and `bold-italic' requests to insertion of
8736corresponding POD directives, and `underline' to C<> POD directive.
8737
8738Such requests are usually bound to M-o LETTER."
8739 (or (get-text-property (point) 'in-pod)
8740 (error "Faces can only be set within POD"))
8741 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8742 (cdr (or (assq face '((bold . "B<")
8743 (italic . "I<")
8744 (bold-italic . "B<I<")
8745 (underline . "C<")))
8746 (error "Face %s not configured for cperl-mode"
8747 face))))
8748\f
8749(defun cperl-time-fontification (&optional l step lim)
8750 "Times how long it takes to do incremental fontification in a region.
8751L is the line to start at, STEP is the number of lines to skip when
8752doing next incremental fontification, LIM is the maximal number of
8753incremental fontification to perform. Messages are accumulated in
8754*Messages* buffer.
8755
8756May be used for pinpointing which construct slows down buffer fontification:
8757start with default arguments, then refine the slowdown regions."
8758 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8759 (or l (setq l 1))
8760 (or step (setq step 500))
8761 (or lim (setq lim 40))
8762 (let* ((timems (function (lambda ()
8763 (let ((tt (current-time)))
8764 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8765 (tt (funcall timems)) (c 0) delta tot)
47e83968
GM
8766 (goto-char (point-min))
8767 (forward-line (1- l))
4ab89e7b
SM
8768 (cperl-mode)
8769 (setq tot (- (- tt (setq tt (funcall timems)))))
8770 (message "cperl-mode at %s: %s" l tot)
8771 (while (and (< c lim) (not (eobp)))
8772 (forward-line step)
8773 (setq l (+ l step))
8774 (setq c (1+ c))
8775 (cperl-update-syntaxification (point) (point))
8776 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8777 (message "to %s:%6s,%7s" l delta tot))
8778 tot))
8779
6546555e
DN
8780(defvar font-lock-cache-position)
8781
4ab89e7b
SM
8782(defun cperl-emulate-lazy-lock (&optional window-size)
8783 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8784Start fontifying the buffer from the start (or end) using the given
8785WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8786goes backwards; default is -50. This function is not CPerl-specific; it
8787may be used to debug problems with delayed incremental fontification."
8788 (interactive
8789 "nSize of window for incremental fontification, negative goes backwards: ")
8790 (or window-size (setq window-size -50))
8791 (let ((pos (if (> window-size 0)
8792 (point-min)
8793 (point-max)))
8794 p)
8795 (goto-char pos)
8796 (normal-mode)
8797 ;; Why needed??? With older font-locks???
8798 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8799 (while (if (> window-size 0)
8800 (< pos (point-max))
8801 (> pos (point-min)))
8802 (setq p (progn
8803 (forward-line window-size)
8804 (point)))
8805 (font-lock-fontify-region (min p pos) (max p pos))
8806 (setq pos p))))
8807
8808\f
db133cb6 8809(defun cperl-lazy-install ()) ; Avoid a warning
f739b53b 8810(defun cperl-lazy-unstall ()) ; Avoid a warning
f83d2997
KH
8811
8812(if (fboundp 'run-with-idle-timer)
8813 (progn
8814 (defvar cperl-help-shown nil
8815 "Non-nil means that the help was already shown now.")
8816
8817 (defvar cperl-lazy-installed nil
8818 "Non-nil means that the lazy-help handlers are installed now.")
8819
8820 (defun cperl-lazy-install ()
f739b53b
SM
8821 "Switches on Auto-Help on Perl constructs (put in the message area).
8822Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997 8823 (interactive)
4ab89e7b 8824 (make-local-variable 'cperl-help-shown)
f83d2997
KH
8825 (if (and (cperl-val 'cperl-lazy-help-time)
8826 (not cperl-lazy-installed))
8827 (progn
8828 (add-hook 'post-command-hook 'cperl-lazy-hook)
5c8b7eaf
SS
8829 (run-with-idle-timer
8830 (cperl-val 'cperl-lazy-help-time 1000000 5)
8831 t
f83d2997
KH
8832 'cperl-get-help-defer)
8833 (setq cperl-lazy-installed t))))
8834
8835 (defun cperl-lazy-unstall ()
f739b53b
SM
8836 "Switches off Auto-Help on Perl constructs (put in the message area).
8837Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997
KH
8838 (interactive)
8839 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8840 (cancel-function-timers 'cperl-get-help-defer)
8841 (setq cperl-lazy-installed nil))
8842
8843 (defun cperl-lazy-hook ()
8844 (setq cperl-help-shown nil))
8845
8846 (defun cperl-get-help-defer ()
83261a2f 8847 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
f83d2997
KH
8848 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8849 (cperl-get-help)
8850 (setq cperl-help-shown t))))
8851 (cperl-lazy-install)))
8852
db133cb6
RS
8853
8854;;; Plug for wrong font-lock:
8855
8856(defun cperl-font-lock-unfontify-region-function (beg end)
4ab89e7b
SM
8857 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8858 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8859 before-change-functions after-change-functions
8860 deactivate-mark buffer-file-name buffer-file-truename)
8861 (remove-text-properties beg end '(face nil))
8862 (if (and (not modified) (buffer-modified-p))
8863 (set-buffer-modified-p nil))))
8864
8865(defun cperl-font-lock-fontify-region-function (beg end loudly)
8866 "Extends the region to safe positions, then calls the default function.
8867Newer `font-lock's can do it themselves.
8868We unwind only as far as needed for fontification. Syntaxification may
8869do extra unwind via `cperl-unwind-to-safe'."
8870 (save-excursion
8871 (goto-char beg)
8872 (while (and beg
8873 (progn
8874 (beginning-of-line)
8875 (eq (get-text-property (setq beg (point)) 'syntax-type)
8876 'multiline)))
8877 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8878 (goto-char beg)))
8879 (setq beg (point))
8880 (goto-char end)
8881 (while (and end
8882 (progn
8883 (or (bolp) (condition-case nil
8884 (forward-line 1)
8885 (error nil)))
8886 (eq (get-text-property (setq end (point)) 'syntax-type)
8887 'multiline)))
8888 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8889 (goto-char end))
8890 (setq end (point)))
8891 (font-lock-default-fontify-region beg end loudly))
db133cb6
RS
8892
8893(defvar cperl-d-l nil)
8894(defun cperl-fontify-syntaxically (end)
5bd52f0e 8895 ;; Some vars for debugging only
6c389151 8896 ;; (message "Syntaxifying...")
4ab89e7b 8897 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
83261a2f 8898 (istate (car cperl-syntax-state))
4ab89e7b
SM
8899 start from-start edebug-backtrace-buffer)
8900 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8901 (progn
8902 (require 'edebug)
8903 (let ((f 'edebug-backtrace))
8904 (funcall f)))) ; Avoid compile-time warning
db133cb6 8905 (or cperl-syntax-done-to
4ab89e7b
SM
8906 (setq cperl-syntax-done-to (point-min)
8907 from-start t))
8908 (setq start (if (and cperl-hook-after-change
8909 (not from-start))
8910 cperl-syntax-done-to ; Fontify without change; ignore start
8911 ;; Need to forget what is after `start'
8912 (min cperl-syntax-done-to (point))))
8913 (goto-char start)
8914 (beginning-of-line)
8915 (setq start (point))
8916 (and cperl-syntaxify-unwind
8917 (setq end (cperl-unwind-to-safe t end)
8918 start (point)))
db133cb6
RS
8919 (and (> end start)
8920 (setq cperl-syntax-done-to start) ; In case what follows fails
8921 (cperl-find-pods-heres start end t nil t))
4ab89e7b
SM
8922 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8923 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8924 dbg iend start end idone cperl-syntax-done-to
5c8b7eaf 8925 istate (car cperl-syntax-state))) ; For debugging
83261a2f 8926 nil)) ; Do not iterate
db133cb6 8927
5bd52f0e 8928(defun cperl-fontify-update (end)
4ab89e7b
SM
8929 (let ((pos (point-min)) prop posend)
8930 (setq end (point-max))
5bd52f0e 8931 (while (< pos end)
4ab89e7b
SM
8932 (setq prop (get-text-property pos 'cperl-postpone)
8933 posend (next-single-property-change pos 'cperl-postpone nil end))
5bd52f0e
RS
8934 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8935 (setq pos posend)))
83261a2f 8936 nil) ; Do not iterate
5bd52f0e 8937
4ab89e7b
SM
8938(defun cperl-fontify-update-bad (end)
8939 ;; Since fontification happens with different region than syntaxification,
8940 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8941 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8942 (if prop
8943 (setq pos (or (cperl-beginning-of-property
8944 (cperl-1+ pos) 'cperl-postpone)
8945 (point-min))))
8946 (while (< pos end)
8947 (setq posend (next-single-property-change pos 'cperl-postpone))
8948 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8949 (setq pos posend)
8950 (setq prop (get-text-property pos 'cperl-postpone))))
8951 nil) ; Do not iterate
8952
8953;; Called when any modification is made to buffer text.
8954(defun cperl-after-change-function (beg end old-len)
8955 ;; We should have been informed about changes by `font-lock'. Since it
8956 ;; does not inform as which calls are defered, do it ourselves
8957 (if cperl-syntax-done-to
8958 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8959
5bd52f0e
RS
8960(defun cperl-update-syntaxification (from to)
8961 (if (and cperl-use-syntax-table-text-property
8962 cperl-syntaxify-by-font-lock
8963 (or (null cperl-syntax-done-to)
8964 (< cperl-syntax-done-to to)))
8965 (progn
8966 (save-excursion
8967 (goto-char from)
8968 (cperl-fontify-syntaxically to)))))
8969
5c8b7eaf 8970(defvar cperl-version
8c777c8d 8971 (let ((v "Revision: 6.2"))
5bd52f0e
RS
8972 (string-match ":\\s *\\([0-9.]+\\)" v)
8973 (substring v (match-beginning 1) (match-end 1)))
8974 "Version of IZ-supported CPerl package this file is based on.")
8975
40ab7974
JB
8976(defun cperl-mode-unload-function ()
8977 "Unload the Cperl mode library."
8978 (let ((new-mode (if (eq (symbol-function 'perl-mode) 'cperl-mode)
8979 'fundamental-mode
8980 'perl-mode)))
8981 (dolist (buf (buffer-list))
8982 (with-current-buffer buf
8983 (when (eq major-mode 'cperl-mode)
8984 (funcall new-mode)))))
8985 ;; continue standard unloading
8986 nil)
8987
f83d2997
KH
8988(provide 'cperl-mode)
8989
8990;;; cperl-mode.el ends here