Remove debug fprintf.
[bpt/emacs.git] / lisp / progmodes / cperl-mode.el
CommitLineData
f83d2997
KH
1;;; cperl-mode.el --- Perl code editing commands for Emacs
2
034babe1 3;; Copyright (C) 1985, 1986, 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
d7a0267c 4;; 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
f83d2997
KH
5;; Free Software Foundation, Inc.
6
7;; Author: Ilya Zakharevich and Bob Olson
4ab89e7b 8;; Maintainer: Ilya Zakharevich <ilyaz@cpan.org>
f83d2997
KH
9;; Keywords: languages, Perl
10
11;; This file is part of GNU Emacs.
12
13;; GNU Emacs is free software; you can redistribute it and/or modify
14;; it under the terms of the GNU General Public License as published by
1a484753 15;; the Free Software Foundation; either version 3, or (at your option)
f83d2997
KH
16;; any later version.
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
24;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
25;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26;; Boston, MA 02110-1301, USA.
f83d2997 27
4ab89e7b 28;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
f83d2997
KH
29
30;;; Commentary:
31
83261a2f
SM
32;; You can either fine-tune the bells and whistles of this mode or
33;; bulk enable them by putting
f83d2997
KH
34
35;; (setq cperl-hairy t)
36
83261a2f
SM
37;; in your .emacs file. (Emacs rulers do not consider it politically
38;; correct to make whistles enabled by default.)
f83d2997 39
83261a2f
SM
40;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
41;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
15ca5699 42;; `cperl-praise', `cperl-speed'. <<<<<<
f83d2997 43
83261a2f
SM
44;; The mode information (on C-h m) provides some customization help.
45;; If you use font-lock feature of this mode, it is advisable to use
46;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
f83d2997 47
83261a2f
SM
48;; Faces used now: three faces for first-class and second-class keywords
49;; and control flow words, one for each: comments, string, labels,
50;; functions definitions and packages, arrays, hashes, and variable
51;; definitions. If you do not see all these faces, your font-lock does
52;; not define them, so you need to define them manually.
f83d2997 53
83261a2f
SM
54;; This mode supports font-lock, imenu and mode-compile. In the
55;; hairy version font-lock is on, but you should activate imenu
56;; yourself (note that mode-compile is not standard yet). Well, you
57;; can use imenu from keyboard anyway (M-x imenu), but it is better
58;; to bind it like that:
f83d2997
KH
59
60;; (define-key global-map [M-S-down-mouse-3] 'imenu)
61
83261a2f
SM
62;;; Font lock bugs as of v4.32:
63
64;; The following kinds of Perl code erroneously start strings:
65;; \$` \$' \$"
66;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
67;; likewise with m, tr, y, q, qX instead of s
68
f83d2997 69;;; Code:
4ab89e7b 70\f
b5b0cb34
JB
71(defvar vc-rcs-header)
72(defvar vc-sccs-header)
73
80585273 74(eval-when-compile
4ab89e7b
SM
75 (condition-case nil
76 (require 'custom)
77 (error nil))
78 (condition-case nil
79 (require 'man)
80 (error nil))
81 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
82 (defvar cperl-can-font-lock
83 (or cperl-xemacs-p
84 (and (boundp 'emacs-major-version)
85 (or window-system
86 (> emacs-major-version 20)))))
87 (if cperl-can-font-lock
88 (require 'font-lock))
89 (defvar msb-menu-cond)
90 (defvar gud-perldb-history)
91 (defvar font-lock-background-mode) ; not in Emacs
92 (defvar font-lock-display-type) ; ditto
93 (defvar paren-backwards-message) ; Not in newer XEmacs?
94 (or (fboundp 'defgroup)
95 (defmacro defgroup (name val doc &rest arr)
96 nil))
97 (or (fboundp 'custom-declare-variable)
98 (defmacro defcustom (name val doc &rest arr)
99 (` (defvar (, name) (, val) (, doc)))))
100 (or (and (fboundp 'custom-declare-variable)
101 (string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
102 (defmacro defface (&rest arr)
103 nil))
104 ;; Avoid warning (tmp definitions)
105 (or (fboundp 'x-color-defined-p)
106 (defmacro x-color-defined-p (col)
107 (cond ((fboundp 'color-defined-p) (` (color-defined-p (, col))))
108 ;; XEmacs >= 19.12
109 ((fboundp 'valid-color-name-p) (` (valid-color-name-p (, col))))
110 ;; XEmacs 19.11
111 ((fboundp 'x-valid-color-name-p) (` (x-valid-color-name-p (, col))))
112 (t '(error "Cannot implement color-defined-p")))))
113 (defmacro cperl-is-face (arg) ; Takes quoted arg
114 (cond ((fboundp 'find-face)
115 (` (find-face (, arg))))
116 (;;(and (fboundp 'face-list)
117 ;; (face-list))
118 (fboundp 'face-list)
119 (` (member (, arg) (and (fboundp 'face-list)
120 (face-list)))))
121 (t
122 (` (boundp (, arg))))))
123 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
124 (cond ((fboundp 'make-face)
125 (` (make-face (quote (, arg)))))
126 (t
127 (` (defvar (, arg) (quote (, arg)) (, descr))))))
128 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
129 (` (progn
130 (or (cperl-is-face (quote (, arg)))
131 (cperl-make-face (, arg) (, descr)))
132 (or (boundp (quote (, arg))) ; We use unquoted variants too
133 (defvar (, arg) (quote (, arg)) (, descr))))))
134 (if cperl-xemacs-p
135 (defmacro cperl-etags-snarf-tag (file line)
136 (` (progn
137 (beginning-of-line 2)
138 (list (, file) (, line)))))
139 (defmacro cperl-etags-snarf-tag (file line)
140 (` (etags-snarf-tag))))
141 (if cperl-xemacs-p
142 (defmacro cperl-etags-goto-tag-location (elt)
143 (`;;(progn
144 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
145 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
146 ;; Probably will not work due to some save-excursion???
147 ;; Or save-file-position?
148 ;; (message "Did I get to line %s?" (elt (, elt) 1))
149 (goto-line (string-to-int (elt (, elt) 1)))))
150 ;;)
151 (defmacro cperl-etags-goto-tag-location (elt)
152 (` (etags-goto-tag-location (, elt))))))
5bd52f0e 153
83261a2f
SM
154(defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
155
156(defvar cperl-can-font-lock
157 (or cperl-xemacs-p
158 (and (boundp 'emacs-major-version)
159 (or window-system
160 (> emacs-major-version 20)))))
161
5bd52f0e
RS
162(defun cperl-choose-color (&rest list)
163 (let (answer)
164 (while list
165 (or answer
166 (if (or (x-color-defined-p (car list))
167 (null (cdr list)))
168 (setq answer (car list))))
169 (setq list (cdr list)))
170 answer))
171
ccc3ce39
SE
172(defgroup cperl nil
173 "Major mode for editing Perl code."
174 :prefix "cperl-"
db133cb6
RS
175 :group 'languages
176 :version "20.3")
177
178(defgroup cperl-indentation-details nil
179 "Indentation."
180 :prefix "cperl-"
181 :group 'cperl)
182
183(defgroup cperl-affected-by-hairy nil
184 "Variables affected by `cperl-hairy'."
185 :prefix "cperl-"
186 :group 'cperl)
187
188(defgroup cperl-autoinsert-details nil
189 "Auto-insert tuneup."
190 :prefix "cperl-"
191 :group 'cperl)
192
193(defgroup cperl-faces nil
194 "Fontification colors."
8ec3bce0 195 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
db133cb6
RS
196 :prefix "cperl-"
197 :group 'cperl)
198
199(defgroup cperl-speed nil
200 "Speed vs. validity tuneup."
201 :prefix "cperl-"
202 :group 'cperl)
203
204(defgroup cperl-help-system nil
205 "Help system tuneup."
206 :prefix "cperl-"
207 :group 'cperl)
ccc3ce39 208
f83d2997 209\f
ccc3ce39 210(defcustom cperl-extra-newline-before-brace nil
f83d2997
KH
211 "*Non-nil means that if, elsif, while, until, else, for, foreach
212and do constructs look like:
213
214 if ()
215 {
216 }
217
218instead of:
219
220 if () {
83261a2f 221 }"
ccc3ce39 222 :type 'boolean
db133cb6
RS
223 :group 'cperl-autoinsert-details)
224
5c8b7eaf 225(defcustom cperl-extra-newline-before-brace-multiline
db133cb6
RS
226 cperl-extra-newline-before-brace
227 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
228for constructs with multiline if/unless/while/until/for/foreach condition."
229 :type 'boolean
230 :group 'cperl-autoinsert-details)
ccc3ce39
SE
231
232(defcustom cperl-indent-level 2
233 "*Indentation of CPerl statements with respect to containing block."
234 :type 'integer
db133cb6 235 :group 'cperl-indentation-details)
80382c24 236(put 'cperl-indent-level 'safe-local-variable 'integerp)
f83d2997 237
ccc3ce39 238(defcustom cperl-lineup-step nil
f83d2997 239 "*`cperl-lineup' will always lineup at multiple of this number.
029cb4d5 240If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 241 :type '(choice (const nil) integer)
db133cb6
RS
242 :group 'cperl-indentation-details)
243
ccc3ce39 244(defcustom cperl-brace-imaginary-offset 0
f83d2997
KH
245 "*Imagined indentation of a Perl open brace that actually follows a statement.
246An open brace following other text is treated as if it were this far
ccc3ce39
SE
247to the right of the start of its line."
248 :type 'integer
db133cb6 249 :group 'cperl-indentation-details)
ccc3ce39
SE
250
251(defcustom cperl-brace-offset 0
252 "*Extra indentation for braces, compared with other text in same context."
253 :type 'integer
db133cb6 254 :group 'cperl-indentation-details)
ccc3ce39
SE
255(defcustom cperl-label-offset -2
256 "*Offset of CPerl label lines relative to usual indentation."
257 :type 'integer
db133cb6 258 :group 'cperl-indentation-details)
ccc3ce39
SE
259(defcustom cperl-min-label-indent 1
260 "*Minimal offset of CPerl label lines."
261 :type 'integer
db133cb6 262 :group 'cperl-indentation-details)
ccc3ce39
SE
263(defcustom cperl-continued-statement-offset 2
264 "*Extra indent for lines not starting new statements."
265 :type 'integer
db133cb6 266 :group 'cperl-indentation-details)
ccc3ce39 267(defcustom cperl-continued-brace-offset 0
f83d2997 268 "*Extra indent for substatements that start with open-braces.
ccc3ce39
SE
269This is in addition to cperl-continued-statement-offset."
270 :type 'integer
db133cb6 271 :group 'cperl-indentation-details)
ccc3ce39
SE
272(defcustom cperl-close-paren-offset -1
273 "*Extra indent for substatements that start with close-parenthesis."
274 :type 'integer
db133cb6 275 :group 'cperl-indentation-details)
ccc3ce39 276
4ab89e7b
SM
277(defcustom cperl-indent-wrt-brace t
278 "*Non-nil means indent statements in if/etc block relative brace, not if/etc.
279Versions 5.2 ... 5.20 behaved as if this were `nil'."
280 :type 'boolean
281 :group 'cperl-indentation-details)
282
ccc3ce39 283(defcustom cperl-auto-newline nil
f83d2997
KH
284 "*Non-nil means automatically newline before and after braces,
285and after colons and semicolons, inserted in CPerl code. The following
286\\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf 287Insertion after colons requires both this variable and
ccc3ce39
SE
288`cperl-auto-newline-after-colon' set."
289 :type 'boolean
db133cb6 290 :group 'cperl-autoinsert-details)
f83d2997 291
6c389151
SM
292(defcustom cperl-autoindent-on-semi nil
293 "*Non-nil means automatically indent after insertion of (semi)colon.
294Active if `cperl-auto-newline' is false."
295 :type 'boolean
296 :group 'cperl-autoinsert-details)
297
ccc3ce39 298(defcustom cperl-auto-newline-after-colon nil
f83d2997 299 "*Non-nil means automatically newline even after colons.
ccc3ce39
SE
300Subject to `cperl-auto-newline' setting."
301 :type 'boolean
db133cb6 302 :group 'cperl-autoinsert-details)
f83d2997 303
ccc3ce39 304(defcustom cperl-tab-always-indent t
f83d2997 305 "*Non-nil means TAB in CPerl mode should always reindent the current line,
ccc3ce39
SE
306regardless of where in the line point is when the TAB command is used."
307 :type 'boolean
db133cb6 308 :group 'cperl-indentation-details)
f83d2997 309
ccc3ce39 310(defcustom cperl-font-lock nil
029cb4d5 311 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
ccc3ce39 312Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
313 :type '(choice (const null) boolean)
314 :group 'cperl-affected-by-hairy)
f83d2997 315
ccc3ce39 316(defcustom cperl-electric-lbrace-space nil
029cb4d5 317 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
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-parens-string "({[]})<"
f83d2997 323 "*String of parentheses that should be electric in CPerl.
ccc3ce39
SE
324Closing ones are electric only if the region is highlighted."
325 :type 'string
db133cb6 326 :group 'cperl-affected-by-hairy)
f83d2997 327
ccc3ce39 328(defcustom cperl-electric-parens nil
f83d2997 329 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
ccc3ce39 330Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
331 :type '(choice (const null) boolean)
332 :group 'cperl-affected-by-hairy)
333
334(defvar zmacs-regions) ; Avoid warning
335
5c8b7eaf 336(defcustom cperl-electric-parens-mark
f83d2997
KH
337 (and window-system
338 (or (and (boundp 'transient-mark-mode) ; For Emacs
339 transient-mark-mode)
340 (and (boundp 'zmacs-regions) ; For XEmacs
341 zmacs-regions)))
342 "*Not-nil means that electric parens look for active mark.
ccc3ce39
SE
343Default is yes if there is visual feedback on mark."
344 :type 'boolean
db133cb6 345 :group 'cperl-autoinsert-details)
f83d2997 346
ccc3ce39 347(defcustom cperl-electric-linefeed nil
f83d2997
KH
348 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
349In any case these two mean plain and hairy linefeeds together.
ccc3ce39 350Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
351 :type '(choice (const null) boolean)
352 :group 'cperl-affected-by-hairy)
f83d2997 353
ccc3ce39 354(defcustom cperl-electric-keywords nil
f83d2997 355 "*Not-nil (and non-null) means keywords are electric in CPerl.
350b4cb9
EZ
356Can be overwritten by `cperl-hairy' if nil.
357
358Uses `abbrev-mode' to do the expansion. If you want to use your
359own abbrevs in cperl-mode, but do not want keywords to be
360electric, you must redefine `cperl-mode-abbrev-table': do
361\\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in
362that paragraph, delete the words that appear at the ends of lines and
363that begin with \"cperl-electric\".
364"
db133cb6
RS
365 :type '(choice (const null) boolean)
366 :group 'cperl-affected-by-hairy)
ccc3ce39 367
f739b53b
SM
368(defcustom cperl-electric-backspace-untabify t
369 "*Not-nil means electric-backspace will untabify in CPerl."
370 :type 'boolean
371 :group 'cperl-autoinsert-details)
372
ccc3ce39 373(defcustom cperl-hairy nil
db133cb6 374 "*Not-nil means most of the bells and whistles are enabled in CPerl.
5c8b7eaf 375Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
db133cb6
RS
376`cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
377`cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
378`cperl-lazy-help-time'."
ccc3ce39 379 :type 'boolean
db133cb6 380 :group 'cperl-affected-by-hairy)
ccc3ce39
SE
381
382(defcustom cperl-comment-column 32
383 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
384 :type 'integer
db133cb6 385 :group 'cperl-indentation-details)
ccc3ce39 386
4ab89e7b
SM
387(defcustom cperl-indent-comment-at-column-0 nil
388 "*Non-nil means that comment started at column 0 should be indentable."
389 :type 'boolean
390 :group 'cperl-indentation-details)
e1a5828f
AS
391
392(defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
393 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
394 :type '(repeat string)
395 :group 'cperl)
396
4ab89e7b 397(defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
e1a5828f
AS
398 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
399 :type '(repeat string)
4ab89e7b
SM
400 :group 'cperl)
401
402;; This became obsolete...
403(defvar cperl-vc-header-alist nil)
404(make-obsolete-variable
405 'cperl-vc-header-alist
406 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead.")
ccc3ce39 407
5c8b7eaf 408(defcustom cperl-clobber-mode-lists
5bd52f0e
RS
409 (not
410 (and
411 (boundp 'interpreter-mode-alist)
412 (assoc "miniperl" interpreter-mode-alist)
413 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
414 "*Whether to install us into `interpreter-' and `extension' mode lists."
415 :type 'boolean
416 :group 'cperl)
417
ccc3ce39 418(defcustom cperl-info-on-command-no-prompt nil
f83d2997 419 "*Not-nil (and non-null) means not to prompt on C-h f.
6292d528 420The opposite behavior is always available if prefixed with C-c.
ccc3ce39 421Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
422 :type '(choice (const null) boolean)
423 :group 'cperl-affected-by-hairy)
424
425(defcustom cperl-clobber-lisp-bindings nil
426 "*Not-nil (and non-null) means not overwrite C-h f.
427The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
428Can be overwritten by `cperl-hairy' if nil."
429 :type '(choice (const null) boolean)
430 :group 'cperl-affected-by-hairy)
f83d2997 431
ccc3ce39 432(defcustom cperl-lazy-help-time nil
db133cb6
RS
433 "*Not-nil (and non-null) means to show lazy help after given idle time.
434Can be overwritten by `cperl-hairy' to be 5 sec if nil."
300f7bb3 435 :type '(choice (const null) (const nil) integer)
db133cb6 436 :group 'cperl-affected-by-hairy)
f83d2997 437
ccc3ce39 438(defcustom cperl-pod-face 'font-lock-comment-face
83261a2f 439 "*Face for POD highlighting."
ccc3ce39 440 :type 'face
db133cb6 441 :group 'cperl-faces)
f83d2997 442
ccc3ce39 443(defcustom cperl-pod-head-face 'font-lock-variable-name-face
83261a2f 444 "*Face for POD highlighting.
ccc3ce39
SE
445Font for POD headers."
446 :type 'face
db133cb6 447 :group 'cperl-faces)
f83d2997 448
ccc3ce39 449(defcustom cperl-here-face 'font-lock-string-face
80585273 450 "*Face for here-docs highlighting."
ccc3ce39 451 :type 'face
db133cb6 452 :group 'cperl-faces)
f83d2997 453
4ab89e7b
SM
454;;; Some double-evaluation happened with font-locks... Needed with 21.2...
455(defvar cperl-singly-quote-face cperl-xemacs-p)
456
224ca9c9
CY
457(defcustom cperl-invalid-face 'underline
458 "*Face for highlighting trailing whitespace."
80585273 459 :type 'face
ac6857fb 460 :version "21.1"
5bd52f0e
RS
461 :group 'cperl-faces)
462
ccc3ce39 463(defcustom cperl-pod-here-fontify '(featurep 'font-lock)
83261a2f 464 "*Not-nil after evaluation means to highlight POD and here-docs sections."
ccc3ce39 465 :type 'boolean
db133cb6 466 :group 'cperl-faces)
f83d2997 467
5bd52f0e
RS
468(defcustom cperl-fontify-m-as-s t
469 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
470 :type 'boolean
471 :group 'cperl-faces)
472
6c389151
SM
473(defcustom cperl-highlight-variables-indiscriminately nil
474 "*Non-nil means perform additional highlighting on variables.
475Currently only changes how scalar variables are highlighted.
476Note that that variable is only read at initialization time for
477the variable `cperl-font-lock-keywords-2', so changing it after you've
f94a632a 478entered CPerl mode the first time will have no effect."
6c389151
SM
479 :type 'boolean
480 :group 'cperl)
481
ccc3ce39 482(defcustom cperl-pod-here-scan t
83261a2f 483 "*Not-nil means look for POD and here-docs sections during startup.
ccc3ce39
SE
484You can always make lookup from menu or using \\[cperl-find-pods-heres]."
485 :type 'boolean
db133cb6 486 :group 'cperl-speed)
f83d2997 487
6c389151
SM
488(defcustom cperl-regexp-scan t
489 "*Not-nil means make marking of regular expression more thorough.
4ab89e7b
SM
490Effective only with `cperl-pod-here-scan'."
491 :type 'boolean
492 :group 'cperl-speed)
493
494(defcustom cperl-hook-after-change t
495 "*Not-nil means install hook to know which regions of buffer are changed.
496May significantly speed up delayed fontification. Changes take effect
497after reload."
6c389151
SM
498 :type 'boolean
499 :group 'cperl-speed)
500
ccc3ce39 501(defcustom cperl-imenu-addback nil
f83d2997 502 "*Not-nil means add backreferences to generated `imenu's.
db133cb6 503May require patched `imenu' and `imenu-go'. Obsolete."
ccc3ce39 504 :type 'boolean
db133cb6 505 :group 'cperl-help-system)
f83d2997 506
ccc3ce39
SE
507(defcustom cperl-max-help-size 66
508 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
509 :type '(choice integer (const nil))
db133cb6 510 :group 'cperl-help-system)
f83d2997 511
ccc3ce39
SE
512(defcustom cperl-shrink-wrap-info-frame t
513 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
514 :type 'boolean
db133cb6 515 :group 'cperl-help-system)
f83d2997 516
ccc3ce39 517(defcustom cperl-info-page "perl"
f83d2997 518 "*Name of the info page containing perl docs.
ccc3ce39
SE
519Older version of this page was called `perl5', newer `perl'."
520 :type 'string
db133cb6 521 :group 'cperl-help-system)
f83d2997 522
5c8b7eaf 523(defcustom cperl-use-syntax-table-text-property
f83d2997 524 (boundp 'parse-sexp-lookup-properties)
ccc3ce39
SE
525 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
526 :type 'boolean
db133cb6 527 :group 'cperl-speed)
f83d2997 528
5c8b7eaf 529(defcustom cperl-use-syntax-table-text-property-for-tags
f83d2997 530 cperl-use-syntax-table-text-property
ccc3ce39
SE
531 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
532 :type 'boolean
db133cb6 533 :group 'cperl-speed)
ccc3ce39
SE
534
535(defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
536 "*Regexp to match files to scan when generating TAGS."
537 :type 'regexp
538 :group 'cperl)
539
8937f01b
RS
540(defcustom cperl-noscan-files-regexp
541 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
ccc3ce39
SE
542 "*Regexp to match files/dirs to skip when generating TAGS."
543 :type 'regexp
544 :group 'cperl)
545
546(defcustom cperl-regexp-indent-step nil
547 "*Indentation used when beautifying regexps.
029cb4d5 548If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 549 :type '(choice integer (const nil))
db133cb6 550 :group 'cperl-indentation-details)
ccc3ce39
SE
551
552(defcustom cperl-indent-left-aligned-comments t
553 "*Non-nil means that the comment starting in leftmost column should indent."
554 :type 'boolean
db133cb6 555 :group 'cperl-indentation-details)
ccc3ce39 556
8f222248 557(defcustom cperl-under-as-char nil
ccc3ce39
SE
558 "*Non-nil means that the _ (underline) should be treated as word char."
559 :type 'boolean
560 :group 'cperl)
f83d2997 561
db133cb6
RS
562(defcustom cperl-extra-perl-args ""
563 "*Extra arguments to use when starting Perl.
564Currently used with `cperl-check-syntax' only."
565 :type 'string
566 :group 'cperl)
567
568(defcustom cperl-message-electric-keyword t
569 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
570 :type 'boolean
571 :group 'cperl-help-system)
572
573(defcustom cperl-indent-region-fix-constructs 1
574 "*Amount of space to insert between `}' and `else' or `elsif'
575in `cperl-indent-region'. Set to nil to leave as is. Values other
576than 1 and nil will probably not work."
577 :type '(choice (const nil) (const 1))
578 :group 'cperl-indentation-details)
579
580(defcustom cperl-break-one-line-blocks-when-indent t
581 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
2022c546 582need to be reformatted into multiline ones when indenting a region."
db133cb6
RS
583 :type 'boolean
584 :group 'cperl-indentation-details)
585
586(defcustom cperl-fix-hanging-brace-when-indent t
587 "*Non-nil means that BLOCK-end `}' may be put on a separate line
5c8b7eaf 588when indenting a region.
db133cb6
RS
589Braces followed by else/elsif/while/until are excepted."
590 :type 'boolean
591 :group 'cperl-indentation-details)
592
593(defcustom cperl-merge-trailing-else t
5c8b7eaf 594 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
db133cb6
RS
595may be merged to be on the same line when indenting a region."
596 :type 'boolean
597 :group 'cperl-indentation-details)
598
6c389151
SM
599(defcustom cperl-indent-parens-as-block nil
600 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
601but for trailing \",\" inside the group, which won't increase indentation.
602One should tune up `cperl-close-paren-offset' as well."
603 :type 'boolean
604 :group 'cperl-indentation-details)
605
a1506d29 606(defcustom cperl-syntaxify-by-font-lock
83261a2f 607 (and cperl-can-font-lock
5bd52f0e 608 (boundp 'parse-sexp-lookup-properties))
6c389151 609 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
5bd52f0e
RS
610 :type '(choice (const message) boolean)
611 :group 'cperl-speed)
612
613(defcustom cperl-syntaxify-unwind
614 t
f94a632a 615 "*Non-nil means that CPerl unwinds to a start of a long construction
5bd52f0e 616when syntaxifying a chunk of buffer."
db133cb6
RS
617 :type 'boolean
618 :group 'cperl-speed)
619
4ab89e7b
SM
620(defcustom cperl-syntaxify-for-menu
621 t
622 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
623This way enabling/disabling of menu items is more correct."
624 :type 'boolean
625 :group 'cperl-speed)
626
5bd52f0e
RS
627(defcustom cperl-ps-print-face-properties
628 '((font-lock-keyword-face nil nil bold shadow)
629 (font-lock-variable-name-face nil nil bold)
630 (font-lock-function-name-face nil nil bold italic box)
631 (font-lock-constant-face nil "LightGray" bold)
4ab89e7b
SM
632 (cperl-array-face nil "LightGray" bold underline)
633 (cperl-hash-face nil "LightGray" bold italic underline)
5bd52f0e
RS
634 (font-lock-comment-face nil "LightGray" italic)
635 (font-lock-string-face nil nil italic underline)
4ab89e7b 636 (cperl-nonoverridable-face nil nil italic underline)
5bd52f0e 637 (font-lock-type-face nil nil underline)
4ab89e7b 638 (font-lock-warning-face nil "LightGray" bold italic box)
5bd52f0e
RS
639 (underline nil "LightGray" strikeout))
640 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
5c8b7eaf 641 :type '(repeat (cons symbol
5bd52f0e
RS
642 (cons (choice (const nil) string)
643 (cons (choice (const nil) string)
644 (repeat symbol)))))
645 :group 'cperl-faces)
646
5cc679ab
JB
647(defvar cperl-dark-background
648 (cperl-choose-color "navy" "os2blue" "darkgreen"))
649(defvar cperl-dark-foreground
650 (cperl-choose-color "orchid1" "orange"))
651
4ab89e7b 652(defface cperl-nonoverridable-face
5cc679ab
JB
653 `((((class grayscale) (background light))
654 (:background "Gray90" :slant italic :underline t))
655 (((class grayscale) (background dark))
656 (:foreground "Gray80" :slant italic :underline t :weight bold))
657 (((class color) (background light))
658 (:foreground "chartreuse3"))
659 (((class color) (background dark))
660 (:foreground ,cperl-dark-foreground))
661 (t (:weight bold :underline t)))
c73fce9a 662 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
5cc679ab
JB
663 :group 'cperl-faces)
664
4ab89e7b 665(defface cperl-array-face
5cc679ab
JB
666 `((((class grayscale) (background light))
667 (:background "Gray90" :weight bold))
668 (((class grayscale) (background dark))
669 (:foreground "Gray80" :weight bold))
670 (((class color) (background light))
671 (:foreground "Blue" :background "lightyellow2" :weight bold))
672 (((class color) (background dark))
673 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
674 (t (:weight bold)))
675 "Font Lock mode face used to highlight array names."
676 :group 'cperl-faces)
677
4ab89e7b 678(defface cperl-hash-face
5cc679ab
JB
679 `((((class grayscale) (background light))
680 (:background "Gray90" :weight bold :slant italic))
681 (((class grayscale) (background dark))
682 (:foreground "Gray80" :weight bold :slant italic))
683 (((class color) (background light))
684 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
685 (((class color) (background dark))
686 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
687 (t (:weight bold :slant italic)))
688 "Font Lock mode face used to highlight hash names."
689 :group 'cperl-faces)
5bd52f0e 690
f83d2997
KH
691\f
692
693;;; Short extra-docs.
694
695(defvar cperl-tips 'please-ignore-this-line
83261a2f 696 "Get maybe newer version of this package from
4ab89e7b 697 http://ilyaz.org/software/emacs
db133cb6
RS
698Subdirectory `cperl-mode' may contain yet newer development releases and/or
699patches to related files.
f83d2997 700
5bd52f0e
RS
701For best results apply to an older Emacs the patches from
702 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
83261a2f 703\(this upgrades syntax-parsing abilities of Emacsen v19.34 and
8e3acc66 704v20.2 up to the level of Emacs v20.3 - a must for a good Perl
83261a2f 705mode.) As of beginning of 2003, XEmacs may provide a similar ability.
5bd52f0e 706
f83d2997
KH
707Get support packages choose-color.el (or font-lock-extra.el before
70819.30), imenu-go.el from the same place. \(Look for other files there
709too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
5c8b7eaf 710later you should use choose-color.el *instead* of font-lock-extra.el
f83d2997
KH
711\(and you will not get smart highlighting in C :-().
712
713Note that to enable Compile choices in the menu you need to install
714mode-compile.el.
715
5efe6a56
SM
716If your Emacs does not default to `cperl-mode' on Perl files, and you
717want it to: put the following into your .emacs file:
718
719 (defalias 'perl-mode 'cperl-mode)
720
a1506d29 721Get perl5-info from
4ab89e7b
SM
722 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
723Also, one can generate a newer documentation running `pod2texi' converter
724 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
f83d2997
KH
725
726If you use imenu-go, run imenu on perl5-info buffer (you can do it
5bd52f0e
RS
727from Perl menu). If many files are related, generate TAGS files from
728Tools/Tags submenu in Perl menu.
f83d2997
KH
729
730If some class structure is too complicated, use Tools/Hierarchy-view
029cb4d5 731from Perl menu, or hierarchic view of imenu. The second one uses the
f83d2997 732current buffer only, the first one requires generation of TAGS from
5bd52f0e
RS
733Perl/Tools/Tags menu beforehand.
734
735Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
736
737Switch auto-help on/off with Perl/Tools/Auto-help.
738
739Though with contemporary Emaxen CPerl mode should maintain the correct
740parsing of Perl even when editing, sometimes it may be lost. Fix this by
741
029cb4d5 742 \\[normal-mode]
f83d2997 743
5bd52f0e 744In cases of more severe confusion sometimes it is helpful to do
f83d2997 745
029cb4d5
SM
746 \\[load-library] cperl-mode RET
747 \\[normal-mode]
f83d2997 748
5bd52f0e
RS
749Before reporting (non-)problems look in the problem section of online
750micro-docs on what I know about CPerl problems.")
f83d2997
KH
751
752(defvar cperl-problems 'please-ignore-this-line
f94a632a
RS
753 "Description of problems in CPerl mode.
754Some faces will not be shown on some versions of Emacs unless you
bab27c0c 755install choose-color.el, available from
4ab89e7b 756 http://ilyaz.org/software/emacs
bab27c0c 757
6c389151 758`fill-paragraph' on a comment may leave the point behind the
4ab89e7b
SM
759paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
760to detect it and bulk out).
761
762See documentation of a variable `cperl-problems-old-emaxen' for the
763problems which disappear if you upgrade Emacs to a reasonably new
764version (20.3 for Emacs, and those of 2004 for XEmacs).")
765
766(defvar cperl-problems-old-emaxen 'please-ignore-this-line
767 "Description of problems in CPerl mode specific for older Emacs versions.
6c389151 768
8e3acc66 769Emacs had a _very_ restricted syntax parsing engine until version
5bd52f0e 77020.1. Most problems below are corrected starting from this version of
8e3acc66 771Emacs, and all of them should be fixed in version 20.3. (Or apply
83261a2f
SM
772patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
773this respect (until 2003).
5bd52f0e 774
6c389151
SM
775Note that even with newer Emacsen in some very rare cases the details
776of interaction of `font-lock' and syntaxification may be not cleaned
777up yet. You may get slightly different colors basing on the order of
778fontification and syntaxification. Say, the initial faces is correct,
779but editing the buffer breaks this.
f83d2997 780
db133cb6
RS
781Even with older Emacsen CPerl mode tries to corrects some Emacs
782misunderstandings, however, for efficiency reasons the degree of
783correction is different for different operations. The partially
784corrected problems are: POD sections, here-documents, regexps. The
785operations are: highlighting, indentation, electric keywords, electric
786braces.
f83d2997
KH
787
788This may be confusing, since the regexp s#//#/#\; may be highlighted
789as a comment, but it will be recognized as a regexp by the indentation
83261a2f 790code. Or the opposite case, when a POD section is highlighted, but
f83d2997
KH
791may break the indentation of the following code (though indentation
792should work if the balance of delimiters is not broken by POD).
793
794The main trick (to make $ a \"backslash\") makes constructions like
795${aaa} look like unbalanced braces. The only trick I can think of is
2e8b9c7d 796to insert it as $ {aaa} (valid in perl5, not in perl4).
f83d2997
KH
797
798Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
db133cb6
RS
799as /($|\\s)/. Note that such a transposition is not always possible.
800
5bd52f0e 801The solution is to upgrade your Emacs or patch an older one. Note
8e3acc66 802that Emacs 20.2 has some bugs related to `syntax-table' text
5bd52f0e
RS
803properties. Patches are available on the main CPerl download site,
804and on CPAN.
db133cb6
RS
805
806If these bugs cannot be fixed on your machine (say, you have an inferior
807environment and cannot recompile), you may still disable all the fancy stuff
83261a2f 808via `cperl-use-syntax-table-text-property'.")
f83d2997 809
f83d2997 810(defvar cperl-praise 'please-ignore-this-line
8e3acc66 811 "Advantages of CPerl mode.
f83d2997
KH
812
8130) It uses the newest `syntax-table' property ;-);
814
8151) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
5c8b7eaf 816mode - but the latter number may have improved too in last years) even
5bd52f0e
RS
817with old Emaxen which do not support `syntax-table' property.
818
819When using `syntax-table' property for syntax assist hints, it should
820handle 99.995% of lines correct - or somesuch. It automatically
821updates syntax assist hints when you edit your script.
f83d2997 822
bab27c0c 8232) It is generally believed to be \"the most user-friendly Emacs
f83d2997
KH
824package\" whatever it may mean (I doubt that the people who say similar
825things tried _all_ the rest of Emacs ;-), but this was not a lonely
826voice);
827
8283) Everything is customizable, one-by-one or in a big sweep;
829
8304) It has many easily-accessable \"tools\":
831 a) Can run program, check syntax, start debugger;
832 b) Can lineup vertically \"middles\" of rows, like `=' in
833 a = b;
834 cc = d;
835 c) Can insert spaces where this impoves readability (in one
836 interactive sweep over the buffer);
837 d) Has support for imenu, including:
838 1) Separate unordered list of \"interesting places\";
839 2) Separate TOC of POD sections;
840 3) Separate list of packages;
841 4) Hierarchical view of methods in (sub)packages;
842 5) and functions (by the full name - with package);
843 e) Has an interface to INFO docs for Perl; The interface is
844 very flexible, including shrink-wrapping of
845 documentation buffer/frame;
846 f) Has a builtin list of one-line explanations for perl constructs.
847 g) Can show these explanations if you stay long enough at the
848 corresponding place (or on demand);
849 h) Has an enhanced fontification (using 3 or 4 additional faces
850 comparing to font-lock - basically, different
851 namespaces in Perl have different colors);
852 i) Can construct TAGS basing on its knowledge of Perl syntax,
853 the standard menu has 6 different way to generate
db133cb6 854 TAGS (if \"by directory\", .xs files - with C-language
f83d2997
KH
855 bindings - are included in the scan);
856 j) Can build a hierarchical view of classes (via imenu) basing
857 on generated TAGS file;
858 k) Has electric parentheses, electric newlines, uses Abbrev
859 for electric logical constructs
860 while () {}
861 with different styles of expansion (context sensitive
862 to be not so bothering). Electric parentheses behave
863 \"as they should\" in a presence of a visible region.
864 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
db133cb6
RS
865 m) Can convert from
866 if (A) { B }
867 to
868 B if A;
f83d2997 869
5bd52f0e 870 n) Highlights (by user-choice) either 3-delimiters constructs
6c389151
SM
871 (such as tr/a/b/), or regular expressions and `y/tr';
872 o) Highlights trailing whitespace;
873 p) Is able to manipulate Perl Regular Expressions to ease
874 conversion to a more readable form.
4ab89e7b
SM
875 q) Can ispell POD sections and HERE-DOCs.
876 r) Understands comments and character classes inside regular
877 expressions; can find matching () and [] in a regular expression.
878 s) Allows indentation of //x-style regular expressions;
879 t) Highlights different symbols in regular expressions according
880 to their function; much less problems with backslashitis;
881 u) Allows to find regular expressions which contain interpolated parts.
5bd52f0e 882
f83d2997
KH
8835) The indentation engine was very smart, but most of tricks may be
884not needed anymore with the support for `syntax-table' property. Has
885progress indicator for indentation (with `imenu' loaded).
886
5c8b7eaf 8876) Indent-region improves inline-comments as well; also corrects
db133cb6 888whitespace *inside* the conditional/loop constructs.
f83d2997
KH
889
8907) Fill-paragraph correctly handles multi-line comments;
db133cb6
RS
891
8928) Can switch to different indentation styles by one command, and restore
893the settings present before the switch.
894
5c8b7eaf 8959) When doing indentation of control constructs, may correct
db133cb6 896line-breaks/spacing between elements of the construct.
029cb4d5
SM
897
89810) Uses a linear-time algorith for indentation of regions (on Emaxen with
4ab89e7b
SM
899capable syntax engines).
900
90111) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
902")
db133cb6
RS
903
904(defvar cperl-speed 'please-ignore-this-line
905 "This is an incomplete compendium of what is available in other parts
906of CPerl documentation. (Please inform me if I skept anything.)
907
908There is a perception that CPerl is slower than alternatives. This part
909of documentation is designed to overcome this misconception.
910
911*By default* CPerl tries to enable the most comfortable settings.
912From most points of view, correctly working package is infinitely more
913comfortable than a non-correctly working one, thus by default CPerl
914prefers correctness over speed. Below is the guide how to change
915settings if your preferences are different.
916
917A) Speed of loading the file. When loading file, CPerl may perform a
918scan which indicates places which cannot be parsed by primitive Emacs
919syntax-parsing routines, and marks them up so that either
920
921 A1) CPerl may work around these deficiencies (for big chunks, mostly
922 PODs and HERE-documents), or
923 A2) On capable Emaxen CPerl will use improved syntax-handlings
924 which reads mark-up hints directly.
925
926 The scan in case A2 is much more comprehensive, thus may be slower.
927
928 User can disable syntax-engine-helping scan of A2 by setting
929 `cperl-use-syntax-table-text-property'
930 variable to nil (if it is set to t).
931
932 One can disable the scan altogether (both A1 and A2) by setting
933 `cperl-pod-here-scan'
934 to nil.
935
5c8b7eaf 936B) Speed of editing operations.
db133cb6
RS
937
938 One can add a (minor) speedup to editing operations by setting
939 `cperl-use-syntax-table-text-property'
940 variable to nil (if it is set to t). This will disable
941 syntax-engine-helping scan, thus will make many more Perl
942 constructs be wrongly recognized by CPerl, thus may lead to
943 wrongly matched parentheses, wrong indentation, etc.
5bd52f0e
RS
944
945 One can unset `cperl-syntaxify-unwind'. This might speed up editing
83261a2f 946 of, say, long POD sections.")
f83d2997 947
5bd52f0e
RS
948(defvar cperl-tips-faces 'please-ignore-this-line
949 "CPerl mode uses following faces for highlighting:
950
4ab89e7b
SM
951 `cperl-array-face' Array names
952 `cperl-hash-face' Hash names
8661c643 953 `font-lock-comment-face' Comments, PODs and whatever is considered
5bd52f0e 954 syntaxically to be not code
8661c643 955 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
5bd52f0e 956 2-arg operators s/y/tr/ or of RExen,
4ab89e7b
SM
957 `font-lock-warning-face' Special-cased m// and s//foo/,
958 `font-lock-function-name-face' _ as a target of a file tests, file tests,
5bd52f0e
RS
959 subroutine names at the moment of definition
960 (except those conflicting with Perl operators),
961 package names (when recognized), format names
8661c643 962 `font-lock-keyword-face' Control flow switch constructs, declarators
4ab89e7b 963 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
8661c643 964 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
5bd52f0e
RS
965 literal parts and the terminator of formats
966 and whatever is syntaxically considered
967 as string literals
8661c643
DL
968 `font-lock-type-face' Overridable keywords
969 `font-lock-variable-name-face' Variable declarations, indirect array and
5bd52f0e 970 hash names, POD headers/item names
e4c067b5 971 `cperl-invalid' Trailing whitespace
5bd52f0e
RS
972
973Note that in several situations the highlighting tries to inform about
974possible confusion, such as different colors for function names in
975declarations depending on what they (do not) override, or special cases
976m// and s/// which do not do what one would expect them to do.
977
5c8b7eaf 978Help with best setup of these faces for printout requested (for each of
5bd52f0e
RS
979the faces: please specify bold, italic, underline, shadow and box.)
980
4ab89e7b
SM
981In regular expressions (except character classes):
982 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
983 `font-lock-constant-face': Delimiters
984 `font-lock-warning-face' Special-cased m// and s//foo/,
985 Mismatched closing delimiters, parens
986 we couldn't match, misplaced quantifiers,
987 unrecognized escape sequences
988 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
989 `font-lock-type-face' POSIX classes inside charclasses,
990 escape sequences with arguments (\x \23 \p \N)
991 and others match-a-char escape sequences
992 `font-lock-keyword-face' Capturing parens, and |
993 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
994 `font-lock-builtin-face' \"Remaining\" 0-length constructs, executable
995 parts of a REx, not-capturing parens
996 `font-lock-variable-name-face' Interpolated constructs, embedded code
997 `font-lock-comment-face' Embedded comments
998
999")
5bd52f0e 1000
f83d2997
KH
1001\f
1002
1003;;; Portability stuff:
1004
1005(defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
b787fc05
GM
1006 `(define-key cperl-mode-map
1007 ,(if xemacs-key
1008 `(if cperl-xemacs-p ,xemacs-key ,emacs-key)
1009 emacs-key)
1010 ,definition))
f83d2997
KH
1011
1012(defvar cperl-del-back-ch
1013 (car (append (where-is-internal 'delete-backward-char)
1014 (where-is-internal 'backward-delete-char-untabify)))
029cb4d5 1015 "Character generated by key bound to `delete-backward-char'.")
f83d2997 1016
5c8b7eaf 1017(and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
f83d2997
KH
1018 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
1019
db133cb6 1020(defun cperl-mark-active () (mark)) ; Avoid undefined warning
f83d2997
KH
1021(if cperl-xemacs-p
1022 (progn
1023 ;; "Active regions" are on: use region only if active
1024 ;; "Active regions" are off: use region unconditionally
1025 (defun cperl-use-region-p ()
db133cb6 1026 (if zmacs-regions (mark) t)))
f83d2997
KH
1027 (defun cperl-use-region-p ()
1028 (if transient-mark-mode mark-active t))
1029 (defun cperl-mark-active () mark-active))
1030
1031(defsubst cperl-enable-font-lock ()
83261a2f 1032 cperl-can-font-lock)
f83d2997 1033
83261a2f 1034(defun cperl-putback-char (c) ; Emacs 19
db133cb6
RS
1035 (set 'unread-command-events (list c))) ; Avoid undefined warning
1036
0ce7de92
RS
1037(if cperl-xemacs-p
1038 (defun cperl-putback-char (c) ; XEmacs >= 19.12
1039 (setq unread-command-events (list (eval '(character-to-event c))))))
f83d2997
KH
1040
1041(or (fboundp 'uncomment-region)
1042 (defun uncomment-region (beg end)
1043 (interactive "r")
1044 (comment-region beg end -1)))
1045
1046(defvar cperl-do-not-fontify
1047 (if (string< emacs-version "19.30")
1048 'fontified
1049 'lazy-lock)
1050 "Text property which inhibits refontification.")
1051
5bd52f0e
RS
1052(defsubst cperl-put-do-not-fontify (from to &optional post)
1053 ;; If POST, do not do it with postponed fontification
1054 (if (and post cperl-syntaxify-by-font-lock)
1055 nil
f83d2997 1056 (put-text-property (max (point-min) (1- from))
5bd52f0e 1057 to cperl-do-not-fontify t)))
f83d2997 1058
ccc3ce39 1059(defcustom cperl-mode-hook nil
f94a632a 1060 "Hook run by CPerl mode."
ccc3ce39
SE
1061 :type 'hook
1062 :group 'cperl)
f83d2997 1063
db133cb6
RS
1064(defvar cperl-syntax-state nil)
1065(defvar cperl-syntax-done-to nil)
5bd52f0e 1066(defvar cperl-emacs-can-parse (> (length (save-excursion
ce22dd53 1067 (parse-partial-sexp (point) (point)))) 9))
db133cb6
RS
1068\f
1069;; Make customization possible "in reverse"
1070(defsubst cperl-val (symbol &optional default hairy)
1071 (cond
1072 ((eq (symbol-value symbol) 'null) default)
1073 (cperl-hairy (or hairy t))
1074 (t (symbol-value symbol))))
f83d2997 1075\f
4ab89e7b
SM
1076
1077(defun cperl-make-indent (column &optional minimum keep)
1078 "Makes indent of the current line the requested amount.
1079Unless KEEP, removes the old indentation. Works around a bug in ancient
1080versions of Emacs."
1081 (let ((prop (get-text-property (point) 'syntax-type)))
1082 (or keep
1083 (delete-horizontal-space))
1084 (indent-to column minimum)
1085 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1086 (and prop
1087 (> (current-column) 0)
1088 (save-excursion
1089 (beginning-of-line)
1090 (or (get-text-property (point) 'syntax-type)
1091 (and (looking-at "\\=[ \t]")
1092 (put-text-property (point) (match-end 0)
1093 'syntax-type prop)))))))
1094
f83d2997
KH
1095;;; Probably it is too late to set these guys already, but it can help later:
1096
5bd52f0e 1097;;;(and cperl-clobber-mode-lists
f83d2997
KH
1098;;;(setq auto-mode-alist
1099;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1100;;;(and (boundp 'interpreter-mode-alist)
1101;;; (setq interpreter-mode-alist (append interpreter-mode-alist
5bd52f0e 1102;;; '(("miniperl" . perl-mode))))))
80585273 1103(eval-when-compile
83261a2f
SM
1104 (mapcar (lambda (p)
1105 (condition-case nil
1106 (require p)
1107 (error nil)))
1108 '(imenu easymenu etags timer man info))
80585273
DL
1109 (if (fboundp 'ps-extend-face-list)
1110 (defmacro cperl-ps-extend-face-list (arg)
1111 `(ps-extend-face-list ,arg))
1112 (defmacro cperl-ps-extend-face-list (arg)
e8af40ee 1113 `(error "This version of Emacs has no `ps-extend-face-list'")))
80585273
DL
1114 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1115 ;; macros instead of defsubsts don't work on Emacs, so we do the
1116 ;; expansion manually. Any other suggestions?
1117 (require 'cl))
f83d2997
KH
1118
1119(defvar cperl-mode-abbrev-table nil
f94a632a 1120 "Abbrev table in use in CPerl mode buffers.")
f83d2997
KH
1121
1122(add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1123
1124(defvar cperl-mode-map () "Keymap used in CPerl mode.")
1125
1126(if cperl-mode-map nil
1127 (setq cperl-mode-map (make-sparse-keymap))
1128 (cperl-define-key "{" 'cperl-electric-lbrace)
1129 (cperl-define-key "[" 'cperl-electric-paren)
1130 (cperl-define-key "(" 'cperl-electric-paren)
1131 (cperl-define-key "<" 'cperl-electric-paren)
1132 (cperl-define-key "}" 'cperl-electric-brace)
1133 (cperl-define-key "]" 'cperl-electric-rparen)
1134 (cperl-define-key ")" 'cperl-electric-rparen)
1135 (cperl-define-key ";" 'cperl-electric-semi)
1136 (cperl-define-key ":" 'cperl-electric-terminator)
1137 (cperl-define-key "\C-j" 'newline-and-indent)
1138 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
db133cb6 1139 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
f83d2997
KH
1140 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1141 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
db133cb6
RS
1142 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1143 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
f83d2997 1144 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
4ab89e7b
SM
1145 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
1146 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
1147 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
1148 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
1149 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx)
1150 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0)
1151 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1)
db133cb6 1152 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
4ab89e7b
SM
1153 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
1154 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
f83d2997
KH
1155 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1156 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1157 [(control meta |)])
1158 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1159 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1160 (cperl-define-key "\177" 'cperl-electric-backspace)
1161 (cperl-define-key "\t" 'cperl-indent-command)
1162 ;; don't clobber the backspace binding:
db133cb6
RS
1163 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1164 [(control c) (control h) F])
db133cb6
RS
1165 (if (cperl-val 'cperl-clobber-lisp-bindings)
1166 (progn
1167 (cperl-define-key "\C-hf"
1168 ;;(concat (char-to-string help-char) "f") ; does not work
1169 'cperl-info-on-command
1170 [(control h) f])
1171 (cperl-define-key "\C-hv"
1172 ;;(concat (char-to-string help-char) "v") ; does not work
1173 'cperl-get-help
5bd52f0e
RS
1174 [(control h) v])
1175 (cperl-define-key "\C-c\C-hf"
1176 ;;(concat (char-to-string help-char) "f") ; does not work
1177 (key-binding "\C-hf")
1178 [(control c) (control h) f])
1179 (cperl-define-key "\C-c\C-hv"
1180 ;;(concat (char-to-string help-char) "v") ; does not work
1181 (key-binding "\C-hv")
1182 [(control c) (control h) v]))
1183 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1184 [(control c) (control h) f])
1185 (cperl-define-key "\C-c\C-hv"
1186 ;;(concat (char-to-string help-char) "v") ; does not work
1187 'cperl-get-help
1188 [(control c) (control h) v]))
5c8b7eaf 1189 (if (and cperl-xemacs-p
f83d2997
KH
1190 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1191 (progn
1192 ;; substitute-key-definition is usefulness-deenhanced...
4ab89e7b 1193 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
f83d2997
KH
1194 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1195 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
4ab89e7b
SM
1196 (or (boundp 'fill-paragraph-function)
1197 (substitute-key-definition
1198 'fill-paragraph 'cperl-fill-paragraph
1199 cperl-mode-map global-map))
f83d2997
KH
1200 (substitute-key-definition
1201 'indent-sexp 'cperl-indent-exp
1202 cperl-mode-map global-map)
f83d2997
KH
1203 (substitute-key-definition
1204 'indent-region 'cperl-indent-region
1205 cperl-mode-map global-map)
1206 (substitute-key-definition
1207 'indent-for-comment 'cperl-indent-for-comment
1208 cperl-mode-map global-map)))
1209
1210(defvar cperl-menu)
db133cb6
RS
1211(defvar cperl-lazy-installed)
1212(defvar cperl-old-style nil)
f83d2997
KH
1213(condition-case nil
1214 (progn
1215 (require 'easymenu)
83261a2f 1216 (easy-menu-define
4ab89e7b
SM
1217 cperl-menu cperl-mode-map "Menu for CPerl mode"
1218 '("Perl"
1219 ["Beginning of function" beginning-of-defun t]
1220 ["End of function" end-of-defun t]
1221 ["Mark function" mark-defun t]
1222 ["Indent expression" cperl-indent-exp t]
82eb0dae 1223 ["Fill paragraph/comment" fill-paragraph t]
4ab89e7b
SM
1224 "----"
1225 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1226 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1227 ("Regexp"
1228 ["Beautify" cperl-beautify-regexp
1229 cperl-use-syntax-table-text-property]
1230 ["Beautify one level deep" (cperl-beautify-regexp 1)
1231 cperl-use-syntax-table-text-property]
1232 ["Beautify a group" cperl-beautify-level
1233 cperl-use-syntax-table-text-property]
1234 ["Beautify a group one level deep" (cperl-beautify-level 1)
1235 cperl-use-syntax-table-text-property]
1236 ["Contract a group" cperl-contract-level
1237 cperl-use-syntax-table-text-property]
1238 ["Contract groups" cperl-contract-levels
1239 cperl-use-syntax-table-text-property]
83261a2f 1240 "----"
4ab89e7b
SM
1241 ["Find next interpolated" cperl-next-interpolated-REx
1242 (next-single-property-change (point-min) 'REx-interpolated)]
1243 ["Find next interpolated (no //o)"
1244 cperl-next-interpolated-REx-0
1245 (or (text-property-any (point-min) (point-max) 'REx-interpolated t)
1246 (text-property-any (point-min) (point-max) 'REx-interpolated 1))]
1247 ["Find next interpolated (neither //o nor whole-REx)"
1248 cperl-next-interpolated-REx-1
1249 (text-property-any (point-min) (point-max) 'REx-interpolated t)])
1250 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
1251 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1252 "----"
1253 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1254 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1255 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1256 "----"
1257 ["Run" mode-compile (fboundp 'mode-compile)]
1258 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1259 (get-buffer "*compilation*"))]
1260 ["Next error" next-error (get-buffer "*compilation*")]
1261 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1262 "----"
1263 ["Debugger" cperl-db t]
1264 "----"
1265 ("Tools"
1266 ["Imenu" imenu (fboundp 'imenu)]
1267 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
83261a2f 1268 "----"
4ab89e7b
SM
1269 ["Ispell PODs" cperl-pod-spell
1270 ;; Better not to update syntaxification here:
1271 ;; debugging syntaxificatio can be broken by this???
1272 (or
1273 (get-text-property (point-min) 'in-pod)
1274 (< (progn
1275 (and cperl-syntaxify-for-menu
1276 (cperl-update-syntaxification (point-max) (point-max)))
1277 (next-single-property-change (point-min) 'in-pod nil (point-max)))
1278 (point-max)))]
1279 ["Ispell HERE-DOCs" cperl-here-doc-spell
1280 (< (progn
1281 (and cperl-syntaxify-for-menu
1282 (cperl-update-syntaxification (point-max) (point-max)))
1283 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
1284 (point-max))]
1285 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
1286 (eq 'here-doc (progn
1287 (and cperl-syntaxify-for-menu
1288 (cperl-update-syntaxification (point) (point)))
1289 (get-text-property (point) 'syntax-type)))]
1290 ["Select this HERE-DOC or POD section"
1291 cperl-select-this-pod-or-here-doc
1292 (memq (progn
1293 (and cperl-syntaxify-for-menu
1294 (cperl-update-syntaxification (point) (point)))
1295 (get-text-property (point) 'syntax-type))
1296 '(here-doc pod))]
83261a2f 1297 "----"
4ab89e7b
SM
1298 ["CPerl pretty print (exprmntl)" cperl-ps-print
1299 (fboundp 'ps-extend-face-list)]
83261a2f 1300 "----"
4ab89e7b
SM
1301 ["Syntaxify region" cperl-find-pods-heres-region
1302 (cperl-use-region-p)]
1303 ["Profile syntaxification" cperl-time-fontification t]
1304 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
1305 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
1306 ["Debug backtrace on syntactic scan (BEWARE!!!)"
1307 (cperl-toggle-set-debug-unwind nil t) t]
83261a2f 1308 "----"
4ab89e7b
SM
1309 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1310 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1311 ("Tags"
f83d2997
KH
1312;;; ["Create tags for current file" cperl-etags t]
1313;;; ["Add tags for current file" (cperl-etags t) t]
1314;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1315;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
5c8b7eaf 1316;;; ["Create tags for Perl files in (sub)directories"
f83d2997
KH
1317;;; (cperl-etags nil 'recursive) t]
1318;;; ["Add tags for Perl files in (sub)directories"
5c8b7eaf 1319;;; (cperl-etags t 'recursive) t])
f83d2997 1320;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
f739b53b
SM
1321 ["Create tags for current file" (cperl-write-tags nil t) t]
1322 ["Add tags for current file" (cperl-write-tags) t]
1323 ["Create tags for Perl files in directory"
1324 (cperl-write-tags nil t nil t) t]
1325 ["Add tags for Perl files in directory"
1326 (cperl-write-tags nil nil nil t) t]
1327 ["Create tags for Perl files in (sub)directories"
1328 (cperl-write-tags nil t t t) t]
1329 ["Add tags for Perl files in (sub)directories"
1330 (cperl-write-tags nil nil t t) t]))
1331 ("Perl docs"
15ca5699 1332 ["Define word at point" imenu-go-find-at-position
f739b53b
SM
1333 (fboundp 'imenu-go-find-at-position)]
1334 ["Help on function" cperl-info-on-command t]
1335 ["Help on function at point" cperl-info-on-current-command t]
1336 ["Help on symbol at point" cperl-get-help t]
1337 ["Perldoc" cperl-perldoc t]
1338 ["Perldoc on word at point" cperl-perldoc-at-point t]
1339 ["View manpage of POD in this file" cperl-build-manpage t]
15ca5699 1340 ["Auto-help on" cperl-lazy-install
f739b53b
SM
1341 (and (fboundp 'run-with-idle-timer)
1342 (not cperl-lazy-installed))]
1343 ["Auto-help off" cperl-lazy-unstall
1344 (and (fboundp 'run-with-idle-timer)
1345 cperl-lazy-installed)])
1346 ("Toggle..."
1347 ["Auto newline" cperl-toggle-auto-newline t]
1348 ["Electric parens" cperl-toggle-electric t]
1349 ["Electric keywords" cperl-toggle-abbrev t]
1350 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1351 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
15ca5699 1352 ["Auto fill" auto-fill-mode t])
f739b53b
SM
1353 ("Indent styles..."
1354 ["CPerl" (cperl-set-style "CPerl") t]
1355 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1356 ["GNU" (cperl-set-style "GNU") t]
1357 ["C++" (cperl-set-style "C++") t]
4ab89e7b 1358 ["K&R" (cperl-set-style "K&R") t]
f739b53b
SM
1359 ["BSD" (cperl-set-style "BSD") t]
1360 ["Whitesmith" (cperl-set-style "Whitesmith") t]
4ab89e7b 1361 ["Memorize Current" (cperl-set-style "Current") t]
f739b53b
SM
1362 ["Memorized" (cperl-set-style-back) cperl-old-style])
1363 ("Micro-docs"
1364 ["Tips" (describe-variable 'cperl-tips) t]
1365 ["Problems" (describe-variable 'cperl-problems) t]
1366 ["Speed" (describe-variable 'cperl-speed) t]
1367 ["Praise" (describe-variable 'cperl-praise) t]
1368 ["Faces" (describe-variable 'cperl-tips-faces) t]
1369 ["CPerl mode" (describe-function 'cperl-mode) t]
1370 ["CPerl version"
1371 (message "The version of master-file for this CPerl is %s-Emacs"
1372 cperl-version) t]))))
f83d2997
KH
1373 (error nil))
1374
1375(autoload 'c-macro-expand "cmacexp"
1376 "Display the result of expanding all C macros occurring in the region.
1377The expansion is entirely correct because it uses the C preprocessor."
1378 t)
1379
4ab89e7b
SM
1380;;; These two must be unwound, otherwise take exponential time
1381(defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
1382"Regular expression to match optional whitespace with interpspersed comments.
1383Should contain exactly one group.")
1384
1385;;; This one is tricky to unwind; still very inefficient...
1386(defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
1387"Regular expression to match whitespace with interpspersed comments.
1388Should contain exactly one group.")
1389
1390
1391;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1392;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1393;;; Details of groups in this may be used in several functions; see comments
1394;;; near mentioned above variable(s)...
1395;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1396(defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
1397 "Match the text after `sub' in a subroutine declaration.
1398If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
1399of attributes (if present), or end of the name or prototype (whatever is
1400the last)."
1401 (concat ; Assume n groups before this...
1402 "\\(" ; n+1=name-group
1403 cperl-white-and-comment-rex ; n+2=pre-name
1404 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
1405 "\\)" ; END n+1=name-group
1406 (if named "" "?")
1407 "\\(" ; n+4=proto-group
1408 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
1409 "\\(([^()]*)\\)" ; n+6=prototype
1410 "\\)?" ; END n+4=proto-group
1411 "\\(" ; n+7=attr-group
1412 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
1413 "\\(" ; n+9=start-attr
1414 ":"
1415 (if attr (concat
1416 "\\("
1417 cperl-maybe-white-and-comment-rex ; whitespace-comments
1418 "\\(\\sw\\|_\\)+" ; attr-name
1419 ;; attr-arg (1 level of internal parens allowed!)
1420 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
1421 "\\(" ; optional : (XXX allows trailing???)
1422 cperl-maybe-white-and-comment-rex ; whitespace-comments
1423 ":\\)?"
1424 "\\)+")
1425 "[^:]")
1426 "\\)"
1427 "\\)?" ; END n+6=proto-group
1428 ))
1429
1430;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1431;;; and `cperl-outline-level'.
1432;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
95f433f4
RS
1433(defvar cperl-imenu--function-name-regexp-perl
1434 (concat
4ab89e7b
SM
1435 "^\\(" ; 1 = all
1436 "\\([ \t]*package" ; 2 = package-group
1437 "\\(" ; 3 = package-name-group
1438 cperl-white-and-comment-rex ; 4 = pre-package-name
1439 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
1440 "\\|"
1441 "[ \t]*sub"
1442 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1443 cperl-maybe-white-and-comment-rex ; 15=pre-block
1444 "\\|"
1445 "=head\\([1-4]\\)[ \t]+" ; 16=level
1446 "\\([^\n]+\\)$" ; 17=text
95f433f4
RS
1447 "\\)"))
1448
8dd511f6
RS
1449(defvar cperl-outline-regexp
1450 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1451
f83d2997 1452(defvar cperl-mode-syntax-table nil
f94a632a 1453 "Syntax table in use in CPerl mode buffers.")
f83d2997
KH
1454
1455(defvar cperl-string-syntax-table nil
f94a632a 1456 "Syntax table in use in CPerl mode string-like chunks.")
f83d2997 1457
4ab89e7b
SM
1458(defsubst cperl-1- (p)
1459 (max (point-min) (1- p)))
1460
1461(defsubst cperl-1+ (p)
1462 (min (point-max) (1+ p)))
1463
f83d2997
KH
1464(if cperl-mode-syntax-table
1465 ()
1466 (setq cperl-mode-syntax-table (make-syntax-table))
1467 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1468 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1469 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1470 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1471 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1472 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1473 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1474 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1475 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1476 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1477 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1478 (modify-syntax-entry ?\n ">" 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 (if cperl-under-as-char
1483 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1484 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1485 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1486 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1487 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
4ab89e7b
SM
1488 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
1489 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
83261a2f 1490 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
f83d2997
KH
1491
1492
1493\f
db133cb6 1494(defvar cperl-faces-init nil)
f83d2997
KH
1495;; Fix for msb.el
1496(defvar cperl-msb-fixed nil)
83261a2f 1497(defvar cperl-use-major-mode 'cperl-mode)
4ab89e7b
SM
1498(defvar cperl-font-lock-multiline-start nil)
1499(defvar cperl-font-lock-multiline nil)
4ab89e7b 1500(defvar cperl-font-locking nil)
83261a2f 1501
e9bfd3a3
GM
1502;; NB as it stands the code in cperl-mode assumes this only has one
1503;; element. If Xemacs 19 support were dropped, this could all be simplified.
1504(defvar cperl-compilation-error-regexp-alist
1505 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1506 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
1507 2 3))
1508 "Alist that specifies how to match errors in perl output.")
1509
f83d2997
KH
1510;;;###autoload
1511(defun cperl-mode ()
1512 "Major mode for editing Perl code.
1513Expression and list commands understand all C brackets.
1514Tab indents for Perl code.
1515Paragraphs are separated by blank lines only.
1516Delete converts tabs to spaces as it moves back.
1517
1518Various characters in Perl almost always come in pairs: {}, (), [],
1519sometimes <>. When the user types the first, she gets the second as
1520well, with optional special formatting done on {}. (Disabled by
1521default.) You can always quote (with \\[quoted-insert]) the left
1522\"paren\" to avoid the expansion. The processing of < is special,
f94a632a 1523since most the time you mean \"less\". CPerl mode tries to guess
f83d2997
KH
1524whether you want to type pair <>, and inserts is if it
1525appropriate. You can set `cperl-electric-parens-string' to the string that
1526contains the parenths from the above list you want to be electrical.
1527Electricity of parenths is controlled by `cperl-electric-parens'.
1528You may also set `cperl-electric-parens-mark' to have electric parens
1529look for active mark and \"embrace\" a region if possible.'
1530
1531CPerl mode provides expansion of the Perl control constructs:
db133cb6 1532
5c8b7eaf 1533 if, else, elsif, unless, while, until, continue, do,
db133cb6
RS
1534 for, foreach, formy and foreachmy.
1535
1536and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1537
1538The user types the keyword immediately followed by a space, which
1539causes the construct to be expanded, and the point is positioned where
1540she is most likely to want to be. eg. when the user types a space
1541following \"if\" the following appears in the buffer: if () { or if ()
1542} { } and the cursor is between the parentheses. The user can then
1543type some boolean expression within the parens. Having done that,
1544typing \\[cperl-linefeed] places you - appropriately indented - on a
1545new line between the braces (if you typed \\[cperl-linefeed] in a POD
5c8b7eaf 1546directive line, then appropriate number of new lines is inserted).
db133cb6
RS
1547
1548If CPerl decides that you want to insert \"English\" style construct like
1549
f83d2997 1550 bite if angry;
db133cb6
RS
1551
1552it will not do any expansion. See also help on variable
1553`cperl-extra-newline-before-brace'. (Note that one can switch the
1554help message on expansion by setting `cperl-message-electric-keyword'
1555to nil.)
f83d2997
KH
1556
1557\\[cperl-linefeed] is a convenience replacement for typing carriage
1558return. It places you in the next line with proper indentation, or if
1559you type it inside the inline block of control construct, like
db133cb6 1560
f83d2997 1561 foreach (@lines) {print; print}
db133cb6 1562
f83d2997
KH
1563and you are on a boundary of a statement inside braces, it will
1564transform the construct into a multiline and will place you into an
5c8b7eaf 1565appropriately indented blank line. If you need a usual
6292d528 1566`newline-and-indent' behavior, it is on \\[newline-and-indent],
f83d2997
KH
1567see documentation on `cperl-electric-linefeed'.
1568
db133cb6
RS
1569Use \\[cperl-invert-if-unless] to change a construction of the form
1570
1571 if (A) { B }
1572
1573into
1574
1575 B if A;
1576
f83d2997
KH
1577\\{cperl-mode-map}
1578
db133cb6
RS
1579Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1580\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1581on electric space between $ and {, `cperl-electric-parens-string' is
1582the string that contains parentheses that should be electric in CPerl
1583\(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
f83d2997
KH
1584setting `cperl-electric-keywords' enables electric expansion of
1585control structures in CPerl. `cperl-electric-linefeed' governs which
1586one of two linefeed behavior is preferable. You can enable all these
1587options simultaneously (recommended mode of use) by setting
1588`cperl-hairy' to t. In this case you can switch separate options off
db133cb6
RS
1589by setting them to `null'. Note that one may undo the extra
1590whitespace inserted by semis and braces in `auto-newline'-mode by
1591consequent \\[cperl-electric-backspace].
f83d2997
KH
1592
1593If your site has perl5 documentation in info format, you can use commands
1594\\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1595These keys run commands `cperl-info-on-current-command' and
1596`cperl-info-on-command', which one is which is controlled by variable
5c8b7eaf 1597`cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
db133cb6 1598\(in turn affected by `cperl-hairy').
f83d2997
KH
1599
1600Even if you have no info-format documentation, short one-liner-style
db133cb6
RS
1601help is available on \\[cperl-get-help], and one can run perldoc or
1602man via menu.
f83d2997 1603
db133cb6
RS
1604It is possible to show this help automatically after some idle time.
1605This is regulated by variable `cperl-lazy-help-time'. Default with
1606`cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1607secs idle time . It is also possible to switch this on/off from the
1608menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
f83d2997
KH
1609
1610Use \\[cperl-lineup] to vertically lineup some construction - put the
1611beginning of the region at the start of construction, and make region
1612span the needed amount of lines.
1613
1614Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
83261a2f 1615`cperl-pod-face', `cperl-pod-head-face' control processing of POD and
db133cb6
RS
1616here-docs sections. With capable Emaxen results of scan are used
1617for indentation too, otherwise they are used for highlighting only.
f83d2997
KH
1618
1619Variables controlling indentation style:
1620 `cperl-tab-always-indent'
1621 Non-nil means TAB in CPerl mode should always reindent the current line,
1622 regardless of where in the line point is when the TAB command is used.
db133cb6
RS
1623 `cperl-indent-left-aligned-comments'
1624 Non-nil means that the comment starting in leftmost column should indent.
f83d2997
KH
1625 `cperl-auto-newline'
1626 Non-nil means automatically newline before and after braces,
1627 and after colons and semicolons, inserted in Perl code. The following
1628 \\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf
SS
1629 Insertion after colons requires both this variable and
1630 `cperl-auto-newline-after-colon' set.
f83d2997
KH
1631 `cperl-auto-newline-after-colon'
1632 Non-nil means automatically newline even after colons.
1633 Subject to `cperl-auto-newline' setting.
1634 `cperl-indent-level'
1635 Indentation of Perl statements within surrounding block.
1636 The surrounding block's indentation is the indentation
1637 of the line on which the open-brace appears.
1638 `cperl-continued-statement-offset'
1639 Extra indentation given to a substatement, such as the
1640 then-clause of an if, or body of a while, or just a statement continuation.
1641 `cperl-continued-brace-offset'
1642 Extra indentation given to a brace that starts a substatement.
1643 This is in addition to `cperl-continued-statement-offset'.
1644 `cperl-brace-offset'
1645 Extra indentation for line if it starts with an open brace.
1646 `cperl-brace-imaginary-offset'
1647 An open brace following other text is treated as if it the line started
1648 this far to the right of the actual line indentation.
1649 `cperl-label-offset'
1650 Extra indentation for line that is a label.
1651 `cperl-min-label-indent'
1652 Minimal indentation for line that is a label.
1653
4ab89e7b
SM
1654Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1655 `cperl-indent-level' 5 4 2 4
1656 `cperl-brace-offset' 0 0 0 0
1657 `cperl-continued-brace-offset' -5 -4 0 0
1658 `cperl-label-offset' -5 -4 -2 -4
1659 `cperl-continued-statement-offset' 5 4 2 4
f83d2997 1660
db133cb6
RS
1661CPerl knows several indentation styles, and may bulk set the
1662corresponding variables. Use \\[cperl-set-style] to do this. Use
1663\\[cperl-set-style-back] to restore the memorized preexisting values
4ab89e7b
SM
1664\(both available from menu). See examples in `cperl-style-examples'.
1665
1666Part of the indentation style is how different parts of if/elsif/else
1667statements are broken into lines; in CPerl, this is reflected on how
1668templates for these constructs are created (controlled by
1669`cperl-extra-newline-before-brace'), and how reflow-logic should treat \"continuation\" blocks of else/elsif/continue, controlled by the same variable,
1670and by `cperl-extra-newline-before-brace-multiline',
1671`cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
db133cb6
RS
1672
1673If `cperl-indent-level' is 0, the statement after opening brace in
5c8b7eaf 1674column 0 is indented on
db133cb6 1675`cperl-brace-offset'+`cperl-continued-statement-offset'.
f83d2997
KH
1676
1677Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
db133cb6
RS
1678with no args.
1679
1680DO NOT FORGET to read micro-docs (available from `Perl' menu)
1681or as help on variables `cperl-tips', `cperl-problems',
f94a632a 1682`cperl-praise', `cperl-speed'."
f83d2997
KH
1683 (interactive)
1684 (kill-all-local-variables)
f83d2997
KH
1685 (use-local-map cperl-mode-map)
1686 (if (cperl-val 'cperl-electric-linefeed)
1687 (progn
1688 (local-set-key "\C-J" 'cperl-linefeed)
1689 (local-set-key "\C-C\C-J" 'newline-and-indent)))
db133cb6
RS
1690 (if (and
1691 (cperl-val 'cperl-clobber-lisp-bindings)
1692 (cperl-val 'cperl-info-on-command-no-prompt))
f83d2997
KH
1693 (progn
1694 ;; don't clobber the backspace binding:
1695 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1696 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1697 [(control c) (control h) f])))
83261a2f 1698 (setq major-mode cperl-use-major-mode)
f83d2997 1699 (setq mode-name "CPerl")
449657e8
GM
1700 (let ((prev-a-c abbrevs-changed))
1701 (define-abbrev-table 'cperl-mode-abbrev-table '(
f83d2997
KH
1702 ("if" "if" cperl-electric-keyword 0)
1703 ("elsif" "elsif" cperl-electric-keyword 0)
1704 ("while" "while" cperl-electric-keyword 0)
1705 ("until" "until" cperl-electric-keyword 0)
1706 ("unless" "unless" cperl-electric-keyword 0)
1707 ("else" "else" cperl-electric-else 0)
db133cb6 1708 ("continue" "continue" cperl-electric-else 0)
f83d2997
KH
1709 ("for" "for" cperl-electric-keyword 0)
1710 ("foreach" "foreach" cperl-electric-keyword 0)
db133cb6
RS
1711 ("formy" "formy" cperl-electric-keyword 0)
1712 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1713 ("do" "do" cperl-electric-keyword 0)
6c389151
SM
1714 ("=pod" "=pod" cperl-electric-pod 0)
1715 ("=over" "=over" cperl-electric-pod 0)
1716 ("=head1" "=head1" cperl-electric-pod 0)
1717 ("=head2" "=head2" cperl-electric-pod 0)
db133cb6
RS
1718 ("pod" "pod" cperl-electric-pod 0)
1719 ("over" "over" cperl-electric-pod 0)
1720 ("head1" "head1" cperl-electric-pod 0)
1721 ("head2" "head2" cperl-electric-pod 0)))
449657e8 1722 (setq abbrevs-changed prev-a-c))
f83d2997 1723 (setq local-abbrev-table cperl-mode-abbrev-table)
4ab89e7b
SM
1724 (if (cperl-val 'cperl-electric-keywords)
1725 (abbrev-mode 1))
f83d2997 1726 (set-syntax-table cperl-mode-syntax-table)
4ab89e7b
SM
1727 ;; Until Emacs is multi-threaded, we do not actually need it local:
1728 (make-local-variable 'cperl-font-lock-multiline-start)
1729 (make-local-variable 'cperl-font-locking)
6c389151
SM
1730 (make-local-variable 'outline-regexp)
1731 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1732 (setq outline-regexp cperl-outline-regexp)
1733 (make-local-variable 'outline-level)
1734 (setq outline-level 'cperl-outline-level)
f83d2997
KH
1735 (make-local-variable 'paragraph-start)
1736 (setq paragraph-start (concat "^$\\|" page-delimiter))
1737 (make-local-variable 'paragraph-separate)
1738 (setq paragraph-separate paragraph-start)
1739 (make-local-variable 'paragraph-ignore-fill-prefix)
1740 (setq paragraph-ignore-fill-prefix t)
4ab89e7b
SM
1741 (if cperl-xemacs-p
1742 (progn
1743 (make-local-variable 'paren-backwards-message)
1744 (set 'paren-backwards-message t)))
f83d2997
KH
1745 (make-local-variable 'indent-line-function)
1746 (setq indent-line-function 'cperl-indent-line)
1747 (make-local-variable 'require-final-newline)
7d441781 1748 (setq require-final-newline mode-require-final-newline)
f83d2997
KH
1749 (make-local-variable 'comment-start)
1750 (setq comment-start "# ")
1751 (make-local-variable 'comment-end)
1752 (setq comment-end "")
1753 (make-local-variable 'comment-column)
1754 (setq comment-column cperl-comment-column)
1755 (make-local-variable 'comment-start-skip)
1756 (setq comment-start-skip "#+ *")
1757 (make-local-variable 'defun-prompt-regexp)
4ab89e7b
SM
1758;;; "[ \t]*sub"
1759;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1760;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1761 (setq defun-prompt-regexp
1762 (concat "^[ \t]*\\(sub"
1763 (cperl-after-sub-regexp 'named 'attr-groups)
1764 "\\|" ; per toke.c
1765 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
1766 "\\)"
1767 cperl-maybe-white-and-comment-rex))
f83d2997
KH
1768 (make-local-variable 'comment-indent-function)
1769 (setq comment-indent-function 'cperl-comment-indent)
4ab89e7b
SM
1770 (and (boundp 'fill-paragraph-function)
1771 (progn
1772 (make-local-variable 'fill-paragraph-function)
1773 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
f83d2997
KH
1774 (make-local-variable 'parse-sexp-ignore-comments)
1775 (setq parse-sexp-ignore-comments t)
1776 (make-local-variable 'indent-region-function)
1777 (setq indent-region-function 'cperl-indent-region)
1778 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1779 (make-local-variable 'imenu-create-index-function)
1780 (setq imenu-create-index-function
80585273 1781 (function cperl-imenu--create-perl-index))
f83d2997
KH
1782 (make-local-variable 'imenu-sort-function)
1783 (setq imenu-sort-function nil)
e1a5828f
AS
1784 (make-local-variable 'vc-rcs-header)
1785 (set 'vc-rcs-header cperl-vc-rcs-header)
1786 (make-local-variable 'vc-sccs-header)
1787 (set 'vc-sccs-header cperl-vc-sccs-header)
4ab89e7b
SM
1788 ;; This one is obsolete...
1789 (make-local-variable 'vc-header-alist)
1790 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
1791 (` ((SCCS (, (car cperl-vc-sccs-header)))
1792 (RCS (, (car cperl-vc-rcs-header)))))))
1793 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
1794 (make-local-variable 'compilation-error-regexp-alist-alist)
1795 (set 'compilation-error-regexp-alist-alist
e9bfd3a3 1796 (cons (cons 'cperl (car cperl-compilation-error-regexp-alist))
4ab89e7b
SM
1797 (symbol-value 'compilation-error-regexp-alist-alist)))
1798 (if (fboundp 'compilation-build-compilation-error-regexp-alist)
1799 (let ((f 'compilation-build-compilation-error-regexp-alist))
1800 (funcall f))
28a62ecb 1801 (make-local-variable 'compilation-error-regexp-alist)
4ab89e7b
SM
1802 (push 'cperl compilation-error-regexp-alist)))
1803 ((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
1804 (make-local-variable 'compilation-error-regexp-alist)
1805 (set 'compilation-error-regexp-alist
10715960
RS
1806 (append cperl-compilation-error-regexp-alist
1807 (symbol-value 'compilation-error-regexp-alist)))))
f83d2997
KH
1808 (make-local-variable 'font-lock-defaults)
1809 (setq font-lock-defaults
db133cb6
RS
1810 (cond
1811 ((string< emacs-version "19.30")
4ab89e7b 1812 '(cperl-font-lock-keywords-2 nil nil ((?_ . "w"))))
db133cb6 1813 ((string< emacs-version "19.33") ; Which one to use?
5efe6a56
SM
1814 '((cperl-font-lock-keywords
1815 cperl-font-lock-keywords-1
4ab89e7b 1816 cperl-font-lock-keywords-2) nil nil ((?_ . "w"))))
db133cb6
RS
1817 (t
1818 '((cperl-load-font-lock-keywords
1819 cperl-load-font-lock-keywords-1
4ab89e7b 1820 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
db133cb6 1821 (make-local-variable 'cperl-syntax-state)
4ab89e7b 1822 (setq cperl-syntax-state nil) ; reset syntaxification cache
f83d2997
KH
1823 (if cperl-use-syntax-table-text-property
1824 (progn
029cb4d5 1825 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997 1826 ;; Do not introduce variable if not needed, we check it!
db133cb6
RS
1827 (set 'parse-sexp-lookup-properties t)
1828 ;; Fix broken font-lock:
1829 (or (boundp 'font-lock-unfontify-region-function)
1830 (set 'font-lock-unfontify-region-function
83261a2f 1831 'font-lock-default-unfontify-region))
4ab89e7b
SM
1832 (unless cperl-xemacs-p ; Our: just a plug for wrong font-lock
1833 (make-local-variable 'font-lock-unfontify-region-function)
1834 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1835 'cperl-font-lock-unfontify-region-function))
029cb4d5 1836 (make-local-variable 'cperl-syntax-done-to)
4ab89e7b 1837 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
029cb4d5 1838 (make-local-variable 'font-lock-syntactic-keywords)
5c8b7eaf 1839 (setq font-lock-syntactic-keywords
db133cb6 1840 (if cperl-syntaxify-by-font-lock
11b41e6f
SM
1841 '((cperl-fontify-syntaxically))
1842 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1843 ;; used to ignore syntax-table text-properties. (t) is a hack
1844 ;; to make font-lock think that font-lock-syntactic-keywords
1845 ;; are defined.
db133cb6 1846 '(t)))))
4ab89e7b
SM
1847 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
1848 (progn
1849 (setq cperl-font-lock-multiline t) ; Not localized...
f453f5a8 1850 (set (make-local-variable 'font-lock-multiline) t))
4ab89e7b
SM
1851 (make-local-variable 'font-lock-fontify-region-function)
1852 (set 'font-lock-fontify-region-function ; not present with old Emacs
1853 'cperl-font-lock-fontify-region-function))
1854 (make-local-variable 'font-lock-fontify-region-function)
1855 (set 'font-lock-fontify-region-function ; not present with old Emacs
1856 'cperl-font-lock-fontify-region-function)
db133cb6 1857 (make-local-variable 'cperl-old-style)
83261a2f
SM
1858 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1859 (set (make-local-variable 'normal-auto-fill-function)
4ab89e7b 1860 'cperl-do-auto-fill)
83261a2f
SM
1861 (or (fboundp 'cperl-old-auto-fill-mode)
1862 (progn
1863 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1864 (defun auto-fill-mode (&optional arg)
1865 (interactive "P")
1866 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1867 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1868 (setq auto-fill-function 'cperl-do-auto-fill))))))
f83d2997 1869 (if (cperl-enable-font-lock)
5c8b7eaf 1870 (if (cperl-val 'cperl-font-lock)
f83d2997
KH
1871 (progn (or cperl-faces-init (cperl-init-faces))
1872 (font-lock-mode 1))))
4ab89e7b
SM
1873 (set (make-local-variable 'facemenu-add-face-function)
1874 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
f83d2997
KH
1875 (and (boundp 'msb-menu-cond)
1876 (not cperl-msb-fixed)
1877 (cperl-msb-fix))
1878 (if (featurep 'easymenu)
46c72468 1879 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
a3c328ee 1880 (run-mode-hooks 'cperl-mode-hook)
4ab89e7b 1881 (if cperl-hook-after-change
39234e39 1882 (add-hook 'after-change-functions 'cperl-after-change-function nil t))
f83d2997 1883 ;; After hooks since fontification will break this
5c8b7eaf 1884 (if cperl-pod-here-scan
83261a2f 1885 (or cperl-syntaxify-by-font-lock
5bd52f0e
RS
1886 (progn (or cperl-faces-init (cperl-init-faces-weak))
1887 (cperl-find-pods-heres)))))
f83d2997
KH
1888\f
1889;; Fix for perldb - make default reasonable
1890(defun cperl-db ()
1891 (interactive)
1892 (require 'gud)
1893 (perldb (read-from-minibuffer "Run perldb (like this): "
1894 (if (consp gud-perldb-history)
1895 (car gud-perldb-history)
1896 (concat "perl " ;;(file-name-nondirectory
83261a2f
SM
1897 ;; I have problems
1898 ;; in OS/2
1899 ;; otherwise
1900 (buffer-file-name)))
f83d2997
KH
1901 nil nil
1902 '(gud-perldb-history . 1))))
1903\f
f83d2997
KH
1904(defun cperl-msb-fix ()
1905 ;; Adds perl files to msb menu, supposes that msb is already loaded
1906 (setq cperl-msb-fixed t)
1907 (let* ((l (length msb-menu-cond))
1908 (last (nth (1- l) msb-menu-cond))
1909 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1910 (handle (1- (nth 1 last))))
1911 (setcdr precdr (list
1912 (list
996e2616 1913 '(memq major-mode '(cperl-mode perl-mode))
f83d2997
KH
1914 handle
1915 "Perl Files (%d)")
1916 last))))
1917\f
1918;; This is used by indent-for-comment
1919;; to decide how much to indent a comment in CPerl code
1920;; based on its context. Do fallback if comment is found wrong.
1921
1922(defvar cperl-wrong-comment)
5bd52f0e
RS
1923(defvar cperl-st-cfence '(14)) ; Comment-fence
1924(defvar cperl-st-sfence '(15)) ; String-fence
1925(defvar cperl-st-punct '(1))
1926(defvar cperl-st-word '(2))
1927(defvar cperl-st-bra '(4 . ?\>))
1928(defvar cperl-st-ket '(5 . ?\<))
1929
f83d2997 1930
4ab89e7b 1931(defun cperl-comment-indent () ; called at point at supposed comment
5bd52f0e 1932 (let ((p (point)) (c (current-column)) was phony)
4ab89e7b
SM
1933 (if (and (not cperl-indent-comment-at-column-0)
1934 (looking-at "^#"))
1935 0 ; Existing comment at bol stays there.
f83d2997
KH
1936 ;; Wrong comment found
1937 (save-excursion
5bd52f0e
RS
1938 (setq was (cperl-to-comment-or-eol)
1939 phony (eq (get-text-property (point) 'syntax-table)
1940 cperl-st-cfence))
1941 (if phony
4ab89e7b 1942 (progn ; Too naive???
5bd52f0e
RS
1943 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1944 (if (eq (preceding-char) ?\#)
1945 (forward-char -1))
1946 (setq was nil)))
4ab89e7b 1947 (if (= (point) p) ; Our caller found a correct place
f83d2997
KH
1948 (progn
1949 (skip-chars-backward " \t")
4ab89e7b
SM
1950 (setq was (current-column))
1951 (if (eq was 0)
1952 comment-column
1953 (max (1+ was) ; Else indent at comment column
1954 comment-column)))
1955 ;; No, the caller found a random place; we need to edit ourselves
f83d2997
KH
1956 (if was nil
1957 (insert comment-start)
1958 (backward-char (length comment-start)))
1959 (setq cperl-wrong-comment t)
4ab89e7b
SM
1960 (cperl-make-indent comment-column 1) ; Indent min 1
1961 c)))))
f83d2997
KH
1962
1963;;;(defun cperl-comment-indent-fallback ()
1964;;; "Is called if the standard comment-search procedure fails.
1965;;;Point is at start of real comment."
1966;;; (let ((c (current-column)) target cnt prevc)
1967;;; (if (= c comment-column) nil
1968;;; (setq cnt (skip-chars-backward "[ \t]"))
5c8b7eaf 1969;;; (setq target (max (1+ (setq prevc
f83d2997
KH
1970;;; (current-column))) ; Else indent at comment column
1971;;; comment-column))
1972;;; (if (= c comment-column) nil
1973;;; (delete-backward-char cnt)
1974;;; (while (< prevc target)
1975;;; (insert "\t")
1976;;; (setq prevc (current-column)))
1977;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1978;;; (while (< prevc target)
1979;;; (insert " ")
1980;;; (setq prevc (current-column)))))))
1981
1982(defun cperl-indent-for-comment ()
1983 "Substitute for `indent-for-comment' in CPerl."
1984 (interactive)
1985 (let (cperl-wrong-comment)
1986 (indent-for-comment)
4ab89e7b 1987 (if cperl-wrong-comment ; set by `cperl-comment-indent'
f83d2997
KH
1988 (progn (cperl-to-comment-or-eol)
1989 (forward-char (length comment-start))))))
1990
1991(defun cperl-comment-region (b e arg)
1992 "Comment or uncomment each line in the region in CPerl mode.
1993See `comment-region'."
1994 (interactive "r\np")
1995 (let ((comment-start "#"))
1996 (comment-region b e arg)))
1997
1998(defun cperl-uncomment-region (b e arg)
1999 "Uncomment or comment each line in the region in CPerl mode.
2000See `comment-region'."
2001 (interactive "r\np")
2002 (let ((comment-start "#"))
2003 (comment-region b e (- arg))))
2004
2005(defvar cperl-brace-recursing nil)
2006
2007(defun cperl-electric-brace (arg &optional only-before)
2008 "Insert character and correct line's indentation.
2009If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2010place (even in empty line), but not after. If after \")\" and the inserted
5c8b7eaf 2011char is \"{\", insert extra newline before only if
f83d2997
KH
2012`cperl-extra-newline-before-brace'."
2013 (interactive "P")
2014 (let (insertpos
2015 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2016 (cperl-mark-active)
f83d2997 2017 (< (mark) (point)))
5c8b7eaf 2018 (mark)
f83d2997
KH
2019 nil)))
2020 (if (and other-end
2021 (not cperl-brace-recursing)
2022 (cperl-val 'cperl-electric-parens)
2023 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2024 ;; Need to insert a matching pair
2025 (progn
2026 (save-excursion
2027 (setq insertpos (point-marker))
2028 (goto-char other-end)
2029 (setq last-command-char ?\{)
2030 (cperl-electric-lbrace arg insertpos))
2031 (forward-char 1))
83261a2f 2032 ;; Check whether we close something "usual" with `}'
db133cb6 2033 (if (and (eq last-command-char ?\})
5c8b7eaf 2034 (not
db133cb6
RS
2035 (condition-case nil
2036 (save-excursion
2037 (up-list (- (prefix-numeric-value arg)))
2038 ;;(cperl-after-block-p (point-min))
f739b53b
SM
2039 (or (cperl-after-expr-p nil "{;)")
2040 ;; after sub, else, continue
2041 (cperl-after-block-p nil 'pre)))
db133cb6
RS
2042 (error nil))))
2043 ;; Just insert the guy
2044 (self-insert-command (prefix-numeric-value arg))
2045 (if (and (not arg) ; No args, end (of empty line or auto)
2046 (eolp)
2047 (or (and (null only-before)
2048 (save-excursion
2049 (skip-chars-backward " \t")
2050 (bolp)))
2051 (and (eq last-command-char ?\{) ; Do not insert newline
2052 ;; if after ")" and `cperl-extra-newline-before-brace'
2053 ;; is nil, do not insert extra newline.
2054 (not cperl-extra-newline-before-brace)
2055 (save-excursion
2056 (skip-chars-backward " \t")
2057 (eq (preceding-char) ?\))))
5c8b7eaf 2058 (if cperl-auto-newline
db133cb6
RS
2059 (progn (cperl-indent-line) (newline) t) nil)))
2060 (progn
2061 (self-insert-command (prefix-numeric-value arg))
2062 (cperl-indent-line)
2063 (if cperl-auto-newline
2064 (setq insertpos (1- (point))))
2065 (if (and cperl-auto-newline (null only-before))
2066 (progn
2067 (newline)
2068 (cperl-indent-line)))
2069 (save-excursion
2070 (if insertpos (progn (goto-char insertpos)
5c8b7eaf 2071 (search-forward (make-string
db133cb6
RS
2072 1 last-command-char))
2073 (setq insertpos (1- (point)))))
2074 (delete-char -1))))
2075 (if insertpos
f83d2997 2076 (save-excursion
db133cb6
RS
2077 (goto-char insertpos)
2078 (self-insert-command (prefix-numeric-value arg)))
2079 (self-insert-command (prefix-numeric-value arg)))))))
f83d2997
KH
2080
2081(defun cperl-electric-lbrace (arg &optional end)
2082 "Insert character, correct line's indentation, correct quoting by space."
2083 (interactive "P")
83261a2f
SM
2084 (let ((cperl-brace-recursing t)
2085 (cperl-auto-newline cperl-auto-newline)
2086 (other-end (or end
2087 (if (and cperl-electric-parens-mark
2088 (cperl-mark-active)
2089 (> (mark) (point)))
2090 (save-excursion
2091 (goto-char (mark))
2092 (point-marker))
2093 nil)))
2094 pos after)
f83d2997
KH
2095 (and (cperl-val 'cperl-electric-lbrace-space)
2096 (eq (preceding-char) ?$)
2097 (save-excursion
2098 (skip-chars-backward "$")
2099 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
b5b0cb34 2100 (insert ?\s))
bab27c0c 2101 ;; Check whether we are in comment
5c8b7eaf 2102 (if (and
bab27c0c
RS
2103 (save-excursion
2104 (beginning-of-line)
2105 (not (looking-at "[ \t]*#")))
2106 (cperl-after-expr-p nil "{;)"))
2107 nil
2108 (setq cperl-auto-newline nil))
f83d2997
KH
2109 (cperl-electric-brace arg)
2110 (and (cperl-val 'cperl-electric-parens)
2111 (eq last-command-char ?{)
5c8b7eaf 2112 (memq last-command-char
f83d2997
KH
2113 (append cperl-electric-parens-string nil))
2114 (or (if other-end (goto-char (marker-position other-end)))
2115 t)
2116 (setq last-command-char ?} pos (point))
2117 (progn (cperl-electric-brace arg t)
2118 (goto-char pos)))))
2119
2120(defun cperl-electric-paren (arg)
f739b53b
SM
2121 "Insert an opening parenthesis or a matching pair of parentheses.
2122See `cperl-electric-parens'."
f83d2997
KH
2123 (interactive "P")
2124 (let ((beg (save-excursion (beginning-of-line) (point)))
2125 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 2126 (cperl-mark-active)
f83d2997 2127 (> (mark) (point)))
83261a2f
SM
2128 (save-excursion
2129 (goto-char (mark))
2130 (point-marker))
f83d2997
KH
2131 nil)))
2132 (if (and (cperl-val 'cperl-electric-parens)
2133 (memq last-command-char
2134 (append cperl-electric-parens-string nil))
2135 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2136 ;;(not (save-excursion (search-backward "#" beg t)))
2137 (if (eq last-command-char ?<)
2138 (progn
2139 (and abbrev-mode ; later it is too late, may be after `for'
2140 (expand-abbrev))
2141 (cperl-after-expr-p nil "{;(,:="))
2142 1))
2143 (progn
2144 (self-insert-command (prefix-numeric-value arg))
2145 (if other-end (goto-char (marker-position other-end)))
5c8b7eaf 2146 (insert (make-string
f83d2997
KH
2147 (prefix-numeric-value arg)
2148 (cdr (assoc last-command-char '((?{ .?})
2149 (?[ . ?])
2150 (?( . ?))
2151 (?< . ?>))))))
2152 (forward-char (- (prefix-numeric-value arg))))
2153 (self-insert-command (prefix-numeric-value arg)))))
2154
2155(defun cperl-electric-rparen (arg)
2156 "Insert a matching pair of parentheses if marking is active.
f739b53b
SM
2157If not, or if we are not at the end of marking range, would self-insert.
2158Affected by `cperl-electric-parens'."
f83d2997
KH
2159 (interactive "P")
2160 (let ((beg (save-excursion (beginning-of-line) (point)))
2161 (other-end (if (and cperl-electric-parens-mark
2162 (cperl-val 'cperl-electric-parens)
2163 (memq last-command-char
2164 (append cperl-electric-parens-string nil))
5c8b7eaf 2165 (cperl-mark-active)
f83d2997 2166 (< (mark) (point)))
5c8b7eaf 2167 (mark)
f83d2997
KH
2168 nil))
2169 p)
2170 (if (and other-end
2171 (cperl-val 'cperl-electric-parens)
2172 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
2173 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2174 ;;(not (save-excursion (search-backward "#" beg t)))
2175 )
2176 (progn
2177 (self-insert-command (prefix-numeric-value arg))
2178 (setq p (point))
2179 (if other-end (goto-char other-end))
2180 (insert (make-string
2181 (prefix-numeric-value arg)
2182 (cdr (assoc last-command-char '((?\} . ?\{)
83261a2f
SM
2183 (?\] . ?\[)
2184 (?\) . ?\()
2185 (?\> . ?\<))))))
f83d2997
KH
2186 (goto-char (1+ p)))
2187 (self-insert-command (prefix-numeric-value arg)))))
2188
2189(defun cperl-electric-keyword ()
db133cb6
RS
2190 "Insert a construction appropriate after a keyword.
2191Help message may be switched off by setting `cperl-message-electric-keyword'
2192to nil."
5c8b7eaf 2193 (let ((beg (save-excursion (beginning-of-line) (point)))
f83d2997
KH
2194 (dollar (and (eq last-command-char ?$)
2195 (eq this-command 'self-insert-command)))
b5b0cb34 2196 (delete (and (memq last-command-char '(?\s ?\n ?\t ?\f))
db133cb6
RS
2197 (memq this-command '(self-insert-command newline))))
2198 my do)
f83d2997 2199 (and (save-excursion
db133cb6
RS
2200 (condition-case nil
2201 (progn
2202 (backward-sexp 1)
2203 (setq do (looking-at "do\\>")))
2204 (error nil))
f83d2997 2205 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2206 (save-excursion
2207 (not
f83d2997 2208 (re-search-backward
5bd52f0e 2209 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2210 beg t)))
2211 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2212 (or
2213 (looking-at "=cut")
2214 (and cperl-use-syntax-table-text-property
2215 (not (eq (get-text-property (point)
2216 'syntax-type)
2217 'pod))))))
f739b53b
SM
2218 (save-excursion (forward-sexp -1)
2219 (not (memq (following-char) (append "$@%&*" nil))))
f83d2997 2220 (progn
db133cb6
RS
2221 (and (eq (preceding-char) ?y)
2222 (progn ; "foreachmy"
2223 (forward-char -2)
2224 (insert " ")
2225 (forward-char 2)
5c8b7eaf
SS
2226 (setq my t dollar t
2227 delete
db133cb6 2228 (memq this-command '(self-insert-command newline)))))
f83d2997
KH
2229 (and dollar (insert " $"))
2230 (cperl-indent-line)
2231 ;;(insert " () {\n}")
2232 (cond
2233 (cperl-extra-newline-before-brace
db133cb6 2234 (insert (if do "\n" " ()\n"))
f83d2997
KH
2235 (insert "{")
2236 (cperl-indent-line)
2237 (insert "\n")
2238 (cperl-indent-line)
db133cb6
RS
2239 (insert "\n}")
2240 (and do (insert " while ();")))
f83d2997 2241 (t
83261a2f 2242 (insert (if do " {\n} while ();" " () {\n}"))))
f83d2997
KH
2243 (or (looking-at "[ \t]\\|$") (insert " "))
2244 (cperl-indent-line)
2245 (if dollar (progn (search-backward "$")
5c8b7eaf 2246 (if my
db133cb6
RS
2247 (forward-char 1)
2248 (delete-char 1)))
f739b53b
SM
2249 (search-backward ")")
2250 (if (eq last-command-char ?\()
2251 (progn ; Avoid "if (())"
2252 (delete-backward-char 1)
2253 (delete-backward-char -1))))
f83d2997 2254 (if delete
db133cb6
RS
2255 (cperl-putback-char cperl-del-back-ch))
2256 (if cperl-message-electric-keyword
2257 (message "Precede char by C-q to avoid expansion"))))))
2258
2259(defun cperl-ensure-newlines (n &optional pos)
2260 "Make sure there are N newlines after the point."
2261 (or pos (setq pos (point)))
2262 (if (looking-at "\n")
2263 (forward-char 1)
2264 (insert "\n"))
2265 (if (> n 1)
2266 (cperl-ensure-newlines (1- n) pos)
2267 (goto-char pos)))
2268
2269(defun cperl-electric-pod ()
2270 "Insert a POD chunk appropriate after a =POD directive."
b5b0cb34 2271 (let ((delete (and (memq last-command-char '(?\s ?\n ?\t ?\f))
db133cb6
RS
2272 (memq this-command '(self-insert-command newline))))
2273 head1 notlast name p really-delete over)
2274 (and (save-excursion
6c389151 2275 (forward-word -1)
a1506d29 2276 (and
db133cb6
RS
2277 (eq (preceding-char) ?=)
2278 (progn
6c389151
SM
2279 (setq head1 (looking-at "head1\\>[ \t]*$"))
2280 (setq over (and (looking-at "over\\>[ \t]*$")
2281 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
db133cb6
RS
2282 (forward-char -1)
2283 (bolp))
5c8b7eaf 2284 (or
5bd52f0e 2285 (get-text-property (point) 'in-pod)
db133cb6 2286 (cperl-after-expr-p nil "{;:")
4ab89e7b
SM
2287 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
2288 (not (looking-at "\n*=cut"))
2289 (or (not cperl-use-syntax-table-text-property)
2290 (eq (get-text-property (point) 'syntax-type) 'pod))))))
db133cb6
RS
2291 (progn
2292 (save-excursion
6c389151 2293 (setq notlast (re-search-forward "^\n=" nil t)))
db133cb6
RS
2294 (or notlast
2295 (progn
2296 (insert "\n\n=cut")
2297 (cperl-ensure-newlines 2)
6c389151 2298 (forward-word -2)
a1506d29
JB
2299 (if (and head1
2300 (not
db133cb6
RS
2301 (save-excursion
2302 (forward-char -1)
2303 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
83261a2f 2304 nil t)))) ; Only one
a1506d29 2305 (progn
6c389151 2306 (forward-word 1)
db133cb6
RS
2307 (setq name (file-name-sans-extension
2308 (file-name-nondirectory (buffer-file-name)))
2309 p (point))
5c8b7eaf 2310 (insert " NAME\n\n" name
029cb4d5 2311 " - \n\n=head1 SYNOPSIS\n\n\n\n"
db133cb6
RS
2312 "=head1 DESCRIPTION")
2313 (cperl-ensure-newlines 4)
2314 (goto-char p)
6c389151 2315 (forward-word 2)
db133cb6
RS
2316 (end-of-line)
2317 (setq really-delete t))
6c389151 2318 (forward-word 1))))
db133cb6
RS
2319 (if over
2320 (progn
2321 (setq p (point))
2322 (insert "\n\n=item \n\n\n\n"
2323 "=back")
2324 (cperl-ensure-newlines 2)
2325 (goto-char p)
6c389151 2326 (forward-word 1)
db133cb6
RS
2327 (end-of-line)
2328 (setq really-delete t)))
2329 (if (and delete really-delete)
f83d2997
KH
2330 (cperl-putback-char cperl-del-back-ch))))))
2331
2332(defun cperl-electric-else ()
db133cb6
RS
2333 "Insert a construction appropriate after a keyword.
2334Help message may be switched off by setting `cperl-message-electric-keyword'
2335to nil."
f83d2997
KH
2336 (let ((beg (save-excursion (beginning-of-line) (point))))
2337 (and (save-excursion
2338 (backward-sexp 1)
2339 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2340 (save-excursion
2341 (not
f83d2997 2342 (re-search-backward
5bd52f0e 2343 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2344 beg t)))
2345 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2346 (looking-at "=cut")
2347 (and cperl-use-syntax-table-text-property
2348 (not (eq (get-text-property (point)
2349 'syntax-type)
2350 'pod)))))
f83d2997
KH
2351 (progn
2352 (cperl-indent-line)
2353 ;;(insert " {\n\n}")
2354 (cond
2355 (cperl-extra-newline-before-brace
2356 (insert "\n")
2357 (insert "{")
2358 (cperl-indent-line)
2359 (insert "\n\n}"))
2360 (t
83261a2f 2361 (insert " {\n\n}")))
f83d2997
KH
2362 (or (looking-at "[ \t]\\|$") (insert " "))
2363 (cperl-indent-line)
2364 (forward-line -1)
2365 (cperl-indent-line)
db133cb6
RS
2366 (cperl-putback-char cperl-del-back-ch)
2367 (setq this-command 'cperl-electric-else)
2368 (if cperl-message-electric-keyword
2369 (message "Precede char by C-q to avoid expansion"))))))
f83d2997
KH
2370
2371(defun cperl-linefeed ()
db133cb6
RS
2372 "Go to end of line, open a new line and indent appropriately.
2373If in POD, insert appropriate lines."
f83d2997
KH
2374 (interactive)
2375 (let ((beg (save-excursion (beginning-of-line) (point)))
2376 (end (save-excursion (end-of-line) (point)))
db133cb6 2377 (pos (point)) start over cut res)
f83d2997 2378 (if (and ; Check if we need to split:
5c8b7eaf 2379 ; i.e., on a boundary and inside "{...}"
f83d2997 2380 (save-excursion (cperl-to-comment-or-eol)
83261a2f 2381 (>= (point) pos)) ; Not in a comment
f83d2997
KH
2382 (or (save-excursion
2383 (skip-chars-backward " \t" beg)
2384 (forward-char -1)
2385 (looking-at "[;{]")) ; After { or ; + spaces
2386 (looking-at "[ \t]*}") ; Before }
2387 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2388 (save-excursion
2389 (and
5c8b7eaf 2390 (eq (car (parse-partial-sexp pos end -1)) -1)
f83d2997
KH
2391 ; Leave the level of parens
2392 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2393 ; Are at end
6c389151 2394 (cperl-after-block-p (point-min))
f83d2997
KH
2395 (progn
2396 (backward-sexp 1)
2397 (setq start (point-marker))
db133cb6 2398 (<= start pos))))) ; Redundant? Are after the
f83d2997
KH
2399 ; start of parens group.
2400 (progn
2401 (skip-chars-backward " \t")
2402 (or (memq (preceding-char) (append ";{" nil))
2403 (insert ";"))
2404 (insert "\n")
2405 (forward-line -1)
2406 (cperl-indent-line)
2407 (goto-char start)
2408 (or (looking-at "{[ \t]*$") ; If there is a statement
2409 ; before, move it to separate line
2410 (progn
2411 (forward-char 1)
2412 (insert "\n")
2413 (cperl-indent-line)))
2414 (forward-line 1) ; We are on the target line
2415 (cperl-indent-line)
2416 (beginning-of-line)
2417 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
83261a2f 2418 ; after, move it to separate line
f83d2997
KH
2419 (progn
2420 (end-of-line)
2421 (search-backward "}" beg)
2422 (skip-chars-backward " \t")
2423 (or (memq (preceding-char) (append ";{" nil))
2424 (insert ";"))
2425 (insert "\n")
2426 (cperl-indent-line)
2427 (forward-line -1)))
5c8b7eaf 2428 (forward-line -1) ; We are on the line before target
f83d2997
KH
2429 (end-of-line)
2430 (newline-and-indent))
db133cb6 2431 (end-of-line) ; else - no splitting
f83d2997
KH
2432 (cond
2433 ((and (looking-at "\n[ \t]*{$")
2434 (save-excursion
2435 (skip-chars-backward " \t")
2436 (eq (preceding-char) ?\)))) ; Probably if () {} group
83261a2f 2437 ; with an extra newline.
f83d2997
KH
2438 (forward-line 2)
2439 (cperl-indent-line))
db133cb6
RS
2440 ((save-excursion ; In POD header
2441 (forward-paragraph -1)
2442 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2443 ;; We are after \n now, so look for the rest
2444 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
5c8b7eaf 2445 (progn
db133cb6
RS
2446 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2447 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2448 t)))
2449 (if (and over
2450 (progn
2451 (forward-paragraph -1)
2452 (forward-word 1)
2453 (setq pos (point))
2454 (setq cut (buffer-substring (point)
2455 (save-excursion
2456 (end-of-line)
2457 (point))))
2458 (delete-char (- (save-excursion (end-of-line) (point))
2459 (point)))
2460 (setq res (expand-abbrev))
2461 (save-excursion
2462 (goto-char pos)
2463 (insert cut))
2464 res))
2465 nil
2466 (cperl-ensure-newlines (if cut 2 4))
2467 (forward-line 2)))
2468 ((get-text-property (point) 'in-pod) ; In POD section
2469 (cperl-ensure-newlines 4)
2470 (forward-line 2))
f83d2997
KH
2471 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2472 (forward-line 1)
2473 (cperl-indent-line))
2474 (t
2475 (newline-and-indent))))))
2476
2477(defun cperl-electric-semi (arg)
2478 "Insert character and correct line's indentation."
2479 (interactive "P")
2480 (if cperl-auto-newline
2481 (cperl-electric-terminator arg)
6c389151
SM
2482 (self-insert-command (prefix-numeric-value arg))
2483 (if cperl-autoindent-on-semi
2484 (cperl-indent-line))))
f83d2997
KH
2485
2486(defun cperl-electric-terminator (arg)
2487 "Insert character and correct line's indentation."
2488 (interactive "P")
83261a2f
SM
2489 (let ((end (point))
2490 (auto (and cperl-auto-newline
2491 (or (not (eq last-command-char ?:))
2492 cperl-auto-newline-after-colon)))
2493 insertpos)
5c8b7eaf 2494 (if (and ;;(not arg)
f83d2997
KH
2495 (eolp)
2496 (not (save-excursion
2497 (beginning-of-line)
2498 (skip-chars-forward " \t")
2499 (or
2500 ;; Ignore in comment lines
2501 (= (following-char) ?#)
2502 ;; Colon is special only after a label
2503 ;; So quickly rule out most other uses of colon
2504 ;; and do no indentation for them.
2505 (and (eq last-command-char ?:)
2506 (save-excursion
2507 (forward-word 1)
2508 (skip-chars-forward " \t")
2509 (and (< (point) end)
2510 (progn (goto-char (- end 1))
2511 (not (looking-at ":"))))))
2512 (progn
2513 (beginning-of-defun)
2514 (let ((pps (parse-partial-sexp (point) end)))
2515 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2516 (progn
2517 (self-insert-command (prefix-numeric-value arg))
2518 ;;(forward-char -1)
2519 (if auto (setq insertpos (point-marker)))
2520 ;;(forward-char 1)
2521 (cperl-indent-line)
2522 (if auto
2523 (progn
2524 (newline)
2525 (cperl-indent-line)))
f83d2997
KH
2526 (save-excursion
2527 (if insertpos (goto-char (1- (marker-position insertpos)))
2528 (forward-char -1))
2529 (delete-char 1))))
2530 (if insertpos
2531 (save-excursion
2532 (goto-char insertpos)
2533 (self-insert-command (prefix-numeric-value arg)))
2534 (self-insert-command (prefix-numeric-value arg)))))
2535
2536(defun cperl-electric-backspace (arg)
f739b53b
SM
2537 "Backspace, or remove the whitespace around the point inserted by an electric
2538key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
f83d2997 2539 (interactive "p")
5c8b7eaf
SS
2540 (if (and cperl-auto-newline
2541 (memq last-command '(cperl-electric-semi
f83d2997
KH
2542 cperl-electric-terminator
2543 cperl-electric-lbrace))
b5b0cb34 2544 (memq (preceding-char) '(?\s ?\t ?\n)))
f83d2997 2545 (let (p)
5c8b7eaf 2546 (if (eq last-command 'cperl-electric-lbrace)
f83d2997
KH
2547 (skip-chars-forward " \t\n"))
2548 (setq p (point))
2549 (skip-chars-backward " \t\n")
2550 (delete-region (point) p))
db133cb6
RS
2551 (and (eq last-command 'cperl-electric-else)
2552 ;; We are removing the whitespace *inside* cperl-electric-else
2553 (setq this-command 'cperl-electric-else-really))
5c8b7eaf 2554 (if (and cperl-auto-newline
db133cb6 2555 (eq last-command 'cperl-electric-else-really)
b5b0cb34 2556 (memq (preceding-char) '(?\s ?\t ?\n)))
db133cb6
RS
2557 (let (p)
2558 (skip-chars-forward " \t\n")
2559 (setq p (point))
2560 (skip-chars-backward " \t\n")
2561 (delete-region (point) p))
f739b53b
SM
2562 (if cperl-electric-backspace-untabify
2563 (backward-delete-char-untabify arg)
2564 (delete-backward-char arg)))))
f83d2997 2565
d6156ce8
KS
2566(put 'cperl-electric-backspace 'delete-selection 'supersede)
2567
4ab89e7b 2568(defun cperl-inside-parens-p () ;; NOT USED????
f83d2997
KH
2569 (condition-case ()
2570 (save-excursion
2571 (save-restriction
2572 (narrow-to-region (point)
2573 (progn (beginning-of-defun) (point)))
2574 (goto-char (point-max))
2575 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2576 (error nil)))
2577\f
2578(defun cperl-indent-command (&optional whole-exp)
2579 "Indent current line as Perl code, or in some cases insert a tab character.
5c8b7eaf 2580If `cperl-tab-always-indent' is non-nil (the default), always indent current
db133cb6 2581line. Otherwise, indent the current line only if point is at the left margin
f83d2997
KH
2582or in the line's indentation; otherwise insert a tab.
2583
2584A numeric argument, regardless of its value,
2585means indent rigidly all the lines of the expression starting after point
2586so that this line becomes properly indented.
2587The relative indentation among the lines of the expression are preserved."
2588 (interactive "P")
5bd52f0e 2589 (cperl-update-syntaxification (point) (point))
f83d2997
KH
2590 (if whole-exp
2591 ;; If arg, always indent this line as Perl
2592 ;; and shift remaining lines of expression the same amount.
2593 (let ((shift-amt (cperl-indent-line))
2594 beg end)
2595 (save-excursion
2596 (if cperl-tab-always-indent
2597 (beginning-of-line))
2598 (setq beg (point))
2599 (forward-sexp 1)
2600 (setq end (point))
2601 (goto-char beg)
2602 (forward-line 1)
2603 (setq beg (point)))
db133cb6 2604 (if (and shift-amt (> end beg))
f83d2997
KH
2605 (indent-code-rigidly beg end shift-amt "#")))
2606 (if (and (not cperl-tab-always-indent)
2607 (save-excursion
2608 (skip-chars-backward " \t")
2609 (not (bolp))))
2610 (insert-tab)
2611 (cperl-indent-line))))
2612
5bd52f0e 2613(defun cperl-indent-line (&optional parse-data)
f83d2997
KH
2614 "Indent current line as Perl code.
2615Return the amount the indentation changed by."
83261a2f
SM
2616 (let ((case-fold-search nil)
2617 (pos (- (point-max) (point)))
2618 indent i beg shift-amt)
5bd52f0e 2619 (setq indent (cperl-calculate-indent parse-data)
db133cb6 2620 i indent)
f83d2997
KH
2621 (beginning-of-line)
2622 (setq beg (point))
2623 (cond ((or (eq indent nil) (eq indent t))
db133cb6 2624 (setq indent (current-indentation) i nil))
f83d2997
KH
2625 ;;((eq indent t) ; Never?
2626 ;; (setq indent (cperl-calculate-indent-within-comment)))
2627 ;;((looking-at "[ \t]*#")
2628 ;; (setq indent 0))
2629 (t
2630 (skip-chars-forward " \t")
2631 (if (listp indent) (setq indent (car indent)))
2632 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2633 (and (> indent 0)
2634 (setq indent (max cperl-min-label-indent
2635 (+ indent cperl-label-offset)))))
2636 ((= (following-char) ?})
2637 (setq indent (- indent cperl-indent-level)))
2638 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2639 (setq indent (+ indent cperl-close-paren-offset)))
2640 ((= (following-char) ?{)
2641 (setq indent (+ indent cperl-brace-offset))))))
2642 (skip-chars-forward " \t")
db133cb6
RS
2643 (setq shift-amt (and i (- indent (current-column))))
2644 (if (or (not shift-amt)
2645 (zerop shift-amt))
f83d2997
KH
2646 (if (> (- (point-max) pos) (point))
2647 (goto-char (- (point-max) pos)))
4ab89e7b
SM
2648 ;;;(delete-region beg (point))
2649 ;;;(indent-to indent)
2650 (cperl-make-indent indent)
f83d2997
KH
2651 ;; If initial point was within line's indentation,
2652 ;; position after the indentation. Else stay at same point in text.
2653 (if (> (- (point-max) pos) (point))
2654 (goto-char (- (point-max) pos))))
2655 shift-amt))
2656
2657(defun cperl-after-label ()
2658 ;; Returns true if the point is after label. Does not do save-excursion.
2659 (and (eq (preceding-char) ?:)
2660 (memq (char-syntax (char-after (- (point) 2)))
2661 '(?w ?_))
2662 (progn
2663 (backward-sexp)
2664 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2665
2666(defun cperl-get-state (&optional parse-start start-state)
5bd52f0e
RS
2667 ;; returns list (START STATE DEPTH PRESTART),
2668 ;; START is a good place to start parsing, or equal to
5c8b7eaf 2669 ;; PARSE-START if preset,
5bd52f0e
RS
2670 ;; STATE is what is returned by `parse-partial-sexp'.
2671 ;; DEPTH is true is we are immediately after end of block
2672 ;; which contains START.
2673 ;; PRESTART is the position basing on which START was found.
f83d2997
KH
2674 (save-excursion
2675 (let ((start-point (point)) depth state start prestart)
5bd52f0e
RS
2676 (if (and parse-start
2677 (<= parse-start start-point))
f83d2997 2678 (goto-char parse-start)
5bd52f0e
RS
2679 (beginning-of-defun)
2680 (setq start-state nil))
f83d2997
KH
2681 (setq prestart (point))
2682 (if start-state nil
2683 ;; Try to go out, if sub is not on the outermost level
2684 (while (< (point) start-point)
2685 (setq start (point) parse-start start depth nil
2686 state (parse-partial-sexp start start-point -1))
2687 (if (> (car state) -1) nil
2688 ;; The current line could start like }}}, so the indentation
2689 ;; corresponds to a different level than what we reached
2690 (setq depth t)
2691 (beginning-of-line 2))) ; Go to the next line.
2692 (if start (goto-char start))) ; Not at the start of file
2693 (setq start (point))
f83d2997
KH
2694 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2695 (list start state depth prestart))))
2696
f83d2997
KH
2697(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2698
4ab89e7b
SM
2699(defun cperl-beginning-of-property (p prop &optional lim)
2700 "Given that P has a property PROP, find where the property starts.
2701Will not look before LIM."
2702 ;;; XXXX What to do at point-max???
2703 (or (previous-single-property-change (cperl-1+ p) prop lim)
2704 (point-min))
2705;;; (cond ((eq p (point-min))
2706;;; p)
2707;;; ((and lim (<= p lim))
2708;;; p)
2709;;; ((not (get-text-property (1- p) prop))
2710;;; p)
2711;;; (t (or (previous-single-property-change p look-prop lim)
2712;;; (point-min))))
2713 )
2714
2715(defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
2716 ;; Old workhorse for calculation of indentation; the major problem
2717 ;; is that it mixes the sniffer logic to understand what the current line
2718 ;; MEANS with the logic to actually calculate where to indent it.
2719 ;; The latter part should be eventually moved to `cperl-calculate-indent';
2720 ;; actually, this is mostly done now...
f739b53b 2721 (cperl-update-syntaxification (point) (point))
4ab89e7b
SM
2722 (let ((res (get-text-property (point) 'syntax-type)))
2723 (save-excursion
2724 (cond
2725 ((and (memq res '(pod here-doc here-doc-delim format))
2726 (not (get-text-property (point) 'indentable)))
2727 (vector res))
2728 ;; before start of POD - whitespace found since do not have 'pod!
2729 ((looking-at "[ \t]*\n=")
2730 (error "Spaces before POD section!"))
2731 ((and (not cperl-indent-left-aligned-comments)
2732 (looking-at "^#"))
2733 [comment-special:at-beginning-of-line])
2734 ((get-text-property (point) 'in-pod)
2735 [in-pod])
2736 (t
2737 (beginning-of-line)
2738 (let* ((indent-point (point))
2739 (char-after-pos (save-excursion
2740 (skip-chars-forward " \t")
2741 (point)))
2742 (char-after (char-after char-after-pos))
2743 (pre-indent-point (point))
2744 p prop look-prop is-block delim)
2745 (save-excursion ; Know we are not in POD, find appropriate pos before
83261a2f
SM
2746 (cperl-backward-to-noncomment nil)
2747 (setq p (max (point-min) (1- (point)))
2748 prop (get-text-property p 'syntax-type)
2749 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2750 'syntax-type))
2751 (if (memq prop '(pod here-doc format here-doc-delim))
2752 (progn
4ab89e7b 2753 (goto-char (cperl-beginning-of-property p look-prop))
83261a2f 2754 (beginning-of-line)
4ab89e7b
SM
2755 (setq pre-indent-point (point)))))
2756 (goto-char pre-indent-point) ; Orig line skipping preceeding pod/etc
2757 (let* ((case-fold-search nil)
2758 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2759 (start (or (nth 2 parse-data) ; last complete sexp terminated
2760 (nth 0 s-s))) ; Good place to start parsing
2761 (state (nth 1 s-s))
2762 (containing-sexp (car (cdr state)))
2763 old-indent)
2764 (if (and
2765 ;;containing-sexp ;; We are buggy at toplevel :-(
2766 parse-data)
2767 (progn
2768 (setcar parse-data pre-indent-point)
2769 (setcar (cdr parse-data) state)
2770 (or (nth 2 parse-data)
2771 (setcar (cddr parse-data) start))
2772 ;; Before this point: end of statement
2773 (setq old-indent (nth 3 parse-data))))
2774 (cond ((get-text-property (point) 'indentable)
2775 ;; indent to "after" the surrounding open
2776 ;; (same offset as `cperl-beautify-regexp-piece'),
2777 ;; skip blanks if we do not close the expression.
2778 (setq delim ; We do not close the expression
2779 (get-text-property
2780 (cperl-1+ char-after-pos) 'indentable)
2781 p (1+ (cperl-beginning-of-property
2782 (point) 'indentable))
2783 is-block ; misused for: preceeding line in REx
2784 (save-excursion ; Find preceeding line
2785 (cperl-backward-to-noncomment p)
2786 (beginning-of-line)
2787 (if (<= (point) p)
2788 (progn ; get indent from the first line
2789 (goto-char p)
2790 (skip-chars-forward " \t")
2791 (if (memq (char-after (point))
2792 (append "#\n" nil))
2793 nil ; Can't use intentation of this line...
2794 (point)))
2795 (skip-chars-forward " \t")
2796 (point)))
2797 prop (parse-partial-sexp p char-after-pos))
2798 (cond ((not delim) ; End the REx, ignore is-block
2799 (vector 'indentable 'terminator p is-block))
2800 (is-block ; Indent w.r.t. preceeding line
2801 (vector 'indentable 'cont-line char-after-pos
2802 is-block char-after p))
2803 (t ; No preceeding line...
2804 (vector 'indentable 'first-line p))))
2805 ((get-text-property char-after-pos 'REx-part2)
2806 (vector 'REx-part2 (point)))
2807 ((nth 3 state)
2808 [comment])
2809 ((nth 4 state)
2810 [string])
2811 ;; XXXX Do we need to special-case this?
2812 ((null containing-sexp)
2813 ;; Line is at top level. May be data or function definition,
2814 ;; or may be function argument declaration.
2815 ;; Indent like the previous top level line
2816 ;; unless that ends in a closeparen without semicolon,
2817 ;; in which case this line is the first argument decl.
2818 (skip-chars-forward " \t")
2819 (cperl-backward-to-noncomment (or old-indent (point-min)))
2820 (setq state
2821 (or (bobp)
2822 (eq (point) old-indent) ; old-indent was at comment
2823 (eq (preceding-char) ?\;)
2824 ;; Had ?\) too
2825 (and (eq (preceding-char) ?\})
2826 (cperl-after-block-and-statement-beg
2827 (point-min))) ; Was start - too close
2828 (memq char-after (append ")]}" nil))
2829 (and (eq (preceding-char) ?\:) ; label
83261a2f
SM
2830 (progn
2831 (forward-sexp -1)
4ab89e7b
SM
2832 (skip-chars-backward " \t")
2833 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2834 (get-text-property (point) 'first-format-line)))
2835
2836 ;; Look at previous line that's at column 0
2837 ;; to determine whether we are in top-level decls
2838 ;; or function's arg decls. Set basic-indent accordingly.
2839 ;; Now add a little if this is a continuation line.
2840 (and state
2841 parse-data
2842 (not (eq char-after ?\C-j))
2843 (setcdr (cddr parse-data)
2844 (list pre-indent-point)))
2845 (vector 'toplevel start char-after state (nth 2 s-s)))
2846 ((not
2847 (or (setq is-block
2848 (and (setq delim (= (char-after containing-sexp) ?{))
2849 (save-excursion ; Is it a hash?
2850 (goto-char containing-sexp)
2851 (cperl-block-p))))
2852 cperl-indent-parens-as-block))
2853 ;; group is an expression, not a block:
2854 ;; indent to just after the surrounding open parens,
2855 ;; skip blanks if we do not close the expression.
2856 (goto-char (1+ containing-sexp))
2857 (or (memq char-after
2858 (append (if delim "}" ")]}") nil))
2859 (looking-at "[ \t]*\\(#\\|$\\)")
2860 (skip-chars-forward " \t"))
2861 (setq old-indent (point)) ; delim=is-brace
2862 (vector 'in-parens char-after (point) delim containing-sexp))
2863 (t
2864 ;; Statement level. Is it a continuation or a new statement?
2865 ;; Find previous non-comment character.
2866 (goto-char pre-indent-point) ; Skip one level of POD/etc
2867 (cperl-backward-to-noncomment containing-sexp)
2868 ;; Back up over label lines, since they don't
2869 ;; affect whether our line is a continuation.
2870 ;; (Had \, too)
2871 (while;;(or (eq (preceding-char) ?\,)
2872 (and (eq (preceding-char) ?:)
2873 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2874 (memq (char-syntax (char-after (- (point) 2)))
2875 '(?w ?_))))
2876 ;;)
2877 ;; This is always FALSE?
2878 (if (eq (preceding-char) ?\,)
2879 ;; Will go to beginning of line, essentially.
2880 ;; Will ignore embedded sexpr XXXX.
2881 (cperl-backward-to-start-of-continued-exp containing-sexp))
2882 (beginning-of-line)
2883 (cperl-backward-to-noncomment containing-sexp))
2884 ;; Now we get non-label preceeding the indent point
2885 (if (not (or (eq (1- (point)) containing-sexp)
2886 (memq (preceding-char)
2887 (append (if is-block " ;{" " ,;{") '(nil)))
2888 (and (eq (preceding-char) ?\})
2889 (cperl-after-block-and-statement-beg
2890 containing-sexp))
2891 (get-text-property (point) 'first-format-line)))
2892 ;; This line is continuation of preceding line's statement;
2893 ;; indent `cperl-continued-statement-offset' more than the
2894 ;; previous line of the statement.
2895 ;;
2896 ;; There might be a label on this line, just
2897 ;; consider it bad style and ignore it.
2898 (progn
2899 (cperl-backward-to-start-of-continued-exp containing-sexp)
2900 (vector 'continuation (point) char-after is-block delim))
2901 ;; This line starts a new statement.
2902 ;; Position following last unclosed open brace
2903 (goto-char containing-sexp)
2904 ;; Is line first statement after an open-brace?
2905 (or
2906 ;; If no, find that first statement and indent like
2907 ;; it. If the first statement begins with label, do
2908 ;; not believe when the indentation of the label is too
2909 ;; small.
2910 (save-excursion
2911 (forward-char 1)
2912 (let ((colon-line-end 0))
2913 (while
2914 (progn (skip-chars-forward " \t\n")
2915 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
2916 ;; Skip over comments and labels following openbrace.
2917 (cond ((= (following-char) ?\#)
2918 (forward-line 1))
2919 ((= (following-char) ?\=)
2920 (goto-char
2921 (or (next-single-property-change (point) 'in-pod)
2922 (point-max)))) ; do not loop if no syntaxification
2923 ;; label:
2924 (t
2925 (save-excursion (end-of-line)
2926 (setq colon-line-end (point)))
2927 (search-forward ":"))))
2928 ;; We are at beginning of code (NOT label or comment)
2929 ;; First, the following code counts
2930 ;; if it is before the line we want to indent.
2931 (and (< (point) indent-point)
2932 (vector 'have-prev-sibling (point) colon-line-end
2933 containing-sexp))))
2934 (progn
2935 ;; If no previous statement,
2936 ;; indent it relative to line brace is on.
2937
2938 ;; For open-braces not the first thing in a line,
2939 ;; add in cperl-brace-imaginary-offset.
2940
2941 ;; If first thing on a line: ?????
2942 ;; Move back over whitespace before the openbrace.
2943 (setq ; brace first thing on a line
2944 old-indent (progn (skip-chars-backward " \t") (bolp)))
2945 ;; Should we indent w.r.t. earlier than start?
2946 ;; Move to start of control group, possibly on a different line
2947 (or cperl-indent-wrt-brace
2948 (cperl-backward-to-noncomment (point-min)))
2949 ;; If the openbrace is preceded by a parenthesized exp,
2950 ;; move to the beginning of that;
2951 (if (eq (preceding-char) ?\))
2952 (progn
2953 (forward-sexp -1)
2954 (cperl-backward-to-noncomment (point-min))))
2955 ;; In the case it starts a subroutine, indent with
2956 ;; respect to `sub', not with respect to the
2957 ;; first thing on the line, say in the case of
2958 ;; anonymous sub in a hash.
2959 (if (and;; Is it a sub in group starting on this line?
2960 (cond ((get-text-property (point) 'attrib-group)
2961 (goto-char (cperl-beginning-of-property
2962 (point) 'attrib-group)))
2963 ((eq (preceding-char) ?b)
2964 (forward-sexp -1)
2965 (looking-at "sub\\>")))
2966 (setq p (nth 1 ; start of innermost containing list
2967 (parse-partial-sexp
2968 (save-excursion (beginning-of-line)
2969 (point))
2970 (point)))))
2971 (progn
2972 (goto-char (1+ p)) ; enclosing block on the same line
2973 (skip-chars-forward " \t")
2974 (vector 'code-start-in-block containing-sexp char-after
2975 (and delim (not is-block)) ; is a HASH
2976 old-indent ; brace first thing on a line
2977 t (point) ; have something before...
2978 )
2979 ;;(current-column)
2980 )
2981 ;; Get initial indentation of the line we are on.
2982 ;; If line starts with label, calculate label indentation
2983 (vector 'code-start-in-block containing-sexp char-after
2984 (and delim (not is-block)) ; is a HASH
2985 old-indent ; brace first thing on a line
2986 nil (point) ; nothing interesting before
2987 ))))))))))))))
2988
2989(defvar cperl-indent-rules-alist
2990 '((pod nil) ; via `syntax-type' property
2991 (here-doc nil) ; via `syntax-type' property
2992 (here-doc-delim nil) ; via `syntax-type' property
2993 (format nil) ; via `syntax-type' property
2994 (in-pod nil) ; via `in-pod' property
2995 (comment-special:at-beginning-of-line nil)
2996 (string t)
2997 (comment nil))
2998 "Alist of indentation rules for CPerl mode.
2999The values mean:
3000 nil: do not indent;
3001 number: add this amount of indentation.
3002
3003Not finished.")
3004
3005(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3006 "Return appropriate indentation for current line as Perl code.
3007In usual case returns an integer: the column to indent to.
3008Returns nil if line starts inside a string, t if in a comment.
3009
3010Will not correct the indentation for labels, but will correct it for braces
3011and closing parentheses and brackets."
3012 ;; This code is still a broken architecture: in some cases we need to
3013 ;; compensate for some modifications which `cperl-indent-line' will add later
3014 (save-excursion
3015 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3016 (cond
3017 ;;((or (null i) (eq i t) (numberp i))
3018 ;; i)
3019 ((vectorp i)
3020 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3021 (cond
3022 (what (cadr what)) ; Load from table
3023 ;;
3024 ;; Indenters for regular expressions with //x and qw()
3025 ;;
3026 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3027 (goto-char (elt i 1))
3028 (condition-case nil ; Use indentation of the 1st part
3029 (forward-sexp -1))
3030 (current-column))
3031 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3032 (cond ;;; [indentable terminator start-pos is-block]
3033 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3034 (goto-char (elt i 2)) ; After opening parens
3035 (1- (current-column)))
3036 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3037 (goto-char (elt i 2))
3038 (+ (or cperl-regexp-indent-step cperl-indent-level)
3039 -1
3040 (current-column)))
3041 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3042 ;; Indent as the level after closing parens
3043 (goto-char (elt i 2)) ; indent line
3044 (skip-chars-forward " \t)") ; Skip closing parens
3045 (setq p (point))
3046 (goto-char (elt i 3)) ; previous line
3047 (skip-chars-forward " \t)") ; Skip closing parens
3048 ;; Number of parens in between:
3049 (setq p (nth 0 (parse-partial-sexp (point) p))
3050 what (elt i 4)) ; First char on current line
3051 (goto-char (elt i 3)) ; previous line
3052 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3053 (cond ((eq what ?\) )
3054 (- cperl-close-paren-offset)) ; compensate
3055 ((eq what ?\| )
3056 (- (or cperl-regexp-indent-step cperl-indent-level)))
3057 (t 0))
3058 (if (eq (following-char) ?\| )
3059 (or cperl-regexp-indent-step cperl-indent-level)
3060 0)
3061 (current-column)))
3062 (t
3063 (error "Unrecognized value of indent: %s" i))))
3064 ;;
3065 ;; Indenter for stuff at toplevel
3066 ;;
3067 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3068 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3069 (goto-char (elt i 1)) ; start = Good place to start parsing
3070 (- (current-indentation) ;
3071 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3072 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3073 ;; Look at previous line that's at column 0
3074 ;; to determine whether we are in top-level decls
3075 ;; or function's arg decls. Set basic-indent accordingly.
3076 ;; Now add a little if this is a continuation line.
3077 (if (elt i 3) ; state (XXX What is the semantic???)
3078 0
3079 cperl-continued-statement-offset)))
3080 ;;
3081 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3082 ;;
3083 ((eq 'in-parens (elt i 0))
3084 ;; in-parens char-after old-indent-point is-brace containing-sexp
3085
3086 ;; group is an expression, not a block:
3087 ;; indent to just after the surrounding open parens,
3088 ;; skip blanks if we do not close the expression.
3089 (+ (progn
3090 (goto-char (elt i 2)) ; old-indent-point
3091 (current-column))
3092 (if (and (elt i 3) ; is-brace
3093 (eq (elt i 1) ?\})) ; char-after
3094 ;; Correct indentation of trailing ?\}
3095 (+ cperl-indent-level cperl-close-paren-offset)
3096 0)))
3097 ;;
3098 ;; Indenter for continuation lines
3099 ;;
3100 ((eq 'continuation (elt i 0))
3101 ;; [continuation statement-start char-after is-block is-brace]
3102 (goto-char (elt i 1)) ; statement-start
3103 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
3104 0 ; Closing parenth
3105 cperl-continued-statement-offset)
3106 (if (or (elt i 3) ; is-block
3107 (not (elt i 4)) ; is-brace
3108 (not (eq (elt i 2) ?\}))) ; char-after
3109 0
3110 ;; Now it is a hash reference
3111 (+ cperl-indent-level cperl-close-paren-offset))
3112 ;; Labels do not take :: ...
3113 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3114 (if (> (current-indentation) cperl-min-label-indent)
3115 (- (current-indentation) cperl-label-offset)
3116 ;; Do not move `parse-data', this should
3117 ;; be quick anyway (this comment comes
3118 ;; from different location):
3119 (cperl-calculate-indent))
3120 (current-column))
3121 (if (eq (elt i 2) ?\{) ; char-after
3122 cperl-continued-brace-offset 0)))
3123 ;;
3124 ;; Indenter for lines in a block which are not leading lines
3125 ;;
3126 ((eq 'have-prev-sibling (elt i 0))
3127 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
3128 (goto-char (elt i 1))
3129 (if (> (elt i 2) (point)) ; colon-line-end; After-label, same line
3130 (if (> (current-indentation)
3131 cperl-min-label-indent)
3132 (- (current-indentation) cperl-label-offset)
3133 ;; Do not believe: `max' was involved in calculation of indent
3134 (+ cperl-indent-level
3135 (save-excursion
3136 (goto-char (elt i 3)) ; block-start
3137 (current-indentation))))
3138 (current-column)))
3139 ;;
3140 ;; Indenter for the first line in a block
3141 ;;
3142 ((eq 'code-start-in-block (elt i 0))
3143 ;;[code-start-in-block before-brace char-after
3144 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3145 ;; group-starts-before-start-of-sub start-of-control-group]
3146 (goto-char (elt i 1))
3147 ;; For open brace in column zero, don't let statement
3148 ;; start there too. If cperl-indent-level=0,
3149 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3150 (+ (if (and (bolp) (zerop cperl-indent-level))
3151 (+ cperl-brace-offset cperl-continued-statement-offset)
3152 cperl-indent-level)
3153 (if (and (elt i 3) ; is-a-HASH-ref
3154 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3155 (+ cperl-indent-level cperl-close-paren-offset)
3156 0)
3157 ;; Unless openbrace is the first nonwhite thing on the line,
3158 ;; add the cperl-brace-imaginary-offset.
3159 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3160 cperl-brace-imaginary-offset)
3161 (progn
3162 (goto-char (elt i 6)) ; start-of-control-group
3163 (if (elt i 5) ; group-starts-before-start-of-sub
3164 (current-column)
3165 ;; Get initial indentation of the line we are on.
3166 ;; If line starts with label, calculate label indentation
3167 (if (save-excursion
3168 (beginning-of-line)
3169 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3170 (if (> (current-indentation) cperl-min-label-indent)
3171 (- (current-indentation) cperl-label-offset)
3172 ;; Do not move `parse-data', this should
3173 ;; be quick anyway:
3174 (cperl-calculate-indent))
3175 (current-indentation))))))
3176 (t
3177 (error "Unrecognized value of indent: %s" i))))
3178 (t
3179 (error "Got strange value of indent: %s" i))))))
3180
3181(defvar cperl-indent-alist
3182 '((string nil)
3183 (comment nil)
3184 (toplevel 0)
3185 (toplevel-after-parenth 2)
3186 (toplevel-continued 2)
3187 (expression 1))
3188 "Alist of indentation rules for CPerl mode.
3189The values mean:
3190 nil: do not indent;
3191 number: add this amount of indentation.
3192
3193Not finished, not used.")
3194
3195(defun cperl-where-am-i (&optional parse-start start-state)
3196 ;; Unfinished
3197 "Return a list of lists ((TYPE POS)...) of good points before the point.
3198POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
3199
3200Not finished, not used."
3201 (save-excursion
3202 (let* ((start-point (point)) unused
3203 (s-s (cperl-get-state))
3204 (start (nth 0 s-s))
3205 (state (nth 1 s-s))
3206 (prestart (nth 3 s-s))
3207 (containing-sexp (car (cdr state)))
3208 (case-fold-search nil)
3209 (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
3210 (cond ((nth 3 state) ; In string
3211 (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
3212 ((nth 4 state) ; In comment
3213 (setq res (cons '(comment) res)))
3214 ((null containing-sexp)
3215 ;; Line is at top level.
3216 ;; Indent like the previous top level line
3217 ;; unless that ends in a closeparen without semicolon,
3218 ;; in which case this line is the first argument decl.
3219 (cperl-backward-to-noncomment (or parse-start (point-min)))
3220 ;;(skip-chars-backward " \t\f\n")
3221 (cond
3222 ((or (bobp)
3223 (memq (preceding-char) (append ";}" nil)))
3224 (setq res (cons (list 'toplevel start) res)))
3225 ((eq (preceding-char) ?\) )
3226 (setq res (cons (list 'toplevel-after-parenth start) res)))
3227 (t
3228 (setq res (cons (list 'toplevel-continued start) res)))))
3229 ((/= (char-after containing-sexp) ?{)
3230 ;; line is expression, not statement:
3231 ;; indent to just after the surrounding open.
3232 ;; skip blanks if we do not close the expression.
3233 (setq res (cons (list 'expression-blanks
3234 (progn
3235 (goto-char (1+ containing-sexp))
3236 (or (looking-at "[ \t]*\\(#\\|$\\)")
3237 (skip-chars-forward " \t"))
3238 (point)))
3239 (cons (list 'expression containing-sexp) res))))
3240 ((progn
3241 ;; Containing-expr starts with \{. Check whether it is a hash.
3242 (goto-char containing-sexp)
3243 (not (cperl-block-p)))
3244 (setq res (cons (list 'expression-blanks
3245 (progn
3246 (goto-char (1+ containing-sexp))
3247 (or (looking-at "[ \t]*\\(#\\|$\\)")
3248 (skip-chars-forward " \t"))
3249 (point)))
3250 (cons (list 'expression containing-sexp) res))))
3251 (t
3252 ;; Statement level.
3253 (setq res (cons (list 'in-block containing-sexp) res))
3254 ;; Is it a continuation or a new statement?
3255 ;; Find previous non-comment character.
3256 (cperl-backward-to-noncomment containing-sexp)
3257 ;; Back up over label lines, since they don't
3258 ;; affect whether our line is a continuation.
3259 ;; Back up comma-delimited lines too ?????
3260 (while (or (eq (preceding-char) ?\,)
3261 (save-excursion (cperl-after-label)))
3262 (if (eq (preceding-char) ?\,)
3263 ;; Will go to beginning of line, essentially
3264 ;; Will ignore embedded sexpr XXXX.
3265 (cperl-backward-to-start-of-continued-exp containing-sexp))
3266 (beginning-of-line)
3267 (cperl-backward-to-noncomment containing-sexp))
3268 ;; Now we get the answer.
3269 (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
3270 ;; This line is continuation of preceding line's statement.
3271 (list (list 'statement-continued containing-sexp))
3272 ;; This line starts a new statement.
3273 ;; Position following last unclosed open.
3274 (goto-char containing-sexp)
3275 ;; Is line first statement after an open-brace?
3276 (or
3277 ;; If no, find that first statement and indent like
3278 ;; it. If the first statement begins with label, do
3279 ;; not believe when the indentation of the label is too
3280 ;; small.
3281 (save-excursion
3282 (forward-char 1)
3283 (let ((colon-line-end 0))
3284 (while (progn (skip-chars-forward " \t\n" start-point)
3285 (and (< (point) start-point)
3286 (looking-at
3287 "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
3288 ;; Skip over comments and labels following openbrace.
3289 (cond ((= (following-char) ?\#)
3290 ;;(forward-line 1)
3291 (end-of-line))
3292 ;; label:
3293 (t
3294 (save-excursion (end-of-line)
3295 (setq colon-line-end (point)))
3296 (search-forward ":"))))
3297 ;; Now at the point, after label, or at start
3298 ;; of first statement in the block.
3299 (and (< (point) start-point)
3300 (if (> colon-line-end (point))
3301 ;; Before statement after label
3302 (if (> (current-indentation)
3303 cperl-min-label-indent)
3304 (list (list 'label-in-block (point)))
3305 ;; Do not believe: `max' is involved
3306 (list
3307 (list 'label-in-block-min-indent (point))))
3308 ;; Before statement
3309 (list 'statement-in-block (point))))))
3310 ;; If no previous statement,
3311 ;; indent it relative to line brace is on.
3312 ;; For open brace in column zero, don't let statement
3313 ;; start there too. If cperl-indent-level is zero,
3314 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3315 ;; For open-braces not the first thing in a line,
3316 ;; add in cperl-brace-imaginary-offset.
3317
3318 ;; If first thing on a line: ?????
3319 (setq unused ; This is not finished...
3320 (+ (if (and (bolp) (zerop cperl-indent-level))
3321 (+ cperl-brace-offset cperl-continued-statement-offset)
3322 cperl-indent-level)
3323 ;; Move back over whitespace before the openbrace.
3324 ;; If openbrace is not first nonwhite thing on the line,
3325 ;; add the cperl-brace-imaginary-offset.
3326 (progn (skip-chars-backward " \t")
3327 (if (bolp) 0 cperl-brace-imaginary-offset))
3328 ;; If the openbrace is preceded by a parenthesized exp,
3329 ;; move to the beginning of that;
3330 ;; possibly a different line
3331 (progn
3332 (if (eq (preceding-char) ?\))
3333 (forward-sexp -1))
3334 ;; Get initial indentation of the line we are on.
3335 ;; If line starts with label, calculate label indentation
3336 (if (save-excursion
3337 (beginning-of-line)
3338 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3339 (if (> (current-indentation) cperl-min-label-indent)
3340 (- (current-indentation) cperl-label-offset)
3341 (cperl-calculate-indent))
3342 (current-indentation)))))))))
3343 res)))
f83d2997
KH
3344
3345(defun cperl-calculate-indent-within-comment ()
3346 "Return the indentation amount for line, assuming that
3347the current line is to be regarded as part of a block comment."
3348 (let (end star-start)
3349 (save-excursion
3350 (beginning-of-line)
3351 (skip-chars-forward " \t")
3352 (setq end (point))
3353 (and (= (following-char) ?#)
3354 (forward-line -1)
3355 (cperl-to-comment-or-eol)
3356 (setq end (point)))
3357 (goto-char end)
3358 (current-column))))
3359
3360
3361(defun cperl-to-comment-or-eol ()
029cb4d5 3362 "Go to position before comment on the current line, or to end of line.
4ab89e7b
SM
3363Returns true if comment is found. In POD will not move the point."
3364 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3365 ;; then looks for literal # or end-of-line.
3366 (let (state stop-in cpoint (lim (progn (end-of-line) (point))) pr e)
3367 (or cperl-font-locking
3368 (cperl-update-syntaxification lim lim))
83261a2f 3369 (beginning-of-line)
4ab89e7b
SM
3370 (if (setq pr (get-text-property (point) 'syntax-type))
3371 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3372 (if (or (eq pr 'pod)
3373 (if (or (not e) (> e lim)) ; deep inside a group
3374 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
83261a2f 3375 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
4ab89e7b
SM
3376 ;; Else - need to do it the hard way
3377 (and (and e (<= e lim))
3378 (goto-char e))
83261a2f
SM
3379 (while (not stop-in)
3380 (setq state (parse-partial-sexp (point) lim nil nil nil t))
f83d2997 3381 ; stop at comment
83261a2f
SM
3382 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3383 (if (nth 4 state) ; After `#';
f83d2997
KH
3384 ; (nth 2 state) can be
3385 ; beginning of m,s,qq and so
3386 ; on
83261a2f
SM
3387 (if (nth 2 state)
3388 (progn
3389 (setq cpoint (point))
3390 (goto-char (nth 2 state))
3391 (cond
3392 ((looking-at "\\(s\\|tr\\)\\>")
3393 (or (re-search-forward
3394 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3395 lim 'move)
3396 (setq stop-in t)))
3397 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3398 (or (re-search-forward
3399 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3400 lim 'move)
3401 (setq stop-in t)))
3402 (t ; It was fair comment
3403 (setq stop-in t) ; Finish
3404 (goto-char (1- cpoint)))))
3405 (setq stop-in t) ; Finish
3406 (forward-char -1))
15ca5699 3407 (setq stop-in t))) ; Finish
83261a2f 3408 (nth 4 state))))
f83d2997 3409
f83d2997
KH
3410(defsubst cperl-modify-syntax-type (at how)
3411 (if (< at (point-max))
3412 (progn
3413 (put-text-property at (1+ at) 'syntax-table how)
4ab89e7b 3414 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
f83d2997
KH
3415
3416(defun cperl-protect-defun-start (s e)
3417 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3418 (save-excursion
3419 (goto-char s)
3420 (while (re-search-forward "^\\s(" e 'to-end)
3421 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3422
5bd52f0e 3423(defun cperl-commentify (bb e string &optional noface)
5c8b7eaf 3424 (if cperl-use-syntax-table-text-property
5bd52f0e
RS
3425 (if (eq noface 'n) ; Only immediate
3426 nil
f83d2997
KH
3427 ;; We suppose that e is _after_ the end of construction, as after eol.
3428 (setq string (if string cperl-st-sfence cperl-st-cfence))
6c389151
SM
3429 (if (> bb (- e 2))
3430 ;; one-char string/comment?!
3431 (cperl-modify-syntax-type bb cperl-st-punct)
3432 (cperl-modify-syntax-type bb string)
3433 (cperl-modify-syntax-type (1- e) string))
f83d2997 3434 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
5c8b7eaf 3435 (put-text-property (1+ bb) (1- e)
f83d2997 3436 'syntax-table cperl-string-syntax-table))
5bd52f0e
RS
3437 (cperl-protect-defun-start bb e))
3438 ;; Fontify
3439 (or noface
3440 (not cperl-pod-here-fontify)
3441 (put-text-property bb e 'face (if string 'font-lock-string-face
3442 'font-lock-comment-face)))))
6c389151 3443
5bd52f0e
RS
3444(defvar cperl-starters '(( ?\( . ?\) )
3445 ( ?\[ . ?\] )
3446 ( ?\{ . ?\} )
3447 ( ?\< . ?\> )))
f83d2997 3448
4ab89e7b
SM
3449(defun cperl-cached-syntax-table (st)
3450 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3451All the entries of the syntax table are \".\", except for a backslash, which
3452is quoting."
3453 (if (car-safe st)
3454 (car st)
3455 (setcar st (make-syntax-table))
3456 (setq st (car st))
3457 (let ((i 0))
3458 (while (< i 256)
3459 (modify-syntax-entry i "." st)
3460 (setq i (1+ i))))
3461 (modify-syntax-entry ?\\ "\\" st)
3462 st))
3463
3464(defun cperl-forward-re (lim end is-2arg st-l err-l argument
f83d2997 3465 &optional ostart oend)
4ab89e7b
SM
3466"Find the end of a regular expression or a stringish construct (q[] etc).
3467The point should be before the starting delimiter.
3468
3469Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3470is s/// or tr/// like expression. If END is nil, generates an error
3471message if needed. If SET-ST is non-nil, will use (or generate) a
3472cached syntax table in ST-L. If ERR-L is non-nil, will store the
3473error message in its CAR (unless it already contains some error
3474message). ARGUMENT should be the name of the construct (used in error
3475messages). OSTART, OEND may be set in recursive calls when processing
3476the second argument of 2ARG construct.
3477
3478Works *before* syntax recognition is done. In IS-2ARG situation may
3479modify syntax-type text property if the situation is too hard."
3480 (let (b starter ender st i i2 go-forward reset-st set-st)
f83d2997
KH
3481 (skip-chars-forward " \t")
3482 ;; ender means matching-char matcher.
5c8b7eaf 3483 (setq b (point)
5bd52f0e
RS
3484 starter (if (eobp) 0 (char-after b))
3485 ender (cdr (assoc starter cperl-starters)))
f83d2997 3486 ;; What if starter == ?\\ ????
4ab89e7b 3487 (setq st (cperl-cached-syntax-table st-l))
f83d2997
KH
3488 (setq set-st t)
3489 ;; Whether we have an intermediate point
3490 (setq i nil)
3491 ;; Prepare the syntax table:
4ab89e7b
SM
3492 (if (not ender) ; m/blah/, s/x//, s/x/y/
3493 (modify-syntax-entry starter "$" st)
3494 (modify-syntax-entry starter (concat "(" (list ender)) st)
3495 (modify-syntax-entry ender (concat ")" (list starter)) st))
f83d2997
KH
3496 (condition-case bb
3497 (progn
5bd52f0e
RS
3498 ;; We use `$' syntax class to find matching stuff, but $$
3499 ;; is recognized the same as $, so we need to check this manually.
f83d2997
KH
3500 (if (and (eq starter (char-after (cperl-1+ b)))
3501 (not ender))
3502 ;; $ has TeXish matching rules, so $$ equiv $...
3503 (forward-char 2)
6c389151 3504 (setq reset-st (syntax-table))
f83d2997
KH
3505 (set-syntax-table st)
3506 (forward-sexp 1)
6c389151
SM
3507 (if (<= (point) (1+ b))
3508 (error "Unfinished regular expression"))
3509 (set-syntax-table reset-st)
3510 (setq reset-st nil)
f83d2997
KH
3511 ;; Now the problem is with m;blah;;
3512 (and (not ender)
3513 (eq (preceding-char)
3514 (char-after (- (point) 2)))
3515 (save-excursion
3516 (forward-char -2)
3517 (= 0 (% (skip-chars-backward "\\\\") 2)))
3518 (forward-char -1)))
5bd52f0e 3519 ;; Now we are after the first part.
f83d2997
KH
3520 (and is-2arg ; Have trailing part
3521 (not ender)
3522 (eq (following-char) starter) ; Empty trailing part
3523 (progn
3524 (or (eq (char-syntax (following-char)) ?.)
3525 ;; Make trailing letter into punctuation
3526 (cperl-modify-syntax-type (point) cperl-st-punct))
3527 (setq is-2arg nil go-forward t))) ; Ignore the tail
3528 (if is-2arg ; Not number => have second part
3529 (progn
3530 (setq i (point) i2 i)
3531 (if ender
b5b0cb34 3532 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
f83d2997
KH
3533 (progn
3534 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3535 (goto-char (match-end 0))
3536 (skip-chars-forward " \t\n\f"))
3537 (setq i2 (point))))
3538 (forward-char -1))
3539 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
5c8b7eaf 3540 (if ender (modify-syntax-entry ender "." st))
f83d2997 3541 (setq set-st nil)
4ab89e7b 3542 (setq ender (cperl-forward-re lim end nil st-l err-l
5bd52f0e 3543 argument starter ender)
f83d2997
KH
3544 ender (nth 2 ender)))))
3545 (error (goto-char lim)
3546 (setq set-st nil)
6c389151
SM
3547 (if reset-st
3548 (set-syntax-table reset-st))
f83d2997
KH
3549 (or end
3550 (message
5bd52f0e 3551 "End of `%s%s%c ... %c' string/RE not found: %s"
f83d2997
KH
3552 argument
3553 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3554 starter (or ender starter) bb)
3555 (or (car err-l) (setcar err-l b)))))
3556 (if set-st
3557 (progn
3558 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3559 (if ender (modify-syntax-entry ender "." st))))
5bd52f0e 3560 ;; i: have 2 args, after end of the first arg
e7f767c2 3561 ;; i2: start of the second arg, if any (before delim if `ender').
5bd52f0e
RS
3562 ;; ender: the last arg bounded by parens-like chars, the second one of them
3563 ;; starter: the starting delimiter of the first arg
5efe6a56 3564 ;; go-forward: has 2 args, and the second part is empty
f83d2997
KH
3565 (list i i2 ender starter go-forward)))
3566
4ab89e7b
SM
3567(defun cperl-forward-group-in-re (&optional st-l)
3568 "Find the end of a group in a REx.
3569Return the error message (if any). Does not work if delimiter is `)'.
3570Works before syntax recognition is done."
3571 ;; Works *before* syntax recognition is done
3572 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3573 (let (st b reset-st)
3574 (condition-case b
3575 (progn
3576 (setq st (cperl-cached-syntax-table st-l))
3577 (modify-syntax-entry ?\( "()" st)
3578 (modify-syntax-entry ?\) ")(" st)
3579 (setq reset-st (syntax-table))
3580 (set-syntax-table st)
3581 (forward-sexp 1))
3582 (error (message
3583 "cperl-forward-group-in-re: error %s" b)))
3584 ;; now restore the initial state
3585 (if st
3586 (progn
3587 (modify-syntax-entry ?\( "." st)
3588 (modify-syntax-entry ?\) "." st)))
3589 (if reset-st
3590 (set-syntax-table reset-st))
3591 b))
3592
3593
83261a2f
SM
3594(defvar font-lock-string-face)
3595;;(defvar font-lock-reference-face)
3596(defvar font-lock-constant-face)
5c8b7eaf 3597(defsubst cperl-postpone-fontification (b e type val &optional now)
5bd52f0e
RS
3598 ;; Do after syntactic fontification?
3599 (if cperl-syntaxify-by-font-lock
3600 (or now (put-text-property b e 'cperl-postpone (cons type val)))
83261a2f 3601 (put-text-property b e type val)))
5bd52f0e
RS
3602
3603;;; Here is how the global structures (those which cannot be
3604;;; recognized locally) are marked:
5c8b7eaf 3605;; a) PODs:
5bd52f0e
RS
3606;; Start-to-end is marked `in-pod' ==> t
3607;; Each non-literal part is marked `syntax-type' ==> `pod'
3608;; Each literal part is marked `syntax-type' ==> `in-pod'
5c8b7eaf 3609;; b) HEREs:
5bd52f0e
RS
3610;; Start-to-end is marked `here-doc-group' ==> t
3611;; The body is marked `syntax-type' ==> `here-doc'
3612;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
5c8b7eaf 3613;; c) FORMATs:
f739b53b
SM
3614;; First line (to =) marked `first-format-line' ==> t
3615;; After-this--to-end is marked `syntax-type' ==> `format'
5c8b7eaf 3616;; d) 'Q'uoted string:
5bd52f0e 3617;; part between markers inclusive is marked `syntax-type' ==> `string'
6c389151 3618;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
4ab89e7b
SM
3619;; second part of s///e is marked `syntax-type' ==> `multiline'
3620;; e) Attributes of subroutines: `attrib-group' ==> t
3621;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3622;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3623
3624;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3625;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
5bd52f0e
RS
3626
3627(defun cperl-unwind-to-safe (before &optional end)
3628 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3629 (let ((pos (point)) opos)
4ab89e7b
SM
3630 (while (and pos (progn
3631 (beginning-of-line)
3632 (get-text-property (setq pos (point)) 'syntax-type)))
3633 (setq opos pos
3634 pos (cperl-beginning-of-property pos 'syntax-type))
3635 (if (eq pos (point-min))
3636 (setq pos nil))
5bd52f0e
RS
3637 (if pos
3638 (if before
3639 (progn
3640 (goto-char (cperl-1- pos))
3641 (beginning-of-line)
3642 (setq pos (point)))
3643 (goto-char (setq pos (cperl-1- pos))))
3644 ;; Up to the start
3645 (goto-char (point-min))))
6c389151
SM
3646 ;; Skip empty lines
3647 (and (looking-at "\n*=")
3648 (/= 0 (skip-chars-backward "\n"))
3649 (forward-char))
3650 (setq pos (point))
5bd52f0e
RS
3651 (if end
3652 ;; Do the same for end, going small steps
4ab89e7b 3653 (save-excursion
5bd52f0e
RS
3654 (while (and end (get-text-property end 'syntax-type))
3655 (setq pos end
4ab89e7b
SM
3656 end (next-single-property-change end 'syntax-type nil (point-max)))
3657 (if end (progn (goto-char end)
3658 (or (bolp) (forward-line 1))
3659 (setq end (point)))))
5bd52f0e
RS
3660 (or end pos)))))
3661
4ab89e7b 3662;;; These are needed for byte-compile (at least with v19)
6c389151 3663(defvar cperl-nonoverridable-face)
4ab89e7b 3664(defvar font-lock-variable-name-face)
6c389151 3665(defvar font-lock-function-name-face)
4ab89e7b
SM
3666(defvar font-lock-keyword-face)
3667(defvar font-lock-builtin-face)
3668(defvar font-lock-type-face)
6c389151 3669(defvar font-lock-comment-face)
4ab89e7b 3670(defvar font-lock-warning-face)
6c389151 3671
4ab89e7b
SM
3672(defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3673 "Syntaxically mark (and fontify) attributes of a subroutine.
3674Should be called with the point before leading colon of an attribute."
3675 ;; Works *before* syntax recognition is done
3676 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3677 (let (st b p reset-st after-first (start (point)) start1 end1)
3678 (condition-case b
3679 (while (looking-at
3680 (concat
3681 "\\(" ; 1=optional? colon
3682 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3683 "\\)"
3684 (if after-first "?" "")
3685 ;; No space between name and paren allowed...
3686 "\\(\\sw+\\)" ; 3=name
3687 "\\((\\)?")) ; 4=optional paren
3688 (and (match-beginning 1)
3689 (cperl-postpone-fontification
3690 (match-beginning 0) (cperl-1+ (match-beginning 0))
3691 'face font-lock-constant-face))
3692 (setq start1 (match-beginning 3) end1 (match-end 3))
3693 (cperl-postpone-fontification start1 end1
3694 'face font-lock-constant-face)
3695 (goto-char end1) ; end or before `('
3696 (if (match-end 4) ; Have attribute arguments...
3697 (progn
3698 (if st nil
3699 (setq st (cperl-cached-syntax-table st-l))
3700 (modify-syntax-entry ?\( "()" st)
3701 (modify-syntax-entry ?\) ")(" st))
3702 (setq reset-st (syntax-table) p (point))
3703 (set-syntax-table st)
3704 (forward-sexp 1)
3705 (set-syntax-table reset-st)
3706 (setq reset-st nil)
3707 (cperl-commentify p (point) t))) ; mark as string
3708 (forward-comment (buffer-size))
3709 (setq after-first t))
3710 (error (message
3711 "L%d: attribute `%s': %s"
3712 (count-lines (point-min) (point))
3713 (and start1 end1 (buffer-substring start1 end1)) b)
3714 (setq start nil)))
3715 (and start
3716 (progn
3717 (put-text-property start (point)
3718 'attrib-group (if (looking-at "{") t 0))
3719 (and pos
3720 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3721 ;; Apparently, we do not need `multiline': faces added now
3722 (put-text-property (+ 3 pos) (cperl-1+ (point))
3723 'syntax-type 'sub-decl))
3724 (and b-fname ; Fontify here: the following condition
3725 (cperl-postpone-fontification ; is too hard to determine by
3726 b-fname e-fname 'face ; a REx, so do it here
3727 (if (looking-at "{")
3728 font-lock-function-name-face
3729 font-lock-variable-name-face)))))
3730 ;; now restore the initial state
3731 (if st
3732 (progn
3733 (modify-syntax-entry ?\( "." st)
3734 (modify-syntax-entry ?\) "." st)))
3735 (if reset-st
3736 (set-syntax-table reset-st))))
3737
3738(defsubst cperl-look-at-leading-count (is-x-REx e)
3739 (if (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3740 (1- e) t) ; return nil on failure, no moving
3741 (if (eq ?\{ (preceding-char)) nil
3742 (cperl-postpone-fontification
3743 (1- (point)) (point)
3744 'face font-lock-warning-face))))
3745
3746;;; Debugging this may require (setq max-specpdl-size 2000)...
3747(defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
f83d2997 3748 "Scans the buffer for hard-to-parse Perl constructions.
5c8b7eaf
SS
3749If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3750the sections using `cperl-pod-head-face', `cperl-pod-face',
f83d2997
KH
3751`cperl-here-face'."
3752 (interactive)
4ab89e7b 3753 (or min (setq min (point-min)
db133cb6
RS
3754 cperl-syntax-state nil
3755 cperl-syntax-done-to min))
f83d2997 3756 (or max (setq max (point-max)))
83261a2f
SM
3757 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3758 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
4ab89e7b 3759 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
83261a2f 3760 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
4ab89e7b 3761 (modified (buffer-modified-p)) overshoot is-o-REx
83261a2f 3762 (after-change-functions nil)
4ab89e7b 3763 (cperl-font-locking t)
83261a2f
SM
3764 (use-syntax-state (and cperl-syntax-state
3765 (>= min (car cperl-syntax-state))))
3766 (state-point (if use-syntax-state
3767 (car cperl-syntax-state)
3768 (point-min)))
3769 (state (if use-syntax-state
3770 (cdr cperl-syntax-state)))
3771 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3772 (st-l (list nil)) (err-l (list nil))
3773 ;; Somehow font-lock may be not loaded yet...
4ab89e7b 3774 ;; (e.g., when building TAGS via command-line call)
83261a2f
SM
3775 (font-lock-string-face (if (boundp 'font-lock-string-face)
3776 font-lock-string-face
3777 'font-lock-string-face))
4ab89e7b 3778 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
83261a2f
SM
3779 font-lock-constant-face
3780 'font-lock-constant-face))
4ab89e7b 3781 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
83261a2f
SM
3782 (if (boundp 'font-lock-function-name-face)
3783 font-lock-function-name-face
3784 'font-lock-function-name-face))
4ab89e7b
SM
3785 (font-lock-variable-name-face ; interpolated vars and ({})-code
3786 (if (boundp 'font-lock-variable-name-face)
3787 font-lock-variable-name-face
3788 'font-lock-variable-name-face))
3789 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3790 (if (boundp 'font-lock-function-name-face)
3791 font-lock-function-name-face
3792 'font-lock-function-name-face))
3793 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3794 (if (boundp 'font-lock-constant-face)
3795 font-lock-constant-face
3796 'font-lock-constant-face))
3797 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3798 (if (boundp 'font-lock-builtin-face)
3799 font-lock-builtin-face
3800 'font-lock-builtin-face))
83261a2f
SM
3801 (font-lock-comment-face
3802 (if (boundp 'font-lock-comment-face)
3803 font-lock-comment-face
3804 'font-lock-comment-face))
4ab89e7b
SM
3805 (font-lock-warning-face
3806 (if (boundp 'font-lock-warning-face)
3807 font-lock-warning-face
3808 'font-lock-warning-face))
3809 (my-cperl-REx-ctl-face ; (|)
3810 (if (boundp 'font-lock-keyword-face)
3811 font-lock-keyword-face
3812 'font-lock-keyword-face))
3813 (my-cperl-REx-modifiers-face ; //gims
83261a2f
SM
3814 (if (boundp 'cperl-nonoverridable-face)
3815 cperl-nonoverridable-face
4ab89e7b
SM
3816 'cperl-nonoverridable-face))
3817 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3818 (if (boundp 'font-lock-type-face)
3819 font-lock-type-face
3820 'font-lock-type-face))
83261a2f
SM
3821 (stop-point (if ignore-max
3822 (point-max)
3823 max))
3824 (search
3825 (concat
4ab89e7b 3826 "\\(\\`\n?\\|^\n\\)=" ; POD
83261a2f
SM
3827 "\\|"
3828 ;; One extra () before this:
4ab89e7b 3829 "<<" ; HERE-DOC
83261a2f
SM
3830 "\\(" ; 1 + 1
3831 ;; First variant "BLAH" or just ``.
3832 "[ \t]*" ; Yes, whitespace is allowed!
3833 "\\([\"'`]\\)" ; 2 + 1 = 3
3834 "\\([^\"'`\n]*\\)" ; 3 + 1
3835 "\\3"
3836 "\\|"
f739b53b 3837 ;; Second variant: Identifier or \ID (same as 'ID') or empty
83261a2f
SM
3838 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3839 ;; Do not have <<= or << 30 or <<30 or << $blah.
3840 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3841 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3842 "\\)"
3843 "\\|"
3844 ;; 1+6 extra () before this:
4ab89e7b 3845 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
83261a2f 3846 (if cperl-use-syntax-table-text-property
db133cb6 3847 (concat
db133cb6 3848 "\\|"
83261a2f 3849 ;; 1+6+2=9 extra () before this:
4ab89e7b 3850 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
83261a2f
SM
3851 "\\|"
3852 ;; 1+6+2+1=10 extra () before this:
3853 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3854 "\\|"
4ab89e7b
SM
3855 ;; 1+6+2+1+1=11 extra () before this
3856 "\\<sub\\>" ; sub with proto/attr
3857 "\\("
3858 cperl-white-and-comment-rex
3859 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3860 "\\("
3861 cperl-maybe-white-and-comment-rex
3862 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
83261a2f 3863 "\\|"
4ab89e7b
SM
3864 ;; 1+6+2+1+1+6=17 extra () before this:
3865 "\\$\\(['{]\\)" ; $' or ${foo}
83261a2f 3866 "\\|"
4ab89e7b
SM
3867 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3868 ;; we do not support intervening comments...):
83261a2f 3869 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
4ab89e7b 3870 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
83261a2f 3871 "\\|"
4ab89e7b
SM
3872 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3873 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
db133cb6 3874 "\\|"
4ab89e7b 3875 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
83261a2f 3876 ""))))
f83d2997
KH
3877 (unwind-protect
3878 (progn
3879 (save-excursion
3880 (or non-inter
3881 (message "Scanning for \"hard\" Perl constructions..."))
4ab89e7b 3882 ;;(message "find: %s --> %s" min max)
db133cb6 3883 (and cperl-pod-here-fontify
83261a2f
SM
3884 ;; We had evals here, do not know why...
3885 (setq face cperl-pod-face
3886 head-face cperl-pod-head-face
3887 here-face cperl-here-face))
5c8b7eaf 3888 (remove-text-properties min max
5bd52f0e 3889 '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3890 attrib-group t
3891 REx-interpolated t
6c389151
SM
3892 cperl-postpone t
3893 syntax-subtype t
3894 rear-nonsticky t
4ab89e7b 3895 front-sticky t
f739b53b
SM
3896 here-doc-group t
3897 first-format-line t
4ab89e7b 3898 REx-part2 t
6c389151 3899 indentable t))
f83d2997
KH
3900 ;; Need to remove face as well...
3901 (goto-char min)
db133cb6 3902 (and (eq system-type 'emx)
4ab89e7b
SM
3903 (eq (point) 1)
3904 (let ((case-fold-search t))
3905 (looking-at "extproc[ \t]")) ; Analogue of #!
5c8b7eaf 3906 (cperl-commentify min
db133cb6
RS
3907 (save-excursion (end-of-line) (point))
3908 nil))
3909 (while (and
3910 (< (point) max)
3911 (re-search-forward search max t))
5bd52f0e 3912 (setq tmpend nil) ; Valid for most cases
4ab89e7b
SM
3913 (setq b (match-beginning 0)
3914 state (save-excursion (parse-partial-sexp
3915 state-point b nil nil state))
3916 state-point b)
5c8b7eaf 3917 (cond
4ab89e7b
SM
3918 ;; 1+6+2+1+1+6=17 extra () before this:
3919 ;; "\\$\\(['{]\\)"
3920 ((match-beginning 18) ; $' or ${foo}
3921 (if (eq (preceding-char) ?\') ; $'
3922 (progn
3923 (setq b (1- (point))
3924 state (parse-partial-sexp
3925 state-point (1- b) nil nil state)
3926 state-point (1- b))
3927 (if (nth 3 state) ; in string
3928 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3929 (goto-char (1+ b)))
3930 ;; else: ${
3931 (setq bb (match-beginning 0))
3932 (cperl-modify-syntax-type bb cperl-st-punct)))
3933 ;; No processing in strings/comments beyond this point:
3934 ((or (nth 3 state) (nth 4 state))
3935 t) ; Do nothing in comment/string
f83d2997 3936 ((match-beginning 1) ; POD section
a1506d29 3937 ;; "\\(\\`\n?\\|^\n\\)="
4ab89e7b
SM
3938 (setq b (match-beginning 0)
3939 state (parse-partial-sexp
3940 state-point b nil nil state)
3941 state-point b)
3942 (if (or (nth 3 state) (nth 4 state)
3943 (looking-at "cut\\>"))
3944 (if (or (nth 3 state) (nth 4 state) ignore-max)
5bd52f0e 3945 nil ; Doing a chunk only
f83d2997
KH
3946 (message "=cut is not preceded by a POD section")
3947 (or (car err-l) (setcar err-l (point))))
3948 (beginning-of-line)
5c8b7eaf
SS
3949
3950 (setq b (point)
5bd52f0e
RS
3951 bb b
3952 tb (match-beginning 0)
3953 b1 nil) ; error condition
db133cb6
RS
3954 ;; We do not search to max, since we may be called from
3955 ;; some hook of fontification, and max is random
6c389151 3956 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
f83d2997 3957 (progn
6c389151
SM
3958 (goto-char b)
3959 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3960 (progn
3961 (message "=cut is not preceded by an empty line")
3962 (setq b1 t)
3963 (or (car err-l) (setcar err-l b))))))
f83d2997
KH
3964 (beginning-of-line 2) ; An empty line after =cut is not POD!
3965 (setq e (point))
db133cb6 3966 (and (> e max)
6c389151 3967 (progn
a1506d29 3968 (remove-text-properties
6c389151 3969 max e '(syntax-type t in-pod t syntax-table t
4ab89e7b
SM
3970 attrib-group t
3971 REx-interpolated t
6c389151
SM
3972 cperl-postpone t
3973 syntax-subtype t
f739b53b 3974 here-doc-group t
6c389151 3975 rear-nonsticky t
4ab89e7b 3976 front-sticky t
f739b53b 3977 first-format-line t
4ab89e7b 3978 REx-part2 t
6c389151
SM
3979 indentable t))
3980 (setq tmpend tb)))
f83d2997 3981 (put-text-property b e 'in-pod t)
6c389151 3982 (put-text-property b e 'syntax-type 'in-pod)
f83d2997
KH
3983 (goto-char b)
3984 (while (re-search-forward "\n\n[ \t]" e t)
3985 ;; We start 'pod 1 char earlier to include the preceding line
3986 (beginning-of-line)
3987 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5efe6a56
SM
3988 (cperl-put-do-not-fontify b (point) t)
3989 ;; mark the non-literal parts as PODs
a1506d29 3990 (if cperl-pod-here-fontify
5efe6a56 3991 (cperl-postpone-fontification b (point) 'face face t))
f83d2997
KH
3992 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3993 (beginning-of-line)
3994 (setq b (point)))
3995 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5efe6a56 3996 (cperl-put-do-not-fontify (point) e t)
a1506d29
JB
3997 (if cperl-pod-here-fontify
3998 (progn
5efe6a56
SM
3999 ;; mark the non-literal parts as PODs
4000 (cperl-postpone-fontification (point) e 'face face t)
4001 (goto-char bb)
a1506d29 4002 (if (looking-at
5efe6a56
SM
4003 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
4004 ;; mark the headers
a1506d29 4005 (cperl-postpone-fontification
5efe6a56 4006 (match-beginning 1) (match-end 1)
6c389151
SM
4007 'face head-face))
4008 (while (re-search-forward
4009 ;; One paragraph
4010 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
4011 e 'toend)
4012 ;; mark the headers
a1506d29 4013 (cperl-postpone-fontification
5efe6a56
SM
4014 (match-beginning 1) (match-end 1)
4015 'face head-face))))
f83d2997
KH
4016 (cperl-commentify bb e nil)
4017 (goto-char e)
4018 (or (eq e (point-max))
83261a2f 4019 (forward-char -1)))) ; Prepare for immediate POD start.
f83d2997 4020 ;; Here document
4ab89e7b
SM
4021 ;; We can do many here-per-line;
4022 ;; but multiline quote on the same line as <<HERE confuses us...
5bd52f0e 4023 ;; ;; One extra () before this:
5c8b7eaf 4024 ;;"<<"
5bd52f0e
RS
4025 ;; "\\(" ; 1 + 1
4026 ;; ;; First variant "BLAH" or just ``.
f739b53b 4027 ;; "[ \t]*" ; Yes, whitespace is allowed!
5bd52f0e
RS
4028 ;; "\\([\"'`]\\)" ; 2 + 1
4029 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
4030 ;; "\\3"
4031 ;; "\\|"
4032 ;; ;; Second variant: Identifier or \ID or empty
4033 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
4034 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
4035 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
4036 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
4037 ;; "\\)"
f83d2997 4038 ((match-beginning 2) ; 1 + 1
4ab89e7b 4039 (setq b (point)
5bd52f0e 4040 tb (match-beginning 0)
4ab89e7b
SM
4041 c (and ; not HERE-DOC
4042 (match-beginning 5)
4043 (save-match-data
4044 (or (looking-at "[ \t]*(") ; << function_call()
4045 (save-excursion ; 1 << func_name, or $foo << 10
4046 (condition-case nil
4047 (progn
4048 (goto-char tb)
4049 ;;; XXX What to do: foo <<bar ???
4050 ;;; XXX Need to support print {a} <<B ???
4051 (forward-sexp -1)
4052 (save-match-data
4053 ; $foo << b; $f .= <<B;
4054 ; ($f+1) << b; a($f) . <<B;
4055 ; foo 1, <<B; $x{a} <<b;
4056 (cond
4057 ((looking-at "[0-9$({]")
4058 (forward-sexp 1)
4059 (and
4060 (looking-at "[ \t]*<<")
4061 (condition-case nil
4062 ;; print $foo <<EOF
4063 (progn
4064 (forward-sexp -2)
4065 (not
4066 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
4067 (error t)))))))
4068 (error nil))) ; func(<<EOF)
4069 (and (not (match-beginning 6)) ; Empty
4070 (looking-at
4071 "[ \t]*[=0-9$@%&(]"))))))
5bd52f0e
RS
4072 (if c ; Not here-doc
4073 nil ; Skip it.
4ab89e7b 4074 (setq c (match-end 2)) ; 1 + 1
f83d2997
KH
4075 (if (match-beginning 5) ;4 + 1
4076 (setq b1 (match-beginning 5) ; 4 + 1
4077 e1 (match-end 5)) ; 4 + 1
4078 (setq b1 (match-beginning 4) ; 3 + 1
4079 e1 (match-end 4))) ; 3 + 1
4080 (setq tag (buffer-substring b1 e1)
4081 qtag (regexp-quote tag))
5c8b7eaf 4082 (cond (cperl-pod-here-fontify
5bd52f0e 4083 ;; Highlight the starting delimiter
4ab89e7b
SM
4084 (cperl-postpone-fontification
4085 b1 e1 'face my-cperl-delimiters-face)
5bd52f0e 4086 (cperl-put-do-not-fontify b1 e1 t)))
f83d2997 4087 (forward-line)
4ab89e7b
SM
4088 (setq i (point))
4089 (if end-of-here-doc
4090 (goto-char end-of-here-doc))
f83d2997 4091 (setq b (point))
db133cb6
RS
4092 ;; We do not search to max, since we may be called from
4093 ;; some hook of fontification, and max is random
f739b53b
SM
4094 (or (and (re-search-forward (concat "^" qtag "$")
4095 stop-point 'toend)
4ab89e7b
SM
4096 ;;;(eq (following-char) ?\n) ; XXXX WHY???
4097 )
f739b53b
SM
4098 (progn ; Pretend we matched at the end
4099 (goto-char (point-max))
4100 (re-search-forward "\\'")
4101 (message "End of here-document `%s' not found." tag)
4102 (or (car err-l) (setcar err-l b))))
4103 (if cperl-pod-here-fontify
4104 (progn
4105 ;; Highlight the ending delimiter
4ab89e7b
SM
4106 (cperl-postpone-fontification
4107 (match-beginning 0) (match-end 0)
4108 'face my-cperl-delimiters-face)
f739b53b
SM
4109 (cperl-put-do-not-fontify b (match-end 0) t)
4110 ;; Highlight the HERE-DOC
4111 (cperl-postpone-fontification b (match-beginning 0)
4112 'face here-face)))
4113 (setq e1 (cperl-1+ (match-end 0)))
4114 (put-text-property b (match-beginning 0)
4115 'syntax-type 'here-doc)
4116 (put-text-property (match-beginning 0) e1
4117 'syntax-type 'here-doc-delim)
4ab89e7b
SM
4118 (put-text-property b e1 'here-doc-group t)
4119 ;; This makes insertion at the start of HERE-DOC update
4120 ;; the whole construct:
4121 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
f739b53b
SM
4122 (cperl-commentify b e1 nil)
4123 (cperl-put-do-not-fontify b (match-end 0) t)
4ab89e7b
SM
4124 ;; Cache the syntax info...
4125 (setq cperl-syntax-state (cons state-point state))
4126 ;; ... and process the rest of the line...
4127 (setq overshoot
4128 (elt ; non-inter ignore-max
4129 (cperl-find-pods-heres c i t end t e1) 1))
4130 (if (and overshoot (> overshoot (point)))
4131 (goto-char overshoot)
4132 (setq overshoot e1))
f739b53b
SM
4133 (if (> e1 max)
4134 (setq tmpend tb))))
f83d2997
KH
4135 ;; format
4136 ((match-beginning 8)
4137 ;; 1+6=7 extra () before this:
4138 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4139 (setq b (point)
4140 name (if (match-beginning 8) ; 7 + 1
4141 (buffer-substring (match-beginning 8) ; 7 + 1
4142 (match-end 8)) ; 7 + 1
5bd52f0e
RS
4143 "")
4144 tb (match-beginning 0))
f83d2997 4145 (setq argument nil)
f739b53b
SM
4146 (put-text-property (save-excursion
4147 (beginning-of-line)
4148 (point))
4149 b 'first-format-line 't)
5c8b7eaf 4150 (if cperl-pod-here-fontify
f83d2997
KH
4151 (while (and (eq (forward-line) 0)
4152 (not (looking-at "^[.;]$")))
4153 (cond
4154 ((looking-at "^#")) ; Skip comments
4155 ((and argument ; Skip argument multi-lines
5c8b7eaf 4156 (looking-at "^[ \t]*{"))
f83d2997
KH
4157 (forward-sexp 1)
4158 (setq argument nil))
4159 (argument ; Skip argument lines
4160 (setq argument nil))
4161 (t ; Format line
4162 (setq b1 (point))
4163 (setq argument (looking-at "^[^\n]*[@^]"))
4164 (end-of-line)
5bd52f0e 4165 ;; Highlight the format line
5c8b7eaf 4166 (cperl-postpone-fontification b1 (point)
83261a2f 4167 'face font-lock-string-face)
f83d2997 4168 (cperl-commentify b1 (point) nil)
5bd52f0e 4169 (cperl-put-do-not-fontify b1 (point) t))))
db133cb6
RS
4170 ;; We do not search to max, since we may be called from
4171 ;; some hook of fontification, and max is random
4172 (re-search-forward "^[.;]$" stop-point 'toend))
f83d2997 4173 (beginning-of-line)
83261a2f 4174 (if (looking-at "^\\.$") ; ";" is not supported yet
f83d2997 4175 (progn
5bd52f0e
RS
4176 ;; Highlight the ending delimiter
4177 (cperl-postpone-fontification (point) (+ (point) 2)
83261a2f 4178 'face font-lock-string-face)
f83d2997 4179 (cperl-commentify (point) (+ (point) 2) nil)
5bd52f0e 4180 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
f83d2997
KH
4181 (message "End of format `%s' not found." name)
4182 (or (car err-l) (setcar err-l b)))
4183 (forward-line)
5bd52f0e
RS
4184 (if (> (point) max)
4185 (setq tmpend tb))
db133cb6 4186 (put-text-property b (point) 'syntax-type 'format))
4ab89e7b 4187 ;; qq-like String or Regexp:
f83d2997
KH
4188 ((or (match-beginning 10) (match-beginning 11))
4189 ;; 1+6+2=9 extra () before this:
5bd52f0e 4190 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
f83d2997 4191 ;; "\\|"
5bd52f0e 4192 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
f83d2997
KH
4193 (setq b1 (if (match-beginning 10) 10 11)
4194 argument (buffer-substring
4195 (match-beginning b1) (match-end b1))
4ab89e7b 4196 b (point) ; end of qq etc
f83d2997
KH
4197 i b
4198 c (char-after (match-beginning b1))
4ab89e7b 4199 bb (char-after (1- (match-beginning b1))) ; tmp holder
5bd52f0e
RS
4200 ;; bb == "Not a stringy"
4201 bb (if (eq b1 10) ; user variables/whatever
f739b53b
SM
4202 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4203 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4204 ((eq bb ?\:) ; $opt::s
4205 (eq (char-after
4206 (- (match-beginning b1) 2))
4207 ?\:))
4208 ((eq bb ?\>) ; $foo->s
4209 (eq (char-after
4210 (- (match-beginning b1) 2))
4211 ?\-))
4212 ((eq bb ?\&)
4ab89e7b 4213 (not (eq (char-after ; &&m/blah/
f739b53b
SM
4214 (- (match-beginning b1) 2))
4215 ?\&)))
4216 (t t)))
5bd52f0e
RS
4217 ;; <file> or <$file>
4218 (and (eq c ?\<)
6c389151 4219 ;; Do not stringify <FH>, <$fh> :
5bd52f0e 4220 (save-match-data
5c8b7eaf 4221 (looking-at
6c389151 4222 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
5bd52f0e 4223 tb (match-beginning 0))
db133cb6
RS
4224 (goto-char (match-beginning b1))
4225 (cperl-backward-to-noncomment (point-min))
f83d2997 4226 (or bb
5bd52f0e 4227 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
f83d2997 4228 (setq argument ""
f739b53b 4229 b1 nil
db133cb6 4230 bb ; Not a regexp?
4ab89e7b
SM
4231 (not
4232 ;; What is below: regexp-p?
4233 (and
4234 (or (memq (preceding-char)
4235 (append (if (memq c '(?\? ?\<))
4236 ;; $a++ ? 1 : 2
4237 "~{(=|&*!,;:["
4238 "~{(=|&+-*!,;:[") nil))
4239 (and (eq (preceding-char) ?\})
4240 (cperl-after-block-p (point-min)))
4241 (and (eq (char-syntax (preceding-char)) ?w)
4242 (progn
4243 (forward-sexp -1)
6c389151
SM
4244;; After these keywords `/' starts a RE. One should add all the
4245;; functions/builtins which expect an argument, but ...
4ab89e7b
SM
4246 (if (eq (preceding-char) ?-)
4247 ;; -d ?foo? is a RE
4248 (looking-at "[a-zA-Z]\\>")
4249 (and
4250 (not (memq (preceding-char)
4251 '(?$ ?@ ?& ?%)))
4252 (looking-at
4253 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4254 (and (eq (preceding-char) ?.)
4255 (eq (char-after (- (point) 2)) ?.))
4256 (bobp))
4257 ;; m|blah| ? foo : bar;
4258 (not
4259 (and (eq c ?\?)
4260 cperl-use-syntax-table-text-property
4261 (not (bobp))
4262 (progn
4263 (forward-char -1)
4264 (looking-at "\\s|"))))))
db133cb6
RS
4265 b (1- b))
4266 ;; s y tr m
f739b53b
SM
4267 ;; Check for $a -> y
4268 (setq b1 (preceding-char)
4269 go (point))
4270 (if (and (eq b1 ?>)
4271 (eq (char-after (- go 2)) ?-))
db133cb6
RS
4272 ;; Not a regexp
4273 (setq bb t))))
f739b53b
SM
4274 (or bb
4275 (progn
4ab89e7b 4276 (goto-char b)
f739b53b
SM
4277 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4278 (goto-char (match-end 0))
4279 (skip-chars-forward " \t\n\f"))
4280 (cond ((and (eq (following-char) ?\})
4281 (eq b1 ?\{))
4282 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4283 (goto-char (1- go))
4284 (skip-chars-backward " \t\n\f")
4285 (if (memq (preceding-char) (append "$@%&*" nil))
4286 (setq bb t) ; @{y}
4287 (condition-case nil
4288 (forward-sexp -1)
4289 (error nil)))
4290 (if (or bb
4291 (looking-at ; $foo -> {s}
4292 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4293 (and ; $foo[12] -> {s}
4294 (memq (following-char) '(?\{ ?\[))
4295 (progn
4296 (forward-sexp 1)
4297 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4298 (setq bb t)
4299 (goto-char b)))
4300 ((and (eq (following-char) ?=)
4301 (eq (char-after (1+ (point))) ?\>))
4302 ;; Check for { foo => 1, s => 2 }
4303 ;; Apparently s=> is never a substitution...
4304 (setq bb t))
4305 ((and (eq (following-char) ?:)
4306 (eq b1 ?\{) ; Check for $ { s::bar }
4307 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
15ca5699 4308 (progn
f739b53b
SM
4309 (goto-char (1- go))
4310 (skip-chars-backward " \t\n\f")
4311 (memq (preceding-char)
4312 (append "$@%&*" nil))))
4ab89e7b
SM
4313 (setq bb t))
4314 ((eobp)
f739b53b
SM
4315 (setq bb t)))))
4316 (if bb
f83d2997 4317 (goto-char i)
6c389151 4318 ;; Skip whitespace and comments...
f83d2997
KH
4319 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4320 (goto-char (match-end 0))
4321 (skip-chars-forward " \t\n\f"))
6c389151
SM
4322 (if (> (point) b)
4323 (put-text-property b (point) 'syntax-type 'prestring))
f83d2997
KH
4324 ;; qtag means two-arg matcher, may be reset to
4325 ;; 2 or 3 later if some special quoting is needed.
4326 ;; e1 means matching-char matcher.
4ab89e7b 4327 (setq b (point) ; before the first delimiter
5bd52f0e
RS
4328 ;; has 2 args
4329 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
db133cb6
RS
4330 ;; We do not search to max, since we may be called from
4331 ;; some hook of fontification, and max is random
4332 i (cperl-forward-re stop-point end
5bd52f0e 4333 i2
4ab89e7b
SM
4334 st-l err-l argument)
4335 ;; If `go', then it is considered as 1-arg, `b1' is nil
4336 ;; as in s/foo//x; the point is before final "slash"
5bd52f0e 4337 b1 (nth 1 i) ; start of the second part
5c8b7eaf 4338 tag (nth 2 i) ; ender-char, true if second part
5bd52f0e 4339 ; is with matching chars []
f83d2997
KH
4340 go (nth 4 i) ; There is a 1-char part after the end
4341 i (car i) ; intermediate point
5c8b7eaf 4342 e1 (point) ; end
5bd52f0e 4343 ;; Before end of the second part if non-matching: ///
5c8b7eaf 4344 tail (if (and i (not tag))
5bd52f0e
RS
4345 (1- e1))
4346 e (if i i e1) ; end of the first part
6c389151 4347 qtag nil ; need to preserve backslashitis
4ab89e7b
SM
4348 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4349 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
f83d2997
KH
4350 ;; Commenting \\ is dangerous, what about ( ?
4351 (and i tail
4352 (eq (char-after i) ?\\)
5bd52f0e 4353 (setq qtag t))
4ab89e7b
SM
4354 (and (if go (looking-at ".\\sw*x")
4355 (looking-at "\\sw*x")) ; qr//x
4356 (setq is-x-REx t))
4357 (and (if go (looking-at ".\\sw*o")
4358 (looking-at "\\sw*o")) ; //o
4359 (setq is-o-REx t))
f83d2997 4360 (if (null i)
5bd52f0e 4361 ;; Considered as 1arg form
f83d2997
KH
4362 (progn
4363 (cperl-commentify b (point) t)
5bd52f0e 4364 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4365 (if (or is-x-REx
4366 ;; ignore other text properties:
4367 (string-match "^qw$" argument))
4368 (put-text-property b (point) 'indentable t))
5bd52f0e
RS
4369 (and go
4370 (setq e1 (cperl-1+ e1))
4371 (or (eobp)
4372 (forward-char 1))))
f83d2997
KH
4373 (cperl-commentify b i t)
4374 (if (looking-at "\\sw*e") ; s///e
4375 (progn
4ab89e7b
SM
4376 ;; Cache the syntax info...
4377 (setq cperl-syntax-state (cons state-point state))
f83d2997
KH
4378 (and
4379 ;; silent:
4ab89e7b 4380 (car (cperl-find-pods-heres b1 (1- (point)) t end))
f83d2997
KH
4381 ;; Error
4382 (goto-char (1+ max)))
5bd52f0e 4383 (if (and tag (eq (preceding-char) ?\>))
f83d2997
KH
4384 (progn
4385 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5bd52f0e 4386 (cperl-modify-syntax-type i cperl-st-bra)))
6c389151 4387 (put-text-property b i 'syntax-type 'string)
4ab89e7b 4388 (put-text-property i (point) 'syntax-type 'multiline)
6c389151
SM
4389 (if is-x-REx
4390 (put-text-property b i 'indentable t)))
5bd52f0e
RS
4391 (cperl-commentify b1 (point) t)
4392 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
4393 (if is-x-REx
4394 (put-text-property b i 'indentable t))
5bd52f0e 4395 (if qtag
db133cb6 4396 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
f83d2997 4397 (setq tail nil)))
5bd52f0e 4398 ;; Now: tail: if the second part is non-matching without ///e
f83d2997
KH
4399 (if (eq (char-syntax (following-char)) ?w)
4400 (progn
4401 (forward-word 1) ; skip modifiers s///s
5bd52f0e 4402 (if tail (cperl-commentify tail (point) t))
a1506d29 4403 (cperl-postpone-fontification
4ab89e7b 4404 e1 (point) 'face my-cperl-REx-modifiers-face)))
5bd52f0e
RS
4405 ;; Check whether it is m// which means "previous match"
4406 ;; and highlight differently
a1506d29 4407 (setq is-REx
6c389151
SM
4408 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4409 (or (not (= (length argument) 0))
4410 (not (eq c ?\<)))))
a1506d29 4411 (if (and is-REx
6c389151 4412 (eq e (+ 2 b))
5bd52f0e
RS
4413 ;; split // *is* using zero-pattern
4414 (save-excursion
4415 (condition-case nil
4416 (progn
4417 (goto-char tb)
4418 (forward-sexp -1)
4419 (not (looking-at "split\\>")))
4420 (error t))))
5c8b7eaf 4421 (cperl-postpone-fontification
4ab89e7b 4422 b e 'face font-lock-warning-face)
5bd52f0e
RS
4423 (if (or i2 ; Has 2 args
4424 (and cperl-fontify-m-as-s
4425 (or
4426 (string-match "^\\(m\\|qr\\)$" argument)
4427 (and (eq 0 (length argument))
4428 (not (eq ?\< (char-after b)))))))
4429 (progn
5c8b7eaf 4430 (cperl-postpone-fontification
4ab89e7b 4431 b (cperl-1+ b) 'face my-cperl-delimiters-face)
5c8b7eaf 4432 (cperl-postpone-fontification
4ab89e7b 4433 (1- e) e 'face my-cperl-delimiters-face)))
6c389151 4434 (if (and is-REx cperl-regexp-scan)
4ab89e7b
SM
4435 ;; Process RExen: embedded comments, charclasses and ]
4436;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4437;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4438;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4439;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4440;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4441;;;m^a[\^b]c^ + m.a[^b]\.c.;
6c389151
SM
4442 (save-excursion
4443 (goto-char (1+ b))
4ab89e7b
SM
4444 ;; First
4445 (cperl-look-at-leading-count is-x-REx e)
4446 (setq hairy-RE
4447 (concat
4448 (if is-x-REx
4449 (if (eq (char-after b) ?\#)
4450 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4451 "\\((\\?#\\)\\|\\(#\\)")
4452 ;; keep the same count: add a fake group
4453 (if (eq (char-after b) ?\#)
4454 "\\((\\?\\\\#\\)\\(\\)"
4455 "\\((\\?#\\)\\(\\)"))
4456 "\\|"
4457 "\\(\\[\\)" ; 3=[
4458 "\\|"
4459 "\\(]\\)" ; 4=]
4460 "\\|"
4461 ;; XXXX Will not be able to use it in s)))
4462 (if (eq (char-after b) ?\) )
4463 "\\())))\\)" ; Will never match
4464 (if (eq (char-after b) ?? )
4465 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4466 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4467 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4468 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4469 "\\(" ;; XXXX 1-char variables, exc. |()\s
4470 "[$@]"
4471 "\\("
4472 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4473 "\\|"
4474 "{[^{}]*}" ; only one-level allowed
4475 "\\|"
4476 "[^{(|) \t\r\n\f]"
4477 "\\)"
4478 "\\(" ;;8,9:code part of array/hash elt
4479 "\\(" "->" "\\)?"
4480 "\\[[^][]*\\]"
4481 "\\|"
4482 "{[^{}]*}"
4483 "\\)*"
4484 ;; XXXX: what if u is delim?
4485 "\\|"
4486 "[)^|$.*?+]"
4487 "\\|"
4488 "{[0-9]+}"
4489 "\\|"
4490 "{[0-9]+,[0-9]*}"
4491 "\\|"
4492 "\\\\[luLUEQbBAzZG]"
4493 "\\|"
4494 "(" ; Group opener
4495 "\\(" ; 10 group opener follower
4496 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4497 "\\|"
4498 "\\?[:=!>?{]" ; "?" something
4499 "\\|"
4500 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4501 "\\|"
4502 "\\?([0-9]+)" ; (?(1)foo|bar)
4503 "\\|"
4504 "\\?<[=!]"
4505 ;;;"\\|"
4506 ;;; "\\?"
4507 "\\)?"
4508 "\\)"
4509 "\\|"
4510 "\\\\\\(.\\)" ; 12=\SYMBOL
4511 ))
6c389151 4512 (while
4ab89e7b
SM
4513 (and (< (point) (1- e))
4514 (re-search-forward hairy-RE (1- e) 'to-end))
6c389151 4515 (goto-char (match-beginning 0))
4ab89e7b
SM
4516 (setq REx-subgr-start (point)
4517 was-subgr (following-char))
4518 (cond
4519 ((match-beginning 6) ; 0-length builtins, groups
4520 (goto-char (match-end 0))
4521 (if (match-beginning 11)
4522 (goto-char (match-beginning 11)))
4523 (if (>= (point) e)
4524 (goto-char (1- e)))
4525 (cperl-postpone-fontification
4526 (match-beginning 0) (point)
4527 'face
4528 (cond
4529 ((eq was-subgr ?\) )
4530 (condition-case nil
4531 (save-excursion
4532 (forward-sexp -1)
4533 (if (> (point) b)
4534 (if (if (eq (char-after b) ?? )
4535 (looking-at "(\\\\\\?")
4536 (eq (char-after (1+ (point))) ?\?))
4537 my-cperl-REx-0length-face
4538 my-cperl-REx-ctl-face)
4539 font-lock-warning-face))
4540 (error font-lock-warning-face)))
4541 ((eq was-subgr ?\| )
4542 my-cperl-REx-ctl-face)
4543 ((eq was-subgr ?\$ )
4544 (if (> (point) (1+ REx-subgr-start))
4545 (progn
4546 (put-text-property
4547 (match-beginning 0) (point)
4548 'REx-interpolated
4549 (if is-o-REx 0
4550 (if (and (eq (match-beginning 0)
4551 (1+ b))
4552 (eq (point)
4553 (1- e))) 1 t)))
4554 font-lock-variable-name-face)
4555 my-cperl-REx-spec-char-face))
4556 ((memq was-subgr (append "^." nil) )
4557 my-cperl-REx-spec-char-face)
4558 ((eq was-subgr ?\( )
4559 (if (not (match-beginning 10))
4560 my-cperl-REx-ctl-face
4561 my-cperl-REx-0length-face))
4562 (t my-cperl-REx-0length-face)))
4563 (if (and (memq was-subgr (append "(|" nil))
4564 (not (string-match "(\\?[-imsx]+)"
4565 (match-string 0))))
4566 (cperl-look-at-leading-count is-x-REx e))
4567 (setq was-subgr nil)) ; We do stuff here
4568 ((match-beginning 12) ; \SYMBOL
4569 (forward-char 2)
4570 (if (>= (point) e)
4571 (goto-char (1- e))
4572 ;; How many chars to not highlight:
4573 ;; 0-len special-alnums in other branch =>
4574 ;; Generic: \non-alnum (1), \alnum (1+face)
4575 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4576 (setq REx-subgr-start (point)
4577 qtag (preceding-char))
4578 (cperl-postpone-fontification
4579 (- (point) 2) (- (point) 1) 'face
4580 (if (memq qtag
4581 (append "ghijkmoqvFHIJKMORTVY" nil))
4582 font-lock-warning-face
4583 my-cperl-REx-0length-face))
4584 (if (and (eq (char-after b) qtag)
4585 (memq qtag (append ".])^$|*?+" nil)))
4586 (progn
4587 (if (and cperl-use-syntax-table-text-property
4588 (eq qtag ?\) ))
4589 (put-text-property
4590 REx-subgr-start (1- (point))
4591 'syntax-table cperl-st-punct))
4592 (cperl-postpone-fontification
4593 (1- (point)) (point) 'face
4594 ; \] can't appear below
4595 (if (memq qtag (append ".]^$" nil))
4596 'my-cperl-REx-spec-char-face
4597 (if (memq qtag (append "*?+" nil))
4598 'my-cperl-REx-0length-face
4599 'my-cperl-REx-ctl-face))))) ; )|
4600 ;; Test for arguments:
4601 (cond
4602 ;; This is not pretty: the 5.8.7 logic:
4603 ;; \0numx -> octal (up to total 3 dig)
4604 ;; \DIGIT -> backref unless \0
4605 ;; \DIGITs -> backref if legal
4606 ;; otherwise up to 3 -> octal
4607 ;; Do not try to distinguish, we guess
4608 ((or (and (memq qtag (append "01234567" nil))
4609 (re-search-forward
4610 "\\=[01234567]?[01234567]?"
4611 (1- e) 'to-end))
4612 (and (memq qtag (append "89" nil))
4613 (re-search-forward
4614 "\\=[0123456789]*" (1- e) 'to-end))
4615 (and (eq qtag ?x)
4616 (re-search-forward
4617 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4618 (1- e) 'to-end))
4619 (and (memq qtag (append "pPN" nil))
4620 (re-search-forward "\\={[^{}]+}\\|."
4621 (1- e) 'to-end))
4622 (eq (char-syntax qtag) ?w))
4623 (cperl-postpone-fontification
4624 (1- REx-subgr-start) (point)
4625 'face my-cperl-REx-length1-face))))
4626 (setq was-subgr nil)) ; We do stuff here
4627 ((match-beginning 3) ; [charclass]
4628 (forward-char 1)
4629 (if (eq (char-after b) ?^ )
4630 (and (eq (following-char) ?\\ )
4631 (eq (char-after (cperl-1+ (point)))
4632 ?^ )
4633 (forward-char 2))
4634 (and (eq (following-char) ?^ )
4635 (forward-char 1)))
4636 (setq argument b ; continue?
4637 tag nil ; list of POSIX classes
4638 qtag (point))
4639 (if (eq (char-after b) ?\] )
4640 (and (eq (following-char) ?\\ )
4641 (eq (char-after (cperl-1+ (point)))
4642 ?\] )
4643 (setq qtag (1+ qtag))
4644 (forward-char 2))
4645 (and (eq (following-char) ?\] )
4646 (forward-char 1)))
4647 ;; Apparently, I can't put \] into a charclass
4648 ;; in m]]: m][\\\]\]] produces [\\]]
4649;;; POSIX? [:word:] [:^word:] only inside []
4650;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4651 (while
4652 (and argument
4653 (re-search-forward
4654 (if (eq (char-after b) ?\] )
4655 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4656 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4657 (1- e) 'toend))
4658 ;; Is this ] an end of POSIX class?
4659 (if (save-excursion
4660 (and
4661 (search-backward "[" argument t)
4662 (< REx-subgr-start (point))
4663 (not
4664 (and ; Should work with delim = \
4665 (eq (preceding-char) ?\\ )
4666 (= (% (skip-chars-backward
4667 "\\\\") 2) 0)))
4668 (looking-at
4669 (cond
4670 ((eq (char-after b) ?\] )
4671 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4672 ((eq (char-after b) ?\: )
4673 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4674 ((eq (char-after b) ?^ )
4675 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
4676 ((eq (char-syntax (char-after b))
4677 ?w)
4678 (concat
4679 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4680 (char-to-string (char-after b))
4681 "\\|\\sw\\)+:\]"))
4682 (t "\\\\*\\[:\\^?\\sw*:]")))
4683 (setq argument (point))))
4684 (setq tag (cons (cons argument (point))
4685 tag)
4686 argument (point)) ; continue
4687 (setq argument nil)))
4688 (and argument
4689 (message "Couldn't find end of charclass in a REx, pos=%s"
4690 REx-subgr-start))
4691 (if (and cperl-use-syntax-table-text-property
4692 (> (- (point) 2) REx-subgr-start))
4693 (put-text-property
4694 (1+ REx-subgr-start) (1- (point))
4695 'syntax-table cperl-st-punct))
4696 (cperl-postpone-fontification
4697 REx-subgr-start qtag
4698 'face my-cperl-REx-spec-char-face)
4699 (cperl-postpone-fontification
4700 (1- (point)) (point) 'face
4701 my-cperl-REx-spec-char-face)
4702 (if (eq (char-after b) ?\] )
4703 (cperl-postpone-fontification
4704 (- (point) 2) (1- (point))
4705 'face my-cperl-REx-0length-face))
4706 (while tag
4707 (cperl-postpone-fontification
4708 (car (car tag)) (cdr (car tag))
4709 'face my-cperl-REx-length1-face)
4710 (setq tag (cdr tag)))
4711 (setq was-subgr nil)) ; did facing already
4712 ;; Now rare stuff:
4713 ((and (match-beginning 2) ; #-comment
4714 (/= (match-beginning 2) (match-end 2)))
4715 (beginning-of-line 2)
4716 (if (> (point) e)
4717 (goto-char (1- e))))
4718 ((match-beginning 4) ; character "]"
4719 (setq was-subgr nil) ; We do stuff here
4720 (goto-char (match-end 0))
4721 (if cperl-use-syntax-table-text-property
4722 (put-text-property
4723 (1- (point)) (point)
4724 'syntax-table cperl-st-punct))
4725 (cperl-postpone-fontification
4726 (1- (point)) (point)
4727 'face font-lock-warning-face))
4728 ((match-beginning 5) ; before (?{}) (??{})
4729 (setq tag (match-end 0))
4730 (if (or (setq qtag
4731 (cperl-forward-group-in-re st-l))
4732 (and (>= (point) e)
4733 (setq qtag "no matching `)' found"))
4734 (and (not (eq (char-after (- (point) 2))
4735 ?\} ))
4736 (setq qtag "Can't find })")))
a1506d29 4737 (progn
4ab89e7b
SM
4738 (goto-char (1- e))
4739 (message qtag))
4740 (cperl-postpone-fontification
4741 (1- tag) (1- (point))
4742 'face font-lock-variable-name-face)
4743 (cperl-postpone-fontification
4744 REx-subgr-start (1- tag)
4745 'face my-cperl-REx-spec-char-face)
4746 (cperl-postpone-fontification
4747 (1- (point)) (point)
4748 'face my-cperl-REx-spec-char-face)
4749 (if cperl-use-syntax-table-text-property
4750 (progn
4751 (put-text-property
4752 (- (point) 2) (1- (point))
4753 'syntax-table cperl-st-cfence)
4754 (put-text-property
4755 (+ REx-subgr-start 2)
4756 (+ REx-subgr-start 3)
4757 'syntax-table cperl-st-cfence))))
4758 (setq was-subgr nil))
4759 (t ; (?#)-comment
4760 ;; Inside "(" and "\" arn't special in any way
4761 ;; Works also if the outside delimiters are ().
4762 (or;;(if (eq (char-after b) ?\) )
4763 ;;(re-search-forward
4764 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4765 ;; (1- e) 'toend)
4766 (search-forward ")" (1- e) 'toend)
4767 ;;)
4768 (message
4769 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4770 REx-subgr-start))))
6c389151
SM
4771 (if (>= (point) e)
4772 (goto-char (1- e)))
4ab89e7b
SM
4773 (cond
4774 (was-subgr
4775 (setq REx-subgr-end (point))
4776 (cperl-commentify
4777 REx-subgr-start REx-subgr-end nil)
4778 (cperl-postpone-fontification
4779 REx-subgr-start REx-subgr-end
4780 'face font-lock-comment-face))))))
6c389151 4781 (if (and is-REx is-x-REx)
a1506d29 4782 (put-text-property (1+ b) (1- e)
6c389151 4783 'syntax-subtype 'x-REx)))
5bd52f0e
RS
4784 (if i2
4785 (progn
5c8b7eaf 4786 (cperl-postpone-fontification
4ab89e7b 4787 (1- e1) e1 'face my-cperl-delimiters-face)
5bd52f0e 4788 (if (assoc (char-after b) cperl-starters)
4ab89e7b
SM
4789 (progn
4790 (cperl-postpone-fontification
4791 b1 (1+ b1) 'face my-cperl-delimiters-face)
4792 (put-text-property b1 (1+ b1)
4793 'REx-part2 t)))))
5bd52f0e
RS
4794 (if (> (point) max)
4795 (setq tmpend tb))))
4ab89e7b
SM
4796 ((match-beginning 17) ; sub with prototype or attribute
4797 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4798 ;;"\\<sub\\>\\(" ;12
4799 ;; cperl-white-and-comment-rex ;13
4800 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4801 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4802 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4803 (setq b1 (match-beginning 14) e1 (match-end 14))
f83d2997
KH
4804 (if (memq (char-after (1- b))
4805 '(?\$ ?\@ ?\% ?\& ?\*))
4806 nil
4ab89e7b
SM
4807 (goto-char b)
4808 (if (eq (char-after (match-beginning 17)) ?\( )
4809 (progn
4810 (cperl-commentify ; Prototypes; mark as string
4811 (match-beginning 17) (match-end 17) t)
4812 (goto-char (match-end 0))
4813 ;; Now look for attributes after prototype:
4814 (forward-comment (buffer-size))
4815 (and (looking-at ":[^:]")
4816 (cperl-find-sub-attrs st-l b1 e1 b)))
4817 ;; treat attributes without prototype
4818 (goto-char (match-beginning 17))
4819 (cperl-find-sub-attrs st-l b1 e1 b))))
4820 ;; 1+6+2+1+1+6+1=18 extra () before this:
f83d2997 4821 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4ab89e7b
SM
4822 ((match-beginning 19) ; old $abc'efg syntax
4823 (setq bb (match-end 0))
4824 ;;;(if (nth 3 state) nil ; in string
4825 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
f83d2997 4826 (goto-char bb))
4ab89e7b 4827 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
f83d2997 4828 ;; "__\\(END\\|DATA\\)__"
4ab89e7b
SM
4829 ((match-beginning 20) ; __END__, __DATA__
4830 (setq bb (match-end 0))
4831 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4832 (cperl-commentify b bb nil)
4833 (setq end t))
4834 ;; "\\\\\\(['`\"($]\\)"
4835 ((match-beginning 21)
4836 ;; Trailing backslash; make non-quoting outside string/comment
4837 (setq bb (match-end 0))
6c389151
SM
4838 (goto-char b)
4839 (skip-chars-backward "\\\\")
4840 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4ab89e7b 4841 (cperl-modify-syntax-type b cperl-st-punct)
6c389151
SM
4842 (goto-char bb))
4843 (t (error "Error in regexp of the sniffer")))
db133cb6 4844 (if (> (point) stop-point)
f83d2997 4845 (progn
5c8b7eaf 4846 (if end
f83d2997
KH
4847 (message "Garbage after __END__/__DATA__ ignored")
4848 (message "Unbalanced syntax found while scanning")
4849 (or (car err-l) (setcar err-l b)))
db133cb6
RS
4850 (goto-char stop-point))))
4851 (setq cperl-syntax-state (cons state-point state)
4ab89e7b
SM
4852 ;; Do not mark syntax as done past tmpend???
4853 cperl-syntax-done-to (or tmpend (max (point) max)))
4854 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4855 )
f83d2997 4856 (if (car err-l) (goto-char (car err-l))
db133cb6
RS
4857 (or non-inter
4858 (message "Scanning for \"hard\" Perl constructions... done"))))
f83d2997
KH
4859 (and (buffer-modified-p)
4860 (not modified)
4861 (set-buffer-modified-p nil))
00424a9e
SM
4862 ;; I do not understand what this is doing here. It breaks font-locking
4863 ;; because it resets the syntax-table from font-lock-syntax-table to
4864 ;; cperl-mode-syntax-table.
4865 ;; (set-syntax-table cperl-mode-syntax-table)
4866 )
4ab89e7b
SM
4867 (list (car err-l) overshoot)))
4868
4869(defun cperl-find-pods-heres-region (min max)
4870 (interactive "r")
4871 (cperl-find-pods-heres min max))
f83d2997
KH
4872
4873(defun cperl-backward-to-noncomment (lim)
4874 ;; Stops at lim or after non-whitespace that is not in comment
4ab89e7b 4875 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
5bd52f0e 4876 (let (stop p pr)
4ab89e7b 4877 (while (and (not stop) (> (point) (or lim (point-min))))
f83d2997
KH
4878 (skip-chars-backward " \t\n\f" lim)
4879 (setq p (point))
4880 (beginning-of-line)
5bd52f0e
RS
4881 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4882 '(pod here-doc here-doc-delim))
4883 (cperl-unwind-to-safe nil)
4ab89e7b
SM
4884 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4885 (not (memq pr '(string prestring))))
4886 (progn (cperl-to-comment-or-eol) (bolp))
4887 (progn
4888 (skip-chars-backward " \t")
4889 (if (< p (point)) (goto-char p))
4890 (setq stop t)))))))
f83d2997 4891
4ab89e7b
SM
4892;; Used only in `cperl-calculate-indent'...
4893(defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4894 ;; Positions is before ?\{. Checks whether it starts a block.
4895 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4896 (cperl-backward-to-noncomment (point-min))
4897 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4898 ; Label may be mixed up with `$blah :'
4899 (save-excursion (cperl-after-label))
4900 (get-text-property (cperl-1- (point)) 'attrib-group)
4901 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4902 (progn
4903 (backward-sexp)
4904 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4905 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4906 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
4907 ;; sub bless::foo {}
4908 (progn
4909 (cperl-backward-to-noncomment (point-min))
4910 (and (eq (preceding-char) ?b)
4911 (progn
4912 (forward-sexp -1)
4913 (looking-at "sub[ \t\n\f#]")))))))))
4914
4915;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4916;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4917;;; may be a part of an in-statement construct, such as
4918;;; ${something()}, print {FH} $data.
4919;;; Moreover, one takes positive approach (looks for else,grep etc)
4920;;; another negative (looks for bless,tr etc)
f739b53b 4921(defun cperl-after-block-p (lim &optional pre-block)
4ab89e7b
SM
4922 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
4923Would not look before LIM. Assumes that LIM is a good place to begin a
4924statement. The kind of block we treat here is one after which a new
4925statement would start; thus the block in ${func()} does not count."
f83d2997
KH
4926 (save-excursion
4927 (condition-case nil
4928 (progn
f739b53b 4929 (or pre-block (forward-sexp -1))
f83d2997 4930 (cperl-backward-to-noncomment lim)
bab27c0c 4931 (or (eq (point) lim)
4ab89e7b
SM
4932 ;; if () {} // sub f () {} // sub f :a(') {}
4933 (eq (preceding-char) ?\) )
4934 ;; label: {}
4935 (save-excursion (cperl-after-label))
4936 ;; sub :attr {}
4937 (get-text-property (cperl-1- (point)) 'attrib-group)
4938 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
db133cb6
RS
4939 (save-excursion
4940 (forward-sexp -1)
4ab89e7b
SM
4941 ;; else {} but not else::func {}
4942 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4943 (not (looking-at "\\(\\sw\\|_\\)+::")))
db133cb6
RS
4944 ;; sub f {}
4945 (progn
4946 (cperl-backward-to-noncomment lim)
4ab89e7b 4947 (and (eq (preceding-char) ?b)
db133cb6
RS
4948 (progn
4949 (forward-sexp -1)
4ab89e7b
SM
4950 (looking-at "sub[ \t\n\f#]"))))))
4951 ;; What preceeds is not word... XXXX Last statement in sub???
db133cb6 4952 (cperl-after-expr-p lim))))
f83d2997
KH
4953 (error nil))))
4954
4955(defun cperl-after-expr-p (&optional lim chars test)
029cb4d5 4956 "Return true if the position is good for start of expression.
f83d2997
KH
4957TEST is the expression to evaluate at the found position. If absent,
4958CHARS is a string that contains good characters to have before us (however,
4959`}' is treated \"smartly\" if it is not in the list)."
83261a2f 4960 (let ((lim (or lim (point-min)))
f739b53b
SM
4961 stop p pr)
4962 (cperl-update-syntaxification (point) (point))
f83d2997
KH
4963 (save-excursion
4964 (while (and (not stop) (> (point) lim))
4965 (skip-chars-backward " \t\n\f" lim)
4966 (setq p (point))
4967 (beginning-of-line)
f739b53b
SM
4968 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4969 ;; '(pod here-doc here-doc-delim))
4970 (if (get-text-property (point) 'here-doc-group)
4971 (progn
4972 (goto-char
4ab89e7b 4973 (cperl-beginning-of-property (point) 'here-doc-group))
f739b53b
SM
4974 (beginning-of-line 0)))
4975 (if (get-text-property (point) 'in-pod)
4976 (progn
4977 (goto-char
4ab89e7b 4978 (cperl-beginning-of-property (point) 'in-pod))
f739b53b 4979 (beginning-of-line 0)))
f83d2997 4980 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
5bd52f0e 4981 ;; Else: last iteration, or a label
f739b53b 4982 (cperl-to-comment-or-eol) ; Will not move past "." after a format
f83d2997
KH
4983 (skip-chars-backward " \t")
4984 (if (< p (point)) (goto-char p))
5bd52f0e
RS
4985 (setq p (point))
4986 (if (and (eq (preceding-char) ?:)
4987 (progn
4988 (forward-char -1)
4989 (skip-chars-backward " \t\n\f" lim)
4ab89e7b 4990 (memq (char-syntax (preceding-char)) '(?w ?_))))
5bd52f0e
RS
4991 (forward-sexp -1) ; Possibly label. Skip it
4992 (goto-char p)
4993 (setq stop t))))
bab27c0c
RS
4994 (or (bobp) ; ???? Needed
4995 (eq (point) lim)
029cb4d5 4996 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
f83d2997
KH
4997 (progn
4998 (if test (eval test)
4999 (or (memq (preceding-char) (append (or chars "{;") nil))
5000 (and (eq (preceding-char) ?\})
f739b53b
SM
5001 (cperl-after-block-p lim))
5002 (and (eq (following-char) ?.) ; in format: see comment above
5003 (eq (get-text-property (point) 'syntax-type)
5004 'format)))))))))
f83d2997 5005
4ab89e7b
SM
5006(defun cperl-backward-to-start-of-expr (&optional lim)
5007 (condition-case nil
5008 (progn
5009 (while (and (or (not lim)
5010 (> (point) lim))
5011 (not (cperl-after-expr-p lim)))
5012 (forward-sexp -1)
5013 ;; May be after $, @, $# etc of a variable
5014 (skip-chars-backward "$@%#")))
5015 (error nil)))
5016
5017(defun cperl-at-end-of-expr (&optional lim)
5018 ;; Since the SEXP approach below is very fragile, do some overengineering
5019 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
5020 (condition-case nil
5021 (save-excursion
5022 ;; If nothing interesting after, does as (forward-sexp -1);
5023 ;; otherwise fails, or ends at a start of following sexp.
5024 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
5025 ;; may be stuck after @ or $; just put some stupid workaround now:
5026 (let ((p (point)))
5027 (forward-sexp 1)
5028 (forward-sexp -1)
5029 (while (memq (preceding-char) (append "%&@$*" nil))
5030 (forward-char -1))
5031 (or (< (point) p)
5032 (cperl-after-expr-p lim))))
5033 (error t))))
5034
5035(defun cperl-forward-to-end-of-expr (&optional lim)
5036 (let ((p (point))))
5037 (condition-case nil
5038 (progn
5039 (while (and (< (point) (or lim (point-max)))
5040 (not (cperl-at-end-of-expr)))
5041 (forward-sexp 1)))
5042 (error nil)))
5043
f83d2997
KH
5044(defun cperl-backward-to-start-of-continued-exp (lim)
5045 (if (memq (preceding-char) (append ")]}\"'`" nil))
5046 (forward-sexp -1))
5047 (beginning-of-line)
5048 (if (<= (point) lim)
5049 (goto-char (1+ lim)))
5050 (skip-chars-forward " \t"))
5051
db133cb6
RS
5052(defun cperl-after-block-and-statement-beg (lim)
5053 ;; We assume that we are after ?\}
5c8b7eaf 5054 (and
db133cb6
RS
5055 (cperl-after-block-p lim)
5056 (save-excursion
5057 (forward-sexp -1)
5058 (cperl-backward-to-noncomment (point-min))
5059 (or (bobp)
bab27c0c 5060 (eq (point) lim)
db133cb6
RS
5061 (not (= (char-syntax (preceding-char)) ?w))
5062 (progn
5063 (forward-sexp -1)
5c8b7eaf 5064 (not
db133cb6
RS
5065 (looking-at
5066 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
5067
f83d2997 5068\f
f83d2997
KH
5069(defun cperl-indent-exp ()
5070 "Simple variant of indentation of continued-sexp.
5bd52f0e
RS
5071
5072Will not indent comment if it starts at `comment-indent' or looks like
5073continuation of the comment on the previous line.
db133cb6 5074
5c8b7eaf 5075If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 5076conditional/loop constructs."
f83d2997
KH
5077 (interactive)
5078 (save-excursion
5079 (let ((tmp-end (progn (end-of-line) (point))) top done)
5080 (save-excursion
5081 (beginning-of-line)
5082 (while (null done)
5083 (setq top (point))
4ab89e7b
SM
5084 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
5085 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
f83d2997
KH
5086 (setq top (point))) ; Get the outermost parenths in line
5087 (goto-char top)
5088 (while (< (point) tmp-end)
5089 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5090 (or (eolp) (forward-sexp 1)))
4ab89e7b
SM
5091 (if (> (point) tmp-end) ; Yes, there an unfinished block
5092 nil
5093 (if (eq ?\) (preceding-char))
5094 (progn ;; Plan B: find by REGEXP block followup this line
5095 (setq top (point))
5096 (condition-case nil
5097 (progn
5098 (forward-sexp -2)
5099 (if (eq (following-char) ?$ ) ; for my $var (list)
5100 (progn
5101 (forward-sexp -1)
5102 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5103 (forward-sexp -1))))
5104 (if (looking-at
5105 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5106 "\\|for\\(each\\)?\\>\\(\\("
5107 cperl-maybe-white-and-comment-rex
5108 "\\(my\\|local\\|our\\)\\)?"
5109 cperl-maybe-white-and-comment-rex
5110 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5111 (progn
5112 (goto-char top)
5113 (forward-sexp 1)
5114 (setq top (point)))))
5115 (error (setq done t)))
5116 (goto-char top))
5117 (if (looking-at ; Try Plan C: continuation block
5118 (concat cperl-maybe-white-and-comment-rex
5119 "\\<\\(else\\|elsif\|continue\\)\\>"))
5120 (progn
5121 (goto-char (match-end 0))
5122 (save-excursion
5123 (end-of-line)
5124 (setq tmp-end (point))))
5125 (setq done t))))
5126 (save-excursion
5127 (end-of-line)
5128 (setq tmp-end (point))))
f83d2997
KH
5129 (goto-char tmp-end)
5130 (setq tmp-end (point-marker)))
db133cb6
RS
5131 (if cperl-indent-region-fix-constructs
5132 (cperl-fix-line-spacing tmp-end))
f83d2997
KH
5133 (cperl-indent-region (point) tmp-end))))
5134
5bd52f0e
RS
5135(defun cperl-fix-line-spacing (&optional end parse-data)
5136 "Improve whitespace in a conditional/loop construct.
5137Returns some position at the last line."
db133cb6
RS
5138 (interactive)
5139 (or end
5140 (setq end (point-max)))
83261a2f
SM
5141 (let ((ee (save-excursion (end-of-line) (point)))
5142 (cperl-indent-region-fix-constructs
5143 (or cperl-indent-region-fix-constructs 1))
5144 p pp ml have-brace ret)
db133cb6
RS
5145 (save-excursion
5146 (beginning-of-line)
5bd52f0e 5147 (setq ret (point))
5c8b7eaf 5148 ;; }? continue
5bd52f0e 5149 ;; blah; }
5c8b7eaf 5150 (if (not
5bd52f0e
RS
5151 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5152 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5153 nil ; Do not need to do anything
83261a2f
SM
5154 ;; Looking at:
5155 ;; }
5156 ;; else
4ab89e7b
SM
5157 (if cperl-merge-trailing-else
5158 (if (looking-at
5159 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5160 (progn
5161 (search-forward "}")
5162 (setq p (point))
5163 (skip-chars-forward " \t\n")
5164 (delete-region p (point))
b5b0cb34 5165 (insert (make-string cperl-indent-region-fix-constructs ?\s))
4ab89e7b
SM
5166 (beginning-of-line)))
5167 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5168 (save-excursion
5169 (search-forward "}")
5170 (delete-horizontal-space)
5171 (insert "\n")
5172 (setq ret (point))
5173 (if (cperl-indent-line parse-data)
5174 (progn
5175 (cperl-fix-line-spacing end parse-data)
5176 (setq ret (point)))))))
83261a2f
SM
5177 ;; Looking at:
5178 ;; } else
5179 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5180 (progn
5181 (search-forward "}")
5182 (delete-horizontal-space)
b5b0cb34 5183 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5184 (beginning-of-line)))
5185 ;; Looking at:
5186 ;; else {
5187 (if (looking-at
5188 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5189 (progn
5190 (forward-word 1)
5191 (delete-horizontal-space)
b5b0cb34 5192 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5193 (beginning-of-line)))
5194 ;; Looking at:
5195 ;; foreach my $var
5196 (if (looking-at
5197 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5198 (progn
5199 (forward-word 2)
5200 (delete-horizontal-space)
b5b0cb34 5201 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
5202 (beginning-of-line)))
5203 ;; Looking at:
5204 ;; foreach my $var (
5205 (if (looking-at
6c389151 5206 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
83261a2f 5207 (progn
f739b53b 5208 (forward-sexp 3)
83261a2f
SM
5209 (delete-horizontal-space)
5210 (insert
b5b0cb34 5211 (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f 5212 (beginning-of-line)))
4ab89e7b
SM
5213 ;; Looking at (with or without "}" at start, ending after "({"):
5214 ;; } foreach my $var () OR {
83261a2f 5215 (if (looking-at
ce22dd53 5216 "[ \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 5217 (progn
4ab89e7b 5218 (setq ml (match-beginning 8)) ; "(" or "{" after control word
83261a2f
SM
5219 (re-search-forward "[({]")
5220 (forward-char -1)
5221 (setq p (point))
5222 (if (eq (following-char) ?\( )
5223 (progn
5224 (forward-sexp 1)
4ab89e7b 5225 (setq pp (point))) ; past parenth-group
83261a2f
SM
5226 ;; after `else' or nothing
5227 (if ml ; after `else'
5228 (skip-chars-backward " \t\n")
5229 (beginning-of-line))
5230 (setq pp nil))
5231 ;; Now after the sexp before the brace
5232 ;; Multiline expr should be special
5233 (setq ml (and pp (save-excursion (goto-char p)
5234 (search-forward "\n" pp t))))
4ab89e7b 5235 (if (and (or (not pp) (< pp end)) ; Do not go too far...
83261a2f
SM
5236 (looking-at "[ \t\n]*{"))
5237 (progn
5238 (cond
5239 ((bolp) ; Were before `{', no if/else/etc
5240 nil)
4ab89e7b 5241 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
83261a2f
SM
5242 (delete-horizontal-space)
5243 (if (if ml
5244 cperl-extra-newline-before-brace-multiline
5245 cperl-extra-newline-before-brace)
5246 (progn
5247 (delete-horizontal-space)
5248 (insert "\n")
5249 (setq ret (point))
5250 (if (cperl-indent-line parse-data)
5251 (progn
5252 (cperl-fix-line-spacing end parse-data)
5253 (setq ret (point)))))
5254 (insert
b5b0cb34 5255 (make-string cperl-indent-region-fix-constructs ?\s))))
83261a2f
SM
5256 ((and (looking-at "[ \t]*\n")
5257 (not (if ml
5258 cperl-extra-newline-before-brace-multiline
5259 cperl-extra-newline-before-brace)))
5260 (setq pp (point))
5261 (skip-chars-forward " \t\n")
5262 (delete-region pp (point))
db133cb6 5263 (insert
4ab89e7b
SM
5264 (make-string cperl-indent-region-fix-constructs ?\ )))
5265 ((and (looking-at "[\t ]*{")
5266 (if ml cperl-extra-newline-before-brace-multiline
5267 cperl-extra-newline-before-brace))
5268 (delete-horizontal-space)
5269 (insert "\n")
5270 (setq ret (point))
5271 (if (cperl-indent-line parse-data)
5272 (progn
5273 (cperl-fix-line-spacing end parse-data)
5274 (setq ret (point))))))
83261a2f
SM
5275 ;; Now we are before `{'
5276 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5277 (progn
5278 (skip-chars-forward " \t\n")
5279 (setq pp (point))
5280 (forward-sexp 1)
5281 (setq p (point))
5282 (goto-char pp)
5283 (setq ml (search-forward "\n" p t))
5284 (if (or cperl-break-one-line-blocks-when-indent ml)
5285 ;; not good: multi-line BLOCK
5286 (progn
5287 (goto-char (1+ pp))
5288 (delete-horizontal-space)
5289 (insert "\n")
5290 (setq ret (point))
5291 (if (cperl-indent-line parse-data)
5292 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5293 (beginning-of-line)
5294 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
5295 ;; Now check whether there is a hanging `}'
5296 ;; Looking at:
5297 ;; } blah
5298 (if (and
5299 cperl-fix-hanging-brace-when-indent
5300 have-brace
5301 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5302 (condition-case nil
5303 (progn
5304 (up-list 1)
5305 (if (and (<= (point) pp)
5306 (eq (preceding-char) ?\} )
5307 (cperl-after-block-and-statement-beg (point-min)))
5308 t
5309 (goto-char p)
5310 nil))
5311 (error nil)))
5312 (progn
5313 (forward-char -1)
5314 (skip-chars-backward " \t")
5315 (if (bolp)
5316 ;; `}' was the first thing on the line, insert NL *after* it.
5317 (progn
5318 (cperl-indent-line parse-data)
5319 (search-forward "}")
5320 (delete-horizontal-space)
5321 (insert "\n"))
5322 (delete-horizontal-space)
5323 (or (eq (preceding-char) ?\;)
5324 (bolp)
5325 (and (eq (preceding-char) ?\} )
5326 (cperl-after-block-p (point-min)))
5327 (insert ";"))
5328 (insert "\n")
5329 (setq ret (point)))
5330 (if (cperl-indent-line parse-data)
5331 (setq ret (cperl-fix-line-spacing end parse-data)))
5332 (beginning-of-line)))))
5bd52f0e
RS
5333 ret))
5334
5335(defvar cperl-update-start) ; Do not need to make them local
5336(defvar cperl-update-end)
5337(defun cperl-delay-update-hook (beg end old-len)
5338 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5339 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
db133cb6 5340
f83d2997
KH
5341(defun cperl-indent-region (start end)
5342 "Simple variant of indentation of region in CPerl mode.
5c8b7eaf 5343Should be slow. Will not indent comment if it starts at `comment-indent'
f83d2997 5344or looks like continuation of the comment on the previous line.
5c8b7eaf
SS
5345Indents all the lines whose first character is between START and END
5346inclusive.
db133cb6 5347
5c8b7eaf 5348If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 5349conditional/loop constructs."
f83d2997 5350 (interactive "r")
5bd52f0e 5351 (cperl-update-syntaxification end end)
f83d2997 5352 (save-excursion
5bd52f0e 5353 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
83261a2f
SM
5354 (let ((indent-info (if cperl-emacs-can-parse
5355 (list nil nil nil) ; Cannot use '(), since will modify
5356 nil))
c326ddd1 5357 (pm 0)
83261a2f
SM
5358 after-change-functions ; Speed it up!
5359 st comm old-comm-indent new-comm-indent p pp i empty)
5bd52f0e 5360 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
83261a2f
SM
5361 (goto-char start)
5362 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5363 (current-column))
5364 new-comm-indent old-comm-indent)
5365 (goto-char start)
5366 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5367 (or (bolp) (beginning-of-line 2))
83261a2f 5368 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5bd52f0e
RS
5369 (setq st (point))
5370 (if (or
5371 (setq empty (looking-at "[ \t]*\n"))
5372 (and (setq comm (looking-at "[ \t]*#"))
83261a2f
SM
5373 (or (eq (current-indentation) (or old-comm-indent
5374 comment-column))
5bd52f0e 5375 (setq old-comm-indent nil))))
f83d2997 5376 (if (and old-comm-indent
5bd52f0e 5377 (not empty)
f83d2997 5378 (= (current-indentation) old-comm-indent)
5bd52f0e
RS
5379 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5380 (not (eq (get-text-property (point) 'syntax-table)
5381 cperl-st-cfence)))
83261a2f
SM
5382 (let ((comment-column new-comm-indent))
5383 (indent-for-comment)))
5384 (progn
5bd52f0e 5385 (setq i (cperl-indent-line indent-info))
f83d2997 5386 (or comm
db133cb6 5387 (not i)
f83d2997 5388 (progn
db133cb6 5389 (if cperl-indent-region-fix-constructs
5bd52f0e 5390 (goto-char (cperl-fix-line-spacing end indent-info)))
83261a2f
SM
5391 (if (setq old-comm-indent
5392 (and (cperl-to-comment-or-eol)
5393 (not (memq (get-text-property (point)
5394 'syntax-type)
5395 '(pod here-doc)))
5c8b7eaf 5396 (not (eq (get-text-property (point)
5bd52f0e
RS
5397 'syntax-table)
5398 cperl-st-cfence))
f83d2997
KH
5399 (current-column)))
5400 (progn (indent-for-comment)
5401 (skip-chars-backward " \t")
5402 (skip-chars-backward "#")
5403 (setq new-comm-indent (current-column))))))))
335dd1f1 5404 (beginning-of-line 2)))
5bd52f0e 5405 ;; Now run the update hooks
83261a2f
SM
5406 (and after-change-functions
5407 cperl-update-end
5408 (save-excursion
5409 (goto-char cperl-update-end)
5410 (insert " ")
5411 (delete-char -1)
5412 (goto-char cperl-update-start)
5413 (insert " ")
5414 (delete-char -1))))))
f83d2997 5415
f83d2997
KH
5416;; Stolen from lisp-mode with a lot of improvements
5417
5418(defun cperl-fill-paragraph (&optional justify iteration)
82eb0dae 5419 "Like `fill-paragraph', but handle CPerl comments.
f83d2997
KH
5420If any of the current line is a comment, fill the comment or the
5421block of it that point is in, preserving the comment's initial
5422indentation and initial hashes. Behaves usually outside of comment."
82eb0dae 5423 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
83261a2f 5424 (let (;; Non-nil if the current line contains a comment.
f83d2997 5425 has-comment
4ab89e7b 5426 fill-paragraph-function ; do not recurse
f83d2997
KH
5427 ;; If has-comment, the appropriate fill-prefix for the comment.
5428 comment-fill-prefix
5429 ;; Line that contains code and comment (or nil)
5430 start
5431 c spaces len dc (comment-column comment-column))
5432 ;; Figure out what kind of comment we are looking at.
5433 (save-excursion
5434 (beginning-of-line)
5435 (cond
5436
5437 ;; A line with nothing but a comment on it?
5438 ((looking-at "[ \t]*#[# \t]*")
5439 (setq has-comment t
5440 comment-fill-prefix (buffer-substring (match-beginning 0)
5441 (match-end 0))))
5442
5443 ;; A line with some code, followed by a comment? Remember that the
5444 ;; semi which starts the comment shouldn't be part of a string or
5445 ;; character.
5446 ((cperl-to-comment-or-eol)
5447 (setq has-comment t)
5448 (looking-at "#+[ \t]*")
5c8b7eaf 5449 (setq start (point) c (current-column)
f83d2997 5450 comment-fill-prefix
b5b0cb34 5451 (concat (make-string (current-column) ?\s)
f83d2997 5452 (buffer-substring (match-beginning 0) (match-end 0)))
5c8b7eaf 5453 spaces (progn (skip-chars-backward " \t")
f83d2997 5454 (buffer-substring (point) start))
5c8b7eaf 5455 dc (- c (current-column)) len (- start (point))
f83d2997
KH
5456 start (point-marker))
5457 (delete-char len)
4ab89e7b 5458 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
f83d2997 5459 (if (not has-comment)
83261a2f 5460 (fill-paragraph justify) ; Do the usual thing outside of comment
f83d2997
KH
5461 ;; Narrow to include only the comment, and then fill the region.
5462 (save-restriction
5463 (narrow-to-region
5464 ;; Find the first line we should include in the region to fill.
5465 (if start (progn (beginning-of-line) (point))
5466 (save-excursion
5467 (while (and (zerop (forward-line -1))
5468 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5469 ;; We may have gone to far. Go forward again.
5470 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5471 (forward-line 1))
5472 (point)))
5473 ;; Find the beginning of the first line past the region to fill.
5474 (save-excursion
5475 (while (progn (forward-line 1)
5476 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5477 (point)))
5478 ;; Remove existing hashes
cff301be 5479 (save-excursion
4ab89e7b
SM
5480 (goto-char (point-min))
5481 (while (progn (forward-line 1) (< (point) (point-max)))
5482 (skip-chars-forward " \t")
5483 (if (looking-at "#+")
5484 (progn
5485 (if (and (eq (point) (match-beginning 0))
5486 (not (eq (point) (match-end 0)))) nil
5487 (error
5488 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5489 (delete-char (- (match-end 0) (match-beginning 0)))))))
f83d2997
KH
5490
5491 ;; Lines with only hashes on them can be paragraph boundaries.
5492 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5493 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5494 (fill-prefix comment-fill-prefix))
5495 (fill-paragraph justify)))
5496 (if (and start)
5c8b7eaf 5497 (progn
f83d2997
KH
5498 (goto-char start)
5499 (if (> dc 0)
83261a2f 5500 (progn (delete-char dc) (insert spaces)))
f83d2997
KH
5501 (if (or (= (current-column) c) iteration) nil
5502 (setq comment-column c)
5503 (indent-for-comment)
5504 ;; Repeat once more, flagging as iteration
4ab89e7b
SM
5505 (cperl-fill-paragraph justify t))))))
5506 t)
f83d2997
KH
5507
5508(defun cperl-do-auto-fill ()
5509 ;; Break out if the line is short enough
5510 (if (> (save-excursion
5511 (end-of-line)
5512 (current-column))
5513 fill-column)
83261a2f
SM
5514 (let ((c (save-excursion (beginning-of-line)
5515 (cperl-to-comment-or-eol) (point)))
8038e2cf 5516 (s (memq (following-char) '(?\s ?\t))) marker)
82eb0dae
SM
5517 (if (>= c (point))
5518 ;; Don't break line inside code: only inside comment.
5519 nil
83261a2f 5520 (setq marker (point-marker))
82eb0dae 5521 (fill-paragraph nil)
83261a2f
SM
5522 (goto-char marker)
5523 ;; Is not enough, sometimes marker is a start of line
5524 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5525 (goto-char (match-end 0))))
5526 ;; Following space could have gone:
8038e2cf 5527 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
83261a2f
SM
5528 (insert " ")
5529 (backward-char 1))
5530 ;; Previous space could have gone:
8038e2cf 5531 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
f83d2997 5532
f83d2997
KH
5533(defun cperl-imenu-addback (lst &optional isback name)
5534 ;; We suppose that the lst is a DAG, unless the first element only
5535 ;; loops back, and ISBACK is set. Thus this function cannot be
5536 ;; applied twice without ISBACK set.
5537 (cond ((not cperl-imenu-addback) lst)
5538 (t
5c8b7eaf 5539 (or name
f83d2997 5540 (setq name "+++BACK+++"))
83261a2f
SM
5541 (mapcar (lambda (elt)
5542 (if (and (listp elt) (listp (cdr elt)))
5543 (progn
5544 ;; In the other order it goes up
5545 ;; one level only ;-(
5546 (setcdr elt (cons (cons name lst)
5547 (cdr elt)))
5548 (cperl-imenu-addback (cdr elt) t name))))
f83d2997
KH
5549 (if isback (cdr lst) lst))
5550 lst)))
5551
80585273 5552(defun cperl-imenu--create-perl-index (&optional regexp)
f83d2997 5553 (require 'imenu) ; May be called from TAGS creator
5c8b7eaf 5554 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
f83d2997
KH
5555 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5556 (index-meth-alist '()) meth
4ab89e7b
SM
5557 packages ends-ranges p marker is-proto
5558 (prev-pos 0) is-pack index index1 name (end-range 0) package)
f83d2997 5559 (goto-char (point-min))
6c389151 5560 (cperl-update-syntaxification (point-max) (point-max))
f83d2997
KH
5561 ;; Search for the function
5562 (progn ;;save-match-data
5563 (while (re-search-forward
80585273 5564 (or regexp cperl-imenu--function-name-regexp-perl)
f83d2997 5565 nil t)
4ab89e7b 5566 ;; 2=package-group, 5=package-name 8=sub-name
f83d2997
KH
5567 (cond
5568 ((and ; Skip some noise if building tags
4ab89e7b
SM
5569 (match-beginning 5) ; package name
5570 ;;(eq (char-after (match-beginning 2)) ?p) ; package
f83d2997 5571 (not (save-match-data
83261a2f 5572 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
f83d2997
KH
5573 nil)
5574 ((and
4ab89e7b
SM
5575 (or (match-beginning 2)
5576 (match-beginning 8)) ; package or sub
6c389151 5577 ;; Skip if quoted (will not skip multi-line ''-strings :-():
f83d2997
KH
5578 (null (get-text-property (match-beginning 1) 'syntax-table))
5579 (null (get-text-property (match-beginning 1) 'syntax-type))
5580 (null (get-text-property (match-beginning 1) 'in-pod)))
4ab89e7b 5581 (setq is-pack (match-beginning 2))
f83d2997
KH
5582 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5583 ;; (goto-char (match-end 0))) ; Messes what follows
4ab89e7b 5584 (setq meth nil
f83d2997
KH
5585 p (point))
5586 (while (and ends-ranges (>= p (car ends-ranges)))
5587 ;; delete obsolete entries
5588 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5589 (setq package (or (car packages) "")
5590 end-range (or (car ends-ranges) 0))
4ab89e7b
SM
5591 (if is-pack ; doing "package"
5592 (progn
5593 (if (match-beginning 5) ; named package
5594 (setq name (buffer-substring (match-beginning 5)
5595 (match-end 5))
5596 name (progn
5597 (set-text-properties 0 (length name) nil name)
5598 name)
5599 package (concat name "::")
5600 name (concat "package " name))
5601 ;; Support nameless packages
5602 (setq name "package;" package ""))
5603 (setq end-range
5604 (save-excursion
5605 (parse-partial-sexp (point) (point-max) -1) (point))
5606 ends-ranges (cons end-range ends-ranges)
5607 packages (cons package packages)))
5608 (setq is-proto
5609 (or (eq (following-char) ?\;)
5610 (eq 0 (get-text-property (point) 'attrib-group)))))
f83d2997 5611 ;; Skip this function name if it is a prototype declaration.
4ab89e7b
SM
5612 (if (and is-proto (not is-pack)) nil
5613 (or is-pack
5614 (setq name
5615 (buffer-substring (match-beginning 8) (match-end 8)))
5616 (set-text-properties 0 (length name) nil name))
5617 (setq marker (make-marker))
5618 (set-marker marker (match-end (if is-pack 2 8)))
5619 (cond (is-pack nil)
5620 ((string-match "[:']" name)
5621 (setq meth t))
5622 ((> p end-range) nil)
5623 (t
5624 (setq name (concat package name) meth t)))
6c389151 5625 (setq index (cons name marker))
4ab89e7b 5626 (if is-pack
f83d2997
KH
5627 (push index index-pack-alist)
5628 (push index index-alist))
5629 (if meth (push index index-meth-alist))
5630 (push index index-unsorted-alist)))
4ab89e7b
SM
5631 ((match-beginning 16) ; POD section
5632 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5633 marker (make-marker))
5634 (set-marker marker (match-beginning 17))
f83d2997 5635 (set-text-properties 0 (length name) nil name)
4ab89e7b
SM
5636 (setq name (concat (make-string
5637 (* 3 (- (char-after (match-beginning 16)) ?1))
5638 ?\ )
5639 name)
5640 index (cons name marker))
f83d2997
KH
5641 (setq index1 (cons (concat "=" name) (cdr index)))
5642 (push index index-pod-alist)
5643 (push index1 index-unsorted-alist)))))
5c8b7eaf 5644 (setq index-alist
f83d2997
KH
5645 (if (default-value 'imenu-sort-function)
5646 (sort index-alist (default-value 'imenu-sort-function))
83261a2f 5647 (nreverse index-alist)))
f83d2997
KH
5648 (and index-pod-alist
5649 (push (cons "+POD headers+..."
5650 (nreverse index-pod-alist))
5651 index-alist))
5652 (and (or index-pack-alist index-meth-alist)
5653 (let ((lst index-pack-alist) hier-list pack elt group name)
5654 ;; Remove "package ", reverse and uniquify.
5655 (while lst
5656 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5657 (if (assoc name hier-list) nil
5658 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5659 (setq lst index-meth-alist)
5660 (while lst
5661 (setq elt (car lst) lst (cdr lst))
5662 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5663 (setq pack (substring (car elt) 0 (match-beginning 0)))
5c8b7eaf 5664 (if (setq group (assoc pack hier-list))
f83d2997
KH
5665 (if (listp (cdr group))
5666 ;; Have some functions already
5c8b7eaf
SS
5667 (setcdr group
5668 (cons (cons (substring
f83d2997
KH
5669 (car elt)
5670 (+ 2 (match-beginning 0)))
5671 (cdr elt))
5672 (cdr group)))
5c8b7eaf 5673 (setcdr group (list (cons (substring
f83d2997
KH
5674 (car elt)
5675 (+ 2 (match-beginning 0)))
5676 (cdr elt)))))
5c8b7eaf
SS
5677 (setq hier-list
5678 (cons (cons pack
5679 (list (cons (substring
f83d2997
KH
5680 (car elt)
5681 (+ 2 (match-beginning 0)))
5682 (cdr elt))))
5683 hier-list))))))
5684 (push (cons "+Hierarchy+..."
5685 hier-list)
5686 index-alist)))
5687 (and index-pack-alist
5688 (push (cons "+Packages+..."
5689 (nreverse index-pack-alist))
5690 index-alist))
5c8b7eaf 5691 (and (or index-pack-alist index-pod-alist
f83d2997
KH
5692 (default-value 'imenu-sort-function))
5693 index-unsorted-alist
5694 (push (cons "+Unsorted List+..."
5695 (nreverse index-unsorted-alist))
5696 index-alist))
5697 (cperl-imenu-addback index-alist)))
5698
6c389151 5699\f
6c389151
SM
5700;; Suggested by Mark A. Hershberger
5701(defun cperl-outline-level ()
5702 (looking-at outline-regexp)
5703 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4ab89e7b
SM
5704;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5705 ((match-beginning 2) 0) ; package
5706 ((match-beginning 8) 1) ; sub
5707 ((match-beginning 16)
5708 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5709 (t 5))) ; should not happen
6c389151
SM
5710
5711\f
f83d2997
KH
5712(defun cperl-windowed-init ()
5713 "Initialization under windowed version."
f453f5a8
CY
5714 (cond ((featurep 'ps-print)
5715 (unless cperl-faces-init
5716 (if (boundp 'font-lock-multiline)
5717 (setq cperl-font-lock-multiline t))
5718 (cperl-init-faces)))
5719 ((not cperl-faces-init)
5720 (add-hook 'font-lock-mode-hook
5721 (function
5722 (lambda ()
5723 (if (memq major-mode '(perl-mode cperl-mode))
5724 (progn
5725 (or cperl-faces-init (cperl-init-faces)))))))
5726 (if (fboundp 'eval-after-load)
5727 (eval-after-load
5728 "ps-print"
5729 '(or cperl-faces-init (cperl-init-faces)))))))
db133cb6 5730
5efe6a56 5731(defvar cperl-font-lock-keywords-1 nil
80585273 5732 "Additional expressions to highlight in Perl mode. Minimal set.")
5efe6a56 5733(defvar cperl-font-lock-keywords nil
80585273 5734 "Additional expressions to highlight in Perl mode. Default set.")
5efe6a56 5735(defvar cperl-font-lock-keywords-2 nil
80585273
DL
5736 "Additional expressions to highlight in Perl mode. Maximal set")
5737
db133cb6
RS
5738(defun cperl-load-font-lock-keywords ()
5739 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5740 cperl-font-lock-keywords)
db133cb6
RS
5741
5742(defun cperl-load-font-lock-keywords-1 ()
5743 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5744 cperl-font-lock-keywords-1)
db133cb6
RS
5745
5746(defun cperl-load-font-lock-keywords-2 ()
5747 (or cperl-faces-init (cperl-init-faces))
5efe6a56 5748 cperl-font-lock-keywords-2)
f83d2997 5749
5bd52f0e
RS
5750(defun cperl-init-faces-weak ()
5751 ;; Allow `cperl-find-pods-heres' to run.
5752 (or (boundp 'font-lock-constant-face)
5753 (cperl-force-face font-lock-constant-face
4ab89e7b
SM
5754 "Face for constant and label names"))
5755 (or (boundp 'font-lock-warning-face)
5756 (cperl-force-face font-lock-warning-face
5757 "Face for things which should stand out"))
5758 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5759 )
5bd52f0e 5760
f83d2997 5761(defun cperl-init-faces ()
5bd52f0e 5762 (condition-case errs
f83d2997
KH
5763 (progn
5764 (require 'font-lock)
5765 (and (fboundp 'font-lock-fontify-anchored-keywords)
5766 (featurep 'font-lock-extra)
5767 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5768 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
f83d2997
KH
5769 (if (fboundp 'font-lock-fontify-anchored-keywords)
5770 (setq font-lock-anchored t))
5c8b7eaf 5771 (setq
f83d2997
KH
5772 t-font-lock-keywords
5773 (list
ac6857fb 5774 `("[ \t]+$" 0 ',cperl-invalid-face t)
f83d2997
KH
5775 (cons
5776 (concat
5777 "\\(^\\|[^$@%&\\]\\)\\<\\("
5778 (mapconcat
5779 'identity
5780 '("if" "until" "while" "elsif" "else" "unless" "for"
5781 "foreach" "continue" "exit" "die" "last" "goto" "next"
4ab89e7b 5782 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
6c389151 5783 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
f83d2997
KH
5784 "\\|") ; Flow control
5785 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5786 ; In what follows we use `type' style
5787 ; for overwritable builtins
5788 (list
5789 (concat
5790 "\\(^\\|[^$@%&\\]\\)\\<\\("
5791 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5792 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5793 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5794 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5795 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5796 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5797 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5798 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5799 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5800 ;; "gethostbyname" "gethostent" "getlogin"
5801 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5802 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5803 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5804 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5805 ;; "getservbyport" "getservent" "getsockname"
5806 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5807 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5bd52f0e 5808 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
f83d2997
KH
5809 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5810 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5811 ;; "quotemeta" "rand" "read" "readdir" "readline"
5812 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5813 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5814 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5815 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5816 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5817 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5818 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5819 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
6c389151 5820 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
f83d2997
KH
5821 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5822 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5823 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5c8b7eaf 5824 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
f83d2997
KH
5825 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5826 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5827 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5828 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5829 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5830 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5831 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5832 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5833 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5834 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5835 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5836 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5837 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5838 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5839 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5bd52f0e 5840 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
f83d2997
KH
5841 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5842 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5843 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5844 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5845 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5846 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5847 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5848 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
6c389151 5849 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
f83d2997
KH
5850 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5851 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5852 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5853 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5854 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5855 "\\)\\>") 2 'font-lock-type-face)
5856 ;; In what follows we use `other' style
5857 ;; for nonoverwritable builtins
5858 ;; Somehow 's', 'm' are not auto-generated???
5859 (list
5860 (concat
5861 "\\(^\\|[^$@%&\\]\\)\\<\\("
6c389151 5862 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
f83d2997
KH
5863 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5864 ;; "eval" "exists" "for" "foreach" "format" "goto"
5865 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4ab89e7b 5866 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
f83d2997
KH
5867 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5868 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5869 ;; "undef" "unless" "unshift" "untie" "until" "use"
5870 ;; "while" "y"
6c389151 5871 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
f83d2997 5872 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
6c389151
SM
5873 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5874 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
f83d2997 5875 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5bd52f0e 5876 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
f83d2997
KH
5877 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5878 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5879 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5880 "\\|[sm]" ; Added manually
4ab89e7b 5881 "\\)\\>") 2 'cperl-nonoverridable-face)
f83d2997
KH
5882 ;; (mapconcat 'identity
5883 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5884 ;; "#include" "#define" "#undef")
5885 ;; "\\|")
5886 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5887 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4ab89e7b
SM
5888 ;; This highlights declarations and definitions differenty.
5889 ;; We do not try to highlight in the case of attributes:
5890 ;; it is already done by `cperl-find-pods-heres'
5891 (list (concat "\\<sub"
5892 cperl-white-and-comment-rex ; whitespace/comments
5893 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5894 "\\("
5895 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5896 "([^()]*)\\)?" ; prototype
5897 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5898 "[{;]")
5899 2 (if cperl-font-lock-multiline
5900 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5901 'font-lock-function-name-face
5902 'font-lock-variable-name-face)
5903 ;; need to manually set 'multiline' for older font-locks
5904 '(progn
5905 (if (< 1 (count-lines (match-beginning 0)
5906 (match-end 0)))
5907 (put-text-property
5908 (+ 3 (match-beginning 0)) (match-end 0)
5909 'syntax-type 'multiline))
5910 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5911 'font-lock-function-name-face
5912 'font-lock-variable-name-face))))
f83d2997
KH
5913 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5914 2 font-lock-function-name-face)
5915 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5916 1 font-lock-function-name-face)
5917 (cond ((featurep 'font-lock-extra)
5c8b7eaf 5918 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
f83d2997
KH
5919 (2 font-lock-string-face t)
5920 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5921 (font-lock-anchored
5922 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5923 (2 font-lock-string-face t)
5924 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5925 nil nil
5926 (1 font-lock-string-face t))))
5927 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5928 2 font-lock-string-face t)))
db133cb6 5929 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
f83d2997 5930 font-lock-string-face t)
5c8b7eaf 5931 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
83261a2f 5932 font-lock-constant-face) ; labels
f83d2997 5933 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
883212ce 5934 2 font-lock-constant-face)
6c389151
SM
5935 ;; Uncomment to get perl-mode-like vars
5936 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5937 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5938 ;;; (2 (cons font-lock-variable-name-face '(underline))))
f83d2997 5939 (cond ((featurep 'font-lock-extra)
6c389151 5940 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
f83d2997
KH
5941 (3 font-lock-variable-name-face)
5942 (4 '(another 4 nil
5943 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5944 (1 font-lock-variable-name-face)
5c8b7eaf 5945 (2 '(restart 2 nil) nil t)))
f83d2997
KH
5946 nil t))) ; local variables, multiple
5947 (font-lock-anchored
4ab89e7b
SM
5948 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
5949 (` ((, (concat "\\<\\(my\\|local\\|our\\)"
5950 cperl-maybe-white-and-comment-rex
5951 "\\(("
5952 cperl-maybe-white-and-comment-rex
5953 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
5954 (5 (, (if cperl-font-lock-multiline
5955 'font-lock-variable-name-face
5956 '(progn (setq cperl-font-lock-multiline-start
5957 (match-beginning 0))
5958 'font-lock-variable-name-face))))
5959 ((, (concat "\\="
5960 cperl-maybe-white-and-comment-rex
5961 ","
5962 cperl-maybe-white-and-comment-rex
5963 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
5964 ;; Bug in font-lock: limit is used not only to limit
5965 ;; searches, but to set the "extend window for
5966 ;; facification" property. Thus we need to minimize.
5967 (, (if cperl-font-lock-multiline
5968 '(if (match-beginning 3)
5969 (save-excursion
5970 (goto-char (match-beginning 3))
5971 (condition-case nil
5972 (forward-sexp 1)
5973 (error
5974 (condition-case nil
5975 (forward-char 200)
5976 (error nil)))) ; typeahead
5977 (1- (point))) ; report limit
5978 (forward-char -2)) ; disable continued expr
5979 '(if (match-beginning 3)
5980 (point-max) ; No limit for continuation
5981 (forward-char -2)))) ; disable continued expr
5982 (, (if cperl-font-lock-multiline
5983 nil
5984 '(progn ; Do at end
5985 ;; "my" may be already fontified (POD),
5986 ;; so cperl-font-lock-multiline-start is nil
5987 (if (or (not cperl-font-lock-multiline-start)
5988 (> 2 (count-lines
5989 cperl-font-lock-multiline-start
5990 (point))))
5991 nil
5992 (put-text-property
5993 (1+ cperl-font-lock-multiline-start) (point)
5994 'syntax-type 'multiline))
5995 (setq cperl-font-lock-multiline-start nil))))
5996 (3 font-lock-variable-name-face)))))
5997 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
f83d2997 5998 3 font-lock-variable-name-face)))
6c389151 5999 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
eb6121fc 6000 4 font-lock-variable-name-face)
9ed9fd35
DP
6001 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
6002 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
eb6121fc 6003 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
a1506d29 6004 (setq
f83d2997
KH
6005 t-font-lock-keywords-1
6006 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4ab89e7b
SM
6007 ;; not yet as of XEmacs 19.12, works with 21.1.11
6008 (or
6009 (not cperl-xemacs-p)
6010 (string< "21.1.9" emacs-version)
6011 (and (string< "21.1.10" emacs-version)
6012 (string< emacs-version "21.1.2")))
f83d2997
KH
6013 '(
6014 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
6015 (if (eq (char-after (match-beginning 2)) ?%)
4ab89e7b
SM
6016 'cperl-hash-face
6017 'cperl-array-face)
f83d2997
KH
6018 t) ; arrays and hashes
6019 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
6020 1
5c8b7eaf 6021 (if (= (- (match-end 2) (match-beginning 2)) 1)
f83d2997 6022 (if (eq (char-after (match-beginning 3)) ?{)
4ab89e7b
SM
6023 'cperl-hash-face
6024 'cperl-array-face) ; arrays and hashes
f83d2997
KH
6025 font-lock-variable-name-face) ; Just to put something
6026 t)
4ab89e7b
SM
6027 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
6028 (1 cperl-array-face)
6029 (2 font-lock-variable-name-face))
6030 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
6031 (1 cperl-hash-face)
6032 (2 font-lock-variable-name-face))
f83d2997
KH
6033 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
6034 ;;; Too much noise from \s* @s[ and friends
5c8b7eaf 6035 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
f83d2997
KH
6036 ;;(3 font-lock-function-name-face t t)
6037 ;;(4
6038 ;; (if (cperl-slash-is-regexp)
6039 ;; font-lock-function-name-face 'default) nil t))
6040 )))
6c389151
SM
6041 (if cperl-highlight-variables-indiscriminately
6042 (setq t-font-lock-keywords-1
6043 (append t-font-lock-keywords-1
4ab89e7b 6044 (list '("\\([$*]{?\\sw+\\)" 1
6c389151 6045 font-lock-variable-name-face)))))
a1506d29 6046 (setq cperl-font-lock-keywords-1
5bd52f0e
RS
6047 (if cperl-syntaxify-by-font-lock
6048 (cons 'cperl-fontify-update
6049 t-font-lock-keywords)
6050 t-font-lock-keywords)
5efe6a56
SM
6051 cperl-font-lock-keywords cperl-font-lock-keywords-1
6052 cperl-font-lock-keywords-2 (append
6c389151
SM
6053 cperl-font-lock-keywords-1
6054 t-font-lock-keywords-1)))
f83d2997
KH
6055 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
6056 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
db133cb6 6057 (eval ; Avoid a warning
83261a2f
SM
6058 '(font-lock-require-faces
6059 (list
6060 ;; Color-light Color-dark Gray-light Gray-dark Mono
6061 (list 'font-lock-comment-face
6062 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
6063 nil
6064 [nil nil t t t]
6065 [nil nil t t t]
6066 nil)
6067 (list 'font-lock-string-face
6068 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
6069 nil
6070 nil
6071 [nil nil t t t]
6072 nil)
6073 (list 'font-lock-function-name-face
6074 (vector
6075 "Blue" "LightSkyBlue" "Gray50" "LightGray"
6076 (cdr (assq 'background-color ; if mono
6077 (frame-parameters))))
6078 (vector
6079 nil nil nil nil
6080 (cdr (assq 'foreground-color ; if mono
6081 (frame-parameters))))
6082 [nil nil t t t]
6083 nil
6084 nil)
6085 (list 'font-lock-variable-name-face
6086 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6087 nil
6088 [nil nil t t t]
6089 [nil nil t t t]
6090 nil)
6091 (list 'font-lock-type-face
6092 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6093 nil
6094 [nil nil t t t]
6095 nil
6096 [nil nil t t t])
4ab89e7b
SM
6097 (list 'font-lock-warning-face
6098 ["Pink" "Red" "Gray50" "LightGray"]
6099 ["gray20" "gray90"
6100 "gray80" "gray20"]
6101 [nil nil t t t]
6102 nil
6103 [nil nil t t t]
6104 )
83261a2f
SM
6105 (list 'font-lock-constant-face
6106 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6107 nil
6108 [nil nil t t t]
6109 nil
6110 [nil nil t t t])
4ab89e7b 6111 (list 'cperl-nonoverridable-face
83261a2f
SM
6112 ["chartreuse3" ("orchid1" "orange")
6113 nil "Gray80"]
6114 [nil nil "gray90"]
6115 [nil nil nil t t]
6116 [nil nil t t]
6117 [nil nil t t t])
4ab89e7b 6118 (list 'cperl-array-face
83261a2f
SM
6119 ["blue" "yellow" nil "Gray80"]
6120 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6121 "gray90"]
6122 t
6123 nil
6124 nil)
4ab89e7b 6125 (list 'cperl-hash-face
83261a2f
SM
6126 ["red" "red" nil "Gray80"]
6127 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6128 "gray90"]
6129 t
6130 t
6131 nil))))
5bd52f0e 6132 ;; Do it the dull way, without choose-color
f83d2997
KH
6133 (defvar cperl-guessed-background nil
6134 "Display characteristics as guessed by cperl.")
83261a2f 6135 ;; (or (fboundp 'x-color-defined-p)
15ca5699 6136 ;; (defalias 'x-color-defined-p
83261a2f
SM
6137 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6138 ;; ;; XEmacs >= 19.12
6139 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6140 ;; ;; XEmacs 19.11
6141 ;; (t 'x-valid-color-name-p))))
5c8b7eaf 6142 (cperl-force-face font-lock-constant-face
5bd52f0e
RS
6143 "Face for constant and label names")
6144 (cperl-force-face font-lock-variable-name-face
6145 "Face for variable names")
6146 (cperl-force-face font-lock-type-face
6147 "Face for data types")
4ab89e7b 6148 (cperl-force-face cperl-nonoverridable-face
5bd52f0e 6149 "Face for data types from another group")
4ab89e7b
SM
6150 (cperl-force-face font-lock-warning-face
6151 "Face for things which should stand out")
5bd52f0e
RS
6152 (cperl-force-face font-lock-comment-face
6153 "Face for comments")
6154 (cperl-force-face font-lock-function-name-face
6155 "Face for function names")
4ab89e7b 6156 (cperl-force-face cperl-hash-face
5bd52f0e 6157 "Face for hashes")
4ab89e7b 6158 (cperl-force-face cperl-array-face
5bd52f0e
RS
6159 "Face for arrays")
6160 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6161 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6162 ;;(or (boundp 'font-lock-type-face)
6163 ;; (defconst font-lock-type-face
6164 ;; 'font-lock-type-face
6165 ;; "Face to use for data types."))
6166 ;;(or (boundp 'cperl-nonoverridable-face)
6167 ;; (defconst cperl-nonoverridable-face
4ab89e7b 6168 ;; 'cperl-nonoverridable-face
5bd52f0e
RS
6169 ;; "Face to use for data types from another group."))
6170 ;;(if (not cperl-xemacs-p) nil
6171 ;; (or (boundp 'font-lock-comment-face)
6172 ;; (defconst font-lock-comment-face
6173 ;; 'font-lock-comment-face
6174 ;; "Face to use for comments."))
6175 ;; (or (boundp 'font-lock-keyword-face)
6176 ;; (defconst font-lock-keyword-face
6177 ;; 'font-lock-keyword-face
6178 ;; "Face to use for keywords."))
6179 ;; (or (boundp 'font-lock-function-name-face)
6180 ;; (defconst font-lock-function-name-face
6181 ;; 'font-lock-function-name-face
6182 ;; "Face to use for function names.")))
6183 (if (and
4ab89e7b 6184 (not (cperl-is-face 'cperl-array-face))
5c8b7eaf 6185 (cperl-is-face 'font-lock-emphasized-face))
4ab89e7b 6186 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
5bd52f0e 6187 (if (and
4ab89e7b 6188 (not (cperl-is-face 'cperl-hash-face))
5c8b7eaf 6189 (cperl-is-face 'font-lock-other-emphasized-face))
4ab89e7b 6190 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
5bd52f0e 6191 (if (and
4ab89e7b 6192 (not (cperl-is-face 'cperl-nonoverridable-face))
5c8b7eaf 6193 (cperl-is-face 'font-lock-other-type-face))
4ab89e7b 6194 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
5bd52f0e
RS
6195 ;;(or (boundp 'cperl-hash-face)
6196 ;; (defconst cperl-hash-face
4ab89e7b 6197 ;; 'cperl-hash-face
5bd52f0e
RS
6198 ;; "Face to use for hashes."))
6199 ;;(or (boundp 'cperl-array-face)
6200 ;; (defconst cperl-array-face
4ab89e7b 6201 ;; 'cperl-array-face
5bd52f0e 6202 ;; "Face to use for arrays."))
f83d2997
KH
6203 ;; Here we try to guess background
6204 (let ((background
6205 (if (boundp 'font-lock-background-mode)
6206 font-lock-background-mode
5c8b7eaf 6207 'light))
83261a2f 6208 (face-list (and (fboundp 'face-list) (face-list))))
5bd52f0e
RS
6209;;;; (fset 'cperl-is-face
6210;;;; (cond ((fboundp 'find-face)
6211;;;; (symbol-function 'find-face))
6212;;;; (face-list
6213;;;; (function (lambda (face) (member face face-list))))
6214;;;; (t
6215;;;; (function (lambda (face) (boundp face))))))
f83d2997
KH
6216 (defvar cperl-guessed-background
6217 (if (and (boundp 'font-lock-display-type)
6218 (eq font-lock-display-type 'grayscale))
6219 'gray
6220 background)
6221 "Background as guessed by CPerl mode")
83261a2f
SM
6222 (and (not (cperl-is-face 'font-lock-constant-face))
6223 (cperl-is-face 'font-lock-reference-face)
6224 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
db133cb6 6225 (if (cperl-is-face 'font-lock-type-face) nil
f83d2997
KH
6226 (copy-face 'default 'font-lock-type-face)
6227 (cond
6228 ((eq background 'light)
6229 (set-face-foreground 'font-lock-type-face
6230 (if (x-color-defined-p "seagreen")
6231 "seagreen"
6232 "sea green")))
6233 ((eq background 'dark)
6234 (set-face-foreground 'font-lock-type-face
6235 (if (x-color-defined-p "os2pink")
6236 "os2pink"
6237 "pink")))
6238 (t
6239 (set-face-background 'font-lock-type-face "gray90"))))
4ab89e7b 6240 (if (cperl-is-face 'cperl-nonoverridable-face)
f83d2997 6241 nil
4ab89e7b 6242 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
f83d2997
KH
6243 (cond
6244 ((eq background 'light)
4ab89e7b 6245 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6246 (if (x-color-defined-p "chartreuse3")
6247 "chartreuse3"
6248 "chartreuse")))
6249 ((eq background 'dark)
4ab89e7b 6250 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
6251 (if (x-color-defined-p "orchid1")
6252 "orchid1"
6253 "orange")))))
5bd52f0e
RS
6254;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6255;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6256;;; (cond
6257;;; ((eq background 'light)
6258;;; (set-face-background 'font-lock-other-emphasized-face
6259;;; (if (x-color-defined-p "lightyellow2")
6260;;; "lightyellow2"
6261;;; (if (x-color-defined-p "lightyellow")
6262;;; "lightyellow"
6263;;; "light yellow"))))
6264;;; ((eq background 'dark)
6265;;; (set-face-background 'font-lock-other-emphasized-face
6266;;; (if (x-color-defined-p "navy")
6267;;; "navy"
6268;;; (if (x-color-defined-p "darkgreen")
6269;;; "darkgreen"
6270;;; "dark green"))))
6271;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6272;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6273;;; (copy-face 'bold 'font-lock-emphasized-face)
6274;;; (cond
6275;;; ((eq background 'light)
6276;;; (set-face-background 'font-lock-emphasized-face
6277;;; (if (x-color-defined-p "lightyellow2")
6278;;; "lightyellow2"
6279;;; "lightyellow")))
6280;;; ((eq background 'dark)
6281;;; (set-face-background 'font-lock-emphasized-face
6282;;; (if (x-color-defined-p "navy")
6283;;; "navy"
6284;;; (if (x-color-defined-p "darkgreen")
6285;;; "darkgreen"
6286;;; "dark green"))))
6287;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
db133cb6 6288 (if (cperl-is-face 'font-lock-variable-name-face) nil
f83d2997 6289 (copy-face 'italic 'font-lock-variable-name-face))
db133cb6 6290 (if (cperl-is-face 'font-lock-constant-face) nil
883212ce 6291 (copy-face 'italic 'font-lock-constant-face))))
f83d2997 6292 (setq cperl-faces-init t))
5bd52f0e 6293 (error (message "cperl-init-faces (ignored): %s" errs))))
f83d2997
KH
6294
6295
6296(defun cperl-ps-print-init ()
6297 "Initialization of `ps-print' components for faces used in CPerl."
5bd52f0e
RS
6298 (eval-after-load "ps-print"
6299 '(setq ps-bold-faces
5c8b7eaf 6300 ;; font-lock-variable-name-face
5bd52f0e 6301 ;; font-lock-constant-face
4ab89e7b 6302 (append '(cperl-array-face cperl-hash-face)
5bd52f0e
RS
6303 ps-bold-faces)
6304 ps-italic-faces
6305 ;; font-lock-constant-face
4ab89e7b 6306 (append '(cperl-nonoverridable-face cperl-hash-face)
5bd52f0e
RS
6307 ps-italic-faces)
6308 ps-underlined-faces
6309 ;; font-lock-type-face
4ab89e7b 6310 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
5bd52f0e
RS
6311 ps-underlined-faces))))
6312
6313(defvar ps-print-face-extension-alist)
6314
6315(defun cperl-ps-print (&optional file)
6316 "Pretty-print in CPerl style.
6317If optional argument FILE is an empty string, prints to printer, otherwise
6318to the file FILE. If FILE is nil, prompts for a file name.
6319
6320Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6321 (interactive)
5c8b7eaf
SS
6322 (or file
6323 (setq file (read-from-minibuffer
5bd52f0e
RS
6324 "Print to file (if empty - to printer): "
6325 (concat (buffer-file-name) ".ps")
6326 nil nil 'file-name-history)))
6327 (or (> (length file) 0)
6328 (setq file nil))
6329 (require 'ps-print) ; To get ps-print-face-extension-alist
6330 (let ((ps-print-color-p t)
6331 (ps-print-face-extension-alist ps-print-face-extension-alist))
6332 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6333 (ps-print-buffer-with-faces file)))
6334
6335;;; (defun cperl-ps-print-init ()
6336;;; "Initialization of `ps-print' components for faces used in CPerl."
6337;;; ;; Guard against old versions
6338;;; (defvar ps-underlined-faces nil)
6339;;; (defvar ps-bold-faces nil)
6340;;; (defvar ps-italic-faces nil)
6341;;; (setq ps-bold-faces
6342;;; (append '(font-lock-emphasized-face
4ab89e7b 6343;;; cperl-array-face
5c8b7eaf
SS
6344;;; font-lock-keyword-face
6345;;; font-lock-variable-name-face
6346;;; font-lock-constant-face
6347;;; font-lock-reference-face
5bd52f0e 6348;;; font-lock-other-emphasized-face
4ab89e7b 6349;;; cperl-hash-face)
5bd52f0e
RS
6350;;; ps-bold-faces))
6351;;; (setq ps-italic-faces
4ab89e7b 6352;;; (append '(cperl-nonoverridable-face
5c8b7eaf
SS
6353;;; font-lock-constant-face
6354;;; font-lock-reference-face
5bd52f0e 6355;;; font-lock-other-emphasized-face
4ab89e7b 6356;;; cperl-hash-face)
5bd52f0e
RS
6357;;; ps-italic-faces))
6358;;; (setq ps-underlined-faces
6359;;; (append '(font-lock-emphasized-face
4ab89e7b 6360;;; cperl-array-face
5bd52f0e 6361;;; font-lock-other-emphasized-face
4ab89e7b
SM
6362;;; cperl-hash-face
6363;;; cperl-nonoverridable-face font-lock-type-face)
5bd52f0e
RS
6364;;; ps-underlined-faces))
6365;;; (cons 'font-lock-type-face ps-underlined-faces))
f83d2997
KH
6366
6367
6368(if (cperl-enable-font-lock) (cperl-windowed-init))
6369
db133cb6 6370(defconst cperl-styles-entries
5c8b7eaf
SS
6371 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6372 cperl-label-offset cperl-extra-newline-before-brace
4ab89e7b 6373 cperl-extra-newline-before-brace-multiline
bab27c0c 6374 cperl-merge-trailing-else
db133cb6
RS
6375 cperl-continued-statement-offset))
6376
4ab89e7b
SM
6377(defconst cperl-style-examples
6378"##### Numbers etc are: cperl-indent-level cperl-brace-offset
6379##### cperl-continued-brace-offset cperl-label-offset
6380##### cperl-continued-statement-offset
6381##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6382
6383########### (Do not forget cperl-extra-newline-before-brace-multiline)
6384
6385### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6386if (foo) {
6387 bar
6388 baz;
6389 label:
6390 {
6391 boon;
6392 }
6393} else {
6394 stop;
6395}
6396
6397### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6398if (foo) {
6399 bar
6400 baz;
6401 label:
6402 {
6403 boon;
6404 }
6405} else {
6406 stop;
6407}
6408
6409### GNU 2/0/0/-2/2/nil/t
6410if (foo)
6411 {
6412 bar
6413 baz;
6414 label:
6415 {
6416 boon;
6417 }
6418 }
6419else
6420 {
6421 stop;
6422 }
6423
6424### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6425if (foo)
6426{
6427 bar
6428 baz;
6429 label:
6430 {
6431 boon;
6432 }
6433}
6434else
6435{
6436 stop;
6437}
6438
6439### BSD (=C++, but will not change preexisting merge-trailing-else
6440### and extra-newline-before-brace ) 4/0/-4/-4/4
6441if (foo)
6442{
6443 bar
6444 baz;
6445 label:
6446 {
6447 boon;
6448 }
6449}
6450else
6451{
6452 stop;
6453}
6454
6455### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6456### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6457if (foo)
6458{
6459 bar
6460 baz;
6461 label:
6462 {
6463 boon;
6464 }
6465}
6466else
6467{
6468 stop;
6469}
6470
6471### Whitesmith (=PerlStyle, but will not change preexisting
6472### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6473if (foo)
6474 {
6475 bar
6476 baz;
6477 label:
6478 {
6479 boon;
6480 }
6481 }
6482else
6483 {
6484 stop;
6485 }
6486"
6487"Examples of if/else with different indent styles (with v4.23).")
6488
db133cb6 6489(defconst cperl-style-alist
4ab89e7b 6490 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
db133cb6
RS
6491 (cperl-indent-level . 2)
6492 (cperl-brace-offset . 0)
6493 (cperl-continued-brace-offset . 0)
6494 (cperl-label-offset . -2)
4ab89e7b 6495 (cperl-continued-statement-offset . 2)
db133cb6 6496 (cperl-extra-newline-before-brace . nil)
4ab89e7b
SM
6497 (cperl-extra-newline-before-brace-multiline . nil)
6498 (cperl-merge-trailing-else . t))
6499
83261a2f 6500 ("PerlStyle" ; CPerl with 4 as indent
db133cb6
RS
6501 (cperl-indent-level . 4)
6502 (cperl-brace-offset . 0)
6503 (cperl-continued-brace-offset . 0)
6504 (cperl-label-offset . -4)
4ab89e7b 6505 (cperl-continued-statement-offset . 4)
db133cb6 6506 (cperl-extra-newline-before-brace . nil)
4ab89e7b
SM
6507 (cperl-extra-newline-before-brace-multiline . nil)
6508 (cperl-merge-trailing-else . t))
6509
db133cb6
RS
6510 ("GNU"
6511 (cperl-indent-level . 2)
6512 (cperl-brace-offset . 0)
6513 (cperl-continued-brace-offset . 0)
6514 (cperl-label-offset . -2)
4ab89e7b 6515 (cperl-continued-statement-offset . 2)
db133cb6 6516 (cperl-extra-newline-before-brace . t)
4ab89e7b
SM
6517 (cperl-extra-newline-before-brace-multiline . t)
6518 (cperl-merge-trailing-else . nil))
6519
db133cb6
RS
6520 ("K&R"
6521 (cperl-indent-level . 5)
6522 (cperl-brace-offset . 0)
6523 (cperl-continued-brace-offset . -5)
6524 (cperl-label-offset . -5)
4ab89e7b 6525 (cperl-continued-statement-offset . 5)
db133cb6 6526 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6527 ;;(cperl-extra-newline-before-brace-multiline . nil)
6528 (cperl-merge-trailing-else . nil))
6529
db133cb6
RS
6530 ("BSD"
6531 (cperl-indent-level . 4)
6532 (cperl-brace-offset . 0)
6533 (cperl-continued-brace-offset . -4)
6534 (cperl-label-offset . -4)
4ab89e7b 6535 (cperl-continued-statement-offset . 4)
db133cb6 6536 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6537 ;;(cperl-extra-newline-before-brace-multiline . nil)
6538 ;;(cperl-merge-trailing-else . nil) ; ???
6539 )
6540
db133cb6
RS
6541 ("C++"
6542 (cperl-indent-level . 4)
6543 (cperl-brace-offset . 0)
6544 (cperl-continued-brace-offset . -4)
6545 (cperl-label-offset . -4)
6546 (cperl-continued-statement-offset . 4)
4ab89e7b
SM
6547 (cperl-extra-newline-before-brace . t)
6548 (cperl-extra-newline-before-brace-multiline . t)
6549 (cperl-merge-trailing-else . nil))
6550
db133cb6
RS
6551 ("Whitesmith"
6552 (cperl-indent-level . 4)
6553 (cperl-brace-offset . 0)
6554 (cperl-continued-brace-offset . 0)
6555 (cperl-label-offset . -4)
4ab89e7b 6556 (cperl-continued-statement-offset . 4)
db133cb6 6557 ;;(cperl-extra-newline-before-brace . nil) ; ???
4ab89e7b
SM
6558 ;;(cperl-extra-newline-before-brace-multiline . nil)
6559 ;;(cperl-merge-trailing-else . nil) ; ???
6560 )
6561 ("Current"))
6562 "List of variables to set to get a particular indentation style.
6563Should be used via `cperl-set-style' or via Perl menu.
6564
6565See examples in `cperl-style-examples'.")
db133cb6 6566
f83d2997 6567(defun cperl-set-style (style)
f94a632a 6568 "Set CPerl mode variables to use one of several different indentation styles.
f83d2997 6569The arguments are a string representing the desired style.
5c8b7eaf 6570The list of styles is in `cperl-style-alist', available styles
4ab89e7b 6571are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
db133cb6
RS
6572
6573The current value of style is memorized (unless there is a memorized
6574data already), may be restored by `cperl-set-style-back'.
6575
6576Chosing \"Current\" style will not change style, so this may be used for
4ab89e7b 6577side-effect of memorizing only. Examples in `cperl-style-examples'."
5c8b7eaf 6578 (interactive
15ca5699 6579 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
db133cb6 6580 cperl-style-alist)))
f83d2997 6581 (list (completing-read "Enter style: " list nil 'insist))))
db133cb6
RS
6582 (or cperl-old-style
6583 (setq cperl-old-style
6584 (mapcar (function
6585 (lambda (name)
6586 (cons name (eval name))))
6587 cperl-styles-entries)))
6588 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
f83d2997
KH
6589 (while style
6590 (setq setting (car style) style (cdr style))
db133cb6
RS
6591 (set (car setting) (cdr setting)))))
6592
6593(defun cperl-set-style-back ()
810fb442 6594 "Restore a style memorized by `cperl-set-style'."
db133cb6
RS
6595 (interactive)
6596 (or cperl-old-style (error "The style was not changed"))
6597 (let (setting)
6598 (while cperl-old-style
5c8b7eaf 6599 (setq setting (car cperl-old-style)
db133cb6
RS
6600 cperl-old-style (cdr cperl-old-style))
6601 (set (car setting) (cdr setting)))))
f83d2997
KH
6602
6603(defun cperl-check-syntax ()
6604 (interactive)
6605 (require 'mode-compile)
db133cb6
RS
6606 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6607 (eval '(mode-compile)))) ; Avoid a warning
f83d2997
KH
6608
6609(defun cperl-info-buffer (type)
6610 ;; Returns buffer with documentation. Creates if missing.
6611 ;; If TYPE, this vars buffer.
6612 ;; Special care is taken to not stomp over an existing info buffer
6613 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6614 (info (get-buffer bname))
6615 (oldbuf (get-buffer "*info*")))
6616 (if info info
6617 (save-window-excursion
6618 ;; Get Info running
6619 (require 'info)
6620 (cond (oldbuf
6621 (set-buffer oldbuf)
6622 (rename-buffer "*info-perl-tmp*")))
6623 (save-window-excursion
6624 (info))
6625 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6626 (set-buffer "*info*")
6627 (rename-buffer bname)
6628 (cond (oldbuf
6629 (set-buffer "*info-perl-tmp*")
6630 (rename-buffer "*info*")
6631 (set-buffer bname)))
029cb4d5 6632 (make-local-variable 'window-min-height)
f83d2997
KH
6633 (setq window-min-height 2)
6634 (current-buffer)))))
6635
6636(defun cperl-word-at-point (&optional p)
f94a632a 6637 "Return the word at point or at P."
f83d2997
KH
6638 (save-excursion
6639 (if p (goto-char p))
6640 (or (cperl-word-at-point-hard)
6641 (progn
6642 (require 'etags)
6643 (funcall (or (and (boundp 'find-tag-default-function)
6644 find-tag-default-function)
6645 (get major-mode 'find-tag-default-function)
6646 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6647 ;; automatically used within `find-tag-default':
6648 'find-tag-default))))))
6649
6650(defun cperl-info-on-command (command)
f94a632a 6651 "Show documentation for Perl command COMMAND in other window.
f83d2997
KH
6652If perl-info buffer is shown in some frame, uses this frame.
6653Customized by setting variables `cperl-shrink-wrap-info-frame',
6654`cperl-max-help-size'."
5c8b7eaf 6655 (interactive
f83d2997 6656 (let* ((default (cperl-word-at-point))
5c8b7eaf 6657 (read (read-string
83261a2f
SM
6658 (format "Find doc for Perl function (default %s): "
6659 default))))
5c8b7eaf 6660 (list (if (equal read "")
83261a2f
SM
6661 default
6662 read))))
f83d2997
KH
6663
6664 (let ((buffer (current-buffer))
6665 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6666 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6667 max-height char-height buf-list)
6668 (if (string-match "^-[a-zA-Z]$" command)
6669 (setq cmd-desc "^-X[ \t\n]"))
6670 (setq isvar (string-match "^[$@%]" command)
6671 buf (cperl-info-buffer isvar)
6672 iniwin (selected-window)
6673 fr1 (window-frame iniwin))
6674 (set-buffer buf)
fc49c9c6 6675 (goto-char (point-min))
5c8b7eaf 6676 (or isvar
f83d2997
KH
6677 (progn (re-search-forward "^-X[ \t\n]")
6678 (forward-line -1)))
6679 (if (re-search-forward cmd-desc nil t)
6680 (progn
6681 ;; Go back to beginning of the group (ex, for qq)
6682 (if (re-search-backward "^[ \t\n\f]")
6683 (forward-line 1))
6684 (beginning-of-line)
5c8b7eaf 6685 ;; Get some of
f83d2997
KH
6686 (setq pos (point)
6687 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6688 (while (and (not win) buf-list)
6689 (setq win (get-buffer-window (car buf-list) t))
6690 (setq buf-list (cdr buf-list)))
6691 (or (not win)
6692 (eq (window-buffer win) buf)
6693 (set-window-buffer win buf))
6694 (and win (setq fr2 (window-frame win)))
6695 (if (or (not fr2) (eq fr1 fr2))
6696 (pop-to-buffer buf)
6697 (special-display-popup-frame buf) ; Make it visible
6698 (select-window win))
6699 (goto-char pos) ; Needed (?!).
6700 ;; Resize
6701 (setq iniheight (window-height)
6702 frheight (frame-height)
6703 not-loner (< iniheight (1- frheight))) ; Are not alone
5c8b7eaf 6704 (cond ((if not-loner cperl-max-help-size
f83d2997 6705 cperl-shrink-wrap-info-frame)
5c8b7eaf
SS
6706 (setq height
6707 (+ 2
6708 (count-lines
6709 pos
f83d2997
KH
6710 (save-excursion
6711 (if (re-search-forward
6712 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6713 (match-beginning 0) (point-max)))))
5c8b7eaf 6714 max-height
f83d2997
KH
6715 (if not-loner
6716 (/ (* (- frheight 3) cperl-max-help-size) 100)
6717 (setq char-height (frame-char-height))
6718 ;; Non-functioning under OS/2:
6719 (if (eq char-height 1) (setq char-height 18))
6720 ;; Title, menubar, + 2 for slack
83261a2f 6721 (- (/ (x-display-pixel-height) char-height) 4)))
f83d2997
KH
6722 (if (> height max-height) (setq height max-height))
6723 ;;(message "was %s doing %s" iniheight height)
6724 (if not-loner
6725 (enlarge-window (- height iniheight))
6726 (set-frame-height (window-frame win) (1+ height)))))
6727 (set-window-start (selected-window) pos))
6728 (message "No entry for %s found." command))
6729 ;;(pop-to-buffer buffer)
6730 (select-window iniwin)))
6731
6732(defun cperl-info-on-current-command ()
029cb4d5 6733 "Show documentation for Perl command at point in other window."
f83d2997
KH
6734 (interactive)
6735 (cperl-info-on-command (cperl-word-at-point)))
6736
6737(defun cperl-imenu-info-imenu-search ()
6738 (if (looking-at "^-X[ \t\n]") nil
6739 (re-search-backward
6740 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6741 (forward-line 1)))
6742
5c8b7eaf 6743(defun cperl-imenu-info-imenu-name ()
f83d2997
KH
6744 (buffer-substring
6745 (match-beginning 1) (match-end 1)))
6746
6747(defun cperl-imenu-on-info ()
4ab89e7b
SM
6748 "Shows imenu for Perl Info Buffer.
6749Opens Perl Info buffer if needed."
f83d2997
KH
6750 (interactive)
6751 (let* ((buffer (current-buffer))
6752 imenu-create-index-function
5c8b7eaf
SS
6753 imenu-prev-index-position-function
6754 imenu-extract-index-name-function
f83d2997
KH
6755 (index-item (save-restriction
6756 (save-window-excursion
6757 (set-buffer (cperl-info-buffer nil))
5c8b7eaf 6758 (setq imenu-create-index-function
f83d2997
KH
6759 'imenu-default-create-index-function
6760 imenu-prev-index-position-function
6761 'cperl-imenu-info-imenu-search
6762 imenu-extract-index-name-function
6763 'cperl-imenu-info-imenu-name)
6764 (imenu-choose-buffer-index)))))
6765 (and index-item
6766 (progn
6767 (push-mark)
6768 (pop-to-buffer "*info-perl*")
6769 (cond
6770 ((markerp (cdr index-item))
6771 (goto-char (marker-position (cdr index-item))))
6772 (t
6773 (goto-char (cdr index-item))))
6774 (set-window-start (selected-window) (point))
6775 (pop-to-buffer buffer)))))
6776
6777(defun cperl-lineup (beg end &optional step minshift)
6778 "Lineup construction in a region.
6779Beginning of region should be at the start of a construction.
6780All first occurrences of this construction in the lines that are
6781partially contained in the region are lined up at the same column.
6782
6783MINSHIFT is the minimal amount of space to insert before the construction.
6784STEP is the tabwidth to position constructions.
029cb4d5 6785If STEP is nil, `cperl-lineup-step' will be used
15ca5699 6786\(or `cperl-indent-level', if `cperl-lineup-step' is nil).
f83d2997
KH
6787Will not move the position at the start to the left."
6788 (interactive "r")
4ab89e7b 6789 (let (search col tcol seen b)
f83d2997
KH
6790 (save-excursion
6791 (goto-char end)
6792 (end-of-line)
6793 (setq end (point-marker))
6794 (goto-char beg)
6795 (skip-chars-forward " \t\f")
6796 (setq beg (point-marker))
6797 (indent-region beg end nil)
6798 (goto-char beg)
6799 (setq col (current-column))
6800 (if (looking-at "[a-zA-Z0-9_]")
6801 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6802 (setq search
5c8b7eaf
SS
6803 (concat "\\<"
6804 (regexp-quote
f83d2997
KH
6805 (buffer-substring (match-beginning 0)
6806 (match-end 0))) "\\>"))
6807 (error "Cannot line up in a middle of the word"))
6808 (if (looking-at "$")
6809 (error "Cannot line up end of line"))
6810 (setq search (regexp-quote (char-to-string (following-char)))))
6811 (setq step (or step cperl-lineup-step cperl-indent-level))
6812 (or minshift (setq minshift 1))
6813 (while (progn
6814 (beginning-of-line 2)
5c8b7eaf 6815 (and (< (point) end)
f83d2997
KH
6816 (re-search-forward search end t)
6817 (goto-char (match-beginning 0))))
6818 (setq tcol (current-column) seen t)
6819 (if (> tcol col) (setq col tcol)))
6820 (or seen
6821 (error "The construction to line up occurred only once"))
6822 (goto-char beg)
6823 (setq col (+ col minshift))
6824 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5c8b7eaf 6825 (while
f83d2997 6826 (progn
4ab89e7b 6827 (cperl-make-indent col)
5c8b7eaf
SS
6828 (beginning-of-line 2)
6829 (and (< (point) end)
f83d2997
KH
6830 (re-search-forward search end t)
6831 (goto-char (match-beginning 0)))))))) ; No body
6832
4ab89e7b 6833(defun cperl-etags (&optional add all files) ;; NOT USED???
f83d2997
KH
6834 "Run etags with appropriate options for Perl files.
6835If optional argument ALL is `recursive', will process Perl files
6836in subdirectories too."
6837 (interactive)
6838 (let ((cmd "etags")
4ab89e7b
SM
6839 (args '("-l" "none" "-r"
6840 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6841 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6842 "-r"
6843 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6844 "-r"
6845 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
f83d2997
KH
6846 res)
6847 (if add (setq args (cons "-a" args)))
6848 (or files (setq files (list buffer-file-name)))
6849 (cond
6850 ((eq all 'recursive)
6851 ;;(error "Not implemented: recursive")
5c8b7eaf 6852 (setq args (append (list "-e"
f83d2997
KH
6853 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6854 use File::Find;
6855 find(\\&wanted, '.');
5c8b7eaf 6856 exec @ARGV;"
f83d2997
KH
6857 cmd) args)
6858 cmd "perl"))
5c8b7eaf 6859 (all
f83d2997 6860 ;;(error "Not implemented: all")
5c8b7eaf 6861 (setq args (append (list "-e"
f83d2997 6862 "push @ARGV, <*.PL *.pl *.pm>;
5c8b7eaf 6863 exec @ARGV;"
f83d2997
KH
6864 cmd) args)
6865 cmd "perl"))
6866 (t
6867 (setq args (append args files))))
6868 (setq res (apply 'call-process cmd nil nil nil args))
6869 (or (eq res 0)
6870 (message "etags returned \"%s\"" res))))
6871
6872(defun cperl-toggle-auto-newline ()
6873 "Toggle the state of `cperl-auto-newline'."
6874 (interactive)
6875 (setq cperl-auto-newline (not cperl-auto-newline))
5c8b7eaf 6876 (message "Newlines will %sbe auto-inserted now."
f83d2997
KH
6877 (if cperl-auto-newline "" "not ")))
6878
6879(defun cperl-toggle-abbrev ()
6880 "Toggle the state of automatic keyword expansion in CPerl mode."
6881 (interactive)
6882 (abbrev-mode (if abbrev-mode 0 1))
5c8b7eaf 6883 (message "Perl control structure will %sbe auto-inserted now."
f83d2997
KH
6884 (if abbrev-mode "" "not ")))
6885
6886
6887(defun cperl-toggle-electric ()
6888 "Toggle the state of parentheses doubling in CPerl mode."
6889 (interactive)
6890 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5c8b7eaf 6891 (message "Parentheses will %sbe auto-doubled now."
f83d2997
KH
6892 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6893
db133cb6 6894(defun cperl-toggle-autohelp ()
f739b53b
SM
6895 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6896Delay of auto-help controlled by `cperl-lazy-help-time'."
db133cb6
RS
6897 (interactive)
6898 (if (fboundp 'run-with-idle-timer)
6899 (progn
6900 (if cperl-lazy-installed
f739b53b 6901 (cperl-lazy-unstall)
db133cb6 6902 (cperl-lazy-install))
5c8b7eaf 6903 (message "Perl help messages will %sbe automatically shown now."
db133cb6
RS
6904 (if cperl-lazy-installed "" "not ")))
6905 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6906
6907(defun cperl-toggle-construct-fix ()
6908 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6909 (interactive)
5c8b7eaf 6910 (setq cperl-indent-region-fix-constructs
5bd52f0e
RS
6911 (if cperl-indent-region-fix-constructs
6912 nil
6913 1))
5c8b7eaf 6914 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
db133cb6
RS
6915 (if cperl-indent-region-fix-constructs "" "not ")))
6916
4ab89e7b
SM
6917(defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6918 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6919Nonpositive numeric argument disables debugging messages. The message
6920summarizes which regions it was decided to rescan for syntactic constructs.
6921
6922The message looks like this:
6923
6924 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6925
6926Numbers are character positions in the buffer. REQ provides the range to
6927rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6928for correct operation it should start and end outside any special syntactic
6929construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6930by CPerl."
6931 (interactive "P")
6932 (or arg
6933 (setq arg (if (eq cperl-syntaxify-by-font-lock
6934 (if backtrace 'backtrace 'message)) 0 1)))
6935 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6936 (setq cperl-syntaxify-by-font-lock arg)
6937 (message "Debugging messages of syntax unwind %sabled."
6938 (if (eq arg t) "dis" "en")))
6939
f83d2997
KH
6940;;;; Tags file creation.
6941
6942(defvar cperl-tmp-buffer " *cperl-tmp*")
6943
6944(defun cperl-setup-tmp-buf ()
6945 (set-buffer (get-buffer-create cperl-tmp-buffer))
6946 (set-syntax-table cperl-mode-syntax-table)
6947 (buffer-disable-undo)
6948 (auto-fill-mode 0)
6949 (if cperl-use-syntax-table-text-property-for-tags
6950 (progn
029cb4d5 6951 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997
KH
6952 ;; Do not introduce variable if not needed, we check it!
6953 (set 'parse-sexp-lookup-properties t))))
6954
6955(defun cperl-xsub-scan ()
f83d2997 6956 (require 'imenu)
5c8b7eaf 6957 (let ((index-alist '())
f83d2997
KH
6958 (prev-pos 0) index index1 name package prefix)
6959 (goto-char (point-min))
f83d2997
KH
6960 ;; Search for the function
6961 (progn ;;save-match-data
6962 (while (re-search-forward
6963 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6964 nil t)
f83d2997 6965 (cond
83261a2f 6966 ((match-beginning 2) ; SECTION
f83d2997
KH
6967 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6968 (goto-char (match-beginning 0))
6969 (skip-chars-forward " \t")
6970 (forward-char 1)
6971 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6972 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6973 (setq prefix nil)))
6974 ((not package) nil) ; C language section
6975 ((match-beginning 3) ; XSUB
6976 (goto-char (1+ (match-beginning 3)))
6977 (setq index (imenu-example--name-and-position))
6978 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6979 (if (and prefix (string-match (concat "^" prefix) name))
6980 (setq name (substring name (length prefix))))
6981 (cond ((string-match "::" name) nil)
6982 (t
6983 (setq index1 (cons (concat package "::" name) (cdr index)))
6984 (push index1 index-alist)))
6985 (setcar index name)
6986 (push index index-alist))
6987 (t ; BOOT: section
6988 ;; (beginning-of-line)
6989 (setq index (imenu-example--name-and-position))
6990 (setcar index (concat package "::BOOT:"))
6991 (push index index-alist)))))
f83d2997
KH
6992 index-alist))
6993
6c389151
SM
6994(defvar cperl-unreadable-ok nil)
6995
6996(defun cperl-find-tags (ifile xs topdir)
83261a2f
SM
6997 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6998 (cperl-pod-here-fontify nil) f file)
f83d2997
KH
6999 (save-excursion
7000 (if b (set-buffer b)
83261a2f 7001 (cperl-setup-tmp-buf))
f83d2997 7002 (erase-buffer)
6c389151
SM
7003 (condition-case err
7004 (setq file (car (insert-file-contents ifile)))
7005 (error (if cperl-unreadable-ok nil
7006 (if (y-or-n-p
7007 (format "File %s unreadable. Continue? " ifile))
7008 (setq cperl-unreadable-ok t)
7009 (error "Aborting: unreadable file %s" ifile)))))
a1506d29 7010 (if (not file)
6c389151 7011 (message "Unreadable file %s" ifile)
83261a2f
SM
7012 (message "Scanning file %s ..." file)
7013 (if (and cperl-use-syntax-table-text-property-for-tags
7014 (not xs))
7015 (condition-case err ; after __END__ may have garbage
7016 (cperl-find-pods-heres nil nil noninteractive)
7017 (error (message "While scanning for syntax: %s" err))))
7018 (if xs
7019 (setq lst (cperl-xsub-scan))
7020 (setq ind (cperl-imenu--create-perl-index))
7021 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
7022 (setq lst
7023 (mapcar
7024 (function
7025 (lambda (elt)
7026 (cond ((string-match "^[_a-zA-Z]" (car elt))
7027 (goto-char (cdr elt))
7028 (beginning-of-line) ; pos should be of the start of the line
7029 (list (car elt)
7030 (point)
7031 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
7032 (buffer-substring (progn
7033 (goto-char (cdr elt))
7034 ;; After name now...
7035 (or (eolp) (forward-char 1))
7036 (point))
7037 (progn
7038 (beginning-of-line)
7039 (point))))))))
7040 lst))
7041 (erase-buffer)
7042 (while lst
7043 (setq elt (car lst) lst (cdr lst))
7044 (if elt
7045 (progn
7046 (insert (elt elt 3)
7047 127
7048 (if (string-match "^package " (car elt))
7049 (substring (car elt) 8)
7050 (car elt) )
7051 1
7052 (number-to-string (elt elt 2)) ; Line
7053 ","
7054 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
7055 "\n")
7056 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
7057 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
7058 (elt elt 3)))
7059 ;; Need to insert the name without package as well
15ca5699 7060 (setq lst (cons (cons (substring (elt elt 3)
83261a2f
SM
7061 (match-beginning 1)
7062 (match-end 1))
7063 (cdr elt))
7064 lst))))))
7065 (setq pos (point))
7066 (goto-char 1)
7067 (setq rel file)
7068 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7069 (set-text-properties 0 (length rel) nil rel)
7070 (and (equal topdir (substring rel 0 (length topdir)))
7071 (setq rel (substring file (length topdir))))
7072 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7073 (setq ret (buffer-substring 1 (point-max)))
7074 (erase-buffer)
7075 (or noninteractive
7076 (message "Scanning file %s finished" file))
7077 ret))))
f83d2997
KH
7078
7079(defun cperl-add-tags-recurse-noxs ()
4ab89e7b 7080 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
f83d2997
KH
7081Use as
7082 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
4ab89e7b 7083 -f cperl-add-tags-recurse-noxs
f83d2997
KH
7084"
7085 (cperl-write-tags nil nil t t nil t))
7086
4ab89e7b
SM
7087(defun cperl-add-tags-recurse-noxs-fullpath ()
7088 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7089Writes down fullpath, so TAGS is relocatable (but if the build directory
7090is relocated, the file TAGS inside it breaks). Use as
7091 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7092 -f cperl-add-tags-recurse-noxs-fullpath
7093"
7094 (cperl-write-tags nil nil t t nil t ""))
7095
f83d2997
KH
7096(defun cperl-add-tags-recurse ()
7097 "Add to TAGS file data for Perl files in the current directory and kids.
7098Use as
7099 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 7100 -f cperl-add-tags-recurse
f83d2997
KH
7101"
7102 (cperl-write-tags nil nil t t))
7103
7104(defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7105 ;; If INBUFFER, do not select buffer, and do not save
7106 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7107 (require 'etags)
7108 (if file nil
7109 (setq file (if dir default-directory (buffer-file-name)))
7110 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7111 (or topdir
7112 (setq topdir default-directory))
7113 (let ((tags-file-name "TAGS")
7114 (case-fold-search (eq system-type 'emx))
6c389151 7115 xs rel tm)
f83d2997
KH
7116 (save-excursion
7117 (cond (inbuffer nil) ; Already there
7118 ((file-exists-p tags-file-name)
5bd52f0e
RS
7119 (if cperl-xemacs-p
7120 (visit-tags-table-buffer)
83261a2f 7121 (visit-tags-table-buffer tags-file-name)))
f83d2997
KH
7122 (t (set-buffer (find-file-noselect tags-file-name))))
7123 (cond
7124 (dir
7125 (cond ((eq erase 'ignore))
7126 (erase
7127 (erase-buffer)
7128 (setq erase 'ignore)))
a1506d29 7129 (let ((files
6c389151 7130 (condition-case err
a1506d29 7131 (directory-files file t
6c389151
SM
7132 (if recurse nil cperl-scan-files-regexp)
7133 t)
7134 (error
7135 (if cperl-unreadable-ok nil
7136 (if (y-or-n-p
7137 (format "Directory %s unreadable. Continue? " file))
a1506d29 7138 (setq cperl-unreadable-ok t
83261a2f 7139 tm nil) ; Return empty list
6c389151 7140 (error "Aborting: unreadable directory %s" file)))))))
15ca5699 7141 (mapcar (function
83261a2f
SM
7142 (lambda (file)
7143 (cond
7144 ((string-match cperl-noscan-files-regexp file)
7145 nil)
7146 ((not (file-directory-p file))
7147 (if (string-match cperl-scan-files-regexp file)
7148 (cperl-write-tags file erase recurse nil t noxs topdir)))
7149 ((not recurse) nil)
7150 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7151 files)))
f83d2997
KH
7152 (t
7153 (setq xs (string-match "\\.xs$" file))
7154 (if (not (and xs noxs))
7155 (progn
7156 (cond ((eq erase 'ignore) (goto-char (point-max)))
83261a2f
SM
7157 (erase (erase-buffer))
7158 (t
7159 (goto-char 1)
7160 (setq rel file)
7161 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7162 (set-text-properties 0 (length rel) nil rel)
7163 (and (equal topdir (substring rel 0 (length topdir)))
7164 (setq rel (substring file (length topdir))))
7165 (if (search-forward (concat "\f\n" rel ",") nil t)
7166 (progn
7167 (search-backward "\f\n")
7168 (delete-region (point)
7169 (save-excursion
7170 (forward-char 1)
7171 (if (search-forward "\f\n"
7172 nil 'toend)
7173 (- (point) 2)
7174 (point-max)))))
7175 (goto-char (point-max)))))
f83d2997 7176 (insert (cperl-find-tags file xs topdir))))))
83261a2f
SM
7177 (if inbuffer nil ; Delegate to the caller
7178 (save-buffer 0) ; No backup
f83d2997
KH
7179 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7180 (initialize-new-tags-table))))))
7181
7182(defvar cperl-tags-hier-regexp-list
5c8b7eaf 7183 (concat
f83d2997
KH
7184 "^\\("
7185 "\\(package\\)\\>"
7186 "\\|"
7187 "sub\\>[^\n]+::"
7188 "\\|"
7189 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7190 "\\|"
7191 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7192 "\\)"))
7193
7194(defvar cperl-hierarchy '(() ())
f94a632a 7195 "Global hierarchy of classes.")
f83d2997
KH
7196
7197(defun cperl-tags-hier-fill ()
7198 ;; Suppose we are in a tag table cooked by cperl.
7199 (goto-char 1)
7200 (let (type pack name pos line chunk ord cons1 file str info fileind)
7201 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5c8b7eaf 7202 (setq pos (match-beginning 0)
f83d2997
KH
7203 pack (match-beginning 2))
7204 (beginning-of-line)
7205 (if (looking-at (concat
7206 "\\([^\n]+\\)"
7207 "\C-?"
7208 "\\([^\n]+\\)"
7209 "\C-a"
7210 "\\([0-9]+\\)"
7211 ","
7212 "\\([0-9]+\\)"))
7213 (progn
7214 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7215 name (buffer-substring (match-beginning 2) (match-end 2))
7216 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5bd52f0e 7217 line (buffer-substring (match-beginning 3) (match-end 3))
f83d2997 7218 ord (if pack 1 0)
f83d2997 7219 file (file-of-tag)
5bd52f0e
RS
7220 fileind (format "%s:%s" file line)
7221 ;; Moves to beginning of the next line:
7222 info (cperl-etags-snarf-tag file line))
f83d2997
KH
7223 ;; Move back
7224 (forward-char -1)
7225 ;; Make new member of hierarchy name ==> file ==> pos if needed
7226 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7227 ;; Name known
7228 (setcdr cons1 (cons (cons fileind (vector file info))
7229 (cdr cons1)))
7230 ;; First occurrence of the name, start alist
7231 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5c8b7eaf 7232 (if pack
f83d2997
KH
7233 (setcar (cdr cperl-hierarchy)
7234 (cons cons1 (nth 1 cperl-hierarchy)))
7235 (setcar cperl-hierarchy
7236 (cons cons1 (car cperl-hierarchy)))))))
7237 (end-of-line))))
7238
7239(defun cperl-tags-hier-init (&optional update)
7240 "Show hierarchical menu of classes and methods.
7241Finds info about classes by a scan of loaded TAGS files.
7242Supposes that the TAGS files contain fully qualified function names.
7243One may build such TAGS files from CPerl mode menu."
7244 (interactive)
7245 (require 'etags)
7246 (require 'imenu)
7247 (if (or update (null (nth 2 cperl-hierarchy)))
83261a2f
SM
7248 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7249 (or (nthcdr 2 elt)
7250 ;; Only in one file
7251 (setcdr elt (cdr (nth 1 elt)))))))
7252 pack name cons1 to l1 l2 l3 l4 b)
f83d2997
KH
7253 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7254 (setq cperl-hierarchy (list l1 l2 l3))
5bd52f0e
RS
7255 (if cperl-xemacs-p ; Not checked
7256 (progn
7257 (or tags-file-name
7258 ;; Does this work in XEmacs?
f83d2997
KH
7259 (call-interactively 'visit-tags-table))
7260 (message "Updating list of classes...")
5bd52f0e
RS
7261 (set-buffer (get-file-buffer tags-file-name))
7262 (cperl-tags-hier-fill))
7263 (or tags-table-list
7264 (call-interactively 'visit-tags-table))
4ab89e7b
SM
7265 (mapcar
7266 (function
7267 (lambda (tagsfile)
5bd52f0e 7268 (message "Updating list of classes... %s" tagsfile)
f83d2997
KH
7269 (set-buffer (get-file-buffer tagsfile))
7270 (cperl-tags-hier-fill)))
7271 tags-table-list)
5bd52f0e 7272 (message "Updating list of classes... postprocessing..."))
f83d2997
KH
7273 (mapcar remover (car cperl-hierarchy))
7274 (mapcar remover (nth 1 cperl-hierarchy))
7275 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7276 (cons "Methods: " (car cperl-hierarchy))))
7277 (cperl-tags-treeify to 1)
7278 (setcar (nthcdr 2 cperl-hierarchy)
7279 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7280 (message "Updating list of classes: done, requesting display...")
7281 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7282 ))
7283 (or (nth 2 cperl-hierarchy)
7284 (error "No items found"))
7285 (setq update
7286;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
83261a2f
SM
7287 (if (if (fboundp 'display-popup-menus-p)
7288 (let ((f 'display-popup-menus-p))
7289 (funcall f))
7290 window-system)
f83d2997
KH
7291 (x-popup-menu t (nth 2 cperl-hierarchy))
7292 (require 'tmm)
7293 (tmm-prompt (nth 2 cperl-hierarchy))))
7294 (if (and update (listp update))
7295 (progn (while (cdr update) (setq update (cdr update)))
7296 (setq update (car update)))) ; Get the last from the list
5c8b7eaf 7297 (if (vectorp update)
f83d2997
KH
7298 (progn
7299 (find-file (elt update 0))
5bd52f0e 7300 (cperl-etags-goto-tag-location (elt update 1))))
f83d2997
KH
7301 (if (eq update -999) (cperl-tags-hier-init t)))
7302
7303(defun cperl-tags-treeify (to level)
7304 ;; cadr of `to' is read-write. On start it is a cons
5c8b7eaf 7305 (let* ((regexp (concat "^\\(" (mapconcat
f83d2997
KH
7306 'identity
7307 (make-list level "[_a-zA-Z0-9]+")
7308 "::")
7309 "\\)\\(::\\)?"))
7310 (packages (cdr (nth 1 to)))
7311 (methods (cdr (nth 2 to)))
7312 l1 head tail cons1 cons2 ord writeto packs recurse
7313 root-packages root-functions ms many_ms same_name ps
7314 (move-deeper
5c8b7eaf 7315 (function
f83d2997
KH
7316 (lambda (elt)
7317 (cond ((and (string-match regexp (car elt))
7318 (or (eq ord 1) (match-end 2)))
7319 (setq head (substring (car elt) 0 (match-end 1))
5c8b7eaf 7320 tail (if (match-end 2) (substring (car elt)
f83d2997
KH
7321 (match-end 2)))
7322 recurse t)
7323 (if (setq cons1 (assoc head writeto)) nil
7324 ;; Need to init new head
7325 (setcdr writeto (cons (list head (list "Packages: ")
7326 (list "Methods: "))
7327 (cdr writeto)))
7328 (setq cons1 (nth 1 writeto)))
7329 (setq cons2 (nth ord cons1)) ; Either packs or meths
7330 (setcdr cons2 (cons elt (cdr cons2))))
7331 ((eq ord 2)
7332 (setq root-functions (cons elt root-functions)))
7333 (t
7334 (setq root-packages (cons elt root-packages))))))))
7335 (setcdr to l1) ; Init to dynamic space
7336 (setq writeto to)
7337 (setq ord 1)
7338 (mapcar move-deeper packages)
7339 (setq ord 2)
7340 (mapcar move-deeper methods)
7341 (if recurse
7342 (mapcar (function (lambda (elt)
7343 (cperl-tags-treeify elt (1+ level))))
7344 (cdr to)))
7345 ;;Now clean up leaders with one child only
7346 (mapcar (function (lambda (elt)
5c8b7eaf 7347 (if (not (and (listp (cdr elt))
f83d2997
KH
7348 (eq (length elt) 2))) nil
7349 (setcar elt (car (nth 1 elt)))
7350 (setcdr elt (cdr (nth 1 elt))))))
7351 (cdr to))
7352 ;; Sort the roots of subtrees
7353 (if (default-value 'imenu-sort-function)
7354 (setcdr to
7355 (sort (cdr to) (default-value 'imenu-sort-function))))
7356 ;; Now add back functions removed from display
7357 (mapcar (function (lambda (elt)
7358 (setcdr to (cons elt (cdr to)))))
7359 (if (default-value 'imenu-sort-function)
7360 (nreverse
7361 (sort root-functions (default-value 'imenu-sort-function)))
7362 root-functions))
7363 ;; Now add back packages removed from display
7364 (mapcar (function (lambda (elt)
5c8b7eaf
SS
7365 (setcdr to (cons (cons (concat "package " (car elt))
7366 (cdr elt))
f83d2997
KH
7367 (cdr to)))))
7368 (if (default-value 'imenu-sort-function)
5c8b7eaf 7369 (nreverse
f83d2997 7370 (sort root-packages (default-value 'imenu-sort-function)))
83261a2f 7371 root-packages))))
f83d2997
KH
7372
7373;;;(x-popup-menu t
5c8b7eaf 7374;;; '(keymap "Name1"
f83d2997 7375;;; ("Ret1" "aa")
5c8b7eaf
SS
7376;;; ("Head1" "ab"
7377;;; keymap "Name2"
f83d2997
KH
7378;;; ("Tail1" "x") ("Tail2" "y"))))
7379
7380(defun cperl-list-fold (list name limit)
7381 (let (list1 list2 elt1 (num 0))
7382 (if (<= (length list) limit) list
7383 (setq list1 nil list2 nil)
7384 (while list
5c8b7eaf 7385 (setq num (1+ num)
f83d2997
KH
7386 elt1 (car list)
7387 list (cdr list))
7388 (if (<= num imenu-max-items)
7389 (setq list2 (cons elt1 list2))
7390 (setq list1 (cons (cons name
7391 (nreverse list2))
7392 list1)
7393 list2 (list elt1)
7394 num 1)))
7395 (nreverse (cons (cons name
7396 (nreverse list2))
7397 list1)))))
7398
7399(defun cperl-menu-to-keymap (menu &optional name)
7400 (let (list)
5c8b7eaf
SS
7401 (cons 'keymap
7402 (mapcar
7403 (function
f83d2997
KH
7404 (lambda (elt)
7405 (cond ((listp (cdr elt))
7406 (setq list (cperl-list-fold
7407 (cdr elt) (car elt) imenu-max-items))
7408 (cons nil
7409 (cons (car elt)
7410 (cperl-menu-to-keymap list))))
7411 (t
7412 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7413 (cperl-list-fold menu "Root" imenu-max-items)))))
7414
7415\f
7416(defvar cperl-bad-style-regexp
7417 (mapconcat 'identity
83261a2f 7418 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
15ca5699 7419 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
83261a2f 7420 "\\|")
f83d2997
KH
7421 "Finds places such that insertion of a whitespace may help a lot.")
7422
5c8b7eaf 7423(defvar cperl-not-bad-style-regexp
15ca5699 7424 (mapconcat
83261a2f 7425 'identity
f83d2997
KH
7426 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7427 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7428 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
4ab89e7b 7429 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
5bd52f0e 7430 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
f83d2997
KH
7431 "-[0-9]" ; -5
7432 "\\+\\+" ; ++var
7433 "--" ; --var
7434 ".->" ; a->b
7435 "->" ; a SPACE ->b
7436 "\\[-" ; a[-1]
5bd52f0e 7437 "\\\\[&$@*\\\\]" ; \&func
f83d2997 7438 "^=" ; =head
5bd52f0e
RS
7439 "\\$." ; $|
7440 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
f83d2997
KH
7441 "||"
7442 "&&"
7443 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
83261a2f 7444 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
f83d2997
KH
7445 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7446 ;;"[*/+-|&<.]+="
7447 )
7448 "\\|")
7449 "If matches at the start of match found by `my-bad-c-style-regexp',
7450insertion of a whitespace will not help.")
7451
7452(defvar found-bad)
7453
7454(defun cperl-find-bad-style ()
7455 "Find places in the buffer where insertion of a whitespace may help.
7456Prompts user for insertion of spaces.
7457Currently it is tuned to C and Perl syntax."
7458 (interactive)
7459 (let (found-bad (p (point)))
7460 (setq last-nonmenu-event 13) ; To disable popup
4ab89e7b 7461 (goto-char (point-min))
f83d2997 7462 (map-y-or-n-p "Insert space here? "
83261a2f 7463 (lambda (arg) (insert " "))
f83d2997 7464 'cperl-next-bad-style
5c8b7eaf 7465 '("location" "locations" "insert a space into")
f83d2997
KH
7466 '((?\C-r (lambda (arg)
7467 (let ((buffer-quit-function
7468 'exit-recursive-edit))
7469 (message "Exit with Esc Esc")
7470 (recursive-edit)
7471 t)) ; Consider acted upon
5c8b7eaf 7472 "edit, exit with Esc Esc")
f83d2997
KH
7473 (?e (lambda (arg)
7474 (let ((buffer-quit-function
7475 'exit-recursive-edit))
7476 (message "Exit with Esc Esc")
7477 (recursive-edit)
7478 t)) ; Consider acted upon
7479 "edit, exit with Esc Esc"))
7480 t)
7481 (if found-bad (goto-char found-bad)
7482 (goto-char p)
7483 (message "No appropriate place found"))))
7484
7485(defun cperl-next-bad-style ()
7486 (let (p (not-found t) (point (point)) found)
7487 (while (and not-found
7488 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7489 (setq p (point))
7490 (goto-char (match-beginning 0))
7491 (if (or
7492 (looking-at cperl-not-bad-style-regexp)
7493 ;; Check for a < -b and friends
7494 (and (eq (following-char) ?\-)
7495 (save-excursion
7496 (skip-chars-backward " \t\n")
07cb2aa3 7497 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
f83d2997
KH
7498 ;; Now check for syntax type
7499 (save-match-data
7500 (setq found (point))
7501 (beginning-of-defun)
7502 (let ((pps (parse-partial-sexp (point) found)))
7503 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7504 (goto-char (match-end 0))
7505 (goto-char (1- p))
7506 (setq not-found nil
7507 found-bad found)))
7508 (not not-found)))
7509
f1d851ae 7510\f
f83d2997 7511;;; Getting help
5c8b7eaf 7512(defvar cperl-have-help-regexp
f83d2997
KH
7513 ;;(concat "\\("
7514 (mapconcat
7515 'identity
83261a2f 7516 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
f83d2997
KH
7517 "[$@]\\^[a-zA-Z]" ; Special variable
7518 "[$@][^ \n\t]" ; Special variable
7519 "-[a-zA-Z]" ; File test
7520 "\\\\[a-zA-Z0]" ; Special chars
83261a2f 7521 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
f83d2997
KH
7522 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7523 "[a-zA-Z_0-9:]+" ; symbol or number
7524 "x="
83261a2f 7525 "#!")
f83d2997 7526 ;;"\\)\\|\\("
83261a2f
SM
7527 "\\|")
7528 ;;"\\)"
7529 ;;)
f83d2997
KH
7530 "Matches places in the buffer we can find help for.")
7531
7532(defvar cperl-message-on-help-error t)
7533(defvar cperl-help-from-timer nil)
7534
7535(defun cperl-word-at-point-hard ()
7536 ;; Does not save-excursion
7537 ;; Get to the something meaningful
7538 (or (eobp) (eolp) (forward-char 1))
5c8b7eaf 7539 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
f83d2997
KH
7540 (save-excursion (beginning-of-line) (point))
7541 'to-beg)
7542 ;; (cond
7543 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7544 ;; (skip-chars-backward " \n\t\r({[]});,")
7545 ;; (or (bobp) (backward-char 1))))
7546 ;; Try to backtrace
7547 (cond
7548 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7549 (skip-chars-backward "a-zA-Z0-9_:")
5c8b7eaf 7550 (cond
f83d2997
KH
7551 ((and (eq (preceding-char) ?^) ; $^I
7552 (eq (char-after (- (point) 2)) ?\$))
7553 (forward-char -2))
7554 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7555 (forward-char -1))
7556 ((and (eq (preceding-char) ?\=)
7557 (eq (current-column) 1))
7558 (forward-char -1))) ; =head1
7559 (if (and (eq (preceding-char) ?\<)
7560 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7561 (forward-char -1)))
7562 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7563 (forward-char -1))
7564 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7565 (forward-char -1))
7566 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7567 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7568 (cond
7569 ((and (eq (preceding-char) ?\$)
7570 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7571 (forward-char -1))
7572 ((and (eq (following-char) ?\>)
7573 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7574 (save-excursion
7575 (forward-sexp -1)
7576 (and (eq (preceding-char) ?\<)
7577 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7578 (search-backward "<"))))
7579 ((and (eq (following-char) ?\$)
7580 (eq (preceding-char) ?\<)
7581 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7582 (forward-char -1)))
7583 (if (looking-at cperl-have-help-regexp)
7584 (buffer-substring (match-beginning 0) (match-end 0))))
7585
7586(defun cperl-get-help ()
7587 "Get one-line docs on the symbol at the point.
7588The data for these docs is a little bit obsolete and may be in fact longer
7589than a line. Your contribution to update/shorten it is appreciated."
7590 (interactive)
7591 (save-match-data ; May be called "inside" query-replace
7592 (save-excursion
7593 (let ((word (cperl-word-at-point-hard)))
7594 (if word
7595 (if (and cperl-help-from-timer ; Bail out if not in mainland
7596 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7597 (or (memq (get-text-property (point) 'face)
7598 '(font-lock-comment-face font-lock-string-face))
7599 (memq (get-text-property (point) 'syntax-type)
7600 '(pod here-doc format))))
7601 nil
7602 (cperl-describe-perl-symbol word))
7603 (if cperl-message-on-help-error
5c8b7eaf 7604 (message "Nothing found for %s..."
f83d2997
KH
7605 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7606
7607;;; Stolen from perl-descr.el by Johan Vromans:
7608
7609(defvar cperl-doc-buffer " *perl-doc*"
7610 "Where the documentation can be found.")
7611
7612(defun cperl-describe-perl-symbol (val)
7613 "Display the documentation of symbol at point, a Perl operator."
7614 (let ((enable-recursive-minibuffers t)
7615 args-file regexp)
7616 (cond
83261a2f
SM
7617 ((string-match "^[&*][a-zA-Z_]" val)
7618 (setq val (concat (substring val 0 1) "NAME")))
7619 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7620 (setq val (concat "@" (substring val 1 (match-end 1)))))
7621 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7622 (setq val (concat "%" (substring val 1 (match-end 1)))))
7623 ((and (string= val "x") (string-match "^x=" val))
7624 (setq val "x="))
7625 ((string-match "^\\$[\C-a-\C-z]" val)
7626 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7627 ((string-match "^CORE::" val)
7628 (setq val "CORE::"))
7629 ((string-match "^SUPER::" val)
7630 (setq val "SUPER::"))
7631 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7632 (setq val "<NAME>")))
5c8b7eaf 7633 (setq regexp (concat "^"
f83d2997 7634 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
5c8b7eaf 7635 (regexp-quote val)
f83d2997
KH
7636 "\\([ \t([/]\\|$\\)"))
7637
7638 ;; get the buffer with the documentation text
7639 (cperl-switch-to-doc-buffer)
7640
7641 ;; lookup in the doc
7642 (goto-char (point-min))
7643 (let ((case-fold-search nil))
5c8b7eaf 7644 (list
f83d2997
KH
7645 (if (re-search-forward regexp (point-max) t)
7646 (save-excursion
7647 (beginning-of-line 1)
7648 (let ((lnstart (point)))
7649 (end-of-line)
7650 (message "%s" (buffer-substring lnstart (point)))))
7651 (if cperl-message-on-help-error
7652 (message "No definition for %s" val)))))))
7653
83261a2f 7654(defvar cperl-short-docs 'please-ignore-this-line
f83d2997
KH
7655 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7656 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
f739b53b 7657... Range (list context); flip/flop [no flop when flip] (scalar context).
5c8b7eaf 7658! ... Logical negation.
f83d2997
KH
7659... != ... Numeric inequality.
7660... !~ ... Search pattern, substitution, or translation (negated).
7661$! In numeric context: errno. In a string context: error string.
7662$\" The separator which joins elements of arrays interpolated in strings.
f739b53b 7663$# The output format for printed numbers. Default is %.15g or close.
f83d2997
KH
7664$$ Process number of this script. Changes in the fork()ed child process.
7665$% The current page number of the currently selected output channel.
7666
7667 The following variables are always local to the current block:
7668
7669$1 Match of the 1st set of parentheses in the last match (auto-local).
7670$2 Match of the 2nd set of parentheses in the last match (auto-local).
7671$3 Match of the 3rd set of parentheses in the last match (auto-local).
7672$4 Match of the 4th set of parentheses in the last match (auto-local).
7673$5 Match of the 5th set of parentheses in the last match (auto-local).
7674$6 Match of the 6th set of parentheses in the last match (auto-local).
7675$7 Match of the 7th set of parentheses in the last match (auto-local).
7676$8 Match of the 8th set of parentheses in the last match (auto-local).
7677$9 Match of the 9th set of parentheses in the last match (auto-local).
7678$& The string matched by the last pattern match (auto-local).
7679$' The string after what was matched by the last match (auto-local).
7680$` The string before what was matched by the last match (auto-local).
7681
7682$( The real gid of this process.
7683$) The effective gid of this process.
7684$* Deprecated: Set to 1 to do multiline matching within a string.
7685$+ The last bracket matched by the last search pattern.
7686$, The output field separator for the print operator.
7687$- The number of lines left on the page.
7688$. The current input line number of the last filehandle that was read.
7689$/ The input record separator, newline by default.
f739b53b 7690$0 Name of the file containing the current perl script (read/write).
f83d2997
KH
7691$: String may be broken after these characters to fill ^-lines in a format.
7692$; Subscript separator for multi-dim array emulation. Default \"\\034\".
7693$< The real uid of this process.
7694$= The page length of the current output channel. Default is 60 lines.
7695$> The effective uid of this process.
7696$? The status returned by the last ``, pipe close or `system'.
7697$@ The perl error message from the last eval or do @var{EXPR} command.
7698$ARGV The name of the current file used with <> .
7699$[ Deprecated: The index of the first element/char in an array/string.
7700$\\ The output record separator for the print operator.
7701$] The perl version string as displayed with perl -v.
7702$^ The name of the current top-of-page format.
7703$^A The current value of the write() accumulator for format() lines.
7704$^D The value of the perl debug (-D) flags.
7705$^E Information about the last system error other than that provided by $!.
7706$^F The highest system file descriptor, ordinarily 2.
7707$^H The current set of syntax checks enabled by `use strict'.
7708$^I The value of the in-place edit extension (perl -i option).
d7584f0f 7709$^L What formats output to perform a formfeed. Default is \\f.
5bd52f0e 7710$^M A buffer for emergency memory allocation when running out of memory.
f83d2997
KH
7711$^O The operating system name under which this copy of Perl was built.
7712$^P Internal debugging flag.
7713$^T The time the script was started. Used by -A/-M/-C file tests.
7714$^W True if warnings are requested (perl -w flag).
7715$^X The name under which perl was invoked (argv[0] in C-speech).
7716$_ The default input and pattern-searching space.
5c8b7eaf 7717$| Auto-flush after write/print on current output channel? Default 0.
f83d2997
KH
7718$~ The name of the current report format.
7719... % ... Modulo division.
7720... %= ... Modulo division assignment.
7721%ENV Contains the current environment.
7722%INC List of files that have been require-d or do-ne.
7723%SIG Used to set signal handlers for various signals.
7724... & ... Bitwise and.
7725... && ... Logical and.
7726... &&= ... Logical and assignment.
7727... &= ... Bitwise and assignment.
7728... * ... Multiplication.
7729... ** ... Exponentiation.
7730*NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7731&NAME(arg0, ...) Subroutine call. Arguments go to @_.
7732... + ... Addition. +EXPR Makes EXPR into scalar context.
7733++ Auto-increment (magical on strings). ++EXPR EXPR++
7734... += ... Addition assignment.
7735, Comma operator.
7736... - ... Subtraction.
7737-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7738... -= ... Subtraction assignment.
7739-A Access time in days since script started.
7740-B File is a non-text (binary) file.
7741-C Inode change time in days since script started.
7742-M Age in days since script started.
7743-O File is owned by real uid.
7744-R File is readable by real uid.
7745-S File is a socket .
7746-T File is a text file.
7747-W File is writable by real uid.
7748-X File is executable by real uid.
7749-b File is a block special file.
7750-c File is a character special file.
7751-d File is a directory.
7752-e File exists .
7753-f File is a plain file.
7754-g File has setgid bit set.
7755-k File has sticky bit set.
7756-l File is a symbolic link.
7757-o File is owned by effective uid.
7758-p File is a named pipe (FIFO).
7759-r File is readable by effective uid.
7760-s File has non-zero size.
7761-t Tests if filehandle (STDIN by default) is opened to a tty.
7762-u File has setuid bit set.
7763-w File is writable by effective uid.
7764-x File is executable by effective uid.
7765-z File has zero size.
7766. Concatenate strings.
f739b53b 7767.. Range (list context); flip/flop (scalar context) operator.
f83d2997
KH
7768.= Concatenate assignment strings
7769... / ... Division. /PATTERN/ioxsmg Pattern match
7770... /= ... Division assignment.
7771/PATTERN/ioxsmg Pattern match.
f739b53b 7772... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
f83d2997
KH
7773<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7774<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7775<> Reads line from union of files in @ARGV (= command line) and STDIN.
7776... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7777... <= ... Numeric less than or equal to.
7778... <=> ... Numeric compare.
7779... = ... Assignment.
7780... == ... Numeric equality.
7781... =~ ... Search pattern, substitution, or translation
7782... > ... Numeric greater than.
7783... >= ... Numeric greater than or equal to.
7784... >> ... Bitwise shift right.
7785... >>= ... Bitwise shift right assignment.
7786... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7787?PATTERN? One-time pattern match.
7788@ARGV Command line arguments (not including the command name - see $0).
7789@INC List of places to look for perl scripts during do/include/use.
f739b53b 7790@_ Parameter array for subroutines; result of split() unless in list context.
d7584f0f 7791\\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
f83d2997
KH
7792\\0 Octal char, e.g. \\033.
7793\\E Case modification terminator. See \\Q, \\L, and \\U.
d7584f0f
AS
7794\\L Lowercase until \\E . See also \\l, lc.
7795\\U Upcase until \\E . See also \\u, uc.
f83d2997
KH
7796\\Q Quote metacharacters until \\E . See also quotemeta.
7797\\a Alarm character (octal 007).
7798\\b Backspace character (octal 010).
7799\\c Control character, e.g. \\c[ .
7800\\e Escape character (octal 033).
7801\\f Formfeed character (octal 014).
7802\\l Lowercase the next character. See also \\L and \\u, lcfirst.
7803\\n Newline character (octal 012 on most systems).
7804\\r Return character (octal 015 on most systems).
7805\\t Tab character (octal 011).
7806\\u Upcase the next character. See also \\U and \\l, ucfirst.
7807\\x Hex character, e.g. \\x1b.
7808... ^ ... Bitwise exclusive or.
7809__END__ Ends program source.
7810__DATA__ Ends program source.
7811__FILE__ Current (source) filename.
7812__LINE__ Current line in current source.
7813__PACKAGE__ Current package.
7814ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7815ARGVOUT Output filehandle with -i flag.
7816BEGIN { ... } Immediately executed (during compilation) piece of code.
7817END { ... } Pseudo-subroutine executed after the script finishes.
6c389151
SM
7818CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7819INIT { ... } Pseudo-subroutine executed before the script starts running.
f83d2997
KH
7820DATA Input filehandle for what follows after __END__ or __DATA__.
7821accept(NEWSOCKET,GENERICSOCKET)
7822alarm(SECONDS)
7823atan2(X,Y)
7824bind(SOCKET,NAME)
7825binmode(FILEHANDLE)
7826caller[(LEVEL)]
7827chdir(EXPR)
7828chmod(LIST)
7829chop[(LIST|VAR)]
7830chown(LIST)
7831chroot(FILENAME)
7832close(FILEHANDLE)
7833closedir(DIRHANDLE)
7834... cmp ... String compare.
7835connect(SOCKET,NAME)
7836continue of { block } continue { block }. Is executed after `next' or at end.
7837cos(EXPR)
7838crypt(PLAINTEXT,SALT)
7839dbmclose(%HASH)
7840dbmopen(%HASH,DBNAME,MODE)
7841defined(EXPR)
7842delete($HASH{KEY})
7843die(LIST)
7844do { ... }|SUBR while|until EXPR executes at least once
7845do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7846dump LABEL
7847each(%HASH)
7848endgrent
7849endhostent
7850endnetent
7851endprotoent
7852endpwent
7853endservent
7854eof[([FILEHANDLE])]
7855... eq ... String equality.
7856eval(EXPR) or eval { BLOCK }
4ab89e7b 7857exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
f83d2997
KH
7858exit(EXPR)
7859exp(EXPR)
7860fcntl(FILEHANDLE,FUNCTION,SCALAR)
7861fileno(FILEHANDLE)
7862flock(FILEHANDLE,OPERATION)
7863for (EXPR;EXPR;EXPR) { ... }
7864foreach [VAR] (@ARRAY) { ... }
7865fork
7866... ge ... String greater than or equal.
7867getc[(FILEHANDLE)]
7868getgrent
7869getgrgid(GID)
7870getgrnam(NAME)
7871gethostbyaddr(ADDR,ADDRTYPE)
7872gethostbyname(NAME)
7873gethostent
7874getlogin
7875getnetbyaddr(ADDR,ADDRTYPE)
7876getnetbyname(NAME)
7877getnetent
7878getpeername(SOCKET)
7879getpgrp(PID)
7880getppid
7881getpriority(WHICH,WHO)
7882getprotobyname(NAME)
7883getprotobynumber(NUMBER)
7884getprotoent
7885getpwent
7886getpwnam(NAME)
7887getpwuid(UID)
7888getservbyname(NAME,PROTO)
7889getservbyport(PORT,PROTO)
7890getservent
7891getsockname(SOCKET)
7892getsockopt(SOCKET,LEVEL,OPTNAME)
7893gmtime(EXPR)
7894goto LABEL
f83d2997
KH
7895... gt ... String greater than.
7896hex(EXPR)
7897if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7898index(STR,SUBSTR[,OFFSET])
7899int(EXPR)
7900ioctl(FILEHANDLE,FUNCTION,SCALAR)
7901join(EXPR,LIST)
7902keys(%HASH)
7903kill(LIST)
7904last [LABEL]
7905... le ... String less than or equal.
7906length(EXPR)
7907link(OLDFILE,NEWFILE)
7908listen(SOCKET,QUEUESIZE)
7909local(LIST)
7910localtime(EXPR)
7911log(EXPR)
7912lstat(EXPR|FILEHANDLE|VAR)
7913... lt ... String less than.
7914m/PATTERN/iogsmx
7915mkdir(FILENAME,MODE)
7916msgctl(ID,CMD,ARG)
7917msgget(KEY,FLAGS)
7918msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7919msgsnd(ID,MSG,FLAGS)
7920my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6c389151 7921our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
f83d2997
KH
7922... ne ... String inequality.
7923next [LABEL]
7924oct(EXPR)
7925open(FILEHANDLE[,EXPR])
7926opendir(DIRHANDLE,EXPR)
7927ord(EXPR) ASCII value of the first char of the string.
7928pack(TEMPLATE,LIST)
7929package NAME Introduces package context.
7930pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7931pop(ARRAY)
7932print [FILEHANDLE] [(LIST)]
7933printf [FILEHANDLE] (FORMAT,LIST)
7934push(ARRAY,LIST)
7935q/STRING/ Synonym for 'STRING'
7936qq/STRING/ Synonym for \"STRING\"
7937qx/STRING/ Synonym for `STRING`
7938rand[(EXPR)]
7939read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7940readdir(DIRHANDLE)
7941readlink(EXPR)
7942recv(SOCKET,SCALAR,LEN,FLAGS)
7943redo [LABEL]
7944rename(OLDNAME,NEWNAME)
7945require [FILENAME | PERL_VERSION]
7946reset[(EXPR)]
7947return(LIST)
7948reverse(LIST)
7949rewinddir(DIRHANDLE)
7950rindex(STR,SUBSTR[,OFFSET])
7951rmdir(FILENAME)
7952s/PATTERN/REPLACEMENT/gieoxsm
7953scalar(EXPR)
7954seek(FILEHANDLE,POSITION,WHENCE)
7955seekdir(DIRHANDLE,POS)
7956select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7957semctl(ID,SEMNUM,CMD,ARG)
7958semget(KEY,NSEMS,SIZE,FLAGS)
7959semop(KEY,...)
7960send(SOCKET,MSG,FLAGS[,TO])
7961setgrent
7962sethostent(STAYOPEN)
7963setnetent(STAYOPEN)
7964setpgrp(PID,PGRP)
7965setpriority(WHICH,WHO,PRIORITY)
7966setprotoent(STAYOPEN)
7967setpwent
7968setservent(STAYOPEN)
7969setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7970shift[(ARRAY)]
7971shmctl(ID,CMD,ARG)
7972shmget(KEY,SIZE,FLAGS)
7973shmread(ID,VAR,POS,SIZE)
7974shmwrite(ID,STRING,POS,SIZE)
7975shutdown(SOCKET,HOW)
7976sin(EXPR)
7977sleep[(EXPR)]
7978socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7979socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7980sort [SUBROUTINE] (LIST)
7981splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7982split[(/PATTERN/[,EXPR[,LIMIT]])]
7983sprintf(FORMAT,LIST)
7984sqrt(EXPR)
7985srand(EXPR)
7986stat(EXPR|FILEHANDLE|VAR)
7987study[(SCALAR)]
7988sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7989substr(EXPR,OFFSET[,LEN])
7990symlink(OLDFILE,NEWFILE)
7991syscall(LIST)
7992sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
4ab89e7b 7993system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
f83d2997
KH
7994syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7995tell[(FILEHANDLE)]
7996telldir(DIRHANDLE)
7997time
7998times
7999tr/SEARCHLIST/REPLACEMENTLIST/cds
8000truncate(FILE|EXPR,LENGTH)
8001umask[(EXPR)]
8002undef[(EXPR)]
8003unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
8004unlink(LIST)
8005unpack(TEMPLATE,EXPR)
8006unshift(ARRAY,LIST)
8007until (EXPR) { ... } EXPR until EXPR
8008utime(LIST)
8009values(%HASH)
8010vec(EXPR,OFFSET,BITS)
8011wait
8012waitpid(PID,FLAGS)
8013wantarray Returns true if the sub/eval is called in list context.
8014warn(LIST)
8015while (EXPR) { ... } EXPR while EXPR
8016write[(EXPR|FILEHANDLE)]
8017... x ... Repeat string or array.
8018x= ... Repetition assignment.
8019y/SEARCHLIST/REPLACEMENTLIST/
8020... | ... Bitwise or.
8021... || ... Logical or.
8022~ ... Unary bitwise complement.
db133cb6 8023#! OS interpreter indicator. If contains `perl', used for options, and -x.
f83d2997
KH
8024AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
8025CORE:: Prefix to access builtin function if imported sub obscures it.
8026SUPER:: Prefix to lookup for a method in @ISA classes.
8027DESTROY Shorthand for `sub DESTROY {...}'.
8028... EQ ... Obsolete synonym of `eq'.
8029... GE ... Obsolete synonym of `ge'.
8030... GT ... Obsolete synonym of `gt'.
8031... LE ... Obsolete synonym of `le'.
8032... LT ... Obsolete synonym of `lt'.
8033... NE ... Obsolete synonym of `ne'.
8034abs [ EXPR ] absolute value
8035... and ... Low-precedence synonym for &&.
8036bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
8037chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
8038chr Converts a number to char with the same ordinal.
8039else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
8040elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
83261a2f 8041exists $HASH{KEY} True if the key exists.
f83d2997
KH
8042format [NAME] = Start of output format. Ended by a single dot (.) on a line.
8043formline PICTURE, LIST Backdoor into \"format\" processing.
8044glob EXPR Synonym of <EXPR>.
8045lc [ EXPR ] Returns lowercased EXPR.
8046lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
db133cb6 8047grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
f83d2997
KH
8048map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
8049no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
8050not ... Low-precedence synonym for ! - negation.
8051... or ... Low-precedence synonym for ||.
8052pos STRING Set/Get end-position of the last match over this string, see \\G.
8053quotemeta [ EXPR ] Quote regexp metacharacters.
8054qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
8055readline FH Synonym of <FH>.
8056readpipe CMD Synonym of `CMD`.
8057ref [ EXPR ] Type of EXPR when dereferenced.
8058sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
8059tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
8060tied Returns internal object for a tied data.
8061uc [ EXPR ] Returns upcased EXPR.
8062ucfirst [ EXPR ] Returns EXPR with upcased first letter.
8063untie VAR Unlink an object from a simple Perl variable.
8064use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
8065... xor ... Low-precedence synonym for exclusive or.
d7584f0f 8066prototype \\&SUB Returns prototype of the function given a reference.
f83d2997
KH
8067=head1 Top-level heading.
8068=head2 Second-level heading.
8069=head3 Third-level heading (is there such?).
8070=over [ NUMBER ] Start list.
8071=item [ TITLE ] Start new item in the list.
8072=back End list.
8073=cut Switch from POD to Perl.
8074=pod Switch from Perl to POD.
8075")
8076
21df56d5 8077(defun cperl-switch-to-doc-buffer (&optional interactive)
f83d2997 8078 "Go to the perl documentation buffer and insert the documentation."
21df56d5 8079 (interactive "p")
f83d2997 8080 (let ((buf (get-buffer-create cperl-doc-buffer)))
21df56d5 8081 (if interactive
f83d2997
KH
8082 (switch-to-buffer-other-window buf)
8083 (set-buffer buf))
8084 (if (= (buffer-size) 0)
8085 (progn
8086 (insert (documentation-property 'cperl-short-docs
8087 'variable-documentation))
8088 (setq buffer-read-only t)))))
8089
6c389151 8090(defun cperl-beautify-regexp-piece (b e embed level)
f83d2997
KH
8091 ;; b is before the starting delimiter, e before the ending
8092 ;; e should be a marker, may be changed, but remains "correct".
e7f767c2 8093 ;; EMBED is nil if we process the whole REx.
4ab89e7b 8094 ;; The REx is guaranteed to have //x
6c389151
SM
8095 ;; LEVEL shows how many levels deep to go
8096 ;; position at enter and at leave is not defined
8097 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
f83d2997
KH
8098 (if (not embed)
8099 (goto-char (1+ b))
8100 (goto-char b)
6c389151 8101 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
f83d2997
KH
8102 (forward-char 2)
8103 (delete-char 1)
8104 (forward-char 1))
8105 ((looking-at "(\\?[^a-zA-Z]")
8106 (forward-char 3))
8107 ((looking-at "(\\?") ; (?i)
8108 (forward-char 2))
8109 (t
8110 (forward-char 1))))
8111 (setq c (if embed (current-indentation) (1- (current-column)))
8112 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
8113 (or (looking-at "[ \t]*[\n#]")
8114 (progn
8115 (insert "\n")))
8116 (goto-char e)
8117 (beginning-of-line)
8118 (if (re-search-forward "[^ \t]" e t)
83261a2f 8119 (progn ; Something before the ending delimiter
f83d2997 8120 (goto-char e)
6c389151 8121 (delete-horizontal-space)
f83d2997 8122 (insert "\n")
4ab89e7b 8123 (cperl-make-indent c)
f83d2997
KH
8124 (set-marker e (point))))
8125 (goto-char b)
8126 (end-of-line 2)
8127 (while (< (point) (marker-position e))
8128 (beginning-of-line)
8129 (setq s (point)
8130 inline t)
8131 (skip-chars-forward " \t")
8132 (delete-region s (point))
4ab89e7b 8133 (cperl-make-indent c1)
f83d2997
KH
8134 (while (and
8135 inline
5c8b7eaf 8136 (looking-at
f83d2997
KH
8137 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8138 "\\|" ; Embedded variable
8139 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8140 "\\|" ; $ ^
8141 "[$^]"
8142 "\\|" ; simple-code simple-code*?
8143 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8144 "\\|" ; Class
8145 "\\(\\[\\)" ; 6
8146 "\\|" ; Grouping
8147 "\\((\\(\\?\\)?\\)" ; 7 8
8148 "\\|" ; |
83261a2f 8149 "\\(|\\)"))) ; 9
f83d2997
KH
8150 (goto-char (match-end 0))
8151 (setq spaces t)
8152 (cond ((match-beginning 1) ; Alphanum word + junk
8153 (forward-char -1))
8154 ((or (match-beginning 3) ; $ab[12]
8155 (and (match-beginning 5) ; X* X+ X{2,3}
8156 (eq (preceding-char) ?\{)))
8157 (forward-char -1)
8158 (forward-sexp 1))
4ab89e7b
SM
8159 ((and ; [], already syntaxified
8160 (match-beginning 6)
8161 cperl-regexp-scan
8162 cperl-use-syntax-table-text-property)
8163 (forward-char -1)
8164 (forward-sexp 1)
8165 (or (eq (preceding-char) ?\])
8166 (error "[]-group not terminated"))
8167 (re-search-forward
8168 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8169 ((match-beginning 6) ; []
8170 (setq tmp (point))
8171 (if (looking-at "\\^?\\]")
8172 (goto-char (match-end 0)))
6c389151
SM
8173 ;; XXXX POSIX classes?!
8174 (while (and (not pos)
8175 (re-search-forward "\\[:\\|\\]" e t))
8176 (if (eq (preceding-char) ?:)
8177 (or (re-search-forward ":\\]" e t)
8178 (error "[:POSIX:]-group in []-group not terminated"))
8179 (setq pos t)))
8180 (or (eq (preceding-char) ?\])
8181 (error "[]-group not terminated"))
4ab89e7b
SM
8182 (re-search-forward
8183 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
f83d2997
KH
8184 ((match-beginning 7) ; ()
8185 (goto-char (match-beginning 0))
6c389151
SM
8186 (setq pos (current-column))
8187 (or (eq pos c1)
f83d2997 8188 (progn
6c389151 8189 (delete-horizontal-space)
f83d2997 8190 (insert "\n")
4ab89e7b 8191 (cperl-make-indent c1)))
f83d2997
KH
8192 (setq tmp (point))
8193 (forward-sexp 1)
8194 ;; (or (forward-sexp 1)
8195 ;; (progn
8196 ;; (goto-char tmp)
8197 ;; (error "()-group not terminated")))
8198 (set-marker m (1- (point)))
8199 (set-marker m1 (point))
6c389151
SM
8200 (if (= level 1)
8201 (if (progn ; indent rigidly if multiline
a1506d29 8202 ;; In fact does not make a lot of sense, since
6c389151
SM
8203 ;; the starting position can be already lost due
8204 ;; to insertion of "\n" and " "
8205 (goto-char tmp)
8206 (search-forward "\n" m1 t))
8207 (indent-rigidly (point) m1 (- c1 pos)))
8208 (setq level (1- level))
8209 (cond
8210 ((not (match-beginning 8))
8211 (cperl-beautify-regexp-piece tmp m t level))
8212 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8213 t)
8214 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8215 (goto-char (+ 2 tmp))
8216 (forward-sexp 1)
8217 (cperl-beautify-regexp-piece (point) m t level))
8218 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8219 (goto-char (+ 3 tmp))
8220 (cperl-beautify-regexp-piece (point) m t level))
8221 (t
8222 (cperl-beautify-regexp-piece tmp m t level))))
f83d2997
KH
8223 (goto-char m1)
8224 (cond ((looking-at "[*+?]\\??")
8225 (goto-char (match-end 0)))
8226 ((eq (following-char) ?\{)
8227 (forward-sexp 1)
8228 (if (eq (following-char) ?\?)
8229 (forward-char))))
8230 (skip-chars-forward " \t")
8231 (setq spaces nil)
8232 (if (looking-at "[#\n]")
8233 (progn
8234 (or (eolp) (indent-for-comment))
8235 (beginning-of-line 2))
6c389151 8236 (delete-horizontal-space)
f83d2997
KH
8237 (insert "\n"))
8238 (end-of-line)
8239 (setq inline nil))
8240 ((match-beginning 9) ; |
8241 (forward-char -1)
8242 (setq tmp (point))
8243 (beginning-of-line)
8244 (if (re-search-forward "[^ \t]" tmp t)
8245 (progn
8246 (goto-char tmp)
6c389151 8247 (delete-horizontal-space)
f83d2997
KH
8248 (insert "\n"))
8249 ;; first at line
8250 (delete-region (point) tmp))
4ab89e7b 8251 (cperl-make-indent c)
f83d2997
KH
8252 (forward-char 1)
8253 (skip-chars-forward " \t")
8254 (setq spaces nil)
8255 (if (looking-at "[#\n]")
8256 (beginning-of-line 2)
6c389151 8257 (delete-horizontal-space)
f83d2997
KH
8258 (insert "\n"))
8259 (end-of-line)
8260 (setq inline nil)))
8261 (or (looking-at "[ \t\n]")
8262 (not spaces)
8263 (insert " "))
8264 (skip-chars-forward " \t"))
83261a2f
SM
8265 (or (looking-at "[#\n]")
8266 (error "Unknown code `%s' in a regexp"
8267 (buffer-substring (point) (1+ (point)))))
8268 (and inline (end-of-line 2)))
f83d2997
KH
8269 ;; Special-case the last line of group
8270 (if (and (>= (point) (marker-position e))
8271 (/= (current-indentation) c))
8272 (progn
83261a2f 8273 (beginning-of-line)
4ab89e7b 8274 (cperl-make-indent c)))))
f83d2997
KH
8275
8276(defun cperl-make-regexp-x ()
db133cb6 8277 ;; Returns position of the start
6c389151 8278 ;; XXX this is called too often! Need to cache the result!
f83d2997
KH
8279 (save-excursion
8280 (or cperl-use-syntax-table-text-property
5bd52f0e 8281 (error "I need to have a regexp marked!"))
f83d2997 8282 ;; Find the start
db133cb6
RS
8283 (if (looking-at "\\s|")
8284 nil ; good already
5bd52f0e 8285 (if (looking-at "\\([smy]\\|qr\\)\\s|")
db133cb6 8286 (forward-char 1)
83261a2f 8287 (re-search-backward "\\s|"))) ; Assume it is scanned already.
f83d2997
KH
8288 ;;(forward-char 1)
8289 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8290 (sub-p (eq (preceding-char) ?s)) s)
8291 (forward-sexp 1)
8292 (set-marker e (1- (point)))
8293 (setq delim (preceding-char))
8294 (if (and sub-p (eq delim (char-after (- (point) 2))))
8295 (error "Possible s/blah// - do not know how to deal with"))
8296 (if sub-p (forward-sexp 1))
5c8b7eaf 8297 (if (looking-at "\\sw*x")
f83d2997
KH
8298 (setq have-x t)
8299 (insert "x"))
8300 ;; Protect fragile " ", "#"
8301 (if have-x nil
8302 (goto-char (1+ b))
8303 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8304 (forward-char -1)
8305 (insert "\\")
8306 (forward-char 1)))
8307 b)))
8308
6c389151 8309(defun cperl-beautify-regexp (&optional deep)
f94a632a 8310 "Do it. (Experimental, may change semantics, recheck the result.)
f83d2997 8311We suppose that the regexp is scanned already."
6c389151 8312 (interactive "P")
0c602a0f 8313 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8314 (save-excursion
8315 (goto-char (cperl-make-regexp-x))
8316 (let ((b (point)) (e (make-marker)))
8317 (forward-sexp 1)
8318 (set-marker e (1- (point)))
8319 (cperl-beautify-regexp-piece b e nil deep))))
f83d2997 8320
db133cb6
RS
8321(defun cperl-regext-to-level-start ()
8322 "Goto start of an enclosing group in regexp.
f83d2997
KH
8323We suppose that the regexp is scanned already."
8324 (interactive)
db133cb6 8325 (let ((limit (cperl-make-regexp-x)) done)
f83d2997
KH
8326 (while (not done)
8327 (or (eq (following-char) ?\()
db133cb6 8328 (search-backward "(" (1+ limit) t)
f83d2997
KH
8329 (error "Cannot find `(' which starts a group"))
8330 (setq done
8331 (save-excursion
8332 (skip-chars-backward "\\")
8333 (looking-at "\\(\\\\\\\\\\)*(")))
db133cb6
RS
8334 (or done (forward-char -1)))))
8335
8336(defun cperl-contract-level ()
5bd52f0e 8337 "Find an enclosing group in regexp and contract it.
db133cb6
RS
8338\(Experimental, may change semantics, recheck the result.)
8339We suppose that the regexp is scanned already."
8340 (interactive)
6c389151 8341 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
83261a2f 8342 (cperl-regext-to-level-start)
4ab89e7b 8343 (let ((b (point)) (e (make-marker)) c)
83261a2f
SM
8344 (forward-sexp 1)
8345 (set-marker e (1- (point)))
8346 (goto-char b)
8347 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8348 (cond
8349 ((match-beginning 1) ; #-comment
8350 (or c (setq c (current-indentation)))
8351 (beginning-of-line 2) ; Skip
4ab89e7b 8352 (cperl-make-indent c))
83261a2f
SM
8353 (t
8354 (delete-char -1)
8355 (just-one-space))))))
db133cb6
RS
8356
8357(defun cperl-contract-levels ()
5bd52f0e 8358 "Find an enclosing group in regexp and contract all the kids.
db133cb6
RS
8359\(Experimental, may change semantics, recheck the result.)
8360We suppose that the regexp is scanned already."
8361 (interactive)
6c389151
SM
8362 (save-excursion
8363 (condition-case nil
8364 (cperl-regext-to-level-start)
8365 (error ; We are outside outermost group
5efe6a56
SM
8366 (goto-char (cperl-make-regexp-x))))
8367 (let ((b (point)) (e (make-marker)) s c)
8368 (forward-sexp 1)
8369 (set-marker e (1- (point)))
8370 (goto-char (1+ b))
8371 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
a1506d29 8372 (cond
6c389151
SM
8373 ((match-beginning 1) ; Skip
8374 nil)
8375 (t ; Group
8376 (cperl-contract-level)))))))
f83d2997 8377
6c389151 8378(defun cperl-beautify-level (&optional deep)
f83d2997
KH
8379 "Find an enclosing group in regexp and beautify it.
8380\(Experimental, may change semantics, recheck the result.)
8381We suppose that the regexp is scanned already."
6c389151 8382 (interactive "P")
0c602a0f 8383 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
8384 (save-excursion
8385 (cperl-regext-to-level-start)
8386 (let ((b (point)) (e (make-marker)))
8387 (forward-sexp 1)
8388 (set-marker e (1- (point)))
8389 (cperl-beautify-regexp-piece b e nil deep))))
db133cb6 8390
4ab89e7b
SM
8391(defun cperl-invert-if-unless-modifiers ()
8392 "Change `B if A;' into `if (A) {B}' etc if possible.
8393\(Unfinished.)"
8394 (interactive) ;
8395 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8396 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8397 (and (= (char-syntax (preceding-char)) ?w)
8398 (forward-sexp -1))
8399 (setq pre-if (point))
8400 (cperl-backward-to-start-of-expr)
8401 (setq pre-B (point))
8402 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8403 (cperl-forward-to-end-of-expr)
8404 (setq post-A (point))
8405 (goto-char pre-if)
8406 (or (looking-at w-rex)
8407 ;; Find the position
8408 (progn (goto-char post-A)
8409 (while (and
8410 (not (looking-at w-rex))
8411 (> (point) pre-B))
8412 (forward-sexp -1))
8413 (setq pre-if (point))))
8414 (or (looking-at w-rex)
8415 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8416 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8417 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8418 ;; First, simple part: find code boundaries
8419 (forward-sexp 1)
8420 (setq post-if (point))
8421 (forward-sexp -2)
8422 (forward-sexp 1)
8423 (setq post-B (point))
8424 (cperl-backward-to-start-of-expr)
8425 (setq pre-B (point))
8426 (setq B (buffer-substring pre-B post-B))
8427 (goto-char pre-if)
8428 (forward-sexp 2)
8429 (forward-sexp -1)
8430 ;; May be after $, @, $# etc of a variable
8431 (skip-chars-backward "$@%#")
8432 (setq pre-A (point))
8433 (cperl-forward-to-end-of-expr)
8434 (setq post-A (point))
8435 (setq A (buffer-substring pre-A post-A))
8436 ;; Now modify (from end, to not break the stuff)
8437 (skip-chars-forward " \t;")
8438 (delete-region pre-A (point)) ; we move to pre-A
8439 (insert "\n" B ";\n}")
8440 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8441 (delete-region pre-if post-if)
8442 (delete-region pre-B post-B)
8443 (goto-char pre-B)
8444 (insert if-string " (" A ") {")
8445 (setq post-B (point))
8446 (if (looking-at "[ \t]+$")
8447 (delete-horizontal-space)
8448 (if (looking-at "[ \t]*#")
8449 (cperl-indent-for-comment)
8450 (just-one-space)))
8451 (forward-line 1)
8452 (if (looking-at "[ \t]*$")
8453 (progn ; delete line
8454 (delete-horizontal-space)
8455 (delete-region (point) (1+ (point)))))
8456 (cperl-indent-line)
8457 (goto-char (1- post-B))
8458 (forward-sexp 1)
8459 (cperl-indent-line)
8460 (goto-char pre-B)))
8461
db133cb6 8462(defun cperl-invert-if-unless ()
4ab89e7b
SM
8463 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8464If the cursor is not on the leading keyword of the BLOCK flavor of
8465construct, will assume it is the STATEMENT flavor, so will try to find
8466the appropriate statement modifier."
db133cb6 8467 (interactive)
4ab89e7b
SM
8468 (and (= (char-syntax (preceding-char)) ?w)
8469 (forward-sexp -1))
6c389151 8470 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
4ab89e7b
SM
8471 (let ((pre-if (point))
8472 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8473 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
db133cb6 8474 (forward-sexp 2)
4ab89e7b 8475 (setq post-A (point))
db133cb6 8476 (forward-sexp -1)
4ab89e7b
SM
8477 (setq pre-A (point))
8478 (setq is-block (and (eq (following-char) ?\( )
8479 (save-excursion
8480 (condition-case nil
8481 (progn
8482 (forward-sexp 2)
8483 (forward-sexp -1)
8484 (eq (following-char) ?\{ ))
8485 (error nil)))))
8486 (if is-block
db133cb6 8487 (progn
4ab89e7b 8488 (goto-char post-A)
db133cb6 8489 (forward-sexp 1)
4ab89e7b 8490 (setq post-B (point))
db133cb6 8491 (forward-sexp -1)
4ab89e7b 8492 (setq pre-B (point))
db133cb6
RS
8493 (if (and (eq (following-char) ?\{ )
8494 (progn
4ab89e7b 8495 (cperl-backward-to-noncomment post-A)
db133cb6
RS
8496 (eq (preceding-char) ?\) )))
8497 (if (condition-case nil
8498 (progn
4ab89e7b 8499 (goto-char post-B)
db133cb6
RS
8500 (forward-sexp 1)
8501 (forward-sexp -1)
8502 (looking-at "\\<els\\(e\\|if\\)\\>"))
8503 (error nil))
8504 (error
4ab89e7b
SM
8505 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8506 (goto-char (1- post-B))
8507 (cperl-backward-to-noncomment pre-B)
db133cb6
RS
8508 (if (eq (preceding-char) ?\;)
8509 (forward-char -1))
4ab89e7b
SM
8510 (setq end-B-code (point))
8511 (goto-char pre-B)
8512 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
db133cb6 8513 (setq p (match-beginning 0)
4ab89e7b
SM
8514 A (buffer-substring p (match-end 0))
8515 state (parse-partial-sexp pre-B p))
5c8b7eaf 8516 (or (nth 3 state)
db133cb6
RS
8517 (nth 4 state)
8518 (nth 5 state)
4ab89e7b 8519 (error "`%s' inside `%s' BLOCK" A if-string))
db133cb6
RS
8520 (goto-char (match-end 0)))
8521 ;; Finally got it
4ab89e7b 8522 (goto-char (1+ pre-B))
db133cb6 8523 (skip-chars-forward " \t\n")
4ab89e7b
SM
8524 (setq B (buffer-substring (point) end-B-code))
8525 (goto-char end-B-code)
db133cb6
RS
8526 (or (looking-at ";?[ \t\n]*}")
8527 (progn
8528 (skip-chars-forward "; \t\n")
4ab89e7b
SM
8529 (setq B-comment
8530 (buffer-substring (point) (1- post-B)))))
8531 (and (equal B "")
8532 (setq B "1"))
8533 (goto-char (1- post-A))
8534 (cperl-backward-to-noncomment pre-A)
db133cb6 8535 (or (looking-at "[ \t\n]*)")
4ab89e7b 8536 (goto-char (1- post-A)))
db133cb6 8537 (setq p (point))
4ab89e7b 8538 (goto-char (1+ pre-A))
db133cb6 8539 (skip-chars-forward " \t\n")
4ab89e7b
SM
8540 (setq A (buffer-substring (point) p))
8541 (delete-region pre-B post-B)
8542 (delete-region pre-A post-A)
8543 (goto-char pre-if)
8544 (insert B " ")
8545 (and B-comment (insert B-comment " "))
db133cb6
RS
8546 (just-one-space)
8547 (forward-word 1)
4ab89e7b
SM
8548 (setq pre-A (point))
8549 (insert " " A ";")
6c389151 8550 (delete-horizontal-space)
4ab89e7b
SM
8551 (setq post-B (point))
8552 (if (looking-at "#")
8553 (indent-for-comment))
8554 (goto-char post-B)
db133cb6
RS
8555 (forward-char -1)
8556 (delete-horizontal-space)
4ab89e7b 8557 (goto-char pre-A)
db133cb6 8558 (just-one-space)
4ab89e7b
SM
8559 (goto-char pre-if)
8560 (setq pre-A (set-marker (make-marker) pre-A))
8561 (while (<= (point) (marker-position pre-A))
8562 (cperl-indent-line)
8563 (forward-line 1))
8564 (goto-char (marker-position pre-A))
8565 (if B-comment
8566 (progn
8567 (forward-line -1)
8568 (indent-for-comment)
8569 (goto-char (marker-position pre-A)))))
8570 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8571 ;; (error "`%s' not with an (EXPR)" if-string)
8572 (forward-sexp -1)
8573 (cperl-invert-if-unless-modifiers)))
8574 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8575 (cperl-invert-if-unless-modifiers)))
db133cb6 8576
5bd52f0e 8577;;; By Anthony Foiani <afoiani@uswest.com>
b7ec9e59
RS
8578;;; Getting help on modules in C-h f ?
8579;;; This is a modified version of `man'.
8580;;; Need to teach it how to lookup functions
4ab89e7b 8581;;;###autoload
b7ec9e59
RS
8582(defun cperl-perldoc (word)
8583 "Run `perldoc' on WORD."
8584 (interactive
8585 (list (let* ((default-entry (cperl-word-at-point))
8586 (input (read-string
8587 (format "perldoc entry%s: "
8588 (if (string= default-entry "")
8589 ""
8590 (format " (default %s)" default-entry))))))
8591 (if (string= input "")
8592 (if (string= default-entry "")
8593 (error "No perldoc args given")
8594 default-entry)
8595 input))))
a8e1e57f 8596 (require 'man)
f739b53b
SM
8597 (let* ((case-fold-search nil)
8598 (is-func (and
b7ec9e59
RS
8599 (string-match "^[a-z]+$" word)
8600 (string-match (concat "^" word "\\>")
8601 (documentation-property
8602 'cperl-short-docs
8603 'variable-documentation))))
8604 (manual-program (if is-func "perldoc -f" "perldoc")))
f739b53b
SM
8605 (cond
8606 (cperl-xemacs-p
8607 (let ((Manual-program "perldoc")
8608 (Manual-switches (if is-func (list "-f"))))
8609 (manual-entry word)))
8610 (t
8611 (Man-getpage-in-background word)))))
b7ec9e59 8612
4ab89e7b 8613;;;###autoload
b7ec9e59
RS
8614(defun cperl-perldoc-at-point ()
8615 "Run a `perldoc' on the word around point."
8616 (interactive)
8617 (cperl-perldoc (cperl-word-at-point)))
8618
8619(defcustom pod2man-program "pod2man"
8620 "*File name for `pod2man'."
8621 :type 'file
8622 :group 'cperl)
8623
5bd52f0e 8624;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
b7ec9e59
RS
8625(defun cperl-pod-to-manpage ()
8626 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8627 (interactive)
8628 (require 'man)
8629 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8630 (bufname (concat "Man " buffer-file-name))
8631 (buffer (generate-new-buffer bufname)))
8632 (save-excursion
8633 (set-buffer buffer)
8634 (let ((process-environment (copy-sequence process-environment)))
8635 ;; Prevent any attempt to use display terminal fanciness.
8636 (setenv "TERM" "dumb")
8637 (set-process-sentinel
8638 (start-process pod2man-program buffer "sh" "-c"
8639 (format (cperl-pod2man-build-command) pod2man-args))
8640 'Man-bgproc-sentinel)))))
8641
f739b53b
SM
8642;;; Updated version by him too
8643(defun cperl-build-manpage ()
8644 "Create a virtual manpage in Emacs from the POD in the file."
8645 (interactive)
8646 (require 'man)
8647 (cond
8648 (cperl-xemacs-p
8649 (let ((Manual-program "perldoc"))
8650 (manual-entry buffer-file-name)))
8651 (t
8652 (let* ((manual-program "perldoc"))
8653 (Man-getpage-in-background buffer-file-name)))))
8654
b7ec9e59
RS
8655(defun cperl-pod2man-build-command ()
8656 "Builds the entire background manpage and cleaning command."
8657 (let ((command (concat pod2man-program " %s 2>/dev/null"))
4ab89e7b 8658 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
b7ec9e59
RS
8659 (while (and flist (car flist))
8660 (let ((pcom (car (car flist)))
8661 (pargs (cdr (car flist))))
8662 (setq command
8663 (concat command " | " pcom " "
8664 (mapconcat '(lambda (phrase)
8665 (if (not (stringp phrase))
8666 (error "Malformed Man-filter-list"))
8667 phrase)
8668 pargs " ")))
8669 (setq flist (cdr flist))))
8670 command))
db133cb6 8671
4ab89e7b
SM
8672
8673(defun cperl-next-interpolated-REx-1 ()
8674 "Move point to next REx which has interpolated parts without //o.
8675Skips RExes consisting of one interpolated variable.
8676
8677Note that skipped RExen are not performance hits."
8678 (interactive "")
8679 (cperl-next-interpolated-REx 1))
8680
8681(defun cperl-next-interpolated-REx-0 ()
8682 "Move point to next REx which has interpolated parts without //o."
8683 (interactive "")
8684 (cperl-next-interpolated-REx 0))
8685
8686(defun cperl-next-interpolated-REx (&optional skip beg limit)
8687 "Move point to next REx which has interpolated parts.
8688SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8689point and the limit of search (default to point and end of buffer).
8690
8691SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8692semantic may be used as a numeric argument.
8693
8694Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8695a result of qr//, this is not a performance hit), t for the rest."
8696 (interactive "P")
8697 (if (numberp skip) (setq skip (list 0 skip)))
8698 (or beg (setq beg (point)))
8699 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8700 (let (pp)
8701 (and (eq (get-text-property beg 'syntax-type) 'string)
8702 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8703 (cperl-map-pods-heres
8704 (function (lambda (s e p)
8705 (if (memq (get-text-property s 'REx-interpolated) skip)
8706 t
8707 (setq pp s)
8708 nil))) ; nil stops
8709 'REx-interpolated beg limit)
8710 (if pp (goto-char pp)
8711 (message "No more interpolated REx"))))
8712
8713;;; Initial version contributed by Trey Belew
8714(defun cperl-here-doc-spell (&optional beg end)
8715 "Spell-check HERE-documents in the Perl buffer.
8716If a region is highlighted, restricts to the region."
8717 (interactive "")
8718 (cperl-pod-spell t beg end))
8719
8720(defun cperl-pod-spell (&optional do-heres beg end)
8721 "Spell-check POD documentation.
8722If invoked with prefix argument, will do HERE-DOCs instead.
8723If a region is highlighted, restricts to the region."
8724 (interactive "P")
8725 (save-excursion
8726 (let (beg end)
8727 (if (cperl-mark-active)
8728 (setq beg (min (mark) (point))
8729 end (max (mark) (point)))
8730 (setq beg (point-min)
8731 end (point-max)))
8732 (cperl-map-pods-heres (function
8733 (lambda (s e p)
8734 (if do-heres
8735 (setq e (save-excursion
8736 (goto-char e)
8737 (forward-line -1)
8738 (point))))
8739 (ispell-region s e)
8740 t))
8741 (if do-heres 'here-doc-group 'in-pod)
8742 beg end))))
8743
8744(defun cperl-map-pods-heres (func &optional prop s end)
8745 "Executes a function over regions of pods or here-documents.
8746PROP is the text-property to search for; default to `in-pod'. Stop when
8747function returns nil."
8748 (let (pos posend has-prop (cont t))
8749 (or prop (setq prop 'in-pod))
8750 (or s (setq s (point-min)))
8751 (or end (setq end (point-max)))
8752 (cperl-update-syntaxification end end)
8753 (save-excursion
8754 (goto-char (setq pos s))
8755 (while (and cont (< pos end))
8756 (setq has-prop (get-text-property pos prop))
8757 (setq posend (next-single-property-change pos prop nil end))
8758 (and has-prop
8759 (setq cont (funcall func pos posend prop)))
8760 (setq pos posend)))))
8761
8762;;; Based on code by Masatake YAMATO:
8763(defun cperl-get-here-doc-region (&optional pos pod)
8764 "Return HERE document region around the point.
8765Return nil if the point is not in a HERE document region. If POD is non-nil,
8766will return a POD section if point is in a POD section."
8767 (or pos (setq pos (point)))
8768 (cperl-update-syntaxification pos pos)
8769 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8770 (and pod
8771 (eq 'pod (get-text-property pos 'syntax-type))))
8772 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8773 (e (next-single-property-change pos 'syntax-type)))
8774 (cons b (or e (point-max))))))
8775
8776(defun cperl-narrow-to-here-doc (&optional pos)
8777 "Narrows editing region to the HERE-DOC at POS.
8778POS defaults to the point."
8779 (interactive "d")
8780 (or pos (setq pos (point)))
8781 (let ((p (cperl-get-here-doc-region pos)))
8782 (or p (error "Not inside a HERE document"))
8783 (narrow-to-region (car p) (cdr p))
8784 (message
8785 "When you are finished with narrow editing, type C-x n w")))
8786
8787(defun cperl-select-this-pod-or-here-doc (&optional pos)
8788 "Select the HERE-DOC (or POD section) at POS.
8789POS defaults to the point."
8790 (interactive "d")
8791 (let ((p (cperl-get-here-doc-region pos t)))
8792 (if p
8793 (progn
8794 (goto-char (car p))
8795 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8796 (message "I do not think POS is in POD or a HERE-doc..."))))
8797
8798(defun cperl-facemenu-add-face-function (face end)
8799 "A callback to process user-initiated font-change requests.
8800Translates `bold', `italic', and `bold-italic' requests to insertion of
8801corresponding POD directives, and `underline' to C<> POD directive.
8802
8803Such requests are usually bound to M-o LETTER."
8804 (or (get-text-property (point) 'in-pod)
8805 (error "Faces can only be set within POD"))
8806 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8807 (cdr (or (assq face '((bold . "B<")
8808 (italic . "I<")
8809 (bold-italic . "B<I<")
8810 (underline . "C<")))
8811 (error "Face %s not configured for cperl-mode"
8812 face))))
8813\f
8814(defun cperl-time-fontification (&optional l step lim)
8815 "Times how long it takes to do incremental fontification in a region.
8816L is the line to start at, STEP is the number of lines to skip when
8817doing next incremental fontification, LIM is the maximal number of
8818incremental fontification to perform. Messages are accumulated in
8819*Messages* buffer.
8820
8821May be used for pinpointing which construct slows down buffer fontification:
8822start with default arguments, then refine the slowdown regions."
8823 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8824 (or l (setq l 1))
8825 (or step (setq step 500))
8826 (or lim (setq lim 40))
8827 (let* ((timems (function (lambda ()
8828 (let ((tt (current-time)))
8829 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8830 (tt (funcall timems)) (c 0) delta tot)
8831 (goto-line l)
8832 (cperl-mode)
8833 (setq tot (- (- tt (setq tt (funcall timems)))))
8834 (message "cperl-mode at %s: %s" l tot)
8835 (while (and (< c lim) (not (eobp)))
8836 (forward-line step)
8837 (setq l (+ l step))
8838 (setq c (1+ c))
8839 (cperl-update-syntaxification (point) (point))
8840 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8841 (message "to %s:%6s,%7s" l delta tot))
8842 tot))
8843
8844(defun cperl-emulate-lazy-lock (&optional window-size)
8845 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8846Start fontifying the buffer from the start (or end) using the given
8847WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8848goes backwards; default is -50. This function is not CPerl-specific; it
8849may be used to debug problems with delayed incremental fontification."
8850 (interactive
8851 "nSize of window for incremental fontification, negative goes backwards: ")
8852 (or window-size (setq window-size -50))
8853 (let ((pos (if (> window-size 0)
8854 (point-min)
8855 (point-max)))
8856 p)
8857 (goto-char pos)
8858 (normal-mode)
8859 ;; Why needed??? With older font-locks???
8860 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8861 (while (if (> window-size 0)
8862 (< pos (point-max))
8863 (> pos (point-min)))
8864 (setq p (progn
8865 (forward-line window-size)
8866 (point)))
8867 (font-lock-fontify-region (min p pos) (max p pos))
8868 (setq pos p))))
8869
8870\f
db133cb6 8871(defun cperl-lazy-install ()) ; Avoid a warning
f739b53b 8872(defun cperl-lazy-unstall ()) ; Avoid a warning
f83d2997
KH
8873
8874(if (fboundp 'run-with-idle-timer)
8875 (progn
8876 (defvar cperl-help-shown nil
8877 "Non-nil means that the help was already shown now.")
8878
8879 (defvar cperl-lazy-installed nil
8880 "Non-nil means that the lazy-help handlers are installed now.")
8881
8882 (defun cperl-lazy-install ()
f739b53b
SM
8883 "Switches on Auto-Help on Perl constructs (put in the message area).
8884Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997 8885 (interactive)
4ab89e7b 8886 (make-local-variable 'cperl-help-shown)
f83d2997
KH
8887 (if (and (cperl-val 'cperl-lazy-help-time)
8888 (not cperl-lazy-installed))
8889 (progn
8890 (add-hook 'post-command-hook 'cperl-lazy-hook)
5c8b7eaf
SS
8891 (run-with-idle-timer
8892 (cperl-val 'cperl-lazy-help-time 1000000 5)
8893 t
f83d2997
KH
8894 'cperl-get-help-defer)
8895 (setq cperl-lazy-installed t))))
8896
8897 (defun cperl-lazy-unstall ()
f739b53b
SM
8898 "Switches off Auto-Help on Perl constructs (put in the message area).
8899Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997
KH
8900 (interactive)
8901 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8902 (cancel-function-timers 'cperl-get-help-defer)
8903 (setq cperl-lazy-installed nil))
8904
8905 (defun cperl-lazy-hook ()
8906 (setq cperl-help-shown nil))
8907
8908 (defun cperl-get-help-defer ()
83261a2f 8909 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
f83d2997
KH
8910 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8911 (cperl-get-help)
8912 (setq cperl-help-shown t))))
8913 (cperl-lazy-install)))
8914
db133cb6
RS
8915
8916;;; Plug for wrong font-lock:
8917
8918(defun cperl-font-lock-unfontify-region-function (beg end)
4ab89e7b
SM
8919 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8920 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8921 before-change-functions after-change-functions
8922 deactivate-mark buffer-file-name buffer-file-truename)
8923 (remove-text-properties beg end '(face nil))
8924 (if (and (not modified) (buffer-modified-p))
8925 (set-buffer-modified-p nil))))
8926
8927(defun cperl-font-lock-fontify-region-function (beg end loudly)
8928 "Extends the region to safe positions, then calls the default function.
8929Newer `font-lock's can do it themselves.
8930We unwind only as far as needed for fontification. Syntaxification may
8931do extra unwind via `cperl-unwind-to-safe'."
8932 (save-excursion
8933 (goto-char beg)
8934 (while (and beg
8935 (progn
8936 (beginning-of-line)
8937 (eq (get-text-property (setq beg (point)) 'syntax-type)
8938 'multiline)))
8939 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8940 (goto-char beg)))
8941 (setq beg (point))
8942 (goto-char end)
8943 (while (and end
8944 (progn
8945 (or (bolp) (condition-case nil
8946 (forward-line 1)
8947 (error nil)))
8948 (eq (get-text-property (setq end (point)) 'syntax-type)
8949 'multiline)))
8950 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8951 (goto-char end))
8952 (setq end (point)))
8953 (font-lock-default-fontify-region beg end loudly))
db133cb6
RS
8954
8955(defvar cperl-d-l nil)
8956(defun cperl-fontify-syntaxically (end)
5bd52f0e 8957 ;; Some vars for debugging only
6c389151 8958 ;; (message "Syntaxifying...")
4ab89e7b 8959 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
83261a2f 8960 (istate (car cperl-syntax-state))
4ab89e7b
SM
8961 start from-start edebug-backtrace-buffer)
8962 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8963 (progn
8964 (require 'edebug)
8965 (let ((f 'edebug-backtrace))
8966 (funcall f)))) ; Avoid compile-time warning
db133cb6 8967 (or cperl-syntax-done-to
4ab89e7b
SM
8968 (setq cperl-syntax-done-to (point-min)
8969 from-start t))
8970 (setq start (if (and cperl-hook-after-change
8971 (not from-start))
8972 cperl-syntax-done-to ; Fontify without change; ignore start
8973 ;; Need to forget what is after `start'
8974 (min cperl-syntax-done-to (point))))
8975 (goto-char start)
8976 (beginning-of-line)
8977 (setq start (point))
8978 (and cperl-syntaxify-unwind
8979 (setq end (cperl-unwind-to-safe t end)
8980 start (point)))
db133cb6
RS
8981 (and (> end start)
8982 (setq cperl-syntax-done-to start) ; In case what follows fails
8983 (cperl-find-pods-heres start end t nil t))
4ab89e7b
SM
8984 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8985 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8986 dbg iend start end idone cperl-syntax-done-to
5c8b7eaf 8987 istate (car cperl-syntax-state))) ; For debugging
83261a2f 8988 nil)) ; Do not iterate
db133cb6 8989
5bd52f0e 8990(defun cperl-fontify-update (end)
4ab89e7b
SM
8991 (let ((pos (point-min)) prop posend)
8992 (setq end (point-max))
5bd52f0e 8993 (while (< pos end)
4ab89e7b
SM
8994 (setq prop (get-text-property pos 'cperl-postpone)
8995 posend (next-single-property-change pos 'cperl-postpone nil end))
5bd52f0e
RS
8996 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8997 (setq pos posend)))
83261a2f 8998 nil) ; Do not iterate
5bd52f0e 8999
4ab89e7b
SM
9000(defun cperl-fontify-update-bad (end)
9001 ;; Since fontification happens with different region than syntaxification,
9002 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
9003 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
9004 (if prop
9005 (setq pos (or (cperl-beginning-of-property
9006 (cperl-1+ pos) 'cperl-postpone)
9007 (point-min))))
9008 (while (< pos end)
9009 (setq posend (next-single-property-change pos 'cperl-postpone))
9010 (and prop (put-text-property pos posend (car prop) (cdr prop)))
9011 (setq pos posend)
9012 (setq prop (get-text-property pos 'cperl-postpone))))
9013 nil) ; Do not iterate
9014
9015;; Called when any modification is made to buffer text.
9016(defun cperl-after-change-function (beg end old-len)
9017 ;; We should have been informed about changes by `font-lock'. Since it
9018 ;; does not inform as which calls are defered, do it ourselves
9019 (if cperl-syntax-done-to
9020 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
9021
5bd52f0e
RS
9022(defun cperl-update-syntaxification (from to)
9023 (if (and cperl-use-syntax-table-text-property
9024 cperl-syntaxify-by-font-lock
9025 (or (null cperl-syntax-done-to)
9026 (< cperl-syntax-done-to to)))
9027 (progn
9028 (save-excursion
9029 (goto-char from)
9030 (cperl-fontify-syntaxically to)))))
9031
5c8b7eaf 9032(defvar cperl-version
4ab89e7b 9033 (let ((v "Revision: 5.22"))
5bd52f0e
RS
9034 (string-match ":\\s *\\([0-9.]+\\)" v)
9035 (substring v (match-beginning 1) (match-end 1)))
9036 "Version of IZ-supported CPerl package this file is based on.")
9037
f83d2997
KH
9038(provide 'cperl-mode)
9039
ab5796a9 9040;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
f83d2997 9041;;; cperl-mode.el ends here