Convert consecutive FSF copyright years to ranges.
[bpt/emacs.git] / lisp / progmodes / cperl-mode.el
CommitLineData
f83d2997
KH
1;;; cperl-mode.el --- Perl code editing commands for Emacs
2
73b0cd50 3;; Copyright (C) 1985-1987, 1991-2011 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))
6c389151 616 "*Non-nil means that CPerl uses `font-lock's 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;
842 c) Can insert spaces where this impoves readability (in one
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
SM
904
90510) Uses a linear-time algorith 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
930 A2) On capable Emaxen CPerl will use improved syntax-handlings
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
5bd52f0e 961 syntaxically 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
RS
972 literal parts and the terminator of formats
973 and whatever is syntaxically considered
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:
1280 ;; debugging syntaxificatio can be broken by this???
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 "----"
4ab89e7b
SM
1307 ["CPerl pretty print (exprmntl)" cperl-ps-print
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]*\\)*"
1391"Regular expression to match optional whitespace with interpspersed comments.
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\\)+"
1396"Regular expression to match whitespace with interpspersed comments.
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
GM
1514;; NB as it stands the code in cperl-mode assumes this only has one
1515;; element. If Xemacs 19 support were dropped, this could all be simplified.
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
KH
1524;;;###autoload
1525(defun cperl-mode ()
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
1540contains the parenths from the above list you want to be electrical.
1541Electricity of parenths is controlled by `cperl-electric-parens'.
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 (interactive)
1699 (kill-all-local-variables)
f83d2997
KH
1700 (use-local-map cperl-mode-map)
1701 (if (cperl-val 'cperl-electric-linefeed)
1702 (progn
1703 (local-set-key "\C-J" 'cperl-linefeed)
1704 (local-set-key "\C-C\C-J" 'newline-and-indent)))
db133cb6
RS
1705 (if (and
1706 (cperl-val 'cperl-clobber-lisp-bindings)
1707 (cperl-val 'cperl-info-on-command-no-prompt))
f83d2997
KH
1708 (progn
1709 ;; don't clobber the backspace binding:
1710 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1711 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1712 [(control c) (control h) f])))
83261a2f 1713 (setq major-mode cperl-use-major-mode)
f83d2997 1714 (setq mode-name "CPerl")
449657e8
GM
1715 (let ((prev-a-c abbrevs-changed))
1716 (define-abbrev-table 'cperl-mode-abbrev-table '(
f83d2997
KH
1717 ("if" "if" cperl-electric-keyword 0)
1718 ("elsif" "elsif" cperl-electric-keyword 0)
1719 ("while" "while" cperl-electric-keyword 0)
1720 ("until" "until" cperl-electric-keyword 0)
1721 ("unless" "unless" cperl-electric-keyword 0)
1722 ("else" "else" cperl-electric-else 0)
db133cb6 1723 ("continue" "continue" cperl-electric-else 0)
f83d2997
KH
1724 ("for" "for" cperl-electric-keyword 0)
1725 ("foreach" "foreach" cperl-electric-keyword 0)
db133cb6
RS
1726 ("formy" "formy" cperl-electric-keyword 0)
1727 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1728 ("do" "do" cperl-electric-keyword 0)
6c389151
SM
1729 ("=pod" "=pod" cperl-electric-pod 0)
1730 ("=over" "=over" cperl-electric-pod 0)
1731 ("=head1" "=head1" cperl-electric-pod 0)
1732 ("=head2" "=head2" cperl-electric-pod 0)
db133cb6
RS
1733 ("pod" "pod" cperl-electric-pod 0)
1734 ("over" "over" cperl-electric-pod 0)
1735 ("head1" "head1" cperl-electric-pod 0)
1736 ("head2" "head2" cperl-electric-pod 0)))
449657e8 1737 (setq abbrevs-changed prev-a-c))
f83d2997 1738 (setq local-abbrev-table cperl-mode-abbrev-table)
4ab89e7b
SM
1739 (if (cperl-val 'cperl-electric-keywords)
1740 (abbrev-mode 1))
f83d2997 1741 (set-syntax-table cperl-mode-syntax-table)
4ab89e7b
SM
1742 ;; Until Emacs is multi-threaded, we do not actually need it local:
1743 (make-local-variable 'cperl-font-lock-multiline-start)
1744 (make-local-variable 'cperl-font-locking)
6c389151
SM
1745 (make-local-variable 'outline-regexp)
1746 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1747 (setq outline-regexp cperl-outline-regexp)
1748 (make-local-variable 'outline-level)
1749 (setq outline-level 'cperl-outline-level)
f83d2997
KH
1750 (make-local-variable 'paragraph-start)
1751 (setq paragraph-start (concat "^$\\|" page-delimiter))
1752 (make-local-variable 'paragraph-separate)
1753 (setq paragraph-separate paragraph-start)
1754 (make-local-variable 'paragraph-ignore-fill-prefix)
1755 (setq paragraph-ignore-fill-prefix t)
6546555e 1756 (if (featurep 'xemacs)
4ab89e7b
SM
1757 (progn
1758 (make-local-variable 'paren-backwards-message)
1759 (set 'paren-backwards-message t)))
f83d2997
KH
1760 (make-local-variable 'indent-line-function)
1761 (setq indent-line-function 'cperl-indent-line)
1762 (make-local-variable 'require-final-newline)
7d441781 1763 (setq require-final-newline mode-require-final-newline)
f83d2997
KH
1764 (make-local-variable 'comment-start)
1765 (setq comment-start "# ")
1766 (make-local-variable 'comment-end)
1767 (setq comment-end "")
1768 (make-local-variable 'comment-column)
1769 (setq comment-column cperl-comment-column)
1770 (make-local-variable 'comment-start-skip)
1771 (setq comment-start-skip "#+ *")
1772 (make-local-variable 'defun-prompt-regexp)
4ab89e7b
SM
1773;;; "[ \t]*sub"
1774;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1775;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1776 (setq defun-prompt-regexp
1777 (concat "^[ \t]*\\(sub"
1778 (cperl-after-sub-regexp 'named 'attr-groups)
1779 "\\|" ; per toke.c
1780 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
1781 "\\)"
1782 cperl-maybe-white-and-comment-rex))
f83d2997
KH
1783 (make-local-variable 'comment-indent-function)
1784 (setq comment-indent-function 'cperl-comment-indent)
4ab89e7b
SM
1785 (and (boundp 'fill-paragraph-function)
1786 (progn
1787 (make-local-variable 'fill-paragraph-function)
1788 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
f83d2997
KH
1789 (make-local-variable 'parse-sexp-ignore-comments)
1790 (setq parse-sexp-ignore-comments t)
1791 (make-local-variable 'indent-region-function)
1792 (setq indent-region-function 'cperl-indent-region)
1793 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1794 (make-local-variable 'imenu-create-index-function)
1795 (setq imenu-create-index-function
80585273 1796 (function cperl-imenu--create-perl-index))
f83d2997
KH
1797 (make-local-variable 'imenu-sort-function)
1798 (setq imenu-sort-function nil)
e1a5828f
AS
1799 (make-local-variable 'vc-rcs-header)
1800 (set 'vc-rcs-header cperl-vc-rcs-header)
1801 (make-local-variable 'vc-sccs-header)
1802 (set 'vc-sccs-header cperl-vc-sccs-header)
67141a37
GM
1803 (when (featurep 'xemacs)
1804 ;; This one is obsolete...
1805 (make-local-variable 'vc-header-alist)
1806 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
1807 `((SCCS ,(car cperl-vc-sccs-header))
1808 (RCS ,(car cperl-vc-rcs-header))))))
4ab89e7b
SM
1809 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
1810 (make-local-variable 'compilation-error-regexp-alist-alist)
1811 (set 'compilation-error-regexp-alist-alist
e9bfd3a3 1812 (cons (cons 'cperl (car cperl-compilation-error-regexp-alist))
4ab89e7b 1813 (symbol-value 'compilation-error-regexp-alist-alist)))
8c777c8d
CY
1814 (if (fboundp 'compilation-build-compilation-error-regexp-alist)
1815 (let ((f 'compilation-build-compilation-error-regexp-alist))
1816 (funcall f))
1817 (make-local-variable 'compilation-error-regexp-alist)
1818 (push 'cperl compilation-error-regexp-alist)))
4ab89e7b
SM
1819 ((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
1820 (make-local-variable 'compilation-error-regexp-alist)
1821 (set 'compilation-error-regexp-alist
10715960
RS
1822 (append cperl-compilation-error-regexp-alist
1823 (symbol-value 'compilation-error-regexp-alist)))))
f83d2997
KH
1824 (make-local-variable 'font-lock-defaults)
1825 (setq font-lock-defaults
db133cb6
RS
1826 (cond
1827 ((string< emacs-version "19.30")
4ab89e7b 1828 '(cperl-font-lock-keywords-2 nil nil ((?_ . "w"))))
db133cb6 1829 ((string< emacs-version "19.33") ; Which one to use?
5efe6a56
SM
1830 '((cperl-font-lock-keywords
1831 cperl-font-lock-keywords-1
4ab89e7b 1832 cperl-font-lock-keywords-2) nil nil ((?_ . "w"))))
db133cb6
RS
1833 (t
1834 '((cperl-load-font-lock-keywords
1835 cperl-load-font-lock-keywords-1
4ab89e7b 1836 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
db133cb6 1837 (make-local-variable 'cperl-syntax-state)
4ab89e7b 1838 (setq cperl-syntax-state nil) ; reset syntaxification cache
f83d2997 1839 (if cperl-use-syntax-table-text-property
cf38dd42
SM
1840 (if (boundp 'syntax-propertize-function)
1841 (progn
1842 ;; Reset syntaxification cache.
1843 (set (make-local-variable 'cperl-syntax-done-to) nil)
1844 (set (make-local-variable 'syntax-propertize-function)
1845 (lambda (start end)
1846 (goto-char start) (cperl-fontify-syntaxically end))))
029cb4d5 1847 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997 1848 ;; Do not introduce variable if not needed, we check it!
db133cb6
RS
1849 (set 'parse-sexp-lookup-properties t)
1850 ;; Fix broken font-lock:
1851 (or (boundp 'font-lock-unfontify-region-function)
1852 (set 'font-lock-unfontify-region-function
83261a2f 1853 'font-lock-default-unfontify-region))
6546555e 1854 (unless (featurep 'xemacs) ; Our: just a plug for wrong font-lock
4ab89e7b
SM
1855 (make-local-variable 'font-lock-unfontify-region-function)
1856 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1857 'cperl-font-lock-unfontify-region-function))
029cb4d5 1858 (make-local-variable 'cperl-syntax-done-to)
4ab89e7b 1859 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
029cb4d5 1860 (make-local-variable 'font-lock-syntactic-keywords)
5c8b7eaf 1861 (setq font-lock-syntactic-keywords
db133cb6 1862 (if cperl-syntaxify-by-font-lock
11b41e6f
SM
1863 '((cperl-fontify-syntaxically))
1864 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1865 ;; used to ignore syntax-table text-properties. (t) is a hack
1866 ;; to make font-lock think that font-lock-syntactic-keywords
1867 ;; are defined.
db133cb6 1868 '(t)))))
4ab89e7b
SM
1869 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
1870 (progn
1871 (setq cperl-font-lock-multiline t) ; Not localized...
f453f5a8 1872 (set (make-local-variable 'font-lock-multiline) t))
4ab89e7b
SM
1873 (make-local-variable 'font-lock-fontify-region-function)
1874 (set 'font-lock-fontify-region-function ; not present with old Emacs
1875 'cperl-font-lock-fontify-region-function))
1876 (make-local-variable 'font-lock-fontify-region-function)
1877 (set 'font-lock-fontify-region-function ; not present with old Emacs
1878 'cperl-font-lock-fontify-region-function)
db133cb6 1879 (make-local-variable 'cperl-old-style)
83261a2f
SM
1880 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1881 (set (make-local-variable 'normal-auto-fill-function)
4ab89e7b 1882 'cperl-do-auto-fill)
83261a2f
SM
1883 (or (fboundp 'cperl-old-auto-fill-mode)
1884 (progn
1885 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1886 (defun auto-fill-mode (&optional arg)
1887 (interactive "P")
1888 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1889 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1890 (setq auto-fill-function 'cperl-do-auto-fill))))))
f83d2997 1891 (if (cperl-enable-font-lock)
5c8b7eaf 1892 (if (cperl-val 'cperl-font-lock)
f83d2997
KH
1893 (progn (or cperl-faces-init (cperl-init-faces))
1894 (font-lock-mode 1))))
4ab89e7b
SM
1895 (set (make-local-variable 'facemenu-add-face-function)
1896 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
f83d2997
KH
1897 (and (boundp 'msb-menu-cond)
1898 (not cperl-msb-fixed)
1899 (cperl-msb-fix))
1900 (if (featurep 'easymenu)
46c72468 1901 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
a3c328ee 1902 (run-mode-hooks 'cperl-mode-hook)
4ab89e7b 1903 (if cperl-hook-after-change
39234e39 1904 (add-hook 'after-change-functions 'cperl-after-change-function nil t))
f83d2997 1905 ;; After hooks since fontification will break this
5c8b7eaf 1906 (if cperl-pod-here-scan
83261a2f 1907 (or cperl-syntaxify-by-font-lock
5bd52f0e
RS
1908 (progn (or cperl-faces-init (cperl-init-faces-weak))
1909 (cperl-find-pods-heres)))))
f83d2997
KH
1910\f
1911;; Fix for perldb - make default reasonable
1912(defun cperl-db ()
1913 (interactive)
1914 (require 'gud)
1915 (perldb (read-from-minibuffer "Run perldb (like this): "
1916 (if (consp gud-perldb-history)
1917 (car gud-perldb-history)
1918 (concat "perl " ;;(file-name-nondirectory
83261a2f
SM
1919 ;; I have problems
1920 ;; in OS/2
1921 ;; otherwise
1922 (buffer-file-name)))
f83d2997
KH
1923 nil nil
1924 '(gud-perldb-history . 1))))
1925\f
f83d2997
KH
1926(defun cperl-msb-fix ()
1927 ;; Adds perl files to msb menu, supposes that msb is already loaded
1928 (setq cperl-msb-fixed t)
1929 (let* ((l (length msb-menu-cond))
1930 (last (nth (1- l) msb-menu-cond))
1931 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1932 (handle (1- (nth 1 last))))
1933 (setcdr precdr (list
1934 (list
996e2616 1935 '(memq major-mode '(cperl-mode perl-mode))
f83d2997
KH
1936 handle
1937 "Perl Files (%d)")
1938 last))))
1939\f
1940;; This is used by indent-for-comment
1941;; to decide how much to indent a comment in CPerl code
1942;; based on its context. Do fallback if comment is found wrong.
1943
1944(defvar cperl-wrong-comment)
5bd52f0e
RS
1945(defvar cperl-st-cfence '(14)) ; Comment-fence
1946(defvar cperl-st-sfence '(15)) ; String-fence
1947(defvar cperl-st-punct '(1))
1948(defvar cperl-st-word '(2))
1949(defvar cperl-st-bra '(4 . ?\>))
1950(defvar cperl-st-ket '(5 . ?\<))
1951
f83d2997 1952
4ab89e7b 1953(defun cperl-comment-indent () ; called at point at supposed comment
5bd52f0e 1954 (let ((p (point)) (c (current-column)) was phony)
4ab89e7b
SM
1955 (if (and (not cperl-indent-comment-at-column-0)
1956 (looking-at "^#"))
1957 0 ; Existing comment at bol stays there.
f83d2997
KH
1958 ;; Wrong comment found
1959 (save-excursion
5bd52f0e
RS
1960 (setq was (cperl-to-comment-or-eol)
1961 phony (eq (get-text-property (point) 'syntax-table)
1962 cperl-st-cfence))
1963 (if phony
4ab89e7b 1964 (progn ; Too naive???
5bd52f0e
RS
1965 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1966 (if (eq (preceding-char) ?\#)
1967 (forward-char -1))
1968 (setq was nil)))
4ab89e7b 1969 (if (= (point) p) ; Our caller found a correct place
f83d2997
KH
1970 (progn
1971 (skip-chars-backward " \t")
4ab89e7b
SM
1972 (setq was (current-column))
1973 (if (eq was 0)
1974 comment-column
1975 (max (1+ was) ; Else indent at comment column
1976 comment-column)))
1977 ;; No, the caller found a random place; we need to edit ourselves
f83d2997
KH
1978 (if was nil
1979 (insert comment-start)
1980 (backward-char (length comment-start)))
1981 (setq cperl-wrong-comment t)
4ab89e7b
SM
1982 (cperl-make-indent comment-column 1) ; Indent min 1
1983 c)))))
f83d2997
KH
1984
1985;;;(defun cperl-comment-indent-fallback ()
1986;;; "Is called if the standard comment-search procedure fails.
1987;;;Point is at start of real comment."
1988;;; (let ((c (current-column)) target cnt prevc)
1989;;; (if (= c comment-column) nil
1990;;; (setq cnt (skip-chars-backward "[ \t]"))
5c8b7eaf 1991;;; (setq target (max (1+ (setq prevc
f83d2997
KH
1992;;; (current-column))) ; Else indent at comment column
1993;;; comment-column))
1994;;; (if (= c comment-column) nil
1995;;; (delete-backward-char cnt)
1996;;; (while (< prevc target)
1997;;; (insert "\t")
1998;;; (setq prevc (current-column)))
1999;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2000;;; (while (< prevc target)
2001;;; (insert " ")
2002;;; (setq prevc (current-column)))))))
2003
2004(defun cperl-indent-for-comment ()
2005 "Substitute for `indent-for-comment' in CPerl."
2006 (interactive)
2007 (let (cperl-wrong-comment)
2008 (indent-for-comment)
4ab89e7b 2009 (if cperl-wrong-comment ; set by `cperl-comment-indent'
f83d2997
KH
2010 (progn (cperl-to-comment-or-eol)
2011 (forward-char (length comment-start))))))
2012
2013(defun cperl-comment-region (b e arg)
2014 "Comment or uncomment each line in the region in CPerl mode.
2015See `comment-region'."
2016 (interactive "r\np")
2017 (let ((comment-start "#"))
2018 (comment-region b e arg)))
2019
2020(defun cperl-uncomment-region (b e arg)
2021 "Uncomment or comment each line in the region in CPerl mode.
2022See `comment-region'."
2023 (interactive "r\np")
2024 (let ((comment-start "#"))
2025 (comment-region b e (- arg))))
2026
2027(defvar cperl-brace-recursing nil)
2028
2029(defun cperl-electric-brace (arg &optional only-before)
2030 "Insert character and correct line's indentation.
2031If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2032place (even in empty line), but not after. If after \")\" and the inserted
5c8b7eaf 2033char is \"{\", insert extra newline before only if
f83d2997
KH
2034`cperl-extra-newline-before-brace'."
2035 (interactive "P")
2036 (let (insertpos
2037 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2038 (cperl-mark-active)
f83d2997 2039 (< (mark) (point)))
5c8b7eaf 2040 (mark)
f83d2997
KH
2041 nil)))
2042 (if (and other-end
2043 (not cperl-brace-recursing)
2044 (cperl-val 'cperl-electric-parens)
2045 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2046 ;; Need to insert a matching pair
2047 (progn
2048 (save-excursion
2049 (setq insertpos (point-marker))
2050 (goto-char other-end)
1ba983e8 2051 (setq last-command-event ?\{)
f83d2997
KH
2052 (cperl-electric-lbrace arg insertpos))
2053 (forward-char 1))
83261a2f 2054 ;; Check whether we close something "usual" with `}'
1ba983e8 2055 (if (and (eq last-command-event ?\})
5c8b7eaf 2056 (not
db133cb6
RS
2057 (condition-case nil
2058 (save-excursion
2059 (up-list (- (prefix-numeric-value arg)))
2060 ;;(cperl-after-block-p (point-min))
f739b53b
SM
2061 (or (cperl-after-expr-p nil "{;)")
2062 ;; after sub, else, continue
2063 (cperl-after-block-p nil 'pre)))
db133cb6
RS
2064 (error nil))))
2065 ;; Just insert the guy
2066 (self-insert-command (prefix-numeric-value arg))
2067 (if (and (not arg) ; No args, end (of empty line or auto)
2068 (eolp)
2069 (or (and (null only-before)
2070 (save-excursion
2071 (skip-chars-backward " \t")
2072 (bolp)))
1ba983e8 2073 (and (eq last-command-event ?\{) ; Do not insert newline
db133cb6
RS
2074 ;; if after ")" and `cperl-extra-newline-before-brace'
2075 ;; is nil, do not insert extra newline.
2076 (not cperl-extra-newline-before-brace)
2077 (save-excursion
2078 (skip-chars-backward " \t")
2079 (eq (preceding-char) ?\))))
5c8b7eaf 2080 (if cperl-auto-newline
db133cb6
RS
2081 (progn (cperl-indent-line) (newline) t) nil)))
2082 (progn
2083 (self-insert-command (prefix-numeric-value arg))
2084 (cperl-indent-line)
2085 (if cperl-auto-newline
2086 (setq insertpos (1- (point))))
2087 (if (and cperl-auto-newline (null only-before))
2088 (progn
2089 (newline)
2090 (cperl-indent-line)))
2091 (save-excursion
2092 (if insertpos (progn (goto-char insertpos)
5c8b7eaf 2093 (search-forward (make-string
1ba983e8 2094 1 last-command-event))
db133cb6
RS
2095 (setq insertpos (1- (point)))))
2096 (delete-char -1))))
2097 (if insertpos
f83d2997 2098 (save-excursion
db133cb6
RS
2099 (goto-char insertpos)
2100 (self-insert-command (prefix-numeric-value arg)))
2101 (self-insert-command (prefix-numeric-value arg)))))))
f83d2997
KH
2102
2103(defun cperl-electric-lbrace (arg &optional end)
2104 "Insert character, correct line's indentation, correct quoting by space."
2105 (interactive "P")
83261a2f
SM
2106 (let ((cperl-brace-recursing t)
2107 (cperl-auto-newline cperl-auto-newline)
2108 (other-end (or end
2109 (if (and cperl-electric-parens-mark
2110 (cperl-mark-active)
2111 (> (mark) (point)))
2112 (save-excursion
2113 (goto-char (mark))
2114 (point-marker))
2115 nil)))
2116 pos after)
f83d2997
KH
2117 (and (cperl-val 'cperl-electric-lbrace-space)
2118 (eq (preceding-char) ?$)
2119 (save-excursion
2120 (skip-chars-backward "$")
2121 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
b5b0cb34 2122 (insert ?\s))
bab27c0c 2123 ;; Check whether we are in comment
5c8b7eaf 2124 (if (and
bab27c0c
RS
2125 (save-excursion
2126 (beginning-of-line)
2127 (not (looking-at "[ \t]*#")))
2128 (cperl-after-expr-p nil "{;)"))
2129 nil
2130 (setq cperl-auto-newline nil))
f83d2997
KH
2131 (cperl-electric-brace arg)
2132 (and (cperl-val 'cperl-electric-parens)
1ba983e8
GM
2133 (eq last-command-event ?{)
2134 (memq last-command-event
f83d2997
KH
2135 (append cperl-electric-parens-string nil))
2136 (or (if other-end (goto-char (marker-position other-end)))
2137 t)
1ba983e8 2138 (setq last-command-event ?} pos (point))
f83d2997
KH
2139 (progn (cperl-electric-brace arg t)
2140 (goto-char pos)))))
2141
2142(defun cperl-electric-paren (arg)
f739b53b
SM
2143 "Insert an opening parenthesis or a matching pair of parentheses.
2144See `cperl-electric-parens'."
f83d2997 2145 (interactive "P")
e180ab9f 2146 (let ((beg (point-at-bol))
f83d2997 2147 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2148 (cperl-mark-active)
f83d2997 2149 (> (mark) (point)))
83261a2f
SM
2150 (save-excursion
2151 (goto-char (mark))
2152 (point-marker))
f83d2997
KH
2153 nil)))
2154 (if (and (cperl-val 'cperl-electric-parens)
1ba983e8 2155 (memq last-command-event
f83d2997
KH
2156 (append cperl-electric-parens-string nil))
2157 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2158 ;;(not (save-excursion (search-backward "#" beg t)))
1ba983e8 2159 (if (eq last-command-event ?<)
f83d2997 2160 (progn
7a55c78b
CY
2161 ;; This code is too electric, see Bug#3943.
2162 ;; (and abbrev-mode ; later it is too late, may be after `for'
2163 ;; (expand-abbrev))
f83d2997
KH
2164 (cperl-after-expr-p nil "{;(,:="))
2165 1))
2166 (progn
2167 (self-insert-command (prefix-numeric-value arg))
2168 (if other-end (goto-char (marker-position other-end)))
5c8b7eaf 2169 (insert (make-string
f83d2997 2170 (prefix-numeric-value arg)
1ba983e8 2171 (cdr (assoc last-command-event '((?{ .?})
f83d2997
KH
2172 (?[ . ?])
2173 (?( . ?))
2174 (?< . ?>))))))
2175 (forward-char (- (prefix-numeric-value arg))))
2176 (self-insert-command (prefix-numeric-value arg)))))
2177
2178(defun cperl-electric-rparen (arg)
2179 "Insert a matching pair of parentheses if marking is active.
f739b53b
SM
2180If not, or if we are not at the end of marking range, would self-insert.
2181Affected by `cperl-electric-parens'."
f83d2997 2182 (interactive "P")
e180ab9f 2183 (let ((beg (point-at-bol))
f83d2997
KH
2184 (other-end (if (and cperl-electric-parens-mark
2185 (cperl-val 'cperl-electric-parens)
1ba983e8 2186 (memq last-command-event
f83d2997 2187 (append cperl-electric-parens-string nil))
5c8b7eaf 2188 (cperl-mark-active)
f83d2997 2189 (< (mark) (point)))
5c8b7eaf 2190 (mark)
f83d2997
KH
2191 nil))
2192 p)
2193 (if (and other-end
2194 (cperl-val 'cperl-electric-parens)
1ba983e8 2195 (memq last-command-event '( ?\) ?\] ?\} ?\> ))
f83d2997
KH
2196 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2197 ;;(not (save-excursion (search-backward "#" beg t)))
2198 )
2199 (progn
2200 (self-insert-command (prefix-numeric-value arg))
2201 (setq p (point))
2202 (if other-end (goto-char other-end))
2203 (insert (make-string
2204 (prefix-numeric-value arg)
1ba983e8 2205 (cdr (assoc last-command-event '((?\} . ?\{)
83261a2f
SM
2206 (?\] . ?\[)
2207 (?\) . ?\()
2208 (?\> . ?\<))))))
f83d2997
KH
2209 (goto-char (1+ p)))
2210 (self-insert-command (prefix-numeric-value arg)))))
2211
2212(defun cperl-electric-keyword ()
db133cb6
RS
2213 "Insert a construction appropriate after a keyword.
2214Help message may be switched off by setting `cperl-message-electric-keyword'
2215to nil."
e180ab9f 2216 (let ((beg (point-at-bol))
1ba983e8 2217 (dollar (and (eq last-command-event ?$)
f83d2997 2218 (eq this-command 'self-insert-command)))
1ba983e8 2219 (delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
db133cb6
RS
2220 (memq this-command '(self-insert-command newline))))
2221 my do)
f83d2997 2222 (and (save-excursion
db133cb6
RS
2223 (condition-case nil
2224 (progn
2225 (backward-sexp 1)
2226 (setq do (looking-at "do\\>")))
2227 (error nil))
f83d2997 2228 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2229 (save-excursion
2230 (not
f83d2997 2231 (re-search-backward
5bd52f0e 2232 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2233 beg t)))
2234 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2235 (or
2236 (looking-at "=cut")
2237 (and cperl-use-syntax-table-text-property
2238 (not (eq (get-text-property (point)
2239 'syntax-type)
2240 'pod))))))
f739b53b
SM
2241 (save-excursion (forward-sexp -1)
2242 (not (memq (following-char) (append "$@%&*" nil))))
f83d2997 2243 (progn
db133cb6
RS
2244 (and (eq (preceding-char) ?y)
2245 (progn ; "foreachmy"
2246 (forward-char -2)
2247 (insert " ")
2248 (forward-char 2)
5c8b7eaf
SS
2249 (setq my t dollar t
2250 delete
db133cb6 2251 (memq this-command '(self-insert-command newline)))))
f83d2997
KH
2252 (and dollar (insert " $"))
2253 (cperl-indent-line)
2254 ;;(insert " () {\n}")
2255 (cond
2256 (cperl-extra-newline-before-brace
db133cb6 2257 (insert (if do "\n" " ()\n"))
f83d2997
KH
2258 (insert "{")
2259 (cperl-indent-line)
2260 (insert "\n")
2261 (cperl-indent-line)
db133cb6
RS
2262 (insert "\n}")
2263 (and do (insert " while ();")))
f83d2997 2264 (t
83261a2f 2265 (insert (if do " {\n} while ();" " () {\n}"))))
f83d2997
KH
2266 (or (looking-at "[ \t]\\|$") (insert " "))
2267 (cperl-indent-line)
2268 (if dollar (progn (search-backward "$")
5c8b7eaf 2269 (if my
db133cb6
RS
2270 (forward-char 1)
2271 (delete-char 1)))
f739b53b 2272 (search-backward ")")
1ba983e8 2273 (if (eq last-command-event ?\()
f739b53b
SM
2274 (progn ; Avoid "if (())"
2275 (delete-backward-char 1)
2276 (delete-backward-char -1))))
f83d2997 2277 (if delete
db133cb6
RS
2278 (cperl-putback-char cperl-del-back-ch))
2279 (if cperl-message-electric-keyword
2280 (message "Precede char by C-q to avoid expansion"))))))
2281
2282(defun cperl-ensure-newlines (n &optional pos)
2283 "Make sure there are N newlines after the point."
2284 (or pos (setq pos (point)))
2285 (if (looking-at "\n")
2286 (forward-char 1)
2287 (insert "\n"))
2288 (if (> n 1)
2289 (cperl-ensure-newlines (1- n) pos)
2290 (goto-char pos)))
2291
2292(defun cperl-electric-pod ()
2293 "Insert a POD chunk appropriate after a =POD directive."
1ba983e8 2294 (let ((delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
db133cb6
RS
2295 (memq this-command '(self-insert-command newline))))
2296 head1 notlast name p really-delete over)
2297 (and (save-excursion
6c389151 2298 (forward-word -1)
a1506d29 2299 (and
db133cb6
RS
2300 (eq (preceding-char) ?=)
2301 (progn
6c389151
SM
2302 (setq head1 (looking-at "head1\\>[ \t]*$"))
2303 (setq over (and (looking-at "over\\>[ \t]*$")
2304 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
db133cb6
RS
2305 (forward-char -1)
2306 (bolp))
5c8b7eaf 2307 (or
5bd52f0e 2308 (get-text-property (point) 'in-pod)
db133cb6 2309 (cperl-after-expr-p nil "{;:")
4ab89e7b
SM
2310 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
2311 (not (looking-at "\n*=cut"))
2312 (or (not cperl-use-syntax-table-text-property)
2313 (eq (get-text-property (point) 'syntax-type) 'pod))))))
db133cb6
RS
2314 (progn
2315 (save-excursion
6c389151 2316 (setq notlast (re-search-forward "^\n=" nil t)))
db133cb6
RS
2317 (or notlast
2318 (progn
2319 (insert "\n\n=cut")
2320 (cperl-ensure-newlines 2)
6c389151 2321 (forward-word -2)
a1506d29
JB
2322 (if (and head1
2323 (not
db133cb6
RS
2324 (save-excursion
2325 (forward-char -1)
2326 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
83261a2f 2327 nil t)))) ; Only one
a1506d29 2328 (progn
6c389151 2329 (forward-word 1)
db133cb6
RS
2330 (setq name (file-name-sans-extension
2331 (file-name-nondirectory (buffer-file-name)))
2332 p (point))
5c8b7eaf 2333 (insert " NAME\n\n" name
029cb4d5 2334 " - \n\n=head1 SYNOPSIS\n\n\n\n"
db133cb6
RS
2335 "=head1 DESCRIPTION")
2336 (cperl-ensure-newlines 4)
2337 (goto-char p)
6c389151 2338 (forward-word 2)
db133cb6
RS
2339 (end-of-line)
2340 (setq really-delete t))
6c389151 2341 (forward-word 1))))
db133cb6
RS
2342 (if over
2343 (progn
2344 (setq p (point))
2345 (insert "\n\n=item \n\n\n\n"
2346 "=back")
2347 (cperl-ensure-newlines 2)
2348 (goto-char p)
6c389151 2349 (forward-word 1)
db133cb6
RS
2350 (end-of-line)
2351 (setq really-delete t)))
2352 (if (and delete really-delete)
f83d2997
KH
2353 (cperl-putback-char cperl-del-back-ch))))))
2354
2355(defun cperl-electric-else ()
db133cb6
RS
2356 "Insert a construction appropriate after a keyword.
2357Help message may be switched off by setting `cperl-message-electric-keyword'
2358to nil."
e180ab9f 2359 (let ((beg (point-at-bol)))
f83d2997
KH
2360 (and (save-excursion
2361 (backward-sexp 1)
2362 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2363 (save-excursion
2364 (not
f83d2997 2365 (re-search-backward
5bd52f0e 2366 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2367 beg t)))
2368 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2369 (looking-at "=cut")
2370 (and cperl-use-syntax-table-text-property
2371 (not (eq (get-text-property (point)
2372 'syntax-type)
2373 'pod)))))
f83d2997
KH
2374 (progn
2375 (cperl-indent-line)
2376 ;;(insert " {\n\n}")
2377 (cond
2378 (cperl-extra-newline-before-brace
2379 (insert "\n")
2380 (insert "{")
2381 (cperl-indent-line)
2382 (insert "\n\n}"))
2383 (t
83261a2f 2384 (insert " {\n\n}")))
f83d2997
KH
2385 (or (looking-at "[ \t]\\|$") (insert " "))
2386 (cperl-indent-line)
2387 (forward-line -1)
2388 (cperl-indent-line)
db133cb6
RS
2389 (cperl-putback-char cperl-del-back-ch)
2390 (setq this-command 'cperl-electric-else)
2391 (if cperl-message-electric-keyword
2392 (message "Precede char by C-q to avoid expansion"))))))
f83d2997
KH
2393
2394(defun cperl-linefeed ()
db133cb6
RS
2395 "Go to end of line, open a new line and indent appropriately.
2396If in POD, insert appropriate lines."
f83d2997 2397 (interactive)
e180ab9f
GM
2398 (let ((beg (point-at-bol))
2399 (end (point-at-eol))
db133cb6 2400 (pos (point)) start over cut res)
f83d2997 2401 (if (and ; Check if we need to split:
5c8b7eaf 2402 ; i.e., on a boundary and inside "{...}"
f83d2997 2403 (save-excursion (cperl-to-comment-or-eol)
83261a2f 2404 (>= (point) pos)) ; Not in a comment
f83d2997
KH
2405 (or (save-excursion
2406 (skip-chars-backward " \t" beg)
2407 (forward-char -1)
2408 (looking-at "[;{]")) ; After { or ; + spaces
2409 (looking-at "[ \t]*}") ; Before }
2410 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2411 (save-excursion
2412 (and
5c8b7eaf 2413 (eq (car (parse-partial-sexp pos end -1)) -1)
f83d2997
KH
2414 ; Leave the level of parens
2415 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2416 ; Are at end
6c389151 2417 (cperl-after-block-p (point-min))
f83d2997
KH
2418 (progn
2419 (backward-sexp 1)
2420 (setq start (point-marker))
db133cb6 2421 (<= start pos))))) ; Redundant? Are after the
f83d2997
KH
2422 ; start of parens group.
2423 (progn
2424 (skip-chars-backward " \t")
2425 (or (memq (preceding-char) (append ";{" nil))
2426 (insert ";"))
2427 (insert "\n")
2428 (forward-line -1)
2429 (cperl-indent-line)
2430 (goto-char start)
2431 (or (looking-at "{[ \t]*$") ; If there is a statement
2432 ; before, move it to separate line
2433 (progn
2434 (forward-char 1)
2435 (insert "\n")
2436 (cperl-indent-line)))
2437 (forward-line 1) ; We are on the target line
2438 (cperl-indent-line)
2439 (beginning-of-line)
2440 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
83261a2f 2441 ; after, move it to separate line
f83d2997
KH
2442 (progn
2443 (end-of-line)
2444 (search-backward "}" beg)
2445 (skip-chars-backward " \t")
2446 (or (memq (preceding-char) (append ";{" nil))
2447 (insert ";"))
2448 (insert "\n")
2449 (cperl-indent-line)
2450 (forward-line -1)))
5c8b7eaf 2451 (forward-line -1) ; We are on the line before target
f83d2997
KH
2452 (end-of-line)
2453 (newline-and-indent))
db133cb6 2454 (end-of-line) ; else - no splitting
f83d2997
KH
2455 (cond
2456 ((and (looking-at "\n[ \t]*{$")
2457 (save-excursion
2458 (skip-chars-backward " \t")
2459 (eq (preceding-char) ?\)))) ; Probably if () {} group
83261a2f 2460 ; with an extra newline.
f83d2997
KH
2461 (forward-line 2)
2462 (cperl-indent-line))
db133cb6
RS
2463 ((save-excursion ; In POD header
2464 (forward-paragraph -1)
2465 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2466 ;; We are after \n now, so look for the rest
2467 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
5c8b7eaf 2468 (progn
db133cb6
RS
2469 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2470 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2471 t)))
2472 (if (and over
2473 (progn
2474 (forward-paragraph -1)
2475 (forward-word 1)
2476 (setq pos (point))
e180ab9f
GM
2477 (setq cut (buffer-substring (point) (point-at-eol)))
2478 (delete-char (- (point-at-eol) (point)))
db133cb6
RS
2479 (setq res (expand-abbrev))
2480 (save-excursion
2481 (goto-char pos)
2482 (insert cut))
2483 res))
2484 nil
2485 (cperl-ensure-newlines (if cut 2 4))
2486 (forward-line 2)))
2487 ((get-text-property (point) 'in-pod) ; In POD section
2488 (cperl-ensure-newlines 4)
2489 (forward-line 2))
f83d2997
KH
2490 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2491 (forward-line 1)
2492 (cperl-indent-line))
2493 (t
2494 (newline-and-indent))))))
2495
2496(defun cperl-electric-semi (arg)
2497 "Insert character and correct line's indentation."
2498 (interactive "P")
2499 (if cperl-auto-newline
2500 (cperl-electric-terminator arg)
6c389151
SM
2501 (self-insert-command (prefix-numeric-value arg))
2502 (if cperl-autoindent-on-semi
2503 (cperl-indent-line))))
f83d2997
KH
2504
2505(defun cperl-electric-terminator (arg)
2506 "Insert character and correct line's indentation."
2507 (interactive "P")
83261a2f
SM
2508 (let ((end (point))
2509 (auto (and cperl-auto-newline
1ba983e8 2510 (or (not (eq last-command-event ?:))
83261a2f
SM
2511 cperl-auto-newline-after-colon)))
2512 insertpos)
5c8b7eaf 2513 (if (and ;;(not arg)
f83d2997
KH
2514 (eolp)
2515 (not (save-excursion
2516 (beginning-of-line)
2517 (skip-chars-forward " \t")
2518 (or
2519 ;; Ignore in comment lines
2520 (= (following-char) ?#)
2521 ;; Colon is special only after a label
2522 ;; So quickly rule out most other uses of colon
2523 ;; and do no indentation for them.
1ba983e8 2524 (and (eq last-command-event ?:)
f83d2997
KH
2525 (save-excursion
2526 (forward-word 1)
2527 (skip-chars-forward " \t")
2528 (and (< (point) end)
2529 (progn (goto-char (- end 1))
2530 (not (looking-at ":"))))))
2531 (progn
2532 (beginning-of-defun)
2533 (let ((pps (parse-partial-sexp (point) end)))
2534 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2535 (progn
2536 (self-insert-command (prefix-numeric-value arg))
2537 ;;(forward-char -1)
2538 (if auto (setq insertpos (point-marker)))
2539 ;;(forward-char 1)
2540 (cperl-indent-line)
2541 (if auto
2542 (progn
2543 (newline)
2544 (cperl-indent-line)))
f83d2997
KH
2545 (save-excursion
2546 (if insertpos (goto-char (1- (marker-position insertpos)))
2547 (forward-char -1))
2548 (delete-char 1))))
2549 (if insertpos
2550 (save-excursion
2551 (goto-char insertpos)
2552 (self-insert-command (prefix-numeric-value arg)))
2553 (self-insert-command (prefix-numeric-value arg)))))
2554
2555(defun cperl-electric-backspace (arg)
8c777c8d
CY
2556 "Backspace, or remove whitespace around the point inserted by an electric key.
2557Will untabify if `cperl-electric-backspace-untabify' is non-nil."
f83d2997 2558 (interactive "p")
5c8b7eaf
SS
2559 (if (and cperl-auto-newline
2560 (memq last-command '(cperl-electric-semi
f83d2997
KH
2561 cperl-electric-terminator
2562 cperl-electric-lbrace))
b5b0cb34 2563 (memq (preceding-char) '(?\s ?\t ?\n)))
f83d2997 2564 (let (p)
5c8b7eaf 2565 (if (eq last-command 'cperl-electric-lbrace)
f83d2997
KH
2566 (skip-chars-forward " \t\n"))
2567 (setq p (point))
2568 (skip-chars-backward " \t\n")
2569 (delete-region (point) p))
db133cb6
RS
2570 (and (eq last-command 'cperl-electric-else)
2571 ;; We are removing the whitespace *inside* cperl-electric-else
2572 (setq this-command 'cperl-electric-else-really))
5c8b7eaf 2573 (if (and cperl-auto-newline
db133cb6 2574 (eq last-command 'cperl-electric-else-really)
b5b0cb34 2575 (memq (preceding-char) '(?\s ?\t ?\n)))
db133cb6
RS
2576 (let (p)
2577 (skip-chars-forward " \t\n")
2578 (setq p (point))
2579 (skip-chars-backward " \t\n")
2580 (delete-region (point) p))
f739b53b
SM
2581 (if cperl-electric-backspace-untabify
2582 (backward-delete-char-untabify arg)
2583 (delete-backward-char arg)))))
f83d2997 2584
d6156ce8
KS
2585(put 'cperl-electric-backspace 'delete-selection 'supersede)
2586
4ab89e7b 2587(defun cperl-inside-parens-p () ;; NOT USED????
f83d2997
KH
2588 (condition-case ()
2589 (save-excursion
2590 (save-restriction
2591 (narrow-to-region (point)
2592 (progn (beginning-of-defun) (point)))
2593 (goto-char (point-max))
2594 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2595 (error nil)))
2596\f
2597(defun cperl-indent-command (&optional whole-exp)
2598 "Indent current line as Perl code, or in some cases insert a tab character.
5c8b7eaf 2599If `cperl-tab-always-indent' is non-nil (the default), always indent current
db133cb6 2600line. Otherwise, indent the current line only if point is at the left margin
f83d2997
KH
2601or in the line's indentation; otherwise insert a tab.
2602
2603A numeric argument, regardless of its value,
2604means indent rigidly all the lines of the expression starting after point
2605so that this line becomes properly indented.
2606The relative indentation among the lines of the expression are preserved."
2607 (interactive "P")
5bd52f0e 2608 (cperl-update-syntaxification (point) (point))
f83d2997
KH
2609 (if whole-exp
2610 ;; If arg, always indent this line as Perl
2611 ;; and shift remaining lines of expression the same amount.
2612 (let ((shift-amt (cperl-indent-line))
2613 beg end)
2614 (save-excursion
2615 (if cperl-tab-always-indent
2616 (beginning-of-line))
2617 (setq beg (point))
2618 (forward-sexp 1)
2619 (setq end (point))
2620 (goto-char beg)
2621 (forward-line 1)
2622 (setq beg (point)))
db133cb6 2623 (if (and shift-amt (> end beg))
f83d2997
KH
2624 (indent-code-rigidly beg end shift-amt "#")))
2625 (if (and (not cperl-tab-always-indent)
2626 (save-excursion
2627 (skip-chars-backward " \t")
2628 (not (bolp))))
2629 (insert-tab)
2630 (cperl-indent-line))))
2631
5bd52f0e 2632(defun cperl-indent-line (&optional parse-data)
f83d2997
KH
2633 "Indent current line as Perl code.
2634Return the amount the indentation changed by."
83261a2f
SM
2635 (let ((case-fold-search nil)
2636 (pos (- (point-max) (point)))
2637 indent i beg shift-amt)
5bd52f0e 2638 (setq indent (cperl-calculate-indent parse-data)
db133cb6 2639 i indent)
f83d2997
KH
2640 (beginning-of-line)
2641 (setq beg (point))
2642 (cond ((or (eq indent nil) (eq indent t))
db133cb6 2643 (setq indent (current-indentation) i nil))
f83d2997
KH
2644 ;;((eq indent t) ; Never?
2645 ;; (setq indent (cperl-calculate-indent-within-comment)))
2646 ;;((looking-at "[ \t]*#")
2647 ;; (setq indent 0))
2648 (t
2649 (skip-chars-forward " \t")
2650 (if (listp indent) (setq indent (car indent)))
82d9a08d
SM
2651 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2652 (not (looking-at "[smy]:\\|tr:")))
f83d2997
KH
2653 (and (> indent 0)
2654 (setq indent (max cperl-min-label-indent
2655 (+ indent cperl-label-offset)))))
2656 ((= (following-char) ?})
2657 (setq indent (- indent cperl-indent-level)))
2658 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2659 (setq indent (+ indent cperl-close-paren-offset)))
2660 ((= (following-char) ?{)
2661 (setq indent (+ indent cperl-brace-offset))))))
2662 (skip-chars-forward " \t")
db133cb6
RS
2663 (setq shift-amt (and i (- indent (current-column))))
2664 (if (or (not shift-amt)
2665 (zerop shift-amt))
f83d2997
KH
2666 (if (> (- (point-max) pos) (point))
2667 (goto-char (- (point-max) pos)))
4ab89e7b
SM
2668 ;;;(delete-region beg (point))
2669 ;;;(indent-to indent)
2670 (cperl-make-indent indent)
f83d2997
KH
2671 ;; If initial point was within line's indentation,
2672 ;; position after the indentation. Else stay at same point in text.
2673 (if (> (- (point-max) pos) (point))
2674 (goto-char (- (point-max) pos))))
2675 shift-amt))
2676
2677(defun cperl-after-label ()
2678 ;; Returns true if the point is after label. Does not do save-excursion.
2679 (and (eq (preceding-char) ?:)
2680 (memq (char-syntax (char-after (- (point) 2)))
2681 '(?w ?_))
2682 (progn
2683 (backward-sexp)
2684 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2685
2686(defun cperl-get-state (&optional parse-start start-state)
5bd52f0e
RS
2687 ;; returns list (START STATE DEPTH PRESTART),
2688 ;; START is a good place to start parsing, or equal to
5c8b7eaf 2689 ;; PARSE-START if preset,
5bd52f0e
RS
2690 ;; STATE is what is returned by `parse-partial-sexp'.
2691 ;; DEPTH is true is we are immediately after end of block
2692 ;; which contains START.
2693 ;; PRESTART is the position basing on which START was found.
f83d2997
KH
2694 (save-excursion
2695 (let ((start-point (point)) depth state start prestart)
5bd52f0e
RS
2696 (if (and parse-start
2697 (<= parse-start start-point))
f83d2997 2698 (goto-char parse-start)
5bd52f0e
RS
2699 (beginning-of-defun)
2700 (setq start-state nil))
f83d2997
KH
2701 (setq prestart (point))
2702 (if start-state nil
2703 ;; Try to go out, if sub is not on the outermost level
2704 (while (< (point) start-point)
2705 (setq start (point) parse-start start depth nil
2706 state (parse-partial-sexp start start-point -1))
2707 (if (> (car state) -1) nil
2708 ;; The current line could start like }}}, so the indentation
2709 ;; corresponds to a different level than what we reached
2710 (setq depth t)
2711 (beginning-of-line 2))) ; Go to the next line.
2712 (if start (goto-char start))) ; Not at the start of file
2713 (setq start (point))
f83d2997
KH
2714 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2715 (list start state depth prestart))))
2716
f83d2997
KH
2717(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2718
4ab89e7b
SM
2719(defun cperl-beginning-of-property (p prop &optional lim)
2720 "Given that P has a property PROP, find where the property starts.
2721Will not look before LIM."
2722 ;;; XXXX What to do at point-max???
2723 (or (previous-single-property-change (cperl-1+ p) prop lim)
2724 (point-min))
2725;;; (cond ((eq p (point-min))
2726;;; p)
2727;;; ((and lim (<= p lim))
2728;;; p)
2729;;; ((not (get-text-property (1- p) prop))
2730;;; p)
2731;;; (t (or (previous-single-property-change p look-prop lim)
2732;;; (point-min))))
2733 )
2734
2735(defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
8c777c8d 2736 ;; the sniffer logic to understand what the current line MEANS.
f739b53b 2737 (cperl-update-syntaxification (point) (point))
4ab89e7b
SM
2738 (let ((res (get-text-property (point) 'syntax-type)))
2739 (save-excursion
2740 (cond
2741 ((and (memq res '(pod here-doc here-doc-delim format))
2742 (not (get-text-property (point) 'indentable)))
2743 (vector res))
2744 ;; before start of POD - whitespace found since do not have 'pod!
2745 ((looking-at "[ \t]*\n=")
2746 (error "Spaces before POD section!"))
2747 ((and (not cperl-indent-left-aligned-comments)
2748 (looking-at "^#"))
2749 [comment-special:at-beginning-of-line])
2750 ((get-text-property (point) 'in-pod)
2751 [in-pod])
2752 (t
2753 (beginning-of-line)
2754 (let* ((indent-point (point))
2755 (char-after-pos (save-excursion
2756 (skip-chars-forward " \t")
2757 (point)))
2758 (char-after (char-after char-after-pos))
2759 (pre-indent-point (point))
2760 p prop look-prop is-block delim)
2761 (save-excursion ; Know we are not in POD, find appropriate pos before
83261a2f
SM
2762 (cperl-backward-to-noncomment nil)
2763 (setq p (max (point-min) (1- (point)))
2764 prop (get-text-property p 'syntax-type)
2765 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2766 'syntax-type))
2767 (if (memq prop '(pod here-doc format here-doc-delim))
2768 (progn
4ab89e7b 2769 (goto-char (cperl-beginning-of-property p look-prop))
83261a2f 2770 (beginning-of-line)
4ab89e7b
SM
2771 (setq pre-indent-point (point)))))
2772 (goto-char pre-indent-point) ; Orig line skipping preceeding pod/etc
2773 (let* ((case-fold-search nil)
2774 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2775 (start (or (nth 2 parse-data) ; last complete sexp terminated
2776 (nth 0 s-s))) ; Good place to start parsing
2777 (state (nth 1 s-s))
2778 (containing-sexp (car (cdr state)))
2779 old-indent)
2780 (if (and
2781 ;;containing-sexp ;; We are buggy at toplevel :-(
2782 parse-data)
2783 (progn
2784 (setcar parse-data pre-indent-point)
2785 (setcar (cdr parse-data) state)
2786 (or (nth 2 parse-data)
2787 (setcar (cddr parse-data) start))
2788 ;; Before this point: end of statement
2789 (setq old-indent (nth 3 parse-data))))
2790 (cond ((get-text-property (point) 'indentable)
2791 ;; indent to "after" the surrounding open
2792 ;; (same offset as `cperl-beautify-regexp-piece'),
2793 ;; skip blanks if we do not close the expression.
2794 (setq delim ; We do not close the expression
2795 (get-text-property
2796 (cperl-1+ char-after-pos) 'indentable)
2797 p (1+ (cperl-beginning-of-property
2798 (point) 'indentable))
2799 is-block ; misused for: preceeding line in REx
2800 (save-excursion ; Find preceeding line
2801 (cperl-backward-to-noncomment p)
2802 (beginning-of-line)
2803 (if (<= (point) p)
2804 (progn ; get indent from the first line
2805 (goto-char p)
2806 (skip-chars-forward " \t")
2807 (if (memq (char-after (point))
2808 (append "#\n" nil))
2809 nil ; Can't use intentation of this line...
2810 (point)))
2811 (skip-chars-forward " \t")
2812 (point)))
2813 prop (parse-partial-sexp p char-after-pos))
2814 (cond ((not delim) ; End the REx, ignore is-block
2815 (vector 'indentable 'terminator p is-block))
2816 (is-block ; Indent w.r.t. preceeding line
2817 (vector 'indentable 'cont-line char-after-pos
2818 is-block char-after p))
2819 (t ; No preceeding line...
2820 (vector 'indentable 'first-line p))))
2821 ((get-text-property char-after-pos 'REx-part2)
2822 (vector 'REx-part2 (point)))
4ab89e7b 2823 ((nth 4 state)
82d9a08d
SM
2824 [comment])
2825 ((nth 3 state)
4ab89e7b
SM
2826 [string])
2827 ;; XXXX Do we need to special-case this?
2828 ((null containing-sexp)
2829 ;; Line is at top level. May be data or function definition,
2830 ;; or may be function argument declaration.
2831 ;; Indent like the previous top level line
2832 ;; unless that ends in a closeparen without semicolon,
2833 ;; in which case this line is the first argument decl.
2834 (skip-chars-forward " \t")
2835 (cperl-backward-to-noncomment (or old-indent (point-min)))
2836 (setq state
2837 (or (bobp)
2838 (eq (point) old-indent) ; old-indent was at comment
2839 (eq (preceding-char) ?\;)
2840 ;; Had ?\) too
2841 (and (eq (preceding-char) ?\})
2842 (cperl-after-block-and-statement-beg
2843 (point-min))) ; Was start - too close
2844 (memq char-after (append ")]}" nil))
2845 (and (eq (preceding-char) ?\:) ; label
83261a2f
SM
2846 (progn
2847 (forward-sexp -1)
4ab89e7b
SM
2848 (skip-chars-backward " \t")
2849 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2850 (get-text-property (point) 'first-format-line)))
cb5bf6ba 2851
4ab89e7b
SM
2852 ;; Look at previous line that's at column 0
2853 ;; to determine whether we are in top-level decls
2854 ;; or function's arg decls. Set basic-indent accordingly.
2855 ;; Now add a little if this is a continuation line.
2856 (and state
2857 parse-data
2858 (not (eq char-after ?\C-j))
2859 (setcdr (cddr parse-data)
2860 (list pre-indent-point)))
2861 (vector 'toplevel start char-after state (nth 2 s-s)))
2862 ((not
2863 (or (setq is-block
2864 (and (setq delim (= (char-after containing-sexp) ?{))
2865 (save-excursion ; Is it a hash?
2866 (goto-char containing-sexp)
2867 (cperl-block-p))))
2868 cperl-indent-parens-as-block))
2869 ;; group is an expression, not a block:
2870 ;; indent to just after the surrounding open parens,
2871 ;; skip blanks if we do not close the expression.
2872 (goto-char (1+ containing-sexp))
2873 (or (memq char-after
2874 (append (if delim "}" ")]}") nil))
2875 (looking-at "[ \t]*\\(#\\|$\\)")
2876 (skip-chars-forward " \t"))
2877 (setq old-indent (point)) ; delim=is-brace
2878 (vector 'in-parens char-after (point) delim containing-sexp))
2879 (t
2880 ;; Statement level. Is it a continuation or a new statement?
2881 ;; Find previous non-comment character.
2882 (goto-char pre-indent-point) ; Skip one level of POD/etc
2883 (cperl-backward-to-noncomment containing-sexp)
2884 ;; Back up over label lines, since they don't
2885 ;; affect whether our line is a continuation.
2886 ;; (Had \, too)
2887 (while;;(or (eq (preceding-char) ?\,)
2888 (and (eq (preceding-char) ?:)
2889 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2890 (memq (char-syntax (char-after (- (point) 2)))
2891 '(?w ?_))))
2892 ;;)
2893 ;; This is always FALSE?
2894 (if (eq (preceding-char) ?\,)
2895 ;; Will go to beginning of line, essentially.
2896 ;; Will ignore embedded sexpr XXXX.
2897 (cperl-backward-to-start-of-continued-exp containing-sexp))
2898 (beginning-of-line)
2899 (cperl-backward-to-noncomment containing-sexp))
2900 ;; Now we get non-label preceeding the indent point
2901 (if (not (or (eq (1- (point)) containing-sexp)
2902 (memq (preceding-char)
2903 (append (if is-block " ;{" " ,;{") '(nil)))
2904 (and (eq (preceding-char) ?\})
2905 (cperl-after-block-and-statement-beg
2906 containing-sexp))
2907 (get-text-property (point) 'first-format-line)))
2908 ;; This line is continuation of preceding line's statement;
2909 ;; indent `cperl-continued-statement-offset' more than the
2910 ;; previous line of the statement.
2911 ;;
2912 ;; There might be a label on this line, just
2913 ;; consider it bad style and ignore it.
2914 (progn
2915 (cperl-backward-to-start-of-continued-exp containing-sexp)
2916 (vector 'continuation (point) char-after is-block delim))
2917 ;; This line starts a new statement.
2918 ;; Position following last unclosed open brace
2919 (goto-char containing-sexp)
2920 ;; Is line first statement after an open-brace?
2921 (or
2922 ;; If no, find that first statement and indent like
2923 ;; it. If the first statement begins with label, do
2924 ;; not believe when the indentation of the label is too
2925 ;; small.
2926 (save-excursion
2927 (forward-char 1)
2928 (let ((colon-line-end 0))
2929 (while
2930 (progn (skip-chars-forward " \t\n")
82d9a08d
SM
2931 ;; s: foo : bar :x is NOT label
2932 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2933 (not (looking-at "[sym]:\\|tr:"))))
4ab89e7b
SM
2934 ;; Skip over comments and labels following openbrace.
2935 (cond ((= (following-char) ?\#)
2936 (forward-line 1))
2937 ((= (following-char) ?\=)
2938 (goto-char
2939 (or (next-single-property-change (point) 'in-pod)
2940 (point-max)))) ; do not loop if no syntaxification
2941 ;; label:
2942 (t
e180ab9f 2943 (setq colon-line-end (point-at-eol))
4ab89e7b
SM
2944 (search-forward ":"))))
2945 ;; We are at beginning of code (NOT label or comment)
2946 ;; First, the following code counts
2947 ;; if it is before the line we want to indent.
2948 (and (< (point) indent-point)
2949 (vector 'have-prev-sibling (point) colon-line-end
2950 containing-sexp))))
2951 (progn
2952 ;; If no previous statement,
2953 ;; indent it relative to line brace is on.
2954
2955 ;; For open-braces not the first thing in a line,
2956 ;; add in cperl-brace-imaginary-offset.
2957
2958 ;; If first thing on a line: ?????
2959 ;; Move back over whitespace before the openbrace.
2960 (setq ; brace first thing on a line
2961 old-indent (progn (skip-chars-backward " \t") (bolp)))
2962 ;; Should we indent w.r.t. earlier than start?
2963 ;; Move to start of control group, possibly on a different line
2964 (or cperl-indent-wrt-brace
2965 (cperl-backward-to-noncomment (point-min)))
2966 ;; If the openbrace is preceded by a parenthesized exp,
2967 ;; move to the beginning of that;
2968 (if (eq (preceding-char) ?\))
2969 (progn
2970 (forward-sexp -1)
2971 (cperl-backward-to-noncomment (point-min))))
2972 ;; In the case it starts a subroutine, indent with
2973 ;; respect to `sub', not with respect to the
2974 ;; first thing on the line, say in the case of
2975 ;; anonymous sub in a hash.
2976 (if (and;; Is it a sub in group starting on this line?
2977 (cond ((get-text-property (point) 'attrib-group)
2978 (goto-char (cperl-beginning-of-property
2979 (point) 'attrib-group)))
2980 ((eq (preceding-char) ?b)
2981 (forward-sexp -1)
2982 (looking-at "sub\\>")))
2983 (setq p (nth 1 ; start of innermost containing list
2984 (parse-partial-sexp
9b026d9f 2985 (point-at-bol)
4ab89e7b
SM
2986 (point)))))
2987 (progn
2988 (goto-char (1+ p)) ; enclosing block on the same line
2989 (skip-chars-forward " \t")
2990 (vector 'code-start-in-block containing-sexp char-after
2991 (and delim (not is-block)) ; is a HASH
2992 old-indent ; brace first thing on a line
2993 t (point) ; have something before...
2994 )
2995 ;;(current-column)
2996 )
2997 ;; Get initial indentation of the line we are on.
2998 ;; If line starts with label, calculate label indentation
2999 (vector 'code-start-in-block containing-sexp char-after
3000 (and delim (not is-block)) ; is a HASH
3001 old-indent ; brace first thing on a line
82d9a08d 3002 nil (point))))))))))))))) ; nothing interesting before
4ab89e7b
SM
3003
3004(defvar cperl-indent-rules-alist
3005 '((pod nil) ; via `syntax-type' property
3006 (here-doc nil) ; via `syntax-type' property
3007 (here-doc-delim nil) ; via `syntax-type' property
3008 (format nil) ; via `syntax-type' property
3009 (in-pod nil) ; via `in-pod' property
3010 (comment-special:at-beginning-of-line nil)
3011 (string t)
3012 (comment nil))
3013 "Alist of indentation rules for CPerl mode.
3014The values mean:
3015 nil: do not indent;
82d9a08d 3016 number: add this amount of indentation.")
4ab89e7b
SM
3017
3018(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3019 "Return appropriate indentation for current line as Perl code.
3020In usual case returns an integer: the column to indent to.
3021Returns nil if line starts inside a string, t if in a comment.
3022
3023Will not correct the indentation for labels, but will correct it for braces
3024and closing parentheses and brackets."
3025 ;; This code is still a broken architecture: in some cases we need to
3026 ;; compensate for some modifications which `cperl-indent-line' will add later
3027 (save-excursion
3028 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3029 (cond
3030 ;;((or (null i) (eq i t) (numberp i))
3031 ;; i)
3032 ((vectorp i)
3033 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3034 (cond
3035 (what (cadr what)) ; Load from table
3036 ;;
3037 ;; Indenters for regular expressions with //x and qw()
3038 ;;
3039 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3040 (goto-char (elt i 1))
3041 (condition-case nil ; Use indentation of the 1st part
3042 (forward-sexp -1))
3043 (current-column))
3044 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3045 (cond ;;; [indentable terminator start-pos is-block]
3046 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3047 (goto-char (elt i 2)) ; After opening parens
3048 (1- (current-column)))
3049 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3050 (goto-char (elt i 2))
3051 (+ (or cperl-regexp-indent-step cperl-indent-level)
3052 -1
3053 (current-column)))
3054 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3055 ;; Indent as the level after closing parens
3056 (goto-char (elt i 2)) ; indent line
3057 (skip-chars-forward " \t)") ; Skip closing parens
3058 (setq p (point))
3059 (goto-char (elt i 3)) ; previous line
3060 (skip-chars-forward " \t)") ; Skip closing parens
3061 ;; Number of parens in between:
3062 (setq p (nth 0 (parse-partial-sexp (point) p))
3063 what (elt i 4)) ; First char on current line
3064 (goto-char (elt i 3)) ; previous line
3065 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3066 (cond ((eq what ?\) )
3067 (- cperl-close-paren-offset)) ; compensate
3068 ((eq what ?\| )
3069 (- (or cperl-regexp-indent-step cperl-indent-level)))
3070 (t 0))
3071 (if (eq (following-char) ?\| )
3072 (or cperl-regexp-indent-step cperl-indent-level)
3073 0)
3074 (current-column)))
3075 (t
3076 (error "Unrecognized value of indent: %s" i))))
3077 ;;
3078 ;; Indenter for stuff at toplevel
3079 ;;
3080 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3081 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3082 (goto-char (elt i 1)) ; start = Good place to start parsing
cb5bf6ba 3083 (- (current-indentation) ;
4ab89e7b
SM
3084 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3085 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3086 ;; Look at previous line that's at column 0
3087 ;; to determine whether we are in top-level decls
3088 ;; or function's arg decls. Set basic-indent accordingly.
3089 ;; Now add a little if this is a continuation line.
3090 (if (elt i 3) ; state (XXX What is the semantic???)
3091 0
3092 cperl-continued-statement-offset)))
3093 ;;
3094 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3095 ;;
3096 ((eq 'in-parens (elt i 0))
3097 ;; in-parens char-after old-indent-point is-brace containing-sexp
3098
3099 ;; group is an expression, not a block:
3100 ;; indent to just after the surrounding open parens,
3101 ;; skip blanks if we do not close the expression.
3102 (+ (progn
3103 (goto-char (elt i 2)) ; old-indent-point
3104 (current-column))
3105 (if (and (elt i 3) ; is-brace
3106 (eq (elt i 1) ?\})) ; char-after
3107 ;; Correct indentation of trailing ?\}
3108 (+ cperl-indent-level cperl-close-paren-offset)
3109 0)))
3110 ;;
3111 ;; Indenter for continuation lines
3112 ;;
3113 ((eq 'continuation (elt i 0))
3114 ;; [continuation statement-start char-after is-block is-brace]
3115 (goto-char (elt i 1)) ; statement-start
3116 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
3117 0 ; Closing parenth
3118 cperl-continued-statement-offset)
3119 (if (or (elt i 3) ; is-block
3120 (not (elt i 4)) ; is-brace
3121 (not (eq (elt i 2) ?\}))) ; char-after
3122 0
3123 ;; Now it is a hash reference
3124 (+ cperl-indent-level cperl-close-paren-offset))
3125 ;; Labels do not take :: ...
3126 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3127 (if (> (current-indentation) cperl-min-label-indent)
3128 (- (current-indentation) cperl-label-offset)
3129 ;; Do not move `parse-data', this should
3130 ;; be quick anyway (this comment comes
3131 ;; from different location):
3132 (cperl-calculate-indent))
3133 (current-column))
3134 (if (eq (elt i 2) ?\{) ; char-after
3135 cperl-continued-brace-offset 0)))
3136 ;;
3137 ;; Indenter for lines in a block which are not leading lines
3138 ;;
3139 ((eq 'have-prev-sibling (elt i 0))
3140 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
82d9a08d
SM
3141 (goto-char (elt i 1)) ; sibling-beg
3142 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
4ab89e7b
SM
3143 (if (> (current-indentation)
3144 cperl-min-label-indent)
3145 (- (current-indentation) cperl-label-offset)
3146 ;; Do not believe: `max' was involved in calculation of indent
3147 (+ cperl-indent-level
3148 (save-excursion
3149 (goto-char (elt i 3)) ; block-start
3150 (current-indentation))))
3151 (current-column)))
3152 ;;
3153 ;; Indenter for the first line in a block
3154 ;;
3155 ((eq 'code-start-in-block (elt i 0))
3156 ;;[code-start-in-block before-brace char-after
3157 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3158 ;; group-starts-before-start-of-sub start-of-control-group]
3159 (goto-char (elt i 1))
3160 ;; For open brace in column zero, don't let statement
3161 ;; start there too. If cperl-indent-level=0,
3162 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3163 (+ (if (and (bolp) (zerop cperl-indent-level))
3164 (+ cperl-brace-offset cperl-continued-statement-offset)
3165 cperl-indent-level)
3166 (if (and (elt i 3) ; is-a-HASH-ref
3167 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3168 (+ cperl-indent-level cperl-close-paren-offset)
3169 0)
3170 ;; Unless openbrace is the first nonwhite thing on the line,
3171 ;; add the cperl-brace-imaginary-offset.
3172 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3173 cperl-brace-imaginary-offset)
3174 (progn
3175 (goto-char (elt i 6)) ; start-of-control-group
3176 (if (elt i 5) ; group-starts-before-start-of-sub
3177 (current-column)
3178 ;; Get initial indentation of the line we are on.
3179 ;; If line starts with label, calculate label indentation
3180 (if (save-excursion
3181 (beginning-of-line)
3182 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3183 (if (> (current-indentation) cperl-min-label-indent)
3184 (- (current-indentation) cperl-label-offset)
3185 ;; Do not move `parse-data', this should
3186 ;; be quick anyway:
3187 (cperl-calculate-indent))
3188 (current-indentation))))))
3189 (t
3190 (error "Unrecognized value of indent: %s" i))))
3191 (t
3192 (error "Got strange value of indent: %s" i))))))
3193
f83d2997
KH
3194(defun cperl-calculate-indent-within-comment ()
3195 "Return the indentation amount for line, assuming that
3196the current line is to be regarded as part of a block comment."
3197 (let (end star-start)
3198 (save-excursion
3199 (beginning-of-line)
3200 (skip-chars-forward " \t")
3201 (setq end (point))
3202 (and (= (following-char) ?#)
3203 (forward-line -1)
3204 (cperl-to-comment-or-eol)
3205 (setq end (point)))
3206 (goto-char end)
3207 (current-column))))
3208
3209
3210(defun cperl-to-comment-or-eol ()
029cb4d5 3211 "Go to position before comment on the current line, or to end of line.
4ab89e7b
SM
3212Returns true if comment is found. In POD will not move the point."
3213 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3214 ;; then looks for literal # or end-of-line.
e180ab9f 3215 (let (state stop-in cpoint (lim (point-at-eol)) pr e)
4ab89e7b
SM
3216 (or cperl-font-locking
3217 (cperl-update-syntaxification lim lim))
83261a2f 3218 (beginning-of-line)
4ab89e7b
SM
3219 (if (setq pr (get-text-property (point) 'syntax-type))
3220 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3221 (if (or (eq pr 'pod)
3222 (if (or (not e) (> e lim)) ; deep inside a group
3223 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
83261a2f 3224 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
4ab89e7b
SM
3225 ;; Else - need to do it the hard way
3226 (and (and e (<= e lim))
3227 (goto-char e))
83261a2f
SM
3228 (while (not stop-in)
3229 (setq state (parse-partial-sexp (point) lim nil nil nil t))
f83d2997 3230 ; stop at comment
83261a2f
SM
3231 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3232 (if (nth 4 state) ; After `#';
f83d2997
KH
3233 ; (nth 2 state) can be
3234 ; beginning of m,s,qq and so
3235 ; on
83261a2f
SM
3236 (if (nth 2 state)
3237 (progn
3238 (setq cpoint (point))
3239 (goto-char (nth 2 state))
3240 (cond
3241 ((looking-at "\\(s\\|tr\\)\\>")
3242 (or (re-search-forward
3243 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3244 lim 'move)
3245 (setq stop-in t)))
3246 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3247 (or (re-search-forward
3248 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3249 lim 'move)
3250 (setq stop-in t)))
3251 (t ; It was fair comment
3252 (setq stop-in t) ; Finish
3253 (goto-char (1- cpoint)))))
3254 (setq stop-in t) ; Finish
3255 (forward-char -1))
15ca5699 3256 (setq stop-in t))) ; Finish
83261a2f 3257 (nth 4 state))))
f83d2997 3258
f83d2997
KH
3259(defsubst cperl-modify-syntax-type (at how)
3260 (if (< at (point-max))
3261 (progn
3262 (put-text-property at (1+ at) 'syntax-table how)
4ab89e7b 3263 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
f83d2997
KH
3264
3265(defun cperl-protect-defun-start (s e)
3266 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3267 (save-excursion
3268 (goto-char s)
3269 (while (re-search-forward "^\\s(" e 'to-end)
3270 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3271
5bd52f0e 3272(defun cperl-commentify (bb e string &optional noface)
5c8b7eaf 3273 (if cperl-use-syntax-table-text-property
5bd52f0e
RS
3274 (if (eq noface 'n) ; Only immediate
3275 nil
f83d2997
KH
3276 ;; We suppose that e is _after_ the end of construction, as after eol.
3277 (setq string (if string cperl-st-sfence cperl-st-cfence))
6c389151
SM
3278 (if (> bb (- e 2))
3279 ;; one-char string/comment?!
3280 (cperl-modify-syntax-type bb cperl-st-punct)
3281 (cperl-modify-syntax-type bb string)
3282 (cperl-modify-syntax-type (1- e) string))
f83d2997 3283 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
5c8b7eaf 3284 (put-text-property (1+ bb) (1- e)
f83d2997 3285 'syntax-table cperl-string-syntax-table))
5bd52f0e
RS
3286 (cperl-protect-defun-start bb e))
3287 ;; Fontify
3288 (or noface
3289 (not cperl-pod-here-fontify)
3290 (put-text-property bb e 'face (if string 'font-lock-string-face
3291 'font-lock-comment-face)))))
6c389151 3292
5bd52f0e
RS
3293(defvar cperl-starters '(( ?\( . ?\) )
3294 ( ?\[ . ?\] )
3295 ( ?\{ . ?\} )
3296 ( ?\< . ?\> )))
f83d2997 3297
4ab89e7b
SM
3298(defun cperl-cached-syntax-table (st)
3299 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3300All the entries of the syntax table are \".\", except for a backslash, which
3301is quoting."
3302 (if (car-safe st)
3303 (car st)
3304 (setcar st (make-syntax-table))
3305 (setq st (car st))
3306 (let ((i 0))
3307 (while (< i 256)
3308 (modify-syntax-entry i "." st)
3309 (setq i (1+ i))))
3310 (modify-syntax-entry ?\\ "\\" st)
3311 st))
3312
3313(defun cperl-forward-re (lim end is-2arg st-l err-l argument
f83d2997 3314 &optional ostart oend)
4ab89e7b
SM
3315"Find the end of a regular expression or a stringish construct (q[] etc).
3316The point should be before the starting delimiter.
3317
3318Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3319is s/// or tr/// like expression. If END is nil, generates an error
3320message if needed. If SET-ST is non-nil, will use (or generate) a
3321cached syntax table in ST-L. If ERR-L is non-nil, will store the
3322error message in its CAR (unless it already contains some error
3323message). ARGUMENT should be the name of the construct (used in error
3324messages). OSTART, OEND may be set in recursive calls when processing
3325the second argument of 2ARG construct.
3326
3327Works *before* syntax recognition is done. In IS-2ARG situation may
3328modify syntax-type text property if the situation is too hard."
3329 (let (b starter ender st i i2 go-forward reset-st set-st)
f83d2997
KH
3330 (skip-chars-forward " \t")
3331 ;; ender means matching-char matcher.
5c8b7eaf 3332 (setq b (point)
5bd52f0e
RS
3333 starter (if (eobp) 0 (char-after b))
3334 ender (cdr (assoc starter cperl-starters)))
f83d2997 3335 ;; What if starter == ?\\ ????
4ab89e7b 3336 (setq st (cperl-cached-syntax-table st-l))
f83d2997
KH
3337 (setq set-st t)
3338 ;; Whether we have an intermediate point
3339 (setq i nil)
3340 ;; Prepare the syntax table:
4ab89e7b
SM
3341 (if (not ender) ; m/blah/, s/x//, s/x/y/
3342 (modify-syntax-entry starter "$" st)
3343 (modify-syntax-entry starter (concat "(" (list ender)) st)
3344 (modify-syntax-entry ender (concat ")" (list starter)) st))
f83d2997
KH
3345 (condition-case bb
3346 (progn
5bd52f0e
RS
3347 ;; We use `$' syntax class to find matching stuff, but $$
3348 ;; is recognized the same as $, so we need to check this manually.
f83d2997
KH
3349 (if (and (eq starter (char-after (cperl-1+ b)))
3350 (not ender))
3351 ;; $ has TeXish matching rules, so $$ equiv $...
3352 (forward-char 2)
6c389151 3353 (setq reset-st (syntax-table))
f83d2997
KH
3354 (set-syntax-table st)
3355 (forward-sexp 1)
6c389151
SM
3356 (if (<= (point) (1+ b))
3357 (error "Unfinished regular expression"))
3358 (set-syntax-table reset-st)
3359 (setq reset-st nil)
f83d2997
KH
3360 ;; Now the problem is with m;blah;;
3361 (and (not ender)
3362 (eq (preceding-char)
3363 (char-after (- (point) 2)))
3364 (save-excursion
3365 (forward-char -2)
3366 (= 0 (% (skip-chars-backward "\\\\") 2)))
3367 (forward-char -1)))
5bd52f0e 3368 ;; Now we are after the first part.
f83d2997
KH
3369 (and is-2arg ; Have trailing part
3370 (not ender)
3371 (eq (following-char) starter) ; Empty trailing part
3372 (progn
3373 (or (eq (char-syntax (following-char)) ?.)
3374 ;; Make trailing letter into punctuation
3375 (cperl-modify-syntax-type (point) cperl-st-punct))
3376 (setq is-2arg nil go-forward t))) ; Ignore the tail
3377 (if is-2arg ; Not number => have second part
3378 (progn
3379 (setq i (point) i2 i)
3380 (if ender
b5b0cb34 3381 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
f83d2997
KH
3382 (progn
3383 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3384 (goto-char (match-end 0))
3385 (skip-chars-forward " \t\n\f"))
3386 (setq i2 (point))))
3387 (forward-char -1))
3388 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
5c8b7eaf 3389 (if ender (modify-syntax-entry ender "." st))
f83d2997 3390 (setq set-st nil)
4ab89e7b 3391 (setq ender (cperl-forward-re lim end nil st-l err-l
5bd52f0e 3392 argument starter ender)
8c777c8d 3393 ender (nth 2 ender)))))
f83d2997
KH
3394 (error (goto-char lim)
3395 (setq set-st nil)
6c389151
SM
3396 (if reset-st
3397 (set-syntax-table reset-st))
f83d2997 3398 (or end
8c777c8d
CY
3399 (and cperl-brace-recursing
3400 (or (eq ostart ?\{)
3401 (eq starter ?\{)))
f83d2997 3402 (message
5bd52f0e 3403 "End of `%s%s%c ... %c' string/RE not found: %s"
f83d2997
KH
3404 argument
3405 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3406 starter (or ender starter) bb)
3407 (or (car err-l) (setcar err-l b)))))
3408 (if set-st
3409 (progn
3410 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3411 (if ender (modify-syntax-entry ender "." st))))
5bd52f0e 3412 ;; i: have 2 args, after end of the first arg
e7f767c2 3413 ;; i2: start of the second arg, if any (before delim if `ender').
5bd52f0e
RS
3414 ;; ender: the last arg bounded by parens-like chars, the second one of them
3415 ;; starter: the starting delimiter of the first arg
5efe6a56 3416 ;; go-forward: has 2 args, and the second part is empty
f83d2997
KH
3417 (list i i2 ender starter go-forward)))
3418
4ab89e7b
SM
3419(defun cperl-forward-group-in-re (&optional st-l)
3420 "Find the end of a group in a REx.
3421Return the error message (if any). Does not work if delimiter is `)'.
3422Works before syntax recognition is done."
3423 ;; Works *before* syntax recognition is done
3424 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3425 (let (st b reset-st)
3426 (condition-case b
3427 (progn
3428 (setq st (cperl-cached-syntax-table st-l))
3429 (modify-syntax-entry ?\( "()" st)
3430 (modify-syntax-entry ?\) ")(" st)
3431 (setq reset-st (syntax-table))
3432 (set-syntax-table st)
3433 (forward-sexp 1))
3434 (error (message
3435 "cperl-forward-group-in-re: error %s" b)))
3436 ;; now restore the initial state
3437 (if st
3438 (progn
3439 (modify-syntax-entry ?\( "." st)
3440 (modify-syntax-entry ?\) "." st)))
3441 (if reset-st
3442 (set-syntax-table reset-st))
3443 b))
3444
3445
83261a2f
SM
3446(defvar font-lock-string-face)
3447;;(defvar font-lock-reference-face)
3448(defvar font-lock-constant-face)
5c8b7eaf 3449(defsubst cperl-postpone-fontification (b e type val &optional now)
5bd52f0e
RS
3450 ;; Do after syntactic fontification?
3451 (if cperl-syntaxify-by-font-lock
3452 (or now (put-text-property b e 'cperl-postpone (cons type val)))
83261a2f 3453 (put-text-property b e type val)))
5bd52f0e
RS
3454
3455;;; Here is how the global structures (those which cannot be
3456;;; recognized locally) are marked:
5c8b7eaf 3457;; a) PODs:
5bd52f0e
RS
3458;; Start-to-end is marked `in-pod' ==> t
3459;; Each non-literal part is marked `syntax-type' ==> `pod'
3460;; Each literal part is marked `syntax-type' ==> `in-pod'
5c8b7eaf 3461;; b) HEREs:
5bd52f0e
RS
3462;; Start-to-end is marked `here-doc-group' ==> t
3463;; The body is marked `syntax-type' ==> `here-doc'
3464;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
5c8b7eaf 3465;; c) FORMATs:
f739b53b
SM
3466;; First line (to =) marked `first-format-line' ==> t
3467;; After-this--to-end is marked `syntax-type' ==> `format'
5c8b7eaf 3468;; d) 'Q'uoted string:
5bd52f0e 3469;; part between markers inclusive is marked `syntax-type' ==> `string'
6c389151 3470;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
4ab89e7b
SM
3471;; second part of s///e is marked `syntax-type' ==> `multiline'
3472;; e) Attributes of subroutines: `attrib-group' ==> t
3473;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3474;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3475
3476;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3477;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
5bd52f0e
RS
3478
3479(defun cperl-unwind-to-safe (before &optional end)
3480 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3481 (let ((pos (point)) opos)
4ab89e7b
SM
3482 (while (and pos (progn
3483 (beginning-of-line)
3484 (get-text-property (setq pos (point)) 'syntax-type)))
3485 (setq opos pos
3486 pos (cperl-beginning-of-property pos 'syntax-type))
3487 (if (eq pos (point-min))
3488 (setq pos nil))
5bd52f0e
RS
3489 (if pos
3490 (if before
3491 (progn
3492 (goto-char (cperl-1- pos))
3493 (beginning-of-line)
3494 (setq pos (point)))
3495 (goto-char (setq pos (cperl-1- pos))))
3496 ;; Up to the start
3497 (goto-char (point-min))))
6c389151
SM
3498 ;; Skip empty lines
3499 (and (looking-at "\n*=")
3500 (/= 0 (skip-chars-backward "\n"))
3501 (forward-char))
3502 (setq pos (point))
5bd52f0e
RS
3503 (if end
3504 ;; Do the same for end, going small steps
4ab89e7b 3505 (save-excursion
5bd52f0e
RS
3506 (while (and end (get-text-property end 'syntax-type))
3507 (setq pos end
4ab89e7b
SM
3508 end (next-single-property-change end 'syntax-type nil (point-max)))
3509 (if end (progn (goto-char end)
3510 (or (bolp) (forward-line 1))
3511 (setq end (point)))))
5bd52f0e
RS
3512 (or end pos)))))
3513
4ab89e7b 3514;;; These are needed for byte-compile (at least with v19)
6c389151 3515(defvar cperl-nonoverridable-face)
4ab89e7b 3516(defvar font-lock-variable-name-face)
6c389151 3517(defvar font-lock-function-name-face)
4ab89e7b
SM
3518(defvar font-lock-keyword-face)
3519(defvar font-lock-builtin-face)
3520(defvar font-lock-type-face)
6c389151 3521(defvar font-lock-comment-face)
4ab89e7b 3522(defvar font-lock-warning-face)
6c389151 3523
4ab89e7b
SM
3524(defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3525 "Syntaxically mark (and fontify) attributes of a subroutine.
3526Should be called with the point before leading colon of an attribute."
3527 ;; Works *before* syntax recognition is done
3528 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3529 (let (st b p reset-st after-first (start (point)) start1 end1)
3530 (condition-case b
3531 (while (looking-at
3532 (concat
3533 "\\(" ; 1=optional? colon
3534 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3535 "\\)"
3536 (if after-first "?" "")
3537 ;; No space between name and paren allowed...
3538 "\\(\\sw+\\)" ; 3=name
3539 "\\((\\)?")) ; 4=optional paren
3540 (and (match-beginning 1)
3541 (cperl-postpone-fontification
3542 (match-beginning 0) (cperl-1+ (match-beginning 0))
3543 'face font-lock-constant-face))
3544 (setq start1 (match-beginning 3) end1 (match-end 3))
3545 (cperl-postpone-fontification start1 end1
3546 'face font-lock-constant-face)
3547 (goto-char end1) ; end or before `('
3548 (if (match-end 4) ; Have attribute arguments...
3549 (progn
3550 (if st nil
3551 (setq st (cperl-cached-syntax-table st-l))
3552 (modify-syntax-entry ?\( "()" st)
3553 (modify-syntax-entry ?\) ")(" st))
3554 (setq reset-st (syntax-table) p (point))
3555 (set-syntax-table st)
3556 (forward-sexp 1)
3557 (set-syntax-table reset-st)
3558 (setq reset-st nil)
3559 (cperl-commentify p (point) t))) ; mark as string
3560 (forward-comment (buffer-size))
3561 (setq after-first t))
3562 (error (message
3563 "L%d: attribute `%s': %s"
3564 (count-lines (point-min) (point))
3565 (and start1 end1 (buffer-substring start1 end1)) b)
3566 (setq start nil)))
3567 (and start
3568 (progn
3569 (put-text-property start (point)
3570 'attrib-group (if (looking-at "{") t 0))
3571 (and pos
3572 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3573 ;; Apparently, we do not need `multiline': faces added now
3574 (put-text-property (+ 3 pos) (cperl-1+ (point))
3575 'syntax-type 'sub-decl))
3576 (and b-fname ; Fontify here: the following condition
3577 (cperl-postpone-fontification ; is too hard to determine by
3578 b-fname e-fname 'face ; a REx, so do it here
3579 (if (looking-at "{")
3580 font-lock-function-name-face
3581 font-lock-variable-name-face)))))
3582 ;; now restore the initial state
3583 (if st
3584 (progn
3585 (modify-syntax-entry ?\( "." st)
3586 (modify-syntax-entry ?\) "." st)))
3587 (if reset-st
3588 (set-syntax-table reset-st))))
3589
3590(defsubst cperl-look-at-leading-count (is-x-REx e)
82d9a08d
SM
3591 (if (and
3592 (< (point) e)
3593 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3594 (1- e) t)) ; return nil on failure, no moving
4ab89e7b
SM
3595 (if (eq ?\{ (preceding-char)) nil
3596 (cperl-postpone-fontification
3597 (1- (point)) (point)
3598 'face font-lock-warning-face))))
3599
8c777c8d
CY
3600;; Do some smarter-highlighting
3601;; XXXX Currently ignores alphanum/dash delims,
3602(defsubst cperl-highlight-charclass (endbracket dashface bsface onec-space)
3603 (let ((l '(1 5 7)) ll lle lll
3604 ;; 2 groups, the first takes the whole match (include \[trnfabe])
3605 (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{[^{}]*}" "\\)")))
3606 (while ; look for unescaped - between non-classes
3607 (re-search-forward
3608 ;; On 19.33, certain simplifications lead
3609 ;; to bugs (as in [^a-z] \\| [trnfabe] )
3610 (concat ; 1: SingleChar (include \[trnfabe])
3611 singleChar
3612 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3613 "\\(" ; 3: DASH SingleChar (match optionally)
3614 "\\(-\\)" ; 4: DASH
3615 singleChar ; 5: SingleChar
3616 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3617 "\\)?"
3618 "\\|"
3619 "\\(" ; 7: other escapes
3620 "\\\\[pP]" "\\([^{]\\|{[^{}]*}\\)"
3621 "\\|" "\\\\[^pP]" "\\)"
3622 )
3623 endbracket 'toend)
3624 (if (match-beginning 4)
3625 (cperl-postpone-fontification
3626 (match-beginning 4) (match-end 4)
3627 'face dashface))
3628 ;; save match data (for looking-at)
3629 (setq lll (mapcar (function (lambda (elt) (cons (match-beginning elt)
3630 (match-end elt)))) l))
3631 (while lll
3632 (setq ll (car lll))
3633 (setq lle (cdr ll)
3634 ll (car ll))
3635 ;; (message "Got %s of %s" ll l)
3636 (if (and ll (eq (char-after ll) ?\\ ))
3637 (save-excursion
3638 (goto-char ll)
3639 (cperl-postpone-fontification ll (1+ ll)
3640 'face bsface)
3641 (if (looking-at "\\\\[a-zA-Z0-9]")
3642 (cperl-postpone-fontification (1+ ll) lle
3643 'face onec-space))))
3644 (setq lll (cdr lll))))
3645 (goto-char endbracket) ; just in case something misbehaves???
3646 t))
3647
4ab89e7b
SM
3648;;; Debugging this may require (setq max-specpdl-size 2000)...
3649(defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
f83d2997 3650 "Scans the buffer for hard-to-parse Perl constructions.
5c8b7eaf
SS
3651If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3652the sections using `cperl-pod-head-face', `cperl-pod-face',
f83d2997
KH
3653`cperl-here-face'."
3654 (interactive)
05927f8c 3655 (or min (setq min (point-min)
db133cb6
RS
3656 cperl-syntax-state nil
3657 cperl-syntax-done-to min))
f83d2997 3658 (or max (setq max (point-max)))
83261a2f
SM
3659 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3660 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
4ab89e7b 3661 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
83261a2f 3662 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
af1d43f9 3663 (modified (buffer-modified-p)) overshoot is-o-REx name
83261a2f 3664 (after-change-functions nil)
4ab89e7b 3665 (cperl-font-locking t)
83261a2f
SM
3666 (use-syntax-state (and cperl-syntax-state
3667 (>= min (car cperl-syntax-state))))
3668 (state-point (if use-syntax-state
3669 (car cperl-syntax-state)
3670 (point-min)))
3671 (state (if use-syntax-state
3672 (cdr cperl-syntax-state)))
3673 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3674 (st-l (list nil)) (err-l (list nil))
3675 ;; Somehow font-lock may be not loaded yet...
4ab89e7b 3676 ;; (e.g., when building TAGS via command-line call)
83261a2f
SM
3677 (font-lock-string-face (if (boundp 'font-lock-string-face)
3678 font-lock-string-face
3679 'font-lock-string-face))
4ab89e7b 3680 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
83261a2f
SM
3681 font-lock-constant-face
3682 'font-lock-constant-face))
4ab89e7b 3683 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
83261a2f
SM
3684 (if (boundp 'font-lock-function-name-face)
3685 font-lock-function-name-face
3686 'font-lock-function-name-face))
4ab89e7b
SM
3687 (font-lock-variable-name-face ; interpolated vars and ({})-code
3688 (if (boundp 'font-lock-variable-name-face)
3689 font-lock-variable-name-face
3690 'font-lock-variable-name-face))
3691 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3692 (if (boundp 'font-lock-function-name-face)
3693 font-lock-function-name-face
3694 'font-lock-function-name-face))
3695 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3696 (if (boundp 'font-lock-constant-face)
3697 font-lock-constant-face
3698 'font-lock-constant-face))
3699 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3700 (if (boundp 'font-lock-builtin-face)
3701 font-lock-builtin-face
3702 'font-lock-builtin-face))
83261a2f
SM
3703 (font-lock-comment-face
3704 (if (boundp 'font-lock-comment-face)
3705 font-lock-comment-face
3706 'font-lock-comment-face))
4ab89e7b
SM
3707 (font-lock-warning-face
3708 (if (boundp 'font-lock-warning-face)
3709 font-lock-warning-face
3710 'font-lock-warning-face))
3711 (my-cperl-REx-ctl-face ; (|)
3712 (if (boundp 'font-lock-keyword-face)
3713 font-lock-keyword-face
3714 'font-lock-keyword-face))
3715 (my-cperl-REx-modifiers-face ; //gims
83261a2f
SM
3716 (if (boundp 'cperl-nonoverridable-face)
3717 cperl-nonoverridable-face
4ab89e7b
SM
3718 'cperl-nonoverridable-face))
3719 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3720 (if (boundp 'font-lock-type-face)
3721 font-lock-type-face
3722 'font-lock-type-face))
83261a2f
SM
3723 (stop-point (if ignore-max
3724 (point-max)
3725 max))
3726 (search
3727 (concat
4ab89e7b 3728 "\\(\\`\n?\\|^\n\\)=" ; POD
83261a2f
SM
3729 "\\|"
3730 ;; One extra () before this:
4ab89e7b 3731 "<<" ; HERE-DOC
83261a2f
SM
3732 "\\(" ; 1 + 1
3733 ;; First variant "BLAH" or just ``.
3734 "[ \t]*" ; Yes, whitespace is allowed!
3735 "\\([\"'`]\\)" ; 2 + 1 = 3
3736 "\\([^\"'`\n]*\\)" ; 3 + 1
3737 "\\3"
3738 "\\|"
f739b53b 3739 ;; Second variant: Identifier or \ID (same as 'ID') or empty
83261a2f
SM
3740 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3741 ;; Do not have <<= or << 30 or <<30 or << $blah.
3742 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3743 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3744 "\\)"
3745 "\\|"
3746 ;; 1+6 extra () before this:
4ab89e7b 3747 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
83261a2f 3748 (if cperl-use-syntax-table-text-property
db133cb6 3749 (concat
db133cb6 3750 "\\|"
83261a2f 3751 ;; 1+6+2=9 extra () before this:
4ab89e7b 3752 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
83261a2f
SM
3753 "\\|"
3754 ;; 1+6+2+1=10 extra () before this:
3755 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3756 "\\|"
4ab89e7b
SM
3757 ;; 1+6+2+1+1=11 extra () before this
3758 "\\<sub\\>" ; sub with proto/attr
3759 "\\("
3760 cperl-white-and-comment-rex
3761 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3762 "\\("
3763 cperl-maybe-white-and-comment-rex
3764 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
83261a2f 3765 "\\|"
4ab89e7b
SM
3766 ;; 1+6+2+1+1+6=17 extra () before this:
3767 "\\$\\(['{]\\)" ; $' or ${foo}
83261a2f 3768 "\\|"
4ab89e7b
SM
3769 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3770 ;; we do not support intervening comments...):
83261a2f 3771 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
4ab89e7b 3772 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
83261a2f 3773 "\\|"
4ab89e7b
SM
3774 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3775 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
db133cb6 3776 "\\|"
4ab89e7b 3777 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
83261a2f 3778 ""))))
f83d2997
KH
3779 (unwind-protect
3780 (progn
3781 (save-excursion
3782 (or non-inter
3783 (message "Scanning for \"hard\" Perl constructions..."))
4ab89e7b 3784 ;;(message "find: %s --> %s" min max)
db133cb6 3785 (and cperl-pod-here-fontify
83261a2f
SM
3786 ;; We had evals here, do not know why...
3787 (setq face cperl-pod-face
3788 head-face cperl-pod-head-face
3789 here-face cperl-here-face))
5c8b7eaf 3790 (remove-text-properties min max
5bd52f0e 3791 '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3792 attrib-group t
3793 REx-interpolated t
6c389151
SM
3794 cperl-postpone t
3795 syntax-subtype t
3796 rear-nonsticky t
4ab89e7b 3797 front-sticky t
f739b53b
SM
3798 here-doc-group t
3799 first-format-line t
4ab89e7b 3800 REx-part2 t
6c389151 3801 indentable t))
f83d2997
KH
3802 ;; Need to remove face as well...
3803 (goto-char min)
72bc50c0
GM
3804 ;; 'emx not supported by Emacs since at least 21.1.
3805 (and (featurep 'xemacs) (eq system-type 'emx)
4ab89e7b
SM
3806 (eq (point) 1)
3807 (let ((case-fold-search t))
3808 (looking-at "extproc[ \t]")) ; Analogue of #!
5c8b7eaf 3809 (cperl-commentify min
e180ab9f 3810 (point-at-eol)
db133cb6
RS
3811 nil))
3812 (while (and
3813 (< (point) max)
3814 (re-search-forward search max t))
5bd52f0e 3815 (setq tmpend nil) ; Valid for most cases
4ab89e7b
SM
3816 (setq b (match-beginning 0)
3817 state (save-excursion (parse-partial-sexp
3818 state-point b nil nil state))
3819 state-point b)
5c8b7eaf 3820 (cond
4ab89e7b
SM
3821 ;; 1+6+2+1+1+6=17 extra () before this:
3822 ;; "\\$\\(['{]\\)"
3823 ((match-beginning 18) ; $' or ${foo}
3824 (if (eq (preceding-char) ?\') ; $'
3825 (progn
3826 (setq b (1- (point))
3827 state (parse-partial-sexp
3828 state-point (1- b) nil nil state)
3829 state-point (1- b))
3830 (if (nth 3 state) ; in string
3831 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3832 (goto-char (1+ b)))
3833 ;; else: ${
3834 (setq bb (match-beginning 0))
3835 (cperl-modify-syntax-type bb cperl-st-punct)))
3836 ;; No processing in strings/comments beyond this point:
3837 ((or (nth 3 state) (nth 4 state))
3838 t) ; Do nothing in comment/string
f83d2997 3839 ((match-beginning 1) ; POD section
a1506d29 3840 ;; "\\(\\`\n?\\|^\n\\)="
4ab89e7b
SM
3841 (setq b (match-beginning 0)
3842 state (parse-partial-sexp
3843 state-point b nil nil state)
3844 state-point b)
3845 (if (or (nth 3 state) (nth 4 state)
3846 (looking-at "cut\\>"))
3847 (if (or (nth 3 state) (nth 4 state) ignore-max)
5bd52f0e 3848 nil ; Doing a chunk only
f83d2997
KH
3849 (message "=cut is not preceded by a POD section")
3850 (or (car err-l) (setcar err-l (point))))
3851 (beginning-of-line)
5c8b7eaf
SS
3852
3853 (setq b (point)
5bd52f0e
RS
3854 bb b
3855 tb (match-beginning 0)
3856 b1 nil) ; error condition
db133cb6
RS
3857 ;; We do not search to max, since we may be called from
3858 ;; some hook of fontification, and max is random
6c389151 3859 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
f83d2997 3860 (progn
6c389151
SM
3861 (goto-char b)
3862 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3863 (progn
3864 (message "=cut is not preceded by an empty line")
3865 (setq b1 t)
3866 (or (car err-l) (setcar err-l b))))))
f83d2997
KH
3867 (beginning-of-line 2) ; An empty line after =cut is not POD!
3868 (setq e (point))
db133cb6 3869 (and (> e max)
6c389151 3870 (progn
a1506d29 3871 (remove-text-properties
6c389151 3872 max e '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3873 attrib-group t
3874 REx-interpolated t
6c389151
SM
3875 cperl-postpone t
3876 syntax-subtype t
f739b53b 3877 here-doc-group t
6c389151 3878 rear-nonsticky t
4ab89e7b 3879 front-sticky t
f739b53b 3880 first-format-line t
4ab89e7b 3881 REx-part2 t
6c389151
SM
3882 indentable t))
3883 (setq tmpend tb)))
f83d2997 3884 (put-text-property b e 'in-pod t)
6c389151 3885 (put-text-property b e 'syntax-type 'in-pod)
f83d2997
KH
3886 (goto-char b)
3887 (while (re-search-forward "\n\n[ \t]" e t)
3888 ;; We start 'pod 1 char earlier to include the preceding line
3889 (beginning-of-line)
3890 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5efe6a56
SM
3891 (cperl-put-do-not-fontify b (point) t)
3892 ;; mark the non-literal parts as PODs
a1506d29 3893 (if cperl-pod-here-fontify
5efe6a56 3894 (cperl-postpone-fontification b (point) 'face face t))
f83d2997
KH
3895 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3896 (beginning-of-line)
3897 (setq b (point)))
3898 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5efe6a56 3899 (cperl-put-do-not-fontify (point) e t)
a1506d29
JB
3900 (if cperl-pod-here-fontify
3901 (progn
5efe6a56
SM
3902 ;; mark the non-literal parts as PODs
3903 (cperl-postpone-fontification (point) e 'face face t)
3904 (goto-char bb)
a1506d29 3905 (if (looking-at
5efe6a56
SM
3906 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3907 ;; mark the headers
a1506d29 3908 (cperl-postpone-fontification
5efe6a56 3909 (match-beginning 1) (match-end 1)
6c389151
SM
3910 'face head-face))
3911 (while (re-search-forward
3912 ;; One paragraph
3913 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3914 e 'toend)
3915 ;; mark the headers
a1506d29 3916 (cperl-postpone-fontification
5efe6a56
SM
3917 (match-beginning 1) (match-end 1)
3918 'face head-face))))
f83d2997
KH
3919 (cperl-commentify bb e nil)
3920 (goto-char e)
3921 (or (eq e (point-max))
83261a2f 3922 (forward-char -1)))) ; Prepare for immediate POD start.
f83d2997 3923 ;; Here document
4ab89e7b
SM
3924 ;; We can do many here-per-line;
3925 ;; but multiline quote on the same line as <<HERE confuses us...
5bd52f0e 3926 ;; ;; One extra () before this:
5c8b7eaf 3927 ;;"<<"
5bd52f0e
RS
3928 ;; "\\(" ; 1 + 1
3929 ;; ;; First variant "BLAH" or just ``.
f739b53b 3930 ;; "[ \t]*" ; Yes, whitespace is allowed!
5bd52f0e
RS
3931 ;; "\\([\"'`]\\)" ; 2 + 1
3932 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3933 ;; "\\3"
3934 ;; "\\|"
3935 ;; ;; Second variant: Identifier or \ID or empty
3936 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3937 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3938 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3939 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3940 ;; "\\)"
f83d2997 3941 ((match-beginning 2) ; 1 + 1
4ab89e7b 3942 (setq b (point)
5bd52f0e 3943 tb (match-beginning 0)
4ab89e7b
SM
3944 c (and ; not HERE-DOC
3945 (match-beginning 5)
3946 (save-match-data
3947 (or (looking-at "[ \t]*(") ; << function_call()
3948 (save-excursion ; 1 << func_name, or $foo << 10
3949 (condition-case nil
3950 (progn
3951 (goto-char tb)
3952 ;;; XXX What to do: foo <<bar ???
3953 ;;; XXX Need to support print {a} <<B ???
3954 (forward-sexp -1)
cb5bf6ba 3955 (save-match-data
4ab89e7b
SM
3956 ; $foo << b; $f .= <<B;
3957 ; ($f+1) << b; a($f) . <<B;
3958 ; foo 1, <<B; $x{a} <<b;
3959 (cond
3960 ((looking-at "[0-9$({]")
3961 (forward-sexp 1)
3962 (and
3963 (looking-at "[ \t]*<<")
3964 (condition-case nil
3965 ;; print $foo <<EOF
3966 (progn
3967 (forward-sexp -2)
3968 (not
3969 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
3970 (error t)))))))
3971 (error nil))) ; func(<<EOF)
3972 (and (not (match-beginning 6)) ; Empty
3973 (looking-at
3974 "[ \t]*[=0-9$@%&(]"))))))
5bd52f0e
RS
3975 (if c ; Not here-doc
3976 nil ; Skip it.
4ab89e7b 3977 (setq c (match-end 2)) ; 1 + 1
f83d2997
KH
3978 (if (match-beginning 5) ;4 + 1
3979 (setq b1 (match-beginning 5) ; 4 + 1
3980 e1 (match-end 5)) ; 4 + 1
3981 (setq b1 (match-beginning 4) ; 3 + 1
3982 e1 (match-end 4))) ; 3 + 1
3983 (setq tag (buffer-substring b1 e1)
3984 qtag (regexp-quote tag))
5c8b7eaf 3985 (cond (cperl-pod-here-fontify
5bd52f0e 3986 ;; Highlight the starting delimiter
cb5bf6ba 3987 (cperl-postpone-fontification
4ab89e7b 3988 b1 e1 'face my-cperl-delimiters-face)
5bd52f0e 3989 (cperl-put-do-not-fontify b1 e1 t)))
f83d2997 3990 (forward-line)
4ab89e7b
SM
3991 (setq i (point))
3992 (if end-of-here-doc
3993 (goto-char end-of-here-doc))
f83d2997 3994 (setq b (point))
db133cb6
RS
3995 ;; We do not search to max, since we may be called from
3996 ;; some hook of fontification, and max is random
f739b53b
SM
3997 (or (and (re-search-forward (concat "^" qtag "$")
3998 stop-point 'toend)
4ab89e7b
SM
3999 ;;;(eq (following-char) ?\n) ; XXXX WHY???
4000 )
f739b53b
SM
4001 (progn ; Pretend we matched at the end
4002 (goto-char (point-max))
4003 (re-search-forward "\\'")
4004 (message "End of here-document `%s' not found." tag)
4005 (or (car err-l) (setcar err-l b))))
4006 (if cperl-pod-here-fontify
4007 (progn
4008 ;; Highlight the ending delimiter
4ab89e7b
SM
4009 (cperl-postpone-fontification
4010 (match-beginning 0) (match-end 0)
4011 'face my-cperl-delimiters-face)
f739b53b
SM
4012 (cperl-put-do-not-fontify b (match-end 0) t)
4013 ;; Highlight the HERE-DOC
4014 (cperl-postpone-fontification b (match-beginning 0)
4015 'face here-face)))
4016 (setq e1 (cperl-1+ (match-end 0)))
4017 (put-text-property b (match-beginning 0)
4018 'syntax-type 'here-doc)
4019 (put-text-property (match-beginning 0) e1
4020 'syntax-type 'here-doc-delim)
4ab89e7b
SM
4021 (put-text-property b e1 'here-doc-group t)
4022 ;; This makes insertion at the start of HERE-DOC update
4023 ;; the whole construct:
4024 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
f739b53b
SM
4025 (cperl-commentify b e1 nil)
4026 (cperl-put-do-not-fontify b (match-end 0) t)
4ab89e7b
SM
4027 ;; Cache the syntax info...
4028 (setq cperl-syntax-state (cons state-point state))
4029 ;; ... and process the rest of the line...
4030 (setq overshoot
4031 (elt ; non-inter ignore-max
4032 (cperl-find-pods-heres c i t end t e1) 1))
4033 (if (and overshoot (> overshoot (point)))
4034 (goto-char overshoot)
4035 (setq overshoot e1))
f739b53b
SM
4036 (if (> e1 max)
4037 (setq tmpend tb))))
f83d2997
KH
4038 ;; format
4039 ((match-beginning 8)
4040 ;; 1+6=7 extra () before this:
4041 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4042 (setq b (point)
4043 name (if (match-beginning 8) ; 7 + 1
4044 (buffer-substring (match-beginning 8) ; 7 + 1
4045 (match-end 8)) ; 7 + 1
5bd52f0e
RS
4046 "")
4047 tb (match-beginning 0))
f83d2997 4048 (setq argument nil)
9b026d9f 4049 (put-text-property (point-at-bol) b 'first-format-line 't)
5c8b7eaf 4050 (if cperl-pod-here-fontify
f83d2997
KH
4051 (while (and (eq (forward-line) 0)
4052 (not (looking-at "^[.;]$")))
4053 (cond
4054 ((looking-at "^#")) ; Skip comments
4055 ((and argument ; Skip argument multi-lines
5c8b7eaf 4056 (looking-at "^[ \t]*{"))
f83d2997
KH
4057 (forward-sexp 1)
4058 (setq argument nil))
4059 (argument ; Skip argument lines
4060 (setq argument nil))
4061 (t ; Format line
4062 (setq b1 (point))
4063 (setq argument (looking-at "^[^\n]*[@^]"))
4064 (end-of-line)
5bd52f0e 4065 ;; Highlight the format line
5c8b7eaf 4066 (cperl-postpone-fontification b1 (point)
83261a2f 4067 'face font-lock-string-face)
f83d2997 4068 (cperl-commentify b1 (point) nil)
5bd52f0e 4069 (cperl-put-do-not-fontify b1 (point) t))))
db133cb6
RS
4070 ;; We do not search to max, since we may be called from
4071 ;; some hook of fontification, and max is random
4072 (re-search-forward "^[.;]$" stop-point 'toend))
f83d2997 4073 (beginning-of-line)
83261a2f 4074 (if (looking-at "^\\.$") ; ";" is not supported yet
f83d2997 4075 (progn
5bd52f0e
RS
4076 ;; Highlight the ending delimiter
4077 (cperl-postpone-fontification (point) (+ (point) 2)
83261a2f 4078 'face font-lock-string-face)
f83d2997 4079 (cperl-commentify (point) (+ (point) 2) nil)
5bd52f0e 4080 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
f83d2997
KH
4081 (message "End of format `%s' not found." name)
4082 (or (car err-l) (setcar err-l b)))
4083 (forward-line)
5bd52f0e
RS
4084 (if (> (point) max)
4085 (setq tmpend tb))
db133cb6 4086 (put-text-property b (point) 'syntax-type 'format))
4ab89e7b 4087 ;; qq-like String or Regexp:
f83d2997
KH
4088 ((or (match-beginning 10) (match-beginning 11))
4089 ;; 1+6+2=9 extra () before this:
5bd52f0e 4090 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
f83d2997 4091 ;; "\\|"
5bd52f0e 4092 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
f83d2997
KH
4093 (setq b1 (if (match-beginning 10) 10 11)
4094 argument (buffer-substring
4095 (match-beginning b1) (match-end b1))
4ab89e7b 4096 b (point) ; end of qq etc
f83d2997
KH
4097 i b
4098 c (char-after (match-beginning b1))
4ab89e7b 4099 bb (char-after (1- (match-beginning b1))) ; tmp holder
5bd52f0e
RS
4100 ;; bb == "Not a stringy"
4101 bb (if (eq b1 10) ; user variables/whatever
f739b53b
SM
4102 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4103 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4104 ((eq bb ?\:) ; $opt::s
4105 (eq (char-after
4106 (- (match-beginning b1) 2))
4107 ?\:))
4108 ((eq bb ?\>) ; $foo->s
4109 (eq (char-after
4110 (- (match-beginning b1) 2))
4111 ?\-))
4112 ((eq bb ?\&)
4ab89e7b 4113 (not (eq (char-after ; &&m/blah/
f739b53b
SM
4114 (- (match-beginning b1) 2))
4115 ?\&)))
4116 (t t)))
5bd52f0e
RS
4117 ;; <file> or <$file>
4118 (and (eq c ?\<)
6c389151 4119 ;; Do not stringify <FH>, <$fh> :
5bd52f0e 4120 (save-match-data
5c8b7eaf 4121 (looking-at
6c389151 4122 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
5bd52f0e 4123 tb (match-beginning 0))
db133cb6
RS
4124 (goto-char (match-beginning b1))
4125 (cperl-backward-to-noncomment (point-min))
f83d2997 4126 (or bb
5bd52f0e 4127 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
f83d2997 4128 (setq argument ""
f739b53b 4129 b1 nil
db133cb6 4130 bb ; Not a regexp?
4ab89e7b
SM
4131 (not
4132 ;; What is below: regexp-p?
4133 (and
4134 (or (memq (preceding-char)
4135 (append (if (memq c '(?\? ?\<))
4136 ;; $a++ ? 1 : 2
4137 "~{(=|&*!,;:["
4138 "~{(=|&+-*!,;:[") nil))
4139 (and (eq (preceding-char) ?\})
4140 (cperl-after-block-p (point-min)))
4141 (and (eq (char-syntax (preceding-char)) ?w)
4142 (progn
4143 (forward-sexp -1)
6c389151
SM
4144;; After these keywords `/' starts a RE. One should add all the
4145;; functions/builtins which expect an argument, but ...
4ab89e7b
SM
4146 (if (eq (preceding-char) ?-)
4147 ;; -d ?foo? is a RE
4148 (looking-at "[a-zA-Z]\\>")
4149 (and
4150 (not (memq (preceding-char)
4151 '(?$ ?@ ?& ?%)))
4152 (looking-at
4153 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4154 (and (eq (preceding-char) ?.)
4155 (eq (char-after (- (point) 2)) ?.))
4156 (bobp))
4157 ;; m|blah| ? foo : bar;
4158 (not
4159 (and (eq c ?\?)
4160 cperl-use-syntax-table-text-property
4161 (not (bobp))
4162 (progn
4163 (forward-char -1)
4164 (looking-at "\\s|"))))))
db133cb6
RS
4165 b (1- b))
4166 ;; s y tr m
f739b53b
SM
4167 ;; Check for $a -> y
4168 (setq b1 (preceding-char)
4169 go (point))
4170 (if (and (eq b1 ?>)
4171 (eq (char-after (- go 2)) ?-))
db133cb6
RS
4172 ;; Not a regexp
4173 (setq bb t))))
f739b53b
SM
4174 (or bb
4175 (progn
4ab89e7b 4176 (goto-char b)
f739b53b
SM
4177 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4178 (goto-char (match-end 0))
4179 (skip-chars-forward " \t\n\f"))
4180 (cond ((and (eq (following-char) ?\})
4181 (eq b1 ?\{))
4182 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4183 (goto-char (1- go))
4184 (skip-chars-backward " \t\n\f")
4185 (if (memq (preceding-char) (append "$@%&*" nil))
4186 (setq bb t) ; @{y}
4187 (condition-case nil
4188 (forward-sexp -1)
4189 (error nil)))
4190 (if (or bb
4191 (looking-at ; $foo -> {s}
4192 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4193 (and ; $foo[12] -> {s}
4194 (memq (following-char) '(?\{ ?\[))
4195 (progn
4196 (forward-sexp 1)
4197 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4198 (setq bb t)
4199 (goto-char b)))
4200 ((and (eq (following-char) ?=)
4201 (eq (char-after (1+ (point))) ?\>))
4202 ;; Check for { foo => 1, s => 2 }
4203 ;; Apparently s=> is never a substitution...
4204 (setq bb t))
4205 ((and (eq (following-char) ?:)
4206 (eq b1 ?\{) ; Check for $ { s::bar }
4207 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
15ca5699 4208 (progn
f739b53b
SM
4209 (goto-char (1- go))
4210 (skip-chars-backward " \t\n\f")
4211 (memq (preceding-char)
4212 (append "$@%&*" nil))))
4ab89e7b
SM
4213 (setq bb t))
4214 ((eobp)
f739b53b
SM
4215 (setq bb t)))))
4216 (if bb
f83d2997 4217 (goto-char i)
6c389151 4218 ;; Skip whitespace and comments...
f83d2997
KH
4219 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4220 (goto-char (match-end 0))
4221 (skip-chars-forward " \t\n\f"))
6c389151
SM
4222 (if (> (point) b)
4223 (put-text-property b (point) 'syntax-type 'prestring))
f83d2997
KH
4224 ;; qtag means two-arg matcher, may be reset to
4225 ;; 2 or 3 later if some special quoting is needed.
4226 ;; e1 means matching-char matcher.
4ab89e7b 4227 (setq b (point) ; before the first delimiter
5bd52f0e
RS
4228 ;; has 2 args
4229 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
db133cb6
RS
4230 ;; We do not search to max, since we may be called from
4231 ;; some hook of fontification, and max is random
4232 i (cperl-forward-re stop-point end
5bd52f0e 4233 i2
4ab89e7b
SM
4234 st-l err-l argument)
4235 ;; If `go', then it is considered as 1-arg, `b1' is nil
4236 ;; as in s/foo//x; the point is before final "slash"
5bd52f0e 4237 b1 (nth 1 i) ; start of the second part
5c8b7eaf 4238 tag (nth 2 i) ; ender-char, true if second part
5bd52f0e 4239 ; is with matching chars []
f83d2997
KH
4240 go (nth 4 i) ; There is a 1-char part after the end
4241 i (car i) ; intermediate point
5c8b7eaf 4242 e1 (point) ; end
5bd52f0e 4243 ;; Before end of the second part if non-matching: ///
5c8b7eaf 4244 tail (if (and i (not tag))
5bd52f0e
RS
4245 (1- e1))
4246 e (if i i e1) ; end of the first part
6c389151 4247 qtag nil ; need to preserve backslashitis
4ab89e7b
SM
4248 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4249 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
f83d2997
KH
4250 ;; Commenting \\ is dangerous, what about ( ?
4251 (and i tail
4252 (eq (char-after i) ?\\)
5bd52f0e 4253 (setq qtag t))
4ab89e7b
SM
4254 (and (if go (looking-at ".\\sw*x")
4255 (looking-at "\\sw*x")) ; qr//x
4256 (setq is-x-REx t))
4257 (and (if go (looking-at ".\\sw*o")
4258 (looking-at "\\sw*o")) ; //o
4259 (setq is-o-REx t))
f83d2997 4260 (if (null i)
5bd52f0e 4261 ;; Considered as 1arg form
f83d2997
KH
4262 (progn
4263 (cperl-commentify b (point) t)
5bd52f0e 4264 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4265 (if (or is-x-REx
4266 ;; ignore other text properties:
4267 (string-match "^qw$" argument))
4268 (put-text-property b (point) 'indentable t))
5bd52f0e
RS
4269 (and go
4270 (setq e1 (cperl-1+ e1))
4271 (or (eobp)
4272 (forward-char 1))))
f83d2997
KH
4273 (cperl-commentify b i t)
4274 (if (looking-at "\\sw*e") ; s///e
4275 (progn
4ab89e7b
SM
4276 ;; Cache the syntax info...
4277 (setq cperl-syntax-state (cons state-point state))
f83d2997
KH
4278 (and
4279 ;; silent:
4ab89e7b 4280 (car (cperl-find-pods-heres b1 (1- (point)) t end))
f83d2997
KH
4281 ;; Error
4282 (goto-char (1+ max)))
5bd52f0e 4283 (if (and tag (eq (preceding-char) ?\>))
f83d2997
KH
4284 (progn
4285 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5bd52f0e 4286 (cperl-modify-syntax-type i cperl-st-bra)))
6c389151 4287 (put-text-property b i 'syntax-type 'string)
4ab89e7b 4288 (put-text-property i (point) 'syntax-type 'multiline)
6c389151
SM
4289 (if is-x-REx
4290 (put-text-property b i 'indentable t)))
5bd52f0e
RS
4291 (cperl-commentify b1 (point) t)
4292 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4293 (if is-x-REx
4294 (put-text-property b i 'indentable t))
5bd52f0e 4295 (if qtag
db133cb6 4296 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
f83d2997 4297 (setq tail nil)))
5bd52f0e 4298 ;; Now: tail: if the second part is non-matching without ///e
f83d2997
KH
4299 (if (eq (char-syntax (following-char)) ?w)
4300 (progn
4301 (forward-word 1) ; skip modifiers s///s
5bd52f0e 4302 (if tail (cperl-commentify tail (point) t))
a1506d29 4303 (cperl-postpone-fontification
4ab89e7b 4304 e1 (point) 'face my-cperl-REx-modifiers-face)))
5bd52f0e
RS
4305 ;; Check whether it is m// which means "previous match"
4306 ;; and highlight differently
a1506d29 4307 (setq is-REx
6c389151
SM
4308 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4309 (or (not (= (length argument) 0))
4310 (not (eq c ?\<)))))
a1506d29 4311 (if (and is-REx
6c389151 4312 (eq e (+ 2 b))
5bd52f0e
RS
4313 ;; split // *is* using zero-pattern
4314 (save-excursion
4315 (condition-case nil
4316 (progn
4317 (goto-char tb)
4318 (forward-sexp -1)
4319 (not (looking-at "split\\>")))
4320 (error t))))
5c8b7eaf 4321 (cperl-postpone-fontification
4ab89e7b 4322 b e 'face font-lock-warning-face)
5bd52f0e
RS
4323 (if (or i2 ; Has 2 args
4324 (and cperl-fontify-m-as-s
4325 (or
4326 (string-match "^\\(m\\|qr\\)$" argument)
4327 (and (eq 0 (length argument))
4328 (not (eq ?\< (char-after b)))))))
4329 (progn
5c8b7eaf 4330 (cperl-postpone-fontification
4ab89e7b 4331 b (cperl-1+ b) 'face my-cperl-delimiters-face)
5c8b7eaf 4332 (cperl-postpone-fontification
4ab89e7b 4333 (1- e) e 'face my-cperl-delimiters-face)))
6c389151 4334 (if (and is-REx cperl-regexp-scan)
4ab89e7b
SM
4335 ;; Process RExen: embedded comments, charclasses and ]
4336;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4337;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4338;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4339;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4340;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4341;;;m^a[\^b]c^ + m.a[^b]\.c.;
6c389151
SM
4342 (save-excursion
4343 (goto-char (1+ b))
cb5bf6ba 4344 ;; First
4ab89e7b
SM
4345 (cperl-look-at-leading-count is-x-REx e)
4346 (setq hairy-RE
4347 (concat
4348 (if is-x-REx
4349 (if (eq (char-after b) ?\#)
4350 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4351 "\\((\\?#\\)\\|\\(#\\)")
4352 ;; keep the same count: add a fake group
4353 (if (eq (char-after b) ?\#)
4354 "\\((\\?\\\\#\\)\\(\\)"
4355 "\\((\\?#\\)\\(\\)"))
4356 "\\|"
4357 "\\(\\[\\)" ; 3=[
4358 "\\|"
4359 "\\(]\\)" ; 4=]
4360 "\\|"
4361 ;; XXXX Will not be able to use it in s)))
4362 (if (eq (char-after b) ?\) )
4363 "\\())))\\)" ; Will never match
4364 (if (eq (char-after b) ?? )
4365 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4366 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4367 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4368 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4369 "\\(" ;; XXXX 1-char variables, exc. |()\s
4370 "[$@]"
4371 "\\("
4372 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4373 "\\|"
4374 "{[^{}]*}" ; only one-level allowed
4375 "\\|"
4376 "[^{(|) \t\r\n\f]"
4377 "\\)"
4378 "\\(" ;;8,9:code part of array/hash elt
4379 "\\(" "->" "\\)?"
4380 "\\[[^][]*\\]"
4381 "\\|"
4382 "{[^{}]*}"
4383 "\\)*"
4384 ;; XXXX: what if u is delim?
4385 "\\|"
4386 "[)^|$.*?+]"
4387 "\\|"
4388 "{[0-9]+}"
4389 "\\|"
4390 "{[0-9]+,[0-9]*}"
4391 "\\|"
4392 "\\\\[luLUEQbBAzZG]"
4393 "\\|"
4394 "(" ; Group opener
4395 "\\(" ; 10 group opener follower
4396 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4397 "\\|"
4398 "\\?[:=!>?{]" ; "?" something
4399 "\\|"
4400 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4401 "\\|"
4402 "\\?([0-9]+)" ; (?(1)foo|bar)
4403 "\\|"
4404 "\\?<[=!]"
4405 ;;;"\\|"
4406 ;;; "\\?"
4407 "\\)?"
4408 "\\)"
4409 "\\|"
4410 "\\\\\\(.\\)" ; 12=\SYMBOL
4411 ))
6c389151 4412 (while
4ab89e7b
SM
4413 (and (< (point) (1- e))
4414 (re-search-forward hairy-RE (1- e) 'to-end))
6c389151 4415 (goto-char (match-beginning 0))
4ab89e7b
SM
4416 (setq REx-subgr-start (point)
4417 was-subgr (following-char))
4418 (cond
4419 ((match-beginning 6) ; 0-length builtins, groups
4420 (goto-char (match-end 0))
4421 (if (match-beginning 11)
4422 (goto-char (match-beginning 11)))
4423 (if (>= (point) e)
4424 (goto-char (1- e)))
4425 (cperl-postpone-fontification
4426 (match-beginning 0) (point)
4427 'face
4428 (cond
4429 ((eq was-subgr ?\) )
4430 (condition-case nil
4431 (save-excursion
4432 (forward-sexp -1)
4433 (if (> (point) b)
4434 (if (if (eq (char-after b) ?? )
4435 (looking-at "(\\\\\\?")
4436 (eq (char-after (1+ (point))) ?\?))
4437 my-cperl-REx-0length-face
4438 my-cperl-REx-ctl-face)
4439 font-lock-warning-face))
4440 (error font-lock-warning-face)))
4441 ((eq was-subgr ?\| )
4442 my-cperl-REx-ctl-face)
4443 ((eq was-subgr ?\$ )
4444 (if (> (point) (1+ REx-subgr-start))
4445 (progn
4446 (put-text-property
4447 (match-beginning 0) (point)
4448 'REx-interpolated
4449 (if is-o-REx 0
4450 (if (and (eq (match-beginning 0)
4451 (1+ b))
4452 (eq (point)
4453 (1- e))) 1 t)))
4454 font-lock-variable-name-face)
4455 my-cperl-REx-spec-char-face))
4456 ((memq was-subgr (append "^." nil) )
4457 my-cperl-REx-spec-char-face)
4458 ((eq was-subgr ?\( )
4459 (if (not (match-beginning 10))
4460 my-cperl-REx-ctl-face
4461 my-cperl-REx-0length-face))
4462 (t my-cperl-REx-0length-face)))
4463 (if (and (memq was-subgr (append "(|" nil))
4464 (not (string-match "(\\?[-imsx]+)"
4465 (match-string 0))))
4466 (cperl-look-at-leading-count is-x-REx e))
4467 (setq was-subgr nil)) ; We do stuff here
4468 ((match-beginning 12) ; \SYMBOL
4469 (forward-char 2)
4470 (if (>= (point) e)
4471 (goto-char (1- e))
4472 ;; How many chars to not highlight:
4473 ;; 0-len special-alnums in other branch =>
4474 ;; Generic: \non-alnum (1), \alnum (1+face)
4475 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4476 (setq REx-subgr-start (point)
4477 qtag (preceding-char))
4478 (cperl-postpone-fontification
4479 (- (point) 2) (- (point) 1) 'face
4480 (if (memq qtag
4481 (append "ghijkmoqvFHIJKMORTVY" nil))
4482 font-lock-warning-face
4483 my-cperl-REx-0length-face))
4484 (if (and (eq (char-after b) qtag)
4485 (memq qtag (append ".])^$|*?+" nil)))
4486 (progn
4487 (if (and cperl-use-syntax-table-text-property
4488 (eq qtag ?\) ))
4489 (put-text-property
4490 REx-subgr-start (1- (point))
4491 'syntax-table cperl-st-punct))
4492 (cperl-postpone-fontification
4493 (1- (point)) (point) 'face
4494 ; \] can't appear below
4495 (if (memq qtag (append ".]^$" nil))
4496 'my-cperl-REx-spec-char-face
4497 (if (memq qtag (append "*?+" nil))
4498 'my-cperl-REx-0length-face
4499 'my-cperl-REx-ctl-face))))) ; )|
4500 ;; Test for arguments:
4501 (cond
4502 ;; This is not pretty: the 5.8.7 logic:
4503 ;; \0numx -> octal (up to total 3 dig)
4504 ;; \DIGIT -> backref unless \0
cb5bf6ba 4505 ;; \DIGITs -> backref if valid
4ab89e7b
SM
4506 ;; otherwise up to 3 -> octal
4507 ;; Do not try to distinguish, we guess
4508 ((or (and (memq qtag (append "01234567" nil))
4509 (re-search-forward
4510 "\\=[01234567]?[01234567]?"
4511 (1- e) 'to-end))
4512 (and (memq qtag (append "89" nil))
cb5bf6ba 4513 (re-search-forward
4ab89e7b
SM
4514 "\\=[0123456789]*" (1- e) 'to-end))
4515 (and (eq qtag ?x)
4516 (re-search-forward
4517 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4518 (1- e) 'to-end))
4519 (and (memq qtag (append "pPN" nil))
4520 (re-search-forward "\\={[^{}]+}\\|."
4521 (1- e) 'to-end))
4522 (eq (char-syntax qtag) ?w))
4523 (cperl-postpone-fontification
4524 (1- REx-subgr-start) (point)
4525 'face my-cperl-REx-length1-face))))
4526 (setq was-subgr nil)) ; We do stuff here
4527 ((match-beginning 3) ; [charclass]
8c777c8d 4528 ;; Highlight leader, trailer, POSIX classes
4ab89e7b
SM
4529 (forward-char 1)
4530 (if (eq (char-after b) ?^ )
4531 (and (eq (following-char) ?\\ )
4532 (eq (char-after (cperl-1+ (point)))
4533 ?^ )
4534 (forward-char 2))
4535 (and (eq (following-char) ?^ )
4536 (forward-char 1)))
8c777c8d 4537 (setq argument b ; continue? & end of last POSIX
4ab89e7b 4538 tag nil ; list of POSIX classes
8c777c8d 4539 qtag (point)) ; after leading ^ if present
4ab89e7b
SM
4540 (if (eq (char-after b) ?\] )
4541 (and (eq (following-char) ?\\ )
4542 (eq (char-after (cperl-1+ (point)))
4543 ?\] )
4544 (setq qtag (1+ qtag))
4545 (forward-char 2))
4546 (and (eq (following-char) ?\] )
4547 (forward-char 1)))
8c777c8d 4548 (setq REx-subgr-end qtag) ;EndOf smart-highlighed
4ab89e7b
SM
4549 ;; Apparently, I can't put \] into a charclass
4550 ;; in m]]: m][\\\]\]] produces [\\]]
4551;;; POSIX? [:word:] [:^word:] only inside []
8c777c8d
CY
4552;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4553 (while ; look for unescaped ]
4ab89e7b
SM
4554 (and argument
4555 (re-search-forward
4556 (if (eq (char-after b) ?\] )
4557 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4558 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4559 (1- e) 'toend))
4560 ;; Is this ] an end of POSIX class?
4561 (if (save-excursion
4562 (and
4563 (search-backward "[" argument t)
4564 (< REx-subgr-start (point))
8c777c8d
CY
4565 (setq argument (point)) ; POSIX-start
4566 (or ; Should work with delim = \
4567 (not (eq (preceding-char) ?\\ ))
4568 ;; XXXX Double \\ is needed with 19.33
4569 (= (% (skip-chars-backward "\\\\") 2) 0))
4ab89e7b
SM
4570 (looking-at
4571 (cond
4572 ((eq (char-after b) ?\] )
4573 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4574 ((eq (char-after b) ?\: )
4575 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4576 ((eq (char-after b) ?^ )
4577 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
4578 ((eq (char-syntax (char-after b))
4579 ?w)
4580 (concat
4581 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4582 (char-to-string (char-after b))
4583 "\\|\\sw\\)+:\]"))
4584 (t "\\\\*\\[:\\^?\\sw*:]")))
8c777c8d
CY
4585 (goto-char REx-subgr-end)
4586 (cperl-highlight-charclass
4587 argument my-cperl-REx-spec-char-face
4588 my-cperl-REx-0length-face my-cperl-REx-length1-face)))
4ab89e7b
SM
4589 (setq tag (cons (cons argument (point))
4590 tag)
8c777c8d
CY
4591 argument (point)
4592 REx-subgr-end argument) ; continue
4ab89e7b
SM
4593 (setq argument nil)))
4594 (and argument
4595 (message "Couldn't find end of charclass in a REx, pos=%s"
4596 REx-subgr-start))
8c777c8d
CY
4597 (setq argument (1- (point)))
4598 (goto-char REx-subgr-end)
4599 (cperl-highlight-charclass
4600 argument my-cperl-REx-spec-char-face
4601 my-cperl-REx-0length-face my-cperl-REx-length1-face)
4602 (forward-char 1)
4603 ;; Highlight starter, trailer, POSIX
4ab89e7b
SM
4604 (if (and cperl-use-syntax-table-text-property
4605 (> (- (point) 2) REx-subgr-start))
4606 (put-text-property
4607 (1+ REx-subgr-start) (1- (point))
4608 'syntax-table cperl-st-punct))
4609 (cperl-postpone-fontification
4610 REx-subgr-start qtag
4611 'face my-cperl-REx-spec-char-face)
4612 (cperl-postpone-fontification
4613 (1- (point)) (point) 'face
4614 my-cperl-REx-spec-char-face)
4615 (if (eq (char-after b) ?\] )
4616 (cperl-postpone-fontification
4617 (- (point) 2) (1- (point))
4618 'face my-cperl-REx-0length-face))
4619 (while tag
4620 (cperl-postpone-fontification
4621 (car (car tag)) (cdr (car tag))
8c777c8d 4622 'face font-lock-variable-name-face) ;my-cperl-REx-length1-face
4ab89e7b
SM
4623 (setq tag (cdr tag)))
4624 (setq was-subgr nil)) ; did facing already
4625 ;; Now rare stuff:
4626 ((and (match-beginning 2) ; #-comment
4627 (/= (match-beginning 2) (match-end 2)))
4628 (beginning-of-line 2)
4629 (if (> (point) e)
4630 (goto-char (1- e))))
4631 ((match-beginning 4) ; character "]"
4632 (setq was-subgr nil) ; We do stuff here
4633 (goto-char (match-end 0))
4634 (if cperl-use-syntax-table-text-property
4635 (put-text-property
4636 (1- (point)) (point)
4637 'syntax-table cperl-st-punct))
4638 (cperl-postpone-fontification
4639 (1- (point)) (point)
4640 'face font-lock-warning-face))
4641 ((match-beginning 5) ; before (?{}) (??{})
4642 (setq tag (match-end 0))
4643 (if (or (setq qtag
4644 (cperl-forward-group-in-re st-l))
4645 (and (>= (point) e)
4646 (setq qtag "no matching `)' found"))
4647 (and (not (eq (char-after (- (point) 2))
4648 ?\} ))
4649 (setq qtag "Can't find })")))
a1506d29 4650 (progn
4ab89e7b 4651 (goto-char (1- e))
274f1353 4652 (message "%s" qtag))
4ab89e7b
SM
4653 (cperl-postpone-fontification
4654 (1- tag) (1- (point))
4655 'face font-lock-variable-name-face)
4656 (cperl-postpone-fontification
4657 REx-subgr-start (1- tag)
4658 'face my-cperl-REx-spec-char-face)
4659 (cperl-postpone-fontification
4660 (1- (point)) (point)
4661 'face my-cperl-REx-spec-char-face)
4662 (if cperl-use-syntax-table-text-property
4663 (progn
4664 (put-text-property
4665 (- (point) 2) (1- (point))
4666 'syntax-table cperl-st-cfence)
4667 (put-text-property
4668 (+ REx-subgr-start 2)
4669 (+ REx-subgr-start 3)
4670 'syntax-table cperl-st-cfence))))
4671 (setq was-subgr nil))
4672 (t ; (?#)-comment
4673 ;; Inside "(" and "\" arn't special in any way
4674 ;; Works also if the outside delimiters are ().
4675 (or;;(if (eq (char-after b) ?\) )
4676 ;;(re-search-forward
4677 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4678 ;; (1- e) 'toend)
4679 (search-forward ")" (1- e) 'toend)
4680 ;;)
4681 (message
4682 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4683 REx-subgr-start))))
6c389151
SM
4684 (if (>= (point) e)
4685 (goto-char (1- e)))
4ab89e7b
SM
4686 (cond
4687 (was-subgr
4688 (setq REx-subgr-end (point))
4689 (cperl-commentify
4690 REx-subgr-start REx-subgr-end nil)
4691 (cperl-postpone-fontification
4692 REx-subgr-start REx-subgr-end
4693 'face font-lock-comment-face))))))
6c389151 4694 (if (and is-REx is-x-REx)
a1506d29 4695 (put-text-property (1+ b) (1- e)
6c389151 4696 'syntax-subtype 'x-REx)))
8c777c8d 4697 (if (and i2 e1 (or (not b1) (> e1 b1)))
82d9a08d 4698 (progn ; No errors finding the second part...
5c8b7eaf 4699 (cperl-postpone-fontification
4ab89e7b 4700 (1- e1) e1 'face my-cperl-delimiters-face)
05927f8c
VJL
4701 (if (and (not (eobp))
4702 (assoc (char-after b) cperl-starters))
4ab89e7b
SM
4703 (progn
4704 (cperl-postpone-fontification
4705 b1 (1+ b1) 'face my-cperl-delimiters-face)
4706 (put-text-property b1 (1+ b1)
4707 'REx-part2 t)))))
5bd52f0e
RS
4708 (if (> (point) max)
4709 (setq tmpend tb))))
4ab89e7b
SM
4710 ((match-beginning 17) ; sub with prototype or attribute
4711 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4712 ;;"\\<sub\\>\\(" ;12
4713 ;; cperl-white-and-comment-rex ;13
4714 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4715 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4716 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4717 (setq b1 (match-beginning 14) e1 (match-end 14))
f83d2997
KH
4718 (if (memq (char-after (1- b))
4719 '(?\$ ?\@ ?\% ?\& ?\*))
4720 nil
4ab89e7b
SM
4721 (goto-char b)
4722 (if (eq (char-after (match-beginning 17)) ?\( )
4723 (progn
4724 (cperl-commentify ; Prototypes; mark as string
4725 (match-beginning 17) (match-end 17) t)
4726 (goto-char (match-end 0))
4727 ;; Now look for attributes after prototype:
4728 (forward-comment (buffer-size))
4729 (and (looking-at ":[^:]")
4730 (cperl-find-sub-attrs st-l b1 e1 b)))
4731 ;; treat attributes without prototype
4732 (goto-char (match-beginning 17))
4733 (cperl-find-sub-attrs st-l b1 e1 b))))
4734 ;; 1+6+2+1+1+6+1=18 extra () before this:
f83d2997 4735 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4ab89e7b
SM
4736 ((match-beginning 19) ; old $abc'efg syntax
4737 (setq bb (match-end 0))
4738 ;;;(if (nth 3 state) nil ; in string
4739 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
f83d2997 4740 (goto-char bb))
4ab89e7b 4741 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
f83d2997 4742 ;; "__\\(END\\|DATA\\)__"
4ab89e7b
SM
4743 ((match-beginning 20) ; __END__, __DATA__
4744 (setq bb (match-end 0))
4745 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4746 (cperl-commentify b bb nil)
4747 (setq end t))
4748 ;; "\\\\\\(['`\"($]\\)"
4749 ((match-beginning 21)
4750 ;; Trailing backslash; make non-quoting outside string/comment
4751 (setq bb (match-end 0))
6c389151
SM
4752 (goto-char b)
4753 (skip-chars-backward "\\\\")
4754 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4ab89e7b 4755 (cperl-modify-syntax-type b cperl-st-punct)
6c389151
SM
4756 (goto-char bb))
4757 (t (error "Error in regexp of the sniffer")))
db133cb6 4758 (if (> (point) stop-point)
f83d2997 4759 (progn
5c8b7eaf 4760 (if end
f83d2997
KH
4761 (message "Garbage after __END__/__DATA__ ignored")
4762 (message "Unbalanced syntax found while scanning")
4763 (or (car err-l) (setcar err-l b)))
db133cb6
RS
4764 (goto-char stop-point))))
4765 (setq cperl-syntax-state (cons state-point state)
4ab89e7b
SM
4766 ;; Do not mark syntax as done past tmpend???
4767 cperl-syntax-done-to (or tmpend (max (point) max)))
4768 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4769 )
f83d2997 4770 (if (car err-l) (goto-char (car err-l))
db133cb6
RS
4771 (or non-inter
4772 (message "Scanning for \"hard\" Perl constructions... done"))))
f83d2997
KH
4773 (and (buffer-modified-p)
4774 (not modified)
4775 (set-buffer-modified-p nil))
00424a9e
SM
4776 ;; I do not understand what this is doing here. It breaks font-locking
4777 ;; because it resets the syntax-table from font-lock-syntax-table to
4778 ;; cperl-mode-syntax-table.
4779 ;; (set-syntax-table cperl-mode-syntax-table)
4780 )
4ab89e7b
SM
4781 (list (car err-l) overshoot)))
4782
4783(defun cperl-find-pods-heres-region (min max)
4784 (interactive "r")
4785 (cperl-find-pods-heres min max))
f83d2997
KH
4786
4787(defun cperl-backward-to-noncomment (lim)
4788 ;; Stops at lim or after non-whitespace that is not in comment
4ab89e7b 4789 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
5bd52f0e 4790 (let (stop p pr)
4ab89e7b 4791 (while (and (not stop) (> (point) (or lim (point-min))))
f83d2997
KH
4792 (skip-chars-backward " \t\n\f" lim)
4793 (setq p (point))
4794 (beginning-of-line)
5bd52f0e
RS
4795 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4796 '(pod here-doc here-doc-delim))
82d9a08d
SM
4797 (progn
4798 (cperl-unwind-to-safe nil)
4799 (setq pr (get-text-property (point) 'syntax-type))))
4800 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4801 (not (memq pr '(string prestring))))
4802 (progn (cperl-to-comment-or-eol) (bolp))
4803 (progn
4804 (skip-chars-backward " \t")
4805 (if (< p (point)) (goto-char p))
4806 (setq stop t))))))
f83d2997 4807
4ab89e7b
SM
4808;; Used only in `cperl-calculate-indent'...
4809(defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4810 ;; Positions is before ?\{. Checks whether it starts a block.
4811 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4812 (cperl-backward-to-noncomment (point-min))
4813 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4814 ; Label may be mixed up with `$blah :'
4815 (save-excursion (cperl-after-label))
4816 (get-text-property (cperl-1- (point)) 'attrib-group)
4817 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4818 (progn
4819 (backward-sexp)
4820 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4821 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4822 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
4823 ;; sub bless::foo {}
4824 (progn
4825 (cperl-backward-to-noncomment (point-min))
4826 (and (eq (preceding-char) ?b)
4827 (progn
4828 (forward-sexp -1)
4829 (looking-at "sub[ \t\n\f#]")))))))))
4830
4831;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4832;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4833;;; may be a part of an in-statement construct, such as
4834;;; ${something()}, print {FH} $data.
4835;;; Moreover, one takes positive approach (looks for else,grep etc)
4836;;; another negative (looks for bless,tr etc)
f739b53b 4837(defun cperl-after-block-p (lim &optional pre-block)
4ab89e7b
SM
4838 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
4839Would not look before LIM. Assumes that LIM is a good place to begin a
4840statement. The kind of block we treat here is one after which a new
4841statement would start; thus the block in ${func()} does not count."
f83d2997
KH
4842 (save-excursion
4843 (condition-case nil
4844 (progn
f739b53b 4845 (or pre-block (forward-sexp -1))
f83d2997 4846 (cperl-backward-to-noncomment lim)
bab27c0c 4847 (or (eq (point) lim)
4ab89e7b
SM
4848 ;; if () {} // sub f () {} // sub f :a(') {}
4849 (eq (preceding-char) ?\) )
4850 ;; label: {}
4851 (save-excursion (cperl-after-label))
4852 ;; sub :attr {}
4853 (get-text-property (cperl-1- (point)) 'attrib-group)
4854 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
db133cb6
RS
4855 (save-excursion
4856 (forward-sexp -1)
4ab89e7b
SM
4857 ;; else {} but not else::func {}
4858 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4859 (not (looking-at "\\(\\sw\\|_\\)+::")))
db133cb6
RS
4860 ;; sub f {}
4861 (progn
4862 (cperl-backward-to-noncomment lim)
4ab89e7b 4863 (and (eq (preceding-char) ?b)
db133cb6
RS
4864 (progn
4865 (forward-sexp -1)
4ab89e7b
SM
4866 (looking-at "sub[ \t\n\f#]"))))))
4867 ;; What preceeds is not word... XXXX Last statement in sub???
db133cb6 4868 (cperl-after-expr-p lim))))
f83d2997
KH
4869 (error nil))))
4870
4871(defun cperl-after-expr-p (&optional lim chars test)
029cb4d5 4872 "Return true if the position is good for start of expression.
f83d2997
KH
4873TEST is the expression to evaluate at the found position. If absent,
4874CHARS is a string that contains good characters to have before us (however,
4875`}' is treated \"smartly\" if it is not in the list)."
83261a2f 4876 (let ((lim (or lim (point-min)))
f739b53b
SM
4877 stop p pr)
4878 (cperl-update-syntaxification (point) (point))
f83d2997
KH
4879 (save-excursion
4880 (while (and (not stop) (> (point) lim))
4881 (skip-chars-backward " \t\n\f" lim)
4882 (setq p (point))
4883 (beginning-of-line)
f739b53b
SM
4884 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4885 ;; '(pod here-doc here-doc-delim))
4886 (if (get-text-property (point) 'here-doc-group)
4887 (progn
4888 (goto-char
4ab89e7b 4889 (cperl-beginning-of-property (point) 'here-doc-group))
f739b53b
SM
4890 (beginning-of-line 0)))
4891 (if (get-text-property (point) 'in-pod)
4892 (progn
4893 (goto-char
4ab89e7b 4894 (cperl-beginning-of-property (point) 'in-pod))
f739b53b 4895 (beginning-of-line 0)))
f83d2997 4896 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
5bd52f0e 4897 ;; Else: last iteration, or a label
f739b53b 4898 (cperl-to-comment-or-eol) ; Will not move past "." after a format
f83d2997
KH
4899 (skip-chars-backward " \t")
4900 (if (< p (point)) (goto-char p))
5bd52f0e
RS
4901 (setq p (point))
4902 (if (and (eq (preceding-char) ?:)
4903 (progn
4904 (forward-char -1)
4905 (skip-chars-backward " \t\n\f" lim)
4ab89e7b 4906 (memq (char-syntax (preceding-char)) '(?w ?_))))
5bd52f0e
RS
4907 (forward-sexp -1) ; Possibly label. Skip it
4908 (goto-char p)
4909 (setq stop t))))
bab27c0c
RS
4910 (or (bobp) ; ???? Needed
4911 (eq (point) lim)
029cb4d5 4912 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
f83d2997
KH
4913 (progn
4914 (if test (eval test)
4915 (or (memq (preceding-char) (append (or chars "{;") nil))
4916 (and (eq (preceding-char) ?\})
f739b53b
SM
4917 (cperl-after-block-p lim))
4918 (and (eq (following-char) ?.) ; in format: see comment above
4919 (eq (get-text-property (point) 'syntax-type)
4920 'format)))))))))
f83d2997 4921
4ab89e7b
SM
4922(defun cperl-backward-to-start-of-expr (&optional lim)
4923 (condition-case nil
4924 (progn
4925 (while (and (or (not lim)
4926 (> (point) lim))
4927 (not (cperl-after-expr-p lim)))
4928 (forward-sexp -1)
4929 ;; May be after $, @, $# etc of a variable
4930 (skip-chars-backward "$@%#")))
4931 (error nil)))
4932
4933(defun cperl-at-end-of-expr (&optional lim)
4934 ;; Since the SEXP approach below is very fragile, do some overengineering
4935 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4936 (condition-case nil
4937 (save-excursion
4938 ;; If nothing interesting after, does as (forward-sexp -1);
4939 ;; otherwise fails, or ends at a start of following sexp.
4940 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4941 ;; may be stuck after @ or $; just put some stupid workaround now:
4942 (let ((p (point)))
4943 (forward-sexp 1)
4944 (forward-sexp -1)
4945 (while (memq (preceding-char) (append "%&@$*" nil))
4946 (forward-char -1))
4947 (or (< (point) p)
4948 (cperl-after-expr-p lim))))
4949 (error t))))
4950
4951(defun cperl-forward-to-end-of-expr (&optional lim)
4952 (let ((p (point))))
4953 (condition-case nil
4954 (progn
4955 (while (and (< (point) (or lim (point-max)))
4956 (not (cperl-at-end-of-expr)))
4957 (forward-sexp 1)))
4958 (error nil)))
4959
f83d2997
KH
4960(defun cperl-backward-to-start-of-continued-exp (lim)
4961 (if (memq (preceding-char) (append ")]}\"'`" nil))
4962 (forward-sexp -1))
4963 (beginning-of-line)
4964 (if (<= (point) lim)
4965 (goto-char (1+ lim)))
4966 (skip-chars-forward " \t"))
4967
db133cb6
RS
4968(defun cperl-after-block-and-statement-beg (lim)
4969 ;; We assume that we are after ?\}
5c8b7eaf 4970 (and
db133cb6
RS
4971 (cperl-after-block-p lim)
4972 (save-excursion
4973 (forward-sexp -1)
4974 (cperl-backward-to-noncomment (point-min))
4975 (or (bobp)
bab27c0c 4976 (eq (point) lim)
db133cb6
RS
4977 (not (= (char-syntax (preceding-char)) ?w))
4978 (progn
4979 (forward-sexp -1)
5c8b7eaf 4980 (not
db133cb6
RS
4981 (looking-at
4982 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
4983
f83d2997 4984\f
f83d2997
KH
4985(defun cperl-indent-exp ()
4986 "Simple variant of indentation of continued-sexp.
5bd52f0e
RS
4987
4988Will not indent comment if it starts at `comment-indent' or looks like
4989continuation of the comment on the previous line.
db133cb6 4990
5c8b7eaf 4991If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 4992conditional/loop constructs."
f83d2997
KH
4993 (interactive)
4994 (save-excursion
e180ab9f 4995 (let ((tmp-end (point-at-eol)) top done)
f83d2997
KH
4996 (save-excursion
4997 (beginning-of-line)
4998 (while (null done)
4999 (setq top (point))
4ab89e7b
SM
5000 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
5001 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
f83d2997
KH
5002 (setq top (point))) ; Get the outermost parenths in line
5003 (goto-char top)
5004 (while (< (point) tmp-end)
5005 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5006 (or (eolp) (forward-sexp 1)))
4ab89e7b
SM
5007 (if (> (point) tmp-end) ; Yes, there an unfinished block
5008 nil
5009 (if (eq ?\) (preceding-char))
5010 (progn ;; Plan B: find by REGEXP block followup this line
5011 (setq top (point))
5012 (condition-case nil
5013 (progn
5014 (forward-sexp -2)
5015 (if (eq (following-char) ?$ ) ; for my $var (list)
5016 (progn
5017 (forward-sexp -1)
5018 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5019 (forward-sexp -1))))
5020 (if (looking-at
5021 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5022 "\\|for\\(each\\)?\\>\\(\\("
5023 cperl-maybe-white-and-comment-rex
5024 "\\(my\\|local\\|our\\)\\)?"
5025 cperl-maybe-white-and-comment-rex
5026 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5027 (progn
5028 (goto-char top)
5029 (forward-sexp 1)
5030 (setq top (point)))))
5031 (error (setq done t)))
5032 (goto-char top))
5033 (if (looking-at ; Try Plan C: continuation block
5034 (concat cperl-maybe-white-and-comment-rex
5035 "\\<\\(else\\|elsif\|continue\\)\\>"))
5036 (progn
5037 (goto-char (match-end 0))
e180ab9f 5038 (setq tmp-end (point-at-eol)))
4ab89e7b 5039 (setq done t))))
e180ab9f 5040 (setq tmp-end (point-at-eol)))
f83d2997
KH
5041 (goto-char tmp-end)
5042 (setq tmp-end (point-marker)))
db133cb6
RS
5043 (if cperl-indent-region-fix-constructs
5044 (cperl-fix-line-spacing tmp-end))
f83d2997
KH
5045 (cperl-indent-region (point) tmp-end))))
5046
5bd52f0e
RS
5047(defun cperl-fix-line-spacing (&optional end parse-data)
5048 "Improve whitespace in a conditional/loop construct.
5049Returns some position at the last line."
db133cb6
RS
5050 (interactive)
5051 (or end
5052 (setq end (point-max)))
e180ab9f 5053 (let ((ee (point-at-eol))
83261a2f
SM
5054 (cperl-indent-region-fix-constructs
5055 (or cperl-indent-region-fix-constructs 1))
5056 p pp ml have-brace ret)
db133cb6
RS
5057 (save-excursion
5058 (beginning-of-line)
5bd52f0e 5059 (setq ret (point))
5c8b7eaf 5060 ;; }? continue
5bd52f0e 5061 ;; blah; }
5c8b7eaf 5062 (if (not
5bd52f0e
RS
5063 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5064 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5065 nil ; Do not need to do anything
83261a2f
SM
5066 ;; Looking at:
5067 ;; }
5068 ;; else
4ab89e7b
SM
5069 (if cperl-merge-trailing-else
5070 (if (looking-at
5071 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5072 (progn
5073 (search-forward "}")
5074 (setq p (point))
5075 (skip-chars-forward " \t\n")
5076 (delete-region p (point))
b5b0cb34 5077 (insert (make-string cperl-indent-region-fix-constructs ?\s))
4ab89e7b
SM
5078 (beginning-of-line)))
5079 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5080 (save-excursion
5081 (search-forward "}")
5082 (delete-horizontal-space)
5083 (insert "\n")
5084 (setq ret (point))
5085 (if (cperl-indent-line parse-data)
5086 (progn
5087 (cperl-fix-line-spacing end parse-data)
5088 (setq ret (point)))))))
83261a2f
SM
5089 ;; Looking at:
5090 ;; } else
5091 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5092 (progn
5093 (search-forward "}")
5094 (delete-horizontal-space)
b5b0cb34 5095 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5096 (beginning-of-line)))
5097 ;; Looking at:
5098 ;; else {
5099 (if (looking-at
5100 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5101 (progn
5102 (forward-word 1)
5103 (delete-horizontal-space)
b5b0cb34 5104 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5105 (beginning-of-line)))
5106 ;; Looking at:
5107 ;; foreach my $var
5108 (if (looking-at
5109 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5110 (progn
5111 (forward-word 2)
5112 (delete-horizontal-space)
b5b0cb34 5113 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5114 (beginning-of-line)))
5115 ;; Looking at:
5116 ;; foreach my $var (
5117 (if (looking-at
6c389151 5118 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
83261a2f 5119 (progn
f739b53b 5120 (forward-sexp 3)
83261a2f
SM
5121 (delete-horizontal-space)
5122 (insert
b5b0cb34 5123 (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f 5124 (beginning-of-line)))
4ab89e7b
SM
5125 ;; Looking at (with or without "}" at start, ending after "({"):
5126 ;; } foreach my $var () OR {
83261a2f 5127 (if (looking-at
ce22dd53 5128 "[ \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 5129 (progn
4ab89e7b 5130 (setq ml (match-beginning 8)) ; "(" or "{" after control word
83261a2f
SM
5131 (re-search-forward "[({]")
5132 (forward-char -1)
5133 (setq p (point))
5134 (if (eq (following-char) ?\( )
5135 (progn
5136 (forward-sexp 1)
4ab89e7b 5137 (setq pp (point))) ; past parenth-group
83261a2f
SM
5138 ;; after `else' or nothing
5139 (if ml ; after `else'
5140 (skip-chars-backward " \t\n")
5141 (beginning-of-line))
5142 (setq pp nil))
5143 ;; Now after the sexp before the brace
5144 ;; Multiline expr should be special
5145 (setq ml (and pp (save-excursion (goto-char p)
5146 (search-forward "\n" pp t))))
4ab89e7b 5147 (if (and (or (not pp) (< pp end)) ; Do not go too far...
83261a2f
SM
5148 (looking-at "[ \t\n]*{"))
5149 (progn
5150 (cond
5151 ((bolp) ; Were before `{', no if/else/etc
5152 nil)
4ab89e7b 5153 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
83261a2f
SM
5154 (delete-horizontal-space)
5155 (if (if ml
5156 cperl-extra-newline-before-brace-multiline
5157 cperl-extra-newline-before-brace)
5158 (progn
5159 (delete-horizontal-space)
5160 (insert "\n")
5161 (setq ret (point))
5162 (if (cperl-indent-line parse-data)
5163 (progn
5164 (cperl-fix-line-spacing end parse-data)
5165 (setq ret (point)))))
5166 (insert
b5b0cb34 5167 (make-string cperl-indent-region-fix-constructs ?\s))))
83261a2f
SM
5168 ((and (looking-at "[ \t]*\n")
5169 (not (if ml
5170 cperl-extra-newline-before-brace-multiline
5171 cperl-extra-newline-before-brace)))
5172 (setq pp (point))
5173 (skip-chars-forward " \t\n")
5174 (delete-region pp (point))
db133cb6 5175 (insert
4ab89e7b
SM
5176 (make-string cperl-indent-region-fix-constructs ?\ )))
5177 ((and (looking-at "[\t ]*{")
5178 (if ml cperl-extra-newline-before-brace-multiline
5179 cperl-extra-newline-before-brace))
5180 (delete-horizontal-space)
5181 (insert "\n")
5182 (setq ret (point))
5183 (if (cperl-indent-line parse-data)
5184 (progn
5185 (cperl-fix-line-spacing end parse-data)
5186 (setq ret (point))))))
83261a2f
SM
5187 ;; Now we are before `{'
5188 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5189 (progn
5190 (skip-chars-forward " \t\n")
5191 (setq pp (point))
5192 (forward-sexp 1)
5193 (setq p (point))
5194 (goto-char pp)
5195 (setq ml (search-forward "\n" p t))
5196 (if (or cperl-break-one-line-blocks-when-indent ml)
5197 ;; not good: multi-line BLOCK
5198 (progn
5199 (goto-char (1+ pp))
5200 (delete-horizontal-space)
5201 (insert "\n")
5202 (setq ret (point))
5203 (if (cperl-indent-line parse-data)
5204 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5205 (beginning-of-line)
e180ab9f 5206 (setq p (point) pp (point-at-eol)) ; May be different from ee.
83261a2f
SM
5207 ;; Now check whether there is a hanging `}'
5208 ;; Looking at:
5209 ;; } blah
5210 (if (and
5211 cperl-fix-hanging-brace-when-indent
5212 have-brace
5213 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5214 (condition-case nil
5215 (progn
5216 (up-list 1)
5217 (if (and (<= (point) pp)
5218 (eq (preceding-char) ?\} )
5219 (cperl-after-block-and-statement-beg (point-min)))
5220 t
5221 (goto-char p)
5222 nil))
5223 (error nil)))
5224 (progn
5225 (forward-char -1)
5226 (skip-chars-backward " \t")
5227 (if (bolp)
5228 ;; `}' was the first thing on the line, insert NL *after* it.
5229 (progn
5230 (cperl-indent-line parse-data)
5231 (search-forward "}")
5232 (delete-horizontal-space)
5233 (insert "\n"))
5234 (delete-horizontal-space)
5235 (or (eq (preceding-char) ?\;)
5236 (bolp)
5237 (and (eq (preceding-char) ?\} )
5238 (cperl-after-block-p (point-min)))
5239 (insert ";"))
5240 (insert "\n")
5241 (setq ret (point)))
5242 (if (cperl-indent-line parse-data)
5243 (setq ret (cperl-fix-line-spacing end parse-data)))
5244 (beginning-of-line)))))
5bd52f0e
RS
5245 ret))
5246
5247(defvar cperl-update-start) ; Do not need to make them local
5248(defvar cperl-update-end)
5249(defun cperl-delay-update-hook (beg end old-len)
5250 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5251 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
db133cb6 5252
f83d2997
KH
5253(defun cperl-indent-region (start end)
5254 "Simple variant of indentation of region in CPerl mode.
5c8b7eaf 5255Should be slow. Will not indent comment if it starts at `comment-indent'
f83d2997 5256or looks like continuation of the comment on the previous line.
5c8b7eaf
SS
5257Indents all the lines whose first character is between START and END
5258inclusive.
db133cb6 5259
5c8b7eaf 5260If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 5261conditional/loop constructs."
f83d2997 5262 (interactive "r")
5bd52f0e 5263 (cperl-update-syntaxification end end)
f83d2997 5264 (save-excursion
5bd52f0e 5265 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
83261a2f
SM
5266 (let ((indent-info (if cperl-emacs-can-parse
5267 (list nil nil nil) ; Cannot use '(), since will modify
5268 nil))
c326ddd1 5269 (pm 0)
83261a2f
SM
5270 after-change-functions ; Speed it up!
5271 st comm old-comm-indent new-comm-indent p pp i empty)
5bd52f0e 5272 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
83261a2f
SM
5273 (goto-char start)
5274 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5275 (current-column))
5276 new-comm-indent old-comm-indent)
5277 (goto-char start)
5278 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5279 (or (bolp) (beginning-of-line 2))
83261a2f 5280 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5bd52f0e
RS
5281 (setq st (point))
5282 (if (or
5283 (setq empty (looking-at "[ \t]*\n"))
5284 (and (setq comm (looking-at "[ \t]*#"))
83261a2f
SM
5285 (or (eq (current-indentation) (or old-comm-indent
5286 comment-column))
5bd52f0e 5287 (setq old-comm-indent nil))))
8c777c8d 5288 (if (and old-comm-indent
5bd52f0e 5289 (not empty)
8c777c8d 5290 (= (current-indentation) old-comm-indent)
5bd52f0e
RS
5291 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5292 (not (eq (get-text-property (point) 'syntax-table)
5293 cperl-st-cfence)))
83261a2f
SM
5294 (let ((comment-column new-comm-indent))
5295 (indent-for-comment)))
5296 (progn
5bd52f0e 5297 (setq i (cperl-indent-line indent-info))
8c777c8d
CY
5298 (or comm
5299 (not i)
5300 (progn
5301 (if cperl-indent-region-fix-constructs
5bd52f0e 5302 (goto-char (cperl-fix-line-spacing end indent-info)))
83261a2f
SM
5303 (if (setq old-comm-indent
5304 (and (cperl-to-comment-or-eol)
5305 (not (memq (get-text-property (point)
5306 'syntax-type)
5307 '(pod here-doc)))
5c8b7eaf 5308 (not (eq (get-text-property (point)
5bd52f0e
RS
5309 'syntax-table)
5310 cperl-st-cfence))
8c777c8d
CY
5311 (current-column)))
5312 (progn (indent-for-comment)
5313 (skip-chars-backward " \t")
5314 (skip-chars-backward "#")
5315 (setq new-comm-indent (current-column))))))))
5316 (beginning-of-line 2)))
5bd52f0e 5317 ;; Now run the update hooks
83261a2f
SM
5318 (and after-change-functions
5319 cperl-update-end
5320 (save-excursion
5321 (goto-char cperl-update-end)
5322 (insert " ")
5323 (delete-char -1)
5324 (goto-char cperl-update-start)
5325 (insert " ")
5326 (delete-char -1))))))
f83d2997 5327
f83d2997
KH
5328;; Stolen from lisp-mode with a lot of improvements
5329
5330(defun cperl-fill-paragraph (&optional justify iteration)
82eb0dae 5331 "Like `fill-paragraph', but handle CPerl comments.
f83d2997
KH
5332If any of the current line is a comment, fill the comment or the
5333block of it that point is in, preserving the comment's initial
5334indentation and initial hashes. Behaves usually outside of comment."
82eb0dae 5335 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
83261a2f 5336 (let (;; Non-nil if the current line contains a comment.
f83d2997 5337 has-comment
4ab89e7b 5338 fill-paragraph-function ; do not recurse
f83d2997
KH
5339 ;; If has-comment, the appropriate fill-prefix for the comment.
5340 comment-fill-prefix
5341 ;; Line that contains code and comment (or nil)
5342 start
5343 c spaces len dc (comment-column comment-column))
5344 ;; Figure out what kind of comment we are looking at.
5345 (save-excursion
5346 (beginning-of-line)
5347 (cond
5348
5349 ;; A line with nothing but a comment on it?
5350 ((looking-at "[ \t]*#[# \t]*")
5351 (setq has-comment t
5352 comment-fill-prefix (buffer-substring (match-beginning 0)
5353 (match-end 0))))
5354
5355 ;; A line with some code, followed by a comment? Remember that the
5356 ;; semi which starts the comment shouldn't be part of a string or
5357 ;; character.
5358 ((cperl-to-comment-or-eol)
5359 (setq has-comment t)
5360 (looking-at "#+[ \t]*")
5c8b7eaf 5361 (setq start (point) c (current-column)
f83d2997 5362 comment-fill-prefix
b5b0cb34 5363 (concat (make-string (current-column) ?\s)
f83d2997 5364 (buffer-substring (match-beginning 0) (match-end 0)))
5c8b7eaf 5365 spaces (progn (skip-chars-backward " \t")
f83d2997 5366 (buffer-substring (point) start))
5c8b7eaf 5367 dc (- c (current-column)) len (- start (point))
f83d2997
KH
5368 start (point-marker))
5369 (delete-char len)
4ab89e7b 5370 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
f83d2997 5371 (if (not has-comment)
83261a2f 5372 (fill-paragraph justify) ; Do the usual thing outside of comment
f83d2997
KH
5373 ;; Narrow to include only the comment, and then fill the region.
5374 (save-restriction
5375 (narrow-to-region
5376 ;; Find the first line we should include in the region to fill.
5377 (if start (progn (beginning-of-line) (point))
5378 (save-excursion
5379 (while (and (zerop (forward-line -1))
5380 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5381 ;; We may have gone to far. Go forward again.
5382 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5383 (forward-line 1))
5384 (point)))
5385 ;; Find the beginning of the first line past the region to fill.
5386 (save-excursion
5387 (while (progn (forward-line 1)
5388 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5389 (point)))
5390 ;; Remove existing hashes
4ab89e7b 5391 (goto-char (point-min))
8c777c8d
CY
5392 (save-excursion
5393 (while (progn (forward-line 1) (< (point) (point-max)))
5394 (skip-chars-forward " \t")
5395 (if (looking-at "#+")
5396 (progn
5397 (if (and (eq (point) (match-beginning 0))
5398 (not (eq (point) (match-end 0)))) nil
4ab89e7b
SM
5399 (error
5400 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5401 (delete-char (- (match-end 0) (match-beginning 0)))))))
f83d2997
KH
5402
5403 ;; Lines with only hashes on them can be paragraph boundaries.
5404 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5405 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5406 (fill-prefix comment-fill-prefix))
5407 (fill-paragraph justify)))
5408 (if (and start)
5c8b7eaf 5409 (progn
f83d2997
KH
5410 (goto-char start)
5411 (if (> dc 0)
83261a2f 5412 (progn (delete-char dc) (insert spaces)))
f83d2997
KH
5413 (if (or (= (current-column) c) iteration) nil
5414 (setq comment-column c)
5415 (indent-for-comment)
5416 ;; Repeat once more, flagging as iteration
4ab89e7b
SM
5417 (cperl-fill-paragraph justify t))))))
5418 t)
f83d2997
KH
5419
5420(defun cperl-do-auto-fill ()
5421 ;; Break out if the line is short enough
5422 (if (> (save-excursion
5423 (end-of-line)
5424 (current-column))
5425 fill-column)
83261a2f
SM
5426 (let ((c (save-excursion (beginning-of-line)
5427 (cperl-to-comment-or-eol) (point)))
8038e2cf 5428 (s (memq (following-char) '(?\s ?\t))) marker)
82eb0dae
SM
5429 (if (>= c (point))
5430 ;; Don't break line inside code: only inside comment.
5431 nil
83261a2f 5432 (setq marker (point-marker))
82eb0dae 5433 (fill-paragraph nil)
83261a2f
SM
5434 (goto-char marker)
5435 ;; Is not enough, sometimes marker is a start of line
5436 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5437 (goto-char (match-end 0))))
5438 ;; Following space could have gone:
8038e2cf 5439 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
83261a2f
SM
5440 (insert " ")
5441 (backward-char 1))
5442 ;; Previous space could have gone:
8038e2cf 5443 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
f83d2997 5444
f83d2997
KH
5445(defun cperl-imenu-addback (lst &optional isback name)
5446 ;; We suppose that the lst is a DAG, unless the first element only
5447 ;; loops back, and ISBACK is set. Thus this function cannot be
5448 ;; applied twice without ISBACK set.
5449 (cond ((not cperl-imenu-addback) lst)
5450 (t
5c8b7eaf 5451 (or name
f83d2997 5452 (setq name "+++BACK+++"))
dba01120
GM
5453 (mapc (lambda (elt)
5454 (if (and (listp elt) (listp (cdr elt)))
5455 (progn
5456 ;; In the other order it goes up
5457 ;; one level only ;-(
5458 (setcdr elt (cons (cons name lst)
5459 (cdr elt)))
5460 (cperl-imenu-addback (cdr elt) t name))))
5461 (if isback (cdr lst) lst))
f83d2997
KH
5462 lst)))
5463
80585273 5464(defun cperl-imenu--create-perl-index (&optional regexp)
f83d2997 5465 (require 'imenu) ; May be called from TAGS creator
5c8b7eaf 5466 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
f83d2997
KH
5467 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5468 (index-meth-alist '()) meth
4ab89e7b
SM
5469 packages ends-ranges p marker is-proto
5470 (prev-pos 0) is-pack index index1 name (end-range 0) package)
f83d2997 5471 (goto-char (point-min))
6c389151 5472 (cperl-update-syntaxification (point-max) (point-max))
f83d2997
KH
5473 ;; Search for the function
5474 (progn ;;save-match-data
5475 (while (re-search-forward
80585273 5476 (or regexp cperl-imenu--function-name-regexp-perl)
f83d2997 5477 nil t)
4ab89e7b 5478 ;; 2=package-group, 5=package-name 8=sub-name
f83d2997
KH
5479 (cond
5480 ((and ; Skip some noise if building tags
4ab89e7b
SM
5481 (match-beginning 5) ; package name
5482 ;;(eq (char-after (match-beginning 2)) ?p) ; package
f83d2997 5483 (not (save-match-data
83261a2f 5484 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
f83d2997
KH
5485 nil)
5486 ((and
4ab89e7b
SM
5487 (or (match-beginning 2)
5488 (match-beginning 8)) ; package or sub
6c389151 5489 ;; Skip if quoted (will not skip multi-line ''-strings :-():
f83d2997
KH
5490 (null (get-text-property (match-beginning 1) 'syntax-table))
5491 (null (get-text-property (match-beginning 1) 'syntax-type))
5492 (null (get-text-property (match-beginning 1) 'in-pod)))
4ab89e7b 5493 (setq is-pack (match-beginning 2))
f83d2997
KH
5494 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5495 ;; (goto-char (match-end 0))) ; Messes what follows
4ab89e7b 5496 (setq meth nil
f83d2997
KH
5497 p (point))
5498 (while (and ends-ranges (>= p (car ends-ranges)))
5499 ;; delete obsolete entries
5500 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5501 (setq package (or (car packages) "")
5502 end-range (or (car ends-ranges) 0))
4ab89e7b
SM
5503 (if is-pack ; doing "package"
5504 (progn
5505 (if (match-beginning 5) ; named package
5506 (setq name (buffer-substring (match-beginning 5)
5507 (match-end 5))
5508 name (progn
5509 (set-text-properties 0 (length name) nil name)
5510 name)
5511 package (concat name "::")
5512 name (concat "package " name))
5513 ;; Support nameless packages
5514 (setq name "package;" package ""))
5515 (setq end-range
5516 (save-excursion
5517 (parse-partial-sexp (point) (point-max) -1) (point))
5518 ends-ranges (cons end-range ends-ranges)
5519 packages (cons package packages)))
5520 (setq is-proto
5521 (or (eq (following-char) ?\;)
5522 (eq 0 (get-text-property (point) 'attrib-group)))))
f83d2997 5523 ;; Skip this function name if it is a prototype declaration.
4ab89e7b
SM
5524 (if (and is-proto (not is-pack)) nil
5525 (or is-pack
5526 (setq name
5527 (buffer-substring (match-beginning 8) (match-end 8)))
5528 (set-text-properties 0 (length name) nil name))
5529 (setq marker (make-marker))
5530 (set-marker marker (match-end (if is-pack 2 8)))
5531 (cond (is-pack nil)
5532 ((string-match "[:']" name)
5533 (setq meth t))
5534 ((> p end-range) nil)
5535 (t
5536 (setq name (concat package name) meth t)))
6c389151 5537 (setq index (cons name marker))
4ab89e7b 5538 (if is-pack
f83d2997
KH
5539 (push index index-pack-alist)
5540 (push index index-alist))
5541 (if meth (push index index-meth-alist))
5542 (push index index-unsorted-alist)))
4ab89e7b
SM
5543 ((match-beginning 16) ; POD section
5544 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5545 marker (make-marker))
5546 (set-marker marker (match-beginning 17))
f83d2997 5547 (set-text-properties 0 (length name) nil name)
4ab89e7b
SM
5548 (setq name (concat (make-string
5549 (* 3 (- (char-after (match-beginning 16)) ?1))
5550 ?\ )
5551 name)
5552 index (cons name marker))
f83d2997
KH
5553 (setq index1 (cons (concat "=" name) (cdr index)))
5554 (push index index-pod-alist)
5555 (push index1 index-unsorted-alist)))))
5c8b7eaf 5556 (setq index-alist
f83d2997
KH
5557 (if (default-value 'imenu-sort-function)
5558 (sort index-alist (default-value 'imenu-sort-function))
83261a2f 5559 (nreverse index-alist)))
f83d2997
KH
5560 (and index-pod-alist
5561 (push (cons "+POD headers+..."
5562 (nreverse index-pod-alist))
5563 index-alist))
5564 (and (or index-pack-alist index-meth-alist)
5565 (let ((lst index-pack-alist) hier-list pack elt group name)
5566 ;; Remove "package ", reverse and uniquify.
5567 (while lst
5568 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5569 (if (assoc name hier-list) nil
5570 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5571 (setq lst index-meth-alist)
5572 (while lst
5573 (setq elt (car lst) lst (cdr lst))
5574 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5575 (setq pack (substring (car elt) 0 (match-beginning 0)))
5c8b7eaf 5576 (if (setq group (assoc pack hier-list))
f83d2997
KH
5577 (if (listp (cdr group))
5578 ;; Have some functions already
5c8b7eaf
SS
5579 (setcdr group
5580 (cons (cons (substring
f83d2997
KH
5581 (car elt)
5582 (+ 2 (match-beginning 0)))
5583 (cdr elt))
5584 (cdr group)))
5c8b7eaf 5585 (setcdr group (list (cons (substring
f83d2997
KH
5586 (car elt)
5587 (+ 2 (match-beginning 0)))
5588 (cdr elt)))))
5c8b7eaf
SS
5589 (setq hier-list
5590 (cons (cons pack
5591 (list (cons (substring
f83d2997
KH
5592 (car elt)
5593 (+ 2 (match-beginning 0)))
5594 (cdr elt))))
5595 hier-list))))))
5596 (push (cons "+Hierarchy+..."
5597 hier-list)
5598 index-alist)))
5599 (and index-pack-alist
5600 (push (cons "+Packages+..."
5601 (nreverse index-pack-alist))
5602 index-alist))
5c8b7eaf 5603 (and (or index-pack-alist index-pod-alist
f83d2997
KH
5604 (default-value 'imenu-sort-function))
5605 index-unsorted-alist
5606 (push (cons "+Unsorted List+..."
5607 (nreverse index-unsorted-alist))
5608 index-alist))
5609 (cperl-imenu-addback index-alist)))
5610
6c389151 5611\f
6c389151
SM
5612;; Suggested by Mark A. Hershberger
5613(defun cperl-outline-level ()
5614 (looking-at outline-regexp)
5615 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4ab89e7b
SM
5616;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5617 ((match-beginning 2) 0) ; package
5618 ((match-beginning 8) 1) ; sub
5619 ((match-beginning 16)
5620 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5621 (t 5))) ; should not happen
6c389151
SM
5622
5623\f
f83d2997
KH
5624(defun cperl-windowed-init ()
5625 "Initialization under windowed version."
f453f5a8 5626 (cond ((featurep 'ps-print)
82d9a08d
SM
5627 (or cperl-faces-init
5628 (progn
5629 (and (boundp 'font-lock-multiline)
5630 (setq cperl-font-lock-multiline t))
5631 (cperl-init-faces))))
f453f5a8
CY
5632 ((not cperl-faces-init)
5633 (add-hook 'font-lock-mode-hook
5634 (function
5635 (lambda ()
5636 (if (memq major-mode '(perl-mode cperl-mode))
5637 (progn
5638 (or cperl-faces-init (cperl-init-faces)))))))
5639 (if (fboundp 'eval-after-load)
5640 (eval-after-load
5641 "ps-print"
5642 '(or cperl-faces-init (cperl-init-faces)))))))
db133cb6 5643
5efe6a56 5644(defvar cperl-font-lock-keywords-1 nil
80585273 5645 "Additional expressions to highlight in Perl mode. Minimal set.")
5efe6a56 5646(defvar cperl-font-lock-keywords nil
80585273 5647 "Additional expressions to highlight in Perl mode. Default set.")
5efe6a56 5648(defvar cperl-font-lock-keywords-2 nil
80585273
DL
5649 "Additional expressions to highlight in Perl mode. Maximal set")
5650
db133cb6
RS
5651(defun cperl-load-font-lock-keywords ()
5652 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5653 cperl-font-lock-keywords)
db133cb6
RS
5654
5655(defun cperl-load-font-lock-keywords-1 ()
5656 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5657 cperl-font-lock-keywords-1)
db133cb6
RS
5658
5659(defun cperl-load-font-lock-keywords-2 ()
5660 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5661 cperl-font-lock-keywords-2)
f83d2997 5662
5bd52f0e
RS
5663(defun cperl-init-faces-weak ()
5664 ;; Allow `cperl-find-pods-heres' to run.
5665 (or (boundp 'font-lock-constant-face)
5666 (cperl-force-face font-lock-constant-face
4ab89e7b
SM
5667 "Face for constant and label names"))
5668 (or (boundp 'font-lock-warning-face)
5669 (cperl-force-face font-lock-warning-face
5670 "Face for things which should stand out"))
5671 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5672 )
5bd52f0e 5673
f83d2997 5674(defun cperl-init-faces ()
5bd52f0e 5675 (condition-case errs
f83d2997
KH
5676 (progn
5677 (require 'font-lock)
5678 (and (fboundp 'font-lock-fontify-anchored-keywords)
5679 (featurep 'font-lock-extra)
5680 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5681 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
f83d2997
KH
5682 (if (fboundp 'font-lock-fontify-anchored-keywords)
5683 (setq font-lock-anchored t))
5c8b7eaf 5684 (setq
f83d2997
KH
5685 t-font-lock-keywords
5686 (list
1f5c1626 5687 `("[ \t]+$" 0 ',cperl-invalid-face t)
f83d2997
KH
5688 (cons
5689 (concat
5690 "\\(^\\|[^$@%&\\]\\)\\<\\("
5691 (mapconcat
5692 'identity
5693 '("if" "until" "while" "elsif" "else" "unless" "for"
5694 "foreach" "continue" "exit" "die" "last" "goto" "next"
4ab89e7b 5695 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
6c389151 5696 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
f83d2997
KH
5697 "\\|") ; Flow control
5698 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5699 ; In what follows we use `type' style
5700 ; for overwritable builtins
5701 (list
5702 (concat
5703 "\\(^\\|[^$@%&\\]\\)\\<\\("
5704 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5705 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5706 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5707 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5708 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5709 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5710 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5711 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5712 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5713 ;; "gethostbyname" "gethostent" "getlogin"
5714 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5715 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5716 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5717 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5718 ;; "getservbyport" "getservent" "getsockname"
5719 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5720 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5bd52f0e 5721 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
f83d2997
KH
5722 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5723 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5724 ;; "quotemeta" "rand" "read" "readdir" "readline"
5725 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5726 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5727 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5728 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5729 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5730 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5731 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5732 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
6c389151 5733 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
f83d2997
KH
5734 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5735 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5736 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5c8b7eaf 5737 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
f83d2997
KH
5738 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5739 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5740 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5741 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5742 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5743 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5744 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5745 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5746 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5747 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5748 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5749 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5750 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5751 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5752 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5bd52f0e 5753 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
f83d2997
KH
5754 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5755 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5756 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5757 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5758 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5759 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5760 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5761 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
6c389151 5762 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
f83d2997
KH
5763 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5764 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5765 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5766 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5767 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5768 "\\)\\>") 2 'font-lock-type-face)
5769 ;; In what follows we use `other' style
5770 ;; for nonoverwritable builtins
5771 ;; Somehow 's', 'm' are not auto-generated???
5772 (list
5773 (concat
5774 "\\(^\\|[^$@%&\\]\\)\\<\\("
6c389151 5775 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
f83d2997
KH
5776 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5777 ;; "eval" "exists" "for" "foreach" "format" "goto"
5778 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4ab89e7b 5779 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
f83d2997
KH
5780 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5781 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5782 ;; "undef" "unless" "unshift" "untie" "until" "use"
5783 ;; "while" "y"
6c389151 5784 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
f83d2997 5785 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
6c389151
SM
5786 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5787 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
f83d2997 5788 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5bd52f0e 5789 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
f83d2997
KH
5790 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5791 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5792 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5793 "\\|[sm]" ; Added manually
4ab89e7b 5794 "\\)\\>") 2 'cperl-nonoverridable-face)
f83d2997
KH
5795 ;; (mapconcat 'identity
5796 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5797 ;; "#include" "#define" "#undef")
5798 ;; "\\|")
5799 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5800 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4ab89e7b
SM
5801 ;; This highlights declarations and definitions differenty.
5802 ;; We do not try to highlight in the case of attributes:
5803 ;; it is already done by `cperl-find-pods-heres'
5804 (list (concat "\\<sub"
5805 cperl-white-and-comment-rex ; whitespace/comments
5806 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5807 "\\("
5808 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5809 "([^()]*)\\)?" ; prototype
5810 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5811 "[{;]")
5812 2 (if cperl-font-lock-multiline
5813 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5814 'font-lock-function-name-face
5815 'font-lock-variable-name-face)
5816 ;; need to manually set 'multiline' for older font-locks
5817 '(progn
5818 (if (< 1 (count-lines (match-beginning 0)
5819 (match-end 0)))
5820 (put-text-property
5821 (+ 3 (match-beginning 0)) (match-end 0)
5822 'syntax-type 'multiline))
5823 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5824 'font-lock-function-name-face
5825 'font-lock-variable-name-face))))
f83d2997
KH
5826 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5827 2 font-lock-function-name-face)
5828 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5829 1 font-lock-function-name-face)
5830 (cond ((featurep 'font-lock-extra)
5c8b7eaf 5831 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
f83d2997
KH
5832 (2 font-lock-string-face t)
5833 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5834 (font-lock-anchored
5835 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5836 (2 font-lock-string-face t)
5837 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5838 nil nil
5839 (1 font-lock-string-face t))))
5840 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5841 2 font-lock-string-face t)))
db133cb6 5842 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
f83d2997 5843 font-lock-string-face t)
5c8b7eaf 5844 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
83261a2f 5845 font-lock-constant-face) ; labels
f83d2997 5846 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
883212ce 5847 2 font-lock-constant-face)
6c389151
SM
5848 ;; Uncomment to get perl-mode-like vars
5849 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5850 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5851 ;;; (2 (cons font-lock-variable-name-face '(underline))))
f83d2997 5852 (cond ((featurep 'font-lock-extra)
6c389151 5853 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
f83d2997
KH
5854 (3 font-lock-variable-name-face)
5855 (4 '(another 4 nil
5856 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5857 (1 font-lock-variable-name-face)
5c8b7eaf 5858 (2 '(restart 2 nil) nil t)))
f83d2997
KH
5859 nil t))) ; local variables, multiple
5860 (font-lock-anchored
4ab89e7b 5861 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
9edd6ee6 5862 `(,(concat "\\<\\(my\\|local\\|our\\)"
4ab89e7b
SM
5863 cperl-maybe-white-and-comment-rex
5864 "\\(("
5865 cperl-maybe-white-and-comment-rex
9edd6ee6
SM
5866 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5867 (5 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5868 'font-lock-variable-name-face
5869 '(progn (setq cperl-font-lock-multiline-start
5870 (match-beginning 0))
9edd6ee6
SM
5871 'font-lock-variable-name-face)))
5872 (,(concat "\\="
4ab89e7b
SM
5873 cperl-maybe-white-and-comment-rex
5874 ","
5875 cperl-maybe-white-and-comment-rex
9edd6ee6 5876 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
cb5bf6ba 5877 ;; Bug in font-lock: limit is used not only to limit
4ab89e7b
SM
5878 ;; searches, but to set the "extend window for
5879 ;; facification" property. Thus we need to minimize.
9edd6ee6 5880 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5881 '(if (match-beginning 3)
5882 (save-excursion
5883 (goto-char (match-beginning 3))
5884 (condition-case nil
5885 (forward-sexp 1)
5886 (error
5887 (condition-case nil
5888 (forward-char 200)
5889 (error nil)))) ; typeahead
5890 (1- (point))) ; report limit
5891 (forward-char -2)) ; disable continued expr
5892 '(if (match-beginning 3)
5893 (point-max) ; No limit for continuation
9edd6ee6
SM
5894 (forward-char -2))) ; disable continued expr
5895 ,(if cperl-font-lock-multiline
4ab89e7b
SM
5896 nil
5897 '(progn ; Do at end
5898 ;; "my" may be already fontified (POD),
5899 ;; so cperl-font-lock-multiline-start is nil
5900 (if (or (not cperl-font-lock-multiline-start)
5901 (> 2 (count-lines
5902 cperl-font-lock-multiline-start
5903 (point))))
5904 nil
5905 (put-text-property
5906 (1+ cperl-font-lock-multiline-start) (point)
5907 'syntax-type 'multiline))
9edd6ee6
SM
5908 (setq cperl-font-lock-multiline-start nil)))
5909 (3 font-lock-variable-name-face))))
4ab89e7b 5910 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
f83d2997 5911 3 font-lock-variable-name-face)))
6c389151 5912 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
eb6121fc 5913 4 font-lock-variable-name-face)
9ed9fd35
DP
5914 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
5915 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
eb6121fc 5916 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
a1506d29 5917 (setq
f83d2997
KH
5918 t-font-lock-keywords-1
5919 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4ab89e7b
SM
5920 ;; not yet as of XEmacs 19.12, works with 21.1.11
5921 (or
6546555e 5922 (not (featurep 'xemacs))
4ab89e7b
SM
5923 (string< "21.1.9" emacs-version)
5924 (and (string< "21.1.10" emacs-version)
5925 (string< emacs-version "21.1.2")))
f83d2997
KH
5926 '(
5927 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5928 (if (eq (char-after (match-beginning 2)) ?%)
4ab89e7b
SM
5929 'cperl-hash-face
5930 'cperl-array-face)
f83d2997
KH
5931 t) ; arrays and hashes
5932 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5933 1
5c8b7eaf 5934 (if (= (- (match-end 2) (match-beginning 2)) 1)
f83d2997 5935 (if (eq (char-after (match-beginning 3)) ?{)
4ab89e7b
SM
5936 'cperl-hash-face
5937 'cperl-array-face) ; arrays and hashes
f83d2997
KH
5938 font-lock-variable-name-face) ; Just to put something
5939 t)
4ab89e7b
SM
5940 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5941 (1 cperl-array-face)
5942 (2 font-lock-variable-name-face))
5943 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5944 (1 cperl-hash-face)
5945 (2 font-lock-variable-name-face))
f83d2997
KH
5946 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5947 ;;; Too much noise from \s* @s[ and friends
5c8b7eaf 5948 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
f83d2997
KH
5949 ;;(3 font-lock-function-name-face t t)
5950 ;;(4
5951 ;; (if (cperl-slash-is-regexp)
5952 ;; font-lock-function-name-face 'default) nil t))
5953 )))
6c389151
SM
5954 (if cperl-highlight-variables-indiscriminately
5955 (setq t-font-lock-keywords-1
5956 (append t-font-lock-keywords-1
4ab89e7b 5957 (list '("\\([$*]{?\\sw+\\)" 1
6c389151 5958 font-lock-variable-name-face)))))
a1506d29 5959 (setq cperl-font-lock-keywords-1
5bd52f0e
RS
5960 (if cperl-syntaxify-by-font-lock
5961 (cons 'cperl-fontify-update
5962 t-font-lock-keywords)
5963 t-font-lock-keywords)
5efe6a56
SM
5964 cperl-font-lock-keywords cperl-font-lock-keywords-1
5965 cperl-font-lock-keywords-2 (append
6c389151
SM
5966 cperl-font-lock-keywords-1
5967 t-font-lock-keywords-1)))
f83d2997
KH
5968 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5969 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
db133cb6 5970 (eval ; Avoid a warning
83261a2f
SM
5971 '(font-lock-require-faces
5972 (list
5973 ;; Color-light Color-dark Gray-light Gray-dark Mono
5974 (list 'font-lock-comment-face
5975 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5976 nil
5977 [nil nil t t t]
5978 [nil nil t t t]
5979 nil)
5980 (list 'font-lock-string-face
5981 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5982 nil
5983 nil
5984 [nil nil t t t]
5985 nil)
5986 (list 'font-lock-function-name-face
5987 (vector
5988 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5989 (cdr (assq 'background-color ; if mono
5990 (frame-parameters))))
5991 (vector
5992 nil nil nil nil
5993 (cdr (assq 'foreground-color ; if mono
5994 (frame-parameters))))
5995 [nil nil t t t]
5996 nil
5997 nil)
5998 (list 'font-lock-variable-name-face
5999 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6000 nil
6001 [nil nil t t t]
6002 [nil nil t t t]
6003 nil)
6004 (list 'font-lock-type-face
6005 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6006 nil
6007 [nil nil t t t]
6008 nil
6009 [nil nil t t t])
4ab89e7b
SM
6010 (list 'font-lock-warning-face
6011 ["Pink" "Red" "Gray50" "LightGray"]
6012 ["gray20" "gray90"
6013 "gray80" "gray20"]
6014 [nil nil t t t]
6015 nil
6016 [nil nil t t t]
6017 )
83261a2f
SM
6018 (list 'font-lock-constant-face
6019 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6020 nil
6021 [nil nil t t t]
6022 nil
6023 [nil nil t t t])
4ab89e7b 6024 (list 'cperl-nonoverridable-face
83261a2f
SM
6025 ["chartreuse3" ("orchid1" "orange")
6026 nil "Gray80"]
6027 [nil nil "gray90"]
6028 [nil nil nil t t]
6029 [nil nil t t]
6030 [nil nil t t t])
4ab89e7b 6031 (list 'cperl-array-face
83261a2f
SM
6032 ["blue" "yellow" nil "Gray80"]
6033 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6034 "gray90"]
6035 t
6036 nil
6037 nil)
4ab89e7b 6038 (list 'cperl-hash-face
83261a2f
SM
6039 ["red" "red" nil "Gray80"]
6040 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6041 "gray90"]
6042 t
6043 t
6044 nil))))
5bd52f0e 6045 ;; Do it the dull way, without choose-color
f83d2997
KH
6046 (defvar cperl-guessed-background nil
6047 "Display characteristics as guessed by cperl.")
83261a2f 6048 ;; (or (fboundp 'x-color-defined-p)
15ca5699 6049 ;; (defalias 'x-color-defined-p
83261a2f
SM
6050 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6051 ;; ;; XEmacs >= 19.12
6052 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6053 ;; ;; XEmacs 19.11
6054 ;; (t 'x-valid-color-name-p))))
5c8b7eaf 6055 (cperl-force-face font-lock-constant-face
5bd52f0e
RS
6056 "Face for constant and label names")
6057 (cperl-force-face font-lock-variable-name-face
6058 "Face for variable names")
6059 (cperl-force-face font-lock-type-face
6060 "Face for data types")
4ab89e7b 6061 (cperl-force-face cperl-nonoverridable-face
5bd52f0e 6062 "Face for data types from another group")
4ab89e7b
SM
6063 (cperl-force-face font-lock-warning-face
6064 "Face for things which should stand out")
5bd52f0e
RS
6065 (cperl-force-face font-lock-comment-face
6066 "Face for comments")
6067 (cperl-force-face font-lock-function-name-face
6068 "Face for function names")
4ab89e7b 6069 (cperl-force-face cperl-hash-face
5bd52f0e 6070 "Face for hashes")
4ab89e7b 6071 (cperl-force-face cperl-array-face
5bd52f0e
RS
6072 "Face for arrays")
6073 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6074 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6075 ;;(or (boundp 'font-lock-type-face)
6076 ;; (defconst font-lock-type-face
6077 ;; 'font-lock-type-face
6078 ;; "Face to use for data types."))
6079 ;;(or (boundp 'cperl-nonoverridable-face)
6080 ;; (defconst cperl-nonoverridable-face
4ab89e7b 6081 ;; 'cperl-nonoverridable-face
5bd52f0e 6082 ;; "Face to use for data types from another group."))
6546555e 6083 ;;(if (not (featurep 'xemacs)) nil
5bd52f0e
RS
6084 ;; (or (boundp 'font-lock-comment-face)
6085 ;; (defconst font-lock-comment-face
6086 ;; 'font-lock-comment-face
6087 ;; "Face to use for comments."))
6088 ;; (or (boundp 'font-lock-keyword-face)
6089 ;; (defconst font-lock-keyword-face
6090 ;; 'font-lock-keyword-face
6091 ;; "Face to use for keywords."))
6092 ;; (or (boundp 'font-lock-function-name-face)
6093 ;; (defconst font-lock-function-name-face
6094 ;; 'font-lock-function-name-face
6095 ;; "Face to use for function names.")))
6096 (if (and
4ab89e7b 6097 (not (cperl-is-face 'cperl-array-face))
5c8b7eaf 6098 (cperl-is-face 'font-lock-emphasized-face))
4ab89e7b 6099 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
5bd52f0e 6100 (if (and
4ab89e7b 6101 (not (cperl-is-face 'cperl-hash-face))
5c8b7eaf 6102 (cperl-is-face 'font-lock-other-emphasized-face))
4ab89e7b 6103 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
5bd52f0e 6104 (if (and
4ab89e7b 6105 (not (cperl-is-face 'cperl-nonoverridable-face))
5c8b7eaf 6106 (cperl-is-face 'font-lock-other-type-face))
4ab89e7b 6107 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
5bd52f0e
RS
6108 ;;(or (boundp 'cperl-hash-face)
6109 ;; (defconst cperl-hash-face
4ab89e7b 6110 ;; 'cperl-hash-face
5bd52f0e
RS
6111 ;; "Face to use for hashes."))
6112 ;;(or (boundp 'cperl-array-face)
6113 ;; (defconst cperl-array-face
4ab89e7b 6114 ;; 'cperl-array-face
5bd52f0e 6115 ;; "Face to use for arrays."))
f83d2997
KH
6116 ;; Here we try to guess background
6117 (let ((background
6118 (if (boundp 'font-lock-background-mode)
6119 font-lock-background-mode
5c8b7eaf 6120 'light))
83261a2f 6121 (face-list (and (fboundp 'face-list) (face-list))))
5bd52f0e
RS
6122;;;; (fset 'cperl-is-face
6123;;;; (cond ((fboundp 'find-face)
6124;;;; (symbol-function 'find-face))
6125;;;; (face-list
6126;;;; (function (lambda (face) (member face face-list))))
6127;;;; (t
6128;;;; (function (lambda (face) (boundp face))))))
f83d2997
KH
6129 (defvar cperl-guessed-background
6130 (if (and (boundp 'font-lock-display-type)
6131 (eq font-lock-display-type 'grayscale))
6132 'gray
6133 background)
6134 "Background as guessed by CPerl mode")
83261a2f
SM
6135 (and (not (cperl-is-face 'font-lock-constant-face))
6136 (cperl-is-face 'font-lock-reference-face)
6137 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
db133cb6 6138 (if (cperl-is-face 'font-lock-type-face) nil
f83d2997
KH
6139 (copy-face 'default 'font-lock-type-face)
6140 (cond
6141 ((eq background 'light)
6142 (set-face-foreground 'font-lock-type-face
6143 (if (x-color-defined-p "seagreen")
6144 "seagreen"
6145 "sea green")))
6146 ((eq background 'dark)
6147 (set-face-foreground 'font-lock-type-face
6148 (if (x-color-defined-p "os2pink")
6149 "os2pink"
6150 "pink")))
6151 (t
6152 (set-face-background 'font-lock-type-face "gray90"))))
4ab89e7b 6153 (if (cperl-is-face 'cperl-nonoverridable-face)
f83d2997 6154 nil
4ab89e7b 6155 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
f83d2997
KH
6156 (cond
6157 ((eq background 'light)
4ab89e7b 6158 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6159 (if (x-color-defined-p "chartreuse3")
6160 "chartreuse3"
6161 "chartreuse")))
6162 ((eq background 'dark)
4ab89e7b 6163 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6164 (if (x-color-defined-p "orchid1")
6165 "orchid1"
6166 "orange")))))
5bd52f0e
RS
6167;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6168;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6169;;; (cond
6170;;; ((eq background 'light)
6171;;; (set-face-background 'font-lock-other-emphasized-face
6172;;; (if (x-color-defined-p "lightyellow2")
6173;;; "lightyellow2"
6174;;; (if (x-color-defined-p "lightyellow")
6175;;; "lightyellow"
6176;;; "light yellow"))))
6177;;; ((eq background 'dark)
6178;;; (set-face-background 'font-lock-other-emphasized-face
6179;;; (if (x-color-defined-p "navy")
6180;;; "navy"
6181;;; (if (x-color-defined-p "darkgreen")
6182;;; "darkgreen"
6183;;; "dark green"))))
6184;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6185;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6186;;; (copy-face 'bold 'font-lock-emphasized-face)
6187;;; (cond
6188;;; ((eq background 'light)
6189;;; (set-face-background 'font-lock-emphasized-face
6190;;; (if (x-color-defined-p "lightyellow2")
6191;;; "lightyellow2"
6192;;; "lightyellow")))
6193;;; ((eq background 'dark)
6194;;; (set-face-background 'font-lock-emphasized-face
6195;;; (if (x-color-defined-p "navy")
6196;;; "navy"
6197;;; (if (x-color-defined-p "darkgreen")
6198;;; "darkgreen"
6199;;; "dark green"))))
6200;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
db133cb6 6201 (if (cperl-is-face 'font-lock-variable-name-face) nil
f83d2997 6202 (copy-face 'italic 'font-lock-variable-name-face))
db133cb6 6203 (if (cperl-is-face 'font-lock-constant-face) nil
883212ce 6204 (copy-face 'italic 'font-lock-constant-face))))
f83d2997 6205 (setq cperl-faces-init t))
5bd52f0e 6206 (error (message "cperl-init-faces (ignored): %s" errs))))
f83d2997
KH
6207
6208
6209(defun cperl-ps-print-init ()
6210 "Initialization of `ps-print' components for faces used in CPerl."
5bd52f0e
RS
6211 (eval-after-load "ps-print"
6212 '(setq ps-bold-faces
5c8b7eaf 6213 ;; font-lock-variable-name-face
5bd52f0e 6214 ;; font-lock-constant-face
4ab89e7b 6215 (append '(cperl-array-face cperl-hash-face)
5bd52f0e
RS
6216 ps-bold-faces)
6217 ps-italic-faces
6218 ;; font-lock-constant-face
4ab89e7b 6219 (append '(cperl-nonoverridable-face cperl-hash-face)
5bd52f0e
RS
6220 ps-italic-faces)
6221 ps-underlined-faces
6222 ;; font-lock-type-face
4ab89e7b 6223 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
5bd52f0e
RS
6224 ps-underlined-faces))))
6225
6226(defvar ps-print-face-extension-alist)
6227
6228(defun cperl-ps-print (&optional file)
6229 "Pretty-print in CPerl style.
6230If optional argument FILE is an empty string, prints to printer, otherwise
6231to the file FILE. If FILE is nil, prompts for a file name.
6232
6233Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6234 (interactive)
5c8b7eaf
SS
6235 (or file
6236 (setq file (read-from-minibuffer
5bd52f0e
RS
6237 "Print to file (if empty - to printer): "
6238 (concat (buffer-file-name) ".ps")
6239 nil nil 'file-name-history)))
6240 (or (> (length file) 0)
6241 (setq file nil))
6242 (require 'ps-print) ; To get ps-print-face-extension-alist
6243 (let ((ps-print-color-p t)
6244 (ps-print-face-extension-alist ps-print-face-extension-alist))
6245 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6246 (ps-print-buffer-with-faces file)))
6247
6248;;; (defun cperl-ps-print-init ()
6249;;; "Initialization of `ps-print' components for faces used in CPerl."
6250;;; ;; Guard against old versions
6251;;; (defvar ps-underlined-faces nil)
6252;;; (defvar ps-bold-faces nil)
6253;;; (defvar ps-italic-faces nil)
6254;;; (setq ps-bold-faces
6255;;; (append '(font-lock-emphasized-face
4ab89e7b 6256;;; cperl-array-face
5c8b7eaf
SS
6257;;; font-lock-keyword-face
6258;;; font-lock-variable-name-face
6259;;; font-lock-constant-face
6260;;; font-lock-reference-face
5bd52f0e 6261;;; font-lock-other-emphasized-face
4ab89e7b 6262;;; cperl-hash-face)
5bd52f0e
RS
6263;;; ps-bold-faces))
6264;;; (setq ps-italic-faces
4ab89e7b 6265;;; (append '(cperl-nonoverridable-face
5c8b7eaf
SS
6266;;; font-lock-constant-face
6267;;; font-lock-reference-face
5bd52f0e 6268;;; font-lock-other-emphasized-face
4ab89e7b 6269;;; cperl-hash-face)
5bd52f0e
RS
6270;;; ps-italic-faces))
6271;;; (setq ps-underlined-faces
6272;;; (append '(font-lock-emphasized-face
4ab89e7b 6273;;; cperl-array-face
5bd52f0e 6274;;; font-lock-other-emphasized-face
4ab89e7b
SM
6275;;; cperl-hash-face
6276;;; cperl-nonoverridable-face font-lock-type-face)
5bd52f0e
RS
6277;;; ps-underlined-faces))
6278;;; (cons 'font-lock-type-face ps-underlined-faces))
f83d2997
KH
6279
6280
6281(if (cperl-enable-font-lock) (cperl-windowed-init))
6282
db133cb6 6283(defconst cperl-styles-entries
5c8b7eaf
SS
6284 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6285 cperl-label-offset cperl-extra-newline-before-brace
4ab89e7b 6286 cperl-extra-newline-before-brace-multiline
bab27c0c 6287 cperl-merge-trailing-else
db133cb6
RS
6288 cperl-continued-statement-offset))
6289
4ab89e7b
SM
6290(defconst cperl-style-examples
6291"##### Numbers etc are: cperl-indent-level cperl-brace-offset
6292##### cperl-continued-brace-offset cperl-label-offset
6293##### cperl-continued-statement-offset
6294##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6295
6296########### (Do not forget cperl-extra-newline-before-brace-multiline)
6297
6298### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6299if (foo) {
6300 bar
6301 baz;
6302 label:
6303 {
6304 boon;
6305 }
6306} else {
6307 stop;
6308}
6309
6310### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6311if (foo) {
6312 bar
6313 baz;
6314 label:
6315 {
6316 boon;
6317 }
6318} else {
6319 stop;
6320}
6321
6322### GNU 2/0/0/-2/2/nil/t
6323if (foo)
6324 {
6325 bar
6326 baz;
6327 label:
6328 {
6329 boon;
6330 }
6331 }
6332else
6333 {
6334 stop;
6335 }
6336
6337### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6338if (foo)
6339{
6340 bar
6341 baz;
6342 label:
6343 {
6344 boon;
6345 }
6346}
6347else
6348{
6349 stop;
6350}
6351
6352### BSD (=C++, but will not change preexisting merge-trailing-else
6353### and extra-newline-before-brace ) 4/0/-4/-4/4
6354if (foo)
6355{
6356 bar
6357 baz;
6358 label:
6359 {
6360 boon;
6361 }
6362}
6363else
6364{
6365 stop;
6366}
6367
6368### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6369### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6370if (foo)
6371{
6372 bar
6373 baz;
6374 label:
6375 {
6376 boon;
6377 }
6378}
6379else
6380{
6381 stop;
6382}
6383
6384### Whitesmith (=PerlStyle, but will not change preexisting
6385### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6386if (foo)
6387 {
6388 bar
6389 baz;
6390 label:
6391 {
6392 boon;
6393 }
6394 }
6395else
6396 {
6397 stop;
6398 }
6399"
6400"Examples of if/else with different indent styles (with v4.23).")
6401
db133cb6 6402(defconst cperl-style-alist
4ab89e7b 6403 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
db133cb6
RS
6404 (cperl-indent-level . 2)
6405 (cperl-brace-offset . 0)
6406 (cperl-continued-brace-offset . 0)
6407 (cperl-label-offset . -2)
4ab89e7b 6408 (cperl-continued-statement-offset . 2)
db133cb6 6409 (cperl-extra-newline-before-brace . nil)
4ab89e7b
SM
6410 (cperl-extra-newline-before-brace-multiline . nil)
6411 (cperl-merge-trailing-else . t))
6412
83261a2f 6413 ("PerlStyle" ; CPerl with 4 as indent
db133cb6
RS
6414 (cperl-indent-level . 4)
6415 (cperl-brace-offset . 0)
6416 (cperl-continued-brace-offset . 0)
6417 (cperl-label-offset . -4)
4ab89e7b 6418 (cperl-continued-statement-offset . 4)
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
db133cb6
RS
6423 ("GNU"
6424 (cperl-indent-level . 2)
6425 (cperl-brace-offset . 0)
6426 (cperl-continued-brace-offset . 0)
6427 (cperl-label-offset . -2)
4ab89e7b 6428 (cperl-continued-statement-offset . 2)
db133cb6 6429 (cperl-extra-newline-before-brace . t)
4ab89e7b
SM
6430 (cperl-extra-newline-before-brace-multiline . t)
6431 (cperl-merge-trailing-else . nil))
6432
db133cb6
RS
6433 ("K&R"
6434 (cperl-indent-level . 5)
6435 (cperl-brace-offset . 0)
6436 (cperl-continued-brace-offset . -5)
6437 (cperl-label-offset . -5)
4ab89e7b 6438 (cperl-continued-statement-offset . 5)
db133cb6 6439 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6440 ;;(cperl-extra-newline-before-brace-multiline . nil)
6441 (cperl-merge-trailing-else . nil))
6442
db133cb6
RS
6443 ("BSD"
6444 (cperl-indent-level . 4)
6445 (cperl-brace-offset . 0)
6446 (cperl-continued-brace-offset . -4)
6447 (cperl-label-offset . -4)
4ab89e7b 6448 (cperl-continued-statement-offset . 4)
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 )
6453
db133cb6
RS
6454 ("C++"
6455 (cperl-indent-level . 4)
6456 (cperl-brace-offset . 0)
6457 (cperl-continued-brace-offset . -4)
6458 (cperl-label-offset . -4)
6459 (cperl-continued-statement-offset . 4)
4ab89e7b
SM
6460 (cperl-extra-newline-before-brace . t)
6461 (cperl-extra-newline-before-brace-multiline . t)
6462 (cperl-merge-trailing-else . nil))
6463
db133cb6
RS
6464 ("Whitesmith"
6465 (cperl-indent-level . 4)
6466 (cperl-brace-offset . 0)
6467 (cperl-continued-brace-offset . 0)
6468 (cperl-label-offset . -4)
4ab89e7b 6469 (cperl-continued-statement-offset . 4)
db133cb6 6470 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6471 ;;(cperl-extra-newline-before-brace-multiline . nil)
6472 ;;(cperl-merge-trailing-else . nil) ; ???
6473 )
6474 ("Current"))
6475 "List of variables to set to get a particular indentation style.
6476Should be used via `cperl-set-style' or via Perl menu.
6477
6478See examples in `cperl-style-examples'.")
db133cb6 6479
f83d2997 6480(defun cperl-set-style (style)
f94a632a 6481 "Set CPerl mode variables to use one of several different indentation styles.
f83d2997 6482The arguments are a string representing the desired style.
5c8b7eaf 6483The list of styles is in `cperl-style-alist', available styles
4ab89e7b 6484are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
db133cb6
RS
6485
6486The current value of style is memorized (unless there is a memorized
6487data already), may be restored by `cperl-set-style-back'.
6488
6489Chosing \"Current\" style will not change style, so this may be used for
4ab89e7b 6490side-effect of memorizing only. Examples in `cperl-style-examples'."
5c8b7eaf 6491 (interactive
15ca5699 6492 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
db133cb6 6493 cperl-style-alist)))
f83d2997 6494 (list (completing-read "Enter style: " list nil 'insist))))
db133cb6
RS
6495 (or cperl-old-style
6496 (setq cperl-old-style
6497 (mapcar (function
6498 (lambda (name)
6499 (cons name (eval name))))
6500 cperl-styles-entries)))
6501 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
f83d2997
KH
6502 (while style
6503 (setq setting (car style) style (cdr style))
db133cb6
RS
6504 (set (car setting) (cdr setting)))))
6505
6506(defun cperl-set-style-back ()
810fb442 6507 "Restore a style memorized by `cperl-set-style'."
db133cb6
RS
6508 (interactive)
6509 (or cperl-old-style (error "The style was not changed"))
6510 (let (setting)
6511 (while cperl-old-style
5c8b7eaf 6512 (setq setting (car cperl-old-style)
db133cb6
RS
6513 cperl-old-style (cdr cperl-old-style))
6514 (set (car setting) (cdr setting)))))
f83d2997
KH
6515
6516(defun cperl-check-syntax ()
6517 (interactive)
6518 (require 'mode-compile)
db133cb6
RS
6519 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6520 (eval '(mode-compile)))) ; Avoid a warning
f83d2997
KH
6521
6522(defun cperl-info-buffer (type)
6523 ;; Returns buffer with documentation. Creates if missing.
6524 ;; If TYPE, this vars buffer.
6525 ;; Special care is taken to not stomp over an existing info buffer
6526 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6527 (info (get-buffer bname))
6528 (oldbuf (get-buffer "*info*")))
6529 (if info info
6530 (save-window-excursion
6531 ;; Get Info running
6532 (require 'info)
6533 (cond (oldbuf
6534 (set-buffer oldbuf)
6535 (rename-buffer "*info-perl-tmp*")))
6536 (save-window-excursion
6537 (info))
6538 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6539 (set-buffer "*info*")
6540 (rename-buffer bname)
6541 (cond (oldbuf
6542 (set-buffer "*info-perl-tmp*")
6543 (rename-buffer "*info*")
6544 (set-buffer bname)))
029cb4d5 6545 (make-local-variable 'window-min-height)
f83d2997
KH
6546 (setq window-min-height 2)
6547 (current-buffer)))))
6548
6549(defun cperl-word-at-point (&optional p)
f94a632a 6550 "Return the word at point or at P."
f83d2997
KH
6551 (save-excursion
6552 (if p (goto-char p))
6553 (or (cperl-word-at-point-hard)
6554 (progn
6555 (require 'etags)
6556 (funcall (or (and (boundp 'find-tag-default-function)
6557 find-tag-default-function)
6558 (get major-mode 'find-tag-default-function)
6559 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6560 ;; automatically used within `find-tag-default':
6561 'find-tag-default))))))
6562
6563(defun cperl-info-on-command (command)
f94a632a 6564 "Show documentation for Perl command COMMAND in other window.
f83d2997
KH
6565If perl-info buffer is shown in some frame, uses this frame.
6566Customized by setting variables `cperl-shrink-wrap-info-frame',
6567`cperl-max-help-size'."
5c8b7eaf 6568 (interactive
f83d2997 6569 (let* ((default (cperl-word-at-point))
5c8b7eaf 6570 (read (read-string
83261a2f
SM
6571 (format "Find doc for Perl function (default %s): "
6572 default))))
5c8b7eaf 6573 (list (if (equal read "")
83261a2f
SM
6574 default
6575 read))))
f83d2997
KH
6576
6577 (let ((buffer (current-buffer))
6578 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6579 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6580 max-height char-height buf-list)
6581 (if (string-match "^-[a-zA-Z]$" command)
6582 (setq cmd-desc "^-X[ \t\n]"))
6583 (setq isvar (string-match "^[$@%]" command)
6584 buf (cperl-info-buffer isvar)
6585 iniwin (selected-window)
6586 fr1 (window-frame iniwin))
6587 (set-buffer buf)
fc49c9c6 6588 (goto-char (point-min))
5c8b7eaf 6589 (or isvar
f83d2997
KH
6590 (progn (re-search-forward "^-X[ \t\n]")
6591 (forward-line -1)))
6592 (if (re-search-forward cmd-desc nil t)
6593 (progn
6594 ;; Go back to beginning of the group (ex, for qq)
6595 (if (re-search-backward "^[ \t\n\f]")
6596 (forward-line 1))
6597 (beginning-of-line)
5c8b7eaf 6598 ;; Get some of
f83d2997
KH
6599 (setq pos (point)
6600 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6601 (while (and (not win) buf-list)
6602 (setq win (get-buffer-window (car buf-list) t))
6603 (setq buf-list (cdr buf-list)))
6604 (or (not win)
6605 (eq (window-buffer win) buf)
6606 (set-window-buffer win buf))
6607 (and win (setq fr2 (window-frame win)))
6608 (if (or (not fr2) (eq fr1 fr2))
6609 (pop-to-buffer buf)
6610 (special-display-popup-frame buf) ; Make it visible
6611 (select-window win))
6612 (goto-char pos) ; Needed (?!).
6613 ;; Resize
6614 (setq iniheight (window-height)
6615 frheight (frame-height)
6616 not-loner (< iniheight (1- frheight))) ; Are not alone
5c8b7eaf 6617 (cond ((if not-loner cperl-max-help-size
f83d2997 6618 cperl-shrink-wrap-info-frame)
5c8b7eaf
SS
6619 (setq height
6620 (+ 2
6621 (count-lines
6622 pos
f83d2997
KH
6623 (save-excursion
6624 (if (re-search-forward
6625 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6626 (match-beginning 0) (point-max)))))
5c8b7eaf 6627 max-height
f83d2997
KH
6628 (if not-loner
6629 (/ (* (- frheight 3) cperl-max-help-size) 100)
6630 (setq char-height (frame-char-height))
6631 ;; Non-functioning under OS/2:
6632 (if (eq char-height 1) (setq char-height 18))
6633 ;; Title, menubar, + 2 for slack
d431decb 6634 (- (/ (display-pixel-height) char-height) 4)))
f83d2997
KH
6635 (if (> height max-height) (setq height max-height))
6636 ;;(message "was %s doing %s" iniheight height)
6637 (if not-loner
6638 (enlarge-window (- height iniheight))
6639 (set-frame-height (window-frame win) (1+ height)))))
6640 (set-window-start (selected-window) pos))
6641 (message "No entry for %s found." command))
6642 ;;(pop-to-buffer buffer)
6643 (select-window iniwin)))
6644
6645(defun cperl-info-on-current-command ()
029cb4d5 6646 "Show documentation for Perl command at point in other window."
f83d2997
KH
6647 (interactive)
6648 (cperl-info-on-command (cperl-word-at-point)))
6649
6650(defun cperl-imenu-info-imenu-search ()
6651 (if (looking-at "^-X[ \t\n]") nil
6652 (re-search-backward
6653 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6654 (forward-line 1)))
6655
5c8b7eaf 6656(defun cperl-imenu-info-imenu-name ()
f83d2997
KH
6657 (buffer-substring
6658 (match-beginning 1) (match-end 1)))
6659
6660(defun cperl-imenu-on-info ()
4ab89e7b
SM
6661 "Shows imenu for Perl Info Buffer.
6662Opens Perl Info buffer if needed."
f83d2997
KH
6663 (interactive)
6664 (let* ((buffer (current-buffer))
6665 imenu-create-index-function
5c8b7eaf
SS
6666 imenu-prev-index-position-function
6667 imenu-extract-index-name-function
f83d2997
KH
6668 (index-item (save-restriction
6669 (save-window-excursion
6670 (set-buffer (cperl-info-buffer nil))
5c8b7eaf 6671 (setq imenu-create-index-function
f83d2997
KH
6672 'imenu-default-create-index-function
6673 imenu-prev-index-position-function
6674 'cperl-imenu-info-imenu-search
6675 imenu-extract-index-name-function
6676 'cperl-imenu-info-imenu-name)
6677 (imenu-choose-buffer-index)))))
6678 (and index-item
6679 (progn
6680 (push-mark)
6681 (pop-to-buffer "*info-perl*")
6682 (cond
6683 ((markerp (cdr index-item))
6684 (goto-char (marker-position (cdr index-item))))
6685 (t
6686 (goto-char (cdr index-item))))
6687 (set-window-start (selected-window) (point))
6688 (pop-to-buffer buffer)))))
6689
6690(defun cperl-lineup (beg end &optional step minshift)
6691 "Lineup construction in a region.
6692Beginning of region should be at the start of a construction.
6693All first occurrences of this construction in the lines that are
6694partially contained in the region are lined up at the same column.
6695
6696MINSHIFT is the minimal amount of space to insert before the construction.
6697STEP is the tabwidth to position constructions.
029cb4d5 6698If STEP is nil, `cperl-lineup-step' will be used
15ca5699 6699\(or `cperl-indent-level', if `cperl-lineup-step' is nil).
f83d2997
KH
6700Will not move the position at the start to the left."
6701 (interactive "r")
4ab89e7b 6702 (let (search col tcol seen b)
f83d2997
KH
6703 (save-excursion
6704 (goto-char end)
6705 (end-of-line)
6706 (setq end (point-marker))
6707 (goto-char beg)
6708 (skip-chars-forward " \t\f")
6709 (setq beg (point-marker))
6710 (indent-region beg end nil)
6711 (goto-char beg)
6712 (setq col (current-column))
6713 (if (looking-at "[a-zA-Z0-9_]")
6714 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6715 (setq search
5c8b7eaf
SS
6716 (concat "\\<"
6717 (regexp-quote
f83d2997
KH
6718 (buffer-substring (match-beginning 0)
6719 (match-end 0))) "\\>"))
6720 (error "Cannot line up in a middle of the word"))
6721 (if (looking-at "$")
6722 (error "Cannot line up end of line"))
6723 (setq search (regexp-quote (char-to-string (following-char)))))
6724 (setq step (or step cperl-lineup-step cperl-indent-level))
6725 (or minshift (setq minshift 1))
6726 (while (progn
6727 (beginning-of-line 2)
5c8b7eaf 6728 (and (< (point) end)
f83d2997
KH
6729 (re-search-forward search end t)
6730 (goto-char (match-beginning 0))))
6731 (setq tcol (current-column) seen t)
6732 (if (> tcol col) (setq col tcol)))
6733 (or seen
6734 (error "The construction to line up occurred only once"))
6735 (goto-char beg)
6736 (setq col (+ col minshift))
6737 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5c8b7eaf 6738 (while
f83d2997 6739 (progn
4ab89e7b 6740 (cperl-make-indent col)
5c8b7eaf
SS
6741 (beginning-of-line 2)
6742 (and (< (point) end)
f83d2997
KH
6743 (re-search-forward search end t)
6744 (goto-char (match-beginning 0)))))))) ; No body
6745
4ab89e7b 6746(defun cperl-etags (&optional add all files) ;; NOT USED???
f83d2997
KH
6747 "Run etags with appropriate options for Perl files.
6748If optional argument ALL is `recursive', will process Perl files
6749in subdirectories too."
6750 (interactive)
6751 (let ((cmd "etags")
4ab89e7b
SM
6752 (args '("-l" "none" "-r"
6753 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6754 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6755 "-r"
6756 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6757 "-r"
6758 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
f83d2997
KH
6759 res)
6760 (if add (setq args (cons "-a" args)))
6761 (or files (setq files (list buffer-file-name)))
6762 (cond
6763 ((eq all 'recursive)
6764 ;;(error "Not implemented: recursive")
5c8b7eaf 6765 (setq args (append (list "-e"
f83d2997
KH
6766 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6767 use File::Find;
6768 find(\\&wanted, '.');
5c8b7eaf 6769 exec @ARGV;"
f83d2997
KH
6770 cmd) args)
6771 cmd "perl"))
5c8b7eaf 6772 (all
f83d2997 6773 ;;(error "Not implemented: all")
5c8b7eaf 6774 (setq args (append (list "-e"
f83d2997 6775 "push @ARGV, <*.PL *.pl *.pm>;
5c8b7eaf 6776 exec @ARGV;"
f83d2997
KH
6777 cmd) args)
6778 cmd "perl"))
6779 (t
6780 (setq args (append args files))))
6781 (setq res (apply 'call-process cmd nil nil nil args))
6782 (or (eq res 0)
6783 (message "etags returned \"%s\"" res))))
6784
6785(defun cperl-toggle-auto-newline ()
6786 "Toggle the state of `cperl-auto-newline'."
6787 (interactive)
6788 (setq cperl-auto-newline (not cperl-auto-newline))
5c8b7eaf 6789 (message "Newlines will %sbe auto-inserted now."
f83d2997
KH
6790 (if cperl-auto-newline "" "not ")))
6791
6792(defun cperl-toggle-abbrev ()
6793 "Toggle the state of automatic keyword expansion in CPerl mode."
6794 (interactive)
6795 (abbrev-mode (if abbrev-mode 0 1))
5c8b7eaf 6796 (message "Perl control structure will %sbe auto-inserted now."
f83d2997
KH
6797 (if abbrev-mode "" "not ")))
6798
6799
6800(defun cperl-toggle-electric ()
6801 "Toggle the state of parentheses doubling in CPerl mode."
6802 (interactive)
6803 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5c8b7eaf 6804 (message "Parentheses will %sbe auto-doubled now."
f83d2997
KH
6805 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6806
db133cb6 6807(defun cperl-toggle-autohelp ()
f739b53b
SM
6808 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6809Delay of auto-help controlled by `cperl-lazy-help-time'."
db133cb6
RS
6810 (interactive)
6811 (if (fboundp 'run-with-idle-timer)
6812 (progn
6813 (if cperl-lazy-installed
f739b53b 6814 (cperl-lazy-unstall)
db133cb6 6815 (cperl-lazy-install))
5c8b7eaf 6816 (message "Perl help messages will %sbe automatically shown now."
db133cb6
RS
6817 (if cperl-lazy-installed "" "not ")))
6818 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6819
6820(defun cperl-toggle-construct-fix ()
6821 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6822 (interactive)
5c8b7eaf 6823 (setq cperl-indent-region-fix-constructs
5bd52f0e
RS
6824 (if cperl-indent-region-fix-constructs
6825 nil
6826 1))
5c8b7eaf 6827 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
db133cb6
RS
6828 (if cperl-indent-region-fix-constructs "" "not ")))
6829
4ab89e7b
SM
6830(defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6831 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6832Nonpositive numeric argument disables debugging messages. The message
6833summarizes which regions it was decided to rescan for syntactic constructs.
6834
6835The message looks like this:
6836
6837 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6838
6839Numbers are character positions in the buffer. REQ provides the range to
6840rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6841for correct operation it should start and end outside any special syntactic
6842construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6843by CPerl."
6844 (interactive "P")
6845 (or arg
cb5bf6ba 6846 (setq arg (if (eq cperl-syntaxify-by-font-lock
4ab89e7b
SM
6847 (if backtrace 'backtrace 'message)) 0 1)))
6848 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6849 (setq cperl-syntaxify-by-font-lock arg)
6850 (message "Debugging messages of syntax unwind %sabled."
6851 (if (eq arg t) "dis" "en")))
6852
f83d2997
KH
6853;;;; Tags file creation.
6854
6855(defvar cperl-tmp-buffer " *cperl-tmp*")
6856
6857(defun cperl-setup-tmp-buf ()
6858 (set-buffer (get-buffer-create cperl-tmp-buffer))
6859 (set-syntax-table cperl-mode-syntax-table)
6860 (buffer-disable-undo)
6861 (auto-fill-mode 0)
6862 (if cperl-use-syntax-table-text-property-for-tags
6863 (progn
029cb4d5 6864 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997
KH
6865 ;; Do not introduce variable if not needed, we check it!
6866 (set 'parse-sexp-lookup-properties t))))
6867
47e83968
GM
6868;; Copied from imenu-example--name-and-position.
6869(defvar imenu-use-markers)
6870
6871(defun cperl-imenu-name-and-position ()
6872 "Return the current/previous sexp and its (beginning) location.
6873Does not move point."
6874 (save-excursion
6875 (forward-sexp -1)
6876 (let ((beg (if imenu-use-markers (point-marker) (point)))
6877 (end (progn (forward-sexp) (point))))
6878 (cons (buffer-substring beg end)
6879 beg))))
6880
f83d2997 6881(defun cperl-xsub-scan ()
f83d2997 6882 (require 'imenu)
5c8b7eaf 6883 (let ((index-alist '())
f83d2997
KH
6884 (prev-pos 0) index index1 name package prefix)
6885 (goto-char (point-min))
f83d2997
KH
6886 ;; Search for the function
6887 (progn ;;save-match-data
6888 (while (re-search-forward
6889 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6890 nil t)
f83d2997 6891 (cond
83261a2f 6892 ((match-beginning 2) ; SECTION
f83d2997
KH
6893 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6894 (goto-char (match-beginning 0))
6895 (skip-chars-forward " \t")
6896 (forward-char 1)
6897 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6898 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6899 (setq prefix nil)))
6900 ((not package) nil) ; C language section
6901 ((match-beginning 3) ; XSUB
6902 (goto-char (1+ (match-beginning 3)))
47e83968 6903 (setq index (cperl-imenu-name-and-position))
f83d2997
KH
6904 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6905 (if (and prefix (string-match (concat "^" prefix) name))
6906 (setq name (substring name (length prefix))))
6907 (cond ((string-match "::" name) nil)
6908 (t
6909 (setq index1 (cons (concat package "::" name) (cdr index)))
6910 (push index1 index-alist)))
6911 (setcar index name)
6912 (push index index-alist))
6913 (t ; BOOT: section
6914 ;; (beginning-of-line)
47e83968 6915 (setq index (cperl-imenu-name-and-position))
f83d2997
KH
6916 (setcar index (concat package "::BOOT:"))
6917 (push index index-alist)))))
f83d2997
KH
6918 index-alist))
6919
6c389151
SM
6920(defvar cperl-unreadable-ok nil)
6921
6922(defun cperl-find-tags (ifile xs topdir)
83261a2f
SM
6923 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6924 (cperl-pod-here-fontify nil) f file)
f83d2997
KH
6925 (save-excursion
6926 (if b (set-buffer b)
83261a2f 6927 (cperl-setup-tmp-buf))
f83d2997 6928 (erase-buffer)
6c389151
SM
6929 (condition-case err
6930 (setq file (car (insert-file-contents ifile)))
6931 (error (if cperl-unreadable-ok nil
6932 (if (y-or-n-p
6933 (format "File %s unreadable. Continue? " ifile))
6934 (setq cperl-unreadable-ok t)
6935 (error "Aborting: unreadable file %s" ifile)))))
a1506d29 6936 (if (not file)
6c389151 6937 (message "Unreadable file %s" ifile)
83261a2f
SM
6938 (message "Scanning file %s ..." file)
6939 (if (and cperl-use-syntax-table-text-property-for-tags
6940 (not xs))
6941 (condition-case err ; after __END__ may have garbage
6942 (cperl-find-pods-heres nil nil noninteractive)
6943 (error (message "While scanning for syntax: %s" err))))
6944 (if xs
6945 (setq lst (cperl-xsub-scan))
6946 (setq ind (cperl-imenu--create-perl-index))
6947 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6948 (setq lst
6949 (mapcar
6950 (function
6951 (lambda (elt)
6952 (cond ((string-match "^[_a-zA-Z]" (car elt))
6953 (goto-char (cdr elt))
6954 (beginning-of-line) ; pos should be of the start of the line
6955 (list (car elt)
6956 (point)
6957 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6958 (buffer-substring (progn
6959 (goto-char (cdr elt))
6960 ;; After name now...
6961 (or (eolp) (forward-char 1))
6962 (point))
6963 (progn
6964 (beginning-of-line)
6965 (point))))))))
6966 lst))
6967 (erase-buffer)
6968 (while lst
6969 (setq elt (car lst) lst (cdr lst))
6970 (if elt
6971 (progn
6972 (insert (elt elt 3)
6973 127
6974 (if (string-match "^package " (car elt))
6975 (substring (car elt) 8)
6976 (car elt) )
6977 1
6978 (number-to-string (elt elt 2)) ; Line
6979 ","
6980 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6981 "\n")
6982 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6983 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
6984 (elt elt 3)))
6985 ;; Need to insert the name without package as well
15ca5699 6986 (setq lst (cons (cons (substring (elt elt 3)
83261a2f
SM
6987 (match-beginning 1)
6988 (match-end 1))
6989 (cdr elt))
6990 lst))))))
6991 (setq pos (point))
6992 (goto-char 1)
6993 (setq rel file)
6994 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
6995 (set-text-properties 0 (length rel) nil rel)
6996 (and (equal topdir (substring rel 0 (length topdir)))
6997 (setq rel (substring file (length topdir))))
6998 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
6999 (setq ret (buffer-substring 1 (point-max)))
7000 (erase-buffer)
7001 (or noninteractive
7002 (message "Scanning file %s finished" file))
7003 ret))))
f83d2997
KH
7004
7005(defun cperl-add-tags-recurse-noxs ()
4ab89e7b 7006 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
f83d2997
KH
7007Use as
7008 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
4ab89e7b 7009 -f cperl-add-tags-recurse-noxs
f83d2997
KH
7010"
7011 (cperl-write-tags nil nil t t nil t))
7012
4ab89e7b
SM
7013(defun cperl-add-tags-recurse-noxs-fullpath ()
7014 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7015Writes down fullpath, so TAGS is relocatable (but if the build directory
7016is relocated, the file TAGS inside it breaks). Use as
7017 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7018 -f cperl-add-tags-recurse-noxs-fullpath
7019"
7020 (cperl-write-tags nil nil t t nil t ""))
7021
f83d2997
KH
7022(defun cperl-add-tags-recurse ()
7023 "Add to TAGS file data for Perl files in the current directory and kids.
7024Use as
7025 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 7026 -f cperl-add-tags-recurse
f83d2997
KH
7027"
7028 (cperl-write-tags nil nil t t))
7029
7030(defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7031 ;; If INBUFFER, do not select buffer, and do not save
7032 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7033 (require 'etags)
7034 (if file nil
7035 (setq file (if dir default-directory (buffer-file-name)))
7036 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7037 (or topdir
7038 (setq topdir default-directory))
7039 (let ((tags-file-name "TAGS")
72bc50c0 7040 (case-fold-search (and (featurep 'xemacs) (eq system-type 'emx)))
6c389151 7041 xs rel tm)
f83d2997
KH
7042 (save-excursion
7043 (cond (inbuffer nil) ; Already there
7044 ((file-exists-p tags-file-name)
6546555e 7045 (if (featurep 'xemacs)
5bd52f0e 7046 (visit-tags-table-buffer)
83261a2f 7047 (visit-tags-table-buffer tags-file-name)))
f83d2997
KH
7048 (t (set-buffer (find-file-noselect tags-file-name))))
7049 (cond
7050 (dir
7051 (cond ((eq erase 'ignore))
7052 (erase
7053 (erase-buffer)
7054 (setq erase 'ignore)))
a1506d29 7055 (let ((files
6c389151 7056 (condition-case err
a1506d29 7057 (directory-files file t
6c389151
SM
7058 (if recurse nil cperl-scan-files-regexp)
7059 t)
7060 (error
7061 (if cperl-unreadable-ok nil
7062 (if (y-or-n-p
7063 (format "Directory %s unreadable. Continue? " file))
a1506d29 7064 (setq cperl-unreadable-ok t
83261a2f 7065 tm nil) ; Return empty list
6c389151 7066 (error "Aborting: unreadable directory %s" file)))))))
dba01120
GM
7067 (mapc (function
7068 (lambda (file)
7069 (cond
7070 ((string-match cperl-noscan-files-regexp file)
7071 nil)
7072 ((not (file-directory-p file))
7073 (if (string-match cperl-scan-files-regexp file)
7074 (cperl-write-tags file erase recurse nil t noxs topdir)))
7075 ((not recurse) nil)
7076 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7077 files)))
f83d2997
KH
7078 (t
7079 (setq xs (string-match "\\.xs$" file))
7080 (if (not (and xs noxs))
7081 (progn
7082 (cond ((eq erase 'ignore) (goto-char (point-max)))
83261a2f
SM
7083 (erase (erase-buffer))
7084 (t
7085 (goto-char 1)
7086 (setq rel file)
7087 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7088 (set-text-properties 0 (length rel) nil rel)
7089 (and (equal topdir (substring rel 0 (length topdir)))
7090 (setq rel (substring file (length topdir))))
7091 (if (search-forward (concat "\f\n" rel ",") nil t)
7092 (progn
7093 (search-backward "\f\n")
7094 (delete-region (point)
7095 (save-excursion
7096 (forward-char 1)
7097 (if (search-forward "\f\n"
7098 nil 'toend)
7099 (- (point) 2)
7100 (point-max)))))
7101 (goto-char (point-max)))))
f83d2997 7102 (insert (cperl-find-tags file xs topdir))))))
83261a2f
SM
7103 (if inbuffer nil ; Delegate to the caller
7104 (save-buffer 0) ; No backup
f83d2997
KH
7105 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7106 (initialize-new-tags-table))))))
7107
7108(defvar cperl-tags-hier-regexp-list
5c8b7eaf 7109 (concat
f83d2997
KH
7110 "^\\("
7111 "\\(package\\)\\>"
7112 "\\|"
7113 "sub\\>[^\n]+::"
7114 "\\|"
7115 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7116 "\\|"
7117 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7118 "\\)"))
7119
7120(defvar cperl-hierarchy '(() ())
f94a632a 7121 "Global hierarchy of classes.")
f83d2997
KH
7122
7123(defun cperl-tags-hier-fill ()
7124 ;; Suppose we are in a tag table cooked by cperl.
7125 (goto-char 1)
7126 (let (type pack name pos line chunk ord cons1 file str info fileind)
7127 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5c8b7eaf 7128 (setq pos (match-beginning 0)
f83d2997
KH
7129 pack (match-beginning 2))
7130 (beginning-of-line)
7131 (if (looking-at (concat
7132 "\\([^\n]+\\)"
7133 "\C-?"
7134 "\\([^\n]+\\)"
7135 "\C-a"
7136 "\\([0-9]+\\)"
7137 ","
7138 "\\([0-9]+\\)"))
7139 (progn
7140 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7141 name (buffer-substring (match-beginning 2) (match-end 2))
7142 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5bd52f0e 7143 line (buffer-substring (match-beginning 3) (match-end 3))
f83d2997 7144 ord (if pack 1 0)
f83d2997 7145 file (file-of-tag)
5bd52f0e
RS
7146 fileind (format "%s:%s" file line)
7147 ;; Moves to beginning of the next line:
7148 info (cperl-etags-snarf-tag file line))
f83d2997
KH
7149 ;; Move back
7150 (forward-char -1)
7151 ;; Make new member of hierarchy name ==> file ==> pos if needed
7152 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7153 ;; Name known
7154 (setcdr cons1 (cons (cons fileind (vector file info))
7155 (cdr cons1)))
7156 ;; First occurrence of the name, start alist
7157 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5c8b7eaf 7158 (if pack
f83d2997
KH
7159 (setcar (cdr cperl-hierarchy)
7160 (cons cons1 (nth 1 cperl-hierarchy)))
7161 (setcar cperl-hierarchy
7162 (cons cons1 (car cperl-hierarchy)))))))
7163 (end-of-line))))
7164
e8a11b22 7165(declare-function x-popup-menu "menu.c" (position menu))
f2d9c15f 7166
f83d2997
KH
7167(defun cperl-tags-hier-init (&optional update)
7168 "Show hierarchical menu of classes and methods.
7169Finds info about classes by a scan of loaded TAGS files.
7170Supposes that the TAGS files contain fully qualified function names.
7171One may build such TAGS files from CPerl mode menu."
7172 (interactive)
7173 (require 'etags)
7174 (require 'imenu)
7175 (if (or update (null (nth 2 cperl-hierarchy)))
83261a2f
SM
7176 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7177 (or (nthcdr 2 elt)
7178 ;; Only in one file
7179 (setcdr elt (cdr (nth 1 elt)))))))
7180 pack name cons1 to l1 l2 l3 l4 b)
f83d2997
KH
7181 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7182 (setq cperl-hierarchy (list l1 l2 l3))
6546555e 7183 (if (featurep 'xemacs) ; Not checked
5bd52f0e
RS
7184 (progn
7185 (or tags-file-name
7186 ;; Does this work in XEmacs?
8c777c8d
CY
7187 (call-interactively 'visit-tags-table))
7188 (message "Updating list of classes...")
5bd52f0e
RS
7189 (set-buffer (get-file-buffer tags-file-name))
7190 (cperl-tags-hier-fill))
7191 (or tags-table-list
7192 (call-interactively 'visit-tags-table))
dba01120 7193 (mapc
4ab89e7b
SM
7194 (function
7195 (lambda (tagsfile)
5bd52f0e 7196 (message "Updating list of classes... %s" tagsfile)
8c777c8d
CY
7197 (set-buffer (get-file-buffer tagsfile))
7198 (cperl-tags-hier-fill)))
dba01120 7199 tags-table-list)
5bd52f0e 7200 (message "Updating list of classes... postprocessing..."))
dba01120
GM
7201 (mapc remover (car cperl-hierarchy))
7202 (mapc remover (nth 1 cperl-hierarchy))
f83d2997
KH
7203 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7204 (cons "Methods: " (car cperl-hierarchy))))
7205 (cperl-tags-treeify to 1)
7206 (setcar (nthcdr 2 cperl-hierarchy)
7207 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7208 (message "Updating list of classes: done, requesting display...")
7209 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7210 ))
7211 (or (nth 2 cperl-hierarchy)
7212 (error "No items found"))
7213 (setq update
7214;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
83261a2f
SM
7215 (if (if (fboundp 'display-popup-menus-p)
7216 (let ((f 'display-popup-menus-p))
7217 (funcall f))
7218 window-system)
f83d2997
KH
7219 (x-popup-menu t (nth 2 cperl-hierarchy))
7220 (require 'tmm)
7221 (tmm-prompt (nth 2 cperl-hierarchy))))
7222 (if (and update (listp update))
7223 (progn (while (cdr update) (setq update (cdr update)))
7224 (setq update (car update)))) ; Get the last from the list
5c8b7eaf 7225 (if (vectorp update)
f83d2997
KH
7226 (progn
7227 (find-file (elt update 0))
5bd52f0e 7228 (cperl-etags-goto-tag-location (elt update 1))))
f83d2997
KH
7229 (if (eq update -999) (cperl-tags-hier-init t)))
7230
7231(defun cperl-tags-treeify (to level)
7232 ;; cadr of `to' is read-write. On start it is a cons
5c8b7eaf 7233 (let* ((regexp (concat "^\\(" (mapconcat
f83d2997
KH
7234 'identity
7235 (make-list level "[_a-zA-Z0-9]+")
7236 "::")
7237 "\\)\\(::\\)?"))
7238 (packages (cdr (nth 1 to)))
7239 (methods (cdr (nth 2 to)))
7240 l1 head tail cons1 cons2 ord writeto packs recurse
7241 root-packages root-functions ms many_ms same_name ps
7242 (move-deeper
5c8b7eaf 7243 (function
f83d2997
KH
7244 (lambda (elt)
7245 (cond ((and (string-match regexp (car elt))
7246 (or (eq ord 1) (match-end 2)))
7247 (setq head (substring (car elt) 0 (match-end 1))
5c8b7eaf 7248 tail (if (match-end 2) (substring (car elt)
f83d2997
KH
7249 (match-end 2)))
7250 recurse t)
7251 (if (setq cons1 (assoc head writeto)) nil
7252 ;; Need to init new head
7253 (setcdr writeto (cons (list head (list "Packages: ")
7254 (list "Methods: "))
7255 (cdr writeto)))
7256 (setq cons1 (nth 1 writeto)))
7257 (setq cons2 (nth ord cons1)) ; Either packs or meths
7258 (setcdr cons2 (cons elt (cdr cons2))))
7259 ((eq ord 2)
7260 (setq root-functions (cons elt root-functions)))
7261 (t
7262 (setq root-packages (cons elt root-packages))))))))
7263 (setcdr to l1) ; Init to dynamic space
7264 (setq writeto to)
7265 (setq ord 1)
dba01120 7266 (mapc move-deeper packages)
f83d2997 7267 (setq ord 2)
dba01120 7268 (mapc move-deeper methods)
f83d2997 7269 (if recurse
dba01120 7270 (mapc (function (lambda (elt)
f83d2997 7271 (cperl-tags-treeify elt (1+ level))))
dba01120 7272 (cdr to)))
f83d2997 7273 ;;Now clean up leaders with one child only
dba01120
GM
7274 (mapc (function (lambda (elt)
7275 (if (not (and (listp (cdr elt))
7276 (eq (length elt) 2))) nil
7277 (setcar elt (car (nth 1 elt)))
7278 (setcdr elt (cdr (nth 1 elt))))))
7279 (cdr to))
f83d2997
KH
7280 ;; Sort the roots of subtrees
7281 (if (default-value 'imenu-sort-function)
7282 (setcdr to
7283 (sort (cdr to) (default-value 'imenu-sort-function))))
7284 ;; Now add back functions removed from display
dba01120
GM
7285 (mapc (function (lambda (elt)
7286 (setcdr to (cons elt (cdr to)))))
7287 (if (default-value 'imenu-sort-function)
7288 (nreverse
7289 (sort root-functions (default-value 'imenu-sort-function)))
7290 root-functions))
f83d2997 7291 ;; Now add back packages removed from display
dba01120
GM
7292 (mapc (function (lambda (elt)
7293 (setcdr to (cons (cons (concat "package " (car elt))
7294 (cdr elt))
7295 (cdr to)))))
7296 (if (default-value 'imenu-sort-function)
7297 (nreverse
7298 (sort root-packages (default-value 'imenu-sort-function)))
7299 root-packages))))
f83d2997
KH
7300
7301;;;(x-popup-menu t
5c8b7eaf 7302;;; '(keymap "Name1"
f83d2997 7303;;; ("Ret1" "aa")
5c8b7eaf
SS
7304;;; ("Head1" "ab"
7305;;; keymap "Name2"
f83d2997
KH
7306;;; ("Tail1" "x") ("Tail2" "y"))))
7307
7308(defun cperl-list-fold (list name limit)
7309 (let (list1 list2 elt1 (num 0))
7310 (if (<= (length list) limit) list
7311 (setq list1 nil list2 nil)
7312 (while list
5c8b7eaf 7313 (setq num (1+ num)
f83d2997
KH
7314 elt1 (car list)
7315 list (cdr list))
7316 (if (<= num imenu-max-items)
7317 (setq list2 (cons elt1 list2))
7318 (setq list1 (cons (cons name
7319 (nreverse list2))
7320 list1)
7321 list2 (list elt1)
7322 num 1)))
7323 (nreverse (cons (cons name
7324 (nreverse list2))
7325 list1)))))
7326
7327(defun cperl-menu-to-keymap (menu &optional name)
7328 (let (list)
5c8b7eaf
SS
7329 (cons 'keymap
7330 (mapcar
7331 (function
f83d2997
KH
7332 (lambda (elt)
7333 (cond ((listp (cdr elt))
7334 (setq list (cperl-list-fold
7335 (cdr elt) (car elt) imenu-max-items))
7336 (cons nil
7337 (cons (car elt)
7338 (cperl-menu-to-keymap list))))
7339 (t
7340 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7341 (cperl-list-fold menu "Root" imenu-max-items)))))
7342
7343\f
7344(defvar cperl-bad-style-regexp
7345 (mapconcat 'identity
83261a2f 7346 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
15ca5699 7347 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
83261a2f 7348 "\\|")
f83d2997
KH
7349 "Finds places such that insertion of a whitespace may help a lot.")
7350
5c8b7eaf 7351(defvar cperl-not-bad-style-regexp
15ca5699 7352 (mapconcat
83261a2f 7353 'identity
f83d2997
KH
7354 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7355 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7356 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
4ab89e7b 7357 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
5bd52f0e 7358 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
f83d2997
KH
7359 "-[0-9]" ; -5
7360 "\\+\\+" ; ++var
7361 "--" ; --var
7362 ".->" ; a->b
7363 "->" ; a SPACE ->b
7364 "\\[-" ; a[-1]
5bd52f0e 7365 "\\\\[&$@*\\\\]" ; \&func
f83d2997 7366 "^=" ; =head
5bd52f0e
RS
7367 "\\$." ; $|
7368 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
f83d2997
KH
7369 "||"
7370 "&&"
7371 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
83261a2f 7372 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
f83d2997
KH
7373 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7374 ;;"[*/+-|&<.]+="
7375 )
7376 "\\|")
7377 "If matches at the start of match found by `my-bad-c-style-regexp',
7378insertion of a whitespace will not help.")
7379
7380(defvar found-bad)
7381
7382(defun cperl-find-bad-style ()
7383 "Find places in the buffer where insertion of a whitespace may help.
7384Prompts user for insertion of spaces.
7385Currently it is tuned to C and Perl syntax."
7386 (interactive)
7387 (let (found-bad (p (point)))
7388 (setq last-nonmenu-event 13) ; To disable popup
4ab89e7b 7389 (goto-char (point-min))
f83d2997 7390 (map-y-or-n-p "Insert space here? "
83261a2f 7391 (lambda (arg) (insert " "))
f83d2997 7392 'cperl-next-bad-style
5c8b7eaf 7393 '("location" "locations" "insert a space into")
f83d2997
KH
7394 '((?\C-r (lambda (arg)
7395 (let ((buffer-quit-function
7396 'exit-recursive-edit))
7397 (message "Exit with Esc Esc")
7398 (recursive-edit)
7399 t)) ; Consider acted upon
5c8b7eaf 7400 "edit, exit with Esc Esc")
f83d2997
KH
7401 (?e (lambda (arg)
7402 (let ((buffer-quit-function
7403 'exit-recursive-edit))
7404 (message "Exit with Esc Esc")
7405 (recursive-edit)
7406 t)) ; Consider acted upon
7407 "edit, exit with Esc Esc"))
7408 t)
7409 (if found-bad (goto-char found-bad)
7410 (goto-char p)
7411 (message "No appropriate place found"))))
7412
7413(defun cperl-next-bad-style ()
7414 (let (p (not-found t) (point (point)) found)
7415 (while (and not-found
7416 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7417 (setq p (point))
7418 (goto-char (match-beginning 0))
7419 (if (or
7420 (looking-at cperl-not-bad-style-regexp)
7421 ;; Check for a < -b and friends
7422 (and (eq (following-char) ?\-)
7423 (save-excursion
7424 (skip-chars-backward " \t\n")
07cb2aa3 7425 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
f83d2997
KH
7426 ;; Now check for syntax type
7427 (save-match-data
7428 (setq found (point))
7429 (beginning-of-defun)
7430 (let ((pps (parse-partial-sexp (point) found)))
7431 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7432 (goto-char (match-end 0))
7433 (goto-char (1- p))
7434 (setq not-found nil
7435 found-bad found)))
7436 (not not-found)))
7437
f1d851ae 7438\f
f83d2997 7439;;; Getting help
5c8b7eaf 7440(defvar cperl-have-help-regexp
f83d2997
KH
7441 ;;(concat "\\("
7442 (mapconcat
7443 'identity
83261a2f 7444 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
f83d2997
KH
7445 "[$@]\\^[a-zA-Z]" ; Special variable
7446 "[$@][^ \n\t]" ; Special variable
7447 "-[a-zA-Z]" ; File test
7448 "\\\\[a-zA-Z0]" ; Special chars
83261a2f 7449 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
f83d2997
KH
7450 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7451 "[a-zA-Z_0-9:]+" ; symbol or number
7452 "x="
83261a2f 7453 "#!")
f83d2997 7454 ;;"\\)\\|\\("
83261a2f
SM
7455 "\\|")
7456 ;;"\\)"
7457 ;;)
f83d2997
KH
7458 "Matches places in the buffer we can find help for.")
7459
7460(defvar cperl-message-on-help-error t)
7461(defvar cperl-help-from-timer nil)
7462
7463(defun cperl-word-at-point-hard ()
7464 ;; Does not save-excursion
7465 ;; Get to the something meaningful
7466 (or (eobp) (eolp) (forward-char 1))
5c8b7eaf 7467 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
e180ab9f 7468 (point-at-bol)
f83d2997
KH
7469 'to-beg)
7470 ;; (cond
7471 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7472 ;; (skip-chars-backward " \n\t\r({[]});,")
7473 ;; (or (bobp) (backward-char 1))))
7474 ;; Try to backtrace
7475 (cond
7476 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7477 (skip-chars-backward "a-zA-Z0-9_:")
5c8b7eaf 7478 (cond
f83d2997
KH
7479 ((and (eq (preceding-char) ?^) ; $^I
7480 (eq (char-after (- (point) 2)) ?\$))
7481 (forward-char -2))
7482 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7483 (forward-char -1))
7484 ((and (eq (preceding-char) ?\=)
7485 (eq (current-column) 1))
7486 (forward-char -1))) ; =head1
7487 (if (and (eq (preceding-char) ?\<)
7488 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7489 (forward-char -1)))
7490 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7491 (forward-char -1))
7492 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7493 (forward-char -1))
7494 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7495 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7496 (cond
7497 ((and (eq (preceding-char) ?\$)
7498 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7499 (forward-char -1))
7500 ((and (eq (following-char) ?\>)
7501 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7502 (save-excursion
7503 (forward-sexp -1)
7504 (and (eq (preceding-char) ?\<)
7505 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7506 (search-backward "<"))))
7507 ((and (eq (following-char) ?\$)
7508 (eq (preceding-char) ?\<)
7509 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7510 (forward-char -1)))
7511 (if (looking-at cperl-have-help-regexp)
7512 (buffer-substring (match-beginning 0) (match-end 0))))
7513
7514(defun cperl-get-help ()
7515 "Get one-line docs on the symbol at the point.
7516The data for these docs is a little bit obsolete and may be in fact longer
7517than a line. Your contribution to update/shorten it is appreciated."
7518 (interactive)
7519 (save-match-data ; May be called "inside" query-replace
7520 (save-excursion
7521 (let ((word (cperl-word-at-point-hard)))
7522 (if word
7523 (if (and cperl-help-from-timer ; Bail out if not in mainland
7524 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7525 (or (memq (get-text-property (point) 'face)
7526 '(font-lock-comment-face font-lock-string-face))
7527 (memq (get-text-property (point) 'syntax-type)
7528 '(pod here-doc format))))
7529 nil
7530 (cperl-describe-perl-symbol word))
7531 (if cperl-message-on-help-error
5c8b7eaf 7532 (message "Nothing found for %s..."
f83d2997
KH
7533 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7534
7535;;; Stolen from perl-descr.el by Johan Vromans:
7536
7537(defvar cperl-doc-buffer " *perl-doc*"
7538 "Where the documentation can be found.")
7539
7540(defun cperl-describe-perl-symbol (val)
7541 "Display the documentation of symbol at point, a Perl operator."
7542 (let ((enable-recursive-minibuffers t)
7543 args-file regexp)
7544 (cond
83261a2f
SM
7545 ((string-match "^[&*][a-zA-Z_]" val)
7546 (setq val (concat (substring val 0 1) "NAME")))
7547 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7548 (setq val (concat "@" (substring val 1 (match-end 1)))))
7549 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7550 (setq val (concat "%" (substring val 1 (match-end 1)))))
7551 ((and (string= val "x") (string-match "^x=" val))
7552 (setq val "x="))
7553 ((string-match "^\\$[\C-a-\C-z]" val)
7554 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7555 ((string-match "^CORE::" val)
7556 (setq val "CORE::"))
7557 ((string-match "^SUPER::" val)
7558 (setq val "SUPER::"))
7559 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7560 (setq val "<NAME>")))
5c8b7eaf 7561 (setq regexp (concat "^"
f83d2997 7562 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
5c8b7eaf 7563 (regexp-quote val)
f83d2997
KH
7564 "\\([ \t([/]\\|$\\)"))
7565
7566 ;; get the buffer with the documentation text
7567 (cperl-switch-to-doc-buffer)
7568
7569 ;; lookup in the doc
7570 (goto-char (point-min))
7571 (let ((case-fold-search nil))
5c8b7eaf 7572 (list
f83d2997
KH
7573 (if (re-search-forward regexp (point-max) t)
7574 (save-excursion
7575 (beginning-of-line 1)
7576 (let ((lnstart (point)))
7577 (end-of-line)
7578 (message "%s" (buffer-substring lnstart (point)))))
7579 (if cperl-message-on-help-error
7580 (message "No definition for %s" val)))))))
7581
83261a2f 7582(defvar cperl-short-docs 'please-ignore-this-line
f83d2997
KH
7583 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7584 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
f739b53b 7585... Range (list context); flip/flop [no flop when flip] (scalar context).
5c8b7eaf 7586! ... Logical negation.
f83d2997
KH
7587... != ... Numeric inequality.
7588... !~ ... Search pattern, substitution, or translation (negated).
7589$! In numeric context: errno. In a string context: error string.
7590$\" The separator which joins elements of arrays interpolated in strings.
f739b53b 7591$# The output format for printed numbers. Default is %.15g or close.
f83d2997
KH
7592$$ Process number of this script. Changes in the fork()ed child process.
7593$% The current page number of the currently selected output channel.
7594
7595 The following variables are always local to the current block:
7596
7597$1 Match of the 1st set of parentheses in the last match (auto-local).
7598$2 Match of the 2nd set of parentheses in the last match (auto-local).
7599$3 Match of the 3rd set of parentheses in the last match (auto-local).
7600$4 Match of the 4th set of parentheses in the last match (auto-local).
7601$5 Match of the 5th set of parentheses in the last match (auto-local).
7602$6 Match of the 6th set of parentheses in the last match (auto-local).
7603$7 Match of the 7th set of parentheses in the last match (auto-local).
7604$8 Match of the 8th set of parentheses in the last match (auto-local).
7605$9 Match of the 9th set of parentheses in the last match (auto-local).
7606$& The string matched by the last pattern match (auto-local).
7607$' The string after what was matched by the last match (auto-local).
7608$` The string before what was matched by the last match (auto-local).
7609
7610$( The real gid of this process.
7611$) The effective gid of this process.
7612$* Deprecated: Set to 1 to do multiline matching within a string.
7613$+ The last bracket matched by the last search pattern.
7614$, The output field separator for the print operator.
7615$- The number of lines left on the page.
7616$. The current input line number of the last filehandle that was read.
7617$/ The input record separator, newline by default.
f739b53b 7618$0 Name of the file containing the current perl script (read/write).
f83d2997
KH
7619$: String may be broken after these characters to fill ^-lines in a format.
7620$; Subscript separator for multi-dim array emulation. Default \"\\034\".
7621$< The real uid of this process.
7622$= The page length of the current output channel. Default is 60 lines.
7623$> The effective uid of this process.
7624$? The status returned by the last ``, pipe close or `system'.
7625$@ The perl error message from the last eval or do @var{EXPR} command.
7626$ARGV The name of the current file used with <> .
7627$[ Deprecated: The index of the first element/char in an array/string.
7628$\\ The output record separator for the print operator.
7629$] The perl version string as displayed with perl -v.
7630$^ The name of the current top-of-page format.
7631$^A The current value of the write() accumulator for format() lines.
7632$^D The value of the perl debug (-D) flags.
7633$^E Information about the last system error other than that provided by $!.
7634$^F The highest system file descriptor, ordinarily 2.
7635$^H The current set of syntax checks enabled by `use strict'.
7636$^I The value of the in-place edit extension (perl -i option).
d7584f0f 7637$^L What formats output to perform a formfeed. Default is \\f.
5bd52f0e 7638$^M A buffer for emergency memory allocation when running out of memory.
f83d2997
KH
7639$^O The operating system name under which this copy of Perl was built.
7640$^P Internal debugging flag.
7641$^T The time the script was started. Used by -A/-M/-C file tests.
7642$^W True if warnings are requested (perl -w flag).
7643$^X The name under which perl was invoked (argv[0] in C-speech).
7644$_ The default input and pattern-searching space.
5c8b7eaf 7645$| Auto-flush after write/print on current output channel? Default 0.
f83d2997
KH
7646$~ The name of the current report format.
7647... % ... Modulo division.
7648... %= ... Modulo division assignment.
7649%ENV Contains the current environment.
7650%INC List of files that have been require-d or do-ne.
7651%SIG Used to set signal handlers for various signals.
7652... & ... Bitwise and.
7653... && ... Logical and.
7654... &&= ... Logical and assignment.
7655... &= ... Bitwise and assignment.
7656... * ... Multiplication.
7657... ** ... Exponentiation.
7658*NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7659&NAME(arg0, ...) Subroutine call. Arguments go to @_.
7660... + ... Addition. +EXPR Makes EXPR into scalar context.
7661++ Auto-increment (magical on strings). ++EXPR EXPR++
7662... += ... Addition assignment.
7663, Comma operator.
7664... - ... Subtraction.
7665-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7666... -= ... Subtraction assignment.
7667-A Access time in days since script started.
7668-B File is a non-text (binary) file.
7669-C Inode change time in days since script started.
7670-M Age in days since script started.
7671-O File is owned by real uid.
7672-R File is readable by real uid.
7673-S File is a socket .
7674-T File is a text file.
7675-W File is writable by real uid.
7676-X File is executable by real uid.
7677-b File is a block special file.
7678-c File is a character special file.
7679-d File is a directory.
7680-e File exists .
7681-f File is a plain file.
7682-g File has setgid bit set.
7683-k File has sticky bit set.
7684-l File is a symbolic link.
7685-o File is owned by effective uid.
7686-p File is a named pipe (FIFO).
7687-r File is readable by effective uid.
7688-s File has non-zero size.
7689-t Tests if filehandle (STDIN by default) is opened to a tty.
7690-u File has setuid bit set.
7691-w File is writable by effective uid.
7692-x File is executable by effective uid.
7693-z File has zero size.
7694. Concatenate strings.
f739b53b 7695.. Range (list context); flip/flop (scalar context) operator.
f83d2997
KH
7696.= Concatenate assignment strings
7697... / ... Division. /PATTERN/ioxsmg Pattern match
7698... /= ... Division assignment.
7699/PATTERN/ioxsmg Pattern match.
f739b53b 7700... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
f83d2997
KH
7701<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7702<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7703<> Reads line from union of files in @ARGV (= command line) and STDIN.
7704... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7705... <= ... Numeric less than or equal to.
7706... <=> ... Numeric compare.
7707... = ... Assignment.
7708... == ... Numeric equality.
7709... =~ ... Search pattern, substitution, or translation
7710... > ... Numeric greater than.
7711... >= ... Numeric greater than or equal to.
7712... >> ... Bitwise shift right.
7713... >>= ... Bitwise shift right assignment.
7714... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7715?PATTERN? One-time pattern match.
7716@ARGV Command line arguments (not including the command name - see $0).
7717@INC List of places to look for perl scripts during do/include/use.
f739b53b 7718@_ Parameter array for subroutines; result of split() unless in list context.
d7584f0f 7719\\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
f83d2997
KH
7720\\0 Octal char, e.g. \\033.
7721\\E Case modification terminator. See \\Q, \\L, and \\U.
d7584f0f
AS
7722\\L Lowercase until \\E . See also \\l, lc.
7723\\U Upcase until \\E . See also \\u, uc.
f83d2997
KH
7724\\Q Quote metacharacters until \\E . See also quotemeta.
7725\\a Alarm character (octal 007).
7726\\b Backspace character (octal 010).
7727\\c Control character, e.g. \\c[ .
7728\\e Escape character (octal 033).
7729\\f Formfeed character (octal 014).
7730\\l Lowercase the next character. See also \\L and \\u, lcfirst.
7731\\n Newline character (octal 012 on most systems).
7732\\r Return character (octal 015 on most systems).
7733\\t Tab character (octal 011).
7734\\u Upcase the next character. See also \\U and \\l, ucfirst.
7735\\x Hex character, e.g. \\x1b.
7736... ^ ... Bitwise exclusive or.
7737__END__ Ends program source.
7738__DATA__ Ends program source.
7739__FILE__ Current (source) filename.
7740__LINE__ Current line in current source.
7741__PACKAGE__ Current package.
7742ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7743ARGVOUT Output filehandle with -i flag.
7744BEGIN { ... } Immediately executed (during compilation) piece of code.
7745END { ... } Pseudo-subroutine executed after the script finishes.
6c389151
SM
7746CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7747INIT { ... } Pseudo-subroutine executed before the script starts running.
f83d2997
KH
7748DATA Input filehandle for what follows after __END__ or __DATA__.
7749accept(NEWSOCKET,GENERICSOCKET)
7750alarm(SECONDS)
7751atan2(X,Y)
7752bind(SOCKET,NAME)
7753binmode(FILEHANDLE)
7754caller[(LEVEL)]
7755chdir(EXPR)
7756chmod(LIST)
7757chop[(LIST|VAR)]
7758chown(LIST)
7759chroot(FILENAME)
7760close(FILEHANDLE)
7761closedir(DIRHANDLE)
7762... cmp ... String compare.
7763connect(SOCKET,NAME)
7764continue of { block } continue { block }. Is executed after `next' or at end.
7765cos(EXPR)
7766crypt(PLAINTEXT,SALT)
7767dbmclose(%HASH)
7768dbmopen(%HASH,DBNAME,MODE)
7769defined(EXPR)
7770delete($HASH{KEY})
7771die(LIST)
7772do { ... }|SUBR while|until EXPR executes at least once
7773do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7774dump LABEL
7775each(%HASH)
7776endgrent
7777endhostent
7778endnetent
7779endprotoent
7780endpwent
7781endservent
7782eof[([FILEHANDLE])]
7783... eq ... String equality.
7784eval(EXPR) or eval { BLOCK }
4ab89e7b 7785exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
f83d2997
KH
7786exit(EXPR)
7787exp(EXPR)
7788fcntl(FILEHANDLE,FUNCTION,SCALAR)
7789fileno(FILEHANDLE)
7790flock(FILEHANDLE,OPERATION)
7791for (EXPR;EXPR;EXPR) { ... }
7792foreach [VAR] (@ARRAY) { ... }
7793fork
7794... ge ... String greater than or equal.
7795getc[(FILEHANDLE)]
7796getgrent
7797getgrgid(GID)
7798getgrnam(NAME)
7799gethostbyaddr(ADDR,ADDRTYPE)
7800gethostbyname(NAME)
7801gethostent
7802getlogin
7803getnetbyaddr(ADDR,ADDRTYPE)
7804getnetbyname(NAME)
7805getnetent
7806getpeername(SOCKET)
7807getpgrp(PID)
7808getppid
7809getpriority(WHICH,WHO)
7810getprotobyname(NAME)
7811getprotobynumber(NUMBER)
7812getprotoent
7813getpwent
7814getpwnam(NAME)
7815getpwuid(UID)
7816getservbyname(NAME,PROTO)
7817getservbyport(PORT,PROTO)
7818getservent
7819getsockname(SOCKET)
7820getsockopt(SOCKET,LEVEL,OPTNAME)
7821gmtime(EXPR)
7822goto LABEL
f83d2997
KH
7823... gt ... String greater than.
7824hex(EXPR)
7825if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7826index(STR,SUBSTR[,OFFSET])
7827int(EXPR)
7828ioctl(FILEHANDLE,FUNCTION,SCALAR)
7829join(EXPR,LIST)
7830keys(%HASH)
7831kill(LIST)
7832last [LABEL]
7833... le ... String less than or equal.
7834length(EXPR)
7835link(OLDFILE,NEWFILE)
7836listen(SOCKET,QUEUESIZE)
7837local(LIST)
7838localtime(EXPR)
7839log(EXPR)
7840lstat(EXPR|FILEHANDLE|VAR)
7841... lt ... String less than.
7842m/PATTERN/iogsmx
7843mkdir(FILENAME,MODE)
7844msgctl(ID,CMD,ARG)
7845msgget(KEY,FLAGS)
7846msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7847msgsnd(ID,MSG,FLAGS)
7848my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6c389151 7849our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
f83d2997
KH
7850... ne ... String inequality.
7851next [LABEL]
7852oct(EXPR)
7853open(FILEHANDLE[,EXPR])
7854opendir(DIRHANDLE,EXPR)
7855ord(EXPR) ASCII value of the first char of the string.
7856pack(TEMPLATE,LIST)
7857package NAME Introduces package context.
7858pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7859pop(ARRAY)
7860print [FILEHANDLE] [(LIST)]
7861printf [FILEHANDLE] (FORMAT,LIST)
7862push(ARRAY,LIST)
7863q/STRING/ Synonym for 'STRING'
7864qq/STRING/ Synonym for \"STRING\"
7865qx/STRING/ Synonym for `STRING`
7866rand[(EXPR)]
7867read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7868readdir(DIRHANDLE)
7869readlink(EXPR)
7870recv(SOCKET,SCALAR,LEN,FLAGS)
7871redo [LABEL]
7872rename(OLDNAME,NEWNAME)
7873require [FILENAME | PERL_VERSION]
7874reset[(EXPR)]
7875return(LIST)
7876reverse(LIST)
7877rewinddir(DIRHANDLE)
7878rindex(STR,SUBSTR[,OFFSET])
7879rmdir(FILENAME)
7880s/PATTERN/REPLACEMENT/gieoxsm
7881scalar(EXPR)
7882seek(FILEHANDLE,POSITION,WHENCE)
7883seekdir(DIRHANDLE,POS)
7884select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7885semctl(ID,SEMNUM,CMD,ARG)
7886semget(KEY,NSEMS,SIZE,FLAGS)
7887semop(KEY,...)
7888send(SOCKET,MSG,FLAGS[,TO])
7889setgrent
7890sethostent(STAYOPEN)
7891setnetent(STAYOPEN)
7892setpgrp(PID,PGRP)
7893setpriority(WHICH,WHO,PRIORITY)
7894setprotoent(STAYOPEN)
7895setpwent
7896setservent(STAYOPEN)
7897setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7898shift[(ARRAY)]
7899shmctl(ID,CMD,ARG)
7900shmget(KEY,SIZE,FLAGS)
7901shmread(ID,VAR,POS,SIZE)
7902shmwrite(ID,STRING,POS,SIZE)
7903shutdown(SOCKET,HOW)
7904sin(EXPR)
7905sleep[(EXPR)]
7906socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7907socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7908sort [SUBROUTINE] (LIST)
7909splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7910split[(/PATTERN/[,EXPR[,LIMIT]])]
7911sprintf(FORMAT,LIST)
7912sqrt(EXPR)
7913srand(EXPR)
7914stat(EXPR|FILEHANDLE|VAR)
7915study[(SCALAR)]
7916sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7917substr(EXPR,OFFSET[,LEN])
7918symlink(OLDFILE,NEWFILE)
7919syscall(LIST)
7920sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
4ab89e7b 7921system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
f83d2997
KH
7922syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7923tell[(FILEHANDLE)]
7924telldir(DIRHANDLE)
7925time
7926times
7927tr/SEARCHLIST/REPLACEMENTLIST/cds
7928truncate(FILE|EXPR,LENGTH)
7929umask[(EXPR)]
7930undef[(EXPR)]
7931unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7932unlink(LIST)
7933unpack(TEMPLATE,EXPR)
7934unshift(ARRAY,LIST)
7935until (EXPR) { ... } EXPR until EXPR
7936utime(LIST)
7937values(%HASH)
7938vec(EXPR,OFFSET,BITS)
7939wait
7940waitpid(PID,FLAGS)
7941wantarray Returns true if the sub/eval is called in list context.
7942warn(LIST)
7943while (EXPR) { ... } EXPR while EXPR
7944write[(EXPR|FILEHANDLE)]
7945... x ... Repeat string or array.
7946x= ... Repetition assignment.
7947y/SEARCHLIST/REPLACEMENTLIST/
7948... | ... Bitwise or.
7949... || ... Logical or.
7950~ ... Unary bitwise complement.
db133cb6 7951#! OS interpreter indicator. If contains `perl', used for options, and -x.
f83d2997
KH
7952AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7953CORE:: Prefix to access builtin function if imported sub obscures it.
7954SUPER:: Prefix to lookup for a method in @ISA classes.
7955DESTROY Shorthand for `sub DESTROY {...}'.
7956... EQ ... Obsolete synonym of `eq'.
7957... GE ... Obsolete synonym of `ge'.
7958... GT ... Obsolete synonym of `gt'.
7959... LE ... Obsolete synonym of `le'.
7960... LT ... Obsolete synonym of `lt'.
7961... NE ... Obsolete synonym of `ne'.
7962abs [ EXPR ] absolute value
7963... and ... Low-precedence synonym for &&.
7964bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7965chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7966chr Converts a number to char with the same ordinal.
7967else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7968elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
83261a2f 7969exists $HASH{KEY} True if the key exists.
f83d2997
KH
7970format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7971formline PICTURE, LIST Backdoor into \"format\" processing.
7972glob EXPR Synonym of <EXPR>.
7973lc [ EXPR ] Returns lowercased EXPR.
7974lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
db133cb6 7975grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
f83d2997
KH
7976map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7977no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7978not ... Low-precedence synonym for ! - negation.
7979... or ... Low-precedence synonym for ||.
7980pos STRING Set/Get end-position of the last match over this string, see \\G.
7981quotemeta [ EXPR ] Quote regexp metacharacters.
7982qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7983readline FH Synonym of <FH>.
7984readpipe CMD Synonym of `CMD`.
7985ref [ EXPR ] Type of EXPR when dereferenced.
7986sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7987tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7988tied Returns internal object for a tied data.
7989uc [ EXPR ] Returns upcased EXPR.
7990ucfirst [ EXPR ] Returns EXPR with upcased first letter.
7991untie VAR Unlink an object from a simple Perl variable.
7992use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
7993... xor ... Low-precedence synonym for exclusive or.
d7584f0f 7994prototype \\&SUB Returns prototype of the function given a reference.
f83d2997
KH
7995=head1 Top-level heading.
7996=head2 Second-level heading.
7997=head3 Third-level heading (is there such?).
7998=over [ NUMBER ] Start list.
7999=item [ TITLE ] Start new item in the list.
8000=back End list.
8001=cut Switch from POD to Perl.
8002=pod Switch from Perl to POD.
8003")
8004
21df56d5 8005(defun cperl-switch-to-doc-buffer (&optional interactive)
f83d2997 8006 "Go to the perl documentation buffer and insert the documentation."
21df56d5 8007 (interactive "p")
f83d2997 8008 (let ((buf (get-buffer-create cperl-doc-buffer)))
21df56d5 8009 (if interactive
f83d2997
KH
8010 (switch-to-buffer-other-window buf)
8011 (set-buffer buf))
8012 (if (= (buffer-size) 0)
8013 (progn
8014 (insert (documentation-property 'cperl-short-docs
8015 'variable-documentation))
8016 (setq buffer-read-only t)))))
8017
6c389151 8018(defun cperl-beautify-regexp-piece (b e embed level)
f83d2997
KH
8019 ;; b is before the starting delimiter, e before the ending
8020 ;; e should be a marker, may be changed, but remains "correct".
e7f767c2 8021 ;; EMBED is nil if we process the whole REx.
4ab89e7b 8022 ;; The REx is guaranteed to have //x
6c389151
SM
8023 ;; LEVEL shows how many levels deep to go
8024 ;; position at enter and at leave is not defined
8025 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8c777c8d
CY
8026 (if embed
8027 (progn
8028 (goto-char b)
8029 (setq c (if (eq embed t) (current-indentation) (current-column)))
8030 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8031 (forward-char 2)
8032 (delete-char 1)
8033 (forward-char 1))
8034 ((looking-at "(\\?[^a-zA-Z]")
8035 (forward-char 3))
8036 ((looking-at "(\\?") ; (?i)
8037 (forward-char 2))
8038 (t
8039 (forward-char 1))))
8040 (goto-char (1+ b))
8041 (setq c (1- (current-column))))
8042 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
f83d2997
KH
8043 (or (looking-at "[ \t]*[\n#]")
8044 (progn
8045 (insert "\n")))
8046 (goto-char e)
8047 (beginning-of-line)
8048 (if (re-search-forward "[^ \t]" e t)
83261a2f 8049 (progn ; Something before the ending delimiter
f83d2997 8050 (goto-char e)
6c389151 8051 (delete-horizontal-space)
f83d2997 8052 (insert "\n")
4ab89e7b 8053 (cperl-make-indent c)
f83d2997
KH
8054 (set-marker e (point))))
8055 (goto-char b)
8056 (end-of-line 2)
8057 (while (< (point) (marker-position e))
8058 (beginning-of-line)
8059 (setq s (point)
8060 inline t)
8061 (skip-chars-forward " \t")
8062 (delete-region s (point))
4ab89e7b 8063 (cperl-make-indent c1)
f83d2997
KH
8064 (while (and
8065 inline
5c8b7eaf 8066 (looking-at
f83d2997
KH
8067 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8068 "\\|" ; Embedded variable
8069 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8070 "\\|" ; $ ^
8071 "[$^]"
8072 "\\|" ; simple-code simple-code*?
8073 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8074 "\\|" ; Class
8075 "\\(\\[\\)" ; 6
8076 "\\|" ; Grouping
8077 "\\((\\(\\?\\)?\\)" ; 7 8
8078 "\\|" ; |
83261a2f 8079 "\\(|\\)"))) ; 9
f83d2997
KH
8080 (goto-char (match-end 0))
8081 (setq spaces t)
8082 (cond ((match-beginning 1) ; Alphanum word + junk
8083 (forward-char -1))
8084 ((or (match-beginning 3) ; $ab[12]
8085 (and (match-beginning 5) ; X* X+ X{2,3}
8086 (eq (preceding-char) ?\{)))
8087 (forward-char -1)
8088 (forward-sexp 1))
4ab89e7b
SM
8089 ((and ; [], already syntaxified
8090 (match-beginning 6)
8091 cperl-regexp-scan
8092 cperl-use-syntax-table-text-property)
8093 (forward-char -1)
8094 (forward-sexp 1)
8095 (or (eq (preceding-char) ?\])
8096 (error "[]-group not terminated"))
8097 (re-search-forward
8098 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8099 ((match-beginning 6) ; []
8100 (setq tmp (point))
8101 (if (looking-at "\\^?\\]")
8102 (goto-char (match-end 0)))
6c389151
SM
8103 ;; XXXX POSIX classes?!
8104 (while (and (not pos)
8105 (re-search-forward "\\[:\\|\\]" e t))
8106 (if (eq (preceding-char) ?:)
8107 (or (re-search-forward ":\\]" e t)
8108 (error "[:POSIX:]-group in []-group not terminated"))
8109 (setq pos t)))
8110 (or (eq (preceding-char) ?\])
8111 (error "[]-group not terminated"))
4ab89e7b
SM
8112 (re-search-forward
8113 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8114 ((match-beginning 7) ; ()
8115 (goto-char (match-beginning 0))
6c389151
SM
8116 (setq pos (current-column))
8117 (or (eq pos c1)
f83d2997 8118 (progn
6c389151 8119 (delete-horizontal-space)
f83d2997 8120 (insert "\n")
4ab89e7b 8121 (cperl-make-indent c1)))
f83d2997
KH
8122 (setq tmp (point))
8123 (forward-sexp 1)
8124 ;; (or (forward-sexp 1)
8125 ;; (progn
8126 ;; (goto-char tmp)
8127 ;; (error "()-group not terminated")))
8128 (set-marker m (1- (point)))
8129 (set-marker m1 (point))
6c389151
SM
8130 (if (= level 1)
8131 (if (progn ; indent rigidly if multiline
a1506d29 8132 ;; In fact does not make a lot of sense, since
6c389151
SM
8133 ;; the starting position can be already lost due
8134 ;; to insertion of "\n" and " "
8135 (goto-char tmp)
8136 (search-forward "\n" m1 t))
8137 (indent-rigidly (point) m1 (- c1 pos)))
8138 (setq level (1- level))
8139 (cond
8140 ((not (match-beginning 8))
8141 (cperl-beautify-regexp-piece tmp m t level))
8142 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8143 t)
8144 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8145 (goto-char (+ 2 tmp))
8146 (forward-sexp 1)
8147 (cperl-beautify-regexp-piece (point) m t level))
8148 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8149 (goto-char (+ 3 tmp))
8150 (cperl-beautify-regexp-piece (point) m t level))
8151 (t
8152 (cperl-beautify-regexp-piece tmp m t level))))
f83d2997
KH
8153 (goto-char m1)
8154 (cond ((looking-at "[*+?]\\??")
8155 (goto-char (match-end 0)))
8156 ((eq (following-char) ?\{)
8157 (forward-sexp 1)
8158 (if (eq (following-char) ?\?)
8159 (forward-char))))
8160 (skip-chars-forward " \t")
8161 (setq spaces nil)
8162 (if (looking-at "[#\n]")
8163 (progn
8164 (or (eolp) (indent-for-comment))
8165 (beginning-of-line 2))
6c389151 8166 (delete-horizontal-space)
f83d2997
KH
8167 (insert "\n"))
8168 (end-of-line)
8169 (setq inline nil))
8170 ((match-beginning 9) ; |
8171 (forward-char -1)
8172 (setq tmp (point))
8173 (beginning-of-line)
8174 (if (re-search-forward "[^ \t]" tmp t)
8175 (progn
8176 (goto-char tmp)
6c389151 8177 (delete-horizontal-space)
f83d2997
KH
8178 (insert "\n"))
8179 ;; first at line
8180 (delete-region (point) tmp))
4ab89e7b 8181 (cperl-make-indent c)
f83d2997
KH
8182 (forward-char 1)
8183 (skip-chars-forward " \t")
8184 (setq spaces nil)
8185 (if (looking-at "[#\n]")
8186 (beginning-of-line 2)
6c389151 8187 (delete-horizontal-space)
f83d2997
KH
8188 (insert "\n"))
8189 (end-of-line)
8190 (setq inline nil)))
8191 (or (looking-at "[ \t\n]")
8192 (not spaces)
8193 (insert " "))
8194 (skip-chars-forward " \t"))
83261a2f
SM
8195 (or (looking-at "[#\n]")
8196 (error "Unknown code `%s' in a regexp"
8197 (buffer-substring (point) (1+ (point)))))
8198 (and inline (end-of-line 2)))
f83d2997
KH
8199 ;; Special-case the last line of group
8200 (if (and (>= (point) (marker-position e))
8201 (/= (current-indentation) c))
8202 (progn
83261a2f 8203 (beginning-of-line)
4ab89e7b 8204 (cperl-make-indent c)))))
f83d2997
KH
8205
8206(defun cperl-make-regexp-x ()
db133cb6 8207 ;; Returns position of the start
6c389151 8208 ;; XXX this is called too often! Need to cache the result!
f83d2997
KH
8209 (save-excursion
8210 (or cperl-use-syntax-table-text-property
5bd52f0e 8211 (error "I need to have a regexp marked!"))
f83d2997 8212 ;; Find the start
db133cb6
RS
8213 (if (looking-at "\\s|")
8214 nil ; good already
8c777c8d
CY
8215 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8216 (and (eq (preceding-char) ?q)
8217 (looking-at "\\(r\\)\\s|")))
8218 (goto-char (match-end 1))
83261a2f 8219 (re-search-backward "\\s|"))) ; Assume it is scanned already.
f83d2997
KH
8220 ;;(forward-char 1)
8221 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8222 (sub-p (eq (preceding-char) ?s)) s)
8223 (forward-sexp 1)
8224 (set-marker e (1- (point)))
8225 (setq delim (preceding-char))
8226 (if (and sub-p (eq delim (char-after (- (point) 2))))
8227 (error "Possible s/blah// - do not know how to deal with"))
8228 (if sub-p (forward-sexp 1))
5c8b7eaf 8229 (if (looking-at "\\sw*x")
f83d2997
KH
8230 (setq have-x t)
8231 (insert "x"))
8232 ;; Protect fragile " ", "#"
8233 (if have-x nil
8234 (goto-char (1+ b))
8235 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8236 (forward-char -1)
8237 (insert "\\")
8238 (forward-char 1)))
8239 b)))
8240
6c389151 8241(defun cperl-beautify-regexp (&optional deep)
f94a632a 8242 "Do it. (Experimental, may change semantics, recheck the result.)
f83d2997 8243We suppose that the regexp is scanned already."
6c389151 8244 (interactive "P")
0c602a0f 8245 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8246 (save-excursion
8247 (goto-char (cperl-make-regexp-x))
8248 (let ((b (point)) (e (make-marker)))
8249 (forward-sexp 1)
8250 (set-marker e (1- (point)))
8251 (cperl-beautify-regexp-piece b e nil deep))))
f83d2997 8252
db133cb6
RS
8253(defun cperl-regext-to-level-start ()
8254 "Goto start of an enclosing group in regexp.
f83d2997
KH
8255We suppose that the regexp is scanned already."
8256 (interactive)
db133cb6 8257 (let ((limit (cperl-make-regexp-x)) done)
f83d2997
KH
8258 (while (not done)
8259 (or (eq (following-char) ?\()
db133cb6 8260 (search-backward "(" (1+ limit) t)
f83d2997
KH
8261 (error "Cannot find `(' which starts a group"))
8262 (setq done
8263 (save-excursion
8264 (skip-chars-backward "\\")
8265 (looking-at "\\(\\\\\\\\\\)*(")))
db133cb6
RS
8266 (or done (forward-char -1)))))
8267
8268(defun cperl-contract-level ()
5bd52f0e 8269 "Find an enclosing group in regexp and contract it.
db133cb6
RS
8270\(Experimental, may change semantics, recheck the result.)
8271We suppose that the regexp is scanned already."
8272 (interactive)
6c389151 8273 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
83261a2f 8274 (cperl-regext-to-level-start)
4ab89e7b 8275 (let ((b (point)) (e (make-marker)) c)
83261a2f
SM
8276 (forward-sexp 1)
8277 (set-marker e (1- (point)))
8278 (goto-char b)
8279 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8280 (cond
8281 ((match-beginning 1) ; #-comment
8282 (or c (setq c (current-indentation)))
8283 (beginning-of-line 2) ; Skip
4ab89e7b 8284 (cperl-make-indent c))
83261a2f
SM
8285 (t
8286 (delete-char -1)
8287 (just-one-space))))))
db133cb6
RS
8288
8289(defun cperl-contract-levels ()
5bd52f0e 8290 "Find an enclosing group in regexp and contract all the kids.
db133cb6
RS
8291\(Experimental, may change semantics, recheck the result.)
8292We suppose that the regexp is scanned already."
8293 (interactive)
6c389151
SM
8294 (save-excursion
8295 (condition-case nil
8296 (cperl-regext-to-level-start)
8297 (error ; We are outside outermost group
5efe6a56
SM
8298 (goto-char (cperl-make-regexp-x))))
8299 (let ((b (point)) (e (make-marker)) s c)
8300 (forward-sexp 1)
8301 (set-marker e (1- (point)))
8302 (goto-char (1+ b))
8303 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
a1506d29 8304 (cond
6c389151
SM
8305 ((match-beginning 1) ; Skip
8306 nil)
8307 (t ; Group
8308 (cperl-contract-level)))))))
f83d2997 8309
6c389151 8310(defun cperl-beautify-level (&optional deep)
f83d2997
KH
8311 "Find an enclosing group in regexp and beautify it.
8312\(Experimental, may change semantics, recheck the result.)
8313We suppose that the regexp is scanned already."
6c389151 8314 (interactive "P")
0c602a0f 8315 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8316 (save-excursion
8317 (cperl-regext-to-level-start)
8318 (let ((b (point)) (e (make-marker)))
8319 (forward-sexp 1)
8320 (set-marker e (1- (point)))
8c777c8d 8321 (cperl-beautify-regexp-piece b e 'level deep))))
db133cb6 8322
4ab89e7b
SM
8323(defun cperl-invert-if-unless-modifiers ()
8324 "Change `B if A;' into `if (A) {B}' etc if possible.
8325\(Unfinished.)"
8c777c8d 8326 (interactive)
4ab89e7b
SM
8327 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8328 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8329 (and (= (char-syntax (preceding-char)) ?w)
8330 (forward-sexp -1))
8331 (setq pre-if (point))
8332 (cperl-backward-to-start-of-expr)
8333 (setq pre-B (point))
8334 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8335 (cperl-forward-to-end-of-expr)
8336 (setq post-A (point))
8337 (goto-char pre-if)
8338 (or (looking-at w-rex)
8339 ;; Find the position
8340 (progn (goto-char post-A)
8341 (while (and
8342 (not (looking-at w-rex))
8343 (> (point) pre-B))
8344 (forward-sexp -1))
8345 (setq pre-if (point))))
8346 (or (looking-at w-rex)
8347 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8348 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8349 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8350 ;; First, simple part: find code boundaries
8351 (forward-sexp 1)
8352 (setq post-if (point))
8353 (forward-sexp -2)
8354 (forward-sexp 1)
8355 (setq post-B (point))
8356 (cperl-backward-to-start-of-expr)
8357 (setq pre-B (point))
8358 (setq B (buffer-substring pre-B post-B))
8359 (goto-char pre-if)
8360 (forward-sexp 2)
8361 (forward-sexp -1)
8362 ;; May be after $, @, $# etc of a variable
8363 (skip-chars-backward "$@%#")
8364 (setq pre-A (point))
8365 (cperl-forward-to-end-of-expr)
8366 (setq post-A (point))
8367 (setq A (buffer-substring pre-A post-A))
8368 ;; Now modify (from end, to not break the stuff)
8369 (skip-chars-forward " \t;")
8370 (delete-region pre-A (point)) ; we move to pre-A
8371 (insert "\n" B ";\n}")
8372 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8373 (delete-region pre-if post-if)
8374 (delete-region pre-B post-B)
8375 (goto-char pre-B)
8376 (insert if-string " (" A ") {")
8377 (setq post-B (point))
8378 (if (looking-at "[ \t]+$")
8379 (delete-horizontal-space)
8380 (if (looking-at "[ \t]*#")
8381 (cperl-indent-for-comment)
8382 (just-one-space)))
8383 (forward-line 1)
8384 (if (looking-at "[ \t]*$")
8385 (progn ; delete line
8386 (delete-horizontal-space)
8387 (delete-region (point) (1+ (point)))))
8388 (cperl-indent-line)
8389 (goto-char (1- post-B))
8390 (forward-sexp 1)
8391 (cperl-indent-line)
8392 (goto-char pre-B)))
8393
db133cb6 8394(defun cperl-invert-if-unless ()
4ab89e7b
SM
8395 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8396If the cursor is not on the leading keyword of the BLOCK flavor of
8397construct, will assume it is the STATEMENT flavor, so will try to find
8398the appropriate statement modifier."
db133cb6 8399 (interactive)
4ab89e7b
SM
8400 (and (= (char-syntax (preceding-char)) ?w)
8401 (forward-sexp -1))
6c389151 8402 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
4ab89e7b
SM
8403 (let ((pre-if (point))
8404 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8405 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
db133cb6 8406 (forward-sexp 2)
4ab89e7b 8407 (setq post-A (point))
db133cb6 8408 (forward-sexp -1)
4ab89e7b
SM
8409 (setq pre-A (point))
8410 (setq is-block (and (eq (following-char) ?\( )
8411 (save-excursion
8412 (condition-case nil
8413 (progn
8414 (forward-sexp 2)
8415 (forward-sexp -1)
8416 (eq (following-char) ?\{ ))
8417 (error nil)))))
8418 (if is-block
db133cb6 8419 (progn
4ab89e7b 8420 (goto-char post-A)
db133cb6 8421 (forward-sexp 1)
4ab89e7b 8422 (setq post-B (point))
db133cb6 8423 (forward-sexp -1)
4ab89e7b 8424 (setq pre-B (point))
db133cb6
RS
8425 (if (and (eq (following-char) ?\{ )
8426 (progn
4ab89e7b 8427 (cperl-backward-to-noncomment post-A)
db133cb6
RS
8428 (eq (preceding-char) ?\) )))
8429 (if (condition-case nil
8430 (progn
4ab89e7b 8431 (goto-char post-B)
db133cb6
RS
8432 (forward-sexp 1)
8433 (forward-sexp -1)
8434 (looking-at "\\<els\\(e\\|if\\)\\>"))
8435 (error nil))
8436 (error
4ab89e7b
SM
8437 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8438 (goto-char (1- post-B))
8439 (cperl-backward-to-noncomment pre-B)
db133cb6
RS
8440 (if (eq (preceding-char) ?\;)
8441 (forward-char -1))
4ab89e7b
SM
8442 (setq end-B-code (point))
8443 (goto-char pre-B)
8444 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
db133cb6 8445 (setq p (match-beginning 0)
4ab89e7b
SM
8446 A (buffer-substring p (match-end 0))
8447 state (parse-partial-sexp pre-B p))
5c8b7eaf 8448 (or (nth 3 state)
db133cb6
RS
8449 (nth 4 state)
8450 (nth 5 state)
4ab89e7b 8451 (error "`%s' inside `%s' BLOCK" A if-string))
db133cb6
RS
8452 (goto-char (match-end 0)))
8453 ;; Finally got it
4ab89e7b 8454 (goto-char (1+ pre-B))
db133cb6 8455 (skip-chars-forward " \t\n")
4ab89e7b
SM
8456 (setq B (buffer-substring (point) end-B-code))
8457 (goto-char end-B-code)
db133cb6
RS
8458 (or (looking-at ";?[ \t\n]*}")
8459 (progn
8460 (skip-chars-forward "; \t\n")
4ab89e7b
SM
8461 (setq B-comment
8462 (buffer-substring (point) (1- post-B)))))
8463 (and (equal B "")
8464 (setq B "1"))
8465 (goto-char (1- post-A))
8466 (cperl-backward-to-noncomment pre-A)
db133cb6 8467 (or (looking-at "[ \t\n]*)")
4ab89e7b 8468 (goto-char (1- post-A)))
db133cb6 8469 (setq p (point))
4ab89e7b 8470 (goto-char (1+ pre-A))
db133cb6 8471 (skip-chars-forward " \t\n")
4ab89e7b
SM
8472 (setq A (buffer-substring (point) p))
8473 (delete-region pre-B post-B)
8474 (delete-region pre-A post-A)
8475 (goto-char pre-if)
8476 (insert B " ")
8477 (and B-comment (insert B-comment " "))
db133cb6
RS
8478 (just-one-space)
8479 (forward-word 1)
4ab89e7b
SM
8480 (setq pre-A (point))
8481 (insert " " A ";")
6c389151 8482 (delete-horizontal-space)
4ab89e7b
SM
8483 (setq post-B (point))
8484 (if (looking-at "#")
8485 (indent-for-comment))
8486 (goto-char post-B)
db133cb6
RS
8487 (forward-char -1)
8488 (delete-horizontal-space)
4ab89e7b 8489 (goto-char pre-A)
db133cb6 8490 (just-one-space)
4ab89e7b
SM
8491 (goto-char pre-if)
8492 (setq pre-A (set-marker (make-marker) pre-A))
8493 (while (<= (point) (marker-position pre-A))
8494 (cperl-indent-line)
8495 (forward-line 1))
8496 (goto-char (marker-position pre-A))
8497 (if B-comment
8498 (progn
8499 (forward-line -1)
8500 (indent-for-comment)
8501 (goto-char (marker-position pre-A)))))
8502 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8503 ;; (error "`%s' not with an (EXPR)" if-string)
8504 (forward-sexp -1)
8505 (cperl-invert-if-unless-modifiers)))
8506 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8507 (cperl-invert-if-unless-modifiers)))
db133cb6 8508
5bd52f0e 8509;;; By Anthony Foiani <afoiani@uswest.com>
b7ec9e59
RS
8510;;; Getting help on modules in C-h f ?
8511;;; This is a modified version of `man'.
8512;;; Need to teach it how to lookup functions
4ab89e7b 8513;;;###autoload
b7ec9e59
RS
8514(defun cperl-perldoc (word)
8515 "Run `perldoc' on WORD."
8516 (interactive
8517 (list (let* ((default-entry (cperl-word-at-point))
8518 (input (read-string
8519 (format "perldoc entry%s: "
8520 (if (string= default-entry "")
8521 ""
8522 (format " (default %s)" default-entry))))))
8523 (if (string= input "")
8524 (if (string= default-entry "")
8525 (error "No perldoc args given")
8526 default-entry)
8527 input))))
a8e1e57f 8528 (require 'man)
f739b53b
SM
8529 (let* ((case-fold-search nil)
8530 (is-func (and
b7ec9e59
RS
8531 (string-match "^[a-z]+$" word)
8532 (string-match (concat "^" word "\\>")
8533 (documentation-property
8534 'cperl-short-docs
8535 'variable-documentation))))
8c777c8d 8536 (Man-switches "")
b7ec9e59 8537 (manual-program (if is-func "perldoc -f" "perldoc")))
f739b53b 8538 (cond
6546555e 8539 ((featurep 'xemacs)
f739b53b
SM
8540 (let ((Manual-program "perldoc")
8541 (Manual-switches (if is-func (list "-f"))))
8542 (manual-entry word)))
8543 (t
8544 (Man-getpage-in-background word)))))
b7ec9e59 8545
4ab89e7b 8546;;;###autoload
b7ec9e59
RS
8547(defun cperl-perldoc-at-point ()
8548 "Run a `perldoc' on the word around point."
8549 (interactive)
8550 (cperl-perldoc (cperl-word-at-point)))
8551
8552(defcustom pod2man-program "pod2man"
8553 "*File name for `pod2man'."
8554 :type 'file
8555 :group 'cperl)
8556
5bd52f0e 8557;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
b7ec9e59
RS
8558(defun cperl-pod-to-manpage ()
8559 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8560 (interactive)
8561 (require 'man)
8562 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8563 (bufname (concat "Man " buffer-file-name))
8564 (buffer (generate-new-buffer bufname)))
9a529312 8565 (with-current-buffer buffer
b7ec9e59
RS
8566 (let ((process-environment (copy-sequence process-environment)))
8567 ;; Prevent any attempt to use display terminal fanciness.
8568 (setenv "TERM" "dumb")
8569 (set-process-sentinel
8570 (start-process pod2man-program buffer "sh" "-c"
8571 (format (cperl-pod2man-build-command) pod2man-args))
8572 'Man-bgproc-sentinel)))))
8573
f739b53b
SM
8574;;; Updated version by him too
8575(defun cperl-build-manpage ()
8576 "Create a virtual manpage in Emacs from the POD in the file."
8577 (interactive)
8578 (require 'man)
8579 (cond
6546555e 8580 ((featurep 'xemacs)
f739b53b
SM
8581 (let ((Manual-program "perldoc"))
8582 (manual-entry buffer-file-name)))
8583 (t
8c777c8d
CY
8584 (let* ((manual-program "perldoc")
8585 (Man-switches ""))
f739b53b
SM
8586 (Man-getpage-in-background buffer-file-name)))))
8587
b7ec9e59
RS
8588(defun cperl-pod2man-build-command ()
8589 "Builds the entire background manpage and cleaning command."
8590 (let ((command (concat pod2man-program " %s 2>/dev/null"))
4ab89e7b 8591 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
b7ec9e59
RS
8592 (while (and flist (car flist))
8593 (let ((pcom (car (car flist)))
8594 (pargs (cdr (car flist))))
8595 (setq command
8596 (concat command " | " pcom " "
8597 (mapconcat '(lambda (phrase)
8598 (if (not (stringp phrase))
8599 (error "Malformed Man-filter-list"))
8600 phrase)
8601 pargs " ")))
8602 (setq flist (cdr flist))))
8603 command))
db133cb6 8604
4ab89e7b
SM
8605
8606(defun cperl-next-interpolated-REx-1 ()
8607 "Move point to next REx which has interpolated parts without //o.
8608Skips RExes consisting of one interpolated variable.
8609
8610Note that skipped RExen are not performance hits."
8611 (interactive "")
8612 (cperl-next-interpolated-REx 1))
8613
8614(defun cperl-next-interpolated-REx-0 ()
8615 "Move point to next REx which has interpolated parts without //o."
8616 (interactive "")
8617 (cperl-next-interpolated-REx 0))
8618
8619(defun cperl-next-interpolated-REx (&optional skip beg limit)
8620 "Move point to next REx which has interpolated parts.
8621SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8622point and the limit of search (default to point and end of buffer).
8623
8624SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8625semantic may be used as a numeric argument.
8626
8627Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8628a result of qr//, this is not a performance hit), t for the rest."
8629 (interactive "P")
8630 (if (numberp skip) (setq skip (list 0 skip)))
8631 (or beg (setq beg (point)))
8632 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8633 (let (pp)
8634 (and (eq (get-text-property beg 'syntax-type) 'string)
8635 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8636 (cperl-map-pods-heres
8637 (function (lambda (s e p)
8638 (if (memq (get-text-property s 'REx-interpolated) skip)
8639 t
8640 (setq pp s)
8641 nil))) ; nil stops
8642 'REx-interpolated beg limit)
8643 (if pp (goto-char pp)
8644 (message "No more interpolated REx"))))
8645
8646;;; Initial version contributed by Trey Belew
8647(defun cperl-here-doc-spell (&optional beg end)
8648 "Spell-check HERE-documents in the Perl buffer.
8649If a region is highlighted, restricts to the region."
8650 (interactive "")
8651 (cperl-pod-spell t beg end))
8652
8653(defun cperl-pod-spell (&optional do-heres beg end)
8654 "Spell-check POD documentation.
8655If invoked with prefix argument, will do HERE-DOCs instead.
8656If a region is highlighted, restricts to the region."
8657 (interactive "P")
8658 (save-excursion
8659 (let (beg end)
8660 (if (cperl-mark-active)
8661 (setq beg (min (mark) (point))
8662 end (max (mark) (point)))
8663 (setq beg (point-min)
8664 end (point-max)))
8665 (cperl-map-pods-heres (function
8666 (lambda (s e p)
8667 (if do-heres
8668 (setq e (save-excursion
8669 (goto-char e)
8670 (forward-line -1)
8671 (point))))
8672 (ispell-region s e)
8673 t))
8674 (if do-heres 'here-doc-group 'in-pod)
8675 beg end))))
8676
8677(defun cperl-map-pods-heres (func &optional prop s end)
8678 "Executes a function over regions of pods or here-documents.
8679PROP is the text-property to search for; default to `in-pod'. Stop when
8680function returns nil."
8681 (let (pos posend has-prop (cont t))
8682 (or prop (setq prop 'in-pod))
8683 (or s (setq s (point-min)))
8684 (or end (setq end (point-max)))
8685 (cperl-update-syntaxification end end)
8686 (save-excursion
8687 (goto-char (setq pos s))
8688 (while (and cont (< pos end))
8689 (setq has-prop (get-text-property pos prop))
8690 (setq posend (next-single-property-change pos prop nil end))
8691 (and has-prop
8692 (setq cont (funcall func pos posend prop)))
8693 (setq pos posend)))))
8694
8695;;; Based on code by Masatake YAMATO:
8696(defun cperl-get-here-doc-region (&optional pos pod)
8697 "Return HERE document region around the point.
8698Return nil if the point is not in a HERE document region. If POD is non-nil,
8699will return a POD section if point is in a POD section."
8700 (or pos (setq pos (point)))
8701 (cperl-update-syntaxification pos pos)
8702 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8703 (and pod
8704 (eq 'pod (get-text-property pos 'syntax-type))))
8705 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8706 (e (next-single-property-change pos 'syntax-type)))
8707 (cons b (or e (point-max))))))
8708
8709(defun cperl-narrow-to-here-doc (&optional pos)
8710 "Narrows editing region to the HERE-DOC at POS.
8711POS defaults to the point."
8712 (interactive "d")
8713 (or pos (setq pos (point)))
8714 (let ((p (cperl-get-here-doc-region pos)))
8715 (or p (error "Not inside a HERE document"))
8716 (narrow-to-region (car p) (cdr p))
8717 (message
8718 "When you are finished with narrow editing, type C-x n w")))
8719
8720(defun cperl-select-this-pod-or-here-doc (&optional pos)
8721 "Select the HERE-DOC (or POD section) at POS.
8722POS defaults to the point."
8723 (interactive "d")
8724 (let ((p (cperl-get-here-doc-region pos t)))
8725 (if p
8726 (progn
8727 (goto-char (car p))
8728 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8729 (message "I do not think POS is in POD or a HERE-doc..."))))
8730
8731(defun cperl-facemenu-add-face-function (face end)
8732 "A callback to process user-initiated font-change requests.
8733Translates `bold', `italic', and `bold-italic' requests to insertion of
8734corresponding POD directives, and `underline' to C<> POD directive.
8735
8736Such requests are usually bound to M-o LETTER."
8737 (or (get-text-property (point) 'in-pod)
8738 (error "Faces can only be set within POD"))
8739 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8740 (cdr (or (assq face '((bold . "B<")
8741 (italic . "I<")
8742 (bold-italic . "B<I<")
8743 (underline . "C<")))
8744 (error "Face %s not configured for cperl-mode"
8745 face))))
8746\f
8747(defun cperl-time-fontification (&optional l step lim)
8748 "Times how long it takes to do incremental fontification in a region.
8749L is the line to start at, STEP is the number of lines to skip when
8750doing next incremental fontification, LIM is the maximal number of
8751incremental fontification to perform. Messages are accumulated in
8752*Messages* buffer.
8753
8754May be used for pinpointing which construct slows down buffer fontification:
8755start with default arguments, then refine the slowdown regions."
8756 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8757 (or l (setq l 1))
8758 (or step (setq step 500))
8759 (or lim (setq lim 40))
8760 (let* ((timems (function (lambda ()
8761 (let ((tt (current-time)))
8762 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8763 (tt (funcall timems)) (c 0) delta tot)
47e83968
GM
8764 (goto-char (point-min))
8765 (forward-line (1- l))
4ab89e7b
SM
8766 (cperl-mode)
8767 (setq tot (- (- tt (setq tt (funcall timems)))))
8768 (message "cperl-mode at %s: %s" l tot)
8769 (while (and (< c lim) (not (eobp)))
8770 (forward-line step)
8771 (setq l (+ l step))
8772 (setq c (1+ c))
8773 (cperl-update-syntaxification (point) (point))
8774 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8775 (message "to %s:%6s,%7s" l delta tot))
8776 tot))
8777
6546555e
DN
8778(defvar font-lock-cache-position)
8779
4ab89e7b
SM
8780(defun cperl-emulate-lazy-lock (&optional window-size)
8781 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8782Start fontifying the buffer from the start (or end) using the given
8783WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8784goes backwards; default is -50. This function is not CPerl-specific; it
8785may be used to debug problems with delayed incremental fontification."
8786 (interactive
8787 "nSize of window for incremental fontification, negative goes backwards: ")
8788 (or window-size (setq window-size -50))
8789 (let ((pos (if (> window-size 0)
8790 (point-min)
8791 (point-max)))
8792 p)
8793 (goto-char pos)
8794 (normal-mode)
8795 ;; Why needed??? With older font-locks???
8796 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8797 (while (if (> window-size 0)
8798 (< pos (point-max))
8799 (> pos (point-min)))
8800 (setq p (progn
8801 (forward-line window-size)
8802 (point)))
8803 (font-lock-fontify-region (min p pos) (max p pos))
8804 (setq pos p))))
8805
8806\f
db133cb6 8807(defun cperl-lazy-install ()) ; Avoid a warning
f739b53b 8808(defun cperl-lazy-unstall ()) ; Avoid a warning
f83d2997
KH
8809
8810(if (fboundp 'run-with-idle-timer)
8811 (progn
8812 (defvar cperl-help-shown nil
8813 "Non-nil means that the help was already shown now.")
8814
8815 (defvar cperl-lazy-installed nil
8816 "Non-nil means that the lazy-help handlers are installed now.")
8817
8818 (defun cperl-lazy-install ()
f739b53b
SM
8819 "Switches on Auto-Help on Perl constructs (put in the message area).
8820Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997 8821 (interactive)
4ab89e7b 8822 (make-local-variable 'cperl-help-shown)
f83d2997
KH
8823 (if (and (cperl-val 'cperl-lazy-help-time)
8824 (not cperl-lazy-installed))
8825 (progn
8826 (add-hook 'post-command-hook 'cperl-lazy-hook)
5c8b7eaf
SS
8827 (run-with-idle-timer
8828 (cperl-val 'cperl-lazy-help-time 1000000 5)
8829 t
f83d2997
KH
8830 'cperl-get-help-defer)
8831 (setq cperl-lazy-installed t))))
8832
8833 (defun cperl-lazy-unstall ()
f739b53b
SM
8834 "Switches off Auto-Help on Perl constructs (put in the message area).
8835Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997
KH
8836 (interactive)
8837 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8838 (cancel-function-timers 'cperl-get-help-defer)
8839 (setq cperl-lazy-installed nil))
8840
8841 (defun cperl-lazy-hook ()
8842 (setq cperl-help-shown nil))
8843
8844 (defun cperl-get-help-defer ()
83261a2f 8845 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
f83d2997
KH
8846 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8847 (cperl-get-help)
8848 (setq cperl-help-shown t))))
8849 (cperl-lazy-install)))
8850
db133cb6
RS
8851
8852;;; Plug for wrong font-lock:
8853
8854(defun cperl-font-lock-unfontify-region-function (beg end)
4ab89e7b
SM
8855 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8856 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8857 before-change-functions after-change-functions
8858 deactivate-mark buffer-file-name buffer-file-truename)
8859 (remove-text-properties beg end '(face nil))
8860 (if (and (not modified) (buffer-modified-p))
8861 (set-buffer-modified-p nil))))
8862
8863(defun cperl-font-lock-fontify-region-function (beg end loudly)
8864 "Extends the region to safe positions, then calls the default function.
8865Newer `font-lock's can do it themselves.
8866We unwind only as far as needed for fontification. Syntaxification may
8867do extra unwind via `cperl-unwind-to-safe'."
8868 (save-excursion
8869 (goto-char beg)
8870 (while (and beg
8871 (progn
8872 (beginning-of-line)
8873 (eq (get-text-property (setq beg (point)) 'syntax-type)
8874 'multiline)))
8875 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8876 (goto-char beg)))
8877 (setq beg (point))
8878 (goto-char end)
8879 (while (and end
8880 (progn
8881 (or (bolp) (condition-case nil
8882 (forward-line 1)
8883 (error nil)))
8884 (eq (get-text-property (setq end (point)) 'syntax-type)
8885 'multiline)))
8886 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8887 (goto-char end))
8888 (setq end (point)))
8889 (font-lock-default-fontify-region beg end loudly))
db133cb6
RS
8890
8891(defvar cperl-d-l nil)
8892(defun cperl-fontify-syntaxically (end)
5bd52f0e 8893 ;; Some vars for debugging only
6c389151 8894 ;; (message "Syntaxifying...")
4ab89e7b 8895 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
83261a2f 8896 (istate (car cperl-syntax-state))
4ab89e7b
SM
8897 start from-start edebug-backtrace-buffer)
8898 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8899 (progn
8900 (require 'edebug)
8901 (let ((f 'edebug-backtrace))
8902 (funcall f)))) ; Avoid compile-time warning
db133cb6 8903 (or cperl-syntax-done-to
4ab89e7b
SM
8904 (setq cperl-syntax-done-to (point-min)
8905 from-start t))
8906 (setq start (if (and cperl-hook-after-change
8907 (not from-start))
8908 cperl-syntax-done-to ; Fontify without change; ignore start
8909 ;; Need to forget what is after `start'
8910 (min cperl-syntax-done-to (point))))
8911 (goto-char start)
8912 (beginning-of-line)
8913 (setq start (point))
8914 (and cperl-syntaxify-unwind
8915 (setq end (cperl-unwind-to-safe t end)
8916 start (point)))
db133cb6
RS
8917 (and (> end start)
8918 (setq cperl-syntax-done-to start) ; In case what follows fails
8919 (cperl-find-pods-heres start end t nil t))
4ab89e7b
SM
8920 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8921 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8922 dbg iend start end idone cperl-syntax-done-to
5c8b7eaf 8923 istate (car cperl-syntax-state))) ; For debugging
83261a2f 8924 nil)) ; Do not iterate
db133cb6 8925
5bd52f0e 8926(defun cperl-fontify-update (end)
4ab89e7b
SM
8927 (let ((pos (point-min)) prop posend)
8928 (setq end (point-max))
5bd52f0e 8929 (while (< pos end)
4ab89e7b
SM
8930 (setq prop (get-text-property pos 'cperl-postpone)
8931 posend (next-single-property-change pos 'cperl-postpone nil end))
5bd52f0e
RS
8932 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8933 (setq pos posend)))
83261a2f 8934 nil) ; Do not iterate
5bd52f0e 8935
4ab89e7b
SM
8936(defun cperl-fontify-update-bad (end)
8937 ;; Since fontification happens with different region than syntaxification,
8938 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8939 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8940 (if prop
8941 (setq pos (or (cperl-beginning-of-property
8942 (cperl-1+ pos) 'cperl-postpone)
8943 (point-min))))
8944 (while (< pos end)
8945 (setq posend (next-single-property-change pos 'cperl-postpone))
8946 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8947 (setq pos posend)
8948 (setq prop (get-text-property pos 'cperl-postpone))))
8949 nil) ; Do not iterate
8950
8951;; Called when any modification is made to buffer text.
8952(defun cperl-after-change-function (beg end old-len)
8953 ;; We should have been informed about changes by `font-lock'. Since it
8954 ;; does not inform as which calls are defered, do it ourselves
8955 (if cperl-syntax-done-to
8956 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8957
5bd52f0e
RS
8958(defun cperl-update-syntaxification (from to)
8959 (if (and cperl-use-syntax-table-text-property
8960 cperl-syntaxify-by-font-lock
8961 (or (null cperl-syntax-done-to)
8962 (< cperl-syntax-done-to to)))
8963 (progn
8964 (save-excursion
8965 (goto-char from)
8966 (cperl-fontify-syntaxically to)))))
8967
5c8b7eaf 8968(defvar cperl-version
8c777c8d 8969 (let ((v "Revision: 6.2"))
5bd52f0e
RS
8970 (string-match ":\\s *\\([0-9.]+\\)" v)
8971 (substring v (match-beginning 1) (match-end 1)))
8972 "Version of IZ-supported CPerl package this file is based on.")
8973
40ab7974
JB
8974(defun cperl-mode-unload-function ()
8975 "Unload the Cperl mode library."
8976 (let ((new-mode (if (eq (symbol-function 'perl-mode) 'cperl-mode)
8977 'fundamental-mode
8978 'perl-mode)))
8979 (dolist (buf (buffer-list))
8980 (with-current-buffer buf
8981 (when (eq major-mode 'cperl-mode)
8982 (funcall new-mode)))))
8983 ;; continue standard unloading
8984 nil)
8985
f83d2997
KH
8986(provide 'cperl-mode)
8987
8988;;; cperl-mode.el ends here