* lisp/progmodes/cperl-mode.el (cperl-mode): Avoid byte-compile warning.
[bpt/emacs.git] / lisp / progmodes / cperl-mode.el
CommitLineData
f83d2997
KH
1;;; cperl-mode.el --- Perl code editing commands for Emacs
2
ab422c4d 3;; Copyright (C) 1985-1987, 1991-2013 Free Software Foundation, Inc.
f83d2997 4
5858f68c
GM
5;; Author: Ilya Zakharevich
6;; Bob Olson
4ab89e7b 7;; Maintainer: Ilya Zakharevich <ilyaz@cpan.org>
f83d2997
KH
8;; Keywords: languages, Perl
9
10;; This file is part of GNU Emacs.
11
b1fc2b50 12;; GNU Emacs is free software: you can redistribute it and/or modify
f83d2997 13;; it under the terms of the GNU General Public License as published by
b1fc2b50
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
f83d2997
KH
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
b1fc2b50 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
f83d2997 24
4ab89e7b 25;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
f83d2997
KH
26
27;;; Commentary:
28
83261a2f
SM
29;; You can either fine-tune the bells and whistles of this mode or
30;; bulk enable them by putting
f83d2997
KH
31
32;; (setq cperl-hairy t)
33
83261a2f
SM
34;; in your .emacs file. (Emacs rulers do not consider it politically
35;; correct to make whistles enabled by default.)
f83d2997 36
83261a2f
SM
37;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
38;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
15ca5699 39;; `cperl-praise', `cperl-speed'. <<<<<<
f83d2997 40
83261a2f
SM
41;; The mode information (on C-h m) provides some customization help.
42;; If you use font-lock feature of this mode, it is advisable to use
43;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
f83d2997 44
83261a2f
SM
45;; Faces used now: three faces for first-class and second-class keywords
46;; and control flow words, one for each: comments, string, labels,
47;; functions definitions and packages, arrays, hashes, and variable
48;; definitions. If you do not see all these faces, your font-lock does
49;; not define them, so you need to define them manually.
f83d2997 50
83261a2f
SM
51;; This mode supports font-lock, imenu and mode-compile. In the
52;; hairy version font-lock is on, but you should activate imenu
53;; yourself (note that mode-compile is not standard yet). Well, you
54;; can use imenu from keyboard anyway (M-x imenu), but it is better
55;; to bind it like that:
f83d2997
KH
56
57;; (define-key global-map [M-S-down-mouse-3] 'imenu)
58
83261a2f
SM
59;;; Font lock bugs as of v4.32:
60
61;; The following kinds of Perl code erroneously start strings:
62;; \$` \$' \$"
63;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
64;; likewise with m, tr, y, q, qX instead of s
65
f83d2997 66;;; Code:
4ab89e7b 67\f
b5b0cb34
JB
68(defvar vc-rcs-header)
69(defvar vc-sccs-header)
70
80585273 71(eval-when-compile
4ab89e7b
SM
72 (condition-case nil
73 (require 'custom)
74 (error nil))
75 (condition-case nil
76 (require 'man)
77 (error nil))
4ab89e7b 78 (defvar cperl-can-font-lock
6546555e 79 (or (featurep 'xemacs)
4ab89e7b
SM
80 (and (boundp 'emacs-major-version)
81 (or window-system
82 (> emacs-major-version 20)))))
83 (if cperl-can-font-lock
84 (require 'font-lock))
85 (defvar msb-menu-cond)
86 (defvar gud-perldb-history)
87 (defvar font-lock-background-mode) ; not in Emacs
88 (defvar font-lock-display-type) ; ditto
89 (defvar paren-backwards-message) ; Not in newer XEmacs?
90 (or (fboundp 'defgroup)
91 (defmacro defgroup (name val doc &rest arr)
92 nil))
93 (or (fboundp 'custom-declare-variable)
94 (defmacro defcustom (name val doc &rest arr)
9edd6ee6 95 `(defvar ,name ,val ,doc)))
4ab89e7b
SM
96 (or (and (fboundp 'custom-declare-variable)
97 (string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
98 (defmacro defface (&rest arr)
99 nil))
100 ;; Avoid warning (tmp definitions)
101 (or (fboundp 'x-color-defined-p)
102 (defmacro x-color-defined-p (col)
9edd6ee6 103 (cond ((fboundp 'color-defined-p) `(color-defined-p ,col))
4ab89e7b 104 ;; XEmacs >= 19.12
9edd6ee6 105 ((fboundp 'valid-color-name-p) `(valid-color-name-p ,col))
4ab89e7b 106 ;; XEmacs 19.11
9edd6ee6 107 ((fboundp 'x-valid-color-name-p) `(x-valid-color-name-p ,col))
4ab89e7b
SM
108 (t '(error "Cannot implement color-defined-p")))))
109 (defmacro cperl-is-face (arg) ; Takes quoted arg
110 (cond ((fboundp 'find-face)
9edd6ee6 111 `(find-face ,arg))
4ab89e7b
SM
112 (;;(and (fboundp 'face-list)
113 ;; (face-list))
114 (fboundp 'face-list)
9edd6ee6
SM
115 `(member ,arg (and (fboundp 'face-list)
116 (face-list))))
4ab89e7b 117 (t
9edd6ee6 118 `(boundp ,arg))))
4ab89e7b
SM
119 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
120 (cond ((fboundp 'make-face)
9edd6ee6 121 `(make-face (quote ,arg)))
4ab89e7b 122 (t
9edd6ee6 123 `(defvar ,arg (quote ,arg) ,descr))))
4ab89e7b 124 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
9edd6ee6
SM
125 `(progn
126 (or (cperl-is-face (quote ,arg))
127 (cperl-make-face ,arg ,descr))
128 (or (boundp (quote ,arg)) ; We use unquoted variants too
129 (defvar ,arg (quote ,arg) ,descr))))
6546555e 130 (if (featurep 'xemacs)
4ab89e7b 131 (defmacro cperl-etags-snarf-tag (file line)
9edd6ee6
SM
132 `(progn
133 (beginning-of-line 2)
134 (list ,file ,line)))
4ab89e7b 135 (defmacro cperl-etags-snarf-tag (file line)
9edd6ee6 136 `(etags-snarf-tag)))
6546555e 137 (if (featurep 'xemacs)
4ab89e7b 138 (defmacro cperl-etags-goto-tag-location (elt)
9edd6ee6
SM
139 ;;(progn
140 ;; (switch-to-buffer (get-file-buffer (elt ,elt 0)))
141 ;; (set-buffer (get-file-buffer (elt ,elt 0)))
142 ;; Probably will not work due to some save-excursion???
143 ;; Or save-file-position?
144 ;; (message "Did I get to line %s?" (elt ,elt 1))
145 `(goto-line (string-to-int (elt ,elt 1))))
4ab89e7b
SM
146 ;;)
147 (defmacro cperl-etags-goto-tag-location (elt)
9edd6ee6 148 `(etags-goto-tag-location ,elt))))
5bd52f0e 149
83261a2f 150(defvar cperl-can-font-lock
6546555e 151 (or (featurep 'xemacs)
83261a2f
SM
152 (and (boundp 'emacs-major-version)
153 (or window-system
154 (> emacs-major-version 20)))))
155
5bd52f0e
RS
156(defun cperl-choose-color (&rest list)
157 (let (answer)
158 (while list
159 (or answer
160 (if (or (x-color-defined-p (car list))
161 (null (cdr list)))
162 (setq answer (car list))))
163 (setq list (cdr list)))
164 answer))
165
ccc3ce39
SE
166(defgroup cperl nil
167 "Major mode for editing Perl code."
168 :prefix "cperl-"
db133cb6
RS
169 :group 'languages
170 :version "20.3")
171
172(defgroup cperl-indentation-details nil
173 "Indentation."
174 :prefix "cperl-"
175 :group 'cperl)
176
177(defgroup cperl-affected-by-hairy nil
178 "Variables affected by `cperl-hairy'."
179 :prefix "cperl-"
180 :group 'cperl)
181
182(defgroup cperl-autoinsert-details nil
183 "Auto-insert tuneup."
184 :prefix "cperl-"
185 :group 'cperl)
186
187(defgroup cperl-faces nil
188 "Fontification colors."
8ec3bce0 189 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
db133cb6
RS
190 :prefix "cperl-"
191 :group 'cperl)
192
193(defgroup cperl-speed nil
194 "Speed vs. validity tuneup."
195 :prefix "cperl-"
196 :group 'cperl)
197
198(defgroup cperl-help-system nil
199 "Help system tuneup."
200 :prefix "cperl-"
201 :group 'cperl)
ccc3ce39 202
f83d2997 203\f
ccc3ce39 204(defcustom cperl-extra-newline-before-brace nil
f83d2997
KH
205 "*Non-nil means that if, elsif, while, until, else, for, foreach
206and do constructs look like:
207
208 if ()
209 {
210 }
211
212instead of:
213
214 if () {
83261a2f 215 }"
ccc3ce39 216 :type 'boolean
db133cb6
RS
217 :group 'cperl-autoinsert-details)
218
5c8b7eaf 219(defcustom cperl-extra-newline-before-brace-multiline
db133cb6
RS
220 cperl-extra-newline-before-brace
221 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
222for constructs with multiline if/unless/while/until/for/foreach condition."
223 :type 'boolean
224 :group 'cperl-autoinsert-details)
ccc3ce39
SE
225
226(defcustom cperl-indent-level 2
227 "*Indentation of CPerl statements with respect to containing block."
228 :type 'integer
db133cb6 229 :group 'cperl-indentation-details)
f152a898 230
2d5590e0 231;; Is is not unusual to put both things like perl-indent-level and
f152a898
DN
232;; cperl-indent-level in the local variable section of a file. If only
233;; one of perl-mode and cperl-mode is in use, a warning will be issued
2d5590e0 234;; about the variable. Autoload these here, so that no warning is
f152a898
DN
235;; issued when using either perl-mode or cperl-mode.
236;;;###autoload(put 'cperl-indent-level 'safe-local-variable 'integerp)
2d5590e0
DN
237;;;###autoload(put 'cperl-brace-offset 'safe-local-variable 'integerp)
238;;;###autoload(put 'cperl-continued-brace-offset 'safe-local-variable 'integerp)
239;;;###autoload(put 'cperl-label-offset 'safe-local-variable 'integerp)
240;;;###autoload(put 'cperl-continued-statement-offset 'safe-local-variable 'integerp)
241;;;###autoload(put 'cperl-extra-newline-before-brace 'safe-local-variable 'booleanp)
242;;;###autoload(put 'cperl-merge-trailing-else 'safe-local-variable 'booleanp)
f83d2997 243
ccc3ce39 244(defcustom cperl-lineup-step nil
f83d2997 245 "*`cperl-lineup' will always lineup at multiple of this number.
029cb4d5 246If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 247 :type '(choice (const nil) integer)
db133cb6
RS
248 :group 'cperl-indentation-details)
249
ccc3ce39 250(defcustom cperl-brace-imaginary-offset 0
f83d2997
KH
251 "*Imagined indentation of a Perl open brace that actually follows a statement.
252An open brace following other text is treated as if it were this far
ccc3ce39
SE
253to the right of the start of its line."
254 :type 'integer
db133cb6 255 :group 'cperl-indentation-details)
ccc3ce39
SE
256
257(defcustom cperl-brace-offset 0
258 "*Extra indentation for braces, compared with other text in same context."
259 :type 'integer
db133cb6 260 :group 'cperl-indentation-details)
ccc3ce39
SE
261(defcustom cperl-label-offset -2
262 "*Offset of CPerl label lines relative to usual indentation."
263 :type 'integer
db133cb6 264 :group 'cperl-indentation-details)
ccc3ce39
SE
265(defcustom cperl-min-label-indent 1
266 "*Minimal offset of CPerl label lines."
267 :type 'integer
db133cb6 268 :group 'cperl-indentation-details)
ccc3ce39
SE
269(defcustom cperl-continued-statement-offset 2
270 "*Extra indent for lines not starting new statements."
271 :type 'integer
db133cb6 272 :group 'cperl-indentation-details)
ccc3ce39 273(defcustom cperl-continued-brace-offset 0
f83d2997 274 "*Extra indent for substatements that start with open-braces.
ccc3ce39
SE
275This is in addition to cperl-continued-statement-offset."
276 :type 'integer
db133cb6 277 :group 'cperl-indentation-details)
ccc3ce39
SE
278(defcustom cperl-close-paren-offset -1
279 "*Extra indent for substatements that start with close-parenthesis."
280 :type 'integer
db133cb6 281 :group 'cperl-indentation-details)
ccc3ce39 282
4ab89e7b
SM
283(defcustom cperl-indent-wrt-brace t
284 "*Non-nil means indent statements in if/etc block relative brace, not if/etc.
285Versions 5.2 ... 5.20 behaved as if this were `nil'."
286 :type 'boolean
287 :group 'cperl-indentation-details)
288
ccc3ce39 289(defcustom cperl-auto-newline nil
f83d2997
KH
290 "*Non-nil means automatically newline before and after braces,
291and after colons and semicolons, inserted in CPerl code. The following
292\\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf 293Insertion after colons requires both this variable and
ccc3ce39
SE
294`cperl-auto-newline-after-colon' set."
295 :type 'boolean
db133cb6 296 :group 'cperl-autoinsert-details)
f83d2997 297
6c389151
SM
298(defcustom cperl-autoindent-on-semi nil
299 "*Non-nil means automatically indent after insertion of (semi)colon.
300Active if `cperl-auto-newline' is false."
301 :type 'boolean
302 :group 'cperl-autoinsert-details)
303
ccc3ce39 304(defcustom cperl-auto-newline-after-colon nil
f83d2997 305 "*Non-nil means automatically newline even after colons.
ccc3ce39
SE
306Subject to `cperl-auto-newline' setting."
307 :type 'boolean
db133cb6 308 :group 'cperl-autoinsert-details)
f83d2997 309
ccc3ce39 310(defcustom cperl-tab-always-indent t
f83d2997 311 "*Non-nil means TAB in CPerl mode should always reindent the current line,
ccc3ce39
SE
312regardless of where in the line point is when the TAB command is used."
313 :type 'boolean
db133cb6 314 :group 'cperl-indentation-details)
f83d2997 315
ccc3ce39 316(defcustom cperl-font-lock nil
029cb4d5 317 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
ccc3ce39 318Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
319 :type '(choice (const null) boolean)
320 :group 'cperl-affected-by-hairy)
f83d2997 321
ccc3ce39 322(defcustom cperl-electric-lbrace-space nil
029cb4d5 323 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
ccc3ce39 324Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
325 :type '(choice (const null) boolean)
326 :group 'cperl-affected-by-hairy)
f83d2997 327
ccc3ce39 328(defcustom cperl-electric-parens-string "({[]})<"
f83d2997 329 "*String of parentheses that should be electric in CPerl.
ccc3ce39
SE
330Closing ones are electric only if the region is highlighted."
331 :type 'string
db133cb6 332 :group 'cperl-affected-by-hairy)
f83d2997 333
ccc3ce39 334(defcustom cperl-electric-parens nil
f83d2997 335 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
ccc3ce39 336Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
337 :type '(choice (const null) boolean)
338 :group 'cperl-affected-by-hairy)
339
340(defvar zmacs-regions) ; Avoid warning
341
5c8b7eaf 342(defcustom cperl-electric-parens-mark
f83d2997
KH
343 (and window-system
344 (or (and (boundp 'transient-mark-mode) ; For Emacs
345 transient-mark-mode)
346 (and (boundp 'zmacs-regions) ; For XEmacs
347 zmacs-regions)))
348 "*Not-nil means that electric parens look for active mark.
ccc3ce39
SE
349Default is yes if there is visual feedback on mark."
350 :type 'boolean
db133cb6 351 :group 'cperl-autoinsert-details)
f83d2997 352
ccc3ce39 353(defcustom cperl-electric-linefeed nil
f83d2997
KH
354 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
355In any case these two mean plain and hairy linefeeds together.
ccc3ce39 356Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
357 :type '(choice (const null) boolean)
358 :group 'cperl-affected-by-hairy)
f83d2997 359
ccc3ce39 360(defcustom cperl-electric-keywords nil
f83d2997 361 "*Not-nil (and non-null) means keywords are electric in CPerl.
350b4cb9
EZ
362Can be overwritten by `cperl-hairy' if nil.
363
364Uses `abbrev-mode' to do the expansion. If you want to use your
365own abbrevs in cperl-mode, but do not want keywords to be
366electric, you must redefine `cperl-mode-abbrev-table': do
367\\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in
368that paragraph, delete the words that appear at the ends of lines and
369that begin with \"cperl-electric\".
370"
db133cb6
RS
371 :type '(choice (const null) boolean)
372 :group 'cperl-affected-by-hairy)
ccc3ce39 373
f739b53b
SM
374(defcustom cperl-electric-backspace-untabify t
375 "*Not-nil means electric-backspace will untabify in CPerl."
376 :type 'boolean
377 :group 'cperl-autoinsert-details)
378
ccc3ce39 379(defcustom cperl-hairy nil
db133cb6 380 "*Not-nil means most of the bells and whistles are enabled in CPerl.
5c8b7eaf 381Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
db133cb6
RS
382`cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
383`cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
384`cperl-lazy-help-time'."
ccc3ce39 385 :type 'boolean
db133cb6 386 :group 'cperl-affected-by-hairy)
ccc3ce39
SE
387
388(defcustom cperl-comment-column 32
389 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
390 :type 'integer
db133cb6 391 :group 'cperl-indentation-details)
ccc3ce39 392
4ab89e7b
SM
393(defcustom cperl-indent-comment-at-column-0 nil
394 "*Non-nil means that comment started at column 0 should be indentable."
395 :type 'boolean
396 :group 'cperl-indentation-details)
e1a5828f
AS
397
398(defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
399 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
400 :type '(repeat string)
401 :group 'cperl)
402
4ab89e7b 403(defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
e1a5828f
AS
404 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
405 :type '(repeat string)
4ab89e7b
SM
406 :group 'cperl)
407
408;; This became obsolete...
409(defvar cperl-vc-header-alist nil)
410(make-obsolete-variable
411 'cperl-vc-header-alist
cb5b40ee
SM
412 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead."
413 "22.1")
ccc3ce39 414
5c8b7eaf 415(defcustom cperl-clobber-mode-lists
5bd52f0e
RS
416 (not
417 (and
418 (boundp 'interpreter-mode-alist)
419 (assoc "miniperl" interpreter-mode-alist)
420 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
421 "*Whether to install us into `interpreter-' and `extension' mode lists."
422 :type 'boolean
423 :group 'cperl)
424
ccc3ce39 425(defcustom cperl-info-on-command-no-prompt nil
f83d2997 426 "*Not-nil (and non-null) means not to prompt on C-h f.
6292d528 427The opposite behavior is always available if prefixed with C-c.
ccc3ce39 428Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
429 :type '(choice (const null) boolean)
430 :group 'cperl-affected-by-hairy)
431
432(defcustom cperl-clobber-lisp-bindings nil
433 "*Not-nil (and non-null) means not overwrite C-h f.
434The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
435Can be overwritten by `cperl-hairy' if nil."
436 :type '(choice (const null) boolean)
437 :group 'cperl-affected-by-hairy)
f83d2997 438
ccc3ce39 439(defcustom cperl-lazy-help-time nil
db133cb6
RS
440 "*Not-nil (and non-null) means to show lazy help after given idle time.
441Can be overwritten by `cperl-hairy' to be 5 sec if nil."
300f7bb3 442 :type '(choice (const null) (const nil) integer)
db133cb6 443 :group 'cperl-affected-by-hairy)
f83d2997 444
ccc3ce39 445(defcustom cperl-pod-face 'font-lock-comment-face
83261a2f 446 "*Face for POD highlighting."
ccc3ce39 447 :type 'face
db133cb6 448 :group 'cperl-faces)
f83d2997 449
ccc3ce39 450(defcustom cperl-pod-head-face 'font-lock-variable-name-face
83261a2f 451 "*Face for POD highlighting.
ccc3ce39
SE
452Font for POD headers."
453 :type 'face
db133cb6 454 :group 'cperl-faces)
f83d2997 455
ccc3ce39 456(defcustom cperl-here-face 'font-lock-string-face
80585273 457 "*Face for here-docs highlighting."
ccc3ce39 458 :type 'face
db133cb6 459 :group 'cperl-faces)
f83d2997 460
4ab89e7b 461;;; Some double-evaluation happened with font-locks... Needed with 21.2...
6546555e 462(defvar cperl-singly-quote-face (featurep 'xemacs))
4ab89e7b 463
224ca9c9
CY
464(defcustom cperl-invalid-face 'underline
465 "*Face for highlighting trailing whitespace."
80585273 466 :type 'face
ac6857fb 467 :version "21.1"
5bd52f0e
RS
468 :group 'cperl-faces)
469
ccc3ce39 470(defcustom cperl-pod-here-fontify '(featurep 'font-lock)
83261a2f 471 "*Not-nil after evaluation means to highlight POD and here-docs sections."
ccc3ce39 472 :type 'boolean
db133cb6 473 :group 'cperl-faces)
f83d2997 474
5bd52f0e
RS
475(defcustom cperl-fontify-m-as-s t
476 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
477 :type 'boolean
478 :group 'cperl-faces)
479
6c389151
SM
480(defcustom cperl-highlight-variables-indiscriminately nil
481 "*Non-nil means perform additional highlighting on variables.
482Currently only changes how scalar variables are highlighted.
483Note that that variable is only read at initialization time for
484the variable `cperl-font-lock-keywords-2', so changing it after you've
f94a632a 485entered CPerl mode the first time will have no effect."
6c389151
SM
486 :type 'boolean
487 :group 'cperl)
488
ccc3ce39 489(defcustom cperl-pod-here-scan t
83261a2f 490 "*Not-nil means look for POD and here-docs sections during startup.
ccc3ce39
SE
491You can always make lookup from menu or using \\[cperl-find-pods-heres]."
492 :type 'boolean
db133cb6 493 :group 'cperl-speed)
f83d2997 494
6c389151
SM
495(defcustom cperl-regexp-scan t
496 "*Not-nil means make marking of regular expression more thorough.
4ab89e7b
SM
497Effective only with `cperl-pod-here-scan'."
498 :type 'boolean
499 :group 'cperl-speed)
500
501(defcustom cperl-hook-after-change t
502 "*Not-nil means install hook to know which regions of buffer are changed.
503May significantly speed up delayed fontification. Changes take effect
504after reload."
6c389151
SM
505 :type 'boolean
506 :group 'cperl-speed)
507
ccc3ce39 508(defcustom cperl-imenu-addback nil
f83d2997 509 "*Not-nil means add backreferences to generated `imenu's.
db133cb6 510May require patched `imenu' and `imenu-go'. Obsolete."
ccc3ce39 511 :type 'boolean
db133cb6 512 :group 'cperl-help-system)
f83d2997 513
ccc3ce39
SE
514(defcustom cperl-max-help-size 66
515 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
516 :type '(choice integer (const nil))
db133cb6 517 :group 'cperl-help-system)
f83d2997 518
ccc3ce39
SE
519(defcustom cperl-shrink-wrap-info-frame t
520 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
521 :type 'boolean
db133cb6 522 :group 'cperl-help-system)
f83d2997 523
ccc3ce39 524(defcustom cperl-info-page "perl"
f83d2997 525 "*Name of the info page containing perl docs.
ccc3ce39
SE
526Older version of this page was called `perl5', newer `perl'."
527 :type 'string
db133cb6 528 :group 'cperl-help-system)
f83d2997 529
5c8b7eaf 530(defcustom cperl-use-syntax-table-text-property
f83d2997 531 (boundp 'parse-sexp-lookup-properties)
ccc3ce39
SE
532 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
533 :type 'boolean
db133cb6 534 :group 'cperl-speed)
f83d2997 535
5c8b7eaf 536(defcustom cperl-use-syntax-table-text-property-for-tags
f83d2997 537 cperl-use-syntax-table-text-property
ccc3ce39
SE
538 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
539 :type 'boolean
db133cb6 540 :group 'cperl-speed)
ccc3ce39
SE
541
542(defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
543 "*Regexp to match files to scan when generating TAGS."
544 :type 'regexp
545 :group 'cperl)
546
8937f01b
RS
547(defcustom cperl-noscan-files-regexp
548 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
ccc3ce39
SE
549 "*Regexp to match files/dirs to skip when generating TAGS."
550 :type 'regexp
551 :group 'cperl)
552
553(defcustom cperl-regexp-indent-step nil
554 "*Indentation used when beautifying regexps.
029cb4d5 555If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 556 :type '(choice integer (const nil))
db133cb6 557 :group 'cperl-indentation-details)
ccc3ce39
SE
558
559(defcustom cperl-indent-left-aligned-comments t
560 "*Non-nil means that the comment starting in leftmost column should indent."
561 :type 'boolean
db133cb6 562 :group 'cperl-indentation-details)
ccc3ce39 563
8f222248 564(defcustom cperl-under-as-char nil
ccc3ce39
SE
565 "*Non-nil means that the _ (underline) should be treated as word char."
566 :type 'boolean
567 :group 'cperl)
f83d2997 568
db133cb6
RS
569(defcustom cperl-extra-perl-args ""
570 "*Extra arguments to use when starting Perl.
571Currently used with `cperl-check-syntax' only."
572 :type 'string
573 :group 'cperl)
574
575(defcustom cperl-message-electric-keyword t
576 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
577 :type 'boolean
578 :group 'cperl-help-system)
579
580(defcustom cperl-indent-region-fix-constructs 1
581 "*Amount of space to insert between `}' and `else' or `elsif'
582in `cperl-indent-region'. Set to nil to leave as is. Values other
583than 1 and nil will probably not work."
584 :type '(choice (const nil) (const 1))
585 :group 'cperl-indentation-details)
586
587(defcustom cperl-break-one-line-blocks-when-indent t
588 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
2022c546 589need to be reformatted into multiline ones when indenting a region."
db133cb6
RS
590 :type 'boolean
591 :group 'cperl-indentation-details)
592
593(defcustom cperl-fix-hanging-brace-when-indent t
594 "*Non-nil means that BLOCK-end `}' may be put on a separate line
5c8b7eaf 595when indenting a region.
db133cb6
RS
596Braces followed by else/elsif/while/until are excepted."
597 :type 'boolean
598 :group 'cperl-indentation-details)
599
600(defcustom cperl-merge-trailing-else t
5c8b7eaf 601 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
db133cb6
RS
602may be merged to be on the same line when indenting a region."
603 :type 'boolean
604 :group 'cperl-indentation-details)
605
6c389151
SM
606(defcustom cperl-indent-parens-as-block nil
607 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
608but for trailing \",\" inside the group, which won't increase indentation.
609One should tune up `cperl-close-paren-offset' as well."
610 :type 'boolean
611 :group 'cperl-indentation-details)
612
a1506d29 613(defcustom cperl-syntaxify-by-font-lock
83261a2f 614 (and cperl-can-font-lock
5bd52f0e 615 (boundp 'parse-sexp-lookup-properties))
3af98a7b 616 "*Non-nil means that CPerl uses the `font-lock' routines for syntaxification."
5bd52f0e
RS
617 :type '(choice (const message) boolean)
618 :group 'cperl-speed)
619
620(defcustom cperl-syntaxify-unwind
621 t
f94a632a 622 "*Non-nil means that CPerl unwinds to a start of a long construction
5bd52f0e 623when syntaxifying a chunk of buffer."
db133cb6
RS
624 :type 'boolean
625 :group 'cperl-speed)
626
4ab89e7b
SM
627(defcustom cperl-syntaxify-for-menu
628 t
629 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
630This way enabling/disabling of menu items is more correct."
631 :type 'boolean
632 :group 'cperl-speed)
633
5bd52f0e
RS
634(defcustom cperl-ps-print-face-properties
635 '((font-lock-keyword-face nil nil bold shadow)
636 (font-lock-variable-name-face nil nil bold)
637 (font-lock-function-name-face nil nil bold italic box)
638 (font-lock-constant-face nil "LightGray" bold)
4ab89e7b 639 (cperl-array-face nil "LightGray" bold underline)
8c777c8d 640 (cperl-hash-face nil "LightGray" bold italic underline)
5bd52f0e
RS
641 (font-lock-comment-face nil "LightGray" italic)
642 (font-lock-string-face nil nil italic underline)
4ab89e7b 643 (cperl-nonoverridable-face nil nil italic underline)
5bd52f0e 644 (font-lock-type-face nil nil underline)
4ab89e7b 645 (font-lock-warning-face nil "LightGray" bold italic box)
5bd52f0e
RS
646 (underline nil "LightGray" strikeout))
647 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
5c8b7eaf 648 :type '(repeat (cons symbol
5bd52f0e
RS
649 (cons (choice (const nil) string)
650 (cons (choice (const nil) string)
651 (repeat symbol)))))
652 :group 'cperl-faces)
653
5cc679ab
JB
654(defvar cperl-dark-background
655 (cperl-choose-color "navy" "os2blue" "darkgreen"))
656(defvar cperl-dark-foreground
657 (cperl-choose-color "orchid1" "orange"))
658
4ab89e7b 659(defface cperl-nonoverridable-face
5cc679ab
JB
660 `((((class grayscale) (background light))
661 (:background "Gray90" :slant italic :underline t))
662 (((class grayscale) (background dark))
663 (:foreground "Gray80" :slant italic :underline t :weight bold))
664 (((class color) (background light))
665 (:foreground "chartreuse3"))
666 (((class color) (background dark))
667 (:foreground ,cperl-dark-foreground))
668 (t (:weight bold :underline t)))
c73fce9a 669 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
5cc679ab
JB
670 :group 'cperl-faces)
671
4ab89e7b 672(defface cperl-array-face
5cc679ab
JB
673 `((((class grayscale) (background light))
674 (:background "Gray90" :weight bold))
675 (((class grayscale) (background dark))
676 (:foreground "Gray80" :weight bold))
677 (((class color) (background light))
678 (:foreground "Blue" :background "lightyellow2" :weight bold))
679 (((class color) (background dark))
680 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
681 (t (:weight bold)))
682 "Font Lock mode face used to highlight array names."
683 :group 'cperl-faces)
684
4ab89e7b 685(defface cperl-hash-face
5cc679ab
JB
686 `((((class grayscale) (background light))
687 (:background "Gray90" :weight bold :slant italic))
688 (((class grayscale) (background dark))
689 (:foreground "Gray80" :weight bold :slant italic))
690 (((class color) (background light))
691 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
692 (((class color) (background dark))
693 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
694 (t (:weight bold :slant italic)))
695 "Font Lock mode face used to highlight hash names."
696 :group 'cperl-faces)
5bd52f0e 697
f83d2997
KH
698\f
699
700;;; Short extra-docs.
701
702(defvar cperl-tips 'please-ignore-this-line
83261a2f 703 "Get maybe newer version of this package from
4ab89e7b 704 http://ilyaz.org/software/emacs
db133cb6
RS
705Subdirectory `cperl-mode' may contain yet newer development releases and/or
706patches to related files.
f83d2997 707
5bd52f0e
RS
708For best results apply to an older Emacs the patches from
709 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
83261a2f 710\(this upgrades syntax-parsing abilities of Emacsen v19.34 and
8e3acc66 711v20.2 up to the level of Emacs v20.3 - a must for a good Perl
83261a2f 712mode.) As of beginning of 2003, XEmacs may provide a similar ability.
5bd52f0e 713
f83d2997
KH
714Get support packages choose-color.el (or font-lock-extra.el before
71519.30), imenu-go.el from the same place. \(Look for other files there
716too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
5c8b7eaf 717later you should use choose-color.el *instead* of font-lock-extra.el
f83d2997
KH
718\(and you will not get smart highlighting in C :-().
719
720Note that to enable Compile choices in the menu you need to install
721mode-compile.el.
722
5efe6a56
SM
723If your Emacs does not default to `cperl-mode' on Perl files, and you
724want it to: put the following into your .emacs file:
725
726 (defalias 'perl-mode 'cperl-mode)
727
a1506d29 728Get perl5-info from
4ab89e7b
SM
729 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
730Also, one can generate a newer documentation running `pod2texi' converter
731 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
f83d2997
KH
732
733If you use imenu-go, run imenu on perl5-info buffer (you can do it
5bd52f0e
RS
734from Perl menu). If many files are related, generate TAGS files from
735Tools/Tags submenu in Perl menu.
f83d2997
KH
736
737If some class structure is too complicated, use Tools/Hierarchy-view
029cb4d5 738from Perl menu, or hierarchic view of imenu. The second one uses the
f83d2997 739current buffer only, the first one requires generation of TAGS from
5bd52f0e
RS
740Perl/Tools/Tags menu beforehand.
741
742Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
743
744Switch auto-help on/off with Perl/Tools/Auto-help.
745
746Though with contemporary Emaxen CPerl mode should maintain the correct
747parsing of Perl even when editing, sometimes it may be lost. Fix this by
748
029cb4d5 749 \\[normal-mode]
f83d2997 750
5bd52f0e 751In cases of more severe confusion sometimes it is helpful to do
f83d2997 752
029cb4d5
SM
753 \\[load-library] cperl-mode RET
754 \\[normal-mode]
f83d2997 755
5bd52f0e
RS
756Before reporting (non-)problems look in the problem section of online
757micro-docs on what I know about CPerl problems.")
f83d2997
KH
758
759(defvar cperl-problems 'please-ignore-this-line
f94a632a
RS
760 "Description of problems in CPerl mode.
761Some faces will not be shown on some versions of Emacs unless you
bab27c0c 762install choose-color.el, available from
4ab89e7b 763 http://ilyaz.org/software/emacs
bab27c0c 764
6c389151 765`fill-paragraph' on a comment may leave the point behind the
4ab89e7b
SM
766paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
767to detect it and bulk out).
768
769See documentation of a variable `cperl-problems-old-emaxen' for the
770problems which disappear if you upgrade Emacs to a reasonably new
771version (20.3 for Emacs, and those of 2004 for XEmacs).")
772
773(defvar cperl-problems-old-emaxen 'please-ignore-this-line
774 "Description of problems in CPerl mode specific for older Emacs versions.
6c389151 775
8e3acc66 776Emacs had a _very_ restricted syntax parsing engine until version
5bd52f0e 77720.1. Most problems below are corrected starting from this version of
8e3acc66 778Emacs, and all of them should be fixed in version 20.3. (Or apply
83261a2f
SM
779patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
780this respect (until 2003).
5bd52f0e 781
6c389151
SM
782Note that even with newer Emacsen in some very rare cases the details
783of interaction of `font-lock' and syntaxification may be not cleaned
784up yet. You may get slightly different colors basing on the order of
785fontification and syntaxification. Say, the initial faces is correct,
786but editing the buffer breaks this.
f83d2997 787
db133cb6
RS
788Even with older Emacsen CPerl mode tries to corrects some Emacs
789misunderstandings, however, for efficiency reasons the degree of
790correction is different for different operations. The partially
791corrected problems are: POD sections, here-documents, regexps. The
792operations are: highlighting, indentation, electric keywords, electric
793braces.
f83d2997
KH
794
795This may be confusing, since the regexp s#//#/#\; may be highlighted
796as a comment, but it will be recognized as a regexp by the indentation
83261a2f 797code. Or the opposite case, when a POD section is highlighted, but
f83d2997
KH
798may break the indentation of the following code (though indentation
799should work if the balance of delimiters is not broken by POD).
800
801The main trick (to make $ a \"backslash\") makes constructions like
802${aaa} look like unbalanced braces. The only trick I can think of is
2e8b9c7d 803to insert it as $ {aaa} (valid in perl5, not in perl4).
f83d2997
KH
804
805Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
db133cb6
RS
806as /($|\\s)/. Note that such a transposition is not always possible.
807
5bd52f0e 808The solution is to upgrade your Emacs or patch an older one. Note
8e3acc66 809that Emacs 20.2 has some bugs related to `syntax-table' text
5bd52f0e
RS
810properties. Patches are available on the main CPerl download site,
811and on CPAN.
db133cb6
RS
812
813If these bugs cannot be fixed on your machine (say, you have an inferior
814environment and cannot recompile), you may still disable all the fancy stuff
83261a2f 815via `cperl-use-syntax-table-text-property'.")
f83d2997 816
f83d2997 817(defvar cperl-praise 'please-ignore-this-line
8e3acc66 818 "Advantages of CPerl mode.
f83d2997
KH
819
8200) It uses the newest `syntax-table' property ;-);
821
8221) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
5c8b7eaf 823mode - but the latter number may have improved too in last years) even
5bd52f0e
RS
824with old Emaxen which do not support `syntax-table' property.
825
826When using `syntax-table' property for syntax assist hints, it should
827handle 99.995% of lines correct - or somesuch. It automatically
828updates syntax assist hints when you edit your script.
f83d2997 829
bab27c0c 8302) It is generally believed to be \"the most user-friendly Emacs
f83d2997
KH
831package\" whatever it may mean (I doubt that the people who say similar
832things tried _all_ the rest of Emacs ;-), but this was not a lonely
833voice);
834
8353) Everything is customizable, one-by-one or in a big sweep;
836
549c0a96 8374) It has many easily-accessible \"tools\":
f83d2997
KH
838 a) Can run program, check syntax, start debugger;
839 b) Can lineup vertically \"middles\" of rows, like `=' in
840 a = b;
841 cc = d;
53964682 842 c) Can insert spaces where this improves readability (in one
f83d2997
KH
843 interactive sweep over the buffer);
844 d) Has support for imenu, including:
845 1) Separate unordered list of \"interesting places\";
846 2) Separate TOC of POD sections;
847 3) Separate list of packages;
848 4) Hierarchical view of methods in (sub)packages;
849 5) and functions (by the full name - with package);
850 e) Has an interface to INFO docs for Perl; The interface is
851 very flexible, including shrink-wrapping of
852 documentation buffer/frame;
853 f) Has a builtin list of one-line explanations for perl constructs.
854 g) Can show these explanations if you stay long enough at the
855 corresponding place (or on demand);
856 h) Has an enhanced fontification (using 3 or 4 additional faces
857 comparing to font-lock - basically, different
858 namespaces in Perl have different colors);
859 i) Can construct TAGS basing on its knowledge of Perl syntax,
860 the standard menu has 6 different way to generate
db133cb6 861 TAGS (if \"by directory\", .xs files - with C-language
f83d2997
KH
862 bindings - are included in the scan);
863 j) Can build a hierarchical view of classes (via imenu) basing
864 on generated TAGS file;
865 k) Has electric parentheses, electric newlines, uses Abbrev
866 for electric logical constructs
867 while () {}
868 with different styles of expansion (context sensitive
869 to be not so bothering). Electric parentheses behave
870 \"as they should\" in a presence of a visible region.
871 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
db133cb6
RS
872 m) Can convert from
873 if (A) { B }
874 to
875 B if A;
f83d2997 876
5bd52f0e 877 n) Highlights (by user-choice) either 3-delimiters constructs
6c389151
SM
878 (such as tr/a/b/), or regular expressions and `y/tr';
879 o) Highlights trailing whitespace;
880 p) Is able to manipulate Perl Regular Expressions to ease
881 conversion to a more readable form.
4ab89e7b
SM
882 q) Can ispell POD sections and HERE-DOCs.
883 r) Understands comments and character classes inside regular
884 expressions; can find matching () and [] in a regular expression.
885 s) Allows indentation of //x-style regular expressions;
886 t) Highlights different symbols in regular expressions according
887 to their function; much less problems with backslashitis;
888 u) Allows to find regular expressions which contain interpolated parts.
5bd52f0e 889
f83d2997
KH
8905) The indentation engine was very smart, but most of tricks may be
891not needed anymore with the support for `syntax-table' property. Has
892progress indicator for indentation (with `imenu' loaded).
893
5c8b7eaf 8946) Indent-region improves inline-comments as well; also corrects
db133cb6 895whitespace *inside* the conditional/loop constructs.
f83d2997
KH
896
8977) Fill-paragraph correctly handles multi-line comments;
db133cb6
RS
898
8998) Can switch to different indentation styles by one command, and restore
900the settings present before the switch.
901
5c8b7eaf 9029) When doing indentation of control constructs, may correct
db133cb6 903line-breaks/spacing between elements of the construct.
029cb4d5 904
91af3942 90510) Uses a linear-time algorithm for indentation of regions (on Emaxen with
4ab89e7b
SM
906capable syntax engines).
907
90811) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
909")
db133cb6
RS
910
911(defvar cperl-speed 'please-ignore-this-line
912 "This is an incomplete compendium of what is available in other parts
913of CPerl documentation. (Please inform me if I skept anything.)
914
915There is a perception that CPerl is slower than alternatives. This part
916of documentation is designed to overcome this misconception.
917
918*By default* CPerl tries to enable the most comfortable settings.
919From most points of view, correctly working package is infinitely more
920comfortable than a non-correctly working one, thus by default CPerl
921prefers correctness over speed. Below is the guide how to change
922settings if your preferences are different.
923
924A) Speed of loading the file. When loading file, CPerl may perform a
925scan which indicates places which cannot be parsed by primitive Emacs
926syntax-parsing routines, and marks them up so that either
927
928 A1) CPerl may work around these deficiencies (for big chunks, mostly
929 PODs and HERE-documents), or
3ed8598c 930 A2) On capable Emaxen CPerl will use improved syntax-handling
db133cb6
RS
931 which reads mark-up hints directly.
932
933 The scan in case A2 is much more comprehensive, thus may be slower.
934
935 User can disable syntax-engine-helping scan of A2 by setting
936 `cperl-use-syntax-table-text-property'
937 variable to nil (if it is set to t).
938
939 One can disable the scan altogether (both A1 and A2) by setting
940 `cperl-pod-here-scan'
941 to nil.
942
5c8b7eaf 943B) Speed of editing operations.
db133cb6
RS
944
945 One can add a (minor) speedup to editing operations by setting
946 `cperl-use-syntax-table-text-property'
947 variable to nil (if it is set to t). This will disable
948 syntax-engine-helping scan, thus will make many more Perl
949 constructs be wrongly recognized by CPerl, thus may lead to
950 wrongly matched parentheses, wrong indentation, etc.
5bd52f0e
RS
951
952 One can unset `cperl-syntaxify-unwind'. This might speed up editing
83261a2f 953 of, say, long POD sections.")
f83d2997 954
5bd52f0e
RS
955(defvar cperl-tips-faces 'please-ignore-this-line
956 "CPerl mode uses following faces for highlighting:
957
4ab89e7b
SM
958 `cperl-array-face' Array names
959 `cperl-hash-face' Hash names
8661c643 960 `font-lock-comment-face' Comments, PODs and whatever is considered
bbd240ce 961 syntactically to be not code
8661c643 962 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
5bd52f0e 963 2-arg operators s/y/tr/ or of RExen,
4ab89e7b
SM
964 `font-lock-warning-face' Special-cased m// and s//foo/,
965 `font-lock-function-name-face' _ as a target of a file tests, file tests,
5bd52f0e
RS
966 subroutine names at the moment of definition
967 (except those conflicting with Perl operators),
968 package names (when recognized), format names
8661c643 969 `font-lock-keyword-face' Control flow switch constructs, declarators
4ab89e7b 970 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
8661c643 971 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
5bd52f0e 972 literal parts and the terminator of formats
bbd240ce 973 and whatever is syntactically considered
5bd52f0e 974 as string literals
8661c643
DL
975 `font-lock-type-face' Overridable keywords
976 `font-lock-variable-name-face' Variable declarations, indirect array and
5bd52f0e 977 hash names, POD headers/item names
8c777c8d 978 `cperl-invalid-face' Trailing whitespace
5bd52f0e
RS
979
980Note that in several situations the highlighting tries to inform about
981possible confusion, such as different colors for function names in
982declarations depending on what they (do not) override, or special cases
983m// and s/// which do not do what one would expect them to do.
984
5c8b7eaf 985Help with best setup of these faces for printout requested (for each of
5bd52f0e
RS
986the faces: please specify bold, italic, underline, shadow and box.)
987
8c777c8d 988In regular expressions (including character classes):
4ab89e7b
SM
989 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
990 `font-lock-constant-face': Delimiters
991 `font-lock-warning-face' Special-cased m// and s//foo/,
992 Mismatched closing delimiters, parens
993 we couldn't match, misplaced quantifiers,
994 unrecognized escape sequences
995 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
8c777c8d 996 `font-lock-type-face' escape sequences with arguments (\\x \\23 \\p \\N)
4ab89e7b
SM
997 and others match-a-char escape sequences
998 `font-lock-keyword-face' Capturing parens, and |
999 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
8c777c8d
CY
1000 \"Range -\" in character classes
1001 `font-lock-builtin-face' \"Remaining\" 0-length constructs, multipliers
1002 ?+*{}, not-capturing parens, leading
1003 backslashes of escape sequences
1004 `font-lock-variable-name-face' Interpolated constructs, embedded code,
1005 POSIX classes (inside charclasses)
4ab89e7b
SM
1006 `font-lock-comment-face' Embedded comments
1007
1008")
5bd52f0e 1009
f83d2997
KH
1010\f
1011
1012;;; Portability stuff:
1013
1014(defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
b787fc05
GM
1015 `(define-key cperl-mode-map
1016 ,(if xemacs-key
6546555e 1017 `(if (featurep 'xemacs) ,xemacs-key ,emacs-key)
b787fc05
GM
1018 emacs-key)
1019 ,definition))
f83d2997
KH
1020
1021(defvar cperl-del-back-ch
1022 (car (append (where-is-internal 'delete-backward-char)
1023 (where-is-internal 'backward-delete-char-untabify)))
029cb4d5 1024 "Character generated by key bound to `delete-backward-char'.")
f83d2997 1025
5c8b7eaf 1026(and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
f83d2997
KH
1027 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
1028
db133cb6 1029(defun cperl-mark-active () (mark)) ; Avoid undefined warning
6546555e 1030(if (featurep 'xemacs)
f83d2997
KH
1031 (progn
1032 ;; "Active regions" are on: use region only if active
1033 ;; "Active regions" are off: use region unconditionally
1034 (defun cperl-use-region-p ()
db133cb6 1035 (if zmacs-regions (mark) t)))
f83d2997
KH
1036 (defun cperl-use-region-p ()
1037 (if transient-mark-mode mark-active t))
1038 (defun cperl-mark-active () mark-active))
1039
1040(defsubst cperl-enable-font-lock ()
83261a2f 1041 cperl-can-font-lock)
f83d2997 1042
83261a2f 1043(defun cperl-putback-char (c) ; Emacs 19
db133cb6
RS
1044 (set 'unread-command-events (list c))) ; Avoid undefined warning
1045
6546555e 1046(if (featurep 'xemacs)
0ce7de92
RS
1047 (defun cperl-putback-char (c) ; XEmacs >= 19.12
1048 (setq unread-command-events (list (eval '(character-to-event c))))))
f83d2997
KH
1049
1050(or (fboundp 'uncomment-region)
1051 (defun uncomment-region (beg end)
1052 (interactive "r")
1053 (comment-region beg end -1)))
1054
1055(defvar cperl-do-not-fontify
1056 (if (string< emacs-version "19.30")
1057 'fontified
1058 'lazy-lock)
1059 "Text property which inhibits refontification.")
1060
5bd52f0e
RS
1061(defsubst cperl-put-do-not-fontify (from to &optional post)
1062 ;; If POST, do not do it with postponed fontification
1063 (if (and post cperl-syntaxify-by-font-lock)
1064 nil
8c777c8d 1065 (put-text-property (max (point-min) (1- from))
5bd52f0e 1066 to cperl-do-not-fontify t)))
f83d2997 1067
ccc3ce39 1068(defcustom cperl-mode-hook nil
f94a632a 1069 "Hook run by CPerl mode."
ccc3ce39
SE
1070 :type 'hook
1071 :group 'cperl)
f83d2997 1072
db133cb6
RS
1073(defvar cperl-syntax-state nil)
1074(defvar cperl-syntax-done-to nil)
5bd52f0e 1075(defvar cperl-emacs-can-parse (> (length (save-excursion
ce22dd53 1076 (parse-partial-sexp (point) (point)))) 9))
db133cb6
RS
1077\f
1078;; Make customization possible "in reverse"
1079(defsubst cperl-val (symbol &optional default hairy)
1080 (cond
1081 ((eq (symbol-value symbol) 'null) default)
1082 (cperl-hairy (or hairy t))
1083 (t (symbol-value symbol))))
f83d2997 1084\f
4ab89e7b
SM
1085
1086(defun cperl-make-indent (column &optional minimum keep)
1087 "Makes indent of the current line the requested amount.
1088Unless KEEP, removes the old indentation. Works around a bug in ancient
1089versions of Emacs."
1090 (let ((prop (get-text-property (point) 'syntax-type)))
1091 (or keep
1092 (delete-horizontal-space))
1093 (indent-to column minimum)
1094 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1095 (and prop
1096 (> (current-column) 0)
1097 (save-excursion
1098 (beginning-of-line)
1099 (or (get-text-property (point) 'syntax-type)
1100 (and (looking-at "\\=[ \t]")
1101 (put-text-property (point) (match-end 0)
1102 'syntax-type prop)))))))
1103
f83d2997
KH
1104;;; Probably it is too late to set these guys already, but it can help later:
1105
5bd52f0e 1106;;;(and cperl-clobber-mode-lists
f83d2997
KH
1107;;;(setq auto-mode-alist
1108;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1109;;;(and (boundp 'interpreter-mode-alist)
1110;;; (setq interpreter-mode-alist (append interpreter-mode-alist
5bd52f0e 1111;;; '(("miniperl" . perl-mode))))))
80585273 1112(eval-when-compile
dba01120
GM
1113 (mapc (lambda (p)
1114 (condition-case nil
1115 (require p)
1116 (error nil)))
1117 '(imenu easymenu etags timer man info))
80585273
DL
1118 (if (fboundp 'ps-extend-face-list)
1119 (defmacro cperl-ps-extend-face-list (arg)
1120 `(ps-extend-face-list ,arg))
1121 (defmacro cperl-ps-extend-face-list (arg)
e8af40ee 1122 `(error "This version of Emacs has no `ps-extend-face-list'")))
80585273
DL
1123 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1124 ;; macros instead of defsubsts don't work on Emacs, so we do the
1125 ;; expansion manually. Any other suggestions?
1126 (require 'cl))
f83d2997
KH
1127
1128(defvar cperl-mode-abbrev-table nil
f94a632a 1129 "Abbrev table in use in CPerl mode buffers.")
f83d2997
KH
1130
1131(add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1132
1133(defvar cperl-mode-map () "Keymap used in CPerl mode.")
1134
1135(if cperl-mode-map nil
1136 (setq cperl-mode-map (make-sparse-keymap))
1137 (cperl-define-key "{" 'cperl-electric-lbrace)
1138 (cperl-define-key "[" 'cperl-electric-paren)
1139 (cperl-define-key "(" 'cperl-electric-paren)
1140 (cperl-define-key "<" 'cperl-electric-paren)
1141 (cperl-define-key "}" 'cperl-electric-brace)
1142 (cperl-define-key "]" 'cperl-electric-rparen)
1143 (cperl-define-key ")" 'cperl-electric-rparen)
1144 (cperl-define-key ";" 'cperl-electric-semi)
1145 (cperl-define-key ":" 'cperl-electric-terminator)
1146 (cperl-define-key "\C-j" 'newline-and-indent)
1147 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
db133cb6 1148 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
f83d2997
KH
1149 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1150 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
db133cb6
RS
1151 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1152 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
f83d2997 1153 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
4ab89e7b
SM
1154 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
1155 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
1156 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
1157 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
1158 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx)
1159 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0)
1160 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1)
db133cb6 1161 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
4ab89e7b
SM
1162 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
1163 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
f83d2997
KH
1164 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1165 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1166 [(control meta |)])
1167 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1168 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1169 (cperl-define-key "\177" 'cperl-electric-backspace)
1170 (cperl-define-key "\t" 'cperl-indent-command)
1171 ;; don't clobber the backspace binding:
db133cb6
RS
1172 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1173 [(control c) (control h) F])
db133cb6
RS
1174 (if (cperl-val 'cperl-clobber-lisp-bindings)
1175 (progn
1176 (cperl-define-key "\C-hf"
1177 ;;(concat (char-to-string help-char) "f") ; does not work
1178 'cperl-info-on-command
1179 [(control h) f])
1180 (cperl-define-key "\C-hv"
1181 ;;(concat (char-to-string help-char) "v") ; does not work
1182 'cperl-get-help
5bd52f0e
RS
1183 [(control h) v])
1184 (cperl-define-key "\C-c\C-hf"
1185 ;;(concat (char-to-string help-char) "f") ; does not work
1186 (key-binding "\C-hf")
1187 [(control c) (control h) f])
1188 (cperl-define-key "\C-c\C-hv"
1189 ;;(concat (char-to-string help-char) "v") ; does not work
1190 (key-binding "\C-hv")
1191 [(control c) (control h) v]))
1192 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1193 [(control c) (control h) f])
1194 (cperl-define-key "\C-c\C-hv"
1195 ;;(concat (char-to-string help-char) "v") ; does not work
1196 'cperl-get-help
1197 [(control c) (control h) v]))
6546555e 1198 (if (and (featurep 'xemacs)
f83d2997
KH
1199 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1200 (progn
1201 ;; substitute-key-definition is usefulness-deenhanced...
4ab89e7b 1202 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
f83d2997
KH
1203 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1204 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
4ab89e7b
SM
1205 (or (boundp 'fill-paragraph-function)
1206 (substitute-key-definition
1207 'fill-paragraph 'cperl-fill-paragraph
1208 cperl-mode-map global-map))
f83d2997
KH
1209 (substitute-key-definition
1210 'indent-sexp 'cperl-indent-exp
1211 cperl-mode-map global-map)
f83d2997
KH
1212 (substitute-key-definition
1213 'indent-region 'cperl-indent-region
1214 cperl-mode-map global-map)
1215 (substitute-key-definition
1216 'indent-for-comment 'cperl-indent-for-comment
1217 cperl-mode-map global-map)))
1218
1219(defvar cperl-menu)
db133cb6
RS
1220(defvar cperl-lazy-installed)
1221(defvar cperl-old-style nil)
f83d2997
KH
1222(condition-case nil
1223 (progn
1224 (require 'easymenu)
83261a2f 1225 (easy-menu-define
4ab89e7b
SM
1226 cperl-menu cperl-mode-map "Menu for CPerl mode"
1227 '("Perl"
1228 ["Beginning of function" beginning-of-defun t]
1229 ["End of function" end-of-defun t]
1230 ["Mark function" mark-defun t]
1231 ["Indent expression" cperl-indent-exp t]
82eb0dae 1232 ["Fill paragraph/comment" fill-paragraph t]
4ab89e7b
SM
1233 "----"
1234 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1235 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1236 ("Regexp"
1237 ["Beautify" cperl-beautify-regexp
1238 cperl-use-syntax-table-text-property]
1239 ["Beautify one level deep" (cperl-beautify-regexp 1)
1240 cperl-use-syntax-table-text-property]
1241 ["Beautify a group" cperl-beautify-level
1242 cperl-use-syntax-table-text-property]
1243 ["Beautify a group one level deep" (cperl-beautify-level 1)
1244 cperl-use-syntax-table-text-property]
1245 ["Contract a group" cperl-contract-level
1246 cperl-use-syntax-table-text-property]
1247 ["Contract groups" cperl-contract-levels
1248 cperl-use-syntax-table-text-property]
83261a2f 1249 "----"
cb5bf6ba 1250 ["Find next interpolated" cperl-next-interpolated-REx
4ab89e7b
SM
1251 (next-single-property-change (point-min) 'REx-interpolated)]
1252 ["Find next interpolated (no //o)"
1253 cperl-next-interpolated-REx-0
1254 (or (text-property-any (point-min) (point-max) 'REx-interpolated t)
1255 (text-property-any (point-min) (point-max) 'REx-interpolated 1))]
1256 ["Find next interpolated (neither //o nor whole-REx)"
1257 cperl-next-interpolated-REx-1
1258 (text-property-any (point-min) (point-max) 'REx-interpolated t)])
1259 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
1260 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1261 "----"
1262 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1263 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1264 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1265 "----"
1266 ["Run" mode-compile (fboundp 'mode-compile)]
1267 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1268 (get-buffer "*compilation*"))]
1269 ["Next error" next-error (get-buffer "*compilation*")]
1270 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1271 "----"
1272 ["Debugger" cperl-db t]
1273 "----"
1274 ("Tools"
1275 ["Imenu" imenu (fboundp 'imenu)]
1276 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
83261a2f 1277 "----"
4ab89e7b
SM
1278 ["Ispell PODs" cperl-pod-spell
1279 ;; Better not to update syntaxification here:
40ba43b4 1280 ;; debugging syntaxification can be broken by this???
4ab89e7b
SM
1281 (or
1282 (get-text-property (point-min) 'in-pod)
1283 (< (progn
1284 (and cperl-syntaxify-for-menu
1285 (cperl-update-syntaxification (point-max) (point-max)))
1286 (next-single-property-change (point-min) 'in-pod nil (point-max)))
1287 (point-max)))]
1288 ["Ispell HERE-DOCs" cperl-here-doc-spell
1289 (< (progn
1290 (and cperl-syntaxify-for-menu
1291 (cperl-update-syntaxification (point-max) (point-max)))
1292 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
1293 (point-max))]
1294 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
1295 (eq 'here-doc (progn
1296 (and cperl-syntaxify-for-menu
1297 (cperl-update-syntaxification (point) (point)))
1298 (get-text-property (point) 'syntax-type)))]
1299 ["Select this HERE-DOC or POD section"
1300 cperl-select-this-pod-or-here-doc
1301 (memq (progn
1302 (and cperl-syntaxify-for-menu
1303 (cperl-update-syntaxification (point) (point)))
1304 (get-text-property (point) 'syntax-type))
1305 '(here-doc pod))]
83261a2f 1306 "----"
4c36be58 1307 ["CPerl pretty print (experimental)" cperl-ps-print
4ab89e7b 1308 (fboundp 'ps-extend-face-list)]
83261a2f 1309 "----"
4ab89e7b
SM
1310 ["Syntaxify region" cperl-find-pods-heres-region
1311 (cperl-use-region-p)]
1312 ["Profile syntaxification" cperl-time-fontification t]
1313 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
1314 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
1315 ["Debug backtrace on syntactic scan (BEWARE!!!)"
1316 (cperl-toggle-set-debug-unwind nil t) t]
83261a2f 1317 "----"
4ab89e7b
SM
1318 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1319 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1320 ("Tags"
f83d2997
KH
1321;;; ["Create tags for current file" cperl-etags t]
1322;;; ["Add tags for current file" (cperl-etags t) t]
1323;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1324;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
5c8b7eaf 1325;;; ["Create tags for Perl files in (sub)directories"
f83d2997
KH
1326;;; (cperl-etags nil 'recursive) t]
1327;;; ["Add tags for Perl files in (sub)directories"
5c8b7eaf 1328;;; (cperl-etags t 'recursive) t])
f83d2997 1329;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
f739b53b
SM
1330 ["Create tags for current file" (cperl-write-tags nil t) t]
1331 ["Add tags for current file" (cperl-write-tags) t]
1332 ["Create tags for Perl files in directory"
1333 (cperl-write-tags nil t nil t) t]
1334 ["Add tags for Perl files in directory"
1335 (cperl-write-tags nil nil nil t) t]
1336 ["Create tags for Perl files in (sub)directories"
1337 (cperl-write-tags nil t t t) t]
1338 ["Add tags for Perl files in (sub)directories"
1339 (cperl-write-tags nil nil t t) t]))
1340 ("Perl docs"
15ca5699 1341 ["Define word at point" imenu-go-find-at-position
f739b53b
SM
1342 (fboundp 'imenu-go-find-at-position)]
1343 ["Help on function" cperl-info-on-command t]
1344 ["Help on function at point" cperl-info-on-current-command t]
1345 ["Help on symbol at point" cperl-get-help t]
1346 ["Perldoc" cperl-perldoc t]
1347 ["Perldoc on word at point" cperl-perldoc-at-point t]
1348 ["View manpage of POD in this file" cperl-build-manpage t]
15ca5699 1349 ["Auto-help on" cperl-lazy-install
f739b53b
SM
1350 (and (fboundp 'run-with-idle-timer)
1351 (not cperl-lazy-installed))]
1352 ["Auto-help off" cperl-lazy-unstall
1353 (and (fboundp 'run-with-idle-timer)
1354 cperl-lazy-installed)])
1355 ("Toggle..."
1356 ["Auto newline" cperl-toggle-auto-newline t]
1357 ["Electric parens" cperl-toggle-electric t]
1358 ["Electric keywords" cperl-toggle-abbrev t]
1359 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1360 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
15ca5699 1361 ["Auto fill" auto-fill-mode t])
f739b53b
SM
1362 ("Indent styles..."
1363 ["CPerl" (cperl-set-style "CPerl") t]
1364 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1365 ["GNU" (cperl-set-style "GNU") t]
1366 ["C++" (cperl-set-style "C++") t]
4ab89e7b 1367 ["K&R" (cperl-set-style "K&R") t]
f739b53b
SM
1368 ["BSD" (cperl-set-style "BSD") t]
1369 ["Whitesmith" (cperl-set-style "Whitesmith") t]
4ab89e7b 1370 ["Memorize Current" (cperl-set-style "Current") t]
f739b53b
SM
1371 ["Memorized" (cperl-set-style-back) cperl-old-style])
1372 ("Micro-docs"
1373 ["Tips" (describe-variable 'cperl-tips) t]
1374 ["Problems" (describe-variable 'cperl-problems) t]
1375 ["Speed" (describe-variable 'cperl-speed) t]
1376 ["Praise" (describe-variable 'cperl-praise) t]
1377 ["Faces" (describe-variable 'cperl-tips-faces) t]
1378 ["CPerl mode" (describe-function 'cperl-mode) t]
1379 ["CPerl version"
1380 (message "The version of master-file for this CPerl is %s-Emacs"
1381 cperl-version) t]))))
f83d2997
KH
1382 (error nil))
1383
1384(autoload 'c-macro-expand "cmacexp"
1385 "Display the result of expanding all C macros occurring in the region.
1386The expansion is entirely correct because it uses the C preprocessor."
1387 t)
1388
4ab89e7b
SM
1389;;; These two must be unwound, otherwise take exponential time
1390(defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
e4769531 1391"Regular expression to match optional whitespace with interspersed comments.
4ab89e7b
SM
1392Should contain exactly one group.")
1393
1394;;; This one is tricky to unwind; still very inefficient...
1395(defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
e4769531 1396"Regular expression to match whitespace with interspersed comments.
4ab89e7b
SM
1397Should contain exactly one group.")
1398
1399
1400;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1401;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1402;;; Details of groups in this may be used in several functions; see comments
1403;;; near mentioned above variable(s)...
1404;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1405(defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
1406 "Match the text after `sub' in a subroutine declaration.
1407If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
1408of attributes (if present), or end of the name or prototype (whatever is
1409the last)."
1410 (concat ; Assume n groups before this...
1411 "\\(" ; n+1=name-group
1412 cperl-white-and-comment-rex ; n+2=pre-name
1413 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
1414 "\\)" ; END n+1=name-group
1415 (if named "" "?")
1416 "\\(" ; n+4=proto-group
1417 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
1418 "\\(([^()]*)\\)" ; n+6=prototype
1419 "\\)?" ; END n+4=proto-group
1420 "\\(" ; n+7=attr-group
1421 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
1422 "\\(" ; n+9=start-attr
1423 ":"
1424 (if attr (concat
1425 "\\("
1426 cperl-maybe-white-and-comment-rex ; whitespace-comments
1427 "\\(\\sw\\|_\\)+" ; attr-name
1428 ;; attr-arg (1 level of internal parens allowed!)
1429 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
1430 "\\(" ; optional : (XXX allows trailing???)
1431 cperl-maybe-white-and-comment-rex ; whitespace-comments
1432 ":\\)?"
1433 "\\)+")
1434 "[^:]")
1435 "\\)"
1436 "\\)?" ; END n+6=proto-group
1437 ))
1438
1439;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1440;;; and `cperl-outline-level'.
1441;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
95f433f4
RS
1442(defvar cperl-imenu--function-name-regexp-perl
1443 (concat
4ab89e7b
SM
1444 "^\\(" ; 1 = all
1445 "\\([ \t]*package" ; 2 = package-group
1446 "\\(" ; 3 = package-name-group
1447 cperl-white-and-comment-rex ; 4 = pre-package-name
1448 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
1449 "\\|"
1450 "[ \t]*sub"
1451 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1452 cperl-maybe-white-and-comment-rex ; 15=pre-block
1453 "\\|"
1454 "=head\\([1-4]\\)[ \t]+" ; 16=level
1455 "\\([^\n]+\\)$" ; 17=text
95f433f4
RS
1456 "\\)"))
1457
8dd511f6
RS
1458(defvar cperl-outline-regexp
1459 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1460
f83d2997 1461(defvar cperl-mode-syntax-table nil
f94a632a 1462 "Syntax table in use in CPerl mode buffers.")
f83d2997
KH
1463
1464(defvar cperl-string-syntax-table nil
f94a632a 1465 "Syntax table in use in CPerl mode string-like chunks.")
f83d2997 1466
4ab89e7b
SM
1467(defsubst cperl-1- (p)
1468 (max (point-min) (1- p)))
1469
1470(defsubst cperl-1+ (p)
1471 (min (point-max) (1+ p)))
1472
f83d2997
KH
1473(if cperl-mode-syntax-table
1474 ()
1475 (setq cperl-mode-syntax-table (make-syntax-table))
1476 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1477 (modify-syntax-entry ?/ "." cperl-mode-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 ?\n ">" cperl-mode-syntax-table)
1488 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1489 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1490 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1491 (if cperl-under-as-char
1492 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1493 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1494 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1495 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1496 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
4ab89e7b
SM
1497 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
1498 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
8c777c8d
CY
1499 (modify-syntax-entry ?\" "." cperl-string-syntax-table)
1500 (modify-syntax-entry ?' "." cperl-string-syntax-table)
1501 (modify-syntax-entry ?` "." cperl-string-syntax-table)
83261a2f 1502 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
f83d2997
KH
1503
1504
1505\f
db133cb6 1506(defvar cperl-faces-init nil)
f83d2997
KH
1507;; Fix for msb.el
1508(defvar cperl-msb-fixed nil)
83261a2f 1509(defvar cperl-use-major-mode 'cperl-mode)
4ab89e7b
SM
1510(defvar cperl-font-lock-multiline-start nil)
1511(defvar cperl-font-lock-multiline nil)
4ab89e7b 1512(defvar cperl-font-locking nil)
83261a2f 1513
e9bfd3a3 1514;; NB as it stands the code in cperl-mode assumes this only has one
0d26e0b6 1515;; element. If XEmacs 19 support were dropped, this could all be simplified.
e9bfd3a3
GM
1516(defvar cperl-compilation-error-regexp-alist
1517 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1518 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
1519 2 3))
1520 "Alist that specifies how to match errors in perl output.")
1521
73e72da4
DN
1522(defvar compilation-error-regexp-alist)
1523
f83d2997 1524;;;###autoload
5fdd4046 1525(define-derived-mode cperl-mode prog-mode "CPerl"
f83d2997
KH
1526 "Major mode for editing Perl code.
1527Expression and list commands understand all C brackets.
1528Tab indents for Perl code.
1529Paragraphs are separated by blank lines only.
1530Delete converts tabs to spaces as it moves back.
1531
1532Various characters in Perl almost always come in pairs: {}, (), [],
1533sometimes <>. When the user types the first, she gets the second as
1534well, with optional special formatting done on {}. (Disabled by
1535default.) You can always quote (with \\[quoted-insert]) the left
1536\"paren\" to avoid the expansion. The processing of < is special,
f94a632a 1537since most the time you mean \"less\". CPerl mode tries to guess
f83d2997
KH
1538whether you want to type pair <>, and inserts is if it
1539appropriate. You can set `cperl-electric-parens-string' to the string that
bbd240ce
PE
1540contains the parens from the above list you want to be electrical.
1541Electricity of parens is controlled by `cperl-electric-parens'.
f83d2997
KH
1542You may also set `cperl-electric-parens-mark' to have electric parens
1543look for active mark and \"embrace\" a region if possible.'
1544
1545CPerl mode provides expansion of the Perl control constructs:
db133cb6 1546
5c8b7eaf 1547 if, else, elsif, unless, while, until, continue, do,
db133cb6
RS
1548 for, foreach, formy and foreachmy.
1549
1550and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1551
1552The user types the keyword immediately followed by a space, which
1553causes the construct to be expanded, and the point is positioned where
1554she is most likely to want to be. eg. when the user types a space
1555following \"if\" the following appears in the buffer: if () { or if ()
1556} { } and the cursor is between the parentheses. The user can then
1557type some boolean expression within the parens. Having done that,
1558typing \\[cperl-linefeed] places you - appropriately indented - on a
1559new line between the braces (if you typed \\[cperl-linefeed] in a POD
5c8b7eaf 1560directive line, then appropriate number of new lines is inserted).
db133cb6
RS
1561
1562If CPerl decides that you want to insert \"English\" style construct like
1563
f83d2997 1564 bite if angry;
db133cb6
RS
1565
1566it will not do any expansion. See also help on variable
1567`cperl-extra-newline-before-brace'. (Note that one can switch the
1568help message on expansion by setting `cperl-message-electric-keyword'
1569to nil.)
f83d2997
KH
1570
1571\\[cperl-linefeed] is a convenience replacement for typing carriage
1572return. It places you in the next line with proper indentation, or if
1573you type it inside the inline block of control construct, like
db133cb6 1574
f83d2997 1575 foreach (@lines) {print; print}
db133cb6 1576
f83d2997
KH
1577and you are on a boundary of a statement inside braces, it will
1578transform the construct into a multiline and will place you into an
5c8b7eaf 1579appropriately indented blank line. If you need a usual
6292d528 1580`newline-and-indent' behavior, it is on \\[newline-and-indent],
f83d2997
KH
1581see documentation on `cperl-electric-linefeed'.
1582
db133cb6
RS
1583Use \\[cperl-invert-if-unless] to change a construction of the form
1584
1585 if (A) { B }
1586
1587into
1588
1589 B if A;
1590
f83d2997
KH
1591\\{cperl-mode-map}
1592
db133cb6
RS
1593Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1594\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1595on electric space between $ and {, `cperl-electric-parens-string' is
1596the string that contains parentheses that should be electric in CPerl
1597\(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
f83d2997
KH
1598setting `cperl-electric-keywords' enables electric expansion of
1599control structures in CPerl. `cperl-electric-linefeed' governs which
1600one of two linefeed behavior is preferable. You can enable all these
1601options simultaneously (recommended mode of use) by setting
1602`cperl-hairy' to t. In this case you can switch separate options off
db133cb6
RS
1603by setting them to `null'. Note that one may undo the extra
1604whitespace inserted by semis and braces in `auto-newline'-mode by
1605consequent \\[cperl-electric-backspace].
f83d2997
KH
1606
1607If your site has perl5 documentation in info format, you can use commands
1608\\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1609These keys run commands `cperl-info-on-current-command' and
1610`cperl-info-on-command', which one is which is controlled by variable
5c8b7eaf 1611`cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
db133cb6 1612\(in turn affected by `cperl-hairy').
f83d2997
KH
1613
1614Even if you have no info-format documentation, short one-liner-style
db133cb6
RS
1615help is available on \\[cperl-get-help], and one can run perldoc or
1616man via menu.
f83d2997 1617
db133cb6
RS
1618It is possible to show this help automatically after some idle time.
1619This is regulated by variable `cperl-lazy-help-time'. Default with
1620`cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1621secs idle time . It is also possible to switch this on/off from the
1622menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
f83d2997
KH
1623
1624Use \\[cperl-lineup] to vertically lineup some construction - put the
1625beginning of the region at the start of construction, and make region
1626span the needed amount of lines.
1627
1628Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
83261a2f 1629`cperl-pod-face', `cperl-pod-head-face' control processing of POD and
db133cb6
RS
1630here-docs sections. With capable Emaxen results of scan are used
1631for indentation too, otherwise they are used for highlighting only.
f83d2997
KH
1632
1633Variables controlling indentation style:
1634 `cperl-tab-always-indent'
1635 Non-nil means TAB in CPerl mode should always reindent the current line,
1636 regardless of where in the line point is when the TAB command is used.
db133cb6
RS
1637 `cperl-indent-left-aligned-comments'
1638 Non-nil means that the comment starting in leftmost column should indent.
f83d2997
KH
1639 `cperl-auto-newline'
1640 Non-nil means automatically newline before and after braces,
1641 and after colons and semicolons, inserted in Perl code. The following
1642 \\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf
SS
1643 Insertion after colons requires both this variable and
1644 `cperl-auto-newline-after-colon' set.
f83d2997
KH
1645 `cperl-auto-newline-after-colon'
1646 Non-nil means automatically newline even after colons.
1647 Subject to `cperl-auto-newline' setting.
1648 `cperl-indent-level'
1649 Indentation of Perl statements within surrounding block.
1650 The surrounding block's indentation is the indentation
1651 of the line on which the open-brace appears.
1652 `cperl-continued-statement-offset'
1653 Extra indentation given to a substatement, such as the
1654 then-clause of an if, or body of a while, or just a statement continuation.
1655 `cperl-continued-brace-offset'
1656 Extra indentation given to a brace that starts a substatement.
1657 This is in addition to `cperl-continued-statement-offset'.
1658 `cperl-brace-offset'
1659 Extra indentation for line if it starts with an open brace.
1660 `cperl-brace-imaginary-offset'
1661 An open brace following other text is treated as if it the line started
1662 this far to the right of the actual line indentation.
1663 `cperl-label-offset'
1664 Extra indentation for line that is a label.
1665 `cperl-min-label-indent'
1666 Minimal indentation for line that is a label.
1667
4ab89e7b
SM
1668Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1669 `cperl-indent-level' 5 4 2 4
1670 `cperl-brace-offset' 0 0 0 0
1671 `cperl-continued-brace-offset' -5 -4 0 0
1672 `cperl-label-offset' -5 -4 -2 -4
1673 `cperl-continued-statement-offset' 5 4 2 4
f83d2997 1674
db133cb6
RS
1675CPerl knows several indentation styles, and may bulk set the
1676corresponding variables. Use \\[cperl-set-style] to do this. Use
1677\\[cperl-set-style-back] to restore the memorized preexisting values
4ab89e7b
SM
1678\(both available from menu). See examples in `cperl-style-examples'.
1679
1680Part of the indentation style is how different parts of if/elsif/else
1681statements are broken into lines; in CPerl, this is reflected on how
1682templates for these constructs are created (controlled by
8c777c8d
CY
1683`cperl-extra-newline-before-brace'), and how reflow-logic should treat
1684\"continuation\" blocks of else/elsif/continue, controlled by the same
1685variable, and by `cperl-extra-newline-before-brace-multiline',
4ab89e7b 1686`cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
db133cb6
RS
1687
1688If `cperl-indent-level' is 0, the statement after opening brace in
5c8b7eaf 1689column 0 is indented on
db133cb6 1690`cperl-brace-offset'+`cperl-continued-statement-offset'.
f83d2997
KH
1691
1692Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
db133cb6
RS
1693with no args.
1694
1695DO NOT FORGET to read micro-docs (available from `Perl' menu)
1696or as help on variables `cperl-tips', `cperl-problems',
f94a632a 1697`cperl-praise', `cperl-speed'."
f83d2997
KH
1698 (if (cperl-val 'cperl-electric-linefeed)
1699 (progn
1700 (local-set-key "\C-J" 'cperl-linefeed)
1701 (local-set-key "\C-C\C-J" 'newline-and-indent)))
db133cb6
RS
1702 (if (and
1703 (cperl-val 'cperl-clobber-lisp-bindings)
1704 (cperl-val 'cperl-info-on-command-no-prompt))
f83d2997
KH
1705 (progn
1706 ;; don't clobber the backspace binding:
1707 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1708 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1709 [(control c) (control h) f])))
449657e8
GM
1710 (let ((prev-a-c abbrevs-changed))
1711 (define-abbrev-table 'cperl-mode-abbrev-table '(
f83d2997
KH
1712 ("if" "if" cperl-electric-keyword 0)
1713 ("elsif" "elsif" cperl-electric-keyword 0)
1714 ("while" "while" cperl-electric-keyword 0)
1715 ("until" "until" cperl-electric-keyword 0)
1716 ("unless" "unless" cperl-electric-keyword 0)
1717 ("else" "else" cperl-electric-else 0)
db133cb6 1718 ("continue" "continue" cperl-electric-else 0)
f83d2997
KH
1719 ("for" "for" cperl-electric-keyword 0)
1720 ("foreach" "foreach" cperl-electric-keyword 0)
db133cb6
RS
1721 ("formy" "formy" cperl-electric-keyword 0)
1722 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1723 ("do" "do" cperl-electric-keyword 0)
6c389151
SM
1724 ("=pod" "=pod" cperl-electric-pod 0)
1725 ("=over" "=over" cperl-electric-pod 0)
1726 ("=head1" "=head1" cperl-electric-pod 0)
1727 ("=head2" "=head2" cperl-electric-pod 0)
db133cb6
RS
1728 ("pod" "pod" cperl-electric-pod 0)
1729 ("over" "over" cperl-electric-pod 0)
1730 ("head1" "head1" cperl-electric-pod 0)
1731 ("head2" "head2" cperl-electric-pod 0)))
449657e8 1732 (setq abbrevs-changed prev-a-c))
f83d2997 1733 (setq local-abbrev-table cperl-mode-abbrev-table)
4ab89e7b
SM
1734 (if (cperl-val 'cperl-electric-keywords)
1735 (abbrev-mode 1))
f83d2997 1736 (set-syntax-table cperl-mode-syntax-table)
4ab89e7b
SM
1737 ;; Until Emacs is multi-threaded, we do not actually need it local:
1738 (make-local-variable 'cperl-font-lock-multiline-start)
1739 (make-local-variable 'cperl-font-locking)
6c389151
SM
1740 (make-local-variable 'outline-regexp)
1741 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1742 (setq outline-regexp cperl-outline-regexp)
1743 (make-local-variable 'outline-level)
1744 (setq outline-level 'cperl-outline-level)
ba03d0d9
CY
1745 (make-local-variable 'add-log-current-defun-function)
1746 (setq add-log-current-defun-function
1747 (lambda ()
9dffb5b6
CY
1748 (save-excursion
1749 (if (re-search-backward "^sub[ \t]+\\([^({ \t\n]+\\)" nil t)
1750 (match-string-no-properties 1)))))
ba03d0d9 1751
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)))
ee7683eb 1821 ((boundp 'compilation-error-regexp-alist);; xemacs 19.x
4ab89e7b
SM
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
4813c453 1842 (if (eval-when-compile (fboundp 'syntax-propertize-rules))
cf38dd42
SM
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)
638eaeb9
SM
1848 (goto-char start)
1849 ;; Even if cperl-fontify-syntaxically has already gone
1850 ;; beyond `start', syntax-propertize has just removed
1851 ;; syntax-table properties between start and end, so we have
1852 ;; to re-apply them.
1853 (setq cperl-syntax-done-to start)
1854 (cperl-fontify-syntaxically end))))
029cb4d5 1855 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997 1856 ;; Do not introduce variable if not needed, we check it!
db133cb6
RS
1857 (set 'parse-sexp-lookup-properties t)
1858 ;; Fix broken font-lock:
1859 (or (boundp 'font-lock-unfontify-region-function)
1860 (set 'font-lock-unfontify-region-function
83261a2f 1861 'font-lock-default-unfontify-region))
6546555e 1862 (unless (featurep 'xemacs) ; Our: just a plug for wrong font-lock
4ab89e7b
SM
1863 (make-local-variable 'font-lock-unfontify-region-function)
1864 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1865 'cperl-font-lock-unfontify-region-function))
029cb4d5 1866 (make-local-variable 'cperl-syntax-done-to)
4ab89e7b 1867 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
029cb4d5 1868 (make-local-variable 'font-lock-syntactic-keywords)
5c8b7eaf 1869 (setq font-lock-syntactic-keywords
db133cb6 1870 (if cperl-syntaxify-by-font-lock
11b41e6f
SM
1871 '((cperl-fontify-syntaxically))
1872 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1873 ;; used to ignore syntax-table text-properties. (t) is a hack
1874 ;; to make font-lock think that font-lock-syntactic-keywords
1875 ;; are defined.
db133cb6 1876 '(t)))))
4ab89e7b
SM
1877 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
1878 (progn
1879 (setq cperl-font-lock-multiline t) ; Not localized...
f453f5a8 1880 (set (make-local-variable 'font-lock-multiline) t))
4ab89e7b
SM
1881 (make-local-variable 'font-lock-fontify-region-function)
1882 (set 'font-lock-fontify-region-function ; not present with old Emacs
1883 'cperl-font-lock-fontify-region-function))
1884 (make-local-variable 'font-lock-fontify-region-function)
1885 (set 'font-lock-fontify-region-function ; not present with old Emacs
1886 'cperl-font-lock-fontify-region-function)
db133cb6 1887 (make-local-variable 'cperl-old-style)
83261a2f
SM
1888 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1889 (set (make-local-variable 'normal-auto-fill-function)
4ab89e7b 1890 'cperl-do-auto-fill)
83261a2f
SM
1891 (or (fboundp 'cperl-old-auto-fill-mode)
1892 (progn
1893 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1894 (defun auto-fill-mode (&optional arg)
1895 (interactive "P")
1896 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1897 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1898 (setq auto-fill-function 'cperl-do-auto-fill))))))
f83d2997 1899 (if (cperl-enable-font-lock)
5c8b7eaf 1900 (if (cperl-val 'cperl-font-lock)
f83d2997
KH
1901 (progn (or cperl-faces-init (cperl-init-faces))
1902 (font-lock-mode 1))))
4ab89e7b
SM
1903 (set (make-local-variable 'facemenu-add-face-function)
1904 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
f83d2997
KH
1905 (and (boundp 'msb-menu-cond)
1906 (not cperl-msb-fixed)
1907 (cperl-msb-fix))
1908 (if (featurep 'easymenu)
46c72468 1909 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
a3c328ee 1910 (run-mode-hooks 'cperl-mode-hook)
4ab89e7b 1911 (if cperl-hook-after-change
39234e39 1912 (add-hook 'after-change-functions 'cperl-after-change-function nil t))
f83d2997 1913 ;; After hooks since fontification will break this
5c8b7eaf 1914 (if cperl-pod-here-scan
83261a2f 1915 (or cperl-syntaxify-by-font-lock
5bd52f0e
RS
1916 (progn (or cperl-faces-init (cperl-init-faces-weak))
1917 (cperl-find-pods-heres)))))
f83d2997
KH
1918\f
1919;; Fix for perldb - make default reasonable
1920(defun cperl-db ()
1921 (interactive)
1922 (require 'gud)
1923 (perldb (read-from-minibuffer "Run perldb (like this): "
1924 (if (consp gud-perldb-history)
1925 (car gud-perldb-history)
1926 (concat "perl " ;;(file-name-nondirectory
83261a2f
SM
1927 ;; I have problems
1928 ;; in OS/2
1929 ;; otherwise
1930 (buffer-file-name)))
f83d2997
KH
1931 nil nil
1932 '(gud-perldb-history . 1))))
1933\f
f83d2997
KH
1934(defun cperl-msb-fix ()
1935 ;; Adds perl files to msb menu, supposes that msb is already loaded
1936 (setq cperl-msb-fixed t)
1937 (let* ((l (length msb-menu-cond))
1938 (last (nth (1- l) msb-menu-cond))
1939 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1940 (handle (1- (nth 1 last))))
1941 (setcdr precdr (list
1942 (list
996e2616 1943 '(memq major-mode '(cperl-mode perl-mode))
f83d2997
KH
1944 handle
1945 "Perl Files (%d)")
1946 last))))
1947\f
1948;; This is used by indent-for-comment
1949;; to decide how much to indent a comment in CPerl code
1950;; based on its context. Do fallback if comment is found wrong.
1951
1952(defvar cperl-wrong-comment)
5bd52f0e
RS
1953(defvar cperl-st-cfence '(14)) ; Comment-fence
1954(defvar cperl-st-sfence '(15)) ; String-fence
1955(defvar cperl-st-punct '(1))
1956(defvar cperl-st-word '(2))
1957(defvar cperl-st-bra '(4 . ?\>))
1958(defvar cperl-st-ket '(5 . ?\<))
1959
f83d2997 1960
4ab89e7b 1961(defun cperl-comment-indent () ; called at point at supposed comment
5bd52f0e 1962 (let ((p (point)) (c (current-column)) was phony)
4ab89e7b
SM
1963 (if (and (not cperl-indent-comment-at-column-0)
1964 (looking-at "^#"))
1965 0 ; Existing comment at bol stays there.
f83d2997
KH
1966 ;; Wrong comment found
1967 (save-excursion
5bd52f0e
RS
1968 (setq was (cperl-to-comment-or-eol)
1969 phony (eq (get-text-property (point) 'syntax-table)
1970 cperl-st-cfence))
1971 (if phony
4ab89e7b 1972 (progn ; Too naive???
5bd52f0e
RS
1973 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1974 (if (eq (preceding-char) ?\#)
1975 (forward-char -1))
1976 (setq was nil)))
4ab89e7b 1977 (if (= (point) p) ; Our caller found a correct place
f83d2997
KH
1978 (progn
1979 (skip-chars-backward " \t")
4ab89e7b
SM
1980 (setq was (current-column))
1981 (if (eq was 0)
1982 comment-column
1983 (max (1+ was) ; Else indent at comment column
1984 comment-column)))
1985 ;; No, the caller found a random place; we need to edit ourselves
f83d2997
KH
1986 (if was nil
1987 (insert comment-start)
1988 (backward-char (length comment-start)))
1989 (setq cperl-wrong-comment t)
4ab89e7b
SM
1990 (cperl-make-indent comment-column 1) ; Indent min 1
1991 c)))))
f83d2997
KH
1992
1993;;;(defun cperl-comment-indent-fallback ()
1994;;; "Is called if the standard comment-search procedure fails.
1995;;;Point is at start of real comment."
1996;;; (let ((c (current-column)) target cnt prevc)
1997;;; (if (= c comment-column) nil
1998;;; (setq cnt (skip-chars-backward "[ \t]"))
5c8b7eaf 1999;;; (setq target (max (1+ (setq prevc
f83d2997
KH
2000;;; (current-column))) ; Else indent at comment column
2001;;; comment-column))
2002;;; (if (= c comment-column) nil
2003;;; (delete-backward-char cnt)
2004;;; (while (< prevc target)
2005;;; (insert "\t")
2006;;; (setq prevc (current-column)))
2007;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2008;;; (while (< prevc target)
2009;;; (insert " ")
2010;;; (setq prevc (current-column)))))))
2011
2012(defun cperl-indent-for-comment ()
2013 "Substitute for `indent-for-comment' in CPerl."
2014 (interactive)
2015 (let (cperl-wrong-comment)
2016 (indent-for-comment)
4ab89e7b 2017 (if cperl-wrong-comment ; set by `cperl-comment-indent'
f83d2997
KH
2018 (progn (cperl-to-comment-or-eol)
2019 (forward-char (length comment-start))))))
2020
2021(defun cperl-comment-region (b e arg)
2022 "Comment or uncomment each line in the region in CPerl mode.
2023See `comment-region'."
2024 (interactive "r\np")
2025 (let ((comment-start "#"))
2026 (comment-region b e arg)))
2027
2028(defun cperl-uncomment-region (b e arg)
2029 "Uncomment or comment each line in the region in CPerl mode.
2030See `comment-region'."
2031 (interactive "r\np")
2032 (let ((comment-start "#"))
2033 (comment-region b e (- arg))))
2034
2035(defvar cperl-brace-recursing nil)
2036
2037(defun cperl-electric-brace (arg &optional only-before)
2038 "Insert character and correct line's indentation.
2039If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2040place (even in empty line), but not after. If after \")\" and the inserted
5c8b7eaf 2041char is \"{\", insert extra newline before only if
f83d2997
KH
2042`cperl-extra-newline-before-brace'."
2043 (interactive "P")
2044 (let (insertpos
2045 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2046 (cperl-mark-active)
f83d2997 2047 (< (mark) (point)))
5c8b7eaf 2048 (mark)
f83d2997
KH
2049 nil)))
2050 (if (and other-end
2051 (not cperl-brace-recursing)
2052 (cperl-val 'cperl-electric-parens)
2053 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2054 ;; Need to insert a matching pair
2055 (progn
2056 (save-excursion
2057 (setq insertpos (point-marker))
2058 (goto-char other-end)
1ba983e8 2059 (setq last-command-event ?\{)
f83d2997
KH
2060 (cperl-electric-lbrace arg insertpos))
2061 (forward-char 1))
83261a2f 2062 ;; Check whether we close something "usual" with `}'
1ba983e8 2063 (if (and (eq last-command-event ?\})
5c8b7eaf 2064 (not
db133cb6
RS
2065 (condition-case nil
2066 (save-excursion
2067 (up-list (- (prefix-numeric-value arg)))
2068 ;;(cperl-after-block-p (point-min))
f739b53b
SM
2069 (or (cperl-after-expr-p nil "{;)")
2070 ;; after sub, else, continue
2071 (cperl-after-block-p nil 'pre)))
db133cb6
RS
2072 (error nil))))
2073 ;; Just insert the guy
2074 (self-insert-command (prefix-numeric-value arg))
2075 (if (and (not arg) ; No args, end (of empty line or auto)
2076 (eolp)
2077 (or (and (null only-before)
2078 (save-excursion
2079 (skip-chars-backward " \t")
2080 (bolp)))
1ba983e8 2081 (and (eq last-command-event ?\{) ; Do not insert newline
db133cb6
RS
2082 ;; if after ")" and `cperl-extra-newline-before-brace'
2083 ;; is nil, do not insert extra newline.
2084 (not cperl-extra-newline-before-brace)
2085 (save-excursion
2086 (skip-chars-backward " \t")
2087 (eq (preceding-char) ?\))))
5c8b7eaf 2088 (if cperl-auto-newline
db133cb6
RS
2089 (progn (cperl-indent-line) (newline) t) nil)))
2090 (progn
2091 (self-insert-command (prefix-numeric-value arg))
2092 (cperl-indent-line)
2093 (if cperl-auto-newline
2094 (setq insertpos (1- (point))))
2095 (if (and cperl-auto-newline (null only-before))
2096 (progn
2097 (newline)
2098 (cperl-indent-line)))
2099 (save-excursion
2100 (if insertpos (progn (goto-char insertpos)
5c8b7eaf 2101 (search-forward (make-string
1ba983e8 2102 1 last-command-event))
db133cb6
RS
2103 (setq insertpos (1- (point)))))
2104 (delete-char -1))))
2105 (if insertpos
f83d2997 2106 (save-excursion
db133cb6
RS
2107 (goto-char insertpos)
2108 (self-insert-command (prefix-numeric-value arg)))
2109 (self-insert-command (prefix-numeric-value arg)))))))
f83d2997
KH
2110
2111(defun cperl-electric-lbrace (arg &optional end)
2112 "Insert character, correct line's indentation, correct quoting by space."
2113 (interactive "P")
83261a2f
SM
2114 (let ((cperl-brace-recursing t)
2115 (cperl-auto-newline cperl-auto-newline)
2116 (other-end (or end
2117 (if (and cperl-electric-parens-mark
2118 (cperl-mark-active)
2119 (> (mark) (point)))
2120 (save-excursion
2121 (goto-char (mark))
2122 (point-marker))
2123 nil)))
2124 pos after)
f83d2997
KH
2125 (and (cperl-val 'cperl-electric-lbrace-space)
2126 (eq (preceding-char) ?$)
2127 (save-excursion
2128 (skip-chars-backward "$")
2129 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
b5b0cb34 2130 (insert ?\s))
bab27c0c 2131 ;; Check whether we are in comment
5c8b7eaf 2132 (if (and
bab27c0c
RS
2133 (save-excursion
2134 (beginning-of-line)
2135 (not (looking-at "[ \t]*#")))
2136 (cperl-after-expr-p nil "{;)"))
2137 nil
2138 (setq cperl-auto-newline nil))
f83d2997
KH
2139 (cperl-electric-brace arg)
2140 (and (cperl-val 'cperl-electric-parens)
1ba983e8
GM
2141 (eq last-command-event ?{)
2142 (memq last-command-event
f83d2997
KH
2143 (append cperl-electric-parens-string nil))
2144 (or (if other-end (goto-char (marker-position other-end)))
2145 t)
1ba983e8 2146 (setq last-command-event ?} pos (point))
f83d2997
KH
2147 (progn (cperl-electric-brace arg t)
2148 (goto-char pos)))))
2149
2150(defun cperl-electric-paren (arg)
f739b53b
SM
2151 "Insert an opening parenthesis or a matching pair of parentheses.
2152See `cperl-electric-parens'."
f83d2997 2153 (interactive "P")
e180ab9f 2154 (let ((beg (point-at-bol))
f83d2997 2155 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2156 (cperl-mark-active)
f83d2997 2157 (> (mark) (point)))
83261a2f
SM
2158 (save-excursion
2159 (goto-char (mark))
2160 (point-marker))
f83d2997
KH
2161 nil)))
2162 (if (and (cperl-val 'cperl-electric-parens)
1ba983e8 2163 (memq last-command-event
f83d2997
KH
2164 (append cperl-electric-parens-string nil))
2165 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2166 ;;(not (save-excursion (search-backward "#" beg t)))
1ba983e8 2167 (if (eq last-command-event ?<)
f83d2997 2168 (progn
7a55c78b
CY
2169 ;; This code is too electric, see Bug#3943.
2170 ;; (and abbrev-mode ; later it is too late, may be after `for'
2171 ;; (expand-abbrev))
f83d2997
KH
2172 (cperl-after-expr-p nil "{;(,:="))
2173 1))
2174 (progn
2175 (self-insert-command (prefix-numeric-value arg))
2176 (if other-end (goto-char (marker-position other-end)))
5c8b7eaf 2177 (insert (make-string
f83d2997 2178 (prefix-numeric-value arg)
1ba983e8 2179 (cdr (assoc last-command-event '((?{ .?})
f83d2997
KH
2180 (?[ . ?])
2181 (?( . ?))
2182 (?< . ?>))))))
2183 (forward-char (- (prefix-numeric-value arg))))
2184 (self-insert-command (prefix-numeric-value arg)))))
2185
2186(defun cperl-electric-rparen (arg)
2187 "Insert a matching pair of parentheses if marking is active.
f739b53b
SM
2188If not, or if we are not at the end of marking range, would self-insert.
2189Affected by `cperl-electric-parens'."
f83d2997 2190 (interactive "P")
e180ab9f 2191 (let ((beg (point-at-bol))
f83d2997
KH
2192 (other-end (if (and cperl-electric-parens-mark
2193 (cperl-val 'cperl-electric-parens)
1ba983e8 2194 (memq last-command-event
f83d2997 2195 (append cperl-electric-parens-string nil))
5c8b7eaf 2196 (cperl-mark-active)
f83d2997 2197 (< (mark) (point)))
5c8b7eaf 2198 (mark)
f83d2997
KH
2199 nil))
2200 p)
2201 (if (and other-end
2202 (cperl-val 'cperl-electric-parens)
1ba983e8 2203 (memq last-command-event '( ?\) ?\] ?\} ?\> ))
f83d2997
KH
2204 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2205 ;;(not (save-excursion (search-backward "#" beg t)))
2206 )
2207 (progn
2208 (self-insert-command (prefix-numeric-value arg))
2209 (setq p (point))
2210 (if other-end (goto-char other-end))
2211 (insert (make-string
2212 (prefix-numeric-value arg)
1ba983e8 2213 (cdr (assoc last-command-event '((?\} . ?\{)
83261a2f
SM
2214 (?\] . ?\[)
2215 (?\) . ?\()
2216 (?\> . ?\<))))))
f83d2997
KH
2217 (goto-char (1+ p)))
2218 (self-insert-command (prefix-numeric-value arg)))))
2219
2220(defun cperl-electric-keyword ()
db133cb6
RS
2221 "Insert a construction appropriate after a keyword.
2222Help message may be switched off by setting `cperl-message-electric-keyword'
2223to nil."
e180ab9f 2224 (let ((beg (point-at-bol))
1ba983e8 2225 (dollar (and (eq last-command-event ?$)
f83d2997 2226 (eq this-command 'self-insert-command)))
1ba983e8 2227 (delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
db133cb6
RS
2228 (memq this-command '(self-insert-command newline))))
2229 my do)
f83d2997 2230 (and (save-excursion
db133cb6
RS
2231 (condition-case nil
2232 (progn
2233 (backward-sexp 1)
2234 (setq do (looking-at "do\\>")))
2235 (error nil))
f83d2997 2236 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2237 (save-excursion
2238 (not
f83d2997 2239 (re-search-backward
5bd52f0e 2240 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2241 beg t)))
2242 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2243 (or
2244 (looking-at "=cut")
2245 (and cperl-use-syntax-table-text-property
2246 (not (eq (get-text-property (point)
2247 'syntax-type)
2248 'pod))))))
f739b53b
SM
2249 (save-excursion (forward-sexp -1)
2250 (not (memq (following-char) (append "$@%&*" nil))))
f83d2997 2251 (progn
db133cb6
RS
2252 (and (eq (preceding-char) ?y)
2253 (progn ; "foreachmy"
2254 (forward-char -2)
2255 (insert " ")
2256 (forward-char 2)
5c8b7eaf
SS
2257 (setq my t dollar t
2258 delete
db133cb6 2259 (memq this-command '(self-insert-command newline)))))
f83d2997
KH
2260 (and dollar (insert " $"))
2261 (cperl-indent-line)
2262 ;;(insert " () {\n}")
2263 (cond
2264 (cperl-extra-newline-before-brace
db133cb6 2265 (insert (if do "\n" " ()\n"))
f83d2997
KH
2266 (insert "{")
2267 (cperl-indent-line)
2268 (insert "\n")
2269 (cperl-indent-line)
db133cb6
RS
2270 (insert "\n}")
2271 (and do (insert " while ();")))
f83d2997 2272 (t
83261a2f 2273 (insert (if do " {\n} while ();" " () {\n}"))))
f83d2997
KH
2274 (or (looking-at "[ \t]\\|$") (insert " "))
2275 (cperl-indent-line)
2276 (if dollar (progn (search-backward "$")
5c8b7eaf 2277 (if my
db133cb6
RS
2278 (forward-char 1)
2279 (delete-char 1)))
f739b53b 2280 (search-backward ")")
1ba983e8 2281 (if (eq last-command-event ?\()
f739b53b
SM
2282 (progn ; Avoid "if (())"
2283 (delete-backward-char 1)
2284 (delete-backward-char -1))))
f83d2997 2285 (if delete
db133cb6
RS
2286 (cperl-putback-char cperl-del-back-ch))
2287 (if cperl-message-electric-keyword
2288 (message "Precede char by C-q to avoid expansion"))))))
2289
2290(defun cperl-ensure-newlines (n &optional pos)
2291 "Make sure there are N newlines after the point."
2292 (or pos (setq pos (point)))
2293 (if (looking-at "\n")
2294 (forward-char 1)
2295 (insert "\n"))
2296 (if (> n 1)
2297 (cperl-ensure-newlines (1- n) pos)
2298 (goto-char pos)))
2299
2300(defun cperl-electric-pod ()
2301 "Insert a POD chunk appropriate after a =POD directive."
1ba983e8 2302 (let ((delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
db133cb6
RS
2303 (memq this-command '(self-insert-command newline))))
2304 head1 notlast name p really-delete over)
2305 (and (save-excursion
6c389151 2306 (forward-word -1)
a1506d29 2307 (and
db133cb6
RS
2308 (eq (preceding-char) ?=)
2309 (progn
6c389151
SM
2310 (setq head1 (looking-at "head1\\>[ \t]*$"))
2311 (setq over (and (looking-at "over\\>[ \t]*$")
2312 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
db133cb6
RS
2313 (forward-char -1)
2314 (bolp))
5c8b7eaf 2315 (or
5bd52f0e 2316 (get-text-property (point) 'in-pod)
db133cb6 2317 (cperl-after-expr-p nil "{;:")
4ab89e7b
SM
2318 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
2319 (not (looking-at "\n*=cut"))
2320 (or (not cperl-use-syntax-table-text-property)
2321 (eq (get-text-property (point) 'syntax-type) 'pod))))))
db133cb6
RS
2322 (progn
2323 (save-excursion
6c389151 2324 (setq notlast (re-search-forward "^\n=" nil t)))
db133cb6
RS
2325 (or notlast
2326 (progn
2327 (insert "\n\n=cut")
2328 (cperl-ensure-newlines 2)
6c389151 2329 (forward-word -2)
a1506d29
JB
2330 (if (and head1
2331 (not
db133cb6
RS
2332 (save-excursion
2333 (forward-char -1)
2334 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
83261a2f 2335 nil t)))) ; Only one
a1506d29 2336 (progn
6c389151 2337 (forward-word 1)
d2c32364 2338 (setq name (file-name-base)
db133cb6 2339 p (point))
5c8b7eaf 2340 (insert " NAME\n\n" name
029cb4d5 2341 " - \n\n=head1 SYNOPSIS\n\n\n\n"
db133cb6
RS
2342 "=head1 DESCRIPTION")
2343 (cperl-ensure-newlines 4)
2344 (goto-char p)
6c389151 2345 (forward-word 2)
db133cb6
RS
2346 (end-of-line)
2347 (setq really-delete t))
6c389151 2348 (forward-word 1))))
db133cb6
RS
2349 (if over
2350 (progn
2351 (setq p (point))
2352 (insert "\n\n=item \n\n\n\n"
2353 "=back")
2354 (cperl-ensure-newlines 2)
2355 (goto-char p)
6c389151 2356 (forward-word 1)
db133cb6
RS
2357 (end-of-line)
2358 (setq really-delete t)))
2359 (if (and delete really-delete)
f83d2997
KH
2360 (cperl-putback-char cperl-del-back-ch))))))
2361
2362(defun cperl-electric-else ()
db133cb6
RS
2363 "Insert a construction appropriate after a keyword.
2364Help message may be switched off by setting `cperl-message-electric-keyword'
2365to nil."
e180ab9f 2366 (let ((beg (point-at-bol)))
f83d2997
KH
2367 (and (save-excursion
2368 (backward-sexp 1)
2369 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2370 (save-excursion
2371 (not
f83d2997 2372 (re-search-backward
5bd52f0e 2373 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2374 beg t)))
2375 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2376 (looking-at "=cut")
2377 (and cperl-use-syntax-table-text-property
2378 (not (eq (get-text-property (point)
2379 'syntax-type)
2380 'pod)))))
f83d2997
KH
2381 (progn
2382 (cperl-indent-line)
2383 ;;(insert " {\n\n}")
2384 (cond
2385 (cperl-extra-newline-before-brace
2386 (insert "\n")
2387 (insert "{")
2388 (cperl-indent-line)
2389 (insert "\n\n}"))
2390 (t
83261a2f 2391 (insert " {\n\n}")))
f83d2997
KH
2392 (or (looking-at "[ \t]\\|$") (insert " "))
2393 (cperl-indent-line)
2394 (forward-line -1)
2395 (cperl-indent-line)
db133cb6
RS
2396 (cperl-putback-char cperl-del-back-ch)
2397 (setq this-command 'cperl-electric-else)
2398 (if cperl-message-electric-keyword
2399 (message "Precede char by C-q to avoid expansion"))))))
f83d2997
KH
2400
2401(defun cperl-linefeed ()
db133cb6
RS
2402 "Go to end of line, open a new line and indent appropriately.
2403If in POD, insert appropriate lines."
f83d2997 2404 (interactive)
e180ab9f
GM
2405 (let ((beg (point-at-bol))
2406 (end (point-at-eol))
db133cb6 2407 (pos (point)) start over cut res)
f83d2997 2408 (if (and ; Check if we need to split:
5c8b7eaf 2409 ; i.e., on a boundary and inside "{...}"
f83d2997 2410 (save-excursion (cperl-to-comment-or-eol)
83261a2f 2411 (>= (point) pos)) ; Not in a comment
f83d2997
KH
2412 (or (save-excursion
2413 (skip-chars-backward " \t" beg)
2414 (forward-char -1)
2415 (looking-at "[;{]")) ; After { or ; + spaces
2416 (looking-at "[ \t]*}") ; Before }
2417 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2418 (save-excursion
2419 (and
5c8b7eaf 2420 (eq (car (parse-partial-sexp pos end -1)) -1)
f83d2997
KH
2421 ; Leave the level of parens
2422 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2423 ; Are at end
6c389151 2424 (cperl-after-block-p (point-min))
f83d2997
KH
2425 (progn
2426 (backward-sexp 1)
2427 (setq start (point-marker))
db133cb6 2428 (<= start pos))))) ; Redundant? Are after the
f83d2997
KH
2429 ; start of parens group.
2430 (progn
2431 (skip-chars-backward " \t")
2432 (or (memq (preceding-char) (append ";{" nil))
2433 (insert ";"))
2434 (insert "\n")
2435 (forward-line -1)
2436 (cperl-indent-line)
2437 (goto-char start)
2438 (or (looking-at "{[ \t]*$") ; If there is a statement
2439 ; before, move it to separate line
2440 (progn
2441 (forward-char 1)
2442 (insert "\n")
2443 (cperl-indent-line)))
2444 (forward-line 1) ; We are on the target line
2445 (cperl-indent-line)
2446 (beginning-of-line)
2447 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
83261a2f 2448 ; after, move it to separate line
f83d2997
KH
2449 (progn
2450 (end-of-line)
2451 (search-backward "}" beg)
2452 (skip-chars-backward " \t")
2453 (or (memq (preceding-char) (append ";{" nil))
2454 (insert ";"))
2455 (insert "\n")
2456 (cperl-indent-line)
2457 (forward-line -1)))
5c8b7eaf 2458 (forward-line -1) ; We are on the line before target
f83d2997
KH
2459 (end-of-line)
2460 (newline-and-indent))
db133cb6 2461 (end-of-line) ; else - no splitting
f83d2997
KH
2462 (cond
2463 ((and (looking-at "\n[ \t]*{$")
2464 (save-excursion
2465 (skip-chars-backward " \t")
2466 (eq (preceding-char) ?\)))) ; Probably if () {} group
83261a2f 2467 ; with an extra newline.
f83d2997
KH
2468 (forward-line 2)
2469 (cperl-indent-line))
db133cb6
RS
2470 ((save-excursion ; In POD header
2471 (forward-paragraph -1)
2472 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2473 ;; We are after \n now, so look for the rest
2474 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
5c8b7eaf 2475 (progn
db133cb6
RS
2476 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2477 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2478 t)))
2479 (if (and over
2480 (progn
2481 (forward-paragraph -1)
2482 (forward-word 1)
2483 (setq pos (point))
e180ab9f
GM
2484 (setq cut (buffer-substring (point) (point-at-eol)))
2485 (delete-char (- (point-at-eol) (point)))
db133cb6
RS
2486 (setq res (expand-abbrev))
2487 (save-excursion
2488 (goto-char pos)
2489 (insert cut))
2490 res))
2491 nil
2492 (cperl-ensure-newlines (if cut 2 4))
2493 (forward-line 2)))
2494 ((get-text-property (point) 'in-pod) ; In POD section
2495 (cperl-ensure-newlines 4)
2496 (forward-line 2))
f83d2997
KH
2497 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2498 (forward-line 1)
2499 (cperl-indent-line))
2500 (t
2501 (newline-and-indent))))))
2502
2503(defun cperl-electric-semi (arg)
2504 "Insert character and correct line's indentation."
2505 (interactive "P")
2506 (if cperl-auto-newline
2507 (cperl-electric-terminator arg)
6c389151
SM
2508 (self-insert-command (prefix-numeric-value arg))
2509 (if cperl-autoindent-on-semi
2510 (cperl-indent-line))))
f83d2997
KH
2511
2512(defun cperl-electric-terminator (arg)
2513 "Insert character and correct line's indentation."
2514 (interactive "P")
83261a2f
SM
2515 (let ((end (point))
2516 (auto (and cperl-auto-newline
1ba983e8 2517 (or (not (eq last-command-event ?:))
83261a2f
SM
2518 cperl-auto-newline-after-colon)))
2519 insertpos)
5c8b7eaf 2520 (if (and ;;(not arg)
f83d2997
KH
2521 (eolp)
2522 (not (save-excursion
2523 (beginning-of-line)
2524 (skip-chars-forward " \t")
2525 (or
2526 ;; Ignore in comment lines
2527 (= (following-char) ?#)
2528 ;; Colon is special only after a label
2529 ;; So quickly rule out most other uses of colon
2530 ;; and do no indentation for them.
1ba983e8 2531 (and (eq last-command-event ?:)
f83d2997
KH
2532 (save-excursion
2533 (forward-word 1)
2534 (skip-chars-forward " \t")
2535 (and (< (point) end)
2536 (progn (goto-char (- end 1))
2537 (not (looking-at ":"))))))
2538 (progn
2539 (beginning-of-defun)
2540 (let ((pps (parse-partial-sexp (point) end)))
2541 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2542 (progn
2543 (self-insert-command (prefix-numeric-value arg))
2544 ;;(forward-char -1)
2545 (if auto (setq insertpos (point-marker)))
2546 ;;(forward-char 1)
2547 (cperl-indent-line)
2548 (if auto
2549 (progn
2550 (newline)
2551 (cperl-indent-line)))
f83d2997
KH
2552 (save-excursion
2553 (if insertpos (goto-char (1- (marker-position insertpos)))
2554 (forward-char -1))
2555 (delete-char 1))))
2556 (if insertpos
2557 (save-excursion
2558 (goto-char insertpos)
2559 (self-insert-command (prefix-numeric-value arg)))
2560 (self-insert-command (prefix-numeric-value arg)))))
2561
2562(defun cperl-electric-backspace (arg)
8c777c8d
CY
2563 "Backspace, or remove whitespace around the point inserted by an electric key.
2564Will untabify if `cperl-electric-backspace-untabify' is non-nil."
f83d2997 2565 (interactive "p")
5c8b7eaf
SS
2566 (if (and cperl-auto-newline
2567 (memq last-command '(cperl-electric-semi
f83d2997
KH
2568 cperl-electric-terminator
2569 cperl-electric-lbrace))
b5b0cb34 2570 (memq (preceding-char) '(?\s ?\t ?\n)))
f83d2997 2571 (let (p)
5c8b7eaf 2572 (if (eq last-command 'cperl-electric-lbrace)
f83d2997
KH
2573 (skip-chars-forward " \t\n"))
2574 (setq p (point))
2575 (skip-chars-backward " \t\n")
2576 (delete-region (point) p))
db133cb6
RS
2577 (and (eq last-command 'cperl-electric-else)
2578 ;; We are removing the whitespace *inside* cperl-electric-else
2579 (setq this-command 'cperl-electric-else-really))
5c8b7eaf 2580 (if (and cperl-auto-newline
db133cb6 2581 (eq last-command 'cperl-electric-else-really)
b5b0cb34 2582 (memq (preceding-char) '(?\s ?\t ?\n)))
db133cb6
RS
2583 (let (p)
2584 (skip-chars-forward " \t\n")
2585 (setq p (point))
2586 (skip-chars-backward " \t\n")
2587 (delete-region (point) p))
f739b53b
SM
2588 (if cperl-electric-backspace-untabify
2589 (backward-delete-char-untabify arg)
2590 (delete-backward-char arg)))))
f83d2997 2591
d6156ce8
KS
2592(put 'cperl-electric-backspace 'delete-selection 'supersede)
2593
4ab89e7b 2594(defun cperl-inside-parens-p () ;; NOT USED????
f83d2997
KH
2595 (condition-case ()
2596 (save-excursion
2597 (save-restriction
2598 (narrow-to-region (point)
2599 (progn (beginning-of-defun) (point)))
2600 (goto-char (point-max))
2601 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2602 (error nil)))
2603\f
2604(defun cperl-indent-command (&optional whole-exp)
2605 "Indent current line as Perl code, or in some cases insert a tab character.
5c8b7eaf 2606If `cperl-tab-always-indent' is non-nil (the default), always indent current
db133cb6 2607line. Otherwise, indent the current line only if point is at the left margin
f83d2997
KH
2608or in the line's indentation; otherwise insert a tab.
2609
2610A numeric argument, regardless of its value,
2611means indent rigidly all the lines of the expression starting after point
2612so that this line becomes properly indented.
2613The relative indentation among the lines of the expression are preserved."
2614 (interactive "P")
5bd52f0e 2615 (cperl-update-syntaxification (point) (point))
f83d2997
KH
2616 (if whole-exp
2617 ;; If arg, always indent this line as Perl
2618 ;; and shift remaining lines of expression the same amount.
2619 (let ((shift-amt (cperl-indent-line))
2620 beg end)
2621 (save-excursion
2622 (if cperl-tab-always-indent
2623 (beginning-of-line))
2624 (setq beg (point))
2625 (forward-sexp 1)
2626 (setq end (point))
2627 (goto-char beg)
2628 (forward-line 1)
2629 (setq beg (point)))
db133cb6 2630 (if (and shift-amt (> end beg))
f83d2997
KH
2631 (indent-code-rigidly beg end shift-amt "#")))
2632 (if (and (not cperl-tab-always-indent)
2633 (save-excursion
2634 (skip-chars-backward " \t")
2635 (not (bolp))))
2636 (insert-tab)
2637 (cperl-indent-line))))
2638
5bd52f0e 2639(defun cperl-indent-line (&optional parse-data)
f83d2997
KH
2640 "Indent current line as Perl code.
2641Return the amount the indentation changed by."
83261a2f
SM
2642 (let ((case-fold-search nil)
2643 (pos (- (point-max) (point)))
2644 indent i beg shift-amt)
5bd52f0e 2645 (setq indent (cperl-calculate-indent parse-data)
db133cb6 2646 i indent)
f83d2997
KH
2647 (beginning-of-line)
2648 (setq beg (point))
2649 (cond ((or (eq indent nil) (eq indent t))
db133cb6 2650 (setq indent (current-indentation) i nil))
f83d2997
KH
2651 ;;((eq indent t) ; Never?
2652 ;; (setq indent (cperl-calculate-indent-within-comment)))
2653 ;;((looking-at "[ \t]*#")
2654 ;; (setq indent 0))
2655 (t
2656 (skip-chars-forward " \t")
2657 (if (listp indent) (setq indent (car indent)))
82d9a08d
SM
2658 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2659 (not (looking-at "[smy]:\\|tr:")))
f83d2997
KH
2660 (and (> indent 0)
2661 (setq indent (max cperl-min-label-indent
2662 (+ indent cperl-label-offset)))))
2663 ((= (following-char) ?})
2664 (setq indent (- indent cperl-indent-level)))
2665 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2666 (setq indent (+ indent cperl-close-paren-offset)))
2667 ((= (following-char) ?{)
2668 (setq indent (+ indent cperl-brace-offset))))))
2669 (skip-chars-forward " \t")
db133cb6
RS
2670 (setq shift-amt (and i (- indent (current-column))))
2671 (if (or (not shift-amt)
2672 (zerop shift-amt))
f83d2997
KH
2673 (if (> (- (point-max) pos) (point))
2674 (goto-char (- (point-max) pos)))
4ab89e7b
SM
2675 ;;;(delete-region beg (point))
2676 ;;;(indent-to indent)
2677 (cperl-make-indent indent)
f83d2997
KH
2678 ;; If initial point was within line's indentation,
2679 ;; position after the indentation. Else stay at same point in text.
2680 (if (> (- (point-max) pos) (point))
2681 (goto-char (- (point-max) pos))))
2682 shift-amt))
2683
2684(defun cperl-after-label ()
2685 ;; Returns true if the point is after label. Does not do save-excursion.
2686 (and (eq (preceding-char) ?:)
2687 (memq (char-syntax (char-after (- (point) 2)))
2688 '(?w ?_))
2689 (progn
2690 (backward-sexp)
2691 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2692
2693(defun cperl-get-state (&optional parse-start start-state)
5bd52f0e
RS
2694 ;; returns list (START STATE DEPTH PRESTART),
2695 ;; START is a good place to start parsing, or equal to
5c8b7eaf 2696 ;; PARSE-START if preset,
5bd52f0e
RS
2697 ;; STATE is what is returned by `parse-partial-sexp'.
2698 ;; DEPTH is true is we are immediately after end of block
2699 ;; which contains START.
2700 ;; PRESTART is the position basing on which START was found.
f83d2997
KH
2701 (save-excursion
2702 (let ((start-point (point)) depth state start prestart)
5bd52f0e
RS
2703 (if (and parse-start
2704 (<= parse-start start-point))
f83d2997 2705 (goto-char parse-start)
5bd52f0e
RS
2706 (beginning-of-defun)
2707 (setq start-state nil))
f83d2997
KH
2708 (setq prestart (point))
2709 (if start-state nil
2710 ;; Try to go out, if sub is not on the outermost level
2711 (while (< (point) start-point)
2712 (setq start (point) parse-start start depth nil
2713 state (parse-partial-sexp start start-point -1))
2714 (if (> (car state) -1) nil
2715 ;; The current line could start like }}}, so the indentation
2716 ;; corresponds to a different level than what we reached
2717 (setq depth t)
2718 (beginning-of-line 2))) ; Go to the next line.
2719 (if start (goto-char start))) ; Not at the start of file
2720 (setq start (point))
f83d2997
KH
2721 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2722 (list start state depth prestart))))
2723
f83d2997
KH
2724(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2725
4ab89e7b
SM
2726(defun cperl-beginning-of-property (p prop &optional lim)
2727 "Given that P has a property PROP, find where the property starts.
2728Will not look before LIM."
2729 ;;; XXXX What to do at point-max???
2730 (or (previous-single-property-change (cperl-1+ p) prop lim)
2731 (point-min))
2732;;; (cond ((eq p (point-min))
2733;;; p)
2734;;; ((and lim (<= p lim))
2735;;; p)
2736;;; ((not (get-text-property (1- p) prop))
2737;;; p)
2738;;; (t (or (previous-single-property-change p look-prop lim)
2739;;; (point-min))))
2740 )
2741
2742(defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
8c777c8d 2743 ;; the sniffer logic to understand what the current line MEANS.
f739b53b 2744 (cperl-update-syntaxification (point) (point))
4ab89e7b
SM
2745 (let ((res (get-text-property (point) 'syntax-type)))
2746 (save-excursion
2747 (cond
2748 ((and (memq res '(pod here-doc here-doc-delim format))
2749 (not (get-text-property (point) 'indentable)))
2750 (vector res))
2751 ;; before start of POD - whitespace found since do not have 'pod!
2752 ((looking-at "[ \t]*\n=")
2753 (error "Spaces before POD section!"))
2754 ((and (not cperl-indent-left-aligned-comments)
2755 (looking-at "^#"))
2756 [comment-special:at-beginning-of-line])
2757 ((get-text-property (point) 'in-pod)
2758 [in-pod])
2759 (t
2760 (beginning-of-line)
2761 (let* ((indent-point (point))
2762 (char-after-pos (save-excursion
2763 (skip-chars-forward " \t")
2764 (point)))
2765 (char-after (char-after char-after-pos))
2766 (pre-indent-point (point))
2767 p prop look-prop is-block delim)
2768 (save-excursion ; Know we are not in POD, find appropriate pos before
83261a2f
SM
2769 (cperl-backward-to-noncomment nil)
2770 (setq p (max (point-min) (1- (point)))
2771 prop (get-text-property p 'syntax-type)
2772 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2773 'syntax-type))
2774 (if (memq prop '(pod here-doc format here-doc-delim))
2775 (progn
4ab89e7b 2776 (goto-char (cperl-beginning-of-property p look-prop))
83261a2f 2777 (beginning-of-line)
4ab89e7b 2778 (setq pre-indent-point (point)))))
97610156 2779 (goto-char pre-indent-point) ; Orig line skipping preceding pod/etc
4ab89e7b
SM
2780 (let* ((case-fold-search nil)
2781 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2782 (start (or (nth 2 parse-data) ; last complete sexp terminated
2783 (nth 0 s-s))) ; Good place to start parsing
2784 (state (nth 1 s-s))
2785 (containing-sexp (car (cdr state)))
2786 old-indent)
2787 (if (and
2788 ;;containing-sexp ;; We are buggy at toplevel :-(
2789 parse-data)
2790 (progn
2791 (setcar parse-data pre-indent-point)
2792 (setcar (cdr parse-data) state)
2793 (or (nth 2 parse-data)
2794 (setcar (cddr parse-data) start))
2795 ;; Before this point: end of statement
2796 (setq old-indent (nth 3 parse-data))))
2797 (cond ((get-text-property (point) 'indentable)
2798 ;; indent to "after" the surrounding open
2799 ;; (same offset as `cperl-beautify-regexp-piece'),
2800 ;; skip blanks if we do not close the expression.
2801 (setq delim ; We do not close the expression
2802 (get-text-property
2803 (cperl-1+ char-after-pos) 'indentable)
2804 p (1+ (cperl-beginning-of-property
2805 (point) 'indentable))
97610156
GM
2806 is-block ; misused for: preceding line in REx
2807 (save-excursion ; Find preceding line
4ab89e7b
SM
2808 (cperl-backward-to-noncomment p)
2809 (beginning-of-line)
2810 (if (<= (point) p)
2811 (progn ; get indent from the first line
2812 (goto-char p)
2813 (skip-chars-forward " \t")
2814 (if (memq (char-after (point))
2815 (append "#\n" nil))
53964682 2816 nil ; Can't use indentation of this line...
4ab89e7b
SM
2817 (point)))
2818 (skip-chars-forward " \t")
2819 (point)))
2820 prop (parse-partial-sexp p char-after-pos))
2821 (cond ((not delim) ; End the REx, ignore is-block
2822 (vector 'indentable 'terminator p is-block))
97610156 2823 (is-block ; Indent w.r.t. preceding line
4ab89e7b
SM
2824 (vector 'indentable 'cont-line char-after-pos
2825 is-block char-after p))
97610156 2826 (t ; No preceding line...
4ab89e7b
SM
2827 (vector 'indentable 'first-line p))))
2828 ((get-text-property char-after-pos 'REx-part2)
2829 (vector 'REx-part2 (point)))
4ab89e7b 2830 ((nth 4 state)
82d9a08d
SM
2831 [comment])
2832 ((nth 3 state)
4ab89e7b
SM
2833 [string])
2834 ;; XXXX Do we need to special-case this?
2835 ((null containing-sexp)
2836 ;; Line is at top level. May be data or function definition,
2837 ;; or may be function argument declaration.
2838 ;; Indent like the previous top level line
2839 ;; unless that ends in a closeparen without semicolon,
2840 ;; in which case this line is the first argument decl.
2841 (skip-chars-forward " \t")
2842 (cperl-backward-to-noncomment (or old-indent (point-min)))
2843 (setq state
2844 (or (bobp)
2845 (eq (point) old-indent) ; old-indent was at comment
2846 (eq (preceding-char) ?\;)
2847 ;; Had ?\) too
2848 (and (eq (preceding-char) ?\})
2849 (cperl-after-block-and-statement-beg
2850 (point-min))) ; Was start - too close
2851 (memq char-after (append ")]}" nil))
2852 (and (eq (preceding-char) ?\:) ; label
83261a2f
SM
2853 (progn
2854 (forward-sexp -1)
4ab89e7b
SM
2855 (skip-chars-backward " \t")
2856 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2857 (get-text-property (point) 'first-format-line)))
cb5bf6ba 2858
4ab89e7b
SM
2859 ;; Look at previous line that's at column 0
2860 ;; to determine whether we are in top-level decls
2861 ;; or function's arg decls. Set basic-indent accordingly.
2862 ;; Now add a little if this is a continuation line.
2863 (and state
2864 parse-data
2865 (not (eq char-after ?\C-j))
2866 (setcdr (cddr parse-data)
2867 (list pre-indent-point)))
2868 (vector 'toplevel start char-after state (nth 2 s-s)))
2869 ((not
2870 (or (setq is-block
2871 (and (setq delim (= (char-after containing-sexp) ?{))
2872 (save-excursion ; Is it a hash?
2873 (goto-char containing-sexp)
2874 (cperl-block-p))))
2875 cperl-indent-parens-as-block))
2876 ;; group is an expression, not a block:
2877 ;; indent to just after the surrounding open parens,
2878 ;; skip blanks if we do not close the expression.
2879 (goto-char (1+ containing-sexp))
2880 (or (memq char-after
2881 (append (if delim "}" ")]}") nil))
2882 (looking-at "[ \t]*\\(#\\|$\\)")
2883 (skip-chars-forward " \t"))
2884 (setq old-indent (point)) ; delim=is-brace
2885 (vector 'in-parens char-after (point) delim containing-sexp))
2886 (t
2887 ;; Statement level. Is it a continuation or a new statement?
2888 ;; Find previous non-comment character.
2889 (goto-char pre-indent-point) ; Skip one level of POD/etc
2890 (cperl-backward-to-noncomment containing-sexp)
2891 ;; Back up over label lines, since they don't
2892 ;; affect whether our line is a continuation.
2893 ;; (Had \, too)
2894 (while;;(or (eq (preceding-char) ?\,)
2895 (and (eq (preceding-char) ?:)
2896 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2897 (memq (char-syntax (char-after (- (point) 2)))
2898 '(?w ?_))))
2899 ;;)
2900 ;; This is always FALSE?
2901 (if (eq (preceding-char) ?\,)
2902 ;; Will go to beginning of line, essentially.
2903 ;; Will ignore embedded sexpr XXXX.
2904 (cperl-backward-to-start-of-continued-exp containing-sexp))
2905 (beginning-of-line)
2906 (cperl-backward-to-noncomment containing-sexp))
97610156 2907 ;; Now we get non-label preceding the indent point
4ab89e7b
SM
2908 (if (not (or (eq (1- (point)) containing-sexp)
2909 (memq (preceding-char)
2910 (append (if is-block " ;{" " ,;{") '(nil)))
2911 (and (eq (preceding-char) ?\})
2912 (cperl-after-block-and-statement-beg
2913 containing-sexp))
2914 (get-text-property (point) 'first-format-line)))
2915 ;; This line is continuation of preceding line's statement;
2916 ;; indent `cperl-continued-statement-offset' more than the
2917 ;; previous line of the statement.
2918 ;;
2919 ;; There might be a label on this line, just
2920 ;; consider it bad style and ignore it.
2921 (progn
2922 (cperl-backward-to-start-of-continued-exp containing-sexp)
2923 (vector 'continuation (point) char-after is-block delim))
2924 ;; This line starts a new statement.
2925 ;; Position following last unclosed open brace
2926 (goto-char containing-sexp)
2927 ;; Is line first statement after an open-brace?
2928 (or
2929 ;; If no, find that first statement and indent like
2930 ;; it. If the first statement begins with label, do
2931 ;; not believe when the indentation of the label is too
2932 ;; small.
2933 (save-excursion
2934 (forward-char 1)
2935 (let ((colon-line-end 0))
2936 (while
2937 (progn (skip-chars-forward " \t\n")
82d9a08d
SM
2938 ;; s: foo : bar :x is NOT label
2939 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2940 (not (looking-at "[sym]:\\|tr:"))))
4ab89e7b
SM
2941 ;; Skip over comments and labels following openbrace.
2942 (cond ((= (following-char) ?\#)
2943 (forward-line 1))
2944 ((= (following-char) ?\=)
2945 (goto-char
2946 (or (next-single-property-change (point) 'in-pod)
2947 (point-max)))) ; do not loop if no syntaxification
2948 ;; label:
2949 (t
e180ab9f 2950 (setq colon-line-end (point-at-eol))
4ab89e7b
SM
2951 (search-forward ":"))))
2952 ;; We are at beginning of code (NOT label or comment)
2953 ;; First, the following code counts
2954 ;; if it is before the line we want to indent.
2955 (and (< (point) indent-point)
2956 (vector 'have-prev-sibling (point) colon-line-end
2957 containing-sexp))))
2958 (progn
2959 ;; If no previous statement,
2960 ;; indent it relative to line brace is on.
2961
2962 ;; For open-braces not the first thing in a line,
2963 ;; add in cperl-brace-imaginary-offset.
2964
2965 ;; If first thing on a line: ?????
2966 ;; Move back over whitespace before the openbrace.
2967 (setq ; brace first thing on a line
2968 old-indent (progn (skip-chars-backward " \t") (bolp)))
2969 ;; Should we indent w.r.t. earlier than start?
2970 ;; Move to start of control group, possibly on a different line
2971 (or cperl-indent-wrt-brace
2972 (cperl-backward-to-noncomment (point-min)))
2973 ;; If the openbrace is preceded by a parenthesized exp,
2974 ;; move to the beginning of that;
2975 (if (eq (preceding-char) ?\))
2976 (progn
2977 (forward-sexp -1)
2978 (cperl-backward-to-noncomment (point-min))))
2979 ;; In the case it starts a subroutine, indent with
2980 ;; respect to `sub', not with respect to the
2981 ;; first thing on the line, say in the case of
2982 ;; anonymous sub in a hash.
2983 (if (and;; Is it a sub in group starting on this line?
2984 (cond ((get-text-property (point) 'attrib-group)
2985 (goto-char (cperl-beginning-of-property
2986 (point) 'attrib-group)))
2987 ((eq (preceding-char) ?b)
2988 (forward-sexp -1)
2989 (looking-at "sub\\>")))
2990 (setq p (nth 1 ; start of innermost containing list
2991 (parse-partial-sexp
9b026d9f 2992 (point-at-bol)
4ab89e7b
SM
2993 (point)))))
2994 (progn
2995 (goto-char (1+ p)) ; enclosing block on the same line
2996 (skip-chars-forward " \t")
2997 (vector 'code-start-in-block containing-sexp char-after
2998 (and delim (not is-block)) ; is a HASH
2999 old-indent ; brace first thing on a line
3000 t (point) ; have something before...
3001 )
3002 ;;(current-column)
3003 )
3004 ;; Get initial indentation of the line we are on.
3005 ;; If line starts with label, calculate label indentation
3006 (vector 'code-start-in-block containing-sexp char-after
3007 (and delim (not is-block)) ; is a HASH
3008 old-indent ; brace first thing on a line
82d9a08d 3009 nil (point))))))))))))))) ; nothing interesting before
4ab89e7b
SM
3010
3011(defvar cperl-indent-rules-alist
3012 '((pod nil) ; via `syntax-type' property
3013 (here-doc nil) ; via `syntax-type' property
3014 (here-doc-delim nil) ; via `syntax-type' property
3015 (format nil) ; via `syntax-type' property
3016 (in-pod nil) ; via `in-pod' property
3017 (comment-special:at-beginning-of-line nil)
3018 (string t)
3019 (comment nil))
3020 "Alist of indentation rules for CPerl mode.
3021The values mean:
3022 nil: do not indent;
82d9a08d 3023 number: add this amount of indentation.")
4ab89e7b
SM
3024
3025(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3026 "Return appropriate indentation for current line as Perl code.
3027In usual case returns an integer: the column to indent to.
3028Returns nil if line starts inside a string, t if in a comment.
3029
3030Will not correct the indentation for labels, but will correct it for braces
3031and closing parentheses and brackets."
3032 ;; This code is still a broken architecture: in some cases we need to
3033 ;; compensate for some modifications which `cperl-indent-line' will add later
3034 (save-excursion
3035 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3036 (cond
3037 ;;((or (null i) (eq i t) (numberp i))
3038 ;; i)
3039 ((vectorp i)
3040 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3041 (cond
3042 (what (cadr what)) ; Load from table
3043 ;;
3044 ;; Indenters for regular expressions with //x and qw()
3045 ;;
3046 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3047 (goto-char (elt i 1))
3048 (condition-case nil ; Use indentation of the 1st part
3049 (forward-sexp -1))
3050 (current-column))
3051 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3052 (cond ;;; [indentable terminator start-pos is-block]
3053 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3054 (goto-char (elt i 2)) ; After opening parens
3055 (1- (current-column)))
3056 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3057 (goto-char (elt i 2))
3058 (+ (or cperl-regexp-indent-step cperl-indent-level)
3059 -1
3060 (current-column)))
3061 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3062 ;; Indent as the level after closing parens
3063 (goto-char (elt i 2)) ; indent line
3064 (skip-chars-forward " \t)") ; Skip closing parens
3065 (setq p (point))
3066 (goto-char (elt i 3)) ; previous line
3067 (skip-chars-forward " \t)") ; Skip closing parens
3068 ;; Number of parens in between:
3069 (setq p (nth 0 (parse-partial-sexp (point) p))
3070 what (elt i 4)) ; First char on current line
3071 (goto-char (elt i 3)) ; previous line
3072 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3073 (cond ((eq what ?\) )
3074 (- cperl-close-paren-offset)) ; compensate
3075 ((eq what ?\| )
3076 (- (or cperl-regexp-indent-step cperl-indent-level)))
3077 (t 0))
3078 (if (eq (following-char) ?\| )
3079 (or cperl-regexp-indent-step cperl-indent-level)
3080 0)
3081 (current-column)))
3082 (t
3083 (error "Unrecognized value of indent: %s" i))))
3084 ;;
3085 ;; Indenter for stuff at toplevel
3086 ;;
3087 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3088 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3089 (goto-char (elt i 1)) ; start = Good place to start parsing
cb5bf6ba 3090 (- (current-indentation) ;
4ab89e7b
SM
3091 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3092 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3093 ;; Look at previous line that's at column 0
3094 ;; to determine whether we are in top-level decls
3095 ;; or function's arg decls. Set basic-indent accordingly.
3096 ;; Now add a little if this is a continuation line.
3097 (if (elt i 3) ; state (XXX What is the semantic???)
3098 0
3099 cperl-continued-statement-offset)))
3100 ;;
3101 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3102 ;;
3103 ((eq 'in-parens (elt i 0))
3104 ;; in-parens char-after old-indent-point is-brace containing-sexp
3105
3106 ;; group is an expression, not a block:
3107 ;; indent to just after the surrounding open parens,
3108 ;; skip blanks if we do not close the expression.
3109 (+ (progn
3110 (goto-char (elt i 2)) ; old-indent-point
3111 (current-column))
3112 (if (and (elt i 3) ; is-brace
3113 (eq (elt i 1) ?\})) ; char-after
3114 ;; Correct indentation of trailing ?\}
3115 (+ cperl-indent-level cperl-close-paren-offset)
3116 0)))
3117 ;;
3118 ;; Indenter for continuation lines
3119 ;;
3120 ((eq 'continuation (elt i 0))
3121 ;; [continuation statement-start char-after is-block is-brace]
3122 (goto-char (elt i 1)) ; statement-start
fd146719
SS
3123 (+ (if (or (memq (elt i 2) (append "}])" nil)) ; char-after
3124 (eq 'continuation ; do not stagger continuations
3125 (elt (cperl-sniff-for-indent parse-data) 0)))
3126 0 ; Closing parenth or continuation of a continuation
4ab89e7b
SM
3127 cperl-continued-statement-offset)
3128 (if (or (elt i 3) ; is-block
3129 (not (elt i 4)) ; is-brace
3130 (not (eq (elt i 2) ?\}))) ; char-after
3131 0
3132 ;; Now it is a hash reference
3133 (+ cperl-indent-level cperl-close-paren-offset))
3134 ;; Labels do not take :: ...
3135 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3136 (if (> (current-indentation) cperl-min-label-indent)
3137 (- (current-indentation) cperl-label-offset)
3138 ;; Do not move `parse-data', this should
3139 ;; be quick anyway (this comment comes
3140 ;; from different location):
3141 (cperl-calculate-indent))
3142 (current-column))
3143 (if (eq (elt i 2) ?\{) ; char-after
3144 cperl-continued-brace-offset 0)))
3145 ;;
3146 ;; Indenter for lines in a block which are not leading lines
3147 ;;
3148 ((eq 'have-prev-sibling (elt i 0))
3149 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
82d9a08d
SM
3150 (goto-char (elt i 1)) ; sibling-beg
3151 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
4ab89e7b
SM
3152 (if (> (current-indentation)
3153 cperl-min-label-indent)
3154 (- (current-indentation) cperl-label-offset)
3155 ;; Do not believe: `max' was involved in calculation of indent
3156 (+ cperl-indent-level
3157 (save-excursion
3158 (goto-char (elt i 3)) ; block-start
3159 (current-indentation))))
3160 (current-column)))
3161 ;;
3162 ;; Indenter for the first line in a block
3163 ;;
3164 ((eq 'code-start-in-block (elt i 0))
3165 ;;[code-start-in-block before-brace char-after
3166 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3167 ;; group-starts-before-start-of-sub start-of-control-group]
3168 (goto-char (elt i 1))
3169 ;; For open brace in column zero, don't let statement
3170 ;; start there too. If cperl-indent-level=0,
3171 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3172 (+ (if (and (bolp) (zerop cperl-indent-level))
3173 (+ cperl-brace-offset cperl-continued-statement-offset)
3174 cperl-indent-level)
3175 (if (and (elt i 3) ; is-a-HASH-ref
3176 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3177 (+ cperl-indent-level cperl-close-paren-offset)
3178 0)
3179 ;; Unless openbrace is the first nonwhite thing on the line,
3180 ;; add the cperl-brace-imaginary-offset.
3181 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3182 cperl-brace-imaginary-offset)
3183 (progn
3184 (goto-char (elt i 6)) ; start-of-control-group
3185 (if (elt i 5) ; group-starts-before-start-of-sub
3186 (current-column)
3187 ;; Get initial indentation of the line we are on.
3188 ;; If line starts with label, calculate label indentation
3189 (if (save-excursion
3190 (beginning-of-line)
3191 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3192 (if (> (current-indentation) cperl-min-label-indent)
3193 (- (current-indentation) cperl-label-offset)
3194 ;; Do not move `parse-data', this should
3195 ;; be quick anyway:
3196 (cperl-calculate-indent))
3197 (current-indentation))))))
3198 (t
3199 (error "Unrecognized value of indent: %s" i))))
3200 (t
3201 (error "Got strange value of indent: %s" i))))))
3202
f83d2997
KH
3203(defun cperl-calculate-indent-within-comment ()
3204 "Return the indentation amount for line, assuming that
3205the current line is to be regarded as part of a block comment."
3206 (let (end star-start)
3207 (save-excursion
3208 (beginning-of-line)
3209 (skip-chars-forward " \t")
3210 (setq end (point))
3211 (and (= (following-char) ?#)
3212 (forward-line -1)
3213 (cperl-to-comment-or-eol)
3214 (setq end (point)))
3215 (goto-char end)
3216 (current-column))))
3217
3218
3219(defun cperl-to-comment-or-eol ()
029cb4d5 3220 "Go to position before comment on the current line, or to end of line.
4ab89e7b
SM
3221Returns true if comment is found. In POD will not move the point."
3222 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3223 ;; then looks for literal # or end-of-line.
e180ab9f 3224 (let (state stop-in cpoint (lim (point-at-eol)) pr e)
4ab89e7b
SM
3225 (or cperl-font-locking
3226 (cperl-update-syntaxification lim lim))
83261a2f 3227 (beginning-of-line)
4ab89e7b
SM
3228 (if (setq pr (get-text-property (point) 'syntax-type))
3229 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3230 (if (or (eq pr 'pod)
3231 (if (or (not e) (> e lim)) ; deep inside a group
3232 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
83261a2f 3233 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
4ab89e7b
SM
3234 ;; Else - need to do it the hard way
3235 (and (and e (<= e lim))
3236 (goto-char e))
83261a2f
SM
3237 (while (not stop-in)
3238 (setq state (parse-partial-sexp (point) lim nil nil nil t))
f83d2997 3239 ; stop at comment
83261a2f
SM
3240 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3241 (if (nth 4 state) ; After `#';
f83d2997
KH
3242 ; (nth 2 state) can be
3243 ; beginning of m,s,qq and so
3244 ; on
83261a2f
SM
3245 (if (nth 2 state)
3246 (progn
3247 (setq cpoint (point))
3248 (goto-char (nth 2 state))
3249 (cond
3250 ((looking-at "\\(s\\|tr\\)\\>")
3251 (or (re-search-forward
3252 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3253 lim 'move)
3254 (setq stop-in t)))
3255 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3256 (or (re-search-forward
3257 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3258 lim 'move)
3259 (setq stop-in t)))
3260 (t ; It was fair comment
3261 (setq stop-in t) ; Finish
3262 (goto-char (1- cpoint)))))
3263 (setq stop-in t) ; Finish
3264 (forward-char -1))
15ca5699 3265 (setq stop-in t))) ; Finish
83261a2f 3266 (nth 4 state))))
f83d2997 3267
f83d2997
KH
3268(defsubst cperl-modify-syntax-type (at how)
3269 (if (< at (point-max))
3270 (progn
3271 (put-text-property at (1+ at) 'syntax-table how)
4ab89e7b 3272 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
f83d2997
KH
3273
3274(defun cperl-protect-defun-start (s e)
3275 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3276 (save-excursion
3277 (goto-char s)
3278 (while (re-search-forward "^\\s(" e 'to-end)
3279 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3280
5bd52f0e 3281(defun cperl-commentify (bb e string &optional noface)
5c8b7eaf 3282 (if cperl-use-syntax-table-text-property
5bd52f0e
RS
3283 (if (eq noface 'n) ; Only immediate
3284 nil
f83d2997
KH
3285 ;; We suppose that e is _after_ the end of construction, as after eol.
3286 (setq string (if string cperl-st-sfence cperl-st-cfence))
6c389151
SM
3287 (if (> bb (- e 2))
3288 ;; one-char string/comment?!
3289 (cperl-modify-syntax-type bb cperl-st-punct)
3290 (cperl-modify-syntax-type bb string)
3291 (cperl-modify-syntax-type (1- e) string))
f83d2997 3292 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
5c8b7eaf 3293 (put-text-property (1+ bb) (1- e)
f83d2997 3294 'syntax-table cperl-string-syntax-table))
5bd52f0e
RS
3295 (cperl-protect-defun-start bb e))
3296 ;; Fontify
3297 (or noface
3298 (not cperl-pod-here-fontify)
3299 (put-text-property bb e 'face (if string 'font-lock-string-face
3300 'font-lock-comment-face)))))
6c389151 3301
5bd52f0e
RS
3302(defvar cperl-starters '(( ?\( . ?\) )
3303 ( ?\[ . ?\] )
3304 ( ?\{ . ?\} )
3305 ( ?\< . ?\> )))
f83d2997 3306
4ab89e7b
SM
3307(defun cperl-cached-syntax-table (st)
3308 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3309All the entries of the syntax table are \".\", except for a backslash, which
3310is quoting."
3311 (if (car-safe st)
3312 (car st)
3313 (setcar st (make-syntax-table))
3314 (setq st (car st))
3315 (let ((i 0))
3316 (while (< i 256)
3317 (modify-syntax-entry i "." st)
3318 (setq i (1+ i))))
3319 (modify-syntax-entry ?\\ "\\" st)
3320 st))
3321
3322(defun cperl-forward-re (lim end is-2arg st-l err-l argument
f83d2997 3323 &optional ostart oend)
4ab89e7b
SM
3324"Find the end of a regular expression or a stringish construct (q[] etc).
3325The point should be before the starting delimiter.
3326
3327Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3328is s/// or tr/// like expression. If END is nil, generates an error
3329message if needed. If SET-ST is non-nil, will use (or generate) a
3330cached syntax table in ST-L. If ERR-L is non-nil, will store the
3331error message in its CAR (unless it already contains some error
3332message). ARGUMENT should be the name of the construct (used in error
3333messages). OSTART, OEND may be set in recursive calls when processing
3334the second argument of 2ARG construct.
3335
3336Works *before* syntax recognition is done. In IS-2ARG situation may
3337modify syntax-type text property if the situation is too hard."
3338 (let (b starter ender st i i2 go-forward reset-st set-st)
f83d2997
KH
3339 (skip-chars-forward " \t")
3340 ;; ender means matching-char matcher.
5c8b7eaf 3341 (setq b (point)
5bd52f0e
RS
3342 starter (if (eobp) 0 (char-after b))
3343 ender (cdr (assoc starter cperl-starters)))
f83d2997 3344 ;; What if starter == ?\\ ????
4ab89e7b 3345 (setq st (cperl-cached-syntax-table st-l))
f83d2997
KH
3346 (setq set-st t)
3347 ;; Whether we have an intermediate point
3348 (setq i nil)
3349 ;; Prepare the syntax table:
4ab89e7b
SM
3350 (if (not ender) ; m/blah/, s/x//, s/x/y/
3351 (modify-syntax-entry starter "$" st)
3352 (modify-syntax-entry starter (concat "(" (list ender)) st)
3353 (modify-syntax-entry ender (concat ")" (list starter)) st))
f83d2997
KH
3354 (condition-case bb
3355 (progn
5bd52f0e
RS
3356 ;; We use `$' syntax class to find matching stuff, but $$
3357 ;; is recognized the same as $, so we need to check this manually.
f83d2997
KH
3358 (if (and (eq starter (char-after (cperl-1+ b)))
3359 (not ender))
3360 ;; $ has TeXish matching rules, so $$ equiv $...
3361 (forward-char 2)
6c389151 3362 (setq reset-st (syntax-table))
f83d2997
KH
3363 (set-syntax-table st)
3364 (forward-sexp 1)
6c389151
SM
3365 (if (<= (point) (1+ b))
3366 (error "Unfinished regular expression"))
3367 (set-syntax-table reset-st)
3368 (setq reset-st nil)
f83d2997
KH
3369 ;; Now the problem is with m;blah;;
3370 (and (not ender)
3371 (eq (preceding-char)
3372 (char-after (- (point) 2)))
3373 (save-excursion
3374 (forward-char -2)
3375 (= 0 (% (skip-chars-backward "\\\\") 2)))
3376 (forward-char -1)))
5bd52f0e 3377 ;; Now we are after the first part.
f83d2997
KH
3378 (and is-2arg ; Have trailing part
3379 (not ender)
3380 (eq (following-char) starter) ; Empty trailing part
3381 (progn
3382 (or (eq (char-syntax (following-char)) ?.)
3383 ;; Make trailing letter into punctuation
3384 (cperl-modify-syntax-type (point) cperl-st-punct))
3385 (setq is-2arg nil go-forward t))) ; Ignore the tail
3386 (if is-2arg ; Not number => have second part
3387 (progn
3388 (setq i (point) i2 i)
3389 (if ender
b5b0cb34 3390 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
f83d2997
KH
3391 (progn
3392 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3393 (goto-char (match-end 0))
3394 (skip-chars-forward " \t\n\f"))
3395 (setq i2 (point))))
3396 (forward-char -1))
3397 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
5c8b7eaf 3398 (if ender (modify-syntax-entry ender "." st))
f83d2997 3399 (setq set-st nil)
4ab89e7b 3400 (setq ender (cperl-forward-re lim end nil st-l err-l
5bd52f0e 3401 argument starter ender)
8c777c8d 3402 ender (nth 2 ender)))))
f83d2997
KH
3403 (error (goto-char lim)
3404 (setq set-st nil)
6c389151
SM
3405 (if reset-st
3406 (set-syntax-table reset-st))
f83d2997 3407 (or end
8c777c8d
CY
3408 (and cperl-brace-recursing
3409 (or (eq ostart ?\{)
3410 (eq starter ?\{)))
f83d2997 3411 (message
5bd52f0e 3412 "End of `%s%s%c ... %c' string/RE not found: %s"
f83d2997
KH
3413 argument
3414 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3415 starter (or ender starter) bb)
3416 (or (car err-l) (setcar err-l b)))))
3417 (if set-st
3418 (progn
3419 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3420 (if ender (modify-syntax-entry ender "." st))))
5bd52f0e 3421 ;; i: have 2 args, after end of the first arg
e7f767c2 3422 ;; i2: start of the second arg, if any (before delim if `ender').
5bd52f0e
RS
3423 ;; ender: the last arg bounded by parens-like chars, the second one of them
3424 ;; starter: the starting delimiter of the first arg
5efe6a56 3425 ;; go-forward: has 2 args, and the second part is empty
f83d2997
KH
3426 (list i i2 ender starter go-forward)))
3427
4ab89e7b
SM
3428(defun cperl-forward-group-in-re (&optional st-l)
3429 "Find the end of a group in a REx.
3430Return the error message (if any). Does not work if delimiter is `)'.
3431Works before syntax recognition is done."
3432 ;; Works *before* syntax recognition is done
3433 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3434 (let (st b reset-st)
3435 (condition-case b
3436 (progn
3437 (setq st (cperl-cached-syntax-table st-l))
3438 (modify-syntax-entry ?\( "()" st)
3439 (modify-syntax-entry ?\) ")(" st)
3440 (setq reset-st (syntax-table))
3441 (set-syntax-table st)
3442 (forward-sexp 1))
3443 (error (message
3444 "cperl-forward-group-in-re: error %s" b)))
3445 ;; now restore the initial state
3446 (if st
3447 (progn
3448 (modify-syntax-entry ?\( "." st)
3449 (modify-syntax-entry ?\) "." st)))
3450 (if reset-st
3451 (set-syntax-table reset-st))
3452 b))
3453
3454
83261a2f
SM
3455(defvar font-lock-string-face)
3456;;(defvar font-lock-reference-face)
3457(defvar font-lock-constant-face)
5c8b7eaf 3458(defsubst cperl-postpone-fontification (b e type val &optional now)
5bd52f0e
RS
3459 ;; Do after syntactic fontification?
3460 (if cperl-syntaxify-by-font-lock
3461 (or now (put-text-property b e 'cperl-postpone (cons type val)))
83261a2f 3462 (put-text-property b e type val)))
5bd52f0e
RS
3463
3464;;; Here is how the global structures (those which cannot be
3465;;; recognized locally) are marked:
5c8b7eaf 3466;; a) PODs:
5bd52f0e
RS
3467;; Start-to-end is marked `in-pod' ==> t
3468;; Each non-literal part is marked `syntax-type' ==> `pod'
3469;; Each literal part is marked `syntax-type' ==> `in-pod'
5c8b7eaf 3470;; b) HEREs:
5bd52f0e
RS
3471;; Start-to-end is marked `here-doc-group' ==> t
3472;; The body is marked `syntax-type' ==> `here-doc'
3473;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
5c8b7eaf 3474;; c) FORMATs:
f739b53b
SM
3475;; First line (to =) marked `first-format-line' ==> t
3476;; After-this--to-end is marked `syntax-type' ==> `format'
5c8b7eaf 3477;; d) 'Q'uoted string:
5bd52f0e 3478;; part between markers inclusive is marked `syntax-type' ==> `string'
6c389151 3479;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
4ab89e7b
SM
3480;; second part of s///e is marked `syntax-type' ==> `multiline'
3481;; e) Attributes of subroutines: `attrib-group' ==> t
3482;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3483;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3484
3485;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3486;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
5bd52f0e
RS
3487
3488(defun cperl-unwind-to-safe (before &optional end)
3489 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3490 (let ((pos (point)) opos)
4ab89e7b
SM
3491 (while (and pos (progn
3492 (beginning-of-line)
3493 (get-text-property (setq pos (point)) 'syntax-type)))
3494 (setq opos pos
3495 pos (cperl-beginning-of-property pos 'syntax-type))
3496 (if (eq pos (point-min))
3497 (setq pos nil))
5bd52f0e
RS
3498 (if pos
3499 (if before
3500 (progn
3501 (goto-char (cperl-1- pos))
3502 (beginning-of-line)
3503 (setq pos (point)))
3504 (goto-char (setq pos (cperl-1- pos))))
3505 ;; Up to the start
3506 (goto-char (point-min))))
6c389151
SM
3507 ;; Skip empty lines
3508 (and (looking-at "\n*=")
3509 (/= 0 (skip-chars-backward "\n"))
3510 (forward-char))
3511 (setq pos (point))
5bd52f0e
RS
3512 (if end
3513 ;; Do the same for end, going small steps
4ab89e7b 3514 (save-excursion
95bdccb7
SM
3515 (while (and end (< end (point-max))
3516 (get-text-property end 'syntax-type))
5bd52f0e 3517 (setq pos end
4ab89e7b
SM
3518 end (next-single-property-change end 'syntax-type nil (point-max)))
3519 (if end (progn (goto-char end)
3520 (or (bolp) (forward-line 1))
3521 (setq end (point)))))
5bd52f0e
RS
3522 (or end pos)))))
3523
4ab89e7b 3524;;; These are needed for byte-compile (at least with v19)
6c389151 3525(defvar cperl-nonoverridable-face)
4ab89e7b 3526(defvar font-lock-variable-name-face)
6c389151 3527(defvar font-lock-function-name-face)
4ab89e7b
SM
3528(defvar font-lock-keyword-face)
3529(defvar font-lock-builtin-face)
3530(defvar font-lock-type-face)
6c389151 3531(defvar font-lock-comment-face)
4ab89e7b 3532(defvar font-lock-warning-face)
6c389151 3533
4ab89e7b 3534(defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
bbd240ce 3535 "Syntactically mark (and fontify) attributes of a subroutine.
4ab89e7b
SM
3536Should be called with the point before leading colon of an attribute."
3537 ;; Works *before* syntax recognition is done
3538 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3539 (let (st b p reset-st after-first (start (point)) start1 end1)
3540 (condition-case b
3541 (while (looking-at
3542 (concat
3543 "\\(" ; 1=optional? colon
3544 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3545 "\\)"
3546 (if after-first "?" "")
3547 ;; No space between name and paren allowed...
3548 "\\(\\sw+\\)" ; 3=name
3549 "\\((\\)?")) ; 4=optional paren
3550 (and (match-beginning 1)
3551 (cperl-postpone-fontification
3552 (match-beginning 0) (cperl-1+ (match-beginning 0))
3553 'face font-lock-constant-face))
3554 (setq start1 (match-beginning 3) end1 (match-end 3))
3555 (cperl-postpone-fontification start1 end1
3556 'face font-lock-constant-face)
3557 (goto-char end1) ; end or before `('
3558 (if (match-end 4) ; Have attribute arguments...
3559 (progn
3560 (if st nil
3561 (setq st (cperl-cached-syntax-table st-l))
3562 (modify-syntax-entry ?\( "()" st)
3563 (modify-syntax-entry ?\) ")(" st))
3564 (setq reset-st (syntax-table) p (point))
3565 (set-syntax-table st)
3566 (forward-sexp 1)
3567 (set-syntax-table reset-st)
3568 (setq reset-st nil)
3569 (cperl-commentify p (point) t))) ; mark as string
3570 (forward-comment (buffer-size))
3571 (setq after-first t))
3572 (error (message
3573 "L%d: attribute `%s': %s"
3574 (count-lines (point-min) (point))
3575 (and start1 end1 (buffer-substring start1 end1)) b)
3576 (setq start nil)))
3577 (and start
3578 (progn
3579 (put-text-property start (point)
3580 'attrib-group (if (looking-at "{") t 0))
3581 (and pos
3582 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3583 ;; Apparently, we do not need `multiline': faces added now
3584 (put-text-property (+ 3 pos) (cperl-1+ (point))
3585 'syntax-type 'sub-decl))
3586 (and b-fname ; Fontify here: the following condition
3587 (cperl-postpone-fontification ; is too hard to determine by
3588 b-fname e-fname 'face ; a REx, so do it here
3589 (if (looking-at "{")
3590 font-lock-function-name-face
3591 font-lock-variable-name-face)))))
3592 ;; now restore the initial state
3593 (if st
3594 (progn
3595 (modify-syntax-entry ?\( "." st)
3596 (modify-syntax-entry ?\) "." st)))
3597 (if reset-st
3598 (set-syntax-table reset-st))))
3599
3600(defsubst cperl-look-at-leading-count (is-x-REx e)
82d9a08d
SM
3601 (if (and
3602 (< (point) e)
3603 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3604 (1- e) t)) ; return nil on failure, no moving
4ab89e7b
SM
3605 (if (eq ?\{ (preceding-char)) nil
3606 (cperl-postpone-fontification
3607 (1- (point)) (point)
3608 'face font-lock-warning-face))))
3609
8c777c8d
CY
3610;; Do some smarter-highlighting
3611;; XXXX Currently ignores alphanum/dash delims,
3612(defsubst cperl-highlight-charclass (endbracket dashface bsface onec-space)
3613 (let ((l '(1 5 7)) ll lle lll
3614 ;; 2 groups, the first takes the whole match (include \[trnfabe])
3615 (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{[^{}]*}" "\\)")))
3616 (while ; look for unescaped - between non-classes
3617 (re-search-forward
3618 ;; On 19.33, certain simplifications lead
3619 ;; to bugs (as in [^a-z] \\| [trnfabe] )
3620 (concat ; 1: SingleChar (include \[trnfabe])
3621 singleChar
3622 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3623 "\\(" ; 3: DASH SingleChar (match optionally)
3624 "\\(-\\)" ; 4: DASH
3625 singleChar ; 5: SingleChar
3626 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3627 "\\)?"
3628 "\\|"
3629 "\\(" ; 7: other escapes
3630 "\\\\[pP]" "\\([^{]\\|{[^{}]*}\\)"
3631 "\\|" "\\\\[^pP]" "\\)"
3632 )
3633 endbracket 'toend)
3634 (if (match-beginning 4)
3635 (cperl-postpone-fontification
3636 (match-beginning 4) (match-end 4)
3637 'face dashface))
3638 ;; save match data (for looking-at)
3639 (setq lll (mapcar (function (lambda (elt) (cons (match-beginning elt)
3640 (match-end elt)))) l))
3641 (while lll
3642 (setq ll (car lll))
3643 (setq lle (cdr ll)
3644 ll (car ll))
3645 ;; (message "Got %s of %s" ll l)
3646 (if (and ll (eq (char-after ll) ?\\ ))
3647 (save-excursion
3648 (goto-char ll)
3649 (cperl-postpone-fontification ll (1+ ll)
3650 'face bsface)
3651 (if (looking-at "\\\\[a-zA-Z0-9]")
3652 (cperl-postpone-fontification (1+ ll) lle
3653 'face onec-space))))
3654 (setq lll (cdr lll))))
3655 (goto-char endbracket) ; just in case something misbehaves???
3656 t))
3657
4ab89e7b
SM
3658;;; Debugging this may require (setq max-specpdl-size 2000)...
3659(defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
f83d2997 3660 "Scans the buffer for hard-to-parse Perl constructions.
5c8b7eaf
SS
3661If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3662the sections using `cperl-pod-head-face', `cperl-pod-face',
f83d2997
KH
3663`cperl-here-face'."
3664 (interactive)
05927f8c 3665 (or min (setq min (point-min)
db133cb6
RS
3666 cperl-syntax-state nil
3667 cperl-syntax-done-to min))
f83d2997 3668 (or max (setq max (point-max)))
83261a2f
SM
3669 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3670 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
4ab89e7b 3671 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
83261a2f 3672 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
af1d43f9 3673 (modified (buffer-modified-p)) overshoot is-o-REx name
83261a2f 3674 (after-change-functions nil)
4ab89e7b 3675 (cperl-font-locking t)
83261a2f
SM
3676 (use-syntax-state (and cperl-syntax-state
3677 (>= min (car cperl-syntax-state))))
3678 (state-point (if use-syntax-state
3679 (car cperl-syntax-state)
3680 (point-min)))
3681 (state (if use-syntax-state
3682 (cdr cperl-syntax-state)))
3683 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3684 (st-l (list nil)) (err-l (list nil))
3685 ;; Somehow font-lock may be not loaded yet...
4ab89e7b 3686 ;; (e.g., when building TAGS via command-line call)
83261a2f
SM
3687 (font-lock-string-face (if (boundp 'font-lock-string-face)
3688 font-lock-string-face
3689 'font-lock-string-face))
4ab89e7b 3690 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
83261a2f
SM
3691 font-lock-constant-face
3692 'font-lock-constant-face))
4ab89e7b 3693 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
83261a2f
SM
3694 (if (boundp 'font-lock-function-name-face)
3695 font-lock-function-name-face
3696 'font-lock-function-name-face))
4ab89e7b
SM
3697 (font-lock-variable-name-face ; interpolated vars and ({})-code
3698 (if (boundp 'font-lock-variable-name-face)
3699 font-lock-variable-name-face
3700 'font-lock-variable-name-face))
3701 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3702 (if (boundp 'font-lock-function-name-face)
3703 font-lock-function-name-face
3704 'font-lock-function-name-face))
3705 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3706 (if (boundp 'font-lock-constant-face)
3707 font-lock-constant-face
3708 'font-lock-constant-face))
3709 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3710 (if (boundp 'font-lock-builtin-face)
3711 font-lock-builtin-face
3712 'font-lock-builtin-face))
83261a2f
SM
3713 (font-lock-comment-face
3714 (if (boundp 'font-lock-comment-face)
3715 font-lock-comment-face
3716 'font-lock-comment-face))
4ab89e7b
SM
3717 (font-lock-warning-face
3718 (if (boundp 'font-lock-warning-face)
3719 font-lock-warning-face
3720 'font-lock-warning-face))
3721 (my-cperl-REx-ctl-face ; (|)
3722 (if (boundp 'font-lock-keyword-face)
3723 font-lock-keyword-face
3724 'font-lock-keyword-face))
3725 (my-cperl-REx-modifiers-face ; //gims
83261a2f
SM
3726 (if (boundp 'cperl-nonoverridable-face)
3727 cperl-nonoverridable-face
4ab89e7b
SM
3728 'cperl-nonoverridable-face))
3729 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3730 (if (boundp 'font-lock-type-face)
3731 font-lock-type-face
3732 'font-lock-type-face))
83261a2f
SM
3733 (stop-point (if ignore-max
3734 (point-max)
3735 max))
3736 (search
3737 (concat
4ab89e7b 3738 "\\(\\`\n?\\|^\n\\)=" ; POD
83261a2f
SM
3739 "\\|"
3740 ;; One extra () before this:
4ab89e7b 3741 "<<" ; HERE-DOC
83261a2f
SM
3742 "\\(" ; 1 + 1
3743 ;; First variant "BLAH" or just ``.
3744 "[ \t]*" ; Yes, whitespace is allowed!
3745 "\\([\"'`]\\)" ; 2 + 1 = 3
3746 "\\([^\"'`\n]*\\)" ; 3 + 1
3747 "\\3"
3748 "\\|"
f739b53b 3749 ;; Second variant: Identifier or \ID (same as 'ID') or empty
83261a2f
SM
3750 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3751 ;; Do not have <<= or << 30 or <<30 or << $blah.
3752 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3753 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3754 "\\)"
3755 "\\|"
3756 ;; 1+6 extra () before this:
4ab89e7b 3757 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
83261a2f 3758 (if cperl-use-syntax-table-text-property
db133cb6 3759 (concat
db133cb6 3760 "\\|"
83261a2f 3761 ;; 1+6+2=9 extra () before this:
4ab89e7b 3762 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
83261a2f
SM
3763 "\\|"
3764 ;; 1+6+2+1=10 extra () before this:
3765 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3766 "\\|"
4ab89e7b
SM
3767 ;; 1+6+2+1+1=11 extra () before this
3768 "\\<sub\\>" ; sub with proto/attr
3769 "\\("
3770 cperl-white-and-comment-rex
3771 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3772 "\\("
3773 cperl-maybe-white-and-comment-rex
3774 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
83261a2f 3775 "\\|"
4ab89e7b
SM
3776 ;; 1+6+2+1+1+6=17 extra () before this:
3777 "\\$\\(['{]\\)" ; $' or ${foo}
83261a2f 3778 "\\|"
4ab89e7b
SM
3779 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3780 ;; we do not support intervening comments...):
83261a2f 3781 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
4ab89e7b 3782 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
83261a2f 3783 "\\|"
4ab89e7b
SM
3784 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3785 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
db133cb6 3786 "\\|"
4ab89e7b 3787 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
83261a2f 3788 ""))))
f83d2997
KH
3789 (unwind-protect
3790 (progn
3791 (save-excursion
3792 (or non-inter
3793 (message "Scanning for \"hard\" Perl constructions..."))
4ab89e7b 3794 ;;(message "find: %s --> %s" min max)
db133cb6 3795 (and cperl-pod-here-fontify
83261a2f
SM
3796 ;; We had evals here, do not know why...
3797 (setq face cperl-pod-face
3798 head-face cperl-pod-head-face
3799 here-face cperl-here-face))
5c8b7eaf 3800 (remove-text-properties min max
5bd52f0e 3801 '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3802 attrib-group t
3803 REx-interpolated t
6c389151
SM
3804 cperl-postpone t
3805 syntax-subtype t
3806 rear-nonsticky t
4ab89e7b 3807 front-sticky t
f739b53b
SM
3808 here-doc-group t
3809 first-format-line t
4ab89e7b 3810 REx-part2 t
6c389151 3811 indentable t))
f83d2997
KH
3812 ;; Need to remove face as well...
3813 (goto-char min)
72bc50c0
GM
3814 ;; 'emx not supported by Emacs since at least 21.1.
3815 (and (featurep 'xemacs) (eq system-type 'emx)
4ab89e7b
SM
3816 (eq (point) 1)
3817 (let ((case-fold-search t))
3818 (looking-at "extproc[ \t]")) ; Analogue of #!
5c8b7eaf 3819 (cperl-commentify min
e180ab9f 3820 (point-at-eol)
db133cb6
RS
3821 nil))
3822 (while (and
3823 (< (point) max)
3824 (re-search-forward search max t))
5bd52f0e 3825 (setq tmpend nil) ; Valid for most cases
4ab89e7b
SM
3826 (setq b (match-beginning 0)
3827 state (save-excursion (parse-partial-sexp
3828 state-point b nil nil state))
3829 state-point b)
5c8b7eaf 3830 (cond
4ab89e7b
SM
3831 ;; 1+6+2+1+1+6=17 extra () before this:
3832 ;; "\\$\\(['{]\\)"
3833 ((match-beginning 18) ; $' or ${foo}
3834 (if (eq (preceding-char) ?\') ; $'
3835 (progn
3836 (setq b (1- (point))
3837 state (parse-partial-sexp
3838 state-point (1- b) nil nil state)
3839 state-point (1- b))
3840 (if (nth 3 state) ; in string
3841 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3842 (goto-char (1+ b)))
3843 ;; else: ${
3844 (setq bb (match-beginning 0))
3845 (cperl-modify-syntax-type bb cperl-st-punct)))
3846 ;; No processing in strings/comments beyond this point:
3847 ((or (nth 3 state) (nth 4 state))
3848 t) ; Do nothing in comment/string
f83d2997 3849 ((match-beginning 1) ; POD section
a1506d29 3850 ;; "\\(\\`\n?\\|^\n\\)="
4ab89e7b
SM
3851 (setq b (match-beginning 0)
3852 state (parse-partial-sexp
3853 state-point b nil nil state)
3854 state-point b)
3855 (if (or (nth 3 state) (nth 4 state)
3856 (looking-at "cut\\>"))
3857 (if (or (nth 3 state) (nth 4 state) ignore-max)
5bd52f0e 3858 nil ; Doing a chunk only
f83d2997
KH
3859 (message "=cut is not preceded by a POD section")
3860 (or (car err-l) (setcar err-l (point))))
3861 (beginning-of-line)
5c8b7eaf
SS
3862
3863 (setq b (point)
5bd52f0e
RS
3864 bb b
3865 tb (match-beginning 0)
3866 b1 nil) ; error condition
db133cb6
RS
3867 ;; We do not search to max, since we may be called from
3868 ;; some hook of fontification, and max is random
6c389151 3869 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
f83d2997 3870 (progn
6c389151
SM
3871 (goto-char b)
3872 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3873 (progn
3874 (message "=cut is not preceded by an empty line")
3875 (setq b1 t)
3876 (or (car err-l) (setcar err-l b))))))
f83d2997
KH
3877 (beginning-of-line 2) ; An empty line after =cut is not POD!
3878 (setq e (point))
db133cb6 3879 (and (> e max)
6c389151 3880 (progn
a1506d29 3881 (remove-text-properties
6c389151 3882 max e '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3883 attrib-group t
3884 REx-interpolated t
6c389151
SM
3885 cperl-postpone t
3886 syntax-subtype t
f739b53b 3887 here-doc-group t
6c389151 3888 rear-nonsticky t
4ab89e7b 3889 front-sticky t
f739b53b 3890 first-format-line t
4ab89e7b 3891 REx-part2 t
6c389151
SM
3892 indentable t))
3893 (setq tmpend tb)))
f83d2997 3894 (put-text-property b e 'in-pod t)
6c389151 3895 (put-text-property b e 'syntax-type 'in-pod)
f83d2997
KH
3896 (goto-char b)
3897 (while (re-search-forward "\n\n[ \t]" e t)
3898 ;; We start 'pod 1 char earlier to include the preceding line
3899 (beginning-of-line)
3900 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5efe6a56
SM
3901 (cperl-put-do-not-fontify b (point) t)
3902 ;; mark the non-literal parts as PODs
a1506d29 3903 (if cperl-pod-here-fontify
5efe6a56 3904 (cperl-postpone-fontification b (point) 'face face t))
f83d2997
KH
3905 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3906 (beginning-of-line)
3907 (setq b (point)))
3908 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5efe6a56 3909 (cperl-put-do-not-fontify (point) e t)
a1506d29
JB
3910 (if cperl-pod-here-fontify
3911 (progn
5efe6a56
SM
3912 ;; mark the non-literal parts as PODs
3913 (cperl-postpone-fontification (point) e 'face face t)
3914 (goto-char bb)
a1506d29 3915 (if (looking-at
5efe6a56
SM
3916 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3917 ;; mark the headers
a1506d29 3918 (cperl-postpone-fontification
5efe6a56 3919 (match-beginning 1) (match-end 1)
6c389151
SM
3920 'face head-face))
3921 (while (re-search-forward
3922 ;; One paragraph
3923 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3924 e 'toend)
3925 ;; mark the headers
a1506d29 3926 (cperl-postpone-fontification
5efe6a56
SM
3927 (match-beginning 1) (match-end 1)
3928 'face head-face))))
f83d2997
KH
3929 (cperl-commentify bb e nil)
3930 (goto-char e)
3931 (or (eq e (point-max))
83261a2f 3932 (forward-char -1)))) ; Prepare for immediate POD start.
f83d2997 3933 ;; Here document
4ab89e7b
SM
3934 ;; We can do many here-per-line;
3935 ;; but multiline quote on the same line as <<HERE confuses us...
5bd52f0e 3936 ;; ;; One extra () before this:
5c8b7eaf 3937 ;;"<<"
5bd52f0e
RS
3938 ;; "\\(" ; 1 + 1
3939 ;; ;; First variant "BLAH" or just ``.
f739b53b 3940 ;; "[ \t]*" ; Yes, whitespace is allowed!
5bd52f0e
RS
3941 ;; "\\([\"'`]\\)" ; 2 + 1
3942 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3943 ;; "\\3"
3944 ;; "\\|"
3945 ;; ;; Second variant: Identifier or \ID or empty
3946 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3947 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3948 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3949 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3950 ;; "\\)"
f83d2997 3951 ((match-beginning 2) ; 1 + 1
4ab89e7b 3952 (setq b (point)
5bd52f0e 3953 tb (match-beginning 0)
4ab89e7b
SM
3954 c (and ; not HERE-DOC
3955 (match-beginning 5)
3956 (save-match-data
3957 (or (looking-at "[ \t]*(") ; << function_call()
3958 (save-excursion ; 1 << func_name, or $foo << 10
3959 (condition-case nil
3960 (progn
3961 (goto-char tb)
3962 ;;; XXX What to do: foo <<bar ???
3963 ;;; XXX Need to support print {a} <<B ???
3964 (forward-sexp -1)
cb5bf6ba 3965 (save-match-data
4ab89e7b
SM
3966 ; $foo << b; $f .= <<B;
3967 ; ($f+1) << b; a($f) . <<B;
3968 ; foo 1, <<B; $x{a} <<b;
3969 (cond
3970 ((looking-at "[0-9$({]")
3971 (forward-sexp 1)
3972 (and
3973 (looking-at "[ \t]*<<")
3974 (condition-case nil
3975 ;; print $foo <<EOF
3976 (progn
3977 (forward-sexp -2)
3978 (not
3979 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
3980 (error t)))))))
3981 (error nil))) ; func(<<EOF)
3982 (and (not (match-beginning 6)) ; Empty
3983 (looking-at
3984 "[ \t]*[=0-9$@%&(]"))))))
5bd52f0e
RS
3985 (if c ; Not here-doc
3986 nil ; Skip it.
4ab89e7b 3987 (setq c (match-end 2)) ; 1 + 1
f83d2997
KH
3988 (if (match-beginning 5) ;4 + 1
3989 (setq b1 (match-beginning 5) ; 4 + 1
3990 e1 (match-end 5)) ; 4 + 1
3991 (setq b1 (match-beginning 4) ; 3 + 1
3992 e1 (match-end 4))) ; 3 + 1
3993 (setq tag (buffer-substring b1 e1)
3994 qtag (regexp-quote tag))
5c8b7eaf 3995 (cond (cperl-pod-here-fontify
5bd52f0e 3996 ;; Highlight the starting delimiter
cb5bf6ba 3997 (cperl-postpone-fontification
4ab89e7b 3998 b1 e1 'face my-cperl-delimiters-face)
5bd52f0e 3999 (cperl-put-do-not-fontify b1 e1 t)))
f83d2997 4000 (forward-line)
4ab89e7b
SM
4001 (setq i (point))
4002 (if end-of-here-doc
4003 (goto-char end-of-here-doc))
f83d2997 4004 (setq b (point))
db133cb6
RS
4005 ;; We do not search to max, since we may be called from
4006 ;; some hook of fontification, and max is random
f739b53b
SM
4007 (or (and (re-search-forward (concat "^" qtag "$")
4008 stop-point 'toend)
4ab89e7b
SM
4009 ;;;(eq (following-char) ?\n) ; XXXX WHY???
4010 )
f739b53b
SM
4011 (progn ; Pretend we matched at the end
4012 (goto-char (point-max))
4013 (re-search-forward "\\'")
4014 (message "End of here-document `%s' not found." tag)
4015 (or (car err-l) (setcar err-l b))))
4016 (if cperl-pod-here-fontify
4017 (progn
4018 ;; Highlight the ending delimiter
4ab89e7b
SM
4019 (cperl-postpone-fontification
4020 (match-beginning 0) (match-end 0)
4021 'face my-cperl-delimiters-face)
f739b53b
SM
4022 (cperl-put-do-not-fontify b (match-end 0) t)
4023 ;; Highlight the HERE-DOC
4024 (cperl-postpone-fontification b (match-beginning 0)
4025 'face here-face)))
4026 (setq e1 (cperl-1+ (match-end 0)))
4027 (put-text-property b (match-beginning 0)
4028 'syntax-type 'here-doc)
4029 (put-text-property (match-beginning 0) e1
4030 'syntax-type 'here-doc-delim)
4ab89e7b
SM
4031 (put-text-property b e1 'here-doc-group t)
4032 ;; This makes insertion at the start of HERE-DOC update
4033 ;; the whole construct:
4034 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
f739b53b
SM
4035 (cperl-commentify b e1 nil)
4036 (cperl-put-do-not-fontify b (match-end 0) t)
4ab89e7b
SM
4037 ;; Cache the syntax info...
4038 (setq cperl-syntax-state (cons state-point state))
4039 ;; ... and process the rest of the line...
4040 (setq overshoot
4041 (elt ; non-inter ignore-max
4042 (cperl-find-pods-heres c i t end t e1) 1))
4043 (if (and overshoot (> overshoot (point)))
4044 (goto-char overshoot)
4045 (setq overshoot e1))
f739b53b
SM
4046 (if (> e1 max)
4047 (setq tmpend tb))))
f83d2997
KH
4048 ;; format
4049 ((match-beginning 8)
4050 ;; 1+6=7 extra () before this:
4051 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4052 (setq b (point)
4053 name (if (match-beginning 8) ; 7 + 1
4054 (buffer-substring (match-beginning 8) ; 7 + 1
4055 (match-end 8)) ; 7 + 1
5bd52f0e
RS
4056 "")
4057 tb (match-beginning 0))
f83d2997 4058 (setq argument nil)
9b026d9f 4059 (put-text-property (point-at-bol) b 'first-format-line 't)
5c8b7eaf 4060 (if cperl-pod-here-fontify
f83d2997
KH
4061 (while (and (eq (forward-line) 0)
4062 (not (looking-at "^[.;]$")))
4063 (cond
4064 ((looking-at "^#")) ; Skip comments
4065 ((and argument ; Skip argument multi-lines
5c8b7eaf 4066 (looking-at "^[ \t]*{"))
f83d2997
KH
4067 (forward-sexp 1)
4068 (setq argument nil))
4069 (argument ; Skip argument lines
4070 (setq argument nil))
4071 (t ; Format line
4072 (setq b1 (point))
4073 (setq argument (looking-at "^[^\n]*[@^]"))
4074 (end-of-line)
5bd52f0e 4075 ;; Highlight the format line
5c8b7eaf 4076 (cperl-postpone-fontification b1 (point)
83261a2f 4077 'face font-lock-string-face)
f83d2997 4078 (cperl-commentify b1 (point) nil)
5bd52f0e 4079 (cperl-put-do-not-fontify b1 (point) t))))
db133cb6
RS
4080 ;; We do not search to max, since we may be called from
4081 ;; some hook of fontification, and max is random
4082 (re-search-forward "^[.;]$" stop-point 'toend))
f83d2997 4083 (beginning-of-line)
83261a2f 4084 (if (looking-at "^\\.$") ; ";" is not supported yet
f83d2997 4085 (progn
5bd52f0e
RS
4086 ;; Highlight the ending delimiter
4087 (cperl-postpone-fontification (point) (+ (point) 2)
83261a2f 4088 'face font-lock-string-face)
f83d2997 4089 (cperl-commentify (point) (+ (point) 2) nil)
5bd52f0e 4090 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
f83d2997
KH
4091 (message "End of format `%s' not found." name)
4092 (or (car err-l) (setcar err-l b)))
4093 (forward-line)
5bd52f0e
RS
4094 (if (> (point) max)
4095 (setq tmpend tb))
db133cb6 4096 (put-text-property b (point) 'syntax-type 'format))
4ab89e7b 4097 ;; qq-like String or Regexp:
f83d2997
KH
4098 ((or (match-beginning 10) (match-beginning 11))
4099 ;; 1+6+2=9 extra () before this:
5bd52f0e 4100 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
f83d2997 4101 ;; "\\|"
5bd52f0e 4102 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
f83d2997
KH
4103 (setq b1 (if (match-beginning 10) 10 11)
4104 argument (buffer-substring
4105 (match-beginning b1) (match-end b1))
4ab89e7b 4106 b (point) ; end of qq etc
f83d2997
KH
4107 i b
4108 c (char-after (match-beginning b1))
4ab89e7b 4109 bb (char-after (1- (match-beginning b1))) ; tmp holder
5bd52f0e
RS
4110 ;; bb == "Not a stringy"
4111 bb (if (eq b1 10) ; user variables/whatever
f739b53b
SM
4112 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4113 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4114 ((eq bb ?\:) ; $opt::s
4115 (eq (char-after
4116 (- (match-beginning b1) 2))
4117 ?\:))
4118 ((eq bb ?\>) ; $foo->s
4119 (eq (char-after
4120 (- (match-beginning b1) 2))
4121 ?\-))
4122 ((eq bb ?\&)
4ab89e7b 4123 (not (eq (char-after ; &&m/blah/
f739b53b
SM
4124 (- (match-beginning b1) 2))
4125 ?\&)))
4126 (t t)))
5bd52f0e
RS
4127 ;; <file> or <$file>
4128 (and (eq c ?\<)
6c389151 4129 ;; Do not stringify <FH>, <$fh> :
5bd52f0e 4130 (save-match-data
5c8b7eaf 4131 (looking-at
6c389151 4132 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
5bd52f0e 4133 tb (match-beginning 0))
db133cb6
RS
4134 (goto-char (match-beginning b1))
4135 (cperl-backward-to-noncomment (point-min))
f83d2997 4136 (or bb
5bd52f0e 4137 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
f83d2997 4138 (setq argument ""
f739b53b 4139 b1 nil
db133cb6 4140 bb ; Not a regexp?
4ab89e7b
SM
4141 (not
4142 ;; What is below: regexp-p?
4143 (and
4144 (or (memq (preceding-char)
4145 (append (if (memq c '(?\? ?\<))
4146 ;; $a++ ? 1 : 2
4147 "~{(=|&*!,;:["
4148 "~{(=|&+-*!,;:[") nil))
4149 (and (eq (preceding-char) ?\})
4150 (cperl-after-block-p (point-min)))
4151 (and (eq (char-syntax (preceding-char)) ?w)
4152 (progn
4153 (forward-sexp -1)
6c389151
SM
4154;; After these keywords `/' starts a RE. One should add all the
4155;; functions/builtins which expect an argument, but ...
4ab89e7b
SM
4156 (if (eq (preceding-char) ?-)
4157 ;; -d ?foo? is a RE
4158 (looking-at "[a-zA-Z]\\>")
4159 (and
4160 (not (memq (preceding-char)
4161 '(?$ ?@ ?& ?%)))
4162 (looking-at
4163 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4164 (and (eq (preceding-char) ?.)
4165 (eq (char-after (- (point) 2)) ?.))
4166 (bobp))
4167 ;; m|blah| ? foo : bar;
4168 (not
4169 (and (eq c ?\?)
4170 cperl-use-syntax-table-text-property
4171 (not (bobp))
4172 (progn
4173 (forward-char -1)
4174 (looking-at "\\s|"))))))
db133cb6
RS
4175 b (1- b))
4176 ;; s y tr m
f739b53b
SM
4177 ;; Check for $a -> y
4178 (setq b1 (preceding-char)
4179 go (point))
4180 (if (and (eq b1 ?>)
4181 (eq (char-after (- go 2)) ?-))
db133cb6
RS
4182 ;; Not a regexp
4183 (setq bb t))))
f739b53b
SM
4184 (or bb
4185 (progn
4ab89e7b 4186 (goto-char b)
f739b53b
SM
4187 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4188 (goto-char (match-end 0))
4189 (skip-chars-forward " \t\n\f"))
4190 (cond ((and (eq (following-char) ?\})
4191 (eq b1 ?\{))
4192 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4193 (goto-char (1- go))
4194 (skip-chars-backward " \t\n\f")
4195 (if (memq (preceding-char) (append "$@%&*" nil))
4196 (setq bb t) ; @{y}
4197 (condition-case nil
4198 (forward-sexp -1)
4199 (error nil)))
4200 (if (or bb
4201 (looking-at ; $foo -> {s}
4202 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4203 (and ; $foo[12] -> {s}
4204 (memq (following-char) '(?\{ ?\[))
4205 (progn
4206 (forward-sexp 1)
4207 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4208 (setq bb t)
4209 (goto-char b)))
4210 ((and (eq (following-char) ?=)
4211 (eq (char-after (1+ (point))) ?\>))
4212 ;; Check for { foo => 1, s => 2 }
4213 ;; Apparently s=> is never a substitution...
4214 (setq bb t))
4215 ((and (eq (following-char) ?:)
4216 (eq b1 ?\{) ; Check for $ { s::bar }
4217 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
15ca5699 4218 (progn
f739b53b
SM
4219 (goto-char (1- go))
4220 (skip-chars-backward " \t\n\f")
4221 (memq (preceding-char)
4222 (append "$@%&*" nil))))
4ab89e7b
SM
4223 (setq bb t))
4224 ((eobp)
f739b53b
SM
4225 (setq bb t)))))
4226 (if bb
f83d2997 4227 (goto-char i)
6c389151 4228 ;; Skip whitespace and comments...
f83d2997
KH
4229 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4230 (goto-char (match-end 0))
4231 (skip-chars-forward " \t\n\f"))
6c389151
SM
4232 (if (> (point) b)
4233 (put-text-property b (point) 'syntax-type 'prestring))
f83d2997
KH
4234 ;; qtag means two-arg matcher, may be reset to
4235 ;; 2 or 3 later if some special quoting is needed.
4236 ;; e1 means matching-char matcher.
4ab89e7b 4237 (setq b (point) ; before the first delimiter
5bd52f0e
RS
4238 ;; has 2 args
4239 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
db133cb6
RS
4240 ;; We do not search to max, since we may be called from
4241 ;; some hook of fontification, and max is random
4242 i (cperl-forward-re stop-point end
5bd52f0e 4243 i2
4ab89e7b
SM
4244 st-l err-l argument)
4245 ;; If `go', then it is considered as 1-arg, `b1' is nil
4246 ;; as in s/foo//x; the point is before final "slash"
5bd52f0e 4247 b1 (nth 1 i) ; start of the second part
5c8b7eaf 4248 tag (nth 2 i) ; ender-char, true if second part
5bd52f0e 4249 ; is with matching chars []
f83d2997
KH
4250 go (nth 4 i) ; There is a 1-char part after the end
4251 i (car i) ; intermediate point
5c8b7eaf 4252 e1 (point) ; end
5bd52f0e 4253 ;; Before end of the second part if non-matching: ///
5c8b7eaf 4254 tail (if (and i (not tag))
5bd52f0e
RS
4255 (1- e1))
4256 e (if i i e1) ; end of the first part
6c389151 4257 qtag nil ; need to preserve backslashitis
4ab89e7b
SM
4258 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4259 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
f83d2997
KH
4260 ;; Commenting \\ is dangerous, what about ( ?
4261 (and i tail
4262 (eq (char-after i) ?\\)
5bd52f0e 4263 (setq qtag t))
4ab89e7b
SM
4264 (and (if go (looking-at ".\\sw*x")
4265 (looking-at "\\sw*x")) ; qr//x
4266 (setq is-x-REx t))
4267 (and (if go (looking-at ".\\sw*o")
4268 (looking-at "\\sw*o")) ; //o
4269 (setq is-o-REx t))
f83d2997 4270 (if (null i)
5bd52f0e 4271 ;; Considered as 1arg form
f83d2997
KH
4272 (progn
4273 (cperl-commentify b (point) t)
5bd52f0e 4274 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4275 (if (or is-x-REx
4276 ;; ignore other text properties:
4277 (string-match "^qw$" argument))
4278 (put-text-property b (point) 'indentable t))
5bd52f0e
RS
4279 (and go
4280 (setq e1 (cperl-1+ e1))
4281 (or (eobp)
4282 (forward-char 1))))
f83d2997
KH
4283 (cperl-commentify b i t)
4284 (if (looking-at "\\sw*e") ; s///e
4285 (progn
4ab89e7b
SM
4286 ;; Cache the syntax info...
4287 (setq cperl-syntax-state (cons state-point state))
f83d2997
KH
4288 (and
4289 ;; silent:
4ab89e7b 4290 (car (cperl-find-pods-heres b1 (1- (point)) t end))
f83d2997
KH
4291 ;; Error
4292 (goto-char (1+ max)))
5bd52f0e 4293 (if (and tag (eq (preceding-char) ?\>))
f83d2997
KH
4294 (progn
4295 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5bd52f0e 4296 (cperl-modify-syntax-type i cperl-st-bra)))
6c389151 4297 (put-text-property b i 'syntax-type 'string)
4ab89e7b 4298 (put-text-property i (point) 'syntax-type 'multiline)
6c389151
SM
4299 (if is-x-REx
4300 (put-text-property b i 'indentable t)))
5bd52f0e
RS
4301 (cperl-commentify b1 (point) t)
4302 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4303 (if is-x-REx
4304 (put-text-property b i 'indentable t))
5bd52f0e 4305 (if qtag
db133cb6 4306 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
f83d2997 4307 (setq tail nil)))
5bd52f0e 4308 ;; Now: tail: if the second part is non-matching without ///e
f83d2997
KH
4309 (if (eq (char-syntax (following-char)) ?w)
4310 (progn
4311 (forward-word 1) ; skip modifiers s///s
5bd52f0e 4312 (if tail (cperl-commentify tail (point) t))
a1506d29 4313 (cperl-postpone-fontification
4ab89e7b 4314 e1 (point) 'face my-cperl-REx-modifiers-face)))
5bd52f0e
RS
4315 ;; Check whether it is m// which means "previous match"
4316 ;; and highlight differently
a1506d29 4317 (setq is-REx
6c389151
SM
4318 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4319 (or (not (= (length argument) 0))
4320 (not (eq c ?\<)))))
a1506d29 4321 (if (and is-REx
6c389151 4322 (eq e (+ 2 b))
5bd52f0e
RS
4323 ;; split // *is* using zero-pattern
4324 (save-excursion
4325 (condition-case nil
4326 (progn
4327 (goto-char tb)
4328 (forward-sexp -1)
4329 (not (looking-at "split\\>")))
4330 (error t))))
5c8b7eaf 4331 (cperl-postpone-fontification
4ab89e7b 4332 b e 'face font-lock-warning-face)
5bd52f0e
RS
4333 (if (or i2 ; Has 2 args
4334 (and cperl-fontify-m-as-s
4335 (or
4336 (string-match "^\\(m\\|qr\\)$" argument)
4337 (and (eq 0 (length argument))
4338 (not (eq ?\< (char-after b)))))))
4339 (progn
5c8b7eaf 4340 (cperl-postpone-fontification
4ab89e7b 4341 b (cperl-1+ b) 'face my-cperl-delimiters-face)
5c8b7eaf 4342 (cperl-postpone-fontification
4ab89e7b 4343 (1- e) e 'face my-cperl-delimiters-face)))
6c389151 4344 (if (and is-REx cperl-regexp-scan)
4ab89e7b
SM
4345 ;; Process RExen: embedded comments, charclasses and ]
4346;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4347;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4348;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4349;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4350;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4351;;;m^a[\^b]c^ + m.a[^b]\.c.;
6c389151
SM
4352 (save-excursion
4353 (goto-char (1+ b))
cb5bf6ba 4354 ;; First
4ab89e7b
SM
4355 (cperl-look-at-leading-count is-x-REx e)
4356 (setq hairy-RE
4357 (concat
4358 (if is-x-REx
4359 (if (eq (char-after b) ?\#)
4360 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4361 "\\((\\?#\\)\\|\\(#\\)")
4362 ;; keep the same count: add a fake group
4363 (if (eq (char-after b) ?\#)
4364 "\\((\\?\\\\#\\)\\(\\)"
4365 "\\((\\?#\\)\\(\\)"))
4366 "\\|"
4367 "\\(\\[\\)" ; 3=[
4368 "\\|"
4369 "\\(]\\)" ; 4=]
4370 "\\|"
4371 ;; XXXX Will not be able to use it in s)))
4372 (if (eq (char-after b) ?\) )
4373 "\\())))\\)" ; Will never match
4374 (if (eq (char-after b) ?? )
4375 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4376 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4377 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4378 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4379 "\\(" ;; XXXX 1-char variables, exc. |()\s
4380 "[$@]"
4381 "\\("
4382 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4383 "\\|"
4384 "{[^{}]*}" ; only one-level allowed
4385 "\\|"
4386 "[^{(|) \t\r\n\f]"
4387 "\\)"
4388 "\\(" ;;8,9:code part of array/hash elt
4389 "\\(" "->" "\\)?"
4390 "\\[[^][]*\\]"
4391 "\\|"
4392 "{[^{}]*}"
4393 "\\)*"
4394 ;; XXXX: what if u is delim?
4395 "\\|"
4396 "[)^|$.*?+]"
4397 "\\|"
4398 "{[0-9]+}"
4399 "\\|"
4400 "{[0-9]+,[0-9]*}"
4401 "\\|"
4402 "\\\\[luLUEQbBAzZG]"
4403 "\\|"
4404 "(" ; Group opener
4405 "\\(" ; 10 group opener follower
4406 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4407 "\\|"
4408 "\\?[:=!>?{]" ; "?" something
4409 "\\|"
4410 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4411 "\\|"
4412 "\\?([0-9]+)" ; (?(1)foo|bar)
4413 "\\|"
4414 "\\?<[=!]"
4415 ;;;"\\|"
4416 ;;; "\\?"
4417 "\\)?"
4418 "\\)"
4419 "\\|"
4420 "\\\\\\(.\\)" ; 12=\SYMBOL
4421 ))
6c389151 4422 (while
4ab89e7b
SM
4423 (and (< (point) (1- e))
4424 (re-search-forward hairy-RE (1- e) 'to-end))
6c389151 4425 (goto-char (match-beginning 0))
4ab89e7b
SM
4426 (setq REx-subgr-start (point)
4427 was-subgr (following-char))
4428 (cond
4429 ((match-beginning 6) ; 0-length builtins, groups
4430 (goto-char (match-end 0))
4431 (if (match-beginning 11)
4432 (goto-char (match-beginning 11)))
4433 (if (>= (point) e)
4434 (goto-char (1- e)))
4435 (cperl-postpone-fontification
4436 (match-beginning 0) (point)
4437 'face
4438 (cond
4439 ((eq was-subgr ?\) )
4440 (condition-case nil
4441 (save-excursion
4442 (forward-sexp -1)
4443 (if (> (point) b)
4444 (if (if (eq (char-after b) ?? )
4445 (looking-at "(\\\\\\?")
4446 (eq (char-after (1+ (point))) ?\?))
4447 my-cperl-REx-0length-face
4448 my-cperl-REx-ctl-face)
4449 font-lock-warning-face))
4450 (error font-lock-warning-face)))
4451 ((eq was-subgr ?\| )
4452 my-cperl-REx-ctl-face)
4453 ((eq was-subgr ?\$ )
4454 (if (> (point) (1+ REx-subgr-start))
4455 (progn
4456 (put-text-property
4457 (match-beginning 0) (point)
4458 'REx-interpolated
4459 (if is-o-REx 0
4460 (if (and (eq (match-beginning 0)
4461 (1+ b))
4462 (eq (point)
4463 (1- e))) 1 t)))
4464 font-lock-variable-name-face)
4465 my-cperl-REx-spec-char-face))
4466 ((memq was-subgr (append "^." nil) )
4467 my-cperl-REx-spec-char-face)
4468 ((eq was-subgr ?\( )
4469 (if (not (match-beginning 10))
4470 my-cperl-REx-ctl-face
4471 my-cperl-REx-0length-face))
4472 (t my-cperl-REx-0length-face)))
4473 (if (and (memq was-subgr (append "(|" nil))
4474 (not (string-match "(\\?[-imsx]+)"
4475 (match-string 0))))
4476 (cperl-look-at-leading-count is-x-REx e))
4477 (setq was-subgr nil)) ; We do stuff here
4478 ((match-beginning 12) ; \SYMBOL
4479 (forward-char 2)
4480 (if (>= (point) e)
4481 (goto-char (1- e))
4482 ;; How many chars to not highlight:
4483 ;; 0-len special-alnums in other branch =>
4484 ;; Generic: \non-alnum (1), \alnum (1+face)
4485 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4486 (setq REx-subgr-start (point)
4487 qtag (preceding-char))
4488 (cperl-postpone-fontification
4489 (- (point) 2) (- (point) 1) 'face
4490 (if (memq qtag
4491 (append "ghijkmoqvFHIJKMORTVY" nil))
4492 font-lock-warning-face
4493 my-cperl-REx-0length-face))
4494 (if (and (eq (char-after b) qtag)
4495 (memq qtag (append ".])^$|*?+" nil)))
4496 (progn
4497 (if (and cperl-use-syntax-table-text-property
4498 (eq qtag ?\) ))
4499 (put-text-property
4500 REx-subgr-start (1- (point))
4501 'syntax-table cperl-st-punct))
4502 (cperl-postpone-fontification
4503 (1- (point)) (point) 'face
4504 ; \] can't appear below
4505 (if (memq qtag (append ".]^$" nil))
4506 'my-cperl-REx-spec-char-face
4507 (if (memq qtag (append "*?+" nil))
4508 'my-cperl-REx-0length-face
4509 'my-cperl-REx-ctl-face))))) ; )|
4510 ;; Test for arguments:
4511 (cond
4512 ;; This is not pretty: the 5.8.7 logic:
4513 ;; \0numx -> octal (up to total 3 dig)
4514 ;; \DIGIT -> backref unless \0
cb5bf6ba 4515 ;; \DIGITs -> backref if valid
4ab89e7b
SM
4516 ;; otherwise up to 3 -> octal
4517 ;; Do not try to distinguish, we guess
4518 ((or (and (memq qtag (append "01234567" nil))
4519 (re-search-forward
4520 "\\=[01234567]?[01234567]?"
4521 (1- e) 'to-end))
4522 (and (memq qtag (append "89" nil))
cb5bf6ba 4523 (re-search-forward
4ab89e7b
SM
4524 "\\=[0123456789]*" (1- e) 'to-end))
4525 (and (eq qtag ?x)
4526 (re-search-forward
4527 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4528 (1- e) 'to-end))
4529 (and (memq qtag (append "pPN" nil))
4530 (re-search-forward "\\={[^{}]+}\\|."
4531 (1- e) 'to-end))
4532 (eq (char-syntax qtag) ?w))
4533 (cperl-postpone-fontification
4534 (1- REx-subgr-start) (point)
4535 'face my-cperl-REx-length1-face))))
4536 (setq was-subgr nil)) ; We do stuff here
4537 ((match-beginning 3) ; [charclass]
8c777c8d 4538 ;; Highlight leader, trailer, POSIX classes
4ab89e7b
SM
4539 (forward-char 1)
4540 (if (eq (char-after b) ?^ )
4541 (and (eq (following-char) ?\\ )
4542 (eq (char-after (cperl-1+ (point)))
4543 ?^ )
4544 (forward-char 2))
4545 (and (eq (following-char) ?^ )
4546 (forward-char 1)))
8c777c8d 4547 (setq argument b ; continue? & end of last POSIX
4ab89e7b 4548 tag nil ; list of POSIX classes
8c777c8d 4549 qtag (point)) ; after leading ^ if present
4ab89e7b
SM
4550 (if (eq (char-after b) ?\] )
4551 (and (eq (following-char) ?\\ )
4552 (eq (char-after (cperl-1+ (point)))
4553 ?\] )
4554 (setq qtag (1+ qtag))
4555 (forward-char 2))
4556 (and (eq (following-char) ?\] )
4557 (forward-char 1)))
3ed8598c 4558 (setq REx-subgr-end qtag) ;End smart-highlighted
4ab89e7b
SM
4559 ;; Apparently, I can't put \] into a charclass
4560 ;; in m]]: m][\\\]\]] produces [\\]]
4561;;; POSIX? [:word:] [:^word:] only inside []
8c777c8d
CY
4562;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4563 (while ; look for unescaped ]
4ab89e7b
SM
4564 (and argument
4565 (re-search-forward
4566 (if (eq (char-after b) ?\] )
4567 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4568 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4569 (1- e) 'toend))
4570 ;; Is this ] an end of POSIX class?
4571 (if (save-excursion
4572 (and
4573 (search-backward "[" argument t)
4574 (< REx-subgr-start (point))
8c777c8d
CY
4575 (setq argument (point)) ; POSIX-start
4576 (or ; Should work with delim = \
4577 (not (eq (preceding-char) ?\\ ))
4578 ;; XXXX Double \\ is needed with 19.33
4579 (= (% (skip-chars-backward "\\\\") 2) 0))
4ab89e7b
SM
4580 (looking-at
4581 (cond
4582 ((eq (char-after b) ?\] )
4583 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4584 ((eq (char-after b) ?\: )
4585 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4586 ((eq (char-after b) ?^ )
4587 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
4588 ((eq (char-syntax (char-after b))
4589 ?w)
4590 (concat
4591 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4592 (char-to-string (char-after b))
4593 "\\|\\sw\\)+:\]"))
4594 (t "\\\\*\\[:\\^?\\sw*:]")))
8c777c8d
CY
4595 (goto-char REx-subgr-end)
4596 (cperl-highlight-charclass
4597 argument my-cperl-REx-spec-char-face
4598 my-cperl-REx-0length-face my-cperl-REx-length1-face)))
4ab89e7b
SM
4599 (setq tag (cons (cons argument (point))
4600 tag)
8c777c8d
CY
4601 argument (point)
4602 REx-subgr-end argument) ; continue
4ab89e7b
SM
4603 (setq argument nil)))
4604 (and argument
4605 (message "Couldn't find end of charclass in a REx, pos=%s"
4606 REx-subgr-start))
8c777c8d
CY
4607 (setq argument (1- (point)))
4608 (goto-char REx-subgr-end)
4609 (cperl-highlight-charclass
4610 argument my-cperl-REx-spec-char-face
4611 my-cperl-REx-0length-face my-cperl-REx-length1-face)
4612 (forward-char 1)
4613 ;; Highlight starter, trailer, POSIX
4ab89e7b
SM
4614 (if (and cperl-use-syntax-table-text-property
4615 (> (- (point) 2) REx-subgr-start))
4616 (put-text-property
4617 (1+ REx-subgr-start) (1- (point))
4618 'syntax-table cperl-st-punct))
4619 (cperl-postpone-fontification
4620 REx-subgr-start qtag
4621 'face my-cperl-REx-spec-char-face)
4622 (cperl-postpone-fontification
4623 (1- (point)) (point) 'face
4624 my-cperl-REx-spec-char-face)
4625 (if (eq (char-after b) ?\] )
4626 (cperl-postpone-fontification
4627 (- (point) 2) (1- (point))
4628 'face my-cperl-REx-0length-face))
4629 (while tag
4630 (cperl-postpone-fontification
4631 (car (car tag)) (cdr (car tag))
8c777c8d 4632 'face font-lock-variable-name-face) ;my-cperl-REx-length1-face
4ab89e7b
SM
4633 (setq tag (cdr tag)))
4634 (setq was-subgr nil)) ; did facing already
4635 ;; Now rare stuff:
4636 ((and (match-beginning 2) ; #-comment
4637 (/= (match-beginning 2) (match-end 2)))
4638 (beginning-of-line 2)
4639 (if (> (point) e)
4640 (goto-char (1- e))))
4641 ((match-beginning 4) ; character "]"
4642 (setq was-subgr nil) ; We do stuff here
4643 (goto-char (match-end 0))
4644 (if cperl-use-syntax-table-text-property
4645 (put-text-property
4646 (1- (point)) (point)
4647 'syntax-table cperl-st-punct))
4648 (cperl-postpone-fontification
4649 (1- (point)) (point)
4650 'face font-lock-warning-face))
4651 ((match-beginning 5) ; before (?{}) (??{})
4652 (setq tag (match-end 0))
4653 (if (or (setq qtag
4654 (cperl-forward-group-in-re st-l))
4655 (and (>= (point) e)
4656 (setq qtag "no matching `)' found"))
4657 (and (not (eq (char-after (- (point) 2))
4658 ?\} ))
4659 (setq qtag "Can't find })")))
a1506d29 4660 (progn
4ab89e7b 4661 (goto-char (1- e))
274f1353 4662 (message "%s" qtag))
4ab89e7b
SM
4663 (cperl-postpone-fontification
4664 (1- tag) (1- (point))
4665 'face font-lock-variable-name-face)
4666 (cperl-postpone-fontification
4667 REx-subgr-start (1- tag)
4668 'face my-cperl-REx-spec-char-face)
4669 (cperl-postpone-fontification
4670 (1- (point)) (point)
4671 'face my-cperl-REx-spec-char-face)
4672 (if cperl-use-syntax-table-text-property
4673 (progn
4674 (put-text-property
4675 (- (point) 2) (1- (point))
4676 'syntax-table cperl-st-cfence)
4677 (put-text-property
4678 (+ REx-subgr-start 2)
4679 (+ REx-subgr-start 3)
4680 'syntax-table cperl-st-cfence))))
4681 (setq was-subgr nil))
4682 (t ; (?#)-comment
4683 ;; Inside "(" and "\" arn't special in any way
4684 ;; Works also if the outside delimiters are ().
4685 (or;;(if (eq (char-after b) ?\) )
4686 ;;(re-search-forward
4687 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4688 ;; (1- e) 'toend)
4689 (search-forward ")" (1- e) 'toend)
4690 ;;)
4691 (message
4692 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4693 REx-subgr-start))))
6c389151
SM
4694 (if (>= (point) e)
4695 (goto-char (1- e)))
4ab89e7b
SM
4696 (cond
4697 (was-subgr
4698 (setq REx-subgr-end (point))
4699 (cperl-commentify
4700 REx-subgr-start REx-subgr-end nil)
4701 (cperl-postpone-fontification
4702 REx-subgr-start REx-subgr-end
4703 'face font-lock-comment-face))))))
6c389151 4704 (if (and is-REx is-x-REx)
a1506d29 4705 (put-text-property (1+ b) (1- e)
6c389151 4706 'syntax-subtype 'x-REx)))
8c777c8d 4707 (if (and i2 e1 (or (not b1) (> e1 b1)))
82d9a08d 4708 (progn ; No errors finding the second part...
5c8b7eaf 4709 (cperl-postpone-fontification
4ab89e7b 4710 (1- e1) e1 'face my-cperl-delimiters-face)
05927f8c
VJL
4711 (if (and (not (eobp))
4712 (assoc (char-after b) cperl-starters))
4ab89e7b
SM
4713 (progn
4714 (cperl-postpone-fontification
4715 b1 (1+ b1) 'face my-cperl-delimiters-face)
4716 (put-text-property b1 (1+ b1)
4717 'REx-part2 t)))))
5bd52f0e
RS
4718 (if (> (point) max)
4719 (setq tmpend tb))))
4ab89e7b
SM
4720 ((match-beginning 17) ; sub with prototype or attribute
4721 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4722 ;;"\\<sub\\>\\(" ;12
4723 ;; cperl-white-and-comment-rex ;13
4724 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4725 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4726 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4727 (setq b1 (match-beginning 14) e1 (match-end 14))
f83d2997
KH
4728 (if (memq (char-after (1- b))
4729 '(?\$ ?\@ ?\% ?\& ?\*))
4730 nil
4ab89e7b
SM
4731 (goto-char b)
4732 (if (eq (char-after (match-beginning 17)) ?\( )
4733 (progn
4734 (cperl-commentify ; Prototypes; mark as string
4735 (match-beginning 17) (match-end 17) t)
4736 (goto-char (match-end 0))
4737 ;; Now look for attributes after prototype:
4738 (forward-comment (buffer-size))
4739 (and (looking-at ":[^:]")
4740 (cperl-find-sub-attrs st-l b1 e1 b)))
4741 ;; treat attributes without prototype
4742 (goto-char (match-beginning 17))
4743 (cperl-find-sub-attrs st-l b1 e1 b))))
4744 ;; 1+6+2+1+1+6+1=18 extra () before this:
f83d2997 4745 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4ab89e7b
SM
4746 ((match-beginning 19) ; old $abc'efg syntax
4747 (setq bb (match-end 0))
4748 ;;;(if (nth 3 state) nil ; in string
4749 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
f83d2997 4750 (goto-char bb))
4ab89e7b 4751 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
f83d2997 4752 ;; "__\\(END\\|DATA\\)__"
4ab89e7b
SM
4753 ((match-beginning 20) ; __END__, __DATA__
4754 (setq bb (match-end 0))
4755 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4756 (cperl-commentify b bb nil)
4757 (setq end t))
4758 ;; "\\\\\\(['`\"($]\\)"
4759 ((match-beginning 21)
4760 ;; Trailing backslash; make non-quoting outside string/comment
4761 (setq bb (match-end 0))
6c389151
SM
4762 (goto-char b)
4763 (skip-chars-backward "\\\\")
4764 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4ab89e7b 4765 (cperl-modify-syntax-type b cperl-st-punct)
6c389151
SM
4766 (goto-char bb))
4767 (t (error "Error in regexp of the sniffer")))
db133cb6 4768 (if (> (point) stop-point)
f83d2997 4769 (progn
5c8b7eaf 4770 (if end
f83d2997
KH
4771 (message "Garbage after __END__/__DATA__ ignored")
4772 (message "Unbalanced syntax found while scanning")
4773 (or (car err-l) (setcar err-l b)))
db133cb6
RS
4774 (goto-char stop-point))))
4775 (setq cperl-syntax-state (cons state-point state)
4ab89e7b
SM
4776 ;; Do not mark syntax as done past tmpend???
4777 cperl-syntax-done-to (or tmpend (max (point) max)))
4778 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4779 )
f83d2997 4780 (if (car err-l) (goto-char (car err-l))
db133cb6
RS
4781 (or non-inter
4782 (message "Scanning for \"hard\" Perl constructions... done"))))
f83d2997
KH
4783 (and (buffer-modified-p)
4784 (not modified)
4785 (set-buffer-modified-p nil))
00424a9e
SM
4786 ;; I do not understand what this is doing here. It breaks font-locking
4787 ;; because it resets the syntax-table from font-lock-syntax-table to
4788 ;; cperl-mode-syntax-table.
4789 ;; (set-syntax-table cperl-mode-syntax-table)
4790 )
4ab89e7b
SM
4791 (list (car err-l) overshoot)))
4792
4793(defun cperl-find-pods-heres-region (min max)
4794 (interactive "r")
4795 (cperl-find-pods-heres min max))
f83d2997
KH
4796
4797(defun cperl-backward-to-noncomment (lim)
4798 ;; Stops at lim or after non-whitespace that is not in comment
4ab89e7b 4799 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
5bd52f0e 4800 (let (stop p pr)
4ab89e7b 4801 (while (and (not stop) (> (point) (or lim (point-min))))
f83d2997
KH
4802 (skip-chars-backward " \t\n\f" lim)
4803 (setq p (point))
4804 (beginning-of-line)
5bd52f0e
RS
4805 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4806 '(pod here-doc here-doc-delim))
82d9a08d
SM
4807 (progn
4808 (cperl-unwind-to-safe nil)
4809 (setq pr (get-text-property (point) 'syntax-type))))
4810 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4811 (not (memq pr '(string prestring))))
4812 (progn (cperl-to-comment-or-eol) (bolp))
4813 (progn
4814 (skip-chars-backward " \t")
4815 (if (< p (point)) (goto-char p))
4816 (setq stop t))))))
f83d2997 4817
4ab89e7b
SM
4818;; Used only in `cperl-calculate-indent'...
4819(defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4820 ;; Positions is before ?\{. Checks whether it starts a block.
4821 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4822 (cperl-backward-to-noncomment (point-min))
4823 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4824 ; Label may be mixed up with `$blah :'
4825 (save-excursion (cperl-after-label))
4826 (get-text-property (cperl-1- (point)) 'attrib-group)
4827 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4828 (progn
4829 (backward-sexp)
4830 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4831 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4832 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
4833 ;; sub bless::foo {}
4834 (progn
4835 (cperl-backward-to-noncomment (point-min))
4836 (and (eq (preceding-char) ?b)
4837 (progn
4838 (forward-sexp -1)
4839 (looking-at "sub[ \t\n\f#]")))))))))
4840
4841;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4842;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4843;;; may be a part of an in-statement construct, such as
4844;;; ${something()}, print {FH} $data.
4845;;; Moreover, one takes positive approach (looks for else,grep etc)
4846;;; another negative (looks for bless,tr etc)
f739b53b 4847(defun cperl-after-block-p (lim &optional pre-block)
97610156 4848 "Return true if the preceding } (if PRE-BLOCK, following {) delimits a block.
4ab89e7b
SM
4849Would not look before LIM. Assumes that LIM is a good place to begin a
4850statement. The kind of block we treat here is one after which a new
4851statement would start; thus the block in ${func()} does not count."
f83d2997
KH
4852 (save-excursion
4853 (condition-case nil
4854 (progn
f739b53b 4855 (or pre-block (forward-sexp -1))
f83d2997 4856 (cperl-backward-to-noncomment lim)
bab27c0c 4857 (or (eq (point) lim)
4ab89e7b
SM
4858 ;; if () {} // sub f () {} // sub f :a(') {}
4859 (eq (preceding-char) ?\) )
4860 ;; label: {}
4861 (save-excursion (cperl-after-label))
4862 ;; sub :attr {}
4863 (get-text-property (cperl-1- (point)) 'attrib-group)
4864 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
db133cb6
RS
4865 (save-excursion
4866 (forward-sexp -1)
4ab89e7b
SM
4867 ;; else {} but not else::func {}
4868 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4869 (not (looking-at "\\(\\sw\\|_\\)+::")))
db133cb6
RS
4870 ;; sub f {}
4871 (progn
4872 (cperl-backward-to-noncomment lim)
4ab89e7b 4873 (and (eq (preceding-char) ?b)
db133cb6
RS
4874 (progn
4875 (forward-sexp -1)
4ab89e7b 4876 (looking-at "sub[ \t\n\f#]"))))))
97610156 4877 ;; What precedes is not word... XXXX Last statement in sub???
db133cb6 4878 (cperl-after-expr-p lim))))
f83d2997
KH
4879 (error nil))))
4880
4881(defun cperl-after-expr-p (&optional lim chars test)
029cb4d5 4882 "Return true if the position is good for start of expression.
f83d2997
KH
4883TEST is the expression to evaluate at the found position. If absent,
4884CHARS is a string that contains good characters to have before us (however,
4885`}' is treated \"smartly\" if it is not in the list)."
83261a2f 4886 (let ((lim (or lim (point-min)))
f739b53b
SM
4887 stop p pr)
4888 (cperl-update-syntaxification (point) (point))
f83d2997
KH
4889 (save-excursion
4890 (while (and (not stop) (> (point) lim))
4891 (skip-chars-backward " \t\n\f" lim)
4892 (setq p (point))
4893 (beginning-of-line)
f739b53b
SM
4894 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4895 ;; '(pod here-doc here-doc-delim))
4896 (if (get-text-property (point) 'here-doc-group)
4897 (progn
4898 (goto-char
4ab89e7b 4899 (cperl-beginning-of-property (point) 'here-doc-group))
f739b53b
SM
4900 (beginning-of-line 0)))
4901 (if (get-text-property (point) 'in-pod)
4902 (progn
4903 (goto-char
4ab89e7b 4904 (cperl-beginning-of-property (point) 'in-pod))
f739b53b 4905 (beginning-of-line 0)))
f83d2997 4906 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
5bd52f0e 4907 ;; Else: last iteration, or a label
f739b53b 4908 (cperl-to-comment-or-eol) ; Will not move past "." after a format
f83d2997
KH
4909 (skip-chars-backward " \t")
4910 (if (< p (point)) (goto-char p))
5bd52f0e
RS
4911 (setq p (point))
4912 (if (and (eq (preceding-char) ?:)
4913 (progn
4914 (forward-char -1)
4915 (skip-chars-backward " \t\n\f" lim)
4ab89e7b 4916 (memq (char-syntax (preceding-char)) '(?w ?_))))
5bd52f0e
RS
4917 (forward-sexp -1) ; Possibly label. Skip it
4918 (goto-char p)
4919 (setq stop t))))
bab27c0c
RS
4920 (or (bobp) ; ???? Needed
4921 (eq (point) lim)
029cb4d5 4922 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
f83d2997
KH
4923 (progn
4924 (if test (eval test)
4925 (or (memq (preceding-char) (append (or chars "{;") nil))
4926 (and (eq (preceding-char) ?\})
f739b53b
SM
4927 (cperl-after-block-p lim))
4928 (and (eq (following-char) ?.) ; in format: see comment above
4929 (eq (get-text-property (point) 'syntax-type)
4930 'format)))))))))
f83d2997 4931
4ab89e7b
SM
4932(defun cperl-backward-to-start-of-expr (&optional lim)
4933 (condition-case nil
4934 (progn
4935 (while (and (or (not lim)
4936 (> (point) lim))
4937 (not (cperl-after-expr-p lim)))
4938 (forward-sexp -1)
4939 ;; May be after $, @, $# etc of a variable
4940 (skip-chars-backward "$@%#")))
4941 (error nil)))
4942
4943(defun cperl-at-end-of-expr (&optional lim)
4944 ;; Since the SEXP approach below is very fragile, do some overengineering
4945 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4946 (condition-case nil
4947 (save-excursion
4948 ;; If nothing interesting after, does as (forward-sexp -1);
4949 ;; otherwise fails, or ends at a start of following sexp.
4950 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4951 ;; may be stuck after @ or $; just put some stupid workaround now:
4952 (let ((p (point)))
4953 (forward-sexp 1)
4954 (forward-sexp -1)
4955 (while (memq (preceding-char) (append "%&@$*" nil))
4956 (forward-char -1))
4957 (or (< (point) p)
4958 (cperl-after-expr-p lim))))
4959 (error t))))
4960
4961(defun cperl-forward-to-end-of-expr (&optional lim)
4962 (let ((p (point))))
4963 (condition-case nil
4964 (progn
4965 (while (and (< (point) (or lim (point-max)))
4966 (not (cperl-at-end-of-expr)))
4967 (forward-sexp 1)))
4968 (error nil)))
4969
f83d2997
KH
4970(defun cperl-backward-to-start-of-continued-exp (lim)
4971 (if (memq (preceding-char) (append ")]}\"'`" nil))
4972 (forward-sexp -1))
4973 (beginning-of-line)
4974 (if (<= (point) lim)
4975 (goto-char (1+ lim)))
4976 (skip-chars-forward " \t"))
4977
db133cb6
RS
4978(defun cperl-after-block-and-statement-beg (lim)
4979 ;; We assume that we are after ?\}
5c8b7eaf 4980 (and
db133cb6
RS
4981 (cperl-after-block-p lim)
4982 (save-excursion
4983 (forward-sexp -1)
4984 (cperl-backward-to-noncomment (point-min))
4985 (or (bobp)
bab27c0c 4986 (eq (point) lim)
db133cb6
RS
4987 (not (= (char-syntax (preceding-char)) ?w))
4988 (progn
4989 (forward-sexp -1)
5c8b7eaf 4990 (not
db133cb6
RS
4991 (looking-at
4992 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
4993
f83d2997 4994\f
f83d2997
KH
4995(defun cperl-indent-exp ()
4996 "Simple variant of indentation of continued-sexp.
5bd52f0e
RS
4997
4998Will not indent comment if it starts at `comment-indent' or looks like
4999continuation of the comment on the previous line.
db133cb6 5000
5c8b7eaf 5001If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 5002conditional/loop constructs."
f83d2997
KH
5003 (interactive)
5004 (save-excursion
e180ab9f 5005 (let ((tmp-end (point-at-eol)) top done)
f83d2997
KH
5006 (save-excursion
5007 (beginning-of-line)
5008 (while (null done)
5009 (setq top (point))
4ab89e7b
SM
5010 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
5011 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
bbd240ce 5012 (setq top (point))) ; Get the outermost parens in line
f83d2997
KH
5013 (goto-char top)
5014 (while (< (point) tmp-end)
5015 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5016 (or (eolp) (forward-sexp 1)))
4ab89e7b
SM
5017 (if (> (point) tmp-end) ; Yes, there an unfinished block
5018 nil
5019 (if (eq ?\) (preceding-char))
5020 (progn ;; Plan B: find by REGEXP block followup this line
5021 (setq top (point))
5022 (condition-case nil
5023 (progn
5024 (forward-sexp -2)
5025 (if (eq (following-char) ?$ ) ; for my $var (list)
5026 (progn
5027 (forward-sexp -1)
5028 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5029 (forward-sexp -1))))
5030 (if (looking-at
5031 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5032 "\\|for\\(each\\)?\\>\\(\\("
5033 cperl-maybe-white-and-comment-rex
5034 "\\(my\\|local\\|our\\)\\)?"
5035 cperl-maybe-white-and-comment-rex
5036 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5037 (progn
5038 (goto-char top)
5039 (forward-sexp 1)
5040 (setq top (point)))))
5041 (error (setq done t)))
5042 (goto-char top))
5043 (if (looking-at ; Try Plan C: continuation block
5044 (concat cperl-maybe-white-and-comment-rex
5045 "\\<\\(else\\|elsif\|continue\\)\\>"))
5046 (progn
5047 (goto-char (match-end 0))
e180ab9f 5048 (setq tmp-end (point-at-eol)))
4ab89e7b 5049 (setq done t))))
e180ab9f 5050 (setq tmp-end (point-at-eol)))
f83d2997
KH
5051 (goto-char tmp-end)
5052 (setq tmp-end (point-marker)))
db133cb6
RS
5053 (if cperl-indent-region-fix-constructs
5054 (cperl-fix-line-spacing tmp-end))
f83d2997
KH
5055 (cperl-indent-region (point) tmp-end))))
5056
5bd52f0e
RS
5057(defun cperl-fix-line-spacing (&optional end parse-data)
5058 "Improve whitespace in a conditional/loop construct.
5059Returns some position at the last line."
db133cb6
RS
5060 (interactive)
5061 (or end
5062 (setq end (point-max)))
e180ab9f 5063 (let ((ee (point-at-eol))
83261a2f
SM
5064 (cperl-indent-region-fix-constructs
5065 (or cperl-indent-region-fix-constructs 1))
5066 p pp ml have-brace ret)
db133cb6
RS
5067 (save-excursion
5068 (beginning-of-line)
5bd52f0e 5069 (setq ret (point))
5c8b7eaf 5070 ;; }? continue
5bd52f0e 5071 ;; blah; }
5c8b7eaf 5072 (if (not
5bd52f0e
RS
5073 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5074 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5075 nil ; Do not need to do anything
83261a2f
SM
5076 ;; Looking at:
5077 ;; }
5078 ;; else
4ab89e7b
SM
5079 (if cperl-merge-trailing-else
5080 (if (looking-at
5081 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5082 (progn
5083 (search-forward "}")
5084 (setq p (point))
5085 (skip-chars-forward " \t\n")
5086 (delete-region p (point))
b5b0cb34 5087 (insert (make-string cperl-indent-region-fix-constructs ?\s))
4ab89e7b
SM
5088 (beginning-of-line)))
5089 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5090 (save-excursion
5091 (search-forward "}")
5092 (delete-horizontal-space)
5093 (insert "\n")
5094 (setq ret (point))
5095 (if (cperl-indent-line parse-data)
5096 (progn
5097 (cperl-fix-line-spacing end parse-data)
5098 (setq ret (point)))))))
83261a2f
SM
5099 ;; Looking at:
5100 ;; } else
5101 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5102 (progn
5103 (search-forward "}")
5104 (delete-horizontal-space)
b5b0cb34 5105 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5106 (beginning-of-line)))
5107 ;; Looking at:
5108 ;; else {
5109 (if (looking-at
5110 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5111 (progn
5112 (forward-word 1)
5113 (delete-horizontal-space)
b5b0cb34 5114 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5115 (beginning-of-line)))
5116 ;; Looking at:
5117 ;; foreach my $var
5118 (if (looking-at
5119 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5120 (progn
5121 (forward-word 2)
5122 (delete-horizontal-space)
b5b0cb34 5123 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5124 (beginning-of-line)))
5125 ;; Looking at:
5126 ;; foreach my $var (
5127 (if (looking-at
6c389151 5128 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
83261a2f 5129 (progn
f739b53b 5130 (forward-sexp 3)
83261a2f
SM
5131 (delete-horizontal-space)
5132 (insert
b5b0cb34 5133 (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f 5134 (beginning-of-line)))
4ab89e7b
SM
5135 ;; Looking at (with or without "}" at start, ending after "({"):
5136 ;; } foreach my $var () OR {
83261a2f 5137 (if (looking-at
ce22dd53 5138 "[ \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 5139 (progn
4ab89e7b 5140 (setq ml (match-beginning 8)) ; "(" or "{" after control word
83261a2f
SM
5141 (re-search-forward "[({]")
5142 (forward-char -1)
5143 (setq p (point))
5144 (if (eq (following-char) ?\( )
5145 (progn
5146 (forward-sexp 1)
4ab89e7b 5147 (setq pp (point))) ; past parenth-group
83261a2f
SM
5148 ;; after `else' or nothing
5149 (if ml ; after `else'
5150 (skip-chars-backward " \t\n")
5151 (beginning-of-line))
5152 (setq pp nil))
5153 ;; Now after the sexp before the brace
5154 ;; Multiline expr should be special
5155 (setq ml (and pp (save-excursion (goto-char p)
5156 (search-forward "\n" pp t))))
4ab89e7b 5157 (if (and (or (not pp) (< pp end)) ; Do not go too far...
83261a2f
SM
5158 (looking-at "[ \t\n]*{"))
5159 (progn
5160 (cond
5161 ((bolp) ; Were before `{', no if/else/etc
5162 nil)
4ab89e7b 5163 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
83261a2f
SM
5164 (delete-horizontal-space)
5165 (if (if ml
5166 cperl-extra-newline-before-brace-multiline
5167 cperl-extra-newline-before-brace)
5168 (progn
5169 (delete-horizontal-space)
5170 (insert "\n")
5171 (setq ret (point))
5172 (if (cperl-indent-line parse-data)
5173 (progn
5174 (cperl-fix-line-spacing end parse-data)
5175 (setq ret (point)))))
5176 (insert
b5b0cb34 5177 (make-string cperl-indent-region-fix-constructs ?\s))))
83261a2f
SM
5178 ((and (looking-at "[ \t]*\n")
5179 (not (if ml
5180 cperl-extra-newline-before-brace-multiline
5181 cperl-extra-newline-before-brace)))
5182 (setq pp (point))
5183 (skip-chars-forward " \t\n")
5184 (delete-region pp (point))
db133cb6 5185 (insert
4ab89e7b
SM
5186 (make-string cperl-indent-region-fix-constructs ?\ )))
5187 ((and (looking-at "[\t ]*{")
5188 (if ml cperl-extra-newline-before-brace-multiline
5189 cperl-extra-newline-before-brace))
5190 (delete-horizontal-space)
5191 (insert "\n")
5192 (setq ret (point))
5193 (if (cperl-indent-line parse-data)
5194 (progn
5195 (cperl-fix-line-spacing end parse-data)
5196 (setq ret (point))))))
83261a2f
SM
5197 ;; Now we are before `{'
5198 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5199 (progn
5200 (skip-chars-forward " \t\n")
5201 (setq pp (point))
5202 (forward-sexp 1)
5203 (setq p (point))
5204 (goto-char pp)
5205 (setq ml (search-forward "\n" p t))
5206 (if (or cperl-break-one-line-blocks-when-indent ml)
5207 ;; not good: multi-line BLOCK
5208 (progn
5209 (goto-char (1+ pp))
5210 (delete-horizontal-space)
5211 (insert "\n")
5212 (setq ret (point))
5213 (if (cperl-indent-line parse-data)
5214 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5215 (beginning-of-line)
e180ab9f 5216 (setq p (point) pp (point-at-eol)) ; May be different from ee.
83261a2f
SM
5217 ;; Now check whether there is a hanging `}'
5218 ;; Looking at:
5219 ;; } blah
5220 (if (and
5221 cperl-fix-hanging-brace-when-indent
5222 have-brace
5223 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5224 (condition-case nil
5225 (progn
5226 (up-list 1)
5227 (if (and (<= (point) pp)
5228 (eq (preceding-char) ?\} )
5229 (cperl-after-block-and-statement-beg (point-min)))
5230 t
5231 (goto-char p)
5232 nil))
5233 (error nil)))
5234 (progn
5235 (forward-char -1)
5236 (skip-chars-backward " \t")
5237 (if (bolp)
5238 ;; `}' was the first thing on the line, insert NL *after* it.
5239 (progn
5240 (cperl-indent-line parse-data)
5241 (search-forward "}")
5242 (delete-horizontal-space)
5243 (insert "\n"))
5244 (delete-horizontal-space)
5245 (or (eq (preceding-char) ?\;)
5246 (bolp)
5247 (and (eq (preceding-char) ?\} )
5248 (cperl-after-block-p (point-min)))
5249 (insert ";"))
5250 (insert "\n")
5251 (setq ret (point)))
5252 (if (cperl-indent-line parse-data)
5253 (setq ret (cperl-fix-line-spacing end parse-data)))
5254 (beginning-of-line)))))
5bd52f0e
RS
5255 ret))
5256
5257(defvar cperl-update-start) ; Do not need to make them local
5258(defvar cperl-update-end)
5259(defun cperl-delay-update-hook (beg end old-len)
5260 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5261 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
db133cb6 5262
f83d2997
KH
5263(defun cperl-indent-region (start end)
5264 "Simple variant of indentation of region in CPerl mode.
5c8b7eaf 5265Should be slow. Will not indent comment if it starts at `comment-indent'
f83d2997 5266or looks like continuation of the comment on the previous line.
5c8b7eaf
SS
5267Indents all the lines whose first character is between START and END
5268inclusive.
db133cb6 5269
5c8b7eaf 5270If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 5271conditional/loop constructs."
f83d2997 5272 (interactive "r")
5bd52f0e 5273 (cperl-update-syntaxification end end)
f83d2997 5274 (save-excursion
5bd52f0e 5275 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
83261a2f
SM
5276 (let ((indent-info (if cperl-emacs-can-parse
5277 (list nil nil nil) ; Cannot use '(), since will modify
5278 nil))
c326ddd1 5279 (pm 0)
83261a2f
SM
5280 after-change-functions ; Speed it up!
5281 st comm old-comm-indent new-comm-indent p pp i empty)
5bd52f0e 5282 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
83261a2f
SM
5283 (goto-char start)
5284 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5285 (current-column))
5286 new-comm-indent old-comm-indent)
5287 (goto-char start)
5288 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5289 (or (bolp) (beginning-of-line 2))
83261a2f 5290 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5bd52f0e
RS
5291 (setq st (point))
5292 (if (or
5293 (setq empty (looking-at "[ \t]*\n"))
5294 (and (setq comm (looking-at "[ \t]*#"))
83261a2f
SM
5295 (or (eq (current-indentation) (or old-comm-indent
5296 comment-column))
5bd52f0e 5297 (setq old-comm-indent nil))))
8c777c8d 5298 (if (and old-comm-indent
5bd52f0e 5299 (not empty)
8c777c8d 5300 (= (current-indentation) old-comm-indent)
5bd52f0e
RS
5301 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5302 (not (eq (get-text-property (point) 'syntax-table)
5303 cperl-st-cfence)))
83261a2f
SM
5304 (let ((comment-column new-comm-indent))
5305 (indent-for-comment)))
5306 (progn
5bd52f0e 5307 (setq i (cperl-indent-line indent-info))
8c777c8d
CY
5308 (or comm
5309 (not i)
5310 (progn
5311 (if cperl-indent-region-fix-constructs
5bd52f0e 5312 (goto-char (cperl-fix-line-spacing end indent-info)))
83261a2f
SM
5313 (if (setq old-comm-indent
5314 (and (cperl-to-comment-or-eol)
5315 (not (memq (get-text-property (point)
5316 'syntax-type)
5317 '(pod here-doc)))
5c8b7eaf 5318 (not (eq (get-text-property (point)
5bd52f0e
RS
5319 'syntax-table)
5320 cperl-st-cfence))
8c777c8d
CY
5321 (current-column)))
5322 (progn (indent-for-comment)
5323 (skip-chars-backward " \t")
5324 (skip-chars-backward "#")
5325 (setq new-comm-indent (current-column))))))))
5326 (beginning-of-line 2)))
5bd52f0e 5327 ;; Now run the update hooks
83261a2f
SM
5328 (and after-change-functions
5329 cperl-update-end
5330 (save-excursion
5331 (goto-char cperl-update-end)
5332 (insert " ")
5333 (delete-char -1)
5334 (goto-char cperl-update-start)
5335 (insert " ")
5336 (delete-char -1))))))
f83d2997 5337
f83d2997
KH
5338;; Stolen from lisp-mode with a lot of improvements
5339
5340(defun cperl-fill-paragraph (&optional justify iteration)
82eb0dae 5341 "Like `fill-paragraph', but handle CPerl comments.
f83d2997
KH
5342If any of the current line is a comment, fill the comment or the
5343block of it that point is in, preserving the comment's initial
5344indentation and initial hashes. Behaves usually outside of comment."
82eb0dae 5345 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
83261a2f 5346 (let (;; Non-nil if the current line contains a comment.
f83d2997 5347 has-comment
4ab89e7b 5348 fill-paragraph-function ; do not recurse
f83d2997
KH
5349 ;; If has-comment, the appropriate fill-prefix for the comment.
5350 comment-fill-prefix
5351 ;; Line that contains code and comment (or nil)
5352 start
5353 c spaces len dc (comment-column comment-column))
5354 ;; Figure out what kind of comment we are looking at.
5355 (save-excursion
5356 (beginning-of-line)
5357 (cond
5358
5359 ;; A line with nothing but a comment on it?
5360 ((looking-at "[ \t]*#[# \t]*")
5361 (setq has-comment t
5362 comment-fill-prefix (buffer-substring (match-beginning 0)
5363 (match-end 0))))
5364
5365 ;; A line with some code, followed by a comment? Remember that the
5366 ;; semi which starts the comment shouldn't be part of a string or
5367 ;; character.
5368 ((cperl-to-comment-or-eol)
5369 (setq has-comment t)
5370 (looking-at "#+[ \t]*")
5c8b7eaf 5371 (setq start (point) c (current-column)
f83d2997 5372 comment-fill-prefix
b5b0cb34 5373 (concat (make-string (current-column) ?\s)
f83d2997 5374 (buffer-substring (match-beginning 0) (match-end 0)))
5c8b7eaf 5375 spaces (progn (skip-chars-backward " \t")
f83d2997 5376 (buffer-substring (point) start))
5c8b7eaf 5377 dc (- c (current-column)) len (- start (point))
f83d2997
KH
5378 start (point-marker))
5379 (delete-char len)
4ab89e7b 5380 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
f83d2997 5381 (if (not has-comment)
83261a2f 5382 (fill-paragraph justify) ; Do the usual thing outside of comment
f83d2997
KH
5383 ;; Narrow to include only the comment, and then fill the region.
5384 (save-restriction
5385 (narrow-to-region
5386 ;; Find the first line we should include in the region to fill.
5387 (if start (progn (beginning-of-line) (point))
5388 (save-excursion
5389 (while (and (zerop (forward-line -1))
5390 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5391 ;; We may have gone to far. Go forward again.
5392 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5393 (forward-line 1))
5394 (point)))
5395 ;; Find the beginning of the first line past the region to fill.
5396 (save-excursion
5397 (while (progn (forward-line 1)
5398 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5399 (point)))
5400 ;; Remove existing hashes
4ab89e7b 5401 (goto-char (point-min))
8c777c8d
CY
5402 (save-excursion
5403 (while (progn (forward-line 1) (< (point) (point-max)))
5404 (skip-chars-forward " \t")
5405 (if (looking-at "#+")
5406 (progn
5407 (if (and (eq (point) (match-beginning 0))
5408 (not (eq (point) (match-end 0)))) nil
4ab89e7b
SM
5409 (error
5410 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5411 (delete-char (- (match-end 0) (match-beginning 0)))))))
f83d2997
KH
5412
5413 ;; Lines with only hashes on them can be paragraph boundaries.
5414 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5415 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5416 (fill-prefix comment-fill-prefix))
5417 (fill-paragraph justify)))
5418 (if (and start)
5c8b7eaf 5419 (progn
f83d2997
KH
5420 (goto-char start)
5421 (if (> dc 0)
83261a2f 5422 (progn (delete-char dc) (insert spaces)))
f83d2997
KH
5423 (if (or (= (current-column) c) iteration) nil
5424 (setq comment-column c)
5425 (indent-for-comment)
5426 ;; Repeat once more, flagging as iteration
4ab89e7b
SM
5427 (cperl-fill-paragraph justify t))))))
5428 t)
f83d2997
KH
5429
5430(defun cperl-do-auto-fill ()
5431 ;; Break out if the line is short enough
5432 (if (> (save-excursion
5433 (end-of-line)
5434 (current-column))
5435 fill-column)
83261a2f
SM
5436 (let ((c (save-excursion (beginning-of-line)
5437 (cperl-to-comment-or-eol) (point)))
8038e2cf 5438 (s (memq (following-char) '(?\s ?\t))) marker)
82eb0dae
SM
5439 (if (>= c (point))
5440 ;; Don't break line inside code: only inside comment.
5441 nil
83261a2f 5442 (setq marker (point-marker))
82eb0dae 5443 (fill-paragraph nil)
83261a2f
SM
5444 (goto-char marker)
5445 ;; Is not enough, sometimes marker is a start of line
5446 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5447 (goto-char (match-end 0))))
5448 ;; Following space could have gone:
8038e2cf 5449 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
83261a2f
SM
5450 (insert " ")
5451 (backward-char 1))
5452 ;; Previous space could have gone:
8038e2cf 5453 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
f83d2997 5454
f83d2997
KH
5455(defun cperl-imenu-addback (lst &optional isback name)
5456 ;; We suppose that the lst is a DAG, unless the first element only
5457 ;; loops back, and ISBACK is set. Thus this function cannot be
5458 ;; applied twice without ISBACK set.
5459 (cond ((not cperl-imenu-addback) lst)
5460 (t
5c8b7eaf 5461 (or name
f83d2997 5462 (setq name "+++BACK+++"))
dba01120
GM
5463 (mapc (lambda (elt)
5464 (if (and (listp elt) (listp (cdr elt)))
5465 (progn
5466 ;; In the other order it goes up
5467 ;; one level only ;-(
5468 (setcdr elt (cons (cons name lst)
5469 (cdr elt)))
5470 (cperl-imenu-addback (cdr elt) t name))))
5471 (if isback (cdr lst) lst))
f83d2997
KH
5472 lst)))
5473
80585273 5474(defun cperl-imenu--create-perl-index (&optional regexp)
f83d2997 5475 (require 'imenu) ; May be called from TAGS creator
5c8b7eaf 5476 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
f83d2997
KH
5477 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5478 (index-meth-alist '()) meth
4ab89e7b
SM
5479 packages ends-ranges p marker is-proto
5480 (prev-pos 0) is-pack index index1 name (end-range 0) package)
f83d2997 5481 (goto-char (point-min))
6c389151 5482 (cperl-update-syntaxification (point-max) (point-max))
f83d2997
KH
5483 ;; Search for the function
5484 (progn ;;save-match-data
5485 (while (re-search-forward
80585273 5486 (or regexp cperl-imenu--function-name-regexp-perl)
f83d2997 5487 nil t)
4ab89e7b 5488 ;; 2=package-group, 5=package-name 8=sub-name
f83d2997
KH
5489 (cond
5490 ((and ; Skip some noise if building tags
4ab89e7b
SM
5491 (match-beginning 5) ; package name
5492 ;;(eq (char-after (match-beginning 2)) ?p) ; package
f83d2997 5493 (not (save-match-data
83261a2f 5494 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
f83d2997
KH
5495 nil)
5496 ((and
4ab89e7b
SM
5497 (or (match-beginning 2)
5498 (match-beginning 8)) ; package or sub
6c389151 5499 ;; Skip if quoted (will not skip multi-line ''-strings :-():
f83d2997
KH
5500 (null (get-text-property (match-beginning 1) 'syntax-table))
5501 (null (get-text-property (match-beginning 1) 'syntax-type))
5502 (null (get-text-property (match-beginning 1) 'in-pod)))
4ab89e7b 5503 (setq is-pack (match-beginning 2))
f83d2997
KH
5504 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5505 ;; (goto-char (match-end 0))) ; Messes what follows
4ab89e7b 5506 (setq meth nil
f83d2997
KH
5507 p (point))
5508 (while (and ends-ranges (>= p (car ends-ranges)))
5509 ;; delete obsolete entries
5510 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5511 (setq package (or (car packages) "")
5512 end-range (or (car ends-ranges) 0))
4ab89e7b
SM
5513 (if is-pack ; doing "package"
5514 (progn
5515 (if (match-beginning 5) ; named package
5516 (setq name (buffer-substring (match-beginning 5)
5517 (match-end 5))
5518 name (progn
5519 (set-text-properties 0 (length name) nil name)
5520 name)
5521 package (concat name "::")
5522 name (concat "package " name))
5523 ;; Support nameless packages
5524 (setq name "package;" package ""))
5525 (setq end-range
5526 (save-excursion
5527 (parse-partial-sexp (point) (point-max) -1) (point))
5528 ends-ranges (cons end-range ends-ranges)
5529 packages (cons package packages)))
5530 (setq is-proto
5531 (or (eq (following-char) ?\;)
5532 (eq 0 (get-text-property (point) 'attrib-group)))))
f83d2997 5533 ;; Skip this function name if it is a prototype declaration.
4ab89e7b
SM
5534 (if (and is-proto (not is-pack)) nil
5535 (or is-pack
5536 (setq name
5537 (buffer-substring (match-beginning 8) (match-end 8)))
5538 (set-text-properties 0 (length name) nil name))
5539 (setq marker (make-marker))
5540 (set-marker marker (match-end (if is-pack 2 8)))
5541 (cond (is-pack nil)
5542 ((string-match "[:']" name)
5543 (setq meth t))
5544 ((> p end-range) nil)
5545 (t
5546 (setq name (concat package name) meth t)))
6c389151 5547 (setq index (cons name marker))
4ab89e7b 5548 (if is-pack
f83d2997
KH
5549 (push index index-pack-alist)
5550 (push index index-alist))
5551 (if meth (push index index-meth-alist))
5552 (push index index-unsorted-alist)))
4ab89e7b
SM
5553 ((match-beginning 16) ; POD section
5554 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5555 marker (make-marker))
5556 (set-marker marker (match-beginning 17))
f83d2997 5557 (set-text-properties 0 (length name) nil name)
4ab89e7b
SM
5558 (setq name (concat (make-string
5559 (* 3 (- (char-after (match-beginning 16)) ?1))
5560 ?\ )
5561 name)
5562 index (cons name marker))
f83d2997
KH
5563 (setq index1 (cons (concat "=" name) (cdr index)))
5564 (push index index-pod-alist)
5565 (push index1 index-unsorted-alist)))))
5c8b7eaf 5566 (setq index-alist
f83d2997
KH
5567 (if (default-value 'imenu-sort-function)
5568 (sort index-alist (default-value 'imenu-sort-function))
83261a2f 5569 (nreverse index-alist)))
f83d2997
KH
5570 (and index-pod-alist
5571 (push (cons "+POD headers+..."
5572 (nreverse index-pod-alist))
5573 index-alist))
5574 (and (or index-pack-alist index-meth-alist)
5575 (let ((lst index-pack-alist) hier-list pack elt group name)
5576 ;; Remove "package ", reverse and uniquify.
5577 (while lst
5578 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5579 (if (assoc name hier-list) nil
5580 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5581 (setq lst index-meth-alist)
5582 (while lst
5583 (setq elt (car lst) lst (cdr lst))
5584 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5585 (setq pack (substring (car elt) 0 (match-beginning 0)))
5c8b7eaf 5586 (if (setq group (assoc pack hier-list))
f83d2997
KH
5587 (if (listp (cdr group))
5588 ;; Have some functions already
5c8b7eaf
SS
5589 (setcdr group
5590 (cons (cons (substring
f83d2997
KH
5591 (car elt)
5592 (+ 2 (match-beginning 0)))
5593 (cdr elt))
5594 (cdr group)))
5c8b7eaf 5595 (setcdr group (list (cons (substring
f83d2997
KH
5596 (car elt)
5597 (+ 2 (match-beginning 0)))
5598 (cdr elt)))))
5c8b7eaf
SS
5599 (setq hier-list
5600 (cons (cons pack
5601 (list (cons (substring
f83d2997
KH
5602 (car elt)
5603 (+ 2 (match-beginning 0)))
5604 (cdr elt))))
5605 hier-list))))))
5606 (push (cons "+Hierarchy+..."
5607 hier-list)
5608 index-alist)))
5609 (and index-pack-alist
5610 (push (cons "+Packages+..."
5611 (nreverse index-pack-alist))
5612 index-alist))
5c8b7eaf 5613 (and (or index-pack-alist index-pod-alist
f83d2997
KH
5614 (default-value 'imenu-sort-function))
5615 index-unsorted-alist
5616 (push (cons "+Unsorted List+..."
5617 (nreverse index-unsorted-alist))
5618 index-alist))
5619 (cperl-imenu-addback index-alist)))
5620
6c389151 5621\f
6c389151
SM
5622;; Suggested by Mark A. Hershberger
5623(defun cperl-outline-level ()
5624 (looking-at outline-regexp)
5625 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4ab89e7b
SM
5626;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5627 ((match-beginning 2) 0) ; package
5628 ((match-beginning 8) 1) ; sub
5629 ((match-beginning 16)
5630 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5631 (t 5))) ; should not happen
6c389151
SM
5632
5633\f
f83d2997
KH
5634(defun cperl-windowed-init ()
5635 "Initialization under windowed version."
f453f5a8 5636 (cond ((featurep 'ps-print)
82d9a08d
SM
5637 (or cperl-faces-init
5638 (progn
5639 (and (boundp 'font-lock-multiline)
5640 (setq cperl-font-lock-multiline t))
5641 (cperl-init-faces))))
f453f5a8
CY
5642 ((not cperl-faces-init)
5643 (add-hook 'font-lock-mode-hook
5644 (function
5645 (lambda ()
5646 (if (memq major-mode '(perl-mode cperl-mode))
5647 (progn
5648 (or cperl-faces-init (cperl-init-faces)))))))
5649 (if (fboundp 'eval-after-load)
5650 (eval-after-load
5651 "ps-print"
5652 '(or cperl-faces-init (cperl-init-faces)))))))
db133cb6 5653
5efe6a56 5654(defvar cperl-font-lock-keywords-1 nil
80585273 5655 "Additional expressions to highlight in Perl mode. Minimal set.")
5efe6a56 5656(defvar cperl-font-lock-keywords nil
80585273 5657 "Additional expressions to highlight in Perl mode. Default set.")
5efe6a56 5658(defvar cperl-font-lock-keywords-2 nil
80585273
DL
5659 "Additional expressions to highlight in Perl mode. Maximal set")
5660
db133cb6
RS
5661(defun cperl-load-font-lock-keywords ()
5662 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5663 cperl-font-lock-keywords)
db133cb6
RS
5664
5665(defun cperl-load-font-lock-keywords-1 ()
5666 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5667 cperl-font-lock-keywords-1)
db133cb6
RS
5668
5669(defun cperl-load-font-lock-keywords-2 ()
5670 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5671 cperl-font-lock-keywords-2)
f83d2997 5672
5bd52f0e
RS
5673(defun cperl-init-faces-weak ()
5674 ;; Allow `cperl-find-pods-heres' to run.
5675 (or (boundp 'font-lock-constant-face)
5676 (cperl-force-face font-lock-constant-face
4ab89e7b
SM
5677 "Face for constant and label names"))
5678 (or (boundp 'font-lock-warning-face)
5679 (cperl-force-face font-lock-warning-face
5680 "Face for things which should stand out"))
5681 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5682 )
5bd52f0e 5683
f83d2997 5684(defun cperl-init-faces ()
5bd52f0e 5685 (condition-case errs
f83d2997
KH
5686 (progn
5687 (require 'font-lock)
5688 (and (fboundp 'font-lock-fontify-anchored-keywords)
5689 (featurep 'font-lock-extra)
5690 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5691 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
f83d2997
KH
5692 (if (fboundp 'font-lock-fontify-anchored-keywords)
5693 (setq font-lock-anchored t))
5c8b7eaf 5694 (setq
f83d2997
KH
5695 t-font-lock-keywords
5696 (list
1f5c1626 5697 `("[ \t]+$" 0 ',cperl-invalid-face t)
f83d2997
KH
5698 (cons
5699 (concat
5700 "\\(^\\|[^$@%&\\]\\)\\<\\("
5701 (mapconcat
5702 'identity
5703 '("if" "until" "while" "elsif" "else" "unless" "for"
5704 "foreach" "continue" "exit" "die" "last" "goto" "next"
4ab89e7b 5705 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
6c389151 5706 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
f83d2997
KH
5707 "\\|") ; Flow control
5708 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5709 ; In what follows we use `type' style
5710 ; for overwritable builtins
5711 (list
5712 (concat
5713 "\\(^\\|[^$@%&\\]\\)\\<\\("
5714 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5715 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5716 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5717 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5718 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5719 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5720 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5721 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5722 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5723 ;; "gethostbyname" "gethostent" "getlogin"
5724 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5725 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5726 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5727 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5728 ;; "getservbyport" "getservent" "getsockname"
5729 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5730 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5bd52f0e 5731 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
f83d2997
KH
5732 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5733 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5734 ;; "quotemeta" "rand" "read" "readdir" "readline"
5735 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5736 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5737 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5738 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5739 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5740 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5741 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5742 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
6c389151 5743 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
f83d2997
KH
5744 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5745 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5746 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5c8b7eaf 5747 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
f83d2997
KH
5748 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5749 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5750 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5751 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5752 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5753 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5754 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5755 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5756 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5757 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5758 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5759 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5760 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5761 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5762 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5bd52f0e 5763 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
f83d2997
KH
5764 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5765 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5766 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5767 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5768 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5769 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5770 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5771 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
6c389151 5772 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
f83d2997
KH
5773 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5774 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5775 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5776 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5777 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5778 "\\)\\>") 2 'font-lock-type-face)
5779 ;; In what follows we use `other' style
5780 ;; for nonoverwritable builtins
5781 ;; Somehow 's', 'm' are not auto-generated???
5782 (list
5783 (concat
5784 "\\(^\\|[^$@%&\\]\\)\\<\\("
6c389151 5785 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
f83d2997
KH
5786 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5787 ;; "eval" "exists" "for" "foreach" "format" "goto"
5788 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4ab89e7b 5789 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
f83d2997
KH
5790 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5791 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5792 ;; "undef" "unless" "unshift" "untie" "until" "use"
5793 ;; "while" "y"
6c389151 5794 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
f83d2997 5795 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
6c389151
SM
5796 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5797 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
f83d2997 5798 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5bd52f0e 5799 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
f83d2997
KH
5800 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5801 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5802 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5803 "\\|[sm]" ; Added manually
4ab89e7b 5804 "\\)\\>") 2 'cperl-nonoverridable-face)
f83d2997
KH
5805 ;; (mapconcat 'identity
5806 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5807 ;; "#include" "#define" "#undef")
5808 ;; "\\|")
5809 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5810 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4c36be58 5811 ;; This highlights declarations and definitions differently.
4ab89e7b
SM
5812 ;; We do not try to highlight in the case of attributes:
5813 ;; it is already done by `cperl-find-pods-heres'
5814 (list (concat "\\<sub"
5815 cperl-white-and-comment-rex ; whitespace/comments
5816 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5817 "\\("
5818 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5819 "([^()]*)\\)?" ; prototype
5820 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5821 "[{;]")
5822 2 (if cperl-font-lock-multiline
5823 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5824 'font-lock-function-name-face
5825 'font-lock-variable-name-face)
5826 ;; need to manually set 'multiline' for older font-locks
5827 '(progn
5828 (if (< 1 (count-lines (match-beginning 0)
5829 (match-end 0)))
5830 (put-text-property
5831 (+ 3 (match-beginning 0)) (match-end 0)
5832 'syntax-type 'multiline))
5833 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5834 'font-lock-function-name-face
5835 'font-lock-variable-name-face))))
f83d2997
KH
5836 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5837 2 font-lock-function-name-face)
5838 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5839 1 font-lock-function-name-face)
5840 (cond ((featurep 'font-lock-extra)
5c8b7eaf 5841 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
f83d2997
KH
5842 (2 font-lock-string-face t)
5843 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5844 (font-lock-anchored
5845 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5846 (2 font-lock-string-face t)
5847 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5848 nil nil
5849 (1 font-lock-string-face t))))
5850 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5851 2 font-lock-string-face t)))
db133cb6 5852 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
f83d2997 5853 font-lock-string-face t)
5c8b7eaf 5854 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
83261a2f 5855 font-lock-constant-face) ; labels
f83d2997 5856 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
883212ce 5857 2 font-lock-constant-face)
6c389151
SM
5858 ;; Uncomment to get perl-mode-like vars
5859 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5860 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5861 ;;; (2 (cons font-lock-variable-name-face '(underline))))
f83d2997 5862 (cond ((featurep 'font-lock-extra)
6c389151 5863 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
f83d2997
KH
5864 (3 font-lock-variable-name-face)
5865 (4 '(another 4 nil
5866 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5867 (1 font-lock-variable-name-face)
5c8b7eaf 5868 (2 '(restart 2 nil) nil t)))
f83d2997
KH
5869 nil t))) ; local variables, multiple
5870 (font-lock-anchored
4ab89e7b 5871 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
9edd6ee6 5872 `(,(concat "\\<\\(my\\|local\\|our\\)"
4ab89e7b
SM
5873 cperl-maybe-white-and-comment-rex
5874 "\\(("
5875 cperl-maybe-white-and-comment-rex
9edd6ee6
SM
5876 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5877 (5 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5878 'font-lock-variable-name-face
5879 '(progn (setq cperl-font-lock-multiline-start
5880 (match-beginning 0))
9edd6ee6
SM
5881 'font-lock-variable-name-face)))
5882 (,(concat "\\="
4ab89e7b
SM
5883 cperl-maybe-white-and-comment-rex
5884 ","
5885 cperl-maybe-white-and-comment-rex
9edd6ee6 5886 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
cb5bf6ba 5887 ;; Bug in font-lock: limit is used not only to limit
4ab89e7b
SM
5888 ;; searches, but to set the "extend window for
5889 ;; facification" property. Thus we need to minimize.
9edd6ee6 5890 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5891 '(if (match-beginning 3)
5892 (save-excursion
5893 (goto-char (match-beginning 3))
5894 (condition-case nil
5895 (forward-sexp 1)
5896 (error
5897 (condition-case nil
5898 (forward-char 200)
5899 (error nil)))) ; typeahead
5900 (1- (point))) ; report limit
5901 (forward-char -2)) ; disable continued expr
5902 '(if (match-beginning 3)
5903 (point-max) ; No limit for continuation
9edd6ee6
SM
5904 (forward-char -2))) ; disable continued expr
5905 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5906 nil
5907 '(progn ; Do at end
5908 ;; "my" may be already fontified (POD),
5909 ;; so cperl-font-lock-multiline-start is nil
5910 (if (or (not cperl-font-lock-multiline-start)
5911 (> 2 (count-lines
5912 cperl-font-lock-multiline-start
5913 (point))))
5914 nil
5915 (put-text-property
5916 (1+ cperl-font-lock-multiline-start) (point)
5917 'syntax-type 'multiline))
9edd6ee6
SM
5918 (setq cperl-font-lock-multiline-start nil)))
5919 (3 font-lock-variable-name-face))))
4ab89e7b 5920 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
f83d2997 5921 3 font-lock-variable-name-face)))
6c389151 5922 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
eb6121fc 5923 4 font-lock-variable-name-face)
bbd240ce 5924 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntactically
9ed9fd35 5925 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
eb6121fc 5926 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
a1506d29 5927 (setq
f83d2997
KH
5928 t-font-lock-keywords-1
5929 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4ab89e7b
SM
5930 ;; not yet as of XEmacs 19.12, works with 21.1.11
5931 (or
6546555e 5932 (not (featurep 'xemacs))
4ab89e7b
SM
5933 (string< "21.1.9" emacs-version)
5934 (and (string< "21.1.10" emacs-version)
5935 (string< emacs-version "21.1.2")))
f83d2997
KH
5936 '(
5937 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5938 (if (eq (char-after (match-beginning 2)) ?%)
4ab89e7b
SM
5939 'cperl-hash-face
5940 'cperl-array-face)
f83d2997
KH
5941 t) ; arrays and hashes
5942 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5943 1
5c8b7eaf 5944 (if (= (- (match-end 2) (match-beginning 2)) 1)
f83d2997 5945 (if (eq (char-after (match-beginning 3)) ?{)
4ab89e7b
SM
5946 'cperl-hash-face
5947 'cperl-array-face) ; arrays and hashes
f83d2997
KH
5948 font-lock-variable-name-face) ; Just to put something
5949 t)
4ab89e7b
SM
5950 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5951 (1 cperl-array-face)
5952 (2 font-lock-variable-name-face))
5953 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5954 (1 cperl-hash-face)
5955 (2 font-lock-variable-name-face))
f83d2997
KH
5956 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5957 ;;; Too much noise from \s* @s[ and friends
5c8b7eaf 5958 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
f83d2997
KH
5959 ;;(3 font-lock-function-name-face t t)
5960 ;;(4
5961 ;; (if (cperl-slash-is-regexp)
5962 ;; font-lock-function-name-face 'default) nil t))
5963 )))
6c389151
SM
5964 (if cperl-highlight-variables-indiscriminately
5965 (setq t-font-lock-keywords-1
5966 (append t-font-lock-keywords-1
4ab89e7b 5967 (list '("\\([$*]{?\\sw+\\)" 1
6c389151 5968 font-lock-variable-name-face)))))
a1506d29 5969 (setq cperl-font-lock-keywords-1
5bd52f0e
RS
5970 (if cperl-syntaxify-by-font-lock
5971 (cons 'cperl-fontify-update
5972 t-font-lock-keywords)
5973 t-font-lock-keywords)
5efe6a56
SM
5974 cperl-font-lock-keywords cperl-font-lock-keywords-1
5975 cperl-font-lock-keywords-2 (append
6c389151
SM
5976 cperl-font-lock-keywords-1
5977 t-font-lock-keywords-1)))
f83d2997
KH
5978 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5979 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
db133cb6 5980 (eval ; Avoid a warning
83261a2f
SM
5981 '(font-lock-require-faces
5982 (list
5983 ;; Color-light Color-dark Gray-light Gray-dark Mono
5984 (list 'font-lock-comment-face
5985 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5986 nil
5987 [nil nil t t t]
5988 [nil nil t t t]
5989 nil)
5990 (list 'font-lock-string-face
5991 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5992 nil
5993 nil
5994 [nil nil t t t]
5995 nil)
5996 (list 'font-lock-function-name-face
5997 (vector
5998 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5999 (cdr (assq 'background-color ; if mono
6000 (frame-parameters))))
6001 (vector
6002 nil nil nil nil
6003 (cdr (assq 'foreground-color ; if mono
6004 (frame-parameters))))
6005 [nil nil t t t]
6006 nil
6007 nil)
6008 (list 'font-lock-variable-name-face
6009 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6010 nil
6011 [nil nil t t t]
6012 [nil nil t t t]
6013 nil)
6014 (list 'font-lock-type-face
6015 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6016 nil
6017 [nil nil t t t]
6018 nil
6019 [nil nil t t t])
4ab89e7b
SM
6020 (list 'font-lock-warning-face
6021 ["Pink" "Red" "Gray50" "LightGray"]
6022 ["gray20" "gray90"
6023 "gray80" "gray20"]
6024 [nil nil t t t]
6025 nil
6026 [nil nil t t t]
6027 )
83261a2f
SM
6028 (list 'font-lock-constant-face
6029 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6030 nil
6031 [nil nil t t t]
6032 nil
6033 [nil nil t t t])
4ab89e7b 6034 (list 'cperl-nonoverridable-face
83261a2f
SM
6035 ["chartreuse3" ("orchid1" "orange")
6036 nil "Gray80"]
6037 [nil nil "gray90"]
6038 [nil nil nil t t]
6039 [nil nil t t]
6040 [nil nil t t t])
4ab89e7b 6041 (list 'cperl-array-face
83261a2f
SM
6042 ["blue" "yellow" nil "Gray80"]
6043 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6044 "gray90"]
6045 t
6046 nil
6047 nil)
4ab89e7b 6048 (list 'cperl-hash-face
83261a2f
SM
6049 ["red" "red" nil "Gray80"]
6050 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6051 "gray90"]
6052 t
6053 t
6054 nil))))
5bd52f0e 6055 ;; Do it the dull way, without choose-color
f83d2997
KH
6056 (defvar cperl-guessed-background nil
6057 "Display characteristics as guessed by cperl.")
83261a2f 6058 ;; (or (fboundp 'x-color-defined-p)
15ca5699 6059 ;; (defalias 'x-color-defined-p
83261a2f
SM
6060 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6061 ;; ;; XEmacs >= 19.12
6062 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6063 ;; ;; XEmacs 19.11
6064 ;; (t 'x-valid-color-name-p))))
5c8b7eaf 6065 (cperl-force-face font-lock-constant-face
5bd52f0e
RS
6066 "Face for constant and label names")
6067 (cperl-force-face font-lock-variable-name-face
6068 "Face for variable names")
6069 (cperl-force-face font-lock-type-face
6070 "Face for data types")
4ab89e7b 6071 (cperl-force-face cperl-nonoverridable-face
5bd52f0e 6072 "Face for data types from another group")
4ab89e7b
SM
6073 (cperl-force-face font-lock-warning-face
6074 "Face for things which should stand out")
5bd52f0e
RS
6075 (cperl-force-face font-lock-comment-face
6076 "Face for comments")
6077 (cperl-force-face font-lock-function-name-face
6078 "Face for function names")
4ab89e7b 6079 (cperl-force-face cperl-hash-face
5bd52f0e 6080 "Face for hashes")
4ab89e7b 6081 (cperl-force-face cperl-array-face
5bd52f0e
RS
6082 "Face for arrays")
6083 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6084 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6085 ;;(or (boundp 'font-lock-type-face)
6086 ;; (defconst font-lock-type-face
6087 ;; 'font-lock-type-face
6088 ;; "Face to use for data types."))
6089 ;;(or (boundp 'cperl-nonoverridable-face)
6090 ;; (defconst cperl-nonoverridable-face
4ab89e7b 6091 ;; 'cperl-nonoverridable-face
5bd52f0e 6092 ;; "Face to use for data types from another group."))
6546555e 6093 ;;(if (not (featurep 'xemacs)) nil
5bd52f0e
RS
6094 ;; (or (boundp 'font-lock-comment-face)
6095 ;; (defconst font-lock-comment-face
6096 ;; 'font-lock-comment-face
6097 ;; "Face to use for comments."))
6098 ;; (or (boundp 'font-lock-keyword-face)
6099 ;; (defconst font-lock-keyword-face
6100 ;; 'font-lock-keyword-face
6101 ;; "Face to use for keywords."))
6102 ;; (or (boundp 'font-lock-function-name-face)
6103 ;; (defconst font-lock-function-name-face
6104 ;; 'font-lock-function-name-face
6105 ;; "Face to use for function names.")))
6106 (if (and
4ab89e7b 6107 (not (cperl-is-face 'cperl-array-face))
5c8b7eaf 6108 (cperl-is-face 'font-lock-emphasized-face))
4ab89e7b 6109 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
5bd52f0e 6110 (if (and
4ab89e7b 6111 (not (cperl-is-face 'cperl-hash-face))
5c8b7eaf 6112 (cperl-is-face 'font-lock-other-emphasized-face))
4ab89e7b 6113 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
5bd52f0e 6114 (if (and
4ab89e7b 6115 (not (cperl-is-face 'cperl-nonoverridable-face))
5c8b7eaf 6116 (cperl-is-face 'font-lock-other-type-face))
4ab89e7b 6117 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
5bd52f0e
RS
6118 ;;(or (boundp 'cperl-hash-face)
6119 ;; (defconst cperl-hash-face
4ab89e7b 6120 ;; 'cperl-hash-face
5bd52f0e
RS
6121 ;; "Face to use for hashes."))
6122 ;;(or (boundp 'cperl-array-face)
6123 ;; (defconst cperl-array-face
4ab89e7b 6124 ;; 'cperl-array-face
5bd52f0e 6125 ;; "Face to use for arrays."))
f83d2997
KH
6126 ;; Here we try to guess background
6127 (let ((background
6128 (if (boundp 'font-lock-background-mode)
6129 font-lock-background-mode
5c8b7eaf 6130 'light))
83261a2f 6131 (face-list (and (fboundp 'face-list) (face-list))))
5bd52f0e
RS
6132;;;; (fset 'cperl-is-face
6133;;;; (cond ((fboundp 'find-face)
6134;;;; (symbol-function 'find-face))
6135;;;; (face-list
6136;;;; (function (lambda (face) (member face face-list))))
6137;;;; (t
6138;;;; (function (lambda (face) (boundp face))))))
f83d2997
KH
6139 (defvar cperl-guessed-background
6140 (if (and (boundp 'font-lock-display-type)
6141 (eq font-lock-display-type 'grayscale))
6142 'gray
6143 background)
6144 "Background as guessed by CPerl mode")
83261a2f
SM
6145 (and (not (cperl-is-face 'font-lock-constant-face))
6146 (cperl-is-face 'font-lock-reference-face)
6147 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
db133cb6 6148 (if (cperl-is-face 'font-lock-type-face) nil
f83d2997
KH
6149 (copy-face 'default 'font-lock-type-face)
6150 (cond
6151 ((eq background 'light)
6152 (set-face-foreground 'font-lock-type-face
6153 (if (x-color-defined-p "seagreen")
6154 "seagreen"
6155 "sea green")))
6156 ((eq background 'dark)
6157 (set-face-foreground 'font-lock-type-face
6158 (if (x-color-defined-p "os2pink")
6159 "os2pink"
6160 "pink")))
6161 (t
6162 (set-face-background 'font-lock-type-face "gray90"))))
4ab89e7b 6163 (if (cperl-is-face 'cperl-nonoverridable-face)
f83d2997 6164 nil
4ab89e7b 6165 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
f83d2997
KH
6166 (cond
6167 ((eq background 'light)
4ab89e7b 6168 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6169 (if (x-color-defined-p "chartreuse3")
6170 "chartreuse3"
6171 "chartreuse")))
6172 ((eq background 'dark)
4ab89e7b 6173 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6174 (if (x-color-defined-p "orchid1")
6175 "orchid1"
6176 "orange")))))
5bd52f0e
RS
6177;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6178;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6179;;; (cond
6180;;; ((eq background 'light)
6181;;; (set-face-background 'font-lock-other-emphasized-face
6182;;; (if (x-color-defined-p "lightyellow2")
6183;;; "lightyellow2"
6184;;; (if (x-color-defined-p "lightyellow")
6185;;; "lightyellow"
6186;;; "light yellow"))))
6187;;; ((eq background 'dark)
6188;;; (set-face-background 'font-lock-other-emphasized-face
6189;;; (if (x-color-defined-p "navy")
6190;;; "navy"
6191;;; (if (x-color-defined-p "darkgreen")
6192;;; "darkgreen"
6193;;; "dark green"))))
6194;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6195;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6196;;; (copy-face 'bold 'font-lock-emphasized-face)
6197;;; (cond
6198;;; ((eq background 'light)
6199;;; (set-face-background 'font-lock-emphasized-face
6200;;; (if (x-color-defined-p "lightyellow2")
6201;;; "lightyellow2"
6202;;; "lightyellow")))
6203;;; ((eq background 'dark)
6204;;; (set-face-background 'font-lock-emphasized-face
6205;;; (if (x-color-defined-p "navy")
6206;;; "navy"
6207;;; (if (x-color-defined-p "darkgreen")
6208;;; "darkgreen"
6209;;; "dark green"))))
6210;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
db133cb6 6211 (if (cperl-is-face 'font-lock-variable-name-face) nil
f83d2997 6212 (copy-face 'italic 'font-lock-variable-name-face))
db133cb6 6213 (if (cperl-is-face 'font-lock-constant-face) nil
883212ce 6214 (copy-face 'italic 'font-lock-constant-face))))
f83d2997 6215 (setq cperl-faces-init t))
5bd52f0e 6216 (error (message "cperl-init-faces (ignored): %s" errs))))
f83d2997
KH
6217
6218
6219(defun cperl-ps-print-init ()
6220 "Initialization of `ps-print' components for faces used in CPerl."
5bd52f0e
RS
6221 (eval-after-load "ps-print"
6222 '(setq ps-bold-faces
5c8b7eaf 6223 ;; font-lock-variable-name-face
5bd52f0e 6224 ;; font-lock-constant-face
4ab89e7b 6225 (append '(cperl-array-face cperl-hash-face)
5bd52f0e
RS
6226 ps-bold-faces)
6227 ps-italic-faces
6228 ;; font-lock-constant-face
4ab89e7b 6229 (append '(cperl-nonoverridable-face cperl-hash-face)
5bd52f0e
RS
6230 ps-italic-faces)
6231 ps-underlined-faces
6232 ;; font-lock-type-face
4ab89e7b 6233 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
5bd52f0e
RS
6234 ps-underlined-faces))))
6235
6236(defvar ps-print-face-extension-alist)
6237
6238(defun cperl-ps-print (&optional file)
6239 "Pretty-print in CPerl style.
6240If optional argument FILE is an empty string, prints to printer, otherwise
6241to the file FILE. If FILE is nil, prompts for a file name.
6242
6243Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6244 (interactive)
5c8b7eaf
SS
6245 (or file
6246 (setq file (read-from-minibuffer
5bd52f0e
RS
6247 "Print to file (if empty - to printer): "
6248 (concat (buffer-file-name) ".ps")
6249 nil nil 'file-name-history)))
6250 (or (> (length file) 0)
6251 (setq file nil))
6252 (require 'ps-print) ; To get ps-print-face-extension-alist
6253 (let ((ps-print-color-p t)
6254 (ps-print-face-extension-alist ps-print-face-extension-alist))
6255 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6256 (ps-print-buffer-with-faces file)))
6257
6258;;; (defun cperl-ps-print-init ()
6259;;; "Initialization of `ps-print' components for faces used in CPerl."
6260;;; ;; Guard against old versions
6261;;; (defvar ps-underlined-faces nil)
6262;;; (defvar ps-bold-faces nil)
6263;;; (defvar ps-italic-faces nil)
6264;;; (setq ps-bold-faces
6265;;; (append '(font-lock-emphasized-face
4ab89e7b 6266;;; cperl-array-face
5c8b7eaf
SS
6267;;; font-lock-keyword-face
6268;;; font-lock-variable-name-face
6269;;; font-lock-constant-face
6270;;; font-lock-reference-face
5bd52f0e 6271;;; font-lock-other-emphasized-face
4ab89e7b 6272;;; cperl-hash-face)
5bd52f0e
RS
6273;;; ps-bold-faces))
6274;;; (setq ps-italic-faces
4ab89e7b 6275;;; (append '(cperl-nonoverridable-face
5c8b7eaf
SS
6276;;; font-lock-constant-face
6277;;; font-lock-reference-face
5bd52f0e 6278;;; font-lock-other-emphasized-face
4ab89e7b 6279;;; cperl-hash-face)
5bd52f0e
RS
6280;;; ps-italic-faces))
6281;;; (setq ps-underlined-faces
6282;;; (append '(font-lock-emphasized-face
4ab89e7b 6283;;; cperl-array-face
5bd52f0e 6284;;; font-lock-other-emphasized-face
4ab89e7b
SM
6285;;; cperl-hash-face
6286;;; cperl-nonoverridable-face font-lock-type-face)
5bd52f0e
RS
6287;;; ps-underlined-faces))
6288;;; (cons 'font-lock-type-face ps-underlined-faces))
f83d2997
KH
6289
6290
6291(if (cperl-enable-font-lock) (cperl-windowed-init))
6292
db133cb6 6293(defconst cperl-styles-entries
5c8b7eaf
SS
6294 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6295 cperl-label-offset cperl-extra-newline-before-brace
4ab89e7b 6296 cperl-extra-newline-before-brace-multiline
bab27c0c 6297 cperl-merge-trailing-else
db133cb6
RS
6298 cperl-continued-statement-offset))
6299
4ab89e7b
SM
6300(defconst cperl-style-examples
6301"##### Numbers etc are: cperl-indent-level cperl-brace-offset
6302##### cperl-continued-brace-offset cperl-label-offset
6303##### cperl-continued-statement-offset
6304##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6305
6306########### (Do not forget cperl-extra-newline-before-brace-multiline)
6307
6308### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6309if (foo) {
6310 bar
6311 baz;
6312 label:
6313 {
6314 boon;
6315 }
6316} else {
6317 stop;
6318}
6319
6320### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6321if (foo) {
6322 bar
6323 baz;
6324 label:
6325 {
6326 boon;
6327 }
6328} else {
6329 stop;
6330}
6331
6332### GNU 2/0/0/-2/2/nil/t
6333if (foo)
6334 {
6335 bar
6336 baz;
6337 label:
6338 {
6339 boon;
6340 }
6341 }
6342else
6343 {
6344 stop;
6345 }
6346
6347### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6348if (foo)
6349{
6350 bar
6351 baz;
6352 label:
6353 {
6354 boon;
6355 }
6356}
6357else
6358{
6359 stop;
6360}
6361
6362### BSD (=C++, but will not change preexisting merge-trailing-else
6363### and extra-newline-before-brace ) 4/0/-4/-4/4
6364if (foo)
6365{
6366 bar
6367 baz;
6368 label:
6369 {
6370 boon;
6371 }
6372}
6373else
6374{
6375 stop;
6376}
6377
6378### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6379### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6380if (foo)
6381{
6382 bar
6383 baz;
6384 label:
6385 {
6386 boon;
6387 }
6388}
6389else
6390{
6391 stop;
6392}
6393
6394### Whitesmith (=PerlStyle, but will not change preexisting
6395### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6396if (foo)
6397 {
6398 bar
6399 baz;
6400 label:
6401 {
6402 boon;
6403 }
6404 }
6405else
6406 {
6407 stop;
6408 }
6409"
6410"Examples of if/else with different indent styles (with v4.23).")
6411
db133cb6 6412(defconst cperl-style-alist
4ab89e7b 6413 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
db133cb6
RS
6414 (cperl-indent-level . 2)
6415 (cperl-brace-offset . 0)
6416 (cperl-continued-brace-offset . 0)
6417 (cperl-label-offset . -2)
4ab89e7b 6418 (cperl-continued-statement-offset . 2)
db133cb6 6419 (cperl-extra-newline-before-brace . nil)
4ab89e7b
SM
6420 (cperl-extra-newline-before-brace-multiline . nil)
6421 (cperl-merge-trailing-else . t))
6422
83261a2f 6423 ("PerlStyle" ; CPerl with 4 as indent
db133cb6
RS
6424 (cperl-indent-level . 4)
6425 (cperl-brace-offset . 0)
6426 (cperl-continued-brace-offset . 0)
6427 (cperl-label-offset . -4)
4ab89e7b 6428 (cperl-continued-statement-offset . 4)
db133cb6 6429 (cperl-extra-newline-before-brace . nil)
4ab89e7b
SM
6430 (cperl-extra-newline-before-brace-multiline . nil)
6431 (cperl-merge-trailing-else . t))
6432
db133cb6
RS
6433 ("GNU"
6434 (cperl-indent-level . 2)
6435 (cperl-brace-offset . 0)
6436 (cperl-continued-brace-offset . 0)
6437 (cperl-label-offset . -2)
4ab89e7b 6438 (cperl-continued-statement-offset . 2)
db133cb6 6439 (cperl-extra-newline-before-brace . t)
4ab89e7b
SM
6440 (cperl-extra-newline-before-brace-multiline . t)
6441 (cperl-merge-trailing-else . nil))
6442
db133cb6
RS
6443 ("K&R"
6444 (cperl-indent-level . 5)
6445 (cperl-brace-offset . 0)
6446 (cperl-continued-brace-offset . -5)
6447 (cperl-label-offset . -5)
4ab89e7b 6448 (cperl-continued-statement-offset . 5)
db133cb6 6449 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6450 ;;(cperl-extra-newline-before-brace-multiline . nil)
6451 (cperl-merge-trailing-else . nil))
6452
db133cb6
RS
6453 ("BSD"
6454 (cperl-indent-level . 4)
6455 (cperl-brace-offset . 0)
6456 (cperl-continued-brace-offset . -4)
6457 (cperl-label-offset . -4)
4ab89e7b 6458 (cperl-continued-statement-offset . 4)
db133cb6 6459 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6460 ;;(cperl-extra-newline-before-brace-multiline . nil)
6461 ;;(cperl-merge-trailing-else . nil) ; ???
6462 )
6463
db133cb6
RS
6464 ("C++"
6465 (cperl-indent-level . 4)
6466 (cperl-brace-offset . 0)
6467 (cperl-continued-brace-offset . -4)
6468 (cperl-label-offset . -4)
6469 (cperl-continued-statement-offset . 4)
4ab89e7b
SM
6470 (cperl-extra-newline-before-brace . t)
6471 (cperl-extra-newline-before-brace-multiline . t)
6472 (cperl-merge-trailing-else . nil))
6473
db133cb6
RS
6474 ("Whitesmith"
6475 (cperl-indent-level . 4)
6476 (cperl-brace-offset . 0)
6477 (cperl-continued-brace-offset . 0)
6478 (cperl-label-offset . -4)
4ab89e7b 6479 (cperl-continued-statement-offset . 4)
db133cb6 6480 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6481 ;;(cperl-extra-newline-before-brace-multiline . nil)
6482 ;;(cperl-merge-trailing-else . nil) ; ???
6483 )
6484 ("Current"))
6485 "List of variables to set to get a particular indentation style.
6486Should be used via `cperl-set-style' or via Perl menu.
6487
6488See examples in `cperl-style-examples'.")
db133cb6 6489
f83d2997 6490(defun cperl-set-style (style)
f94a632a 6491 "Set CPerl mode variables to use one of several different indentation styles.
f83d2997 6492The arguments are a string representing the desired style.
5c8b7eaf 6493The list of styles is in `cperl-style-alist', available styles
4ab89e7b 6494are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
db133cb6
RS
6495
6496The current value of style is memorized (unless there is a memorized
6497data already), may be restored by `cperl-set-style-back'.
6498
fe3c5669 6499Choosing \"Current\" style will not change style, so this may be used for
4ab89e7b 6500side-effect of memorizing only. Examples in `cperl-style-examples'."
5c8b7eaf 6501 (interactive
15ca5699 6502 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
db133cb6 6503 cperl-style-alist)))
f83d2997 6504 (list (completing-read "Enter style: " list nil 'insist))))
db133cb6
RS
6505 (or cperl-old-style
6506 (setq cperl-old-style
6507 (mapcar (function
6508 (lambda (name)
6509 (cons name (eval name))))
6510 cperl-styles-entries)))
6511 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
f83d2997
KH
6512 (while style
6513 (setq setting (car style) style (cdr style))
db133cb6
RS
6514 (set (car setting) (cdr setting)))))
6515
6516(defun cperl-set-style-back ()
810fb442 6517 "Restore a style memorized by `cperl-set-style'."
db133cb6
RS
6518 (interactive)
6519 (or cperl-old-style (error "The style was not changed"))
6520 (let (setting)
6521 (while cperl-old-style
5c8b7eaf 6522 (setq setting (car cperl-old-style)
db133cb6
RS
6523 cperl-old-style (cdr cperl-old-style))
6524 (set (car setting) (cdr setting)))))
f83d2997
KH
6525
6526(defun cperl-check-syntax ()
6527 (interactive)
6528 (require 'mode-compile)
db133cb6
RS
6529 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6530 (eval '(mode-compile)))) ; Avoid a warning
f83d2997
KH
6531
6532(defun cperl-info-buffer (type)
6533 ;; Returns buffer with documentation. Creates if missing.
6534 ;; If TYPE, this vars buffer.
6535 ;; Special care is taken to not stomp over an existing info buffer
6536 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6537 (info (get-buffer bname))
6538 (oldbuf (get-buffer "*info*")))
6539 (if info info
6540 (save-window-excursion
6541 ;; Get Info running
6542 (require 'info)
6543 (cond (oldbuf
6544 (set-buffer oldbuf)
6545 (rename-buffer "*info-perl-tmp*")))
6546 (save-window-excursion
6547 (info))
6548 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6549 (set-buffer "*info*")
6550 (rename-buffer bname)
6551 (cond (oldbuf
6552 (set-buffer "*info-perl-tmp*")
6553 (rename-buffer "*info*")
6554 (set-buffer bname)))
029cb4d5 6555 (make-local-variable 'window-min-height)
f83d2997
KH
6556 (setq window-min-height 2)
6557 (current-buffer)))))
6558
6559(defun cperl-word-at-point (&optional p)
f94a632a 6560 "Return the word at point or at P."
f83d2997
KH
6561 (save-excursion
6562 (if p (goto-char p))
6563 (or (cperl-word-at-point-hard)
6564 (progn
6565 (require 'etags)
6566 (funcall (or (and (boundp 'find-tag-default-function)
6567 find-tag-default-function)
6568 (get major-mode 'find-tag-default-function)
6569 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6570 ;; automatically used within `find-tag-default':
6571 'find-tag-default))))))
6572
6573(defun cperl-info-on-command (command)
f94a632a 6574 "Show documentation for Perl command COMMAND in other window.
f83d2997
KH
6575If perl-info buffer is shown in some frame, uses this frame.
6576Customized by setting variables `cperl-shrink-wrap-info-frame',
6577`cperl-max-help-size'."
5c8b7eaf 6578 (interactive
f83d2997 6579 (let* ((default (cperl-word-at-point))
5c8b7eaf 6580 (read (read-string
83261a2f
SM
6581 (format "Find doc for Perl function (default %s): "
6582 default))))
5c8b7eaf 6583 (list (if (equal read "")
83261a2f
SM
6584 default
6585 read))))
f83d2997
KH
6586
6587 (let ((buffer (current-buffer))
6588 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6589 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6590 max-height char-height buf-list)
6591 (if (string-match "^-[a-zA-Z]$" command)
6592 (setq cmd-desc "^-X[ \t\n]"))
6593 (setq isvar (string-match "^[$@%]" command)
6594 buf (cperl-info-buffer isvar)
6595 iniwin (selected-window)
6596 fr1 (window-frame iniwin))
6597 (set-buffer buf)
fc49c9c6 6598 (goto-char (point-min))
5c8b7eaf 6599 (or isvar
f83d2997
KH
6600 (progn (re-search-forward "^-X[ \t\n]")
6601 (forward-line -1)))
6602 (if (re-search-forward cmd-desc nil t)
6603 (progn
6604 ;; Go back to beginning of the group (ex, for qq)
6605 (if (re-search-backward "^[ \t\n\f]")
6606 (forward-line 1))
6607 (beginning-of-line)
5c8b7eaf 6608 ;; Get some of
f83d2997
KH
6609 (setq pos (point)
6610 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6611 (while (and (not win) buf-list)
6612 (setq win (get-buffer-window (car buf-list) t))
6613 (setq buf-list (cdr buf-list)))
6614 (or (not win)
6615 (eq (window-buffer win) buf)
6616 (set-window-buffer win buf))
6617 (and win (setq fr2 (window-frame win)))
6618 (if (or (not fr2) (eq fr1 fr2))
6619 (pop-to-buffer buf)
6620 (special-display-popup-frame buf) ; Make it visible
6621 (select-window win))
6622 (goto-char pos) ; Needed (?!).
6623 ;; Resize
6624 (setq iniheight (window-height)
6625 frheight (frame-height)
6626 not-loner (< iniheight (1- frheight))) ; Are not alone
5c8b7eaf 6627 (cond ((if not-loner cperl-max-help-size
f83d2997 6628 cperl-shrink-wrap-info-frame)
5c8b7eaf
SS
6629 (setq height
6630 (+ 2
6631 (count-lines
6632 pos
f83d2997
KH
6633 (save-excursion
6634 (if (re-search-forward
6635 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6636 (match-beginning 0) (point-max)))))
5c8b7eaf 6637 max-height
f83d2997
KH
6638 (if not-loner
6639 (/ (* (- frheight 3) cperl-max-help-size) 100)
6640 (setq char-height (frame-char-height))
6641 ;; Non-functioning under OS/2:
6642 (if (eq char-height 1) (setq char-height 18))
6643 ;; Title, menubar, + 2 for slack
d431decb 6644 (- (/ (display-pixel-height) char-height) 4)))
f83d2997
KH
6645 (if (> height max-height) (setq height max-height))
6646 ;;(message "was %s doing %s" iniheight height)
6647 (if not-loner
6648 (enlarge-window (- height iniheight))
6649 (set-frame-height (window-frame win) (1+ height)))))
6650 (set-window-start (selected-window) pos))
6651 (message "No entry for %s found." command))
6652 ;;(pop-to-buffer buffer)
6653 (select-window iniwin)))
6654
6655(defun cperl-info-on-current-command ()
029cb4d5 6656 "Show documentation for Perl command at point in other window."
f83d2997
KH
6657 (interactive)
6658 (cperl-info-on-command (cperl-word-at-point)))
6659
6660(defun cperl-imenu-info-imenu-search ()
6661 (if (looking-at "^-X[ \t\n]") nil
6662 (re-search-backward
6663 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6664 (forward-line 1)))
6665
5c8b7eaf 6666(defun cperl-imenu-info-imenu-name ()
f83d2997
KH
6667 (buffer-substring
6668 (match-beginning 1) (match-end 1)))
6669
6670(defun cperl-imenu-on-info ()
4ab89e7b
SM
6671 "Shows imenu for Perl Info Buffer.
6672Opens Perl Info buffer if needed."
f83d2997
KH
6673 (interactive)
6674 (let* ((buffer (current-buffer))
6675 imenu-create-index-function
5c8b7eaf
SS
6676 imenu-prev-index-position-function
6677 imenu-extract-index-name-function
f83d2997
KH
6678 (index-item (save-restriction
6679 (save-window-excursion
6680 (set-buffer (cperl-info-buffer nil))
5c8b7eaf 6681 (setq imenu-create-index-function
f83d2997
KH
6682 'imenu-default-create-index-function
6683 imenu-prev-index-position-function
6684 'cperl-imenu-info-imenu-search
6685 imenu-extract-index-name-function
6686 'cperl-imenu-info-imenu-name)
6687 (imenu-choose-buffer-index)))))
6688 (and index-item
6689 (progn
6690 (push-mark)
6691 (pop-to-buffer "*info-perl*")
6692 (cond
6693 ((markerp (cdr index-item))
6694 (goto-char (marker-position (cdr index-item))))
6695 (t
6696 (goto-char (cdr index-item))))
6697 (set-window-start (selected-window) (point))
6698 (pop-to-buffer buffer)))))
6699
6700(defun cperl-lineup (beg end &optional step minshift)
6701 "Lineup construction in a region.
6702Beginning of region should be at the start of a construction.
6703All first occurrences of this construction in the lines that are
6704partially contained in the region are lined up at the same column.
6705
6706MINSHIFT is the minimal amount of space to insert before the construction.
6707STEP is the tabwidth to position constructions.
029cb4d5 6708If STEP is nil, `cperl-lineup-step' will be used
15ca5699 6709\(or `cperl-indent-level', if `cperl-lineup-step' is nil).
f83d2997
KH
6710Will not move the position at the start to the left."
6711 (interactive "r")
4ab89e7b 6712 (let (search col tcol seen b)
f83d2997
KH
6713 (save-excursion
6714 (goto-char end)
6715 (end-of-line)
6716 (setq end (point-marker))
6717 (goto-char beg)
6718 (skip-chars-forward " \t\f")
6719 (setq beg (point-marker))
6720 (indent-region beg end nil)
6721 (goto-char beg)
6722 (setq col (current-column))
6723 (if (looking-at "[a-zA-Z0-9_]")
6724 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6725 (setq search
5c8b7eaf
SS
6726 (concat "\\<"
6727 (regexp-quote
f83d2997
KH
6728 (buffer-substring (match-beginning 0)
6729 (match-end 0))) "\\>"))
6730 (error "Cannot line up in a middle of the word"))
6731 (if (looking-at "$")
6732 (error "Cannot line up end of line"))
6733 (setq search (regexp-quote (char-to-string (following-char)))))
6734 (setq step (or step cperl-lineup-step cperl-indent-level))
6735 (or minshift (setq minshift 1))
6736 (while (progn
6737 (beginning-of-line 2)
5c8b7eaf 6738 (and (< (point) end)
f83d2997
KH
6739 (re-search-forward search end t)
6740 (goto-char (match-beginning 0))))
6741 (setq tcol (current-column) seen t)
6742 (if (> tcol col) (setq col tcol)))
6743 (or seen
6744 (error "The construction to line up occurred only once"))
6745 (goto-char beg)
6746 (setq col (+ col minshift))
6747 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5c8b7eaf 6748 (while
f83d2997 6749 (progn
4ab89e7b 6750 (cperl-make-indent col)
5c8b7eaf
SS
6751 (beginning-of-line 2)
6752 (and (< (point) end)
f83d2997
KH
6753 (re-search-forward search end t)
6754 (goto-char (match-beginning 0)))))))) ; No body
6755
4ab89e7b 6756(defun cperl-etags (&optional add all files) ;; NOT USED???
f83d2997
KH
6757 "Run etags with appropriate options for Perl files.
6758If optional argument ALL is `recursive', will process Perl files
6759in subdirectories too."
6760 (interactive)
6761 (let ((cmd "etags")
4ab89e7b
SM
6762 (args '("-l" "none" "-r"
6763 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6764 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6765 "-r"
6766 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6767 "-r"
6768 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
f83d2997
KH
6769 res)
6770 (if add (setq args (cons "-a" args)))
6771 (or files (setq files (list buffer-file-name)))
6772 (cond
6773 ((eq all 'recursive)
6774 ;;(error "Not implemented: recursive")
5c8b7eaf 6775 (setq args (append (list "-e"
f83d2997
KH
6776 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6777 use File::Find;
6778 find(\\&wanted, '.');
5c8b7eaf 6779 exec @ARGV;"
f83d2997
KH
6780 cmd) args)
6781 cmd "perl"))
5c8b7eaf 6782 (all
f83d2997 6783 ;;(error "Not implemented: all")
5c8b7eaf 6784 (setq args (append (list "-e"
f83d2997 6785 "push @ARGV, <*.PL *.pl *.pm>;
5c8b7eaf 6786 exec @ARGV;"
f83d2997
KH
6787 cmd) args)
6788 cmd "perl"))
6789 (t
6790 (setq args (append args files))))
6791 (setq res (apply 'call-process cmd nil nil nil args))
6792 (or (eq res 0)
6793 (message "etags returned \"%s\"" res))))
6794
6795(defun cperl-toggle-auto-newline ()
6796 "Toggle the state of `cperl-auto-newline'."
6797 (interactive)
6798 (setq cperl-auto-newline (not cperl-auto-newline))
5c8b7eaf 6799 (message "Newlines will %sbe auto-inserted now."
f83d2997
KH
6800 (if cperl-auto-newline "" "not ")))
6801
6802(defun cperl-toggle-abbrev ()
6803 "Toggle the state of automatic keyword expansion in CPerl mode."
6804 (interactive)
6805 (abbrev-mode (if abbrev-mode 0 1))
5c8b7eaf 6806 (message "Perl control structure will %sbe auto-inserted now."
f83d2997
KH
6807 (if abbrev-mode "" "not ")))
6808
6809
6810(defun cperl-toggle-electric ()
6811 "Toggle the state of parentheses doubling in CPerl mode."
6812 (interactive)
6813 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5c8b7eaf 6814 (message "Parentheses will %sbe auto-doubled now."
f83d2997
KH
6815 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6816
db133cb6 6817(defun cperl-toggle-autohelp ()
f739b53b
SM
6818 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6819Delay of auto-help controlled by `cperl-lazy-help-time'."
db133cb6
RS
6820 (interactive)
6821 (if (fboundp 'run-with-idle-timer)
6822 (progn
6823 (if cperl-lazy-installed
f739b53b 6824 (cperl-lazy-unstall)
db133cb6 6825 (cperl-lazy-install))
5c8b7eaf 6826 (message "Perl help messages will %sbe automatically shown now."
db133cb6
RS
6827 (if cperl-lazy-installed "" "not ")))
6828 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6829
6830(defun cperl-toggle-construct-fix ()
6831 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6832 (interactive)
5c8b7eaf 6833 (setq cperl-indent-region-fix-constructs
5bd52f0e
RS
6834 (if cperl-indent-region-fix-constructs
6835 nil
6836 1))
5c8b7eaf 6837 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
db133cb6
RS
6838 (if cperl-indent-region-fix-constructs "" "not ")))
6839
4ab89e7b
SM
6840(defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6841 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6842Nonpositive numeric argument disables debugging messages. The message
6843summarizes which regions it was decided to rescan for syntactic constructs.
6844
6845The message looks like this:
6846
6847 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6848
6849Numbers are character positions in the buffer. REQ provides the range to
6850rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6851for correct operation it should start and end outside any special syntactic
6852construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6853by CPerl."
6854 (interactive "P")
6855 (or arg
cb5bf6ba 6856 (setq arg (if (eq cperl-syntaxify-by-font-lock
4ab89e7b
SM
6857 (if backtrace 'backtrace 'message)) 0 1)))
6858 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6859 (setq cperl-syntaxify-by-font-lock arg)
6860 (message "Debugging messages of syntax unwind %sabled."
6861 (if (eq arg t) "dis" "en")))
6862
f83d2997
KH
6863;;;; Tags file creation.
6864
6865(defvar cperl-tmp-buffer " *cperl-tmp*")
6866
6867(defun cperl-setup-tmp-buf ()
6868 (set-buffer (get-buffer-create cperl-tmp-buffer))
6869 (set-syntax-table cperl-mode-syntax-table)
6870 (buffer-disable-undo)
6871 (auto-fill-mode 0)
6872 (if cperl-use-syntax-table-text-property-for-tags
6873 (progn
029cb4d5 6874 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997
KH
6875 ;; Do not introduce variable if not needed, we check it!
6876 (set 'parse-sexp-lookup-properties t))))
6877
47e83968
GM
6878;; Copied from imenu-example--name-and-position.
6879(defvar imenu-use-markers)
6880
6881(defun cperl-imenu-name-and-position ()
6882 "Return the current/previous sexp and its (beginning) location.
6883Does not move point."
6884 (save-excursion
6885 (forward-sexp -1)
6886 (let ((beg (if imenu-use-markers (point-marker) (point)))
6887 (end (progn (forward-sexp) (point))))
6888 (cons (buffer-substring beg end)
6889 beg))))
6890
f83d2997 6891(defun cperl-xsub-scan ()
f83d2997 6892 (require 'imenu)
5c8b7eaf 6893 (let ((index-alist '())
f83d2997
KH
6894 (prev-pos 0) index index1 name package prefix)
6895 (goto-char (point-min))
f83d2997
KH
6896 ;; Search for the function
6897 (progn ;;save-match-data
6898 (while (re-search-forward
6899 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6900 nil t)
f83d2997 6901 (cond
83261a2f 6902 ((match-beginning 2) ; SECTION
f83d2997
KH
6903 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6904 (goto-char (match-beginning 0))
6905 (skip-chars-forward " \t")
6906 (forward-char 1)
6907 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6908 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6909 (setq prefix nil)))
6910 ((not package) nil) ; C language section
6911 ((match-beginning 3) ; XSUB
6912 (goto-char (1+ (match-beginning 3)))
47e83968 6913 (setq index (cperl-imenu-name-and-position))
f83d2997
KH
6914 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6915 (if (and prefix (string-match (concat "^" prefix) name))
6916 (setq name (substring name (length prefix))))
6917 (cond ((string-match "::" name) nil)
6918 (t
6919 (setq index1 (cons (concat package "::" name) (cdr index)))
6920 (push index1 index-alist)))
6921 (setcar index name)
6922 (push index index-alist))
6923 (t ; BOOT: section
6924 ;; (beginning-of-line)
47e83968 6925 (setq index (cperl-imenu-name-and-position))
f83d2997
KH
6926 (setcar index (concat package "::BOOT:"))
6927 (push index index-alist)))))
f83d2997
KH
6928 index-alist))
6929
6c389151
SM
6930(defvar cperl-unreadable-ok nil)
6931
6932(defun cperl-find-tags (ifile xs topdir)
83261a2f
SM
6933 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6934 (cperl-pod-here-fontify nil) f file)
f83d2997
KH
6935 (save-excursion
6936 (if b (set-buffer b)
83261a2f 6937 (cperl-setup-tmp-buf))
f83d2997 6938 (erase-buffer)
6c389151
SM
6939 (condition-case err
6940 (setq file (car (insert-file-contents ifile)))
6941 (error (if cperl-unreadable-ok nil
6942 (if (y-or-n-p
6943 (format "File %s unreadable. Continue? " ifile))
6944 (setq cperl-unreadable-ok t)
6945 (error "Aborting: unreadable file %s" ifile)))))
a1506d29 6946 (if (not file)
6c389151 6947 (message "Unreadable file %s" ifile)
83261a2f
SM
6948 (message "Scanning file %s ..." file)
6949 (if (and cperl-use-syntax-table-text-property-for-tags
6950 (not xs))
6951 (condition-case err ; after __END__ may have garbage
6952 (cperl-find-pods-heres nil nil noninteractive)
6953 (error (message "While scanning for syntax: %s" err))))
6954 (if xs
6955 (setq lst (cperl-xsub-scan))
6956 (setq ind (cperl-imenu--create-perl-index))
6957 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6958 (setq lst
6959 (mapcar
6960 (function
6961 (lambda (elt)
6962 (cond ((string-match "^[_a-zA-Z]" (car elt))
6963 (goto-char (cdr elt))
6964 (beginning-of-line) ; pos should be of the start of the line
6965 (list (car elt)
6966 (point)
6967 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6968 (buffer-substring (progn
6969 (goto-char (cdr elt))
6970 ;; After name now...
6971 (or (eolp) (forward-char 1))
6972 (point))
6973 (progn
6974 (beginning-of-line)
6975 (point))))))))
6976 lst))
6977 (erase-buffer)
6978 (while lst
6979 (setq elt (car lst) lst (cdr lst))
6980 (if elt
6981 (progn
6982 (insert (elt elt 3)
6983 127
6984 (if (string-match "^package " (car elt))
6985 (substring (car elt) 8)
6986 (car elt) )
6987 1
6988 (number-to-string (elt elt 2)) ; Line
6989 ","
6990 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6991 "\n")
6992 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6993 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
6994 (elt elt 3)))
6995 ;; Need to insert the name without package as well
15ca5699 6996 (setq lst (cons (cons (substring (elt elt 3)
83261a2f
SM
6997 (match-beginning 1)
6998 (match-end 1))
6999 (cdr elt))
7000 lst))))))
7001 (setq pos (point))
7002 (goto-char 1)
7003 (setq rel file)
7004 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7005 (set-text-properties 0 (length rel) nil rel)
7006 (and (equal topdir (substring rel 0 (length topdir)))
7007 (setq rel (substring file (length topdir))))
7008 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7009 (setq ret (buffer-substring 1 (point-max)))
7010 (erase-buffer)
7011 (or noninteractive
7012 (message "Scanning file %s finished" file))
7013 ret))))
f83d2997
KH
7014
7015(defun cperl-add-tags-recurse-noxs ()
4ab89e7b 7016 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
f83d2997
KH
7017Use as
7018 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
4ab89e7b 7019 -f cperl-add-tags-recurse-noxs
f83d2997
KH
7020"
7021 (cperl-write-tags nil nil t t nil t))
7022
4ab89e7b
SM
7023(defun cperl-add-tags-recurse-noxs-fullpath ()
7024 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7025Writes down fullpath, so TAGS is relocatable (but if the build directory
7026is relocated, the file TAGS inside it breaks). Use as
7027 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7028 -f cperl-add-tags-recurse-noxs-fullpath
7029"
7030 (cperl-write-tags nil nil t t nil t ""))
7031
f83d2997
KH
7032(defun cperl-add-tags-recurse ()
7033 "Add to TAGS file data for Perl files in the current directory and kids.
7034Use as
7035 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 7036 -f cperl-add-tags-recurse
f83d2997
KH
7037"
7038 (cperl-write-tags nil nil t t))
7039
7040(defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7041 ;; If INBUFFER, do not select buffer, and do not save
7042 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7043 (require 'etags)
7044 (if file nil
7045 (setq file (if dir default-directory (buffer-file-name)))
7046 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7047 (or topdir
7048 (setq topdir default-directory))
7049 (let ((tags-file-name "TAGS")
72bc50c0 7050 (case-fold-search (and (featurep 'xemacs) (eq system-type 'emx)))
6c389151 7051 xs rel tm)
f83d2997
KH
7052 (save-excursion
7053 (cond (inbuffer nil) ; Already there
7054 ((file-exists-p tags-file-name)
6546555e 7055 (if (featurep 'xemacs)
5bd52f0e 7056 (visit-tags-table-buffer)
83261a2f 7057 (visit-tags-table-buffer tags-file-name)))
f83d2997
KH
7058 (t (set-buffer (find-file-noselect tags-file-name))))
7059 (cond
7060 (dir
7061 (cond ((eq erase 'ignore))
7062 (erase
7063 (erase-buffer)
7064 (setq erase 'ignore)))
a1506d29 7065 (let ((files
6c389151 7066 (condition-case err
a1506d29 7067 (directory-files file t
6c389151
SM
7068 (if recurse nil cperl-scan-files-regexp)
7069 t)
7070 (error
7071 (if cperl-unreadable-ok nil
7072 (if (y-or-n-p
7073 (format "Directory %s unreadable. Continue? " file))
a1506d29 7074 (setq cperl-unreadable-ok t
83261a2f 7075 tm nil) ; Return empty list
6c389151 7076 (error "Aborting: unreadable directory %s" file)))))))
dba01120
GM
7077 (mapc (function
7078 (lambda (file)
7079 (cond
7080 ((string-match cperl-noscan-files-regexp file)
7081 nil)
7082 ((not (file-directory-p file))
7083 (if (string-match cperl-scan-files-regexp file)
7084 (cperl-write-tags file erase recurse nil t noxs topdir)))
7085 ((not recurse) nil)
7086 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7087 files)))
f83d2997
KH
7088 (t
7089 (setq xs (string-match "\\.xs$" file))
7090 (if (not (and xs noxs))
7091 (progn
7092 (cond ((eq erase 'ignore) (goto-char (point-max)))
83261a2f
SM
7093 (erase (erase-buffer))
7094 (t
7095 (goto-char 1)
7096 (setq rel file)
7097 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7098 (set-text-properties 0 (length rel) nil rel)
7099 (and (equal topdir (substring rel 0 (length topdir)))
7100 (setq rel (substring file (length topdir))))
7101 (if (search-forward (concat "\f\n" rel ",") nil t)
7102 (progn
7103 (search-backward "\f\n")
7104 (delete-region (point)
7105 (save-excursion
7106 (forward-char 1)
7107 (if (search-forward "\f\n"
7108 nil 'toend)
7109 (- (point) 2)
7110 (point-max)))))
7111 (goto-char (point-max)))))
f83d2997 7112 (insert (cperl-find-tags file xs topdir))))))
83261a2f
SM
7113 (if inbuffer nil ; Delegate to the caller
7114 (save-buffer 0) ; No backup
f83d2997
KH
7115 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7116 (initialize-new-tags-table))))))
7117
7118(defvar cperl-tags-hier-regexp-list
5c8b7eaf 7119 (concat
f83d2997
KH
7120 "^\\("
7121 "\\(package\\)\\>"
7122 "\\|"
7123 "sub\\>[^\n]+::"
7124 "\\|"
7125 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7126 "\\|"
7127 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7128 "\\)"))
7129
7130(defvar cperl-hierarchy '(() ())
f94a632a 7131 "Global hierarchy of classes.")
f83d2997
KH
7132
7133(defun cperl-tags-hier-fill ()
7134 ;; Suppose we are in a tag table cooked by cperl.
7135 (goto-char 1)
7136 (let (type pack name pos line chunk ord cons1 file str info fileind)
7137 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5c8b7eaf 7138 (setq pos (match-beginning 0)
f83d2997
KH
7139 pack (match-beginning 2))
7140 (beginning-of-line)
7141 (if (looking-at (concat
7142 "\\([^\n]+\\)"
7143 "\C-?"
7144 "\\([^\n]+\\)"
7145 "\C-a"
7146 "\\([0-9]+\\)"
7147 ","
7148 "\\([0-9]+\\)"))
7149 (progn
7150 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7151 name (buffer-substring (match-beginning 2) (match-end 2))
7152 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5bd52f0e 7153 line (buffer-substring (match-beginning 3) (match-end 3))
f83d2997 7154 ord (if pack 1 0)
f83d2997 7155 file (file-of-tag)
5bd52f0e
RS
7156 fileind (format "%s:%s" file line)
7157 ;; Moves to beginning of the next line:
7158 info (cperl-etags-snarf-tag file line))
f83d2997
KH
7159 ;; Move back
7160 (forward-char -1)
7161 ;; Make new member of hierarchy name ==> file ==> pos if needed
7162 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7163 ;; Name known
7164 (setcdr cons1 (cons (cons fileind (vector file info))
7165 (cdr cons1)))
7166 ;; First occurrence of the name, start alist
7167 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5c8b7eaf 7168 (if pack
f83d2997
KH
7169 (setcar (cdr cperl-hierarchy)
7170 (cons cons1 (nth 1 cperl-hierarchy)))
7171 (setcar cperl-hierarchy
7172 (cons cons1 (car cperl-hierarchy)))))))
7173 (end-of-line))))
7174
e8a11b22 7175(declare-function x-popup-menu "menu.c" (position menu))
f2d9c15f 7176
f83d2997
KH
7177(defun cperl-tags-hier-init (&optional update)
7178 "Show hierarchical menu of classes and methods.
7179Finds info about classes by a scan of loaded TAGS files.
7180Supposes that the TAGS files contain fully qualified function names.
7181One may build such TAGS files from CPerl mode menu."
7182 (interactive)
7183 (require 'etags)
7184 (require 'imenu)
7185 (if (or update (null (nth 2 cperl-hierarchy)))
83261a2f
SM
7186 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7187 (or (nthcdr 2 elt)
7188 ;; Only in one file
7189 (setcdr elt (cdr (nth 1 elt)))))))
7190 pack name cons1 to l1 l2 l3 l4 b)
f83d2997
KH
7191 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7192 (setq cperl-hierarchy (list l1 l2 l3))
6546555e 7193 (if (featurep 'xemacs) ; Not checked
5bd52f0e
RS
7194 (progn
7195 (or tags-file-name
7196 ;; Does this work in XEmacs?
8c777c8d
CY
7197 (call-interactively 'visit-tags-table))
7198 (message "Updating list of classes...")
5bd52f0e
RS
7199 (set-buffer (get-file-buffer tags-file-name))
7200 (cperl-tags-hier-fill))
7201 (or tags-table-list
7202 (call-interactively 'visit-tags-table))
dba01120 7203 (mapc
4ab89e7b
SM
7204 (function
7205 (lambda (tagsfile)
5bd52f0e 7206 (message "Updating list of classes... %s" tagsfile)
8c777c8d
CY
7207 (set-buffer (get-file-buffer tagsfile))
7208 (cperl-tags-hier-fill)))
dba01120 7209 tags-table-list)
5bd52f0e 7210 (message "Updating list of classes... postprocessing..."))
dba01120
GM
7211 (mapc remover (car cperl-hierarchy))
7212 (mapc remover (nth 1 cperl-hierarchy))
f83d2997
KH
7213 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7214 (cons "Methods: " (car cperl-hierarchy))))
7215 (cperl-tags-treeify to 1)
7216 (setcar (nthcdr 2 cperl-hierarchy)
7217 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7218 (message "Updating list of classes: done, requesting display...")
7219 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7220 ))
7221 (or (nth 2 cperl-hierarchy)
7222 (error "No items found"))
7223 (setq update
7224;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
83261a2f
SM
7225 (if (if (fboundp 'display-popup-menus-p)
7226 (let ((f 'display-popup-menus-p))
7227 (funcall f))
7228 window-system)
f83d2997
KH
7229 (x-popup-menu t (nth 2 cperl-hierarchy))
7230 (require 'tmm)
7231 (tmm-prompt (nth 2 cperl-hierarchy))))
7232 (if (and update (listp update))
7233 (progn (while (cdr update) (setq update (cdr update)))
7234 (setq update (car update)))) ; Get the last from the list
5c8b7eaf 7235 (if (vectorp update)
f83d2997
KH
7236 (progn
7237 (find-file (elt update 0))
5bd52f0e 7238 (cperl-etags-goto-tag-location (elt update 1))))
f83d2997
KH
7239 (if (eq update -999) (cperl-tags-hier-init t)))
7240
7241(defun cperl-tags-treeify (to level)
7242 ;; cadr of `to' is read-write. On start it is a cons
5c8b7eaf 7243 (let* ((regexp (concat "^\\(" (mapconcat
f83d2997
KH
7244 'identity
7245 (make-list level "[_a-zA-Z0-9]+")
7246 "::")
7247 "\\)\\(::\\)?"))
7248 (packages (cdr (nth 1 to)))
7249 (methods (cdr (nth 2 to)))
7250 l1 head tail cons1 cons2 ord writeto packs recurse
7251 root-packages root-functions ms many_ms same_name ps
7252 (move-deeper
5c8b7eaf 7253 (function
f83d2997
KH
7254 (lambda (elt)
7255 (cond ((and (string-match regexp (car elt))
7256 (or (eq ord 1) (match-end 2)))
7257 (setq head (substring (car elt) 0 (match-end 1))
5c8b7eaf 7258 tail (if (match-end 2) (substring (car elt)
f83d2997
KH
7259 (match-end 2)))
7260 recurse t)
7261 (if (setq cons1 (assoc head writeto)) nil
7262 ;; Need to init new head
7263 (setcdr writeto (cons (list head (list "Packages: ")
7264 (list "Methods: "))
7265 (cdr writeto)))
7266 (setq cons1 (nth 1 writeto)))
7267 (setq cons2 (nth ord cons1)) ; Either packs or meths
7268 (setcdr cons2 (cons elt (cdr cons2))))
7269 ((eq ord 2)
7270 (setq root-functions (cons elt root-functions)))
7271 (t
7272 (setq root-packages (cons elt root-packages))))))))
7273 (setcdr to l1) ; Init to dynamic space
7274 (setq writeto to)
7275 (setq ord 1)
dba01120 7276 (mapc move-deeper packages)
f83d2997 7277 (setq ord 2)
dba01120 7278 (mapc move-deeper methods)
f83d2997 7279 (if recurse
dba01120 7280 (mapc (function (lambda (elt)
f83d2997 7281 (cperl-tags-treeify elt (1+ level))))
dba01120 7282 (cdr to)))
f83d2997 7283 ;;Now clean up leaders with one child only
dba01120
GM
7284 (mapc (function (lambda (elt)
7285 (if (not (and (listp (cdr elt))
7286 (eq (length elt) 2))) nil
7287 (setcar elt (car (nth 1 elt)))
7288 (setcdr elt (cdr (nth 1 elt))))))
7289 (cdr to))
f83d2997
KH
7290 ;; Sort the roots of subtrees
7291 (if (default-value 'imenu-sort-function)
7292 (setcdr to
7293 (sort (cdr to) (default-value 'imenu-sort-function))))
7294 ;; Now add back functions removed from display
dba01120
GM
7295 (mapc (function (lambda (elt)
7296 (setcdr to (cons elt (cdr to)))))
7297 (if (default-value 'imenu-sort-function)
7298 (nreverse
7299 (sort root-functions (default-value 'imenu-sort-function)))
7300 root-functions))
f83d2997 7301 ;; Now add back packages removed from display
dba01120
GM
7302 (mapc (function (lambda (elt)
7303 (setcdr to (cons (cons (concat "package " (car elt))
7304 (cdr elt))
7305 (cdr to)))))
7306 (if (default-value 'imenu-sort-function)
7307 (nreverse
7308 (sort root-packages (default-value 'imenu-sort-function)))
7309 root-packages))))
f83d2997
KH
7310
7311;;;(x-popup-menu t
5c8b7eaf 7312;;; '(keymap "Name1"
f83d2997 7313;;; ("Ret1" "aa")
5c8b7eaf
SS
7314;;; ("Head1" "ab"
7315;;; keymap "Name2"
f83d2997
KH
7316;;; ("Tail1" "x") ("Tail2" "y"))))
7317
7318(defun cperl-list-fold (list name limit)
7319 (let (list1 list2 elt1 (num 0))
7320 (if (<= (length list) limit) list
7321 (setq list1 nil list2 nil)
7322 (while list
5c8b7eaf 7323 (setq num (1+ num)
f83d2997
KH
7324 elt1 (car list)
7325 list (cdr list))
7326 (if (<= num imenu-max-items)
7327 (setq list2 (cons elt1 list2))
7328 (setq list1 (cons (cons name
7329 (nreverse list2))
7330 list1)
7331 list2 (list elt1)
7332 num 1)))
7333 (nreverse (cons (cons name
7334 (nreverse list2))
7335 list1)))))
7336
7337(defun cperl-menu-to-keymap (menu &optional name)
7338 (let (list)
5c8b7eaf
SS
7339 (cons 'keymap
7340 (mapcar
7341 (function
f83d2997
KH
7342 (lambda (elt)
7343 (cond ((listp (cdr elt))
7344 (setq list (cperl-list-fold
7345 (cdr elt) (car elt) imenu-max-items))
7346 (cons nil
7347 (cons (car elt)
7348 (cperl-menu-to-keymap list))))
7349 (t
7350 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7351 (cperl-list-fold menu "Root" imenu-max-items)))))
7352
7353\f
7354(defvar cperl-bad-style-regexp
7355 (mapconcat 'identity
83261a2f 7356 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
15ca5699 7357 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
83261a2f 7358 "\\|")
f83d2997
KH
7359 "Finds places such that insertion of a whitespace may help a lot.")
7360
5c8b7eaf 7361(defvar cperl-not-bad-style-regexp
15ca5699 7362 (mapconcat
83261a2f 7363 'identity
f83d2997
KH
7364 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7365 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7366 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
4ab89e7b 7367 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
5bd52f0e 7368 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
f83d2997
KH
7369 "-[0-9]" ; -5
7370 "\\+\\+" ; ++var
7371 "--" ; --var
7372 ".->" ; a->b
7373 "->" ; a SPACE ->b
7374 "\\[-" ; a[-1]
5bd52f0e 7375 "\\\\[&$@*\\\\]" ; \&func
f83d2997 7376 "^=" ; =head
5bd52f0e
RS
7377 "\\$." ; $|
7378 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
f83d2997
KH
7379 "||"
7380 "&&"
7381 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
83261a2f 7382 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
f83d2997
KH
7383 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7384 ;;"[*/+-|&<.]+="
7385 )
7386 "\\|")
7387 "If matches at the start of match found by `my-bad-c-style-regexp',
7388insertion of a whitespace will not help.")
7389
7390(defvar found-bad)
7391
7392(defun cperl-find-bad-style ()
7393 "Find places in the buffer where insertion of a whitespace may help.
7394Prompts user for insertion of spaces.
7395Currently it is tuned to C and Perl syntax."
7396 (interactive)
7397 (let (found-bad (p (point)))
7398 (setq last-nonmenu-event 13) ; To disable popup
4ab89e7b 7399 (goto-char (point-min))
f83d2997 7400 (map-y-or-n-p "Insert space here? "
83261a2f 7401 (lambda (arg) (insert " "))
f83d2997 7402 'cperl-next-bad-style
5c8b7eaf 7403 '("location" "locations" "insert a space into")
f83d2997
KH
7404 '((?\C-r (lambda (arg)
7405 (let ((buffer-quit-function
7406 'exit-recursive-edit))
7407 (message "Exit with Esc Esc")
7408 (recursive-edit)
7409 t)) ; Consider acted upon
5c8b7eaf 7410 "edit, exit with Esc Esc")
f83d2997
KH
7411 (?e (lambda (arg)
7412 (let ((buffer-quit-function
7413 'exit-recursive-edit))
7414 (message "Exit with Esc Esc")
7415 (recursive-edit)
7416 t)) ; Consider acted upon
7417 "edit, exit with Esc Esc"))
7418 t)
7419 (if found-bad (goto-char found-bad)
7420 (goto-char p)
7421 (message "No appropriate place found"))))
7422
7423(defun cperl-next-bad-style ()
7424 (let (p (not-found t) (point (point)) found)
7425 (while (and not-found
7426 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7427 (setq p (point))
7428 (goto-char (match-beginning 0))
7429 (if (or
7430 (looking-at cperl-not-bad-style-regexp)
7431 ;; Check for a < -b and friends
7432 (and (eq (following-char) ?\-)
7433 (save-excursion
7434 (skip-chars-backward " \t\n")
07cb2aa3 7435 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
f83d2997
KH
7436 ;; Now check for syntax type
7437 (save-match-data
7438 (setq found (point))
7439 (beginning-of-defun)
7440 (let ((pps (parse-partial-sexp (point) found)))
7441 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7442 (goto-char (match-end 0))
7443 (goto-char (1- p))
7444 (setq not-found nil
7445 found-bad found)))
7446 (not not-found)))
7447
f1d851ae 7448\f
f83d2997 7449;;; Getting help
5c8b7eaf 7450(defvar cperl-have-help-regexp
f83d2997
KH
7451 ;;(concat "\\("
7452 (mapconcat
7453 'identity
83261a2f 7454 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
f83d2997
KH
7455 "[$@]\\^[a-zA-Z]" ; Special variable
7456 "[$@][^ \n\t]" ; Special variable
7457 "-[a-zA-Z]" ; File test
7458 "\\\\[a-zA-Z0]" ; Special chars
83261a2f 7459 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
f83d2997
KH
7460 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7461 "[a-zA-Z_0-9:]+" ; symbol or number
7462 "x="
83261a2f 7463 "#!")
f83d2997 7464 ;;"\\)\\|\\("
83261a2f
SM
7465 "\\|")
7466 ;;"\\)"
7467 ;;)
f83d2997
KH
7468 "Matches places in the buffer we can find help for.")
7469
7470(defvar cperl-message-on-help-error t)
7471(defvar cperl-help-from-timer nil)
7472
7473(defun cperl-word-at-point-hard ()
7474 ;; Does not save-excursion
7475 ;; Get to the something meaningful
7476 (or (eobp) (eolp) (forward-char 1))
5c8b7eaf 7477 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
e180ab9f 7478 (point-at-bol)
f83d2997
KH
7479 'to-beg)
7480 ;; (cond
7481 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7482 ;; (skip-chars-backward " \n\t\r({[]});,")
7483 ;; (or (bobp) (backward-char 1))))
7484 ;; Try to backtrace
7485 (cond
7486 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7487 (skip-chars-backward "a-zA-Z0-9_:")
5c8b7eaf 7488 (cond
f83d2997
KH
7489 ((and (eq (preceding-char) ?^) ; $^I
7490 (eq (char-after (- (point) 2)) ?\$))
7491 (forward-char -2))
7492 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7493 (forward-char -1))
7494 ((and (eq (preceding-char) ?\=)
7495 (eq (current-column) 1))
7496 (forward-char -1))) ; =head1
7497 (if (and (eq (preceding-char) ?\<)
7498 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7499 (forward-char -1)))
7500 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7501 (forward-char -1))
7502 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7503 (forward-char -1))
7504 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7505 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7506 (cond
7507 ((and (eq (preceding-char) ?\$)
7508 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7509 (forward-char -1))
7510 ((and (eq (following-char) ?\>)
7511 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7512 (save-excursion
7513 (forward-sexp -1)
7514 (and (eq (preceding-char) ?\<)
7515 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7516 (search-backward "<"))))
7517 ((and (eq (following-char) ?\$)
7518 (eq (preceding-char) ?\<)
7519 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7520 (forward-char -1)))
7521 (if (looking-at cperl-have-help-regexp)
7522 (buffer-substring (match-beginning 0) (match-end 0))))
7523
7524(defun cperl-get-help ()
7525 "Get one-line docs on the symbol at the point.
7526The data for these docs is a little bit obsolete and may be in fact longer
7527than a line. Your contribution to update/shorten it is appreciated."
7528 (interactive)
7529 (save-match-data ; May be called "inside" query-replace
7530 (save-excursion
7531 (let ((word (cperl-word-at-point-hard)))
7532 (if word
7533 (if (and cperl-help-from-timer ; Bail out if not in mainland
7534 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7535 (or (memq (get-text-property (point) 'face)
7536 '(font-lock-comment-face font-lock-string-face))
7537 (memq (get-text-property (point) 'syntax-type)
7538 '(pod here-doc format))))
7539 nil
7540 (cperl-describe-perl-symbol word))
7541 (if cperl-message-on-help-error
5c8b7eaf 7542 (message "Nothing found for %s..."
f83d2997
KH
7543 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7544
7545;;; Stolen from perl-descr.el by Johan Vromans:
7546
7547(defvar cperl-doc-buffer " *perl-doc*"
7548 "Where the documentation can be found.")
7549
7550(defun cperl-describe-perl-symbol (val)
7551 "Display the documentation of symbol at point, a Perl operator."
7552 (let ((enable-recursive-minibuffers t)
7553 args-file regexp)
7554 (cond
83261a2f
SM
7555 ((string-match "^[&*][a-zA-Z_]" val)
7556 (setq val (concat (substring val 0 1) "NAME")))
7557 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7558 (setq val (concat "@" (substring val 1 (match-end 1)))))
7559 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7560 (setq val (concat "%" (substring val 1 (match-end 1)))))
7561 ((and (string= val "x") (string-match "^x=" val))
7562 (setq val "x="))
7563 ((string-match "^\\$[\C-a-\C-z]" val)
7564 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7565 ((string-match "^CORE::" val)
7566 (setq val "CORE::"))
7567 ((string-match "^SUPER::" val)
7568 (setq val "SUPER::"))
7569 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7570 (setq val "<NAME>")))
5c8b7eaf 7571 (setq regexp (concat "^"
f83d2997 7572 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
5c8b7eaf 7573 (regexp-quote val)
f83d2997
KH
7574 "\\([ \t([/]\\|$\\)"))
7575
7576 ;; get the buffer with the documentation text
7577 (cperl-switch-to-doc-buffer)
7578
7579 ;; lookup in the doc
7580 (goto-char (point-min))
7581 (let ((case-fold-search nil))
5c8b7eaf 7582 (list
f83d2997
KH
7583 (if (re-search-forward regexp (point-max) t)
7584 (save-excursion
7585 (beginning-of-line 1)
7586 (let ((lnstart (point)))
7587 (end-of-line)
7588 (message "%s" (buffer-substring lnstart (point)))))
7589 (if cperl-message-on-help-error
7590 (message "No definition for %s" val)))))))
7591
83261a2f 7592(defvar cperl-short-docs 'please-ignore-this-line
f83d2997
KH
7593 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7594 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
f739b53b 7595... Range (list context); flip/flop [no flop when flip] (scalar context).
5c8b7eaf 7596! ... Logical negation.
f83d2997
KH
7597... != ... Numeric inequality.
7598... !~ ... Search pattern, substitution, or translation (negated).
7599$! In numeric context: errno. In a string context: error string.
7600$\" The separator which joins elements of arrays interpolated in strings.
f739b53b 7601$# The output format for printed numbers. Default is %.15g or close.
f83d2997
KH
7602$$ Process number of this script. Changes in the fork()ed child process.
7603$% The current page number of the currently selected output channel.
7604
7605 The following variables are always local to the current block:
7606
7607$1 Match of the 1st set of parentheses in the last match (auto-local).
7608$2 Match of the 2nd set of parentheses in the last match (auto-local).
7609$3 Match of the 3rd set of parentheses in the last match (auto-local).
7610$4 Match of the 4th set of parentheses in the last match (auto-local).
7611$5 Match of the 5th set of parentheses in the last match (auto-local).
7612$6 Match of the 6th set of parentheses in the last match (auto-local).
7613$7 Match of the 7th set of parentheses in the last match (auto-local).
7614$8 Match of the 8th set of parentheses in the last match (auto-local).
7615$9 Match of the 9th set of parentheses in the last match (auto-local).
7616$& The string matched by the last pattern match (auto-local).
7617$' The string after what was matched by the last match (auto-local).
7618$` The string before what was matched by the last match (auto-local).
7619
7620$( The real gid of this process.
7621$) The effective gid of this process.
7622$* Deprecated: Set to 1 to do multiline matching within a string.
7623$+ The last bracket matched by the last search pattern.
7624$, The output field separator for the print operator.
7625$- The number of lines left on the page.
7626$. The current input line number of the last filehandle that was read.
7627$/ The input record separator, newline by default.
f739b53b 7628$0 Name of the file containing the current perl script (read/write).
f83d2997
KH
7629$: String may be broken after these characters to fill ^-lines in a format.
7630$; Subscript separator for multi-dim array emulation. Default \"\\034\".
7631$< The real uid of this process.
7632$= The page length of the current output channel. Default is 60 lines.
7633$> The effective uid of this process.
7634$? The status returned by the last ``, pipe close or `system'.
7635$@ The perl error message from the last eval or do @var{EXPR} command.
7636$ARGV The name of the current file used with <> .
7637$[ Deprecated: The index of the first element/char in an array/string.
7638$\\ The output record separator for the print operator.
7639$] The perl version string as displayed with perl -v.
7640$^ The name of the current top-of-page format.
7641$^A The current value of the write() accumulator for format() lines.
7642$^D The value of the perl debug (-D) flags.
7643$^E Information about the last system error other than that provided by $!.
7644$^F The highest system file descriptor, ordinarily 2.
7645$^H The current set of syntax checks enabled by `use strict'.
7646$^I The value of the in-place edit extension (perl -i option).
d7584f0f 7647$^L What formats output to perform a formfeed. Default is \\f.
5bd52f0e 7648$^M A buffer for emergency memory allocation when running out of memory.
f83d2997
KH
7649$^O The operating system name under which this copy of Perl was built.
7650$^P Internal debugging flag.
7651$^T The time the script was started. Used by -A/-M/-C file tests.
7652$^W True if warnings are requested (perl -w flag).
7653$^X The name under which perl was invoked (argv[0] in C-speech).
7654$_ The default input and pattern-searching space.
5c8b7eaf 7655$| Auto-flush after write/print on current output channel? Default 0.
f83d2997
KH
7656$~ The name of the current report format.
7657... % ... Modulo division.
7658... %= ... Modulo division assignment.
7659%ENV Contains the current environment.
7660%INC List of files that have been require-d or do-ne.
7661%SIG Used to set signal handlers for various signals.
7662... & ... Bitwise and.
7663... && ... Logical and.
7664... &&= ... Logical and assignment.
7665... &= ... Bitwise and assignment.
7666... * ... Multiplication.
7667... ** ... Exponentiation.
e4920bc9 7668*NAME Glob: all objects referred by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
f83d2997
KH
7669&NAME(arg0, ...) Subroutine call. Arguments go to @_.
7670... + ... Addition. +EXPR Makes EXPR into scalar context.
7671++ Auto-increment (magical on strings). ++EXPR EXPR++
7672... += ... Addition assignment.
7673, Comma operator.
7674... - ... Subtraction.
7675-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7676... -= ... Subtraction assignment.
7677-A Access time in days since script started.
7678-B File is a non-text (binary) file.
7679-C Inode change time in days since script started.
7680-M Age in days since script started.
7681-O File is owned by real uid.
7682-R File is readable by real uid.
7683-S File is a socket .
7684-T File is a text file.
7685-W File is writable by real uid.
7686-X File is executable by real uid.
7687-b File is a block special file.
7688-c File is a character special file.
7689-d File is a directory.
7690-e File exists .
7691-f File is a plain file.
7692-g File has setgid bit set.
7693-k File has sticky bit set.
7694-l File is a symbolic link.
7695-o File is owned by effective uid.
7696-p File is a named pipe (FIFO).
7697-r File is readable by effective uid.
7698-s File has non-zero size.
7699-t Tests if filehandle (STDIN by default) is opened to a tty.
7700-u File has setuid bit set.
7701-w File is writable by effective uid.
7702-x File is executable by effective uid.
7703-z File has zero size.
7704. Concatenate strings.
f739b53b 7705.. Range (list context); flip/flop (scalar context) operator.
f83d2997
KH
7706.= Concatenate assignment strings
7707... / ... Division. /PATTERN/ioxsmg Pattern match
7708... /= ... Division assignment.
7709/PATTERN/ioxsmg Pattern match.
f739b53b 7710... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
f83d2997
KH
7711<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7712<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7713<> Reads line from union of files in @ARGV (= command line) and STDIN.
7714... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7715... <= ... Numeric less than or equal to.
7716... <=> ... Numeric compare.
7717... = ... Assignment.
7718... == ... Numeric equality.
7719... =~ ... Search pattern, substitution, or translation
7720... > ... Numeric greater than.
7721... >= ... Numeric greater than or equal to.
7722... >> ... Bitwise shift right.
7723... >>= ... Bitwise shift right assignment.
7724... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7725?PATTERN? One-time pattern match.
7726@ARGV Command line arguments (not including the command name - see $0).
7727@INC List of places to look for perl scripts during do/include/use.
f739b53b 7728@_ Parameter array for subroutines; result of split() unless in list context.
d7584f0f 7729\\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
f83d2997
KH
7730\\0 Octal char, e.g. \\033.
7731\\E Case modification terminator. See \\Q, \\L, and \\U.
d7584f0f
AS
7732\\L Lowercase until \\E . See also \\l, lc.
7733\\U Upcase until \\E . See also \\u, uc.
f83d2997
KH
7734\\Q Quote metacharacters until \\E . See also quotemeta.
7735\\a Alarm character (octal 007).
7736\\b Backspace character (octal 010).
7737\\c Control character, e.g. \\c[ .
7738\\e Escape character (octal 033).
7739\\f Formfeed character (octal 014).
7740\\l Lowercase the next character. See also \\L and \\u, lcfirst.
7741\\n Newline character (octal 012 on most systems).
7742\\r Return character (octal 015 on most systems).
7743\\t Tab character (octal 011).
7744\\u Upcase the next character. See also \\U and \\l, ucfirst.
7745\\x Hex character, e.g. \\x1b.
7746... ^ ... Bitwise exclusive or.
7747__END__ Ends program source.
7748__DATA__ Ends program source.
7749__FILE__ Current (source) filename.
7750__LINE__ Current line in current source.
7751__PACKAGE__ Current package.
7752ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7753ARGVOUT Output filehandle with -i flag.
7754BEGIN { ... } Immediately executed (during compilation) piece of code.
7755END { ... } Pseudo-subroutine executed after the script finishes.
6c389151
SM
7756CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7757INIT { ... } Pseudo-subroutine executed before the script starts running.
f83d2997
KH
7758DATA Input filehandle for what follows after __END__ or __DATA__.
7759accept(NEWSOCKET,GENERICSOCKET)
7760alarm(SECONDS)
7761atan2(X,Y)
7762bind(SOCKET,NAME)
7763binmode(FILEHANDLE)
7764caller[(LEVEL)]
7765chdir(EXPR)
7766chmod(LIST)
7767chop[(LIST|VAR)]
7768chown(LIST)
7769chroot(FILENAME)
7770close(FILEHANDLE)
7771closedir(DIRHANDLE)
7772... cmp ... String compare.
7773connect(SOCKET,NAME)
7774continue of { block } continue { block }. Is executed after `next' or at end.
7775cos(EXPR)
7776crypt(PLAINTEXT,SALT)
7777dbmclose(%HASH)
7778dbmopen(%HASH,DBNAME,MODE)
7779defined(EXPR)
7780delete($HASH{KEY})
7781die(LIST)
7782do { ... }|SUBR while|until EXPR executes at least once
7783do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7784dump LABEL
7785each(%HASH)
7786endgrent
7787endhostent
7788endnetent
7789endprotoent
7790endpwent
7791endservent
7792eof[([FILEHANDLE])]
7793... eq ... String equality.
7794eval(EXPR) or eval { BLOCK }
4ab89e7b 7795exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
f83d2997
KH
7796exit(EXPR)
7797exp(EXPR)
7798fcntl(FILEHANDLE,FUNCTION,SCALAR)
7799fileno(FILEHANDLE)
7800flock(FILEHANDLE,OPERATION)
7801for (EXPR;EXPR;EXPR) { ... }
7802foreach [VAR] (@ARRAY) { ... }
7803fork
7804... ge ... String greater than or equal.
7805getc[(FILEHANDLE)]
7806getgrent
7807getgrgid(GID)
7808getgrnam(NAME)
7809gethostbyaddr(ADDR,ADDRTYPE)
7810gethostbyname(NAME)
7811gethostent
7812getlogin
7813getnetbyaddr(ADDR,ADDRTYPE)
7814getnetbyname(NAME)
7815getnetent
7816getpeername(SOCKET)
7817getpgrp(PID)
7818getppid
7819getpriority(WHICH,WHO)
7820getprotobyname(NAME)
7821getprotobynumber(NUMBER)
7822getprotoent
7823getpwent
7824getpwnam(NAME)
7825getpwuid(UID)
7826getservbyname(NAME,PROTO)
7827getservbyport(PORT,PROTO)
7828getservent
7829getsockname(SOCKET)
7830getsockopt(SOCKET,LEVEL,OPTNAME)
7831gmtime(EXPR)
7832goto LABEL
f83d2997
KH
7833... gt ... String greater than.
7834hex(EXPR)
7835if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7836index(STR,SUBSTR[,OFFSET])
7837int(EXPR)
7838ioctl(FILEHANDLE,FUNCTION,SCALAR)
7839join(EXPR,LIST)
7840keys(%HASH)
7841kill(LIST)
7842last [LABEL]
7843... le ... String less than or equal.
7844length(EXPR)
7845link(OLDFILE,NEWFILE)
7846listen(SOCKET,QUEUESIZE)
7847local(LIST)
7848localtime(EXPR)
7849log(EXPR)
7850lstat(EXPR|FILEHANDLE|VAR)
7851... lt ... String less than.
7852m/PATTERN/iogsmx
7853mkdir(FILENAME,MODE)
7854msgctl(ID,CMD,ARG)
7855msgget(KEY,FLAGS)
7856msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7857msgsnd(ID,MSG,FLAGS)
7858my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6c389151 7859our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
f83d2997
KH
7860... ne ... String inequality.
7861next [LABEL]
7862oct(EXPR)
7863open(FILEHANDLE[,EXPR])
7864opendir(DIRHANDLE,EXPR)
7865ord(EXPR) ASCII value of the first char of the string.
7866pack(TEMPLATE,LIST)
7867package NAME Introduces package context.
7868pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7869pop(ARRAY)
7870print [FILEHANDLE] [(LIST)]
7871printf [FILEHANDLE] (FORMAT,LIST)
7872push(ARRAY,LIST)
7873q/STRING/ Synonym for 'STRING'
7874qq/STRING/ Synonym for \"STRING\"
7875qx/STRING/ Synonym for `STRING`
7876rand[(EXPR)]
7877read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7878readdir(DIRHANDLE)
7879readlink(EXPR)
7880recv(SOCKET,SCALAR,LEN,FLAGS)
7881redo [LABEL]
7882rename(OLDNAME,NEWNAME)
7883require [FILENAME | PERL_VERSION]
7884reset[(EXPR)]
7885return(LIST)
7886reverse(LIST)
7887rewinddir(DIRHANDLE)
7888rindex(STR,SUBSTR[,OFFSET])
7889rmdir(FILENAME)
7890s/PATTERN/REPLACEMENT/gieoxsm
7891scalar(EXPR)
7892seek(FILEHANDLE,POSITION,WHENCE)
7893seekdir(DIRHANDLE,POS)
7894select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7895semctl(ID,SEMNUM,CMD,ARG)
7896semget(KEY,NSEMS,SIZE,FLAGS)
7897semop(KEY,...)
7898send(SOCKET,MSG,FLAGS[,TO])
7899setgrent
7900sethostent(STAYOPEN)
7901setnetent(STAYOPEN)
7902setpgrp(PID,PGRP)
7903setpriority(WHICH,WHO,PRIORITY)
7904setprotoent(STAYOPEN)
7905setpwent
7906setservent(STAYOPEN)
7907setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7908shift[(ARRAY)]
7909shmctl(ID,CMD,ARG)
7910shmget(KEY,SIZE,FLAGS)
7911shmread(ID,VAR,POS,SIZE)
7912shmwrite(ID,STRING,POS,SIZE)
7913shutdown(SOCKET,HOW)
7914sin(EXPR)
7915sleep[(EXPR)]
7916socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7917socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7918sort [SUBROUTINE] (LIST)
7919splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7920split[(/PATTERN/[,EXPR[,LIMIT]])]
7921sprintf(FORMAT,LIST)
7922sqrt(EXPR)
7923srand(EXPR)
7924stat(EXPR|FILEHANDLE|VAR)
7925study[(SCALAR)]
7926sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7927substr(EXPR,OFFSET[,LEN])
7928symlink(OLDFILE,NEWFILE)
7929syscall(LIST)
7930sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
4ab89e7b 7931system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
f83d2997
KH
7932syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7933tell[(FILEHANDLE)]
7934telldir(DIRHANDLE)
7935time
7936times
7937tr/SEARCHLIST/REPLACEMENTLIST/cds
7938truncate(FILE|EXPR,LENGTH)
7939umask[(EXPR)]
7940undef[(EXPR)]
7941unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7942unlink(LIST)
7943unpack(TEMPLATE,EXPR)
7944unshift(ARRAY,LIST)
7945until (EXPR) { ... } EXPR until EXPR
7946utime(LIST)
7947values(%HASH)
7948vec(EXPR,OFFSET,BITS)
7949wait
7950waitpid(PID,FLAGS)
7951wantarray Returns true if the sub/eval is called in list context.
7952warn(LIST)
7953while (EXPR) { ... } EXPR while EXPR
7954write[(EXPR|FILEHANDLE)]
7955... x ... Repeat string or array.
7956x= ... Repetition assignment.
7957y/SEARCHLIST/REPLACEMENTLIST/
7958... | ... Bitwise or.
7959... || ... Logical or.
7960~ ... Unary bitwise complement.
db133cb6 7961#! OS interpreter indicator. If contains `perl', used for options, and -x.
f83d2997
KH
7962AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7963CORE:: Prefix to access builtin function if imported sub obscures it.
7964SUPER:: Prefix to lookup for a method in @ISA classes.
7965DESTROY Shorthand for `sub DESTROY {...}'.
7966... EQ ... Obsolete synonym of `eq'.
7967... GE ... Obsolete synonym of `ge'.
7968... GT ... Obsolete synonym of `gt'.
7969... LE ... Obsolete synonym of `le'.
7970... LT ... Obsolete synonym of `lt'.
7971... NE ... Obsolete synonym of `ne'.
7972abs [ EXPR ] absolute value
7973... and ... Low-precedence synonym for &&.
7974bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7975chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7976chr Converts a number to char with the same ordinal.
7977else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7978elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
83261a2f 7979exists $HASH{KEY} True if the key exists.
f83d2997
KH
7980format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7981formline PICTURE, LIST Backdoor into \"format\" processing.
7982glob EXPR Synonym of <EXPR>.
7983lc [ EXPR ] Returns lowercased EXPR.
7984lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
db133cb6 7985grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
f83d2997
KH
7986map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7987no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7988not ... Low-precedence synonym for ! - negation.
7989... or ... Low-precedence synonym for ||.
7990pos STRING Set/Get end-position of the last match over this string, see \\G.
7991quotemeta [ EXPR ] Quote regexp metacharacters.
7992qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7993readline FH Synonym of <FH>.
7994readpipe CMD Synonym of `CMD`.
7995ref [ EXPR ] Type of EXPR when dereferenced.
7996sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7997tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7998tied Returns internal object for a tied data.
7999uc [ EXPR ] Returns upcased EXPR.
8000ucfirst [ EXPR ] Returns EXPR with upcased first letter.
8001untie VAR Unlink an object from a simple Perl variable.
8002use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
8003... xor ... Low-precedence synonym for exclusive or.
d7584f0f 8004prototype \\&SUB Returns prototype of the function given a reference.
f83d2997
KH
8005=head1 Top-level heading.
8006=head2 Second-level heading.
8007=head3 Third-level heading (is there such?).
8008=over [ NUMBER ] Start list.
8009=item [ TITLE ] Start new item in the list.
8010=back End list.
8011=cut Switch from POD to Perl.
8012=pod Switch from Perl to POD.
8013")
8014
21df56d5 8015(defun cperl-switch-to-doc-buffer (&optional interactive)
f83d2997 8016 "Go to the perl documentation buffer and insert the documentation."
21df56d5 8017 (interactive "p")
f83d2997 8018 (let ((buf (get-buffer-create cperl-doc-buffer)))
21df56d5 8019 (if interactive
f83d2997
KH
8020 (switch-to-buffer-other-window buf)
8021 (set-buffer buf))
8022 (if (= (buffer-size) 0)
8023 (progn
8024 (insert (documentation-property 'cperl-short-docs
8025 'variable-documentation))
8026 (setq buffer-read-only t)))))
8027
6c389151 8028(defun cperl-beautify-regexp-piece (b e embed level)
f83d2997
KH
8029 ;; b is before the starting delimiter, e before the ending
8030 ;; e should be a marker, may be changed, but remains "correct".
e7f767c2 8031 ;; EMBED is nil if we process the whole REx.
4ab89e7b 8032 ;; The REx is guaranteed to have //x
6c389151
SM
8033 ;; LEVEL shows how many levels deep to go
8034 ;; position at enter and at leave is not defined
8035 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8c777c8d
CY
8036 (if embed
8037 (progn
8038 (goto-char b)
8039 (setq c (if (eq embed t) (current-indentation) (current-column)))
8040 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8041 (forward-char 2)
8042 (delete-char 1)
8043 (forward-char 1))
8044 ((looking-at "(\\?[^a-zA-Z]")
8045 (forward-char 3))
8046 ((looking-at "(\\?") ; (?i)
8047 (forward-char 2))
8048 (t
8049 (forward-char 1))))
8050 (goto-char (1+ b))
8051 (setq c (1- (current-column))))
8052 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
f83d2997
KH
8053 (or (looking-at "[ \t]*[\n#]")
8054 (progn
8055 (insert "\n")))
8056 (goto-char e)
8057 (beginning-of-line)
8058 (if (re-search-forward "[^ \t]" e t)
83261a2f 8059 (progn ; Something before the ending delimiter
f83d2997 8060 (goto-char e)
6c389151 8061 (delete-horizontal-space)
f83d2997 8062 (insert "\n")
4ab89e7b 8063 (cperl-make-indent c)
f83d2997
KH
8064 (set-marker e (point))))
8065 (goto-char b)
8066 (end-of-line 2)
8067 (while (< (point) (marker-position e))
8068 (beginning-of-line)
8069 (setq s (point)
8070 inline t)
8071 (skip-chars-forward " \t")
8072 (delete-region s (point))
4ab89e7b 8073 (cperl-make-indent c1)
f83d2997
KH
8074 (while (and
8075 inline
5c8b7eaf 8076 (looking-at
f83d2997
KH
8077 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8078 "\\|" ; Embedded variable
8079 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8080 "\\|" ; $ ^
8081 "[$^]"
8082 "\\|" ; simple-code simple-code*?
8083 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8084 "\\|" ; Class
8085 "\\(\\[\\)" ; 6
8086 "\\|" ; Grouping
8087 "\\((\\(\\?\\)?\\)" ; 7 8
8088 "\\|" ; |
83261a2f 8089 "\\(|\\)"))) ; 9
f83d2997
KH
8090 (goto-char (match-end 0))
8091 (setq spaces t)
8092 (cond ((match-beginning 1) ; Alphanum word + junk
8093 (forward-char -1))
8094 ((or (match-beginning 3) ; $ab[12]
8095 (and (match-beginning 5) ; X* X+ X{2,3}
8096 (eq (preceding-char) ?\{)))
8097 (forward-char -1)
8098 (forward-sexp 1))
4ab89e7b
SM
8099 ((and ; [], already syntaxified
8100 (match-beginning 6)
8101 cperl-regexp-scan
8102 cperl-use-syntax-table-text-property)
8103 (forward-char -1)
8104 (forward-sexp 1)
8105 (or (eq (preceding-char) ?\])
8106 (error "[]-group not terminated"))
8107 (re-search-forward
8108 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8109 ((match-beginning 6) ; []
8110 (setq tmp (point))
8111 (if (looking-at "\\^?\\]")
8112 (goto-char (match-end 0)))
6c389151
SM
8113 ;; XXXX POSIX classes?!
8114 (while (and (not pos)
8115 (re-search-forward "\\[:\\|\\]" e t))
8116 (if (eq (preceding-char) ?:)
8117 (or (re-search-forward ":\\]" e t)
8118 (error "[:POSIX:]-group in []-group not terminated"))
8119 (setq pos t)))
8120 (or (eq (preceding-char) ?\])
8121 (error "[]-group not terminated"))
4ab89e7b
SM
8122 (re-search-forward
8123 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8124 ((match-beginning 7) ; ()
8125 (goto-char (match-beginning 0))
6c389151
SM
8126 (setq pos (current-column))
8127 (or (eq pos c1)
f83d2997 8128 (progn
6c389151 8129 (delete-horizontal-space)
f83d2997 8130 (insert "\n")
4ab89e7b 8131 (cperl-make-indent c1)))
f83d2997
KH
8132 (setq tmp (point))
8133 (forward-sexp 1)
8134 ;; (or (forward-sexp 1)
8135 ;; (progn
8136 ;; (goto-char tmp)
8137 ;; (error "()-group not terminated")))
8138 (set-marker m (1- (point)))
8139 (set-marker m1 (point))
6c389151
SM
8140 (if (= level 1)
8141 (if (progn ; indent rigidly if multiline
a1506d29 8142 ;; In fact does not make a lot of sense, since
6c389151
SM
8143 ;; the starting position can be already lost due
8144 ;; to insertion of "\n" and " "
8145 (goto-char tmp)
8146 (search-forward "\n" m1 t))
8147 (indent-rigidly (point) m1 (- c1 pos)))
8148 (setq level (1- level))
8149 (cond
8150 ((not (match-beginning 8))
8151 (cperl-beautify-regexp-piece tmp m t level))
8152 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8153 t)
8154 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8155 (goto-char (+ 2 tmp))
8156 (forward-sexp 1)
8157 (cperl-beautify-regexp-piece (point) m t level))
8158 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8159 (goto-char (+ 3 tmp))
8160 (cperl-beautify-regexp-piece (point) m t level))
8161 (t
8162 (cperl-beautify-regexp-piece tmp m t level))))
f83d2997
KH
8163 (goto-char m1)
8164 (cond ((looking-at "[*+?]\\??")
8165 (goto-char (match-end 0)))
8166 ((eq (following-char) ?\{)
8167 (forward-sexp 1)
8168 (if (eq (following-char) ?\?)
8169 (forward-char))))
8170 (skip-chars-forward " \t")
8171 (setq spaces nil)
8172 (if (looking-at "[#\n]")
8173 (progn
8174 (or (eolp) (indent-for-comment))
8175 (beginning-of-line 2))
6c389151 8176 (delete-horizontal-space)
f83d2997
KH
8177 (insert "\n"))
8178 (end-of-line)
8179 (setq inline nil))
8180 ((match-beginning 9) ; |
8181 (forward-char -1)
8182 (setq tmp (point))
8183 (beginning-of-line)
8184 (if (re-search-forward "[^ \t]" tmp t)
8185 (progn
8186 (goto-char tmp)
6c389151 8187 (delete-horizontal-space)
f83d2997
KH
8188 (insert "\n"))
8189 ;; first at line
8190 (delete-region (point) tmp))
4ab89e7b 8191 (cperl-make-indent c)
f83d2997
KH
8192 (forward-char 1)
8193 (skip-chars-forward " \t")
8194 (setq spaces nil)
8195 (if (looking-at "[#\n]")
8196 (beginning-of-line 2)
6c389151 8197 (delete-horizontal-space)
f83d2997
KH
8198 (insert "\n"))
8199 (end-of-line)
8200 (setq inline nil)))
8201 (or (looking-at "[ \t\n]")
8202 (not spaces)
8203 (insert " "))
8204 (skip-chars-forward " \t"))
83261a2f
SM
8205 (or (looking-at "[#\n]")
8206 (error "Unknown code `%s' in a regexp"
8207 (buffer-substring (point) (1+ (point)))))
8208 (and inline (end-of-line 2)))
f83d2997
KH
8209 ;; Special-case the last line of group
8210 (if (and (>= (point) (marker-position e))
8211 (/= (current-indentation) c))
8212 (progn
83261a2f 8213 (beginning-of-line)
4ab89e7b 8214 (cperl-make-indent c)))))
f83d2997
KH
8215
8216(defun cperl-make-regexp-x ()
db133cb6 8217 ;; Returns position of the start
6c389151 8218 ;; XXX this is called too often! Need to cache the result!
f83d2997
KH
8219 (save-excursion
8220 (or cperl-use-syntax-table-text-property
5bd52f0e 8221 (error "I need to have a regexp marked!"))
f83d2997 8222 ;; Find the start
db133cb6
RS
8223 (if (looking-at "\\s|")
8224 nil ; good already
8c777c8d
CY
8225 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8226 (and (eq (preceding-char) ?q)
8227 (looking-at "\\(r\\)\\s|")))
8228 (goto-char (match-end 1))
83261a2f 8229 (re-search-backward "\\s|"))) ; Assume it is scanned already.
f83d2997
KH
8230 ;;(forward-char 1)
8231 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8232 (sub-p (eq (preceding-char) ?s)) s)
8233 (forward-sexp 1)
8234 (set-marker e (1- (point)))
8235 (setq delim (preceding-char))
8236 (if (and sub-p (eq delim (char-after (- (point) 2))))
8237 (error "Possible s/blah// - do not know how to deal with"))
8238 (if sub-p (forward-sexp 1))
5c8b7eaf 8239 (if (looking-at "\\sw*x")
f83d2997
KH
8240 (setq have-x t)
8241 (insert "x"))
8242 ;; Protect fragile " ", "#"
8243 (if have-x nil
8244 (goto-char (1+ b))
8245 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8246 (forward-char -1)
8247 (insert "\\")
8248 (forward-char 1)))
8249 b)))
8250
6c389151 8251(defun cperl-beautify-regexp (&optional deep)
f94a632a 8252 "Do it. (Experimental, may change semantics, recheck the result.)
f83d2997 8253We suppose that the regexp is scanned already."
6c389151 8254 (interactive "P")
0c602a0f 8255 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8256 (save-excursion
8257 (goto-char (cperl-make-regexp-x))
8258 (let ((b (point)) (e (make-marker)))
8259 (forward-sexp 1)
8260 (set-marker e (1- (point)))
8261 (cperl-beautify-regexp-piece b e nil deep))))
f83d2997 8262
db133cb6
RS
8263(defun cperl-regext-to-level-start ()
8264 "Goto start of an enclosing group in regexp.
f83d2997
KH
8265We suppose that the regexp is scanned already."
8266 (interactive)
db133cb6 8267 (let ((limit (cperl-make-regexp-x)) done)
f83d2997
KH
8268 (while (not done)
8269 (or (eq (following-char) ?\()
db133cb6 8270 (search-backward "(" (1+ limit) t)
f83d2997
KH
8271 (error "Cannot find `(' which starts a group"))
8272 (setq done
8273 (save-excursion
8274 (skip-chars-backward "\\")
8275 (looking-at "\\(\\\\\\\\\\)*(")))
db133cb6
RS
8276 (or done (forward-char -1)))))
8277
8278(defun cperl-contract-level ()
5bd52f0e 8279 "Find an enclosing group in regexp and contract it.
db133cb6
RS
8280\(Experimental, may change semantics, recheck the result.)
8281We suppose that the regexp is scanned already."
8282 (interactive)
6c389151 8283 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
83261a2f 8284 (cperl-regext-to-level-start)
4ab89e7b 8285 (let ((b (point)) (e (make-marker)) c)
83261a2f
SM
8286 (forward-sexp 1)
8287 (set-marker e (1- (point)))
8288 (goto-char b)
8289 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8290 (cond
8291 ((match-beginning 1) ; #-comment
8292 (or c (setq c (current-indentation)))
8293 (beginning-of-line 2) ; Skip
4ab89e7b 8294 (cperl-make-indent c))
83261a2f
SM
8295 (t
8296 (delete-char -1)
8297 (just-one-space))))))
db133cb6
RS
8298
8299(defun cperl-contract-levels ()
5bd52f0e 8300 "Find an enclosing group in regexp and contract all the kids.
db133cb6
RS
8301\(Experimental, may change semantics, recheck the result.)
8302We suppose that the regexp is scanned already."
8303 (interactive)
6c389151
SM
8304 (save-excursion
8305 (condition-case nil
8306 (cperl-regext-to-level-start)
8307 (error ; We are outside outermost group
5efe6a56
SM
8308 (goto-char (cperl-make-regexp-x))))
8309 (let ((b (point)) (e (make-marker)) s c)
8310 (forward-sexp 1)
8311 (set-marker e (1- (point)))
8312 (goto-char (1+ b))
8313 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
a1506d29 8314 (cond
6c389151
SM
8315 ((match-beginning 1) ; Skip
8316 nil)
8317 (t ; Group
8318 (cperl-contract-level)))))))
f83d2997 8319
6c389151 8320(defun cperl-beautify-level (&optional deep)
f83d2997
KH
8321 "Find an enclosing group in regexp and beautify it.
8322\(Experimental, may change semantics, recheck the result.)
8323We suppose that the regexp is scanned already."
6c389151 8324 (interactive "P")
0c602a0f 8325 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8326 (save-excursion
8327 (cperl-regext-to-level-start)
8328 (let ((b (point)) (e (make-marker)))
8329 (forward-sexp 1)
8330 (set-marker e (1- (point)))
8c777c8d 8331 (cperl-beautify-regexp-piece b e 'level deep))))
db133cb6 8332
4ab89e7b
SM
8333(defun cperl-invert-if-unless-modifiers ()
8334 "Change `B if A;' into `if (A) {B}' etc if possible.
8335\(Unfinished.)"
8c777c8d 8336 (interactive)
4ab89e7b
SM
8337 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8338 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8339 (and (= (char-syntax (preceding-char)) ?w)
8340 (forward-sexp -1))
8341 (setq pre-if (point))
8342 (cperl-backward-to-start-of-expr)
8343 (setq pre-B (point))
8344 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8345 (cperl-forward-to-end-of-expr)
8346 (setq post-A (point))
8347 (goto-char pre-if)
8348 (or (looking-at w-rex)
8349 ;; Find the position
8350 (progn (goto-char post-A)
8351 (while (and
8352 (not (looking-at w-rex))
8353 (> (point) pre-B))
8354 (forward-sexp -1))
8355 (setq pre-if (point))))
8356 (or (looking-at w-rex)
8357 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8358 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8359 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8360 ;; First, simple part: find code boundaries
8361 (forward-sexp 1)
8362 (setq post-if (point))
8363 (forward-sexp -2)
8364 (forward-sexp 1)
8365 (setq post-B (point))
8366 (cperl-backward-to-start-of-expr)
8367 (setq pre-B (point))
8368 (setq B (buffer-substring pre-B post-B))
8369 (goto-char pre-if)
8370 (forward-sexp 2)
8371 (forward-sexp -1)
8372 ;; May be after $, @, $# etc of a variable
8373 (skip-chars-backward "$@%#")
8374 (setq pre-A (point))
8375 (cperl-forward-to-end-of-expr)
8376 (setq post-A (point))
8377 (setq A (buffer-substring pre-A post-A))
8378 ;; Now modify (from end, to not break the stuff)
8379 (skip-chars-forward " \t;")
8380 (delete-region pre-A (point)) ; we move to pre-A
8381 (insert "\n" B ";\n}")
8382 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8383 (delete-region pre-if post-if)
8384 (delete-region pre-B post-B)
8385 (goto-char pre-B)
8386 (insert if-string " (" A ") {")
8387 (setq post-B (point))
8388 (if (looking-at "[ \t]+$")
8389 (delete-horizontal-space)
8390 (if (looking-at "[ \t]*#")
8391 (cperl-indent-for-comment)
8392 (just-one-space)))
8393 (forward-line 1)
8394 (if (looking-at "[ \t]*$")
8395 (progn ; delete line
8396 (delete-horizontal-space)
8397 (delete-region (point) (1+ (point)))))
8398 (cperl-indent-line)
8399 (goto-char (1- post-B))
8400 (forward-sexp 1)
8401 (cperl-indent-line)
8402 (goto-char pre-B)))
8403
db133cb6 8404(defun cperl-invert-if-unless ()
4ab89e7b
SM
8405 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8406If the cursor is not on the leading keyword of the BLOCK flavor of
8407construct, will assume it is the STATEMENT flavor, so will try to find
8408the appropriate statement modifier."
db133cb6 8409 (interactive)
4ab89e7b
SM
8410 (and (= (char-syntax (preceding-char)) ?w)
8411 (forward-sexp -1))
6c389151 8412 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
4ab89e7b
SM
8413 (let ((pre-if (point))
8414 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8415 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
db133cb6 8416 (forward-sexp 2)
4ab89e7b 8417 (setq post-A (point))
db133cb6 8418 (forward-sexp -1)
4ab89e7b
SM
8419 (setq pre-A (point))
8420 (setq is-block (and (eq (following-char) ?\( )
8421 (save-excursion
8422 (condition-case nil
8423 (progn
8424 (forward-sexp 2)
8425 (forward-sexp -1)
8426 (eq (following-char) ?\{ ))
8427 (error nil)))))
8428 (if is-block
db133cb6 8429 (progn
4ab89e7b 8430 (goto-char post-A)
db133cb6 8431 (forward-sexp 1)
4ab89e7b 8432 (setq post-B (point))
db133cb6 8433 (forward-sexp -1)
4ab89e7b 8434 (setq pre-B (point))
db133cb6
RS
8435 (if (and (eq (following-char) ?\{ )
8436 (progn
4ab89e7b 8437 (cperl-backward-to-noncomment post-A)
db133cb6
RS
8438 (eq (preceding-char) ?\) )))
8439 (if (condition-case nil
8440 (progn
4ab89e7b 8441 (goto-char post-B)
db133cb6
RS
8442 (forward-sexp 1)
8443 (forward-sexp -1)
8444 (looking-at "\\<els\\(e\\|if\\)\\>"))
8445 (error nil))
8446 (error
4ab89e7b
SM
8447 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8448 (goto-char (1- post-B))
8449 (cperl-backward-to-noncomment pre-B)
db133cb6
RS
8450 (if (eq (preceding-char) ?\;)
8451 (forward-char -1))
4ab89e7b
SM
8452 (setq end-B-code (point))
8453 (goto-char pre-B)
8454 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
db133cb6 8455 (setq p (match-beginning 0)
4ab89e7b
SM
8456 A (buffer-substring p (match-end 0))
8457 state (parse-partial-sexp pre-B p))
5c8b7eaf 8458 (or (nth 3 state)
db133cb6
RS
8459 (nth 4 state)
8460 (nth 5 state)
4ab89e7b 8461 (error "`%s' inside `%s' BLOCK" A if-string))
db133cb6
RS
8462 (goto-char (match-end 0)))
8463 ;; Finally got it
4ab89e7b 8464 (goto-char (1+ pre-B))
db133cb6 8465 (skip-chars-forward " \t\n")
4ab89e7b
SM
8466 (setq B (buffer-substring (point) end-B-code))
8467 (goto-char end-B-code)
db133cb6
RS
8468 (or (looking-at ";?[ \t\n]*}")
8469 (progn
8470 (skip-chars-forward "; \t\n")
4ab89e7b
SM
8471 (setq B-comment
8472 (buffer-substring (point) (1- post-B)))))
8473 (and (equal B "")
8474 (setq B "1"))
8475 (goto-char (1- post-A))
8476 (cperl-backward-to-noncomment pre-A)
db133cb6 8477 (or (looking-at "[ \t\n]*)")
4ab89e7b 8478 (goto-char (1- post-A)))
db133cb6 8479 (setq p (point))
4ab89e7b 8480 (goto-char (1+ pre-A))
db133cb6 8481 (skip-chars-forward " \t\n")
4ab89e7b
SM
8482 (setq A (buffer-substring (point) p))
8483 (delete-region pre-B post-B)
8484 (delete-region pre-A post-A)
8485 (goto-char pre-if)
8486 (insert B " ")
8487 (and B-comment (insert B-comment " "))
db133cb6
RS
8488 (just-one-space)
8489 (forward-word 1)
4ab89e7b
SM
8490 (setq pre-A (point))
8491 (insert " " A ";")
6c389151 8492 (delete-horizontal-space)
4ab89e7b
SM
8493 (setq post-B (point))
8494 (if (looking-at "#")
8495 (indent-for-comment))
8496 (goto-char post-B)
db133cb6
RS
8497 (forward-char -1)
8498 (delete-horizontal-space)
4ab89e7b 8499 (goto-char pre-A)
db133cb6 8500 (just-one-space)
4ab89e7b
SM
8501 (goto-char pre-if)
8502 (setq pre-A (set-marker (make-marker) pre-A))
8503 (while (<= (point) (marker-position pre-A))
8504 (cperl-indent-line)
8505 (forward-line 1))
8506 (goto-char (marker-position pre-A))
8507 (if B-comment
8508 (progn
8509 (forward-line -1)
8510 (indent-for-comment)
8511 (goto-char (marker-position pre-A)))))
8512 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8513 ;; (error "`%s' not with an (EXPR)" if-string)
8514 (forward-sexp -1)
8515 (cperl-invert-if-unless-modifiers)))
8516 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8517 (cperl-invert-if-unless-modifiers)))
db133cb6 8518
5bd52f0e 8519;;; By Anthony Foiani <afoiani@uswest.com>
b7ec9e59
RS
8520;;; Getting help on modules in C-h f ?
8521;;; This is a modified version of `man'.
8522;;; Need to teach it how to lookup functions
4ab89e7b 8523;;;###autoload
b7ec9e59
RS
8524(defun cperl-perldoc (word)
8525 "Run `perldoc' on WORD."
8526 (interactive
8527 (list (let* ((default-entry (cperl-word-at-point))
8528 (input (read-string
8529 (format "perldoc entry%s: "
8530 (if (string= default-entry "")
8531 ""
8532 (format " (default %s)" default-entry))))))
8533 (if (string= input "")
8534 (if (string= default-entry "")
8535 (error "No perldoc args given")
8536 default-entry)
8537 input))))
a8e1e57f 8538 (require 'man)
f739b53b
SM
8539 (let* ((case-fold-search nil)
8540 (is-func (and
b7ec9e59
RS
8541 (string-match "^[a-z]+$" word)
8542 (string-match (concat "^" word "\\>")
8543 (documentation-property
8544 'cperl-short-docs
8545 'variable-documentation))))
8c777c8d 8546 (Man-switches "")
b7ec9e59 8547 (manual-program (if is-func "perldoc -f" "perldoc")))
f739b53b 8548 (cond
6546555e 8549 ((featurep 'xemacs)
f739b53b
SM
8550 (let ((Manual-program "perldoc")
8551 (Manual-switches (if is-func (list "-f"))))
8552 (manual-entry word)))
8553 (t
8554 (Man-getpage-in-background word)))))
b7ec9e59 8555
4ab89e7b 8556;;;###autoload
b7ec9e59
RS
8557(defun cperl-perldoc-at-point ()
8558 "Run a `perldoc' on the word around point."
8559 (interactive)
8560 (cperl-perldoc (cperl-word-at-point)))
8561
8562(defcustom pod2man-program "pod2man"
8563 "*File name for `pod2man'."
8564 :type 'file
8565 :group 'cperl)
8566
5bd52f0e 8567;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
b7ec9e59
RS
8568(defun cperl-pod-to-manpage ()
8569 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8570 (interactive)
8571 (require 'man)
8572 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8573 (bufname (concat "Man " buffer-file-name))
8574 (buffer (generate-new-buffer bufname)))
9a529312 8575 (with-current-buffer buffer
b7ec9e59
RS
8576 (let ((process-environment (copy-sequence process-environment)))
8577 ;; Prevent any attempt to use display terminal fanciness.
8578 (setenv "TERM" "dumb")
8579 (set-process-sentinel
8580 (start-process pod2man-program buffer "sh" "-c"
8581 (format (cperl-pod2man-build-command) pod2man-args))
8582 'Man-bgproc-sentinel)))))
8583
f739b53b
SM
8584;;; Updated version by him too
8585(defun cperl-build-manpage ()
8586 "Create a virtual manpage in Emacs from the POD in the file."
8587 (interactive)
8588 (require 'man)
8589 (cond
6546555e 8590 ((featurep 'xemacs)
f739b53b
SM
8591 (let ((Manual-program "perldoc"))
8592 (manual-entry buffer-file-name)))
8593 (t
8c777c8d
CY
8594 (let* ((manual-program "perldoc")
8595 (Man-switches ""))
f739b53b
SM
8596 (Man-getpage-in-background buffer-file-name)))))
8597
b7ec9e59
RS
8598(defun cperl-pod2man-build-command ()
8599 "Builds the entire background manpage and cleaning command."
8600 (let ((command (concat pod2man-program " %s 2>/dev/null"))
4ab89e7b 8601 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
b7ec9e59
RS
8602 (while (and flist (car flist))
8603 (let ((pcom (car (car flist)))
8604 (pargs (cdr (car flist))))
8605 (setq command
8606 (concat command " | " pcom " "
4f91a816
SM
8607 (mapconcat (lambda (phrase)
8608 (if (not (stringp phrase))
8609 (error "Malformed Man-filter-list"))
8610 phrase)
b7ec9e59
RS
8611 pargs " ")))
8612 (setq flist (cdr flist))))
8613 command))
db133cb6 8614
4ab89e7b
SM
8615
8616(defun cperl-next-interpolated-REx-1 ()
8617 "Move point to next REx which has interpolated parts without //o.
8618Skips RExes consisting of one interpolated variable.
8619
8620Note that skipped RExen are not performance hits."
8621 (interactive "")
8622 (cperl-next-interpolated-REx 1))
8623
8624(defun cperl-next-interpolated-REx-0 ()
8625 "Move point to next REx which has interpolated parts without //o."
8626 (interactive "")
8627 (cperl-next-interpolated-REx 0))
8628
8629(defun cperl-next-interpolated-REx (&optional skip beg limit)
8630 "Move point to next REx which has interpolated parts.
8631SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8632point and the limit of search (default to point and end of buffer).
8633
8634SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8635semantic may be used as a numeric argument.
8636
8637Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8638a result of qr//, this is not a performance hit), t for the rest."
8639 (interactive "P")
8640 (if (numberp skip) (setq skip (list 0 skip)))
8641 (or beg (setq beg (point)))
8642 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8643 (let (pp)
8644 (and (eq (get-text-property beg 'syntax-type) 'string)
8645 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8646 (cperl-map-pods-heres
8647 (function (lambda (s e p)
8648 (if (memq (get-text-property s 'REx-interpolated) skip)
8649 t
8650 (setq pp s)
8651 nil))) ; nil stops
8652 'REx-interpolated beg limit)
8653 (if pp (goto-char pp)
8654 (message "No more interpolated REx"))))
8655
8656;;; Initial version contributed by Trey Belew
8657(defun cperl-here-doc-spell (&optional beg end)
8658 "Spell-check HERE-documents in the Perl buffer.
8659If a region is highlighted, restricts to the region."
8660 (interactive "")
8661 (cperl-pod-spell t beg end))
8662
8663(defun cperl-pod-spell (&optional do-heres beg end)
8664 "Spell-check POD documentation.
8665If invoked with prefix argument, will do HERE-DOCs instead.
8666If a region is highlighted, restricts to the region."
8667 (interactive "P")
8668 (save-excursion
8669 (let (beg end)
8670 (if (cperl-mark-active)
8671 (setq beg (min (mark) (point))
8672 end (max (mark) (point)))
8673 (setq beg (point-min)
8674 end (point-max)))
8675 (cperl-map-pods-heres (function
8676 (lambda (s e p)
8677 (if do-heres
8678 (setq e (save-excursion
8679 (goto-char e)
8680 (forward-line -1)
8681 (point))))
8682 (ispell-region s e)
8683 t))
8684 (if do-heres 'here-doc-group 'in-pod)
8685 beg end))))
8686
8687(defun cperl-map-pods-heres (func &optional prop s end)
8688 "Executes a function over regions of pods or here-documents.
8689PROP is the text-property to search for; default to `in-pod'. Stop when
8690function returns nil."
8691 (let (pos posend has-prop (cont t))
8692 (or prop (setq prop 'in-pod))
8693 (or s (setq s (point-min)))
8694 (or end (setq end (point-max)))
8695 (cperl-update-syntaxification end end)
8696 (save-excursion
8697 (goto-char (setq pos s))
8698 (while (and cont (< pos end))
8699 (setq has-prop (get-text-property pos prop))
8700 (setq posend (next-single-property-change pos prop nil end))
8701 (and has-prop
8702 (setq cont (funcall func pos posend prop)))
8703 (setq pos posend)))))
8704
8705;;; Based on code by Masatake YAMATO:
8706(defun cperl-get-here-doc-region (&optional pos pod)
8707 "Return HERE document region around the point.
8708Return nil if the point is not in a HERE document region. If POD is non-nil,
8709will return a POD section if point is in a POD section."
8710 (or pos (setq pos (point)))
8711 (cperl-update-syntaxification pos pos)
8712 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8713 (and pod
8714 (eq 'pod (get-text-property pos 'syntax-type))))
8715 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8716 (e (next-single-property-change pos 'syntax-type)))
8717 (cons b (or e (point-max))))))
8718
8719(defun cperl-narrow-to-here-doc (&optional pos)
8720 "Narrows editing region to the HERE-DOC at POS.
8721POS defaults to the point."
8722 (interactive "d")
8723 (or pos (setq pos (point)))
8724 (let ((p (cperl-get-here-doc-region pos)))
8725 (or p (error "Not inside a HERE document"))
8726 (narrow-to-region (car p) (cdr p))
8727 (message
8728 "When you are finished with narrow editing, type C-x n w")))
8729
8730(defun cperl-select-this-pod-or-here-doc (&optional pos)
8731 "Select the HERE-DOC (or POD section) at POS.
8732POS defaults to the point."
8733 (interactive "d")
8734 (let ((p (cperl-get-here-doc-region pos t)))
8735 (if p
8736 (progn
8737 (goto-char (car p))
8738 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8739 (message "I do not think POS is in POD or a HERE-doc..."))))
8740
8741(defun cperl-facemenu-add-face-function (face end)
8742 "A callback to process user-initiated font-change requests.
8743Translates `bold', `italic', and `bold-italic' requests to insertion of
8744corresponding POD directives, and `underline' to C<> POD directive.
8745
8746Such requests are usually bound to M-o LETTER."
8747 (or (get-text-property (point) 'in-pod)
8748 (error "Faces can only be set within POD"))
8749 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8750 (cdr (or (assq face '((bold . "B<")
8751 (italic . "I<")
8752 (bold-italic . "B<I<")
8753 (underline . "C<")))
8754 (error "Face %s not configured for cperl-mode"
8755 face))))
8756\f
8757(defun cperl-time-fontification (&optional l step lim)
8758 "Times how long it takes to do incremental fontification in a region.
8759L is the line to start at, STEP is the number of lines to skip when
8760doing next incremental fontification, LIM is the maximal number of
8761incremental fontification to perform. Messages are accumulated in
8762*Messages* buffer.
8763
8764May be used for pinpointing which construct slows down buffer fontification:
8765start with default arguments, then refine the slowdown regions."
8766 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8767 (or l (setq l 1))
8768 (or step (setq step 500))
8769 (or lim (setq lim 40))
8770 (let* ((timems (function (lambda ()
8771 (let ((tt (current-time)))
8772 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8773 (tt (funcall timems)) (c 0) delta tot)
47e83968
GM
8774 (goto-char (point-min))
8775 (forward-line (1- l))
4ab89e7b
SM
8776 (cperl-mode)
8777 (setq tot (- (- tt (setq tt (funcall timems)))))
8778 (message "cperl-mode at %s: %s" l tot)
8779 (while (and (< c lim) (not (eobp)))
8780 (forward-line step)
8781 (setq l (+ l step))
8782 (setq c (1+ c))
8783 (cperl-update-syntaxification (point) (point))
8784 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8785 (message "to %s:%6s,%7s" l delta tot))
8786 tot))
8787
6546555e
DN
8788(defvar font-lock-cache-position)
8789
4ab89e7b
SM
8790(defun cperl-emulate-lazy-lock (&optional window-size)
8791 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8792Start fontifying the buffer from the start (or end) using the given
8793WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8794goes backwards; default is -50. This function is not CPerl-specific; it
8795may be used to debug problems with delayed incremental fontification."
8796 (interactive
8797 "nSize of window for incremental fontification, negative goes backwards: ")
8798 (or window-size (setq window-size -50))
8799 (let ((pos (if (> window-size 0)
8800 (point-min)
8801 (point-max)))
8802 p)
8803 (goto-char pos)
8804 (normal-mode)
8805 ;; Why needed??? With older font-locks???
8806 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8807 (while (if (> window-size 0)
8808 (< pos (point-max))
8809 (> pos (point-min)))
8810 (setq p (progn
8811 (forward-line window-size)
8812 (point)))
8813 (font-lock-fontify-region (min p pos) (max p pos))
8814 (setq pos p))))
8815
8816\f
db133cb6 8817(defun cperl-lazy-install ()) ; Avoid a warning
f739b53b 8818(defun cperl-lazy-unstall ()) ; Avoid a warning
f83d2997
KH
8819
8820(if (fboundp 'run-with-idle-timer)
8821 (progn
8822 (defvar cperl-help-shown nil
8823 "Non-nil means that the help was already shown now.")
8824
8825 (defvar cperl-lazy-installed nil
8826 "Non-nil means that the lazy-help handlers are installed now.")
8827
8828 (defun cperl-lazy-install ()
f739b53b
SM
8829 "Switches on Auto-Help on Perl constructs (put in the message area).
8830Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997 8831 (interactive)
4ab89e7b 8832 (make-local-variable 'cperl-help-shown)
f83d2997
KH
8833 (if (and (cperl-val 'cperl-lazy-help-time)
8834 (not cperl-lazy-installed))
8835 (progn
8836 (add-hook 'post-command-hook 'cperl-lazy-hook)
5c8b7eaf
SS
8837 (run-with-idle-timer
8838 (cperl-val 'cperl-lazy-help-time 1000000 5)
8839 t
f83d2997
KH
8840 'cperl-get-help-defer)
8841 (setq cperl-lazy-installed t))))
8842
8843 (defun cperl-lazy-unstall ()
f739b53b
SM
8844 "Switches off Auto-Help on Perl constructs (put in the message area).
8845Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997
KH
8846 (interactive)
8847 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8848 (cancel-function-timers 'cperl-get-help-defer)
8849 (setq cperl-lazy-installed nil))
8850
8851 (defun cperl-lazy-hook ()
8852 (setq cperl-help-shown nil))
8853
8854 (defun cperl-get-help-defer ()
83261a2f 8855 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
f83d2997
KH
8856 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8857 (cperl-get-help)
8858 (setq cperl-help-shown t))))
8859 (cperl-lazy-install)))
8860
db133cb6
RS
8861
8862;;; Plug for wrong font-lock:
8863
8864(defun cperl-font-lock-unfontify-region-function (beg end)
4ab89e7b
SM
8865 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8866 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8867 before-change-functions after-change-functions
8868 deactivate-mark buffer-file-name buffer-file-truename)
8869 (remove-text-properties beg end '(face nil))
8870 (if (and (not modified) (buffer-modified-p))
8871 (set-buffer-modified-p nil))))
8872
8873(defun cperl-font-lock-fontify-region-function (beg end loudly)
8874 "Extends the region to safe positions, then calls the default function.
8875Newer `font-lock's can do it themselves.
8876We unwind only as far as needed for fontification. Syntaxification may
8877do extra unwind via `cperl-unwind-to-safe'."
8878 (save-excursion
8879 (goto-char beg)
8880 (while (and beg
8881 (progn
8882 (beginning-of-line)
8883 (eq (get-text-property (setq beg (point)) 'syntax-type)
8884 'multiline)))
8885 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8886 (goto-char beg)))
8887 (setq beg (point))
8888 (goto-char end)
8889 (while (and end
8890 (progn
8891 (or (bolp) (condition-case nil
8892 (forward-line 1)
8893 (error nil)))
8894 (eq (get-text-property (setq end (point)) 'syntax-type)
8895 'multiline)))
8896 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8897 (goto-char end))
8898 (setq end (point)))
8899 (font-lock-default-fontify-region beg end loudly))
db133cb6
RS
8900
8901(defvar cperl-d-l nil)
8902(defun cperl-fontify-syntaxically (end)
5bd52f0e 8903 ;; Some vars for debugging only
6c389151 8904 ;; (message "Syntaxifying...")
4ab89e7b 8905 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
83261a2f 8906 (istate (car cperl-syntax-state))
4ab89e7b
SM
8907 start from-start edebug-backtrace-buffer)
8908 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8909 (progn
8910 (require 'edebug)
8911 (let ((f 'edebug-backtrace))
8912 (funcall f)))) ; Avoid compile-time warning
db133cb6 8913 (or cperl-syntax-done-to
4ab89e7b
SM
8914 (setq cperl-syntax-done-to (point-min)
8915 from-start t))
8916 (setq start (if (and cperl-hook-after-change
8917 (not from-start))
8918 cperl-syntax-done-to ; Fontify without change; ignore start
8919 ;; Need to forget what is after `start'
8920 (min cperl-syntax-done-to (point))))
8921 (goto-char start)
8922 (beginning-of-line)
8923 (setq start (point))
8924 (and cperl-syntaxify-unwind
8925 (setq end (cperl-unwind-to-safe t end)
8926 start (point)))
db133cb6
RS
8927 (and (> end start)
8928 (setq cperl-syntax-done-to start) ; In case what follows fails
8929 (cperl-find-pods-heres start end t nil t))
4ab89e7b
SM
8930 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8931 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8932 dbg iend start end idone cperl-syntax-done-to
5c8b7eaf 8933 istate (car cperl-syntax-state))) ; For debugging
83261a2f 8934 nil)) ; Do not iterate
db133cb6 8935
5bd52f0e 8936(defun cperl-fontify-update (end)
4ab89e7b
SM
8937 (let ((pos (point-min)) prop posend)
8938 (setq end (point-max))
5bd52f0e 8939 (while (< pos end)
4ab89e7b
SM
8940 (setq prop (get-text-property pos 'cperl-postpone)
8941 posend (next-single-property-change pos 'cperl-postpone nil end))
5bd52f0e
RS
8942 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8943 (setq pos posend)))
83261a2f 8944 nil) ; Do not iterate
5bd52f0e 8945
4ab89e7b
SM
8946(defun cperl-fontify-update-bad (end)
8947 ;; Since fontification happens with different region than syntaxification,
8948 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8949 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8950 (if prop
8951 (setq pos (or (cperl-beginning-of-property
8952 (cperl-1+ pos) 'cperl-postpone)
8953 (point-min))))
8954 (while (< pos end)
8955 (setq posend (next-single-property-change pos 'cperl-postpone))
8956 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8957 (setq pos posend)
8958 (setq prop (get-text-property pos 'cperl-postpone))))
8959 nil) ; Do not iterate
8960
8961;; Called when any modification is made to buffer text.
8962(defun cperl-after-change-function (beg end old-len)
8963 ;; We should have been informed about changes by `font-lock'. Since it
4c36be58 8964 ;; does not inform as which calls are deferred, do it ourselves
4ab89e7b
SM
8965 (if cperl-syntax-done-to
8966 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8967
5bd52f0e 8968(defun cperl-update-syntaxification (from to)
bde2ab6f
SM
8969 (cond
8970 ((not cperl-use-syntax-table-text-property) nil)
8971 ((fboundp 'syntax-propertize) (syntax-propertize to))
8972 ((and cperl-syntaxify-by-font-lock
8973 (or (null cperl-syntax-done-to)
8974 (< cperl-syntax-done-to to)))
8975 (save-excursion
8976 (goto-char from)
8977 (cperl-fontify-syntaxically to)))))
5bd52f0e 8978
5c8b7eaf 8979(defvar cperl-version
8c777c8d 8980 (let ((v "Revision: 6.2"))
5bd52f0e
RS
8981 (string-match ":\\s *\\([0-9.]+\\)" v)
8982 (substring v (match-beginning 1) (match-end 1)))
8983 "Version of IZ-supported CPerl package this file is based on.")
8984
f83d2997
KH
8985(provide 'cperl-mode)
8986
8987;;; cperl-mode.el ends here