Add :link (custom-group-link font-lock-faces) to defgroup.
[bpt/emacs.git] / lisp / progmodes / cperl-mode.el
CommitLineData
f83d2997
KH
1;;; cperl-mode.el --- Perl code editing commands for Emacs
2
034babe1
NR
3;; Copyright (C) 1985, 1986, 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4;; 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
f83d2997
KH
5;; Free Software Foundation, Inc.
6
7;; Author: Ilya Zakharevich and Bob Olson
83261a2f 8;; Maintainer: Ilya Zakharevich <cperl@ilyaz.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
15;; the Free Software Foundation; either version 2, or (at your option)
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
83261a2f 28;;; Corrections made by Ilya Zakharevich cperl@ilyaz.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
KH
69;;; Code:
70
b5b0cb34
JB
71(defvar vc-rcs-header)
72(defvar vc-sccs-header)
73
5bd52f0e 74;; Some macros are needed for `defcustom'
80585273 75(eval-when-compile
f739b53b
SM
76 (condition-case nil
77 (require 'man)
78 (error nil))
83261a2f
SM
79 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
80 (defvar cperl-can-font-lock
81 (or cperl-xemacs-p
82 (and (boundp 'emacs-major-version)
83 (or window-system
84 (> emacs-major-version 20)))))
85 (if cperl-can-font-lock
86 (require 'font-lock))
80585273
DL
87 (defvar msb-menu-cond)
88 (defvar gud-perldb-history)
89 (defvar font-lock-background-mode) ; not in Emacs
90 (defvar font-lock-display-type) ; ditto
80585273
DL
91 (defmacro cperl-is-face (arg) ; Takes quoted arg
92 (cond ((fboundp 'find-face)
93 `(find-face ,arg))
94 (;;(and (fboundp 'face-list)
95 ;; (face-list))
96 (fboundp 'face-list)
97 `(member ,arg (and (fboundp 'face-list)
98 (face-list))))
99 (t
100 `(boundp ,arg))))
101 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
102 (cond ((fboundp 'make-face)
103 `(make-face (quote ,arg)))
104 (t
ce22dd53 105 `(defvar ,arg (quote ,arg) ,descr))))
80585273
DL
106 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
107 `(progn
108 (or (cperl-is-face (quote ,arg))
109 (cperl-make-face ,arg ,descr))
110 (or (boundp (quote ,arg)) ; We use unquoted variants too
ce22dd53 111 (defvar ,arg (quote ,arg) ,descr))))
80585273
DL
112 (if cperl-xemacs-p
113 (defmacro cperl-etags-snarf-tag (file line)
b787fc05 114 `(progn
80585273
DL
115 (beginning-of-line 2)
116 (list ,file ,line)))
117 (defmacro cperl-etags-snarf-tag (file line)
118 `(etags-snarf-tag)))
119 (if cperl-xemacs-p
120 (defmacro cperl-etags-goto-tag-location (elt)
121 ;;(progn
122 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
123 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
124 ;; Probably will not work due to some save-excursion???
125 ;; Or save-file-position?
126 ;; (message "Did I get to line %s?" (elt (, elt) 1))
027a4b6b 127 `(goto-line (string-to-number (elt ,elt 1))))
80585273
DL
128 ;;)
129 (defmacro cperl-etags-goto-tag-location (elt)
f739b53b 130 `(etags-goto-tag-location ,elt))))
5bd52f0e 131
83261a2f
SM
132(defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
133
134(defvar cperl-can-font-lock
135 (or cperl-xemacs-p
136 (and (boundp 'emacs-major-version)
137 (or window-system
138 (> emacs-major-version 20)))))
139
5bd52f0e
RS
140(defun cperl-choose-color (&rest list)
141 (let (answer)
142 (while list
143 (or answer
144 (if (or (x-color-defined-p (car list))
145 (null (cdr list)))
146 (setq answer (car list))))
147 (setq list (cdr list)))
148 answer))
149
ccc3ce39
SE
150(defgroup cperl nil
151 "Major mode for editing Perl code."
152 :prefix "cperl-"
db133cb6
RS
153 :group 'languages
154 :version "20.3")
155
156(defgroup cperl-indentation-details nil
157 "Indentation."
158 :prefix "cperl-"
159 :group 'cperl)
160
161(defgroup cperl-affected-by-hairy nil
162 "Variables affected by `cperl-hairy'."
163 :prefix "cperl-"
164 :group 'cperl)
165
166(defgroup cperl-autoinsert-details nil
167 "Auto-insert tuneup."
168 :prefix "cperl-"
169 :group 'cperl)
170
171(defgroup cperl-faces nil
172 "Fontification colors."
8ec3bce0 173 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
db133cb6
RS
174 :prefix "cperl-"
175 :group 'cperl)
176
177(defgroup cperl-speed nil
178 "Speed vs. validity tuneup."
179 :prefix "cperl-"
180 :group 'cperl)
181
182(defgroup cperl-help-system nil
183 "Help system tuneup."
184 :prefix "cperl-"
185 :group 'cperl)
ccc3ce39 186
f83d2997 187\f
ccc3ce39 188(defcustom cperl-extra-newline-before-brace nil
f83d2997
KH
189 "*Non-nil means that if, elsif, while, until, else, for, foreach
190and do constructs look like:
191
192 if ()
193 {
194 }
195
196instead of:
197
198 if () {
83261a2f 199 }"
ccc3ce39 200 :type 'boolean
db133cb6
RS
201 :group 'cperl-autoinsert-details)
202
5c8b7eaf 203(defcustom cperl-extra-newline-before-brace-multiline
db133cb6
RS
204 cperl-extra-newline-before-brace
205 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
206for constructs with multiline if/unless/while/until/for/foreach condition."
207 :type 'boolean
208 :group 'cperl-autoinsert-details)
ccc3ce39
SE
209
210(defcustom cperl-indent-level 2
211 "*Indentation of CPerl statements with respect to containing block."
212 :type 'integer
db133cb6 213 :group 'cperl-indentation-details)
f83d2997 214
ccc3ce39 215(defcustom cperl-lineup-step nil
f83d2997 216 "*`cperl-lineup' will always lineup at multiple of this number.
029cb4d5 217If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 218 :type '(choice (const nil) integer)
db133cb6
RS
219 :group 'cperl-indentation-details)
220
ccc3ce39 221(defcustom cperl-brace-imaginary-offset 0
f83d2997
KH
222 "*Imagined indentation of a Perl open brace that actually follows a statement.
223An open brace following other text is treated as if it were this far
ccc3ce39
SE
224to the right of the start of its line."
225 :type 'integer
db133cb6 226 :group 'cperl-indentation-details)
ccc3ce39
SE
227
228(defcustom cperl-brace-offset 0
229 "*Extra indentation for braces, compared with other text in same context."
230 :type 'integer
db133cb6 231 :group 'cperl-indentation-details)
ccc3ce39
SE
232(defcustom cperl-label-offset -2
233 "*Offset of CPerl label lines relative to usual indentation."
234 :type 'integer
db133cb6 235 :group 'cperl-indentation-details)
ccc3ce39
SE
236(defcustom cperl-min-label-indent 1
237 "*Minimal offset of CPerl label lines."
238 :type 'integer
db133cb6 239 :group 'cperl-indentation-details)
ccc3ce39
SE
240(defcustom cperl-continued-statement-offset 2
241 "*Extra indent for lines not starting new statements."
242 :type 'integer
db133cb6 243 :group 'cperl-indentation-details)
ccc3ce39 244(defcustom cperl-continued-brace-offset 0
f83d2997 245 "*Extra indent for substatements that start with open-braces.
ccc3ce39
SE
246This is in addition to cperl-continued-statement-offset."
247 :type 'integer
db133cb6 248 :group 'cperl-indentation-details)
ccc3ce39
SE
249(defcustom cperl-close-paren-offset -1
250 "*Extra indent for substatements that start with close-parenthesis."
251 :type 'integer
db133cb6 252 :group 'cperl-indentation-details)
ccc3ce39
SE
253
254(defcustom cperl-auto-newline nil
f83d2997
KH
255 "*Non-nil means automatically newline before and after braces,
256and after colons and semicolons, inserted in CPerl code. The following
257\\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf 258Insertion after colons requires both this variable and
ccc3ce39
SE
259`cperl-auto-newline-after-colon' set."
260 :type 'boolean
db133cb6 261 :group 'cperl-autoinsert-details)
f83d2997 262
6c389151
SM
263(defcustom cperl-autoindent-on-semi nil
264 "*Non-nil means automatically indent after insertion of (semi)colon.
265Active if `cperl-auto-newline' is false."
266 :type 'boolean
267 :group 'cperl-autoinsert-details)
268
ccc3ce39 269(defcustom cperl-auto-newline-after-colon nil
f83d2997 270 "*Non-nil means automatically newline even after colons.
ccc3ce39
SE
271Subject to `cperl-auto-newline' setting."
272 :type 'boolean
db133cb6 273 :group 'cperl-autoinsert-details)
f83d2997 274
ccc3ce39 275(defcustom cperl-tab-always-indent t
f83d2997 276 "*Non-nil means TAB in CPerl mode should always reindent the current line,
ccc3ce39
SE
277regardless of where in the line point is when the TAB command is used."
278 :type 'boolean
db133cb6 279 :group 'cperl-indentation-details)
f83d2997 280
ccc3ce39 281(defcustom cperl-font-lock nil
029cb4d5 282 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
ccc3ce39 283Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
284 :type '(choice (const null) boolean)
285 :group 'cperl-affected-by-hairy)
f83d2997 286
ccc3ce39 287(defcustom cperl-electric-lbrace-space nil
029cb4d5 288 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
ccc3ce39 289Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
290 :type '(choice (const null) boolean)
291 :group 'cperl-affected-by-hairy)
f83d2997 292
ccc3ce39 293(defcustom cperl-electric-parens-string "({[]})<"
f83d2997 294 "*String of parentheses that should be electric in CPerl.
ccc3ce39
SE
295Closing ones are electric only if the region is highlighted."
296 :type 'string
db133cb6 297 :group 'cperl-affected-by-hairy)
f83d2997 298
ccc3ce39 299(defcustom cperl-electric-parens nil
f83d2997 300 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
ccc3ce39 301Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
302 :type '(choice (const null) boolean)
303 :group 'cperl-affected-by-hairy)
304
305(defvar zmacs-regions) ; Avoid warning
306
5c8b7eaf 307(defcustom cperl-electric-parens-mark
f83d2997
KH
308 (and window-system
309 (or (and (boundp 'transient-mark-mode) ; For Emacs
310 transient-mark-mode)
311 (and (boundp 'zmacs-regions) ; For XEmacs
312 zmacs-regions)))
313 "*Not-nil means that electric parens look for active mark.
ccc3ce39
SE
314Default is yes if there is visual feedback on mark."
315 :type 'boolean
db133cb6 316 :group 'cperl-autoinsert-details)
f83d2997 317
ccc3ce39 318(defcustom cperl-electric-linefeed nil
f83d2997
KH
319 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
320In any case these two mean plain and hairy linefeeds together.
ccc3ce39 321Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
322 :type '(choice (const null) boolean)
323 :group 'cperl-affected-by-hairy)
f83d2997 324
ccc3ce39 325(defcustom cperl-electric-keywords nil
f83d2997 326 "*Not-nil (and non-null) means keywords are electric in CPerl.
ccc3ce39 327Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
328 :type '(choice (const null) boolean)
329 :group 'cperl-affected-by-hairy)
ccc3ce39 330
f739b53b
SM
331(defcustom cperl-electric-backspace-untabify t
332 "*Not-nil means electric-backspace will untabify in CPerl."
333 :type 'boolean
334 :group 'cperl-autoinsert-details)
335
ccc3ce39 336(defcustom cperl-hairy nil
db133cb6 337 "*Not-nil means most of the bells and whistles are enabled in CPerl.
5c8b7eaf 338Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
db133cb6
RS
339`cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
340`cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
341`cperl-lazy-help-time'."
ccc3ce39 342 :type 'boolean
db133cb6 343 :group 'cperl-affected-by-hairy)
ccc3ce39
SE
344
345(defcustom cperl-comment-column 32
346 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
347 :type 'integer
db133cb6 348 :group 'cperl-indentation-details)
ccc3ce39 349
e1a5828f 350(defvar cperl-vc-header-alist nil)
6292d528 351(make-obsolete-variable
e1a5828f
AS
352 'cperl-vc-header-alist
353 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead.")
354
355(defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
356 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
357 :type '(repeat string)
358 :group 'cperl)
359
360(defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;")
361 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
362 :type '(repeat string)
ccc3ce39
SE
363 :group 'cperl)
364
5c8b7eaf 365(defcustom cperl-clobber-mode-lists
5bd52f0e
RS
366 (not
367 (and
368 (boundp 'interpreter-mode-alist)
369 (assoc "miniperl" interpreter-mode-alist)
370 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
371 "*Whether to install us into `interpreter-' and `extension' mode lists."
372 :type 'boolean
373 :group 'cperl)
374
ccc3ce39 375(defcustom cperl-info-on-command-no-prompt nil
f83d2997 376 "*Not-nil (and non-null) means not to prompt on C-h f.
6292d528 377The opposite behavior is always available if prefixed with C-c.
ccc3ce39 378Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
379 :type '(choice (const null) boolean)
380 :group 'cperl-affected-by-hairy)
381
382(defcustom cperl-clobber-lisp-bindings nil
383 "*Not-nil (and non-null) means not overwrite C-h f.
384The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
385Can be overwritten by `cperl-hairy' if nil."
386 :type '(choice (const null) boolean)
387 :group 'cperl-affected-by-hairy)
f83d2997 388
ccc3ce39 389(defcustom cperl-lazy-help-time nil
db133cb6
RS
390 "*Not-nil (and non-null) means to show lazy help after given idle time.
391Can be overwritten by `cperl-hairy' to be 5 sec if nil."
300f7bb3 392 :type '(choice (const null) (const nil) integer)
db133cb6 393 :group 'cperl-affected-by-hairy)
f83d2997 394
ccc3ce39 395(defcustom cperl-pod-face 'font-lock-comment-face
83261a2f 396 "*Face for POD highlighting."
ccc3ce39 397 :type 'face
db133cb6 398 :group 'cperl-faces)
f83d2997 399
ccc3ce39 400(defcustom cperl-pod-head-face 'font-lock-variable-name-face
83261a2f 401 "*Face for POD highlighting.
ccc3ce39
SE
402Font for POD headers."
403 :type 'face
db133cb6 404 :group 'cperl-faces)
f83d2997 405
ccc3ce39 406(defcustom cperl-here-face 'font-lock-string-face
80585273 407 "*Face for here-docs highlighting."
ccc3ce39 408 :type 'face
db133cb6 409 :group 'cperl-faces)
f83d2997 410
ac6857fb 411(defcustom cperl-invalid-face 'underline
80585273
DL
412 "*Face for highlighting trailing whitespace."
413 :type 'face
ac6857fb 414 :version "21.1"
5bd52f0e
RS
415 :group 'cperl-faces)
416
ccc3ce39 417(defcustom cperl-pod-here-fontify '(featurep 'font-lock)
83261a2f 418 "*Not-nil after evaluation means to highlight POD and here-docs sections."
ccc3ce39 419 :type 'boolean
db133cb6 420 :group 'cperl-faces)
f83d2997 421
5bd52f0e
RS
422(defcustom cperl-fontify-m-as-s t
423 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
424 :type 'boolean
425 :group 'cperl-faces)
426
6c389151
SM
427(defcustom cperl-highlight-variables-indiscriminately nil
428 "*Non-nil means perform additional highlighting on variables.
429Currently only changes how scalar variables are highlighted.
430Note that that variable is only read at initialization time for
431the variable `cperl-font-lock-keywords-2', so changing it after you've
f94a632a 432entered CPerl mode the first time will have no effect."
6c389151
SM
433 :type 'boolean
434 :group 'cperl)
435
ccc3ce39 436(defcustom cperl-pod-here-scan t
83261a2f 437 "*Not-nil means look for POD and here-docs sections during startup.
ccc3ce39
SE
438You can always make lookup from menu or using \\[cperl-find-pods-heres]."
439 :type 'boolean
db133cb6 440 :group 'cperl-speed)
f83d2997 441
6c389151
SM
442(defcustom cperl-regexp-scan t
443 "*Not-nil means make marking of regular expression more thorough.
444Effective only with `cperl-pod-here-scan'. Not implemented yet."
445 :type 'boolean
446 :group 'cperl-speed)
447
ccc3ce39 448(defcustom cperl-imenu-addback nil
f83d2997 449 "*Not-nil means add backreferences to generated `imenu's.
db133cb6 450May require patched `imenu' and `imenu-go'. Obsolete."
ccc3ce39 451 :type 'boolean
db133cb6 452 :group 'cperl-help-system)
f83d2997 453
ccc3ce39
SE
454(defcustom cperl-max-help-size 66
455 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
456 :type '(choice integer (const nil))
db133cb6 457 :group 'cperl-help-system)
f83d2997 458
ccc3ce39
SE
459(defcustom cperl-shrink-wrap-info-frame t
460 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
461 :type 'boolean
db133cb6 462 :group 'cperl-help-system)
f83d2997 463
ccc3ce39 464(defcustom cperl-info-page "perl"
f83d2997 465 "*Name of the info page containing perl docs.
ccc3ce39
SE
466Older version of this page was called `perl5', newer `perl'."
467 :type 'string
db133cb6 468 :group 'cperl-help-system)
f83d2997 469
5c8b7eaf 470(defcustom cperl-use-syntax-table-text-property
f83d2997 471 (boundp 'parse-sexp-lookup-properties)
ccc3ce39
SE
472 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
473 :type 'boolean
db133cb6 474 :group 'cperl-speed)
f83d2997 475
5c8b7eaf 476(defcustom cperl-use-syntax-table-text-property-for-tags
f83d2997 477 cperl-use-syntax-table-text-property
ccc3ce39
SE
478 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
479 :type 'boolean
db133cb6 480 :group 'cperl-speed)
ccc3ce39
SE
481
482(defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
483 "*Regexp to match files to scan when generating TAGS."
484 :type 'regexp
485 :group 'cperl)
486
8937f01b
RS
487(defcustom cperl-noscan-files-regexp
488 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
ccc3ce39
SE
489 "*Regexp to match files/dirs to skip when generating TAGS."
490 :type 'regexp
491 :group 'cperl)
492
493(defcustom cperl-regexp-indent-step nil
494 "*Indentation used when beautifying regexps.
029cb4d5 495If nil, the value of `cperl-indent-level' will be used."
ccc3ce39 496 :type '(choice integer (const nil))
db133cb6 497 :group 'cperl-indentation-details)
ccc3ce39
SE
498
499(defcustom cperl-indent-left-aligned-comments t
500 "*Non-nil means that the comment starting in leftmost column should indent."
501 :type 'boolean
db133cb6 502 :group 'cperl-indentation-details)
ccc3ce39 503
8f222248 504(defcustom cperl-under-as-char nil
ccc3ce39
SE
505 "*Non-nil means that the _ (underline) should be treated as word char."
506 :type 'boolean
507 :group 'cperl)
f83d2997 508
db133cb6
RS
509(defcustom cperl-extra-perl-args ""
510 "*Extra arguments to use when starting Perl.
511Currently used with `cperl-check-syntax' only."
512 :type 'string
513 :group 'cperl)
514
515(defcustom cperl-message-electric-keyword t
516 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
517 :type 'boolean
518 :group 'cperl-help-system)
519
520(defcustom cperl-indent-region-fix-constructs 1
521 "*Amount of space to insert between `}' and `else' or `elsif'
522in `cperl-indent-region'. Set to nil to leave as is. Values other
523than 1 and nil will probably not work."
524 :type '(choice (const nil) (const 1))
525 :group 'cperl-indentation-details)
526
527(defcustom cperl-break-one-line-blocks-when-indent t
528 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
2022c546 529need to be reformatted into multiline ones when indenting a region."
db133cb6
RS
530 :type 'boolean
531 :group 'cperl-indentation-details)
532
533(defcustom cperl-fix-hanging-brace-when-indent t
534 "*Non-nil means that BLOCK-end `}' may be put on a separate line
5c8b7eaf 535when indenting a region.
db133cb6
RS
536Braces followed by else/elsif/while/until are excepted."
537 :type 'boolean
538 :group 'cperl-indentation-details)
539
540(defcustom cperl-merge-trailing-else t
5c8b7eaf 541 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
db133cb6
RS
542may be merged to be on the same line when indenting a region."
543 :type 'boolean
544 :group 'cperl-indentation-details)
545
6c389151
SM
546(defcustom cperl-indent-parens-as-block nil
547 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
548but for trailing \",\" inside the group, which won't increase indentation.
549One should tune up `cperl-close-paren-offset' as well."
550 :type 'boolean
551 :group 'cperl-indentation-details)
552
a1506d29 553(defcustom cperl-syntaxify-by-font-lock
83261a2f 554 (and cperl-can-font-lock
5bd52f0e 555 (boundp 'parse-sexp-lookup-properties))
6c389151 556 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
5bd52f0e
RS
557 :type '(choice (const message) boolean)
558 :group 'cperl-speed)
559
560(defcustom cperl-syntaxify-unwind
561 t
f94a632a 562 "*Non-nil means that CPerl unwinds to a start of a long construction
5bd52f0e 563when syntaxifying a chunk of buffer."
db133cb6
RS
564 :type 'boolean
565 :group 'cperl-speed)
566
5bd52f0e
RS
567(defcustom cperl-ps-print-face-properties
568 '((font-lock-keyword-face nil nil bold shadow)
569 (font-lock-variable-name-face nil nil bold)
570 (font-lock-function-name-face nil nil bold italic box)
571 (font-lock-constant-face nil "LightGray" bold)
e4c067b5
MB
572 (cperl-array nil "LightGray" bold underline)
573 (cperl-hash nil "LightGray" bold italic underline)
5bd52f0e
RS
574 (font-lock-comment-face nil "LightGray" italic)
575 (font-lock-string-face nil nil italic underline)
e4c067b5 576 (cperl-nonoverridable nil nil italic underline)
5bd52f0e
RS
577 (font-lock-type-face nil nil underline)
578 (underline nil "LightGray" strikeout))
579 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
5c8b7eaf 580 :type '(repeat (cons symbol
5bd52f0e
RS
581 (cons (choice (const nil) string)
582 (cons (choice (const nil) string)
583 (repeat symbol)))))
584 :group 'cperl-faces)
585
5cc679ab
JB
586(defvar cperl-dark-background
587 (cperl-choose-color "navy" "os2blue" "darkgreen"))
588(defvar cperl-dark-foreground
589 (cperl-choose-color "orchid1" "orange"))
590
e4c067b5 591(defface cperl-nonoverridable
5cc679ab
JB
592 `((((class grayscale) (background light))
593 (:background "Gray90" :slant italic :underline t))
594 (((class grayscale) (background dark))
595 (:foreground "Gray80" :slant italic :underline t :weight bold))
596 (((class color) (background light))
597 (:foreground "chartreuse3"))
598 (((class color) (background dark))
599 (:foreground ,cperl-dark-foreground))
600 (t (:weight bold :underline t)))
c73fce9a 601 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
5cc679ab 602 :group 'cperl-faces)
e4c067b5
MB
603;; backward-compatibility alias
604(put 'cperl-nonoverridable-face 'face-alias 'cperl-nonoverridable)
5cc679ab 605
e4c067b5 606(defface cperl-array
5cc679ab
JB
607 `((((class grayscale) (background light))
608 (:background "Gray90" :weight bold))
609 (((class grayscale) (background dark))
610 (:foreground "Gray80" :weight bold))
611 (((class color) (background light))
612 (:foreground "Blue" :background "lightyellow2" :weight bold))
613 (((class color) (background dark))
614 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
615 (t (:weight bold)))
616 "Font Lock mode face used to highlight array names."
617 :group 'cperl-faces)
e4c067b5
MB
618;; backward-compatibility alias
619(put 'cperl-array-face 'face-alias 'cperl-array)
5cc679ab 620
e4c067b5 621(defface cperl-hash
5cc679ab
JB
622 `((((class grayscale) (background light))
623 (:background "Gray90" :weight bold :slant italic))
624 (((class grayscale) (background dark))
625 (:foreground "Gray80" :weight bold :slant italic))
626 (((class color) (background light))
627 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
628 (((class color) (background dark))
629 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
630 (t (:weight bold :slant italic)))
631 "Font Lock mode face used to highlight hash names."
632 :group 'cperl-faces)
e4c067b5
MB
633;; backward-compatibility alias
634(put 'cperl-hash-face 'face-alias 'cperl-hash)
5bd52f0e 635
f83d2997
KH
636\f
637
638;;; Short extra-docs.
639
640(defvar cperl-tips 'please-ignore-this-line
83261a2f 641 "Get maybe newer version of this package from
f83d2997
KH
642 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
643and/or
644 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
db133cb6
RS
645Subdirectory `cperl-mode' may contain yet newer development releases and/or
646patches to related files.
f83d2997 647
5bd52f0e
RS
648For best results apply to an older Emacs the patches from
649 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
83261a2f 650\(this upgrades syntax-parsing abilities of Emacsen v19.34 and
8e3acc66 651v20.2 up to the level of Emacs v20.3 - a must for a good Perl
83261a2f 652mode.) As of beginning of 2003, XEmacs may provide a similar ability.
5bd52f0e 653
f83d2997
KH
654Get support packages choose-color.el (or font-lock-extra.el before
65519.30), imenu-go.el from the same place. \(Look for other files there
656too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
5c8b7eaf 657later you should use choose-color.el *instead* of font-lock-extra.el
f83d2997
KH
658\(and you will not get smart highlighting in C :-().
659
660Note that to enable Compile choices in the menu you need to install
661mode-compile.el.
662
5efe6a56
SM
663If your Emacs does not default to `cperl-mode' on Perl files, and you
664want it to: put the following into your .emacs file:
665
666 (defalias 'perl-mode 'cperl-mode)
667
a1506d29 668Get perl5-info from
f83d2997
KH
669 $CPAN/doc/manual/info/perl-info.tar.gz
670older version was on
671 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
672
673If you use imenu-go, run imenu on perl5-info buffer (you can do it
5bd52f0e
RS
674from Perl menu). If many files are related, generate TAGS files from
675Tools/Tags submenu in Perl menu.
f83d2997
KH
676
677If some class structure is too complicated, use Tools/Hierarchy-view
029cb4d5 678from Perl menu, or hierarchic view of imenu. The second one uses the
f83d2997 679current buffer only, the first one requires generation of TAGS from
5bd52f0e
RS
680Perl/Tools/Tags menu beforehand.
681
682Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
683
684Switch auto-help on/off with Perl/Tools/Auto-help.
685
686Though with contemporary Emaxen CPerl mode should maintain the correct
687parsing of Perl even when editing, sometimes it may be lost. Fix this by
688
029cb4d5 689 \\[normal-mode]
f83d2997 690
5bd52f0e 691In cases of more severe confusion sometimes it is helpful to do
f83d2997 692
029cb4d5
SM
693 \\[load-library] cperl-mode RET
694 \\[normal-mode]
f83d2997 695
5bd52f0e
RS
696Before reporting (non-)problems look in the problem section of online
697micro-docs on what I know about CPerl problems.")
f83d2997
KH
698
699(defvar cperl-problems 'please-ignore-this-line
f94a632a
RS
700 "Description of problems in CPerl mode.
701Some faces will not be shown on some versions of Emacs unless you
bab27c0c
RS
702install choose-color.el, available from
703 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
704
6c389151
SM
705`fill-paragraph' on a comment may leave the point behind the
706paragraph. Parsing of lines with several <<EOF is not implemented
707yet.
708
8e3acc66 709Emacs had a _very_ restricted syntax parsing engine until version
5bd52f0e 71020.1. Most problems below are corrected starting from this version of
8e3acc66 711Emacs, and all of them should be fixed in version 20.3. (Or apply
83261a2f
SM
712patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
713this respect (until 2003).
5bd52f0e 714
6c389151
SM
715Note that even with newer Emacsen in some very rare cases the details
716of interaction of `font-lock' and syntaxification may be not cleaned
717up yet. You may get slightly different colors basing on the order of
718fontification and syntaxification. Say, the initial faces is correct,
719but editing the buffer breaks this.
f83d2997 720
db133cb6
RS
721Even with older Emacsen CPerl mode tries to corrects some Emacs
722misunderstandings, however, for efficiency reasons the degree of
723correction is different for different operations. The partially
724corrected problems are: POD sections, here-documents, regexps. The
725operations are: highlighting, indentation, electric keywords, electric
726braces.
f83d2997
KH
727
728This may be confusing, since the regexp s#//#/#\; may be highlighted
729as a comment, but it will be recognized as a regexp by the indentation
83261a2f 730code. Or the opposite case, when a POD section is highlighted, but
f83d2997
KH
731may break the indentation of the following code (though indentation
732should work if the balance of delimiters is not broken by POD).
733
734The main trick (to make $ a \"backslash\") makes constructions like
735${aaa} look like unbalanced braces. The only trick I can think of is
2e8b9c7d 736to insert it as $ {aaa} (valid in perl5, not in perl4).
f83d2997
KH
737
738Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
db133cb6
RS
739as /($|\\s)/. Note that such a transposition is not always possible.
740
5bd52f0e 741The solution is to upgrade your Emacs or patch an older one. Note
8e3acc66 742that Emacs 20.2 has some bugs related to `syntax-table' text
5bd52f0e
RS
743properties. Patches are available on the main CPerl download site,
744and on CPAN.
db133cb6
RS
745
746If these bugs cannot be fixed on your machine (say, you have an inferior
747environment and cannot recompile), you may still disable all the fancy stuff
83261a2f 748via `cperl-use-syntax-table-text-property'.")
f83d2997 749
f83d2997 750(defvar cperl-praise 'please-ignore-this-line
8e3acc66 751 "Advantages of CPerl mode.
f83d2997
KH
752
7530) It uses the newest `syntax-table' property ;-);
754
7551) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
5c8b7eaf 756mode - but the latter number may have improved too in last years) even
5bd52f0e
RS
757with old Emaxen which do not support `syntax-table' property.
758
759When using `syntax-table' property for syntax assist hints, it should
760handle 99.995% of lines correct - or somesuch. It automatically
761updates syntax assist hints when you edit your script.
f83d2997 762
bab27c0c 7632) It is generally believed to be \"the most user-friendly Emacs
f83d2997
KH
764package\" whatever it may mean (I doubt that the people who say similar
765things tried _all_ the rest of Emacs ;-), but this was not a lonely
766voice);
767
7683) Everything is customizable, one-by-one or in a big sweep;
769
7704) It has many easily-accessable \"tools\":
771 a) Can run program, check syntax, start debugger;
772 b) Can lineup vertically \"middles\" of rows, like `=' in
773 a = b;
774 cc = d;
775 c) Can insert spaces where this impoves readability (in one
776 interactive sweep over the buffer);
777 d) Has support for imenu, including:
778 1) Separate unordered list of \"interesting places\";
779 2) Separate TOC of POD sections;
780 3) Separate list of packages;
781 4) Hierarchical view of methods in (sub)packages;
782 5) and functions (by the full name - with package);
783 e) Has an interface to INFO docs for Perl; The interface is
784 very flexible, including shrink-wrapping of
785 documentation buffer/frame;
786 f) Has a builtin list of one-line explanations for perl constructs.
787 g) Can show these explanations if you stay long enough at the
788 corresponding place (or on demand);
789 h) Has an enhanced fontification (using 3 or 4 additional faces
790 comparing to font-lock - basically, different
791 namespaces in Perl have different colors);
792 i) Can construct TAGS basing on its knowledge of Perl syntax,
793 the standard menu has 6 different way to generate
db133cb6 794 TAGS (if \"by directory\", .xs files - with C-language
f83d2997
KH
795 bindings - are included in the scan);
796 j) Can build a hierarchical view of classes (via imenu) basing
797 on generated TAGS file;
798 k) Has electric parentheses, electric newlines, uses Abbrev
799 for electric logical constructs
800 while () {}
801 with different styles of expansion (context sensitive
802 to be not so bothering). Electric parentheses behave
803 \"as they should\" in a presence of a visible region.
804 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
db133cb6
RS
805 m) Can convert from
806 if (A) { B }
807 to
808 B if A;
f83d2997 809
5bd52f0e 810 n) Highlights (by user-choice) either 3-delimiters constructs
6c389151
SM
811 (such as tr/a/b/), or regular expressions and `y/tr';
812 o) Highlights trailing whitespace;
813 p) Is able to manipulate Perl Regular Expressions to ease
814 conversion to a more readable form.
5bd52f0e 815
f83d2997
KH
8165) The indentation engine was very smart, but most of tricks may be
817not needed anymore with the support for `syntax-table' property. Has
818progress indicator for indentation (with `imenu' loaded).
819
5c8b7eaf 8206) Indent-region improves inline-comments as well; also corrects
db133cb6 821whitespace *inside* the conditional/loop constructs.
f83d2997
KH
822
8237) Fill-paragraph correctly handles multi-line comments;
db133cb6
RS
824
8258) Can switch to different indentation styles by one command, and restore
826the settings present before the switch.
827
5c8b7eaf 8289) When doing indentation of control constructs, may correct
db133cb6 829line-breaks/spacing between elements of the construct.
029cb4d5
SM
830
83110) Uses a linear-time algorith for indentation of regions (on Emaxen with
83261a2f 832capable syntax engines).")
db133cb6
RS
833
834(defvar cperl-speed 'please-ignore-this-line
835 "This is an incomplete compendium of what is available in other parts
836of CPerl documentation. (Please inform me if I skept anything.)
837
838There is a perception that CPerl is slower than alternatives. This part
839of documentation is designed to overcome this misconception.
840
841*By default* CPerl tries to enable the most comfortable settings.
842From most points of view, correctly working package is infinitely more
843comfortable than a non-correctly working one, thus by default CPerl
844prefers correctness over speed. Below is the guide how to change
845settings if your preferences are different.
846
847A) Speed of loading the file. When loading file, CPerl may perform a
848scan which indicates places which cannot be parsed by primitive Emacs
849syntax-parsing routines, and marks them up so that either
850
851 A1) CPerl may work around these deficiencies (for big chunks, mostly
852 PODs and HERE-documents), or
853 A2) On capable Emaxen CPerl will use improved syntax-handlings
854 which reads mark-up hints directly.
855
856 The scan in case A2 is much more comprehensive, thus may be slower.
857
858 User can disable syntax-engine-helping scan of A2 by setting
859 `cperl-use-syntax-table-text-property'
860 variable to nil (if it is set to t).
861
862 One can disable the scan altogether (both A1 and A2) by setting
863 `cperl-pod-here-scan'
864 to nil.
865
5c8b7eaf 866B) Speed of editing operations.
db133cb6
RS
867
868 One can add a (minor) speedup to editing operations by setting
869 `cperl-use-syntax-table-text-property'
870 variable to nil (if it is set to t). This will disable
871 syntax-engine-helping scan, thus will make many more Perl
872 constructs be wrongly recognized by CPerl, thus may lead to
873 wrongly matched parentheses, wrong indentation, etc.
5bd52f0e
RS
874
875 One can unset `cperl-syntaxify-unwind'. This might speed up editing
83261a2f 876 of, say, long POD sections.")
f83d2997 877
5bd52f0e
RS
878(defvar cperl-tips-faces 'please-ignore-this-line
879 "CPerl mode uses following faces for highlighting:
880
e4c067b5
MB
881 `cperl-array' Array names
882 `cperl-hash' Hash names
8661c643 883 `font-lock-comment-face' Comments, PODs and whatever is considered
5bd52f0e 884 syntaxically to be not code
8661c643 885 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
5bd52f0e 886 2-arg operators s/y/tr/ or of RExen,
a1506d29 887 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
5bd52f0e
RS
888 a target of a file tests, file tests,
889 subroutine names at the moment of definition
890 (except those conflicting with Perl operators),
891 package names (when recognized), format names
8661c643 892 `font-lock-keyword-face' Control flow switch constructs, declarators
e4c067b5 893 `cperl-nonoverridable' Non-overridable keywords, modifiers of RExen
8661c643 894 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
5bd52f0e
RS
895 literal parts and the terminator of formats
896 and whatever is syntaxically considered
897 as string literals
8661c643
DL
898 `font-lock-type-face' Overridable keywords
899 `font-lock-variable-name-face' Variable declarations, indirect array and
5bd52f0e 900 hash names, POD headers/item names
e4c067b5 901 `cperl-invalid' Trailing whitespace
5bd52f0e
RS
902
903Note that in several situations the highlighting tries to inform about
904possible confusion, such as different colors for function names in
905declarations depending on what they (do not) override, or special cases
906m// and s/// which do not do what one would expect them to do.
907
5c8b7eaf 908Help with best setup of these faces for printout requested (for each of
5bd52f0e
RS
909the faces: please specify bold, italic, underline, shadow and box.)
910
911\(Not finished.)")
912
f83d2997
KH
913\f
914
915;;; Portability stuff:
916
917(defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
b787fc05
GM
918 `(define-key cperl-mode-map
919 ,(if xemacs-key
920 `(if cperl-xemacs-p ,xemacs-key ,emacs-key)
921 emacs-key)
922 ,definition))
f83d2997
KH
923
924(defvar cperl-del-back-ch
925 (car (append (where-is-internal 'delete-backward-char)
926 (where-is-internal 'backward-delete-char-untabify)))
029cb4d5 927 "Character generated by key bound to `delete-backward-char'.")
f83d2997 928
5c8b7eaf 929(and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
f83d2997
KH
930 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
931
db133cb6 932(defun cperl-mark-active () (mark)) ; Avoid undefined warning
f83d2997
KH
933(if cperl-xemacs-p
934 (progn
935 ;; "Active regions" are on: use region only if active
936 ;; "Active regions" are off: use region unconditionally
937 (defun cperl-use-region-p ()
db133cb6 938 (if zmacs-regions (mark) t)))
f83d2997
KH
939 (defun cperl-use-region-p ()
940 (if transient-mark-mode mark-active t))
941 (defun cperl-mark-active () mark-active))
942
943(defsubst cperl-enable-font-lock ()
83261a2f 944 cperl-can-font-lock)
f83d2997 945
83261a2f 946(defun cperl-putback-char (c) ; Emacs 19
db133cb6
RS
947 (set 'unread-command-events (list c))) ; Avoid undefined warning
948
0ce7de92
RS
949(if cperl-xemacs-p
950 (defun cperl-putback-char (c) ; XEmacs >= 19.12
951 (setq unread-command-events (list (eval '(character-to-event c))))))
f83d2997
KH
952
953(or (fboundp 'uncomment-region)
954 (defun uncomment-region (beg end)
955 (interactive "r")
956 (comment-region beg end -1)))
957
958(defvar cperl-do-not-fontify
959 (if (string< emacs-version "19.30")
960 'fontified
961 'lazy-lock)
962 "Text property which inhibits refontification.")
963
5bd52f0e
RS
964(defsubst cperl-put-do-not-fontify (from to &optional post)
965 ;; If POST, do not do it with postponed fontification
966 (if (and post cperl-syntaxify-by-font-lock)
967 nil
f83d2997 968 (put-text-property (max (point-min) (1- from))
5bd52f0e 969 to cperl-do-not-fontify t)))
f83d2997 970
ccc3ce39 971(defcustom cperl-mode-hook nil
f94a632a 972 "Hook run by CPerl mode."
ccc3ce39
SE
973 :type 'hook
974 :group 'cperl)
f83d2997 975
db133cb6
RS
976(defvar cperl-syntax-state nil)
977(defvar cperl-syntax-done-to nil)
5bd52f0e 978(defvar cperl-emacs-can-parse (> (length (save-excursion
ce22dd53 979 (parse-partial-sexp (point) (point)))) 9))
db133cb6
RS
980\f
981;; Make customization possible "in reverse"
982(defsubst cperl-val (symbol &optional default hairy)
983 (cond
984 ((eq (symbol-value symbol) 'null) default)
985 (cperl-hairy (or hairy t))
986 (t (symbol-value symbol))))
f83d2997
KH
987\f
988;;; Probably it is too late to set these guys already, but it can help later:
989
5bd52f0e 990;;;(and cperl-clobber-mode-lists
f83d2997
KH
991;;;(setq auto-mode-alist
992;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
993;;;(and (boundp 'interpreter-mode-alist)
994;;; (setq interpreter-mode-alist (append interpreter-mode-alist
5bd52f0e 995;;; '(("miniperl" . perl-mode))))))
80585273 996(eval-when-compile
83261a2f
SM
997 (mapcar (lambda (p)
998 (condition-case nil
999 (require p)
1000 (error nil)))
1001 '(imenu easymenu etags timer man info))
80585273
DL
1002 (if (fboundp 'ps-extend-face-list)
1003 (defmacro cperl-ps-extend-face-list (arg)
1004 `(ps-extend-face-list ,arg))
1005 (defmacro cperl-ps-extend-face-list (arg)
e8af40ee 1006 `(error "This version of Emacs has no `ps-extend-face-list'")))
80585273
DL
1007 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1008 ;; macros instead of defsubsts don't work on Emacs, so we do the
1009 ;; expansion manually. Any other suggestions?
1010 (require 'cl))
f83d2997
KH
1011
1012(defvar cperl-mode-abbrev-table nil
f94a632a 1013 "Abbrev table in use in CPerl mode buffers.")
f83d2997
KH
1014
1015(add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1016
1017(defvar cperl-mode-map () "Keymap used in CPerl mode.")
1018
1019(if cperl-mode-map nil
1020 (setq cperl-mode-map (make-sparse-keymap))
1021 (cperl-define-key "{" 'cperl-electric-lbrace)
1022 (cperl-define-key "[" 'cperl-electric-paren)
1023 (cperl-define-key "(" 'cperl-electric-paren)
1024 (cperl-define-key "<" 'cperl-electric-paren)
1025 (cperl-define-key "}" 'cperl-electric-brace)
1026 (cperl-define-key "]" 'cperl-electric-rparen)
1027 (cperl-define-key ")" 'cperl-electric-rparen)
1028 (cperl-define-key ";" 'cperl-electric-semi)
1029 (cperl-define-key ":" 'cperl-electric-terminator)
1030 (cperl-define-key "\C-j" 'newline-and-indent)
1031 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
db133cb6 1032 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
f83d2997
KH
1033 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1034 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
db133cb6
RS
1035 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1036 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
f83d2997 1037 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
db133cb6 1038 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
f83d2997
KH
1039 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1040 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1041 [(control meta |)])
1042 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1043 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1044 (cperl-define-key "\177" 'cperl-electric-backspace)
1045 (cperl-define-key "\t" 'cperl-indent-command)
1046 ;; don't clobber the backspace binding:
db133cb6
RS
1047 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1048 [(control c) (control h) F])
db133cb6
RS
1049 (if (cperl-val 'cperl-clobber-lisp-bindings)
1050 (progn
1051 (cperl-define-key "\C-hf"
1052 ;;(concat (char-to-string help-char) "f") ; does not work
1053 'cperl-info-on-command
1054 [(control h) f])
1055 (cperl-define-key "\C-hv"
1056 ;;(concat (char-to-string help-char) "v") ; does not work
1057 'cperl-get-help
5bd52f0e
RS
1058 [(control h) v])
1059 (cperl-define-key "\C-c\C-hf"
1060 ;;(concat (char-to-string help-char) "f") ; does not work
1061 (key-binding "\C-hf")
1062 [(control c) (control h) f])
1063 (cperl-define-key "\C-c\C-hv"
1064 ;;(concat (char-to-string help-char) "v") ; does not work
1065 (key-binding "\C-hv")
1066 [(control c) (control h) v]))
1067 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1068 [(control c) (control h) f])
1069 (cperl-define-key "\C-c\C-hv"
1070 ;;(concat (char-to-string help-char) "v") ; does not work
1071 'cperl-get-help
1072 [(control c) (control h) v]))
5c8b7eaf 1073 (if (and cperl-xemacs-p
f83d2997
KH
1074 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1075 (progn
1076 ;; substitute-key-definition is usefulness-deenhanced...
1077 (cperl-define-key "\M-q" 'cperl-fill-paragraph)
1078 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1079 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1080 (substitute-key-definition
1081 'indent-sexp 'cperl-indent-exp
1082 cperl-mode-map global-map)
f83d2997
KH
1083 (substitute-key-definition
1084 'indent-region 'cperl-indent-region
1085 cperl-mode-map global-map)
1086 (substitute-key-definition
1087 'indent-for-comment 'cperl-indent-for-comment
1088 cperl-mode-map global-map)))
1089
1090(defvar cperl-menu)
db133cb6
RS
1091(defvar cperl-lazy-installed)
1092(defvar cperl-old-style nil)
f83d2997
KH
1093(condition-case nil
1094 (progn
1095 (require 'easymenu)
83261a2f
SM
1096 (easy-menu-define
1097 cperl-menu cperl-mode-map "Menu for CPerl mode"
1098 '("Perl"
1099 ["Beginning of function" beginning-of-defun t]
1100 ["End of function" end-of-defun t]
1101 ["Mark function" mark-defun t]
1102 ["Indent expression" cperl-indent-exp t]
82eb0dae 1103 ["Fill paragraph/comment" fill-paragraph t]
83261a2f
SM
1104 "----"
1105 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1106 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1107 ("Regexp"
1108 ["Beautify" cperl-beautify-regexp
1109 cperl-use-syntax-table-text-property]
1110 ["Beautify one level deep" (cperl-beautify-regexp 1)
1111 cperl-use-syntax-table-text-property]
1112 ["Beautify a group" cperl-beautify-level
1113 cperl-use-syntax-table-text-property]
1114 ["Beautify a group one level deep" (cperl-beautify-level 1)
1115 cperl-use-syntax-table-text-property]
1116 ["Contract a group" cperl-contract-level
1117 cperl-use-syntax-table-text-property]
1118 ["Contract groups" cperl-contract-levels
1119 cperl-use-syntax-table-text-property])
1120 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1121 "----"
1122 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1123 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1124 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1125 "----"
1126 ["Run" mode-compile (fboundp 'mode-compile)]
1127 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1128 (get-buffer "*compilation*"))]
1129 ["Next error" next-error (get-buffer "*compilation*")]
1130 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1131 "----"
1132 ["Debugger" cperl-db t]
1133 "----"
1134 ("Tools"
1135 ["Imenu" imenu (fboundp 'imenu)]
1136 ["Insert spaces if needed" cperl-find-bad-style t]
1137 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1138 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1139 ["CPerl pretty print (exprmntl)" cperl-ps-print
1140 (fboundp 'ps-extend-face-list)]
1141 ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
1142 ("Tags"
f83d2997
KH
1143;;; ["Create tags for current file" cperl-etags t]
1144;;; ["Add tags for current file" (cperl-etags t) t]
1145;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1146;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
5c8b7eaf 1147;;; ["Create tags for Perl files in (sub)directories"
f83d2997
KH
1148;;; (cperl-etags nil 'recursive) t]
1149;;; ["Add tags for Perl files in (sub)directories"
5c8b7eaf 1150;;; (cperl-etags t 'recursive) t])
f83d2997 1151;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
f739b53b
SM
1152 ["Create tags for current file" (cperl-write-tags nil t) t]
1153 ["Add tags for current file" (cperl-write-tags) t]
1154 ["Create tags for Perl files in directory"
1155 (cperl-write-tags nil t nil t) t]
1156 ["Add tags for Perl files in directory"
1157 (cperl-write-tags nil nil nil t) t]
1158 ["Create tags for Perl files in (sub)directories"
1159 (cperl-write-tags nil t t t) t]
1160 ["Add tags for Perl files in (sub)directories"
1161 (cperl-write-tags nil nil t t) t]))
1162 ("Perl docs"
15ca5699 1163 ["Define word at point" imenu-go-find-at-position
f739b53b
SM
1164 (fboundp 'imenu-go-find-at-position)]
1165 ["Help on function" cperl-info-on-command t]
1166 ["Help on function at point" cperl-info-on-current-command t]
1167 ["Help on symbol at point" cperl-get-help t]
1168 ["Perldoc" cperl-perldoc t]
1169 ["Perldoc on word at point" cperl-perldoc-at-point t]
1170 ["View manpage of POD in this file" cperl-build-manpage t]
15ca5699 1171 ["Auto-help on" cperl-lazy-install
f739b53b
SM
1172 (and (fboundp 'run-with-idle-timer)
1173 (not cperl-lazy-installed))]
1174 ["Auto-help off" cperl-lazy-unstall
1175 (and (fboundp 'run-with-idle-timer)
1176 cperl-lazy-installed)])
1177 ("Toggle..."
1178 ["Auto newline" cperl-toggle-auto-newline t]
1179 ["Electric parens" cperl-toggle-electric t]
1180 ["Electric keywords" cperl-toggle-abbrev t]
1181 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1182 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
15ca5699 1183 ["Auto fill" auto-fill-mode t])
f739b53b
SM
1184 ("Indent styles..."
1185 ["CPerl" (cperl-set-style "CPerl") t]
1186 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1187 ["GNU" (cperl-set-style "GNU") t]
1188 ["C++" (cperl-set-style "C++") t]
1189 ["FSF" (cperl-set-style "FSF") t]
1190 ["BSD" (cperl-set-style "BSD") t]
1191 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1192 ["Current" (cperl-set-style "Current") t]
1193 ["Memorized" (cperl-set-style-back) cperl-old-style])
1194 ("Micro-docs"
1195 ["Tips" (describe-variable 'cperl-tips) t]
1196 ["Problems" (describe-variable 'cperl-problems) t]
1197 ["Speed" (describe-variable 'cperl-speed) t]
1198 ["Praise" (describe-variable 'cperl-praise) t]
1199 ["Faces" (describe-variable 'cperl-tips-faces) t]
1200 ["CPerl mode" (describe-function 'cperl-mode) t]
1201 ["CPerl version"
1202 (message "The version of master-file for this CPerl is %s-Emacs"
1203 cperl-version) t]))))
f83d2997
KH
1204 (error nil))
1205
1206(autoload 'c-macro-expand "cmacexp"
1207 "Display the result of expanding all C macros occurring in the region.
1208The expansion is entirely correct because it uses the C preprocessor."
1209 t)
1210
95f433f4
RS
1211(defvar cperl-imenu--function-name-regexp-perl
1212 (concat
1213 "^\\("
1214 "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
1215 "\\|"
1216 "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
1217 "\\)"))
1218
8dd511f6
RS
1219(defvar cperl-outline-regexp
1220 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1221
f83d2997 1222(defvar cperl-mode-syntax-table nil
f94a632a 1223 "Syntax table in use in CPerl mode buffers.")
f83d2997
KH
1224
1225(defvar cperl-string-syntax-table nil
f94a632a 1226 "Syntax table in use in CPerl mode string-like chunks.")
f83d2997
KH
1227
1228(if cperl-mode-syntax-table
1229 ()
1230 (setq cperl-mode-syntax-table (make-syntax-table))
1231 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1232 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1233 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1234 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1235 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1236 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1237 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1238 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1239 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1240 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1241 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1242 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
1243 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1244 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1245 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1246 (if cperl-under-as-char
1247 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1248 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1249 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1250 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1251 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
83261a2f 1252 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
f83d2997
KH
1253
1254
1255\f
db133cb6 1256(defvar cperl-faces-init nil)
f83d2997
KH
1257;; Fix for msb.el
1258(defvar cperl-msb-fixed nil)
83261a2f
SM
1259(defvar cperl-use-major-mode 'cperl-mode)
1260
f83d2997
KH
1261;;;###autoload
1262(defun cperl-mode ()
1263 "Major mode for editing Perl code.
1264Expression and list commands understand all C brackets.
1265Tab indents for Perl code.
1266Paragraphs are separated by blank lines only.
1267Delete converts tabs to spaces as it moves back.
1268
1269Various characters in Perl almost always come in pairs: {}, (), [],
1270sometimes <>. When the user types the first, she gets the second as
1271well, with optional special formatting done on {}. (Disabled by
1272default.) You can always quote (with \\[quoted-insert]) the left
1273\"paren\" to avoid the expansion. The processing of < is special,
f94a632a 1274since most the time you mean \"less\". CPerl mode tries to guess
f83d2997
KH
1275whether you want to type pair <>, and inserts is if it
1276appropriate. You can set `cperl-electric-parens-string' to the string that
1277contains the parenths from the above list you want to be electrical.
1278Electricity of parenths is controlled by `cperl-electric-parens'.
1279You may also set `cperl-electric-parens-mark' to have electric parens
1280look for active mark and \"embrace\" a region if possible.'
1281
1282CPerl mode provides expansion of the Perl control constructs:
db133cb6 1283
5c8b7eaf 1284 if, else, elsif, unless, while, until, continue, do,
db133cb6
RS
1285 for, foreach, formy and foreachmy.
1286
1287and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1288
1289The user types the keyword immediately followed by a space, which
1290causes the construct to be expanded, and the point is positioned where
1291she is most likely to want to be. eg. when the user types a space
1292following \"if\" the following appears in the buffer: if () { or if ()
1293} { } and the cursor is between the parentheses. The user can then
1294type some boolean expression within the parens. Having done that,
1295typing \\[cperl-linefeed] places you - appropriately indented - on a
1296new line between the braces (if you typed \\[cperl-linefeed] in a POD
5c8b7eaf 1297directive line, then appropriate number of new lines is inserted).
db133cb6
RS
1298
1299If CPerl decides that you want to insert \"English\" style construct like
1300
f83d2997 1301 bite if angry;
db133cb6
RS
1302
1303it will not do any expansion. See also help on variable
1304`cperl-extra-newline-before-brace'. (Note that one can switch the
1305help message on expansion by setting `cperl-message-electric-keyword'
1306to nil.)
f83d2997
KH
1307
1308\\[cperl-linefeed] is a convenience replacement for typing carriage
1309return. It places you in the next line with proper indentation, or if
1310you type it inside the inline block of control construct, like
db133cb6 1311
f83d2997 1312 foreach (@lines) {print; print}
db133cb6 1313
f83d2997
KH
1314and you are on a boundary of a statement inside braces, it will
1315transform the construct into a multiline and will place you into an
5c8b7eaf 1316appropriately indented blank line. If you need a usual
6292d528 1317`newline-and-indent' behavior, it is on \\[newline-and-indent],
f83d2997
KH
1318see documentation on `cperl-electric-linefeed'.
1319
db133cb6
RS
1320Use \\[cperl-invert-if-unless] to change a construction of the form
1321
1322 if (A) { B }
1323
1324into
1325
1326 B if A;
1327
f83d2997
KH
1328\\{cperl-mode-map}
1329
db133cb6
RS
1330Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1331\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1332on electric space between $ and {, `cperl-electric-parens-string' is
1333the string that contains parentheses that should be electric in CPerl
1334\(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
f83d2997
KH
1335setting `cperl-electric-keywords' enables electric expansion of
1336control structures in CPerl. `cperl-electric-linefeed' governs which
1337one of two linefeed behavior is preferable. You can enable all these
1338options simultaneously (recommended mode of use) by setting
1339`cperl-hairy' to t. In this case you can switch separate options off
db133cb6
RS
1340by setting them to `null'. Note that one may undo the extra
1341whitespace inserted by semis and braces in `auto-newline'-mode by
1342consequent \\[cperl-electric-backspace].
f83d2997
KH
1343
1344If your site has perl5 documentation in info format, you can use commands
1345\\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1346These keys run commands `cperl-info-on-current-command' and
1347`cperl-info-on-command', which one is which is controlled by variable
5c8b7eaf 1348`cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
db133cb6 1349\(in turn affected by `cperl-hairy').
f83d2997
KH
1350
1351Even if you have no info-format documentation, short one-liner-style
db133cb6
RS
1352help is available on \\[cperl-get-help], and one can run perldoc or
1353man via menu.
f83d2997 1354
db133cb6
RS
1355It is possible to show this help automatically after some idle time.
1356This is regulated by variable `cperl-lazy-help-time'. Default with
1357`cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1358secs idle time . It is also possible to switch this on/off from the
1359menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
f83d2997
KH
1360
1361Use \\[cperl-lineup] to vertically lineup some construction - put the
1362beginning of the region at the start of construction, and make region
1363span the needed amount of lines.
1364
1365Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
83261a2f 1366`cperl-pod-face', `cperl-pod-head-face' control processing of POD and
db133cb6
RS
1367here-docs sections. With capable Emaxen results of scan are used
1368for indentation too, otherwise they are used for highlighting only.
f83d2997
KH
1369
1370Variables controlling indentation style:
1371 `cperl-tab-always-indent'
1372 Non-nil means TAB in CPerl mode should always reindent the current line,
1373 regardless of where in the line point is when the TAB command is used.
db133cb6
RS
1374 `cperl-indent-left-aligned-comments'
1375 Non-nil means that the comment starting in leftmost column should indent.
f83d2997
KH
1376 `cperl-auto-newline'
1377 Non-nil means automatically newline before and after braces,
1378 and after colons and semicolons, inserted in Perl code. The following
1379 \\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf
SS
1380 Insertion after colons requires both this variable and
1381 `cperl-auto-newline-after-colon' set.
f83d2997
KH
1382 `cperl-auto-newline-after-colon'
1383 Non-nil means automatically newline even after colons.
1384 Subject to `cperl-auto-newline' setting.
1385 `cperl-indent-level'
1386 Indentation of Perl statements within surrounding block.
1387 The surrounding block's indentation is the indentation
1388 of the line on which the open-brace appears.
1389 `cperl-continued-statement-offset'
1390 Extra indentation given to a substatement, such as the
1391 then-clause of an if, or body of a while, or just a statement continuation.
1392 `cperl-continued-brace-offset'
1393 Extra indentation given to a brace that starts a substatement.
1394 This is in addition to `cperl-continued-statement-offset'.
1395 `cperl-brace-offset'
1396 Extra indentation for line if it starts with an open brace.
1397 `cperl-brace-imaginary-offset'
1398 An open brace following other text is treated as if it the line started
1399 this far to the right of the actual line indentation.
1400 `cperl-label-offset'
1401 Extra indentation for line that is a label.
1402 `cperl-min-label-indent'
1403 Minimal indentation for line that is a label.
1404
1405Settings for K&R and BSD indentation styles are
1406 `cperl-indent-level' 5 8
1407 `cperl-continued-statement-offset' 5 8
1408 `cperl-brace-offset' -5 -8
1409 `cperl-label-offset' -5 -8
1410
db133cb6
RS
1411CPerl knows several indentation styles, and may bulk set the
1412corresponding variables. Use \\[cperl-set-style] to do this. Use
1413\\[cperl-set-style-back] to restore the memorized preexisting values
1414\(both available from menu).
1415
1416If `cperl-indent-level' is 0, the statement after opening brace in
5c8b7eaf 1417column 0 is indented on
db133cb6 1418`cperl-brace-offset'+`cperl-continued-statement-offset'.
f83d2997
KH
1419
1420Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
db133cb6
RS
1421with no args.
1422
1423DO NOT FORGET to read micro-docs (available from `Perl' menu)
1424or as help on variables `cperl-tips', `cperl-problems',
f94a632a 1425`cperl-praise', `cperl-speed'."
f83d2997
KH
1426 (interactive)
1427 (kill-all-local-variables)
f83d2997
KH
1428 (use-local-map cperl-mode-map)
1429 (if (cperl-val 'cperl-electric-linefeed)
1430 (progn
1431 (local-set-key "\C-J" 'cperl-linefeed)
1432 (local-set-key "\C-C\C-J" 'newline-and-indent)))
db133cb6
RS
1433 (if (and
1434 (cperl-val 'cperl-clobber-lisp-bindings)
1435 (cperl-val 'cperl-info-on-command-no-prompt))
f83d2997
KH
1436 (progn
1437 ;; don't clobber the backspace binding:
1438 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1439 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1440 [(control c) (control h) f])))
83261a2f 1441 (setq major-mode cperl-use-major-mode)
f83d2997
KH
1442 (setq mode-name "CPerl")
1443 (if (not cperl-mode-abbrev-table)
1444 (let ((prev-a-c abbrevs-changed))
1445 (define-abbrev-table 'cperl-mode-abbrev-table '(
1446 ("if" "if" cperl-electric-keyword 0)
1447 ("elsif" "elsif" cperl-electric-keyword 0)
1448 ("while" "while" cperl-electric-keyword 0)
1449 ("until" "until" cperl-electric-keyword 0)
1450 ("unless" "unless" cperl-electric-keyword 0)
1451 ("else" "else" cperl-electric-else 0)
db133cb6 1452 ("continue" "continue" cperl-electric-else 0)
f83d2997
KH
1453 ("for" "for" cperl-electric-keyword 0)
1454 ("foreach" "foreach" cperl-electric-keyword 0)
db133cb6
RS
1455 ("formy" "formy" cperl-electric-keyword 0)
1456 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1457 ("do" "do" cperl-electric-keyword 0)
6c389151
SM
1458 ("=pod" "=pod" cperl-electric-pod 0)
1459 ("=over" "=over" cperl-electric-pod 0)
1460 ("=head1" "=head1" cperl-electric-pod 0)
1461 ("=head2" "=head2" cperl-electric-pod 0)
db133cb6
RS
1462 ("pod" "pod" cperl-electric-pod 0)
1463 ("over" "over" cperl-electric-pod 0)
1464 ("head1" "head1" cperl-electric-pod 0)
1465 ("head2" "head2" cperl-electric-pod 0)))
f83d2997
KH
1466 (setq abbrevs-changed prev-a-c)))
1467 (setq local-abbrev-table cperl-mode-abbrev-table)
1468 (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
1469 (set-syntax-table cperl-mode-syntax-table)
6c389151
SM
1470 (make-local-variable 'outline-regexp)
1471 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1472 (setq outline-regexp cperl-outline-regexp)
1473 (make-local-variable 'outline-level)
1474 (setq outline-level 'cperl-outline-level)
f83d2997
KH
1475 (make-local-variable 'paragraph-start)
1476 (setq paragraph-start (concat "^$\\|" page-delimiter))
1477 (make-local-variable 'paragraph-separate)
1478 (setq paragraph-separate paragraph-start)
1479 (make-local-variable 'paragraph-ignore-fill-prefix)
1480 (setq paragraph-ignore-fill-prefix t)
82eb0dae 1481 (set (make-local-variable 'fill-paragraph-function) 'cperl-fill-paragraph)
f83d2997
KH
1482 (make-local-variable 'indent-line-function)
1483 (setq indent-line-function 'cperl-indent-line)
1484 (make-local-variable 'require-final-newline)
7d441781 1485 (setq require-final-newline mode-require-final-newline)
f83d2997
KH
1486 (make-local-variable 'comment-start)
1487 (setq comment-start "# ")
1488 (make-local-variable 'comment-end)
1489 (setq comment-end "")
1490 (make-local-variable 'comment-column)
1491 (setq comment-column cperl-comment-column)
1492 (make-local-variable 'comment-start-skip)
1493 (setq comment-start-skip "#+ *")
1494 (make-local-variable 'defun-prompt-regexp)
defa8e19 1495 (setq defun-prompt-regexp "^[ \t]*sub[ \t\n]+\\([^ \t\n{(;]+\\)\\([ \t\n]*([^()]*)[ \t\n]*\\)?[ \t\n]*")
f83d2997
KH
1496 (make-local-variable 'comment-indent-function)
1497 (setq comment-indent-function 'cperl-comment-indent)
1498 (make-local-variable 'parse-sexp-ignore-comments)
1499 (setq parse-sexp-ignore-comments t)
1500 (make-local-variable 'indent-region-function)
1501 (setq indent-region-function 'cperl-indent-region)
1502 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1503 (make-local-variable 'imenu-create-index-function)
1504 (setq imenu-create-index-function
80585273 1505 (function cperl-imenu--create-perl-index))
f83d2997
KH
1506 (make-local-variable 'imenu-sort-function)
1507 (setq imenu-sort-function nil)
e1a5828f
AS
1508 (make-local-variable 'vc-rcs-header)
1509 (set 'vc-rcs-header cperl-vc-rcs-header)
1510 (make-local-variable 'vc-sccs-header)
1511 (set 'vc-sccs-header cperl-vc-sccs-header)
f83d2997
KH
1512 (make-local-variable 'font-lock-defaults)
1513 (setq font-lock-defaults
db133cb6
RS
1514 (cond
1515 ((string< emacs-version "19.30")
5efe6a56 1516 '(cperl-font-lock-keywords-2))
db133cb6 1517 ((string< emacs-version "19.33") ; Which one to use?
5efe6a56
SM
1518 '((cperl-font-lock-keywords
1519 cperl-font-lock-keywords-1
1520 cperl-font-lock-keywords-2)))
db133cb6
RS
1521 (t
1522 '((cperl-load-font-lock-keywords
1523 cperl-load-font-lock-keywords-1
00424a9e
SM
1524 cperl-load-font-lock-keywords-2)
1525 nil nil ((?_ . "w"))))))
db133cb6 1526 (make-local-variable 'cperl-syntax-state)
f83d2997
KH
1527 (if cperl-use-syntax-table-text-property
1528 (progn
029cb4d5 1529 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997 1530 ;; Do not introduce variable if not needed, we check it!
db133cb6
RS
1531 (set 'parse-sexp-lookup-properties t)
1532 ;; Fix broken font-lock:
1533 (or (boundp 'font-lock-unfontify-region-function)
1534 (set 'font-lock-unfontify-region-function
83261a2f 1535 'font-lock-default-unfontify-region))
029cb4d5 1536 (make-local-variable 'font-lock-unfontify-region-function)
83261a2f 1537 (set 'font-lock-unfontify-region-function ; not present with old Emacs
db133cb6 1538 'cperl-font-lock-unfontify-region-function)
029cb4d5 1539 (make-local-variable 'cperl-syntax-done-to)
029cb4d5 1540 (make-local-variable 'font-lock-syntactic-keywords)
5c8b7eaf 1541 (setq font-lock-syntactic-keywords
db133cb6 1542 (if cperl-syntaxify-by-font-lock
11b41e6f
SM
1543 '((cperl-fontify-syntaxically))
1544 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1545 ;; used to ignore syntax-table text-properties. (t) is a hack
1546 ;; to make font-lock think that font-lock-syntactic-keywords
1547 ;; are defined.
db133cb6
RS
1548 '(t)))))
1549 (make-local-variable 'cperl-old-style)
83261a2f
SM
1550 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1551 (set (make-local-variable 'normal-auto-fill-function)
1552 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
1553 (or (fboundp 'cperl-old-auto-fill-mode)
1554 (progn
1555 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1556 (defun auto-fill-mode (&optional arg)
1557 (interactive "P")
1558 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1559 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1560 (setq auto-fill-function 'cperl-do-auto-fill))))))
f83d2997 1561 (if (cperl-enable-font-lock)
5c8b7eaf 1562 (if (cperl-val 'cperl-font-lock)
f83d2997
KH
1563 (progn (or cperl-faces-init (cperl-init-faces))
1564 (font-lock-mode 1))))
1565 (and (boundp 'msb-menu-cond)
1566 (not cperl-msb-fixed)
1567 (cperl-msb-fix))
1568 (if (featurep 'easymenu)
46c72468 1569 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
a3c328ee 1570 (run-mode-hooks 'cperl-mode-hook)
f83d2997 1571 ;; After hooks since fontification will break this
5c8b7eaf 1572 (if cperl-pod-here-scan
83261a2f 1573 (or cperl-syntaxify-by-font-lock
5bd52f0e
RS
1574 (progn (or cperl-faces-init (cperl-init-faces-weak))
1575 (cperl-find-pods-heres)))))
f83d2997
KH
1576\f
1577;; Fix for perldb - make default reasonable
1578(defun cperl-db ()
1579 (interactive)
1580 (require 'gud)
1581 (perldb (read-from-minibuffer "Run perldb (like this): "
1582 (if (consp gud-perldb-history)
1583 (car gud-perldb-history)
1584 (concat "perl " ;;(file-name-nondirectory
83261a2f
SM
1585 ;; I have problems
1586 ;; in OS/2
1587 ;; otherwise
1588 (buffer-file-name)))
f83d2997
KH
1589 nil nil
1590 '(gud-perldb-history . 1))))
1591\f
f83d2997
KH
1592(defun cperl-msb-fix ()
1593 ;; Adds perl files to msb menu, supposes that msb is already loaded
1594 (setq cperl-msb-fixed t)
1595 (let* ((l (length msb-menu-cond))
1596 (last (nth (1- l) msb-menu-cond))
1597 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1598 (handle (1- (nth 1 last))))
1599 (setcdr precdr (list
1600 (list
996e2616 1601 '(memq major-mode '(cperl-mode perl-mode))
f83d2997
KH
1602 handle
1603 "Perl Files (%d)")
1604 last))))
1605\f
1606;; This is used by indent-for-comment
1607;; to decide how much to indent a comment in CPerl code
1608;; based on its context. Do fallback if comment is found wrong.
1609
1610(defvar cperl-wrong-comment)
5bd52f0e
RS
1611(defvar cperl-st-cfence '(14)) ; Comment-fence
1612(defvar cperl-st-sfence '(15)) ; String-fence
1613(defvar cperl-st-punct '(1))
1614(defvar cperl-st-word '(2))
1615(defvar cperl-st-bra '(4 . ?\>))
1616(defvar cperl-st-ket '(5 . ?\<))
1617
f83d2997
KH
1618
1619(defun cperl-comment-indent ()
5bd52f0e 1620 (let ((p (point)) (c (current-column)) was phony)
f83d2997
KH
1621 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
1622 ;; Wrong comment found
1623 (save-excursion
5bd52f0e
RS
1624 (setq was (cperl-to-comment-or-eol)
1625 phony (eq (get-text-property (point) 'syntax-table)
1626 cperl-st-cfence))
1627 (if phony
1628 (progn
1629 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1630 (if (eq (preceding-char) ?\#)
1631 (forward-char -1))
1632 (setq was nil)))
f83d2997
KH
1633 (if (= (point) p)
1634 (progn
1635 (skip-chars-backward " \t")
1636 (max (1+ (current-column)) ; Else indent at comment column
1637 comment-column))
1638 (if was nil
1639 (insert comment-start)
1640 (backward-char (length comment-start)))
1641 (setq cperl-wrong-comment t)
1642 (indent-to comment-column 1) ; Indent minimum 1
1643 c))))) ; except leave at least one space.
1644
1645;;;(defun cperl-comment-indent-fallback ()
1646;;; "Is called if the standard comment-search procedure fails.
1647;;;Point is at start of real comment."
1648;;; (let ((c (current-column)) target cnt prevc)
1649;;; (if (= c comment-column) nil
1650;;; (setq cnt (skip-chars-backward "[ \t]"))
5c8b7eaf 1651;;; (setq target (max (1+ (setq prevc
f83d2997
KH
1652;;; (current-column))) ; Else indent at comment column
1653;;; comment-column))
1654;;; (if (= c comment-column) nil
1655;;; (delete-backward-char cnt)
1656;;; (while (< prevc target)
1657;;; (insert "\t")
1658;;; (setq prevc (current-column)))
1659;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1660;;; (while (< prevc target)
1661;;; (insert " ")
1662;;; (setq prevc (current-column)))))))
1663
1664(defun cperl-indent-for-comment ()
1665 "Substitute for `indent-for-comment' in CPerl."
1666 (interactive)
1667 (let (cperl-wrong-comment)
1668 (indent-for-comment)
1669 (if cperl-wrong-comment
1670 (progn (cperl-to-comment-or-eol)
1671 (forward-char (length comment-start))))))
1672
1673(defun cperl-comment-region (b e arg)
1674 "Comment or uncomment each line in the region in CPerl mode.
1675See `comment-region'."
1676 (interactive "r\np")
1677 (let ((comment-start "#"))
1678 (comment-region b e arg)))
1679
1680(defun cperl-uncomment-region (b e arg)
1681 "Uncomment or comment each line in the region in CPerl mode.
1682See `comment-region'."
1683 (interactive "r\np")
1684 (let ((comment-start "#"))
1685 (comment-region b e (- arg))))
1686
1687(defvar cperl-brace-recursing nil)
1688
1689(defun cperl-electric-brace (arg &optional only-before)
1690 "Insert character and correct line's indentation.
1691If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1692place (even in empty line), but not after. If after \")\" and the inserted
5c8b7eaf 1693char is \"{\", insert extra newline before only if
f83d2997
KH
1694`cperl-extra-newline-before-brace'."
1695 (interactive "P")
1696 (let (insertpos
1697 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 1698 (cperl-mark-active)
f83d2997 1699 (< (mark) (point)))
5c8b7eaf 1700 (mark)
f83d2997
KH
1701 nil)))
1702 (if (and other-end
1703 (not cperl-brace-recursing)
1704 (cperl-val 'cperl-electric-parens)
1705 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
1706 ;; Need to insert a matching pair
1707 (progn
1708 (save-excursion
1709 (setq insertpos (point-marker))
1710 (goto-char other-end)
1711 (setq last-command-char ?\{)
1712 (cperl-electric-lbrace arg insertpos))
1713 (forward-char 1))
83261a2f 1714 ;; Check whether we close something "usual" with `}'
db133cb6 1715 (if (and (eq last-command-char ?\})
5c8b7eaf 1716 (not
db133cb6
RS
1717 (condition-case nil
1718 (save-excursion
1719 (up-list (- (prefix-numeric-value arg)))
1720 ;;(cperl-after-block-p (point-min))
f739b53b
SM
1721 (or (cperl-after-expr-p nil "{;)")
1722 ;; after sub, else, continue
1723 (cperl-after-block-p nil 'pre)))
db133cb6
RS
1724 (error nil))))
1725 ;; Just insert the guy
1726 (self-insert-command (prefix-numeric-value arg))
1727 (if (and (not arg) ; No args, end (of empty line or auto)
1728 (eolp)
1729 (or (and (null only-before)
1730 (save-excursion
1731 (skip-chars-backward " \t")
1732 (bolp)))
1733 (and (eq last-command-char ?\{) ; Do not insert newline
1734 ;; if after ")" and `cperl-extra-newline-before-brace'
1735 ;; is nil, do not insert extra newline.
1736 (not cperl-extra-newline-before-brace)
1737 (save-excursion
1738 (skip-chars-backward " \t")
1739 (eq (preceding-char) ?\))))
5c8b7eaf 1740 (if cperl-auto-newline
db133cb6
RS
1741 (progn (cperl-indent-line) (newline) t) nil)))
1742 (progn
1743 (self-insert-command (prefix-numeric-value arg))
1744 (cperl-indent-line)
1745 (if cperl-auto-newline
1746 (setq insertpos (1- (point))))
1747 (if (and cperl-auto-newline (null only-before))
1748 (progn
1749 (newline)
1750 (cperl-indent-line)))
1751 (save-excursion
1752 (if insertpos (progn (goto-char insertpos)
5c8b7eaf 1753 (search-forward (make-string
db133cb6
RS
1754 1 last-command-char))
1755 (setq insertpos (1- (point)))))
1756 (delete-char -1))))
1757 (if insertpos
f83d2997 1758 (save-excursion
db133cb6
RS
1759 (goto-char insertpos)
1760 (self-insert-command (prefix-numeric-value arg)))
1761 (self-insert-command (prefix-numeric-value arg)))))))
f83d2997
KH
1762
1763(defun cperl-electric-lbrace (arg &optional end)
1764 "Insert character, correct line's indentation, correct quoting by space."
1765 (interactive "P")
83261a2f
SM
1766 (let ((cperl-brace-recursing t)
1767 (cperl-auto-newline cperl-auto-newline)
1768 (other-end (or end
1769 (if (and cperl-electric-parens-mark
1770 (cperl-mark-active)
1771 (> (mark) (point)))
1772 (save-excursion
1773 (goto-char (mark))
1774 (point-marker))
1775 nil)))
1776 pos after)
f83d2997
KH
1777 (and (cperl-val 'cperl-electric-lbrace-space)
1778 (eq (preceding-char) ?$)
1779 (save-excursion
1780 (skip-chars-backward "$")
1781 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
b5b0cb34 1782 (insert ?\s))
bab27c0c 1783 ;; Check whether we are in comment
5c8b7eaf 1784 (if (and
bab27c0c
RS
1785 (save-excursion
1786 (beginning-of-line)
1787 (not (looking-at "[ \t]*#")))
1788 (cperl-after-expr-p nil "{;)"))
1789 nil
1790 (setq cperl-auto-newline nil))
f83d2997
KH
1791 (cperl-electric-brace arg)
1792 (and (cperl-val 'cperl-electric-parens)
1793 (eq last-command-char ?{)
5c8b7eaf 1794 (memq last-command-char
f83d2997
KH
1795 (append cperl-electric-parens-string nil))
1796 (or (if other-end (goto-char (marker-position other-end)))
1797 t)
1798 (setq last-command-char ?} pos (point))
1799 (progn (cperl-electric-brace arg t)
1800 (goto-char pos)))))
1801
1802(defun cperl-electric-paren (arg)
f739b53b
SM
1803 "Insert an opening parenthesis or a matching pair of parentheses.
1804See `cperl-electric-parens'."
f83d2997
KH
1805 (interactive "P")
1806 (let ((beg (save-excursion (beginning-of-line) (point)))
1807 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 1808 (cperl-mark-active)
f83d2997 1809 (> (mark) (point)))
83261a2f
SM
1810 (save-excursion
1811 (goto-char (mark))
1812 (point-marker))
f83d2997
KH
1813 nil)))
1814 (if (and (cperl-val 'cperl-electric-parens)
1815 (memq last-command-char
1816 (append cperl-electric-parens-string nil))
1817 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1818 ;;(not (save-excursion (search-backward "#" beg t)))
1819 (if (eq last-command-char ?<)
1820 (progn
1821 (and abbrev-mode ; later it is too late, may be after `for'
1822 (expand-abbrev))
1823 (cperl-after-expr-p nil "{;(,:="))
1824 1))
1825 (progn
1826 (self-insert-command (prefix-numeric-value arg))
1827 (if other-end (goto-char (marker-position other-end)))
5c8b7eaf 1828 (insert (make-string
f83d2997
KH
1829 (prefix-numeric-value arg)
1830 (cdr (assoc last-command-char '((?{ .?})
1831 (?[ . ?])
1832 (?( . ?))
1833 (?< . ?>))))))
1834 (forward-char (- (prefix-numeric-value arg))))
1835 (self-insert-command (prefix-numeric-value arg)))))
1836
1837(defun cperl-electric-rparen (arg)
1838 "Insert a matching pair of parentheses if marking is active.
f739b53b
SM
1839If not, or if we are not at the end of marking range, would self-insert.
1840Affected by `cperl-electric-parens'."
f83d2997
KH
1841 (interactive "P")
1842 (let ((beg (save-excursion (beginning-of-line) (point)))
1843 (other-end (if (and cperl-electric-parens-mark
1844 (cperl-val 'cperl-electric-parens)
1845 (memq last-command-char
1846 (append cperl-electric-parens-string nil))
5c8b7eaf 1847 (cperl-mark-active)
f83d2997 1848 (< (mark) (point)))
5c8b7eaf 1849 (mark)
f83d2997
KH
1850 nil))
1851 p)
1852 (if (and other-end
1853 (cperl-val 'cperl-electric-parens)
1854 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
1855 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1856 ;;(not (save-excursion (search-backward "#" beg t)))
1857 )
1858 (progn
1859 (self-insert-command (prefix-numeric-value arg))
1860 (setq p (point))
1861 (if other-end (goto-char other-end))
1862 (insert (make-string
1863 (prefix-numeric-value arg)
1864 (cdr (assoc last-command-char '((?\} . ?\{)
83261a2f
SM
1865 (?\] . ?\[)
1866 (?\) . ?\()
1867 (?\> . ?\<))))))
f83d2997
KH
1868 (goto-char (1+ p)))
1869 (self-insert-command (prefix-numeric-value arg)))))
1870
1871(defun cperl-electric-keyword ()
db133cb6
RS
1872 "Insert a construction appropriate after a keyword.
1873Help message may be switched off by setting `cperl-message-electric-keyword'
1874to nil."
5c8b7eaf 1875 (let ((beg (save-excursion (beginning-of-line) (point)))
f83d2997
KH
1876 (dollar (and (eq last-command-char ?$)
1877 (eq this-command 'self-insert-command)))
b5b0cb34 1878 (delete (and (memq last-command-char '(?\s ?\n ?\t ?\f))
db133cb6
RS
1879 (memq this-command '(self-insert-command newline))))
1880 my do)
f83d2997 1881 (and (save-excursion
db133cb6
RS
1882 (condition-case nil
1883 (progn
1884 (backward-sexp 1)
1885 (setq do (looking-at "do\\>")))
1886 (error nil))
f83d2997 1887 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
1888 (save-excursion
1889 (not
f83d2997 1890 (re-search-backward
5bd52f0e 1891 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
1892 beg t)))
1893 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
1894 (or
1895 (looking-at "=cut")
1896 (and cperl-use-syntax-table-text-property
1897 (not (eq (get-text-property (point)
1898 'syntax-type)
1899 'pod))))))
f739b53b
SM
1900 (save-excursion (forward-sexp -1)
1901 (not (memq (following-char) (append "$@%&*" nil))))
f83d2997 1902 (progn
db133cb6
RS
1903 (and (eq (preceding-char) ?y)
1904 (progn ; "foreachmy"
1905 (forward-char -2)
1906 (insert " ")
1907 (forward-char 2)
5c8b7eaf
SS
1908 (setq my t dollar t
1909 delete
db133cb6 1910 (memq this-command '(self-insert-command newline)))))
f83d2997
KH
1911 (and dollar (insert " $"))
1912 (cperl-indent-line)
1913 ;;(insert " () {\n}")
1914 (cond
1915 (cperl-extra-newline-before-brace
db133cb6 1916 (insert (if do "\n" " ()\n"))
f83d2997
KH
1917 (insert "{")
1918 (cperl-indent-line)
1919 (insert "\n")
1920 (cperl-indent-line)
db133cb6
RS
1921 (insert "\n}")
1922 (and do (insert " while ();")))
f83d2997 1923 (t
83261a2f 1924 (insert (if do " {\n} while ();" " () {\n}"))))
f83d2997
KH
1925 (or (looking-at "[ \t]\\|$") (insert " "))
1926 (cperl-indent-line)
1927 (if dollar (progn (search-backward "$")
5c8b7eaf 1928 (if my
db133cb6
RS
1929 (forward-char 1)
1930 (delete-char 1)))
f739b53b
SM
1931 (search-backward ")")
1932 (if (eq last-command-char ?\()
1933 (progn ; Avoid "if (())"
1934 (delete-backward-char 1)
1935 (delete-backward-char -1))))
f83d2997 1936 (if delete
db133cb6
RS
1937 (cperl-putback-char cperl-del-back-ch))
1938 (if cperl-message-electric-keyword
1939 (message "Precede char by C-q to avoid expansion"))))))
1940
1941(defun cperl-ensure-newlines (n &optional pos)
1942 "Make sure there are N newlines after the point."
1943 (or pos (setq pos (point)))
1944 (if (looking-at "\n")
1945 (forward-char 1)
1946 (insert "\n"))
1947 (if (> n 1)
1948 (cperl-ensure-newlines (1- n) pos)
1949 (goto-char pos)))
1950
1951(defun cperl-electric-pod ()
1952 "Insert a POD chunk appropriate after a =POD directive."
b5b0cb34 1953 (let ((delete (and (memq last-command-char '(?\s ?\n ?\t ?\f))
db133cb6
RS
1954 (memq this-command '(self-insert-command newline))))
1955 head1 notlast name p really-delete over)
1956 (and (save-excursion
6c389151 1957 (forward-word -1)
a1506d29 1958 (and
db133cb6
RS
1959 (eq (preceding-char) ?=)
1960 (progn
6c389151
SM
1961 (setq head1 (looking-at "head1\\>[ \t]*$"))
1962 (setq over (and (looking-at "over\\>[ \t]*$")
1963 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
db133cb6
RS
1964 (forward-char -1)
1965 (bolp))
5c8b7eaf 1966 (or
5bd52f0e 1967 (get-text-property (point) 'in-pod)
db133cb6
RS
1968 (cperl-after-expr-p nil "{;:")
1969 (and (re-search-backward
a1506d29
JB
1970 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
1971 "\\(\\`\n?\\|^\n\\)=\\sw+"
6c389151 1972 (point-min) t)
db133cb6
RS
1973 (not (or
1974 (looking-at "=cut")
1975 (and cperl-use-syntax-table-text-property
1976 (not (eq (get-text-property (point) 'syntax-type)
1977 'pod)))))))))
1978 (progn
1979 (save-excursion
6c389151 1980 (setq notlast (re-search-forward "^\n=" nil t)))
db133cb6
RS
1981 (or notlast
1982 (progn
1983 (insert "\n\n=cut")
1984 (cperl-ensure-newlines 2)
6c389151 1985 (forward-word -2)
a1506d29
JB
1986 (if (and head1
1987 (not
db133cb6
RS
1988 (save-excursion
1989 (forward-char -1)
1990 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
83261a2f 1991 nil t)))) ; Only one
a1506d29 1992 (progn
6c389151 1993 (forward-word 1)
db133cb6
RS
1994 (setq name (file-name-sans-extension
1995 (file-name-nondirectory (buffer-file-name)))
1996 p (point))
5c8b7eaf 1997 (insert " NAME\n\n" name
029cb4d5 1998 " - \n\n=head1 SYNOPSIS\n\n\n\n"
db133cb6
RS
1999 "=head1 DESCRIPTION")
2000 (cperl-ensure-newlines 4)
2001 (goto-char p)
6c389151 2002 (forward-word 2)
db133cb6
RS
2003 (end-of-line)
2004 (setq really-delete t))
6c389151 2005 (forward-word 1))))
db133cb6
RS
2006 (if over
2007 (progn
2008 (setq p (point))
2009 (insert "\n\n=item \n\n\n\n"
2010 "=back")
2011 (cperl-ensure-newlines 2)
2012 (goto-char p)
6c389151 2013 (forward-word 1)
db133cb6
RS
2014 (end-of-line)
2015 (setq really-delete t)))
2016 (if (and delete really-delete)
f83d2997
KH
2017 (cperl-putback-char cperl-del-back-ch))))))
2018
2019(defun cperl-electric-else ()
db133cb6
RS
2020 "Insert a construction appropriate after a keyword.
2021Help message may be switched off by setting `cperl-message-electric-keyword'
2022to nil."
f83d2997
KH
2023 (let ((beg (save-excursion (beginning-of-line) (point))))
2024 (and (save-excursion
2025 (backward-sexp 1)
2026 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
2027 (save-excursion
2028 (not
f83d2997 2029 (re-search-backward
5bd52f0e 2030 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
2031 beg t)))
2032 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
2033 (looking-at "=cut")
2034 (and cperl-use-syntax-table-text-property
2035 (not (eq (get-text-property (point)
2036 'syntax-type)
2037 'pod)))))
f83d2997
KH
2038 (progn
2039 (cperl-indent-line)
2040 ;;(insert " {\n\n}")
2041 (cond
2042 (cperl-extra-newline-before-brace
2043 (insert "\n")
2044 (insert "{")
2045 (cperl-indent-line)
2046 (insert "\n\n}"))
2047 (t
83261a2f 2048 (insert " {\n\n}")))
f83d2997
KH
2049 (or (looking-at "[ \t]\\|$") (insert " "))
2050 (cperl-indent-line)
2051 (forward-line -1)
2052 (cperl-indent-line)
db133cb6
RS
2053 (cperl-putback-char cperl-del-back-ch)
2054 (setq this-command 'cperl-electric-else)
2055 (if cperl-message-electric-keyword
2056 (message "Precede char by C-q to avoid expansion"))))))
f83d2997
KH
2057
2058(defun cperl-linefeed ()
db133cb6
RS
2059 "Go to end of line, open a new line and indent appropriately.
2060If in POD, insert appropriate lines."
f83d2997
KH
2061 (interactive)
2062 (let ((beg (save-excursion (beginning-of-line) (point)))
2063 (end (save-excursion (end-of-line) (point)))
db133cb6 2064 (pos (point)) start over cut res)
f83d2997 2065 (if (and ; Check if we need to split:
5c8b7eaf 2066 ; i.e., on a boundary and inside "{...}"
f83d2997 2067 (save-excursion (cperl-to-comment-or-eol)
83261a2f 2068 (>= (point) pos)) ; Not in a comment
f83d2997
KH
2069 (or (save-excursion
2070 (skip-chars-backward " \t" beg)
2071 (forward-char -1)
2072 (looking-at "[;{]")) ; After { or ; + spaces
2073 (looking-at "[ \t]*}") ; Before }
2074 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2075 (save-excursion
2076 (and
5c8b7eaf 2077 (eq (car (parse-partial-sexp pos end -1)) -1)
f83d2997
KH
2078 ; Leave the level of parens
2079 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2080 ; Are at end
6c389151 2081 (cperl-after-block-p (point-min))
f83d2997
KH
2082 (progn
2083 (backward-sexp 1)
2084 (setq start (point-marker))
db133cb6 2085 (<= start pos))))) ; Redundant? Are after the
f83d2997
KH
2086 ; start of parens group.
2087 (progn
2088 (skip-chars-backward " \t")
2089 (or (memq (preceding-char) (append ";{" nil))
2090 (insert ";"))
2091 (insert "\n")
2092 (forward-line -1)
2093 (cperl-indent-line)
2094 (goto-char start)
2095 (or (looking-at "{[ \t]*$") ; If there is a statement
2096 ; before, move it to separate line
2097 (progn
2098 (forward-char 1)
2099 (insert "\n")
2100 (cperl-indent-line)))
2101 (forward-line 1) ; We are on the target line
2102 (cperl-indent-line)
2103 (beginning-of-line)
2104 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
83261a2f 2105 ; after, move it to separate line
f83d2997
KH
2106 (progn
2107 (end-of-line)
2108 (search-backward "}" beg)
2109 (skip-chars-backward " \t")
2110 (or (memq (preceding-char) (append ";{" nil))
2111 (insert ";"))
2112 (insert "\n")
2113 (cperl-indent-line)
2114 (forward-line -1)))
5c8b7eaf 2115 (forward-line -1) ; We are on the line before target
f83d2997
KH
2116 (end-of-line)
2117 (newline-and-indent))
db133cb6 2118 (end-of-line) ; else - no splitting
f83d2997
KH
2119 (cond
2120 ((and (looking-at "\n[ \t]*{$")
2121 (save-excursion
2122 (skip-chars-backward " \t")
2123 (eq (preceding-char) ?\)))) ; Probably if () {} group
83261a2f 2124 ; with an extra newline.
f83d2997
KH
2125 (forward-line 2)
2126 (cperl-indent-line))
db133cb6
RS
2127 ((save-excursion ; In POD header
2128 (forward-paragraph -1)
2129 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2130 ;; We are after \n now, so look for the rest
2131 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
5c8b7eaf 2132 (progn
db133cb6
RS
2133 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2134 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2135 t)))
2136 (if (and over
2137 (progn
2138 (forward-paragraph -1)
2139 (forward-word 1)
2140 (setq pos (point))
2141 (setq cut (buffer-substring (point)
2142 (save-excursion
2143 (end-of-line)
2144 (point))))
2145 (delete-char (- (save-excursion (end-of-line) (point))
2146 (point)))
2147 (setq res (expand-abbrev))
2148 (save-excursion
2149 (goto-char pos)
2150 (insert cut))
2151 res))
2152 nil
2153 (cperl-ensure-newlines (if cut 2 4))
2154 (forward-line 2)))
2155 ((get-text-property (point) 'in-pod) ; In POD section
2156 (cperl-ensure-newlines 4)
2157 (forward-line 2))
f83d2997
KH
2158 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2159 (forward-line 1)
2160 (cperl-indent-line))
2161 (t
2162 (newline-and-indent))))))
2163
2164(defun cperl-electric-semi (arg)
2165 "Insert character and correct line's indentation."
2166 (interactive "P")
2167 (if cperl-auto-newline
2168 (cperl-electric-terminator arg)
6c389151
SM
2169 (self-insert-command (prefix-numeric-value arg))
2170 (if cperl-autoindent-on-semi
2171 (cperl-indent-line))))
f83d2997
KH
2172
2173(defun cperl-electric-terminator (arg)
2174 "Insert character and correct line's indentation."
2175 (interactive "P")
83261a2f
SM
2176 (let ((end (point))
2177 (auto (and cperl-auto-newline
2178 (or (not (eq last-command-char ?:))
2179 cperl-auto-newline-after-colon)))
2180 insertpos)
5c8b7eaf 2181 (if (and ;;(not arg)
f83d2997
KH
2182 (eolp)
2183 (not (save-excursion
2184 (beginning-of-line)
2185 (skip-chars-forward " \t")
2186 (or
2187 ;; Ignore in comment lines
2188 (= (following-char) ?#)
2189 ;; Colon is special only after a label
2190 ;; So quickly rule out most other uses of colon
2191 ;; and do no indentation for them.
2192 (and (eq last-command-char ?:)
2193 (save-excursion
2194 (forward-word 1)
2195 (skip-chars-forward " \t")
2196 (and (< (point) end)
2197 (progn (goto-char (- end 1))
2198 (not (looking-at ":"))))))
2199 (progn
2200 (beginning-of-defun)
2201 (let ((pps (parse-partial-sexp (point) end)))
2202 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2203 (progn
2204 (self-insert-command (prefix-numeric-value arg))
2205 ;;(forward-char -1)
2206 (if auto (setq insertpos (point-marker)))
2207 ;;(forward-char 1)
2208 (cperl-indent-line)
2209 (if auto
2210 (progn
2211 (newline)
2212 (cperl-indent-line)))
f83d2997
KH
2213 (save-excursion
2214 (if insertpos (goto-char (1- (marker-position insertpos)))
2215 (forward-char -1))
2216 (delete-char 1))))
2217 (if insertpos
2218 (save-excursion
2219 (goto-char insertpos)
2220 (self-insert-command (prefix-numeric-value arg)))
2221 (self-insert-command (prefix-numeric-value arg)))))
2222
2223(defun cperl-electric-backspace (arg)
f739b53b
SM
2224 "Backspace, or remove the whitespace around the point inserted by an electric
2225key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
f83d2997 2226 (interactive "p")
5c8b7eaf
SS
2227 (if (and cperl-auto-newline
2228 (memq last-command '(cperl-electric-semi
f83d2997
KH
2229 cperl-electric-terminator
2230 cperl-electric-lbrace))
b5b0cb34 2231 (memq (preceding-char) '(?\s ?\t ?\n)))
f83d2997 2232 (let (p)
5c8b7eaf 2233 (if (eq last-command 'cperl-electric-lbrace)
f83d2997
KH
2234 (skip-chars-forward " \t\n"))
2235 (setq p (point))
2236 (skip-chars-backward " \t\n")
2237 (delete-region (point) p))
db133cb6
RS
2238 (and (eq last-command 'cperl-electric-else)
2239 ;; We are removing the whitespace *inside* cperl-electric-else
2240 (setq this-command 'cperl-electric-else-really))
5c8b7eaf 2241 (if (and cperl-auto-newline
db133cb6 2242 (eq last-command 'cperl-electric-else-really)
b5b0cb34 2243 (memq (preceding-char) '(?\s ?\t ?\n)))
db133cb6
RS
2244 (let (p)
2245 (skip-chars-forward " \t\n")
2246 (setq p (point))
2247 (skip-chars-backward " \t\n")
2248 (delete-region (point) p))
f739b53b
SM
2249 (if cperl-electric-backspace-untabify
2250 (backward-delete-char-untabify arg)
2251 (delete-backward-char arg)))))
f83d2997 2252
d6156ce8
KS
2253(put 'cperl-electric-backspace 'delete-selection 'supersede)
2254
f83d2997
KH
2255(defun cperl-inside-parens-p ()
2256 (condition-case ()
2257 (save-excursion
2258 (save-restriction
2259 (narrow-to-region (point)
2260 (progn (beginning-of-defun) (point)))
2261 (goto-char (point-max))
2262 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2263 (error nil)))
2264\f
2265(defun cperl-indent-command (&optional whole-exp)
2266 "Indent current line as Perl code, or in some cases insert a tab character.
5c8b7eaf 2267If `cperl-tab-always-indent' is non-nil (the default), always indent current
db133cb6 2268line. Otherwise, indent the current line only if point is at the left margin
f83d2997
KH
2269or in the line's indentation; otherwise insert a tab.
2270
2271A numeric argument, regardless of its value,
2272means indent rigidly all the lines of the expression starting after point
2273so that this line becomes properly indented.
2274The relative indentation among the lines of the expression are preserved."
2275 (interactive "P")
5bd52f0e 2276 (cperl-update-syntaxification (point) (point))
f83d2997
KH
2277 (if whole-exp
2278 ;; If arg, always indent this line as Perl
2279 ;; and shift remaining lines of expression the same amount.
2280 (let ((shift-amt (cperl-indent-line))
2281 beg end)
2282 (save-excursion
2283 (if cperl-tab-always-indent
2284 (beginning-of-line))
2285 (setq beg (point))
2286 (forward-sexp 1)
2287 (setq end (point))
2288 (goto-char beg)
2289 (forward-line 1)
2290 (setq beg (point)))
db133cb6 2291 (if (and shift-amt (> end beg))
f83d2997
KH
2292 (indent-code-rigidly beg end shift-amt "#")))
2293 (if (and (not cperl-tab-always-indent)
2294 (save-excursion
2295 (skip-chars-backward " \t")
2296 (not (bolp))))
2297 (insert-tab)
2298 (cperl-indent-line))))
2299
5bd52f0e 2300(defun cperl-indent-line (&optional parse-data)
f83d2997
KH
2301 "Indent current line as Perl code.
2302Return the amount the indentation changed by."
83261a2f
SM
2303 (let ((case-fold-search nil)
2304 (pos (- (point-max) (point)))
2305 indent i beg shift-amt)
5bd52f0e 2306 (setq indent (cperl-calculate-indent parse-data)
db133cb6 2307 i indent)
f83d2997
KH
2308 (beginning-of-line)
2309 (setq beg (point))
2310 (cond ((or (eq indent nil) (eq indent t))
db133cb6 2311 (setq indent (current-indentation) i nil))
f83d2997
KH
2312 ;;((eq indent t) ; Never?
2313 ;; (setq indent (cperl-calculate-indent-within-comment)))
2314 ;;((looking-at "[ \t]*#")
2315 ;; (setq indent 0))
2316 (t
2317 (skip-chars-forward " \t")
2318 (if (listp indent) (setq indent (car indent)))
2319 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2320 (and (> indent 0)
2321 (setq indent (max cperl-min-label-indent
2322 (+ indent cperl-label-offset)))))
2323 ((= (following-char) ?})
2324 (setq indent (- indent cperl-indent-level)))
2325 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2326 (setq indent (+ indent cperl-close-paren-offset)))
2327 ((= (following-char) ?{)
2328 (setq indent (+ indent cperl-brace-offset))))))
2329 (skip-chars-forward " \t")
db133cb6
RS
2330 (setq shift-amt (and i (- indent (current-column))))
2331 (if (or (not shift-amt)
2332 (zerop shift-amt))
f83d2997
KH
2333 (if (> (- (point-max) pos) (point))
2334 (goto-char (- (point-max) pos)))
2335 (delete-region beg (point))
2336 (indent-to indent)
2337 ;; If initial point was within line's indentation,
2338 ;; position after the indentation. Else stay at same point in text.
2339 (if (> (- (point-max) pos) (point))
2340 (goto-char (- (point-max) pos))))
2341 shift-amt))
2342
2343(defun cperl-after-label ()
2344 ;; Returns true if the point is after label. Does not do save-excursion.
2345 (and (eq (preceding-char) ?:)
2346 (memq (char-syntax (char-after (- (point) 2)))
2347 '(?w ?_))
2348 (progn
2349 (backward-sexp)
2350 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2351
2352(defun cperl-get-state (&optional parse-start start-state)
5bd52f0e
RS
2353 ;; returns list (START STATE DEPTH PRESTART),
2354 ;; START is a good place to start parsing, or equal to
5c8b7eaf 2355 ;; PARSE-START if preset,
5bd52f0e
RS
2356 ;; STATE is what is returned by `parse-partial-sexp'.
2357 ;; DEPTH is true is we are immediately after end of block
2358 ;; which contains START.
2359 ;; PRESTART is the position basing on which START was found.
f83d2997
KH
2360 (save-excursion
2361 (let ((start-point (point)) depth state start prestart)
5bd52f0e
RS
2362 (if (and parse-start
2363 (<= parse-start start-point))
f83d2997 2364 (goto-char parse-start)
5bd52f0e
RS
2365 (beginning-of-defun)
2366 (setq start-state nil))
f83d2997
KH
2367 (setq prestart (point))
2368 (if start-state nil
2369 ;; Try to go out, if sub is not on the outermost level
2370 (while (< (point) start-point)
2371 (setq start (point) parse-start start depth nil
2372 state (parse-partial-sexp start start-point -1))
2373 (if (> (car state) -1) nil
2374 ;; The current line could start like }}}, so the indentation
2375 ;; corresponds to a different level than what we reached
2376 (setq depth t)
2377 (beginning-of-line 2))) ; Go to the next line.
2378 (if start (goto-char start))) ; Not at the start of file
2379 (setq start (point))
f83d2997
KH
2380 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2381 (list start state depth prestart))))
2382
83261a2f 2383(defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
f83d2997
KH
2384 ;; Positions is before ?\{. Checks whether it starts a block.
2385 ;; No save-excursion!
2386 (cperl-backward-to-noncomment (point-min))
f83d2997
KH
2387 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
2388 ; Label may be mixed up with `$blah :'
2389 (save-excursion (cperl-after-label))
2390 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2391 (progn
2392 (backward-sexp)
2393 ;; Need take into account `bless', `return', `tr',...
2394 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
5bd52f0e 2395 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
f83d2997
KH
2396 (progn
2397 (skip-chars-backward " \t\n\f")
2398 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2399 (progn
2400 (backward-sexp)
5c8b7eaf 2401 (looking-at
f83d2997
KH
2402 "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
2403
2404(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2405
5bd52f0e 2406(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
f83d2997
KH
2407 "Return appropriate indentation for current line as Perl code.
2408In usual case returns an integer: the column to indent to.
5bd52f0e
RS
2409Returns nil if line starts inside a string, t if in a comment.
2410
2411Will not correct the indentation for labels, but will correct it for braces
0c602a0f 2412and closing parentheses and brackets."
f739b53b 2413 (cperl-update-syntaxification (point) (point))
f83d2997
KH
2414 (save-excursion
2415 (if (or
6c389151
SM
2416 (and (memq (get-text-property (point) 'syntax-type)
2417 '(pod here-doc here-doc-delim format))
2418 (not (get-text-property (point) 'indentable)))
f83d2997
KH
2419 ;; before start of POD - whitespace found since do not have 'pod!
2420 (and (looking-at "[ \t]*\n=")
83261a2f 2421 (error "Spaces before POD section!"))
f83d2997
KH
2422 (and (not cperl-indent-left-aligned-comments)
2423 (looking-at "^#")))
2424 nil
83261a2f
SM
2425 (beginning-of-line)
2426 (let ((indent-point (point))
2427 (char-after (save-excursion
2428 (skip-chars-forward " \t")
2429 (following-char)))
2430 (in-pod (get-text-property (point) 'in-pod))
2431 (pre-indent-point (point))
2432 p prop look-prop is-block delim)
2433 (cond
2434 (in-pod
2435 ;; In the verbatim part, probably code example. What to do???
2436 )
2437 (t
2438 (save-excursion
2439 ;; Not in POD
2440 (cperl-backward-to-noncomment nil)
2441 (setq p (max (point-min) (1- (point)))
2442 prop (get-text-property p 'syntax-type)
2443 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2444 'syntax-type))
2445 (if (memq prop '(pod here-doc format here-doc-delim))
2446 (progn
2447 (goto-char (or (previous-single-property-change p look-prop)
2448 (point-min)))
2449 (beginning-of-line)
2450 (setq pre-indent-point (point)))))))
2451 (goto-char pre-indent-point)
2452 (let* ((case-fold-search nil)
2453 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2454 (start (or (nth 2 parse-data)
2455 (nth 0 s-s)))
2456 (state (nth 1 s-s))
2457 (containing-sexp (car (cdr state)))
2458 old-indent)
2459 (if (and
2460 ;;containing-sexp ;; We are buggy at toplevel :-(
2461 parse-data)
f83d2997 2462 (progn
83261a2f
SM
2463 (setcar parse-data pre-indent-point)
2464 (setcar (cdr parse-data) state)
2465 (or (nth 2 parse-data)
2466 (setcar (cddr parse-data) start))
2467 ;; Before this point: end of statement
2468 (setq old-indent (nth 3 parse-data))))
2469 (cond ((get-text-property (point) 'indentable)
2470 ;; indent to just after the surrounding open,
2471 ;; skip blanks if we do not close the expression.
2472 (goto-char (1+ (previous-single-property-change (point) 'indentable)))
2473 (or (memq char-after (append ")]}" nil))
2474 (looking-at "[ \t]*\\(#\\|$\\)")
2475 (skip-chars-forward " \t"))
2476 (current-column))
2477 ((or (nth 3 state) (nth 4 state))
2478 ;; return nil or t if should not change this line
2479 (nth 4 state))
2480 ;; XXXX Do we need to special-case this?
2481 ((null containing-sexp)
2482 ;; Line is at top level. May be data or function definition,
2483 ;; or may be function argument declaration.
2484 ;; Indent like the previous top level line
2485 ;; unless that ends in a closeparen without semicolon,
2486 ;; in which case this line is the first argument decl.
2487 (skip-chars-forward " \t")
2488 (+ (save-excursion
2489 (goto-char start)
2490 (- (current-indentation)
2491 (if (nth 2 s-s) cperl-indent-level 0)))
2492 (if (= char-after ?{) cperl-continued-brace-offset 0)
2493 (progn
2494 (cperl-backward-to-noncomment (or old-indent (point-min)))
2495 ;; Look at previous line that's at column 0
2496 ;; to determine whether we are in top-level decls
2497 ;; or function's arg decls. Set basic-indent accordingly.
2498 ;; Now add a little if this is a continuation line.
2499 (if (or (bobp)
2500 (eq (point) old-indent) ; old-indent was at comment
2501 (eq (preceding-char) ?\;)
2502 ;; Had ?\) too
2503 (and (eq (preceding-char) ?\})
2504 (cperl-after-block-and-statement-beg
2505 (point-min))) ; Was start - too close
2506 (memq char-after (append ")]}" nil))
2507 (and (eq (preceding-char) ?\:) ; label
2508 (progn
2509 (forward-sexp -1)
2510 (skip-chars-backward " \t")
f739b53b
SM
2511 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2512 (get-text-property (point) 'first-format-line))
83261a2f
SM
2513 (progn
2514 (if (and parse-data
2515 (not (eq char-after ?\C-j)))
2516 (setcdr (cddr parse-data)
2517 (list pre-indent-point)))
2518 0)
2519 cperl-continued-statement-offset))))
2520 ((not
2521 (or (setq is-block
2522 (and (setq delim (= (char-after containing-sexp) ?{))
2523 (save-excursion ; Is it a hash?
2524 (goto-char containing-sexp)
2525 (cperl-block-p))))
2526 cperl-indent-parens-as-block))
2527 ;; group is an expression, not a block:
2528 ;; indent to just after the surrounding open parens,
2529 ;; skip blanks if we do not close the expression.
2530 (goto-char (1+ containing-sexp))
2531 (or (memq char-after
2532 (append (if delim "}" ")]}") nil))
2533 (looking-at "[ \t]*\\(#\\|$\\)")
2534 (skip-chars-forward " \t"))
2535 (+ (current-column)
2536 (if (and delim
2537 (eq char-after ?\}))
2538 ;; Correct indentation of trailing ?\}
2539 (+ cperl-indent-level cperl-close-paren-offset)
2540 0)))
6c389151
SM
2541;;; ((and (/= (char-after containing-sexp) ?{)
2542;;; (not cperl-indent-parens-as-block))
2543;;; ;; line is expression, not statement:
2544;;; ;; indent to just after the surrounding open,
2545;;; ;; skip blanks if we do not close the expression.
2546;;; (goto-char (1+ containing-sexp))
2547;;; (or (memq char-after (append ")]}" nil))
2548;;; (looking-at "[ \t]*\\(#\\|$\\)")
2549;;; (skip-chars-forward " \t"))
2550;;; (current-column))
2551;;; ((progn
2552;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2553;;; (goto-char containing-sexp)
2554;;; (and (not (cperl-block-p))
2555;;; (not cperl-indent-parens-as-block)))
2556;;; (goto-char (1+ containing-sexp))
2557;;; (or (eq char-after ?\})
2558;;; (looking-at "[ \t]*\\(#\\|$\\)")
2559;;; (skip-chars-forward " \t"))
2560;;; (+ (current-column) ; Correct indentation of trailing ?\}
2561;;; (if (eq char-after ?\}) (+ cperl-indent-level
a1506d29 2562;;; cperl-close-paren-offset)
6c389151 2563;;; 0)))
83261a2f
SM
2564 (t
2565 ;; Statement level. Is it a continuation or a new statement?
2566 ;; Find previous non-comment character.
2567 (goto-char pre-indent-point)
2568 (cperl-backward-to-noncomment containing-sexp)
2569 ;; Back up over label lines, since they don't
2570 ;; affect whether our line is a continuation.
2571 ;; (Had \, too)
2572 (while ;;(or (eq (preceding-char) ?\,)
2573 (and (eq (preceding-char) ?:)
2574 (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
2575 (memq (char-syntax (char-after (- (point) 2)))
2576 '(?w ?_))))
2577 ;;)
2578 (if (eq (preceding-char) ?\,)
2579 ;; Will go to beginning of line, essentially.
2580 ;; Will ignore embedded sexpr XXXX.
2581 (cperl-backward-to-start-of-continued-exp containing-sexp))
2582 (beginning-of-line)
2583 (cperl-backward-to-noncomment containing-sexp))
2584 ;; Now we get the answer.
2585 (if (not (or (eq (1- (point)) containing-sexp)
2586 (memq (preceding-char)
2587 (append (if is-block " ;{" " ,;{") '(nil)))
2588 (and (eq (preceding-char) ?\})
2589 (cperl-after-block-and-statement-beg
f739b53b
SM
2590 containing-sexp))
2591 (get-text-property (point) 'first-format-line)))
83261a2f
SM
2592 ;; This line is continuation of preceding line's statement;
2593 ;; indent `cperl-continued-statement-offset' more than the
2594 ;; previous line of the statement.
2595 ;;
2596 ;; There might be a label on this line, just
2597 ;; consider it bad style and ignore it.
f83d2997 2598 (progn
83261a2f
SM
2599 (cperl-backward-to-start-of-continued-exp containing-sexp)
2600 (+ (if (memq char-after (append "}])" nil))
2601 0 ; Closing parenth
2602 cperl-continued-statement-offset)
2603 (if (or is-block
2604 (not delim)
2605 (not (eq char-after ?\})))
2606 0
2607 ;; Now it is a hash reference
2608 (+ cperl-indent-level cperl-close-paren-offset))
2609 (if (looking-at "\\w+[ \t]*:")
2610 (if (> (current-indentation) cperl-min-label-indent)
2611 (- (current-indentation) cperl-label-offset)
2612 ;; Do not move `parse-data', this should
2613 ;; be quick anyway (this comment comes
2614 ;; from different location):
2615 (cperl-calculate-indent))
2616 (current-column))
2617 (if (eq char-after ?\{)
2618 cperl-continued-brace-offset 0)))
2619 ;; This line starts a new statement.
2620 ;; Position following last unclosed open.
2621 (goto-char containing-sexp)
2622 ;; Is line first statement after an open-brace?
2623 (or
2624 ;; If no, find that first statement and indent like
2625 ;; it. If the first statement begins with label, do
2626 ;; not believe when the indentation of the label is too
2627 ;; small.
2628 (save-excursion
2629 (forward-char 1)
2630 (setq old-indent (current-indentation))
2631 (let ((colon-line-end 0))
f739b53b
SM
2632 (while
2633 (progn (skip-chars-forward " \t\n")
2634 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
83261a2f
SM
2635 ;; Skip over comments and labels following openbrace.
2636 (cond ((= (following-char) ?\#)
2637 (forward-line 1))
f739b53b
SM
2638 ((= (following-char) ?\=)
2639 (goto-char
2640 (or (next-single-property-change (point) 'in-pod)
2641 (point-max)))) ; do not loop if no syntaxification
83261a2f
SM
2642 ;; label:
2643 (t
2644 (save-excursion (end-of-line)
2645 (setq colon-line-end (point)))
2646 (search-forward ":"))))
2647 ;; The first following code counts
2648 ;; if it is before the line we want to indent.
2649 (and (< (point) indent-point)
2650 (if (> colon-line-end (point)) ; After label
2651 (if (> (current-indentation)
2652 cperl-min-label-indent)
2653 (- (current-indentation) cperl-label-offset)
2654 ;; Do not believe: `max' is involved
2655 (+ old-indent cperl-indent-level))
2656 (current-column)))))
2657 ;; If no previous statement,
2658 ;; indent it relative to line brace is on.
2659 ;; For open brace in column zero, don't let statement
2660 ;; start there too. If cperl-indent-level is zero,
2661 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2662 ;; For open-braces not the first thing in a line,
2663 ;; add in cperl-brace-imaginary-offset.
2664
2665 ;; If first thing on a line: ?????
2666 (+ (if (and (bolp) (zerop cperl-indent-level))
2667 (+ cperl-brace-offset cperl-continued-statement-offset)
2668 cperl-indent-level)
2669 (if (or is-block
2670 (not delim)
2671 (not (eq char-after ?\})))
2672 0
2673 ;; Now it is a hash reference
2674 (+ cperl-indent-level cperl-close-paren-offset))
2675 ;; Move back over whitespace before the openbrace.
2676 ;; If openbrace is not first nonwhite thing on the line,
2677 ;; add the cperl-brace-imaginary-offset.
2678 (progn (skip-chars-backward " \t")
2679 (if (bolp) 0 cperl-brace-imaginary-offset))
2680 ;; If the openbrace is preceded by a parenthesized exp,
2681 ;; move to the beginning of that;
2682 ;; possibly a different line
2683 (progn
2684 (if (eq (preceding-char) ?\))
2685 (forward-sexp -1))
2686 ;; In the case it starts a subroutine, indent with
2687 ;; respect to `sub', not with respect to the
2688 ;; first thing on the line, say in the case of
2689 ;; anonymous sub in a hash.
2690 ;;
2691 (skip-chars-backward " \t")
2692 (if (and (eq (preceding-char) ?b)
2693 (progn
2694 (forward-sexp -1)
2695 (looking-at "sub\\>"))
2696 (setq old-indent
2697 (nth 1
2698 (parse-partial-sexp
2699 (save-excursion (beginning-of-line) (point))
2700 (point)))))
2701 (progn (goto-char (1+ old-indent))
2702 (skip-chars-forward " \t")
2703 (current-column))
2704 ;; Get initial indentation of the line we are on.
2705 ;; If line starts with label, calculate label indentation
2706 (if (save-excursion
2707 (beginning-of-line)
2708 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2709 (if (> (current-indentation) cperl-min-label-indent)
2710 (- (current-indentation) cperl-label-offset)
2711 ;; Do not move `parse-data', this should
2712 ;; be quick anyway:
2713 (cperl-calculate-indent))
2714 (current-indentation))))))))))))))
f83d2997 2715
825d0745
JB
2716;; (defvar cperl-indent-alist
2717;; '((string nil)
2718;; (comment nil)
2719;; (toplevel 0)
2720;; (toplevel-after-parenth 2)
2721;; (toplevel-continued 2)
2722;; (expression 1))
2723;; "Alist of indentation rules for CPerl mode.
2724;; The values mean:
2725;; nil: do not indent;
2726;; number: add this amount of indentation.
2727
2728;; Not finished, not used.")
2729
2730;; (defun cperl-where-am-i (&optional parse-start start-state)
2731;; ;; Unfinished
2732;; "Return a list of lists ((TYPE POS)...) of good points before the point.
2733;; ;; POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2734
2735;; ;; Not finished, not used."
2736;; (save-excursion
2737;; (let* ((start-point (point))
2738;; (s-s (cperl-get-state))
2739;; (start (nth 0 s-s))
2740;; (state (nth 1 s-s))
2741;; (prestart (nth 3 s-s))
2742;; (containing-sexp (car (cdr state)))
2743;; (case-fold-search nil)
2744;; (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
2745;; (cond ((nth 3 state) ; In string
2746;; (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
2747;; ((nth 4 state) ; In comment
2748;; (setq res (cons '(comment) res)))
2749;; ((null containing-sexp)
2750;; ;; Line is at top level.
2751;; ;; Indent like the previous top level line
2752;; ;; unless that ends in a closeparen without semicolon,
2753;; ;; in which case this line is the first argument decl.
2754;; (cperl-backward-to-noncomment (or parse-start (point-min)))
2755;; ;;(skip-chars-backward " \t\f\n")
2756;; (cond
2757;; ((or (bobp)
2758;; (memq (preceding-char) (append ";}" nil)))
2759;; (setq res (cons (list 'toplevel start) res)))
2760;; ((eq (preceding-char) ?\) )
2761;; (setq res (cons (list 'toplevel-after-parenth start) res)))
2762;; (t
2763;; (setq res (cons (list 'toplevel-continued start) res)))))
2764;; ((/= (char-after containing-sexp) ?{)
2765;; ;; line is expression, not statement:
2766;; ;; indent to just after the surrounding open.
2767;; ;; skip blanks if we do not close the expression.
2768;; (setq res (cons (list 'expression-blanks
2769;; (progn
2770;; (goto-char (1+ containing-sexp))
2771;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2772;; (skip-chars-forward " \t"))
2773;; (point)))
2774;; (cons (list 'expression containing-sexp) res))))
2775;; ((progn
2776;; ;; Containing-expr starts with \{. Check whether it is a hash.
2777;; (goto-char containing-sexp)
2778;; (not (cperl-block-p)))
2779;; (setq res (cons (list 'expression-blanks
2780;; (progn
2781;; (goto-char (1+ containing-sexp))
2782;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2783;; (skip-chars-forward " \t"))
2784;; (point)))
2785;; (cons (list 'expression containing-sexp) res))))
2786;; (t
2787;; ;; Statement level.
2788;; (setq res (cons (list 'in-block containing-sexp) res))
2789;; ;; Is it a continuation or a new statement?
2790;; ;; Find previous non-comment character.
2791;; (cperl-backward-to-noncomment containing-sexp)
2792;; ;; Back up over label lines, since they don't
2793;; ;; affect whether our line is a continuation.
2794;; ;; Back up comma-delimited lines too ?????
2795;; (while (or (eq (preceding-char) ?\,)
2796;; (save-excursion (cperl-after-label)))
2797;; (if (eq (preceding-char) ?\,)
2798;; ;; Will go to beginning of line, essentially
2799;; ;; Will ignore embedded sexpr XXXX.
2800;; (cperl-backward-to-start-of-continued-exp containing-sexp))
2801;; (beginning-of-line)
2802;; (cperl-backward-to-noncomment containing-sexp))
2803;; ;; Now we get the answer.
2804;; (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2805;; ;; This line is continuation of preceding line's statement.
2806;; (list (list 'statement-continued containing-sexp))
2807;; ;; This line starts a new statement.
2808;; ;; Position following last unclosed open.
2809;; (goto-char containing-sexp)
2810;; ;; Is line first statement after an open-brace?
2811;; (or
2812;; ;; If no, find that first statement and indent like
2813;; ;; it. If the first statement begins with label, do
2814;; ;; not believe when the indentation of the label is too
2815;; ;; small.
2816;; (save-excursion
2817;; (forward-char 1)
2818;; (let ((colon-line-end 0))
2819;; (while (progn (skip-chars-forward " \t\n" start-point)
2820;; (and (< (point) start-point)
2821;; (looking-at
2822;; "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2823;; ;; Skip over comments and labels following openbrace.
2824;; (cond ((= (following-char) ?\#)
2825;; ;;(forward-line 1)
2826;; (end-of-line))
2827;; ;; label:
2828;; (t
2829;; (save-excursion (end-of-line)
2830;; (setq colon-line-end (point)))
2831;; (search-forward ":"))))
2832;; ;; Now at the point, after label, or at start
2833;; ;; of first statement in the block.
2834;; (and (< (point) start-point)
2835;; (if (> colon-line-end (point))
2836;; ;; Before statement after label
2837;; (if (> (current-indentation)
2838;; cperl-min-label-indent)
2839;; (list (list 'label-in-block (point)))
2840;; ;; Do not believe: `max' is involved
2841;; (list
2842;; (list 'label-in-block-min-indent (point))))
2843;; ;; Before statement
2844;; (list 'statement-in-block (point))))))
2845;; ;; If no previous statement,
2846;; ;; indent it relative to line brace is on.
2847;; ;; For open brace in column zero, don't let statement
2848;; ;; start there too. If cperl-indent-level is zero,
2849;; ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2850;; ;; For open-braces not the first thing in a line,
2851;; ;; add in cperl-brace-imaginary-offset.
2852
2853;; ;; If first thing on a line: ?????
2854;; (+ (if (and (bolp) (zerop cperl-indent-level))
2855;; (+ cperl-brace-offset cperl-continued-statement-offset)
2856;; cperl-indent-level)
2857;; ;; Move back over whitespace before the openbrace.
2858;; ;; If openbrace is not first nonwhite thing on the line,
2859;; ;; add the cperl-brace-imaginary-offset.
2860;; (progn (skip-chars-backward " \t")
2861;; (if (bolp) 0 cperl-brace-imaginary-offset))
2862;; ;; If the openbrace is preceded by a parenthesized exp,
2863;; ;; move to the beginning of that;
2864;; ;; possibly a different line
2865;; (progn
2866;; (if (eq (preceding-char) ?\))
2867;; (forward-sexp -1))
2868;; ;; Get initial indentation of the line we are on.
2869;; ;; If line starts with label, calculate label indentation
2870;; (if (save-excursion
2871;; (beginning-of-line)
2872;; (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2873;; (if (> (current-indentation) cperl-min-label-indent)
2874;; (- (current-indentation) cperl-label-offset)
2875;; (cperl-calculate-indent))
2876;; (current-indentation))))))))
2877;; res)))
f83d2997
KH
2878
2879(defun cperl-calculate-indent-within-comment ()
2880 "Return the indentation amount for line, assuming that
2881the current line is to be regarded as part of a block comment."
2882 (let (end star-start)
2883 (save-excursion
2884 (beginning-of-line)
2885 (skip-chars-forward " \t")
2886 (setq end (point))
2887 (and (= (following-char) ?#)
2888 (forward-line -1)
2889 (cperl-to-comment-or-eol)
2890 (setq end (point)))
2891 (goto-char end)
2892 (current-column))))
2893
2894
2895(defun cperl-to-comment-or-eol ()
029cb4d5 2896 "Go to position before comment on the current line, or to end of line.
f83d2997
KH
2897Returns true if comment is found."
2898 (let (state stop-in cpoint (lim (progn (end-of-line) (point))))
83261a2f
SM
2899 (beginning-of-line)
2900 (if (or
2901 (eq (get-text-property (point) 'syntax-type) 'pod)
2902 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t))
2903 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
2904 ;; Else
2905 (while (not stop-in)
2906 (setq state (parse-partial-sexp (point) lim nil nil nil t))
f83d2997 2907 ; stop at comment
83261a2f
SM
2908 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2909 (if (nth 4 state) ; After `#';
f83d2997
KH
2910 ; (nth 2 state) can be
2911 ; beginning of m,s,qq and so
2912 ; on
83261a2f
SM
2913 (if (nth 2 state)
2914 (progn
2915 (setq cpoint (point))
2916 (goto-char (nth 2 state))
2917 (cond
2918 ((looking-at "\\(s\\|tr\\)\\>")
2919 (or (re-search-forward
2920 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
2921 lim 'move)
2922 (setq stop-in t)))
2923 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
2924 (or (re-search-forward
2925 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
2926 lim 'move)
2927 (setq stop-in t)))
2928 (t ; It was fair comment
2929 (setq stop-in t) ; Finish
2930 (goto-char (1- cpoint)))))
2931 (setq stop-in t) ; Finish
2932 (forward-char -1))
15ca5699 2933 (setq stop-in t))) ; Finish
83261a2f 2934 (nth 4 state))))
f83d2997
KH
2935
2936(defsubst cperl-1- (p)
2937 (max (point-min) (1- p)))
2938
2939(defsubst cperl-1+ (p)
2940 (min (point-max) (1+ p)))
2941
f83d2997
KH
2942(defsubst cperl-modify-syntax-type (at how)
2943 (if (< at (point-max))
2944 (progn
2945 (put-text-property at (1+ at) 'syntax-table how)
2946 (put-text-property at (1+ at) 'rear-nonsticky t))))
2947
2948(defun cperl-protect-defun-start (s e)
2949 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2950 (save-excursion
2951 (goto-char s)
2952 (while (re-search-forward "^\\s(" e 'to-end)
2953 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
2954
5bd52f0e 2955(defun cperl-commentify (bb e string &optional noface)
5c8b7eaf 2956 (if cperl-use-syntax-table-text-property
5bd52f0e
RS
2957 (if (eq noface 'n) ; Only immediate
2958 nil
f83d2997
KH
2959 ;; We suppose that e is _after_ the end of construction, as after eol.
2960 (setq string (if string cperl-st-sfence cperl-st-cfence))
6c389151
SM
2961 (if (> bb (- e 2))
2962 ;; one-char string/comment?!
2963 (cperl-modify-syntax-type bb cperl-st-punct)
2964 (cperl-modify-syntax-type bb string)
2965 (cperl-modify-syntax-type (1- e) string))
f83d2997 2966 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
5c8b7eaf 2967 (put-text-property (1+ bb) (1- e)
f83d2997 2968 'syntax-table cperl-string-syntax-table))
5bd52f0e
RS
2969 (cperl-protect-defun-start bb e))
2970 ;; Fontify
2971 (or noface
2972 (not cperl-pod-here-fontify)
2973 (put-text-property bb e 'face (if string 'font-lock-string-face
2974 'font-lock-comment-face)))))
6c389151 2975
5bd52f0e
RS
2976(defvar cperl-starters '(( ?\( . ?\) )
2977 ( ?\[ . ?\] )
2978 ( ?\{ . ?\} )
2979 ( ?\< . ?\> )))
f83d2997
KH
2980
2981(defun cperl-forward-re (lim end is-2arg set-st st-l err-l argument
2982 &optional ostart oend)
2983 ;; Works *before* syntax recognition is done
2984 ;; May modify syntax-type text property if the situation is too hard
6c389151 2985 (let (b starter ender st i i2 go-forward reset-st)
f83d2997
KH
2986 (skip-chars-forward " \t")
2987 ;; ender means matching-char matcher.
5c8b7eaf 2988 (setq b (point)
5bd52f0e
RS
2989 starter (if (eobp) 0 (char-after b))
2990 ender (cdr (assoc starter cperl-starters)))
f83d2997
KH
2991 ;; What if starter == ?\\ ????
2992 (if set-st
2993 (if (car st-l)
2994 (setq st (car st-l))
2995 (setcar st-l (make-syntax-table))
2996 (setq i 0 st (car st-l))
2997 (while (< i 256)
2998 (modify-syntax-entry i "." st)
2999 (setq i (1+ i)))
3000 (modify-syntax-entry ?\\ "\\" st)))
3001 (setq set-st t)
3002 ;; Whether we have an intermediate point
3003 (setq i nil)
3004 ;; Prepare the syntax table:
3005 (and set-st
3006 (if (not ender) ; m/blah/, s/x//, s/x/y/
3007 (modify-syntax-entry starter "$" st)
3008 (modify-syntax-entry starter (concat "(" (list ender)) st)
3009 (modify-syntax-entry ender (concat ")" (list starter)) st)))
3010 (condition-case bb
3011 (progn
5bd52f0e
RS
3012 ;; We use `$' syntax class to find matching stuff, but $$
3013 ;; is recognized the same as $, so we need to check this manually.
f83d2997
KH
3014 (if (and (eq starter (char-after (cperl-1+ b)))
3015 (not ender))
3016 ;; $ has TeXish matching rules, so $$ equiv $...
3017 (forward-char 2)
6c389151 3018 (setq reset-st (syntax-table))
f83d2997
KH
3019 (set-syntax-table st)
3020 (forward-sexp 1)
6c389151
SM
3021 (if (<= (point) (1+ b))
3022 (error "Unfinished regular expression"))
3023 (set-syntax-table reset-st)
3024 (setq reset-st nil)
f83d2997
KH
3025 ;; Now the problem is with m;blah;;
3026 (and (not ender)
3027 (eq (preceding-char)
3028 (char-after (- (point) 2)))
3029 (save-excursion
3030 (forward-char -2)
3031 (= 0 (% (skip-chars-backward "\\\\") 2)))
3032 (forward-char -1)))
5bd52f0e 3033 ;; Now we are after the first part.
f83d2997
KH
3034 (and is-2arg ; Have trailing part
3035 (not ender)
3036 (eq (following-char) starter) ; Empty trailing part
3037 (progn
3038 (or (eq (char-syntax (following-char)) ?.)
3039 ;; Make trailing letter into punctuation
3040 (cperl-modify-syntax-type (point) cperl-st-punct))
3041 (setq is-2arg nil go-forward t))) ; Ignore the tail
3042 (if is-2arg ; Not number => have second part
3043 (progn
3044 (setq i (point) i2 i)
3045 (if ender
b5b0cb34 3046 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
f83d2997
KH
3047 (progn
3048 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3049 (goto-char (match-end 0))
3050 (skip-chars-forward " \t\n\f"))
3051 (setq i2 (point))))
3052 (forward-char -1))
3053 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
5c8b7eaf 3054 (if ender (modify-syntax-entry ender "." st))
f83d2997 3055 (setq set-st nil)
5bd52f0e
RS
3056 (setq ender (cperl-forward-re lim end nil t st-l err-l
3057 argument starter ender)
f83d2997
KH
3058 ender (nth 2 ender)))))
3059 (error (goto-char lim)
3060 (setq set-st nil)
6c389151
SM
3061 (if reset-st
3062 (set-syntax-table reset-st))
f83d2997
KH
3063 (or end
3064 (message
5bd52f0e 3065 "End of `%s%s%c ... %c' string/RE not found: %s"
f83d2997
KH
3066 argument
3067 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3068 starter (or ender starter) bb)
3069 (or (car err-l) (setcar err-l b)))))
3070 (if set-st
3071 (progn
3072 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3073 (if ender (modify-syntax-entry ender "." st))))
5bd52f0e
RS
3074 ;; i: have 2 args, after end of the first arg
3075 ;; i2: start of the second arg, if any (before delim iff `ender').
3076 ;; ender: the last arg bounded by parens-like chars, the second one of them
3077 ;; starter: the starting delimiter of the first arg
5efe6a56 3078 ;; go-forward: has 2 args, and the second part is empty
f83d2997
KH
3079 (list i i2 ender starter go-forward)))
3080
83261a2f
SM
3081(defvar font-lock-string-face)
3082;;(defvar font-lock-reference-face)
3083(defvar font-lock-constant-face)
5c8b7eaf 3084(defsubst cperl-postpone-fontification (b e type val &optional now)
5bd52f0e
RS
3085 ;; Do after syntactic fontification?
3086 (if cperl-syntaxify-by-font-lock
3087 (or now (put-text-property b e 'cperl-postpone (cons type val)))
83261a2f 3088 (put-text-property b e type val)))
5bd52f0e
RS
3089
3090;;; Here is how the global structures (those which cannot be
3091;;; recognized locally) are marked:
5c8b7eaf 3092;; a) PODs:
5bd52f0e
RS
3093;; Start-to-end is marked `in-pod' ==> t
3094;; Each non-literal part is marked `syntax-type' ==> `pod'
3095;; Each literal part is marked `syntax-type' ==> `in-pod'
5c8b7eaf 3096;; b) HEREs:
5bd52f0e
RS
3097;; Start-to-end is marked `here-doc-group' ==> t
3098;; The body is marked `syntax-type' ==> `here-doc'
3099;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
5c8b7eaf 3100;; c) FORMATs:
f739b53b
SM
3101;; First line (to =) marked `first-format-line' ==> t
3102;; After-this--to-end is marked `syntax-type' ==> `format'
5c8b7eaf 3103;; d) 'Q'uoted string:
5bd52f0e 3104;; part between markers inclusive is marked `syntax-type' ==> `string'
6c389151 3105;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
5bd52f0e
RS
3106
3107(defun cperl-unwind-to-safe (before &optional end)
3108 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3109 (let ((pos (point)) opos)
3110 (setq opos pos)
3111 (while (and pos (get-text-property pos 'syntax-type))
3112 (setq pos (previous-single-property-change pos 'syntax-type))
3113 (if pos
3114 (if before
3115 (progn
3116 (goto-char (cperl-1- pos))
3117 (beginning-of-line)
3118 (setq pos (point)))
3119 (goto-char (setq pos (cperl-1- pos))))
3120 ;; Up to the start
3121 (goto-char (point-min))))
6c389151
SM
3122 ;; Skip empty lines
3123 (and (looking-at "\n*=")
3124 (/= 0 (skip-chars-backward "\n"))
3125 (forward-char))
3126 (setq pos (point))
5bd52f0e
RS
3127 (if end
3128 ;; Do the same for end, going small steps
3129 (progn
3130 (while (and end (get-text-property end 'syntax-type))
3131 (setq pos end
3132 end (next-single-property-change end 'syntax-type)))
3133 (or end pos)))))
3134
6c389151
SM
3135(defvar cperl-nonoverridable-face)
3136(defvar font-lock-function-name-face)
3137(defvar font-lock-comment-face)
3138
db133cb6 3139(defun cperl-find-pods-heres (&optional min max non-inter end ignore-max)
f83d2997 3140 "Scans the buffer for hard-to-parse Perl constructions.
5c8b7eaf
SS
3141If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3142the sections using `cperl-pod-head-face', `cperl-pod-face',
f83d2997
KH
3143`cperl-here-face'."
3144 (interactive)
db133cb6
RS
3145 (or min (setq min (point-min)
3146 cperl-syntax-state nil
3147 cperl-syntax-done-to min))
f83d2997 3148 (or max (setq max (point-max)))
83261a2f
SM
3149 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3150 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3151 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3152 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3153 (modified (buffer-modified-p))
3154 (after-change-functions nil)
3155 (use-syntax-state (and cperl-syntax-state
3156 (>= min (car cperl-syntax-state))))
3157 (state-point (if use-syntax-state
3158 (car cperl-syntax-state)
3159 (point-min)))
3160 (state (if use-syntax-state
3161 (cdr cperl-syntax-state)))
3162 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3163 (st-l (list nil)) (err-l (list nil))
3164 ;; Somehow font-lock may be not loaded yet...
3165 (font-lock-string-face (if (boundp 'font-lock-string-face)
3166 font-lock-string-face
3167 'font-lock-string-face))
3168 (font-lock-constant-face (if (boundp 'font-lock-constant-face)
3169 font-lock-constant-face
3170 'font-lock-constant-face))
3171 (font-lock-function-name-face
3172 (if (boundp 'font-lock-function-name-face)
3173 font-lock-function-name-face
3174 'font-lock-function-name-face))
3175 (font-lock-comment-face
3176 (if (boundp 'font-lock-comment-face)
3177 font-lock-comment-face
3178 'font-lock-comment-face))
3179 (cperl-nonoverridable-face
3180 (if (boundp 'cperl-nonoverridable-face)
3181 cperl-nonoverridable-face
e4c067b5 3182 'cperl-nonoverridable))
83261a2f
SM
3183 (stop-point (if ignore-max
3184 (point-max)
3185 max))
3186 (search
3187 (concat
3188 "\\(\\`\n?\\|^\n\\)="
3189 "\\|"
3190 ;; One extra () before this:
3191 "<<"
3192 "\\(" ; 1 + 1
3193 ;; First variant "BLAH" or just ``.
3194 "[ \t]*" ; Yes, whitespace is allowed!
3195 "\\([\"'`]\\)" ; 2 + 1 = 3
3196 "\\([^\"'`\n]*\\)" ; 3 + 1
3197 "\\3"
3198 "\\|"
f739b53b 3199 ;; Second variant: Identifier or \ID (same as 'ID') or empty
83261a2f
SM
3200 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3201 ;; Do not have <<= or << 30 or <<30 or << $blah.
3202 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3203 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3204 "\\)"
3205 "\\|"
3206 ;; 1+6 extra () before this:
3207 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3208 (if cperl-use-syntax-table-text-property
db133cb6 3209 (concat
db133cb6 3210 "\\|"
83261a2f
SM
3211 ;; 1+6+2=9 extra () before this:
3212 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3213 "\\|"
3214 ;; 1+6+2+1=10 extra () before this:
3215 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3216 "\\|"
3217 ;; 1+6+2+1+1=11 extra () before this:
3218 "\\<sub\\>[ \t]*\\([a-zA-Z_:'0-9]+[ \t]*\\)?\\(([^()]*)\\)"
3219 "\\|"
3220 ;; 1+6+2+1+1+2=13 extra () before this:
3221 "\\$\\(['{]\\)"
3222 "\\|"
3223 ;; 1+6+2+1+1+2+1=14 extra () before this:
3224 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3225 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3226 "\\|"
3227 "__\\(END\\|DATA\\)__"
3228 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
db133cb6 3229 "\\|"
f739b53b 3230 "\\\\\\(['`\"($]\\)")
83261a2f 3231 ""))))
f83d2997
KH
3232 (unwind-protect
3233 (progn
3234 (save-excursion
3235 (or non-inter
3236 (message "Scanning for \"hard\" Perl constructions..."))
db133cb6 3237 (and cperl-pod-here-fontify
83261a2f
SM
3238 ;; We had evals here, do not know why...
3239 (setq face cperl-pod-face
3240 head-face cperl-pod-head-face
3241 here-face cperl-here-face))
5c8b7eaf 3242 (remove-text-properties min max
5bd52f0e 3243 '(syntax-type t in-pod t syntax-table t
6c389151
SM
3244 cperl-postpone t
3245 syntax-subtype t
3246 rear-nonsticky t
f739b53b
SM
3247 here-doc-group t
3248 first-format-line t
6c389151 3249 indentable t))
f83d2997
KH
3250 ;; Need to remove face as well...
3251 (goto-char min)
db133cb6
RS
3252 (and (eq system-type 'emx)
3253 (looking-at "extproc[ \t]") ; Analogue of #!
5c8b7eaf 3254 (cperl-commentify min
db133cb6
RS
3255 (save-excursion (end-of-line) (point))
3256 nil))
3257 (while (and
3258 (< (point) max)
3259 (re-search-forward search max t))
5bd52f0e 3260 (setq tmpend nil) ; Valid for most cases
5c8b7eaf 3261 (cond
f83d2997 3262 ((match-beginning 1) ; POD section
a1506d29 3263 ;; "\\(\\`\n?\\|^\n\\)="
6c389151 3264 (if (looking-at "cut\\>")
5bd52f0e
RS
3265 (if ignore-max
3266 nil ; Doing a chunk only
f83d2997
KH
3267 (message "=cut is not preceded by a POD section")
3268 (or (car err-l) (setcar err-l (point))))
3269 (beginning-of-line)
5c8b7eaf
SS
3270
3271 (setq b (point)
5bd52f0e
RS
3272 bb b
3273 tb (match-beginning 0)
3274 b1 nil) ; error condition
db133cb6
RS
3275 ;; We do not search to max, since we may be called from
3276 ;; some hook of fontification, and max is random
6c389151 3277 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
f83d2997 3278 (progn
6c389151
SM
3279 (goto-char b)
3280 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3281 (progn
3282 (message "=cut is not preceded by an empty line")
3283 (setq b1 t)
3284 (or (car err-l) (setcar err-l b))))))
f83d2997
KH
3285 (beginning-of-line 2) ; An empty line after =cut is not POD!
3286 (setq e (point))
db133cb6 3287 (and (> e max)
6c389151 3288 (progn
a1506d29 3289 (remove-text-properties
6c389151
SM
3290 max e '(syntax-type t in-pod t syntax-table t
3291 cperl-postpone t
3292 syntax-subtype t
f739b53b 3293 here-doc-group t
6c389151 3294 rear-nonsticky t
f739b53b 3295 first-format-line t
6c389151
SM
3296 indentable t))
3297 (setq tmpend tb)))
f83d2997 3298 (put-text-property b e 'in-pod t)
6c389151 3299 (put-text-property b e 'syntax-type 'in-pod)
f83d2997
KH
3300 (goto-char b)
3301 (while (re-search-forward "\n\n[ \t]" e t)
3302 ;; We start 'pod 1 char earlier to include the preceding line
3303 (beginning-of-line)
3304 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5efe6a56
SM
3305 (cperl-put-do-not-fontify b (point) t)
3306 ;; mark the non-literal parts as PODs
a1506d29 3307 (if cperl-pod-here-fontify
5efe6a56 3308 (cperl-postpone-fontification b (point) 'face face t))
f83d2997
KH
3309 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3310 (beginning-of-line)
3311 (setq b (point)))
3312 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5efe6a56 3313 (cperl-put-do-not-fontify (point) e t)
a1506d29
JB
3314 (if cperl-pod-here-fontify
3315 (progn
5efe6a56
SM
3316 ;; mark the non-literal parts as PODs
3317 (cperl-postpone-fontification (point) e 'face face t)
3318 (goto-char bb)
a1506d29 3319 (if (looking-at
5efe6a56
SM
3320 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3321 ;; mark the headers
a1506d29 3322 (cperl-postpone-fontification
5efe6a56 3323 (match-beginning 1) (match-end 1)
6c389151
SM
3324 'face head-face))
3325 (while (re-search-forward
3326 ;; One paragraph
3327 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3328 e 'toend)
3329 ;; mark the headers
a1506d29 3330 (cperl-postpone-fontification
5efe6a56
SM
3331 (match-beginning 1) (match-end 1)
3332 'face head-face))))
f83d2997
KH
3333 (cperl-commentify bb e nil)
3334 (goto-char e)
3335 (or (eq e (point-max))
83261a2f 3336 (forward-char -1)))) ; Prepare for immediate POD start.
f83d2997
KH
3337 ;; Here document
3338 ;; We do only one here-per-line
5bd52f0e 3339 ;; ;; One extra () before this:
5c8b7eaf 3340 ;;"<<"
5bd52f0e
RS
3341 ;; "\\(" ; 1 + 1
3342 ;; ;; First variant "BLAH" or just ``.
f739b53b 3343 ;; "[ \t]*" ; Yes, whitespace is allowed!
5bd52f0e
RS
3344 ;; "\\([\"'`]\\)" ; 2 + 1
3345 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3346 ;; "\\3"
3347 ;; "\\|"
3348 ;; ;; Second variant: Identifier or \ID or empty
3349 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3350 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3351 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3352 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3353 ;; "\\)"
f83d2997
KH
3354 ((match-beginning 2) ; 1 + 1
3355 ;; Abort in comment:
3356 (setq b (point))
3357 (setq state (parse-partial-sexp state-point b nil nil state)
5bd52f0e
RS
3358 state-point b
3359 tb (match-beginning 0)
3360 i (or (nth 3 state) (nth 4 state)))
5c8b7eaf 3361 (if i
5bd52f0e
RS
3362 (setq c t)
3363 (setq c (and
3364 (match-beginning 5)
3365 (not (match-beginning 6)) ; Empty
3366 (looking-at
3367 "[ \t]*[=0-9$@%&(]"))))
3368 (if c ; Not here-doc
3369 nil ; Skip it.
f83d2997
KH
3370 (if (match-beginning 5) ;4 + 1
3371 (setq b1 (match-beginning 5) ; 4 + 1
3372 e1 (match-end 5)) ; 4 + 1
3373 (setq b1 (match-beginning 4) ; 3 + 1
3374 e1 (match-end 4))) ; 3 + 1
3375 (setq tag (buffer-substring b1 e1)
3376 qtag (regexp-quote tag))
5c8b7eaf 3377 (cond (cperl-pod-here-fontify
5bd52f0e
RS
3378 ;; Highlight the starting delimiter
3379 (cperl-postpone-fontification b1 e1 'face font-lock-constant-face)
3380 (cperl-put-do-not-fontify b1 e1 t)))
f83d2997
KH
3381 (forward-line)
3382 (setq b (point))
db133cb6
RS
3383 ;; We do not search to max, since we may be called from
3384 ;; some hook of fontification, and max is random
f739b53b
SM
3385 (or (and (re-search-forward (concat "^" qtag "$")
3386 stop-point 'toend)
3387 (eq (following-char) ?\n))
3388 (progn ; Pretend we matched at the end
3389 (goto-char (point-max))
3390 (re-search-forward "\\'")
3391 (message "End of here-document `%s' not found." tag)
3392 (or (car err-l) (setcar err-l b))))
3393 (if cperl-pod-here-fontify
3394 (progn
3395 ;; Highlight the ending delimiter
3396 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
3397 'face font-lock-constant-face)
3398 (cperl-put-do-not-fontify b (match-end 0) t)
3399 ;; Highlight the HERE-DOC
3400 (cperl-postpone-fontification b (match-beginning 0)
3401 'face here-face)))
3402 (setq e1 (cperl-1+ (match-end 0)))
3403 (put-text-property b (match-beginning 0)
3404 'syntax-type 'here-doc)
3405 (put-text-property (match-beginning 0) e1
3406 'syntax-type 'here-doc-delim)
3407 (put-text-property b e1
3408 'here-doc-group t)
3409 (cperl-commentify b e1 nil)
3410 (cperl-put-do-not-fontify b (match-end 0) t)
3411 (if (> e1 max)
3412 (setq tmpend tb))))
f83d2997
KH
3413 ;; format
3414 ((match-beginning 8)
3415 ;; 1+6=7 extra () before this:
3416 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3417 (setq b (point)
3418 name (if (match-beginning 8) ; 7 + 1
3419 (buffer-substring (match-beginning 8) ; 7 + 1
3420 (match-end 8)) ; 7 + 1
5bd52f0e
RS
3421 "")
3422 tb (match-beginning 0))
f83d2997 3423 (setq argument nil)
f739b53b
SM
3424 (put-text-property (save-excursion
3425 (beginning-of-line)
3426 (point))
3427 b 'first-format-line 't)
5c8b7eaf 3428 (if cperl-pod-here-fontify
f83d2997
KH
3429 (while (and (eq (forward-line) 0)
3430 (not (looking-at "^[.;]$")))
3431 (cond
3432 ((looking-at "^#")) ; Skip comments
3433 ((and argument ; Skip argument multi-lines
5c8b7eaf 3434 (looking-at "^[ \t]*{"))
f83d2997
KH
3435 (forward-sexp 1)
3436 (setq argument nil))
3437 (argument ; Skip argument lines
3438 (setq argument nil))
3439 (t ; Format line
3440 (setq b1 (point))
3441 (setq argument (looking-at "^[^\n]*[@^]"))
3442 (end-of-line)
5bd52f0e 3443 ;; Highlight the format line
5c8b7eaf 3444 (cperl-postpone-fontification b1 (point)
83261a2f 3445 'face font-lock-string-face)
f83d2997 3446 (cperl-commentify b1 (point) nil)
5bd52f0e 3447 (cperl-put-do-not-fontify b1 (point) t))))
db133cb6
RS
3448 ;; We do not search to max, since we may be called from
3449 ;; some hook of fontification, and max is random
3450 (re-search-forward "^[.;]$" stop-point 'toend))
f83d2997 3451 (beginning-of-line)
83261a2f 3452 (if (looking-at "^\\.$") ; ";" is not supported yet
f83d2997 3453 (progn
5bd52f0e
RS
3454 ;; Highlight the ending delimiter
3455 (cperl-postpone-fontification (point) (+ (point) 2)
83261a2f 3456 'face font-lock-string-face)
f83d2997 3457 (cperl-commentify (point) (+ (point) 2) nil)
5bd52f0e 3458 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
f83d2997
KH
3459 (message "End of format `%s' not found." name)
3460 (or (car err-l) (setcar err-l b)))
3461 (forward-line)
5bd52f0e
RS
3462 (if (> (point) max)
3463 (setq tmpend tb))
db133cb6 3464 (put-text-property b (point) 'syntax-type 'format))
f83d2997
KH
3465 ;; Regexp:
3466 ((or (match-beginning 10) (match-beginning 11))
3467 ;; 1+6+2=9 extra () before this:
5bd52f0e 3468 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
f83d2997 3469 ;; "\\|"
5bd52f0e 3470 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
f83d2997
KH
3471 (setq b1 (if (match-beginning 10) 10 11)
3472 argument (buffer-substring
3473 (match-beginning b1) (match-end b1))
3474 b (point)
3475 i b
3476 c (char-after (match-beginning b1))
3477 bb (char-after (1- (match-beginning b1))) ; tmp holder
5bd52f0e
RS
3478 ;; bb == "Not a stringy"
3479 bb (if (eq b1 10) ; user variables/whatever
f739b53b
SM
3480 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
3481 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
3482 ((eq bb ?\:) ; $opt::s
3483 (eq (char-after
3484 (- (match-beginning b1) 2))
3485 ?\:))
3486 ((eq bb ?\>) ; $foo->s
3487 (eq (char-after
3488 (- (match-beginning b1) 2))
3489 ?\-))
3490 ((eq bb ?\&)
3491 (not (eq (char-after ; &&m/blah/
3492 (- (match-beginning b1) 2))
3493 ?\&)))
3494 (t t)))
5bd52f0e
RS
3495 ;; <file> or <$file>
3496 (and (eq c ?\<)
6c389151 3497 ;; Do not stringify <FH>, <$fh> :
5bd52f0e 3498 (save-match-data
5c8b7eaf 3499 (looking-at
6c389151 3500 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
5bd52f0e 3501 tb (match-beginning 0))
db133cb6
RS
3502 (goto-char (match-beginning b1))
3503 (cperl-backward-to-noncomment (point-min))
f83d2997 3504 (or bb
5bd52f0e 3505 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
f83d2997 3506 (setq argument ""
f739b53b 3507 b1 nil
db133cb6
RS
3508 bb ; Not a regexp?
3509 (progn
5c8b7eaf 3510 (not
db133cb6
RS
3511 ;; What is below: regexp-p?
3512 (and
3513 (or (memq (preceding-char)
5bd52f0e 3514 (append (if (memq c '(?\? ?\<))
db133cb6 3515 ;; $a++ ? 1 : 2
5bd52f0e
RS
3516 "~{(=|&*!,;:"
3517 "~{(=|&+-*!,;:") nil))
db133cb6
RS
3518 (and (eq (preceding-char) ?\})
3519 (cperl-after-block-p (point-min)))
3520 (and (eq (char-syntax (preceding-char)) ?w)
3521 (progn
3522 (forward-sexp -1)
6c389151
SM
3523;; After these keywords `/' starts a RE. One should add all the
3524;; functions/builtins which expect an argument, but ...
5bd52f0e
RS
3525 (if (eq (preceding-char) ?-)
3526 ;; -d ?foo? is a RE
3527 (looking-at "[a-zA-Z]\\>")
029cb4d5
SM
3528 (and
3529 (not (memq (preceding-char)
3530 '(?$ ?@ ?& ?%)))
3531 (looking-at
3532 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
db133cb6
RS
3533 (and (eq (preceding-char) ?.)
3534 (eq (char-after (- (point) 2)) ?.))
3535 (bobp))
3536 ;; m|blah| ? foo : bar;
3537 (not
3538 (and (eq c ?\?)
5c8b7eaf 3539 cperl-use-syntax-table-text-property
db133cb6
RS
3540 (not (bobp))
3541 (progn
3542 (forward-char -1)
3543 (looking-at "\\s|")))))))
3544 b (1- b))
3545 ;; s y tr m
f739b53b
SM
3546 ;; Check for $a -> y
3547 (setq b1 (preceding-char)
3548 go (point))
3549 (if (and (eq b1 ?>)
3550 (eq (char-after (- go 2)) ?-))
db133cb6
RS
3551 ;; Not a regexp
3552 (setq bb t))))
5c8b7eaf 3553 (or bb (setq state (parse-partial-sexp
f83d2997
KH
3554 state-point b nil nil state)
3555 state-point b))
f739b53b 3556 (setq bb (or bb (nth 3 state) (nth 4 state)))
f83d2997 3557 (goto-char b)
f739b53b
SM
3558 (or bb
3559 (progn
3560 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3561 (goto-char (match-end 0))
3562 (skip-chars-forward " \t\n\f"))
3563 (cond ((and (eq (following-char) ?\})
3564 (eq b1 ?\{))
3565 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3566 (goto-char (1- go))
3567 (skip-chars-backward " \t\n\f")
3568 (if (memq (preceding-char) (append "$@%&*" nil))
3569 (setq bb t) ; @{y}
3570 (condition-case nil
3571 (forward-sexp -1)
3572 (error nil)))
3573 (if (or bb
3574 (looking-at ; $foo -> {s}
3575 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
3576 (and ; $foo[12] -> {s}
3577 (memq (following-char) '(?\{ ?\[))
3578 (progn
3579 (forward-sexp 1)
3580 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
3581 (setq bb t)
3582 (goto-char b)))
3583 ((and (eq (following-char) ?=)
3584 (eq (char-after (1+ (point))) ?\>))
3585 ;; Check for { foo => 1, s => 2 }
3586 ;; Apparently s=> is never a substitution...
3587 (setq bb t))
3588 ((and (eq (following-char) ?:)
3589 (eq b1 ?\{) ; Check for $ { s::bar }
3590 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
15ca5699 3591 (progn
f739b53b
SM
3592 (goto-char (1- go))
3593 (skip-chars-backward " \t\n\f")
3594 (memq (preceding-char)
3595 (append "$@%&*" nil))))
3596 (setq bb t)))))
3597 (if bb
f83d2997 3598 (goto-char i)
6c389151 3599 ;; Skip whitespace and comments...
f83d2997
KH
3600 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3601 (goto-char (match-end 0))
3602 (skip-chars-forward " \t\n\f"))
6c389151
SM
3603 (if (> (point) b)
3604 (put-text-property b (point) 'syntax-type 'prestring))
f83d2997
KH
3605 ;; qtag means two-arg matcher, may be reset to
3606 ;; 2 or 3 later if some special quoting is needed.
3607 ;; e1 means matching-char matcher.
3608 (setq b (point)
5bd52f0e
RS
3609 ;; has 2 args
3610 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
db133cb6
RS
3611 ;; We do not search to max, since we may be called from
3612 ;; some hook of fontification, and max is random
3613 i (cperl-forward-re stop-point end
5bd52f0e 3614 i2
db133cb6 3615 t st-l err-l argument)
5bd52f0e
RS
3616 ;; Note that if `go', then it is considered as 1-arg
3617 b1 (nth 1 i) ; start of the second part
5c8b7eaf 3618 tag (nth 2 i) ; ender-char, true if second part
5bd52f0e 3619 ; is with matching chars []
f83d2997
KH
3620 go (nth 4 i) ; There is a 1-char part after the end
3621 i (car i) ; intermediate point
5c8b7eaf 3622 e1 (point) ; end
5bd52f0e 3623 ;; Before end of the second part if non-matching: ///
5c8b7eaf 3624 tail (if (and i (not tag))
5bd52f0e
RS
3625 (1- e1))
3626 e (if i i e1) ; end of the first part
6c389151
SM
3627 qtag nil ; need to preserve backslashitis
3628 is-x-REx nil) ; REx has //x modifier
f83d2997
KH
3629 ;; Commenting \\ is dangerous, what about ( ?
3630 (and i tail
3631 (eq (char-after i) ?\\)
5bd52f0e 3632 (setq qtag t))
6c389151
SM
3633 (if (looking-at "\\sw*x") ; qr//x
3634 (setq is-x-REx t))
f83d2997 3635 (if (null i)
5bd52f0e 3636 ;; Considered as 1arg form
f83d2997
KH
3637 (progn
3638 (cperl-commentify b (point) t)
5bd52f0e 3639 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
3640 (if (or is-x-REx
3641 ;; ignore other text properties:
3642 (string-match "^qw$" argument))
3643 (put-text-property b (point) 'indentable t))
5bd52f0e
RS
3644 (and go
3645 (setq e1 (cperl-1+ e1))
3646 (or (eobp)
3647 (forward-char 1))))
f83d2997
KH
3648 (cperl-commentify b i t)
3649 (if (looking-at "\\sw*e") ; s///e
3650 (progn
3651 (and
3652 ;; silent:
5bd52f0e 3653 (cperl-find-pods-heres b1 (1- (point)) t end)
f83d2997
KH
3654 ;; Error
3655 (goto-char (1+ max)))
5bd52f0e 3656 (if (and tag (eq (preceding-char) ?\>))
f83d2997
KH
3657 (progn
3658 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5bd52f0e 3659 (cperl-modify-syntax-type i cperl-st-bra)))
6c389151
SM
3660 (put-text-property b i 'syntax-type 'string)
3661 (if is-x-REx
3662 (put-text-property b i 'indentable t)))
5bd52f0e
RS
3663 (cperl-commentify b1 (point) t)
3664 (put-text-property b (point) 'syntax-type 'string)
6c389151
SM
3665 (if is-x-REx
3666 (put-text-property b i 'indentable t))
5bd52f0e 3667 (if qtag
db133cb6 3668 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
f83d2997 3669 (setq tail nil)))
5bd52f0e 3670 ;; Now: tail: if the second part is non-matching without ///e
f83d2997
KH
3671 (if (eq (char-syntax (following-char)) ?w)
3672 (progn
3673 (forward-word 1) ; skip modifiers s///s
5bd52f0e 3674 (if tail (cperl-commentify tail (point) t))
a1506d29 3675 (cperl-postpone-fontification
e4c067b5 3676 e1 (point) 'face 'cperl-nonoverridable)))
5bd52f0e
RS
3677 ;; Check whether it is m// which means "previous match"
3678 ;; and highlight differently
a1506d29 3679 (setq is-REx
6c389151
SM
3680 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
3681 (or (not (= (length argument) 0))
3682 (not (eq c ?\<)))))
a1506d29 3683 (if (and is-REx
6c389151 3684 (eq e (+ 2 b))
5bd52f0e
RS
3685 ;; split // *is* using zero-pattern
3686 (save-excursion
3687 (condition-case nil
3688 (progn
3689 (goto-char tb)
3690 (forward-sexp -1)
3691 (not (looking-at "split\\>")))
3692 (error t))))
5c8b7eaf 3693 (cperl-postpone-fontification
5bd52f0e
RS
3694 b e 'face font-lock-function-name-face)
3695 (if (or i2 ; Has 2 args
3696 (and cperl-fontify-m-as-s
3697 (or
3698 (string-match "^\\(m\\|qr\\)$" argument)
3699 (and (eq 0 (length argument))
3700 (not (eq ?\< (char-after b)))))))
3701 (progn
5c8b7eaf 3702 (cperl-postpone-fontification
5bd52f0e 3703 b (cperl-1+ b) 'face font-lock-constant-face)
5c8b7eaf 3704 (cperl-postpone-fontification
6c389151
SM
3705 (1- e) e 'face font-lock-constant-face)))
3706 (if (and is-REx cperl-regexp-scan)
3707 ;; Process RExen better
3708 (save-excursion
3709 (goto-char (1+ b))
3710 (while
3711 (and (< (point) e)
3712 (re-search-forward
3713 (if is-x-REx
3714 (if (eq (char-after b) ?\#)
3715 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
83261a2f
SM
3716 "\\((\\?#\\)\\|\\(#\\)")
3717 (if (eq (char-after b) ?\#)
3718 "\\((\\?\\\\#\\)"
3719 "\\((\\?#\\)"))
6c389151
SM
3720 (1- e) 'to-end))
3721 (goto-char (match-beginning 0))
3722 (setq REx-comment-start (point)
3723 was-comment t)
3724 (if (save-excursion
3725 (and
3726 ;; XXX not working if outside delimiter is #
3727 (eq (preceding-char) ?\\)
3728 (= (% (skip-chars-backward "$\\\\") 2) -1)))
3729 ;; Not a comment, avoid loop:
3730 (progn (setq was-comment nil)
3731 (forward-char 1))
3732 (if (match-beginning 2)
a1506d29 3733 (progn
6c389151
SM
3734 (beginning-of-line 2)
3735 (if (> (point) e)
3736 (goto-char (1- e))))
3737 ;; Works also if the outside delimiters are ().
3738 (or (search-forward ")" (1- e) 'toend)
3739 (message
3740 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3741 REx-comment-start))))
3742 (if (>= (point) e)
3743 (goto-char (1- e)))
3744 (if was-comment
3745 (progn
3746 (setq REx-comment-end (point))
3747 (cperl-commentify
3748 REx-comment-start REx-comment-end nil)
a1506d29 3749 (cperl-postpone-fontification
6c389151
SM
3750 REx-comment-start REx-comment-end
3751 'face font-lock-comment-face))))))
3752 (if (and is-REx is-x-REx)
a1506d29 3753 (put-text-property (1+ b) (1- e)
6c389151 3754 'syntax-subtype 'x-REx)))
5bd52f0e
RS
3755 (if i2
3756 (progn
5c8b7eaf 3757 (cperl-postpone-fontification
5bd52f0e
RS
3758 (1- e1) e1 'face font-lock-constant-face)
3759 (if (assoc (char-after b) cperl-starters)
5c8b7eaf 3760 (cperl-postpone-fontification
5bd52f0e
RS
3761 b1 (1+ b1) 'face font-lock-constant-face))))
3762 (if (> (point) max)
3763 (setq tmpend tb))))
f83d2997
KH
3764 ((match-beginning 13) ; sub with prototypes
3765 (setq b (match-beginning 0))
3766 (if (memq (char-after (1- b))
3767 '(?\$ ?\@ ?\% ?\& ?\*))
3768 nil
5c8b7eaf 3769 (setq state (parse-partial-sexp
5bd52f0e
RS
3770 state-point b nil nil state)
3771 state-point b)
f83d2997
KH
3772 (if (or (nth 3 state) (nth 4 state))
3773 nil
3774 ;; Mark as string
3775 (cperl-commentify (match-beginning 13) (match-end 13) t))
3776 (goto-char (match-end 0))))
3777 ;; 1+6+2+1+1+2=13 extra () before this:
3778 ;; "\\$\\(['{]\\)"
3779 ((and (match-beginning 14)
db133cb6 3780 (eq (preceding-char) ?\')) ; $'
f83d2997 3781 (setq b (1- (point))
5c8b7eaf 3782 state (parse-partial-sexp
f83d2997
KH
3783 state-point (1- b) nil nil state)
3784 state-point (1- b))
3785 (if (nth 3 state) ; in string
3786 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3787 (goto-char (1+ b)))
3788 ;; 1+6+2+1+1+2=13 extra () before this:
3789 ;; "\\$\\(['{]\\)"
3790 ((match-beginning 14) ; ${
3791 (setq bb (match-beginning 0))
3792 (cperl-modify-syntax-type bb cperl-st-punct))
3793 ;; 1+6+2+1+1+2+1=14 extra () before this:
3794 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3795 ((match-beginning 15) ; old $abc'efg syntax
3796 (setq bb (match-end 0)
3797 b (match-beginning 0)
5c8b7eaf 3798 state (parse-partial-sexp
f83d2997
KH
3799 state-point b nil nil state)
3800 state-point b)
3801 (if (nth 3 state) ; in string
3802 nil
3803 (put-text-property (1- bb) bb 'syntax-table cperl-st-word))
3804 (goto-char bb))
3805 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3806 ;; "__\\(END\\|DATA\\)__"
6c389151 3807 ((match-beginning 16) ; __END__, __DATA__
f83d2997
KH
3808 (setq bb (match-end 0)
3809 b (match-beginning 0)
5c8b7eaf 3810 state (parse-partial-sexp
f83d2997
KH
3811 state-point b nil nil state)
3812 state-point b)
3813 (if (or (nth 3 state) (nth 4 state))
3814 nil
3815 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3816 (cperl-commentify b bb nil)
3817 (setq end t))
6c389151 3818 (goto-char bb))
f739b53b
SM
3819 ((match-beginning 17) ; "\\\\\\(['`\"($]\\)"
3820 ;; Trailing backslash ==> non-quoting outside string/comment
6c389151
SM
3821 (setq bb (match-end 0)
3822 b (match-beginning 0))
3823 (goto-char b)
3824 (skip-chars-backward "\\\\")
3825 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
a1506d29 3826 (setq state (parse-partial-sexp
6c389151
SM
3827 state-point b nil nil state)
3828 state-point b)
3829 (if (or (nth 3 state) (nth 4 state) )
3830 nil
3831 (cperl-modify-syntax-type b cperl-st-punct))
3832 (goto-char bb))
3833 (t (error "Error in regexp of the sniffer")))
db133cb6 3834 (if (> (point) stop-point)
f83d2997 3835 (progn
5c8b7eaf 3836 (if end
f83d2997
KH
3837 (message "Garbage after __END__/__DATA__ ignored")
3838 (message "Unbalanced syntax found while scanning")
3839 (or (car err-l) (setcar err-l b)))
db133cb6
RS
3840 (goto-char stop-point))))
3841 (setq cperl-syntax-state (cons state-point state)
5bd52f0e 3842 cperl-syntax-done-to (or tmpend (max (point) max))))
f83d2997 3843 (if (car err-l) (goto-char (car err-l))
db133cb6
RS
3844 (or non-inter
3845 (message "Scanning for \"hard\" Perl constructions... done"))))
f83d2997
KH
3846 (and (buffer-modified-p)
3847 (not modified)
3848 (set-buffer-modified-p nil))
00424a9e
SM
3849 ;; I do not understand what this is doing here. It breaks font-locking
3850 ;; because it resets the syntax-table from font-lock-syntax-table to
3851 ;; cperl-mode-syntax-table.
3852 ;; (set-syntax-table cperl-mode-syntax-table)
3853 )
f83d2997
KH
3854 (car err-l)))
3855
3856(defun cperl-backward-to-noncomment (lim)
3857 ;; Stops at lim or after non-whitespace that is not in comment
5bd52f0e 3858 (let (stop p pr)
f83d2997
KH
3859 (while (and (not stop) (> (point) (or lim 1)))
3860 (skip-chars-backward " \t\n\f" lim)
3861 (setq p (point))
3862 (beginning-of-line)
5bd52f0e
RS
3863 (if (memq (setq pr (get-text-property (point) 'syntax-type))
3864 '(pod here-doc here-doc-delim))
3865 (cperl-unwind-to-safe nil)
83261a2f
SM
3866 (or (looking-at "^[ \t]*\\(#\\|$\\)")
3867 (progn (cperl-to-comment-or-eol) (bolp))
3868 (progn
3869 (skip-chars-backward " \t")
3870 (if (< p (point)) (goto-char p))
3871 (setq stop t)))))))
f83d2997 3872
f739b53b
SM
3873(defun cperl-after-block-p (lim &optional pre-block)
3874 "Return true if the preceeding } ends a block or a following { starts one.
3875Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3876otherwise following {."
f83d2997
KH
3877 ;; We suppose that the preceding char is }.
3878 (save-excursion
3879 (condition-case nil
3880 (progn
f739b53b 3881 (or pre-block (forward-sexp -1))
f83d2997 3882 (cperl-backward-to-noncomment lim)
bab27c0c
RS
3883 (or (eq (point) lim)
3884 (eq (preceding-char) ?\) ) ; if () {} sub f () {}
db133cb6
RS
3885 (if (eq (char-syntax (preceding-char)) ?w) ; else {}
3886 (save-excursion
3887 (forward-sexp -1)
f739b53b 3888 (or (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
db133cb6
RS
3889 ;; sub f {}
3890 (progn
3891 (cperl-backward-to-noncomment lim)
3892 (and (eq (char-syntax (preceding-char)) ?w)
3893 (progn
3894 (forward-sexp -1)
3895 (looking-at "sub\\>"))))))
3896 (cperl-after-expr-p lim))))
f83d2997
KH
3897 (error nil))))
3898
3899(defun cperl-after-expr-p (&optional lim chars test)
029cb4d5 3900 "Return true if the position is good for start of expression.
f83d2997
KH
3901TEST is the expression to evaluate at the found position. If absent,
3902CHARS is a string that contains good characters to have before us (however,
3903`}' is treated \"smartly\" if it is not in the list)."
83261a2f 3904 (let ((lim (or lim (point-min)))
f739b53b
SM
3905 stop p pr)
3906 (cperl-update-syntaxification (point) (point))
f83d2997
KH
3907 (save-excursion
3908 (while (and (not stop) (> (point) lim))
3909 (skip-chars-backward " \t\n\f" lim)
3910 (setq p (point))
3911 (beginning-of-line)
f739b53b
SM
3912 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3913 ;; '(pod here-doc here-doc-delim))
3914 (if (get-text-property (point) 'here-doc-group)
3915 (progn
3916 (goto-char
3917 (previous-single-property-change (point) 'here-doc-group))
3918 (beginning-of-line 0)))
3919 (if (get-text-property (point) 'in-pod)
3920 (progn
3921 (goto-char
3922 (previous-single-property-change (point) 'in-pod))
3923 (beginning-of-line 0)))
f83d2997 3924 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
5bd52f0e 3925 ;; Else: last iteration, or a label
f739b53b 3926 (cperl-to-comment-or-eol) ; Will not move past "." after a format
f83d2997
KH
3927 (skip-chars-backward " \t")
3928 (if (< p (point)) (goto-char p))
5bd52f0e
RS
3929 (setq p (point))
3930 (if (and (eq (preceding-char) ?:)
3931 (progn
3932 (forward-char -1)
3933 (skip-chars-backward " \t\n\f" lim)
3934 (eq (char-syntax (preceding-char)) ?w)))
3935 (forward-sexp -1) ; Possibly label. Skip it
3936 (goto-char p)
3937 (setq stop t))))
bab27c0c
RS
3938 (or (bobp) ; ???? Needed
3939 (eq (point) lim)
029cb4d5 3940 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
f83d2997
KH
3941 (progn
3942 (if test (eval test)
3943 (or (memq (preceding-char) (append (or chars "{;") nil))
3944 (and (eq (preceding-char) ?\})
f739b53b
SM
3945 (cperl-after-block-p lim))
3946 (and (eq (following-char) ?.) ; in format: see comment above
3947 (eq (get-text-property (point) 'syntax-type)
3948 'format)))))))))
f83d2997
KH
3949
3950(defun cperl-backward-to-start-of-continued-exp (lim)
3951 (if (memq (preceding-char) (append ")]}\"'`" nil))
3952 (forward-sexp -1))
3953 (beginning-of-line)
3954 (if (<= (point) lim)
3955 (goto-char (1+ lim)))
3956 (skip-chars-forward " \t"))
3957
db133cb6
RS
3958(defun cperl-after-block-and-statement-beg (lim)
3959 ;; We assume that we are after ?\}
5c8b7eaf 3960 (and
db133cb6
RS
3961 (cperl-after-block-p lim)
3962 (save-excursion
3963 (forward-sexp -1)
3964 (cperl-backward-to-noncomment (point-min))
3965 (or (bobp)
bab27c0c 3966 (eq (point) lim)
db133cb6
RS
3967 (not (= (char-syntax (preceding-char)) ?w))
3968 (progn
3969 (forward-sexp -1)
5c8b7eaf 3970 (not
db133cb6
RS
3971 (looking-at
3972 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
3973
f83d2997 3974\f
f83d2997
KH
3975(defun cperl-indent-exp ()
3976 "Simple variant of indentation of continued-sexp.
5bd52f0e
RS
3977
3978Will not indent comment if it starts at `comment-indent' or looks like
3979continuation of the comment on the previous line.
db133cb6 3980
5c8b7eaf 3981If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 3982conditional/loop constructs."
f83d2997
KH
3983 (interactive)
3984 (save-excursion
3985 (let ((tmp-end (progn (end-of-line) (point))) top done)
3986 (save-excursion
3987 (beginning-of-line)
3988 (while (null done)
3989 (setq top (point))
3990 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
3991 -1)) -1)
3992 (setq top (point))) ; Get the outermost parenths in line
3993 (goto-char top)
3994 (while (< (point) tmp-end)
3995 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
3996 (or (eolp) (forward-sexp 1)))
5bd52f0e
RS
3997 (if (> (point) tmp-end)
3998 (save-excursion
3999 (end-of-line)
4000 (setq tmp-end (point)))
f83d2997
KH
4001 (setq done t)))
4002 (goto-char tmp-end)
4003 (setq tmp-end (point-marker)))
db133cb6
RS
4004 (if cperl-indent-region-fix-constructs
4005 (cperl-fix-line-spacing tmp-end))
f83d2997
KH
4006 (cperl-indent-region (point) tmp-end))))
4007
5bd52f0e
RS
4008(defun cperl-fix-line-spacing (&optional end parse-data)
4009 "Improve whitespace in a conditional/loop construct.
4010Returns some position at the last line."
db133cb6
RS
4011 (interactive)
4012 (or end
4013 (setq end (point-max)))
83261a2f
SM
4014 (let ((ee (save-excursion (end-of-line) (point)))
4015 (cperl-indent-region-fix-constructs
4016 (or cperl-indent-region-fix-constructs 1))
4017 p pp ml have-brace ret)
db133cb6
RS
4018 (save-excursion
4019 (beginning-of-line)
5bd52f0e 4020 (setq ret (point))
5c8b7eaf 4021 ;; }? continue
5bd52f0e 4022 ;; blah; }
5c8b7eaf 4023 (if (not
5bd52f0e
RS
4024 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
4025 (setq have-brace (save-excursion (search-forward "}" ee t)))))
4026 nil ; Do not need to do anything
83261a2f
SM
4027 ;; Looking at:
4028 ;; }
4029 ;; else
4030 (if (and cperl-merge-trailing-else
4031 (looking-at
4032 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
4033 (progn
4034 (search-forward "}")
4035 (setq p (point))
4036 (skip-chars-forward " \t\n")
4037 (delete-region p (point))
b5b0cb34 4038 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
4039 (beginning-of-line)))
4040 ;; Looking at:
4041 ;; } else
4042 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
4043 (progn
4044 (search-forward "}")
4045 (delete-horizontal-space)
b5b0cb34 4046 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
4047 (beginning-of-line)))
4048 ;; Looking at:
4049 ;; else {
4050 (if (looking-at
4051 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4052 (progn
4053 (forward-word 1)
4054 (delete-horizontal-space)
b5b0cb34 4055 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
4056 (beginning-of-line)))
4057 ;; Looking at:
4058 ;; foreach my $var
4059 (if (looking-at
4060 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
4061 (progn
4062 (forward-word 2)
4063 (delete-horizontal-space)
b5b0cb34 4064 (insert (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
4065 (beginning-of-line)))
4066 ;; Looking at:
4067 ;; foreach my $var (
4068 (if (looking-at
6c389151 4069 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
83261a2f 4070 (progn
f739b53b 4071 (forward-sexp 3)
83261a2f
SM
4072 (delete-horizontal-space)
4073 (insert
b5b0cb34 4074 (make-string cperl-indent-region-fix-constructs ?\s))
83261a2f
SM
4075 (beginning-of-line)))
4076 ;; Looking at:
4077 ;; } foreach my $var () {
4078 (if (looking-at
ce22dd53 4079 "[ \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
SM
4080 (progn
4081 (setq ml (match-beginning 8))
4082 (re-search-forward "[({]")
4083 (forward-char -1)
4084 (setq p (point))
4085 (if (eq (following-char) ?\( )
4086 (progn
4087 (forward-sexp 1)
4088 (setq pp (point)))
4089 ;; after `else' or nothing
4090 (if ml ; after `else'
4091 (skip-chars-backward " \t\n")
4092 (beginning-of-line))
4093 (setq pp nil))
4094 ;; Now after the sexp before the brace
4095 ;; Multiline expr should be special
4096 (setq ml (and pp (save-excursion (goto-char p)
4097 (search-forward "\n" pp t))))
4098 (if (and (or (not pp) (< pp end))
4099 (looking-at "[ \t\n]*{"))
4100 (progn
4101 (cond
4102 ((bolp) ; Were before `{', no if/else/etc
4103 nil)
4104 ((looking-at "\\(\t*\\| [ \t]+\\){")
4105 (delete-horizontal-space)
4106 (if (if ml
4107 cperl-extra-newline-before-brace-multiline
4108 cperl-extra-newline-before-brace)
4109 (progn
4110 (delete-horizontal-space)
4111 (insert "\n")
4112 (setq ret (point))
4113 (if (cperl-indent-line parse-data)
4114 (progn
4115 (cperl-fix-line-spacing end parse-data)
4116 (setq ret (point)))))
4117 (insert
b5b0cb34 4118 (make-string cperl-indent-region-fix-constructs ?\s))))
83261a2f
SM
4119 ((and (looking-at "[ \t]*\n")
4120 (not (if ml
4121 cperl-extra-newline-before-brace-multiline
4122 cperl-extra-newline-before-brace)))
4123 (setq pp (point))
4124 (skip-chars-forward " \t\n")
4125 (delete-region pp (point))
db133cb6 4126 (insert
b5b0cb34 4127 (make-string cperl-indent-region-fix-constructs ?\s))))
83261a2f
SM
4128 ;; Now we are before `{'
4129 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
4130 (progn
4131 (skip-chars-forward " \t\n")
4132 (setq pp (point))
4133 (forward-sexp 1)
4134 (setq p (point))
4135 (goto-char pp)
4136 (setq ml (search-forward "\n" p t))
4137 (if (or cperl-break-one-line-blocks-when-indent ml)
4138 ;; not good: multi-line BLOCK
4139 (progn
4140 (goto-char (1+ pp))
4141 (delete-horizontal-space)
4142 (insert "\n")
4143 (setq ret (point))
4144 (if (cperl-indent-line parse-data)
4145 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
4146 (beginning-of-line)
4147 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
4148 ;; Now check whether there is a hanging `}'
4149 ;; Looking at:
4150 ;; } blah
4151 (if (and
4152 cperl-fix-hanging-brace-when-indent
4153 have-brace
4154 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4155 (condition-case nil
4156 (progn
4157 (up-list 1)
4158 (if (and (<= (point) pp)
4159 (eq (preceding-char) ?\} )
4160 (cperl-after-block-and-statement-beg (point-min)))
4161 t
4162 (goto-char p)
4163 nil))
4164 (error nil)))
4165 (progn
4166 (forward-char -1)
4167 (skip-chars-backward " \t")
4168 (if (bolp)
4169 ;; `}' was the first thing on the line, insert NL *after* it.
4170 (progn
4171 (cperl-indent-line parse-data)
4172 (search-forward "}")
4173 (delete-horizontal-space)
4174 (insert "\n"))
4175 (delete-horizontal-space)
4176 (or (eq (preceding-char) ?\;)
4177 (bolp)
4178 (and (eq (preceding-char) ?\} )
4179 (cperl-after-block-p (point-min)))
4180 (insert ";"))
4181 (insert "\n")
4182 (setq ret (point)))
4183 (if (cperl-indent-line parse-data)
4184 (setq ret (cperl-fix-line-spacing end parse-data)))
4185 (beginning-of-line)))))
5bd52f0e
RS
4186 ret))
4187
4188(defvar cperl-update-start) ; Do not need to make them local
4189(defvar cperl-update-end)
4190(defun cperl-delay-update-hook (beg end old-len)
4191 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
4192 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
db133cb6 4193
f83d2997
KH
4194(defun cperl-indent-region (start end)
4195 "Simple variant of indentation of region in CPerl mode.
5c8b7eaf 4196Should be slow. Will not indent comment if it starts at `comment-indent'
f83d2997 4197or looks like continuation of the comment on the previous line.
5c8b7eaf
SS
4198Indents all the lines whose first character is between START and END
4199inclusive.
db133cb6 4200
5c8b7eaf 4201If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 4202conditional/loop constructs."
f83d2997 4203 (interactive "r")
5bd52f0e 4204 (cperl-update-syntaxification end end)
f83d2997 4205 (save-excursion
5bd52f0e 4206 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
83261a2f
SM
4207 (let ((indent-info (if cperl-emacs-can-parse
4208 (list nil nil nil) ; Cannot use '(), since will modify
4209 nil))
c326ddd1 4210 (pm 0)
83261a2f
SM
4211 after-change-functions ; Speed it up!
4212 st comm old-comm-indent new-comm-indent p pp i empty)
5bd52f0e 4213 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
83261a2f
SM
4214 (goto-char start)
4215 (setq old-comm-indent (and (cperl-to-comment-or-eol)
4216 (current-column))
4217 new-comm-indent old-comm-indent)
4218 (goto-char start)
4219 (setq end (set-marker (make-marker) end)) ; indentation changes pos
4220 (or (bolp) (beginning-of-line 2))
83261a2f 4221 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5bd52f0e
RS
4222 (setq st (point))
4223 (if (or
4224 (setq empty (looking-at "[ \t]*\n"))
4225 (and (setq comm (looking-at "[ \t]*#"))
83261a2f
SM
4226 (or (eq (current-indentation) (or old-comm-indent
4227 comment-column))
5bd52f0e 4228 (setq old-comm-indent nil))))
f83d2997 4229 (if (and old-comm-indent
5bd52f0e 4230 (not empty)
f83d2997 4231 (= (current-indentation) old-comm-indent)
5bd52f0e
RS
4232 (not (eq (get-text-property (point) 'syntax-type) 'pod))
4233 (not (eq (get-text-property (point) 'syntax-table)
4234 cperl-st-cfence)))
83261a2f
SM
4235 (let ((comment-column new-comm-indent))
4236 (indent-for-comment)))
4237 (progn
5bd52f0e 4238 (setq i (cperl-indent-line indent-info))
f83d2997 4239 (or comm
db133cb6 4240 (not i)
f83d2997 4241 (progn
db133cb6 4242 (if cperl-indent-region-fix-constructs
5bd52f0e 4243 (goto-char (cperl-fix-line-spacing end indent-info)))
83261a2f
SM
4244 (if (setq old-comm-indent
4245 (and (cperl-to-comment-or-eol)
4246 (not (memq (get-text-property (point)
4247 'syntax-type)
4248 '(pod here-doc)))
5c8b7eaf 4249 (not (eq (get-text-property (point)
5bd52f0e
RS
4250 'syntax-table)
4251 cperl-st-cfence))
f83d2997
KH
4252 (current-column)))
4253 (progn (indent-for-comment)
4254 (skip-chars-backward " \t")
4255 (skip-chars-backward "#")
4256 (setq new-comm-indent (current-column))))))))
335dd1f1 4257 (beginning-of-line 2)))
5bd52f0e 4258 ;; Now run the update hooks
83261a2f
SM
4259 (and after-change-functions
4260 cperl-update-end
4261 (save-excursion
4262 (goto-char cperl-update-end)
4263 (insert " ")
4264 (delete-char -1)
4265 (goto-char cperl-update-start)
4266 (insert " ")
4267 (delete-char -1))))))
f83d2997 4268
f83d2997
KH
4269;; Stolen from lisp-mode with a lot of improvements
4270
4271(defun cperl-fill-paragraph (&optional justify iteration)
82eb0dae 4272 "Like `fill-paragraph', but handle CPerl comments.
f83d2997
KH
4273If any of the current line is a comment, fill the comment or the
4274block of it that point is in, preserving the comment's initial
4275indentation and initial hashes. Behaves usually outside of comment."
82eb0dae 4276 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
83261a2f 4277 (let (;; Non-nil if the current line contains a comment.
f83d2997
KH
4278 has-comment
4279
4280 ;; If has-comment, the appropriate fill-prefix for the comment.
4281 comment-fill-prefix
4282 ;; Line that contains code and comment (or nil)
4283 start
4284 c spaces len dc (comment-column comment-column))
4285 ;; Figure out what kind of comment we are looking at.
4286 (save-excursion
4287 (beginning-of-line)
4288 (cond
4289
4290 ;; A line with nothing but a comment on it?
4291 ((looking-at "[ \t]*#[# \t]*")
4292 (setq has-comment t
4293 comment-fill-prefix (buffer-substring (match-beginning 0)
4294 (match-end 0))))
4295
4296 ;; A line with some code, followed by a comment? Remember that the
4297 ;; semi which starts the comment shouldn't be part of a string or
4298 ;; character.
4299 ((cperl-to-comment-or-eol)
4300 (setq has-comment t)
4301 (looking-at "#+[ \t]*")
5c8b7eaf 4302 (setq start (point) c (current-column)
f83d2997 4303 comment-fill-prefix
b5b0cb34 4304 (concat (make-string (current-column) ?\s)
f83d2997 4305 (buffer-substring (match-beginning 0) (match-end 0)))
5c8b7eaf 4306 spaces (progn (skip-chars-backward " \t")
f83d2997 4307 (buffer-substring (point) start))
5c8b7eaf 4308 dc (- c (current-column)) len (- start (point))
f83d2997
KH
4309 start (point-marker))
4310 (delete-char len)
4311 (insert (make-string dc ?-)))))
4312 (if (not has-comment)
83261a2f 4313 (fill-paragraph justify) ; Do the usual thing outside of comment
f83d2997
KH
4314 ;; Narrow to include only the comment, and then fill the region.
4315 (save-restriction
4316 (narrow-to-region
4317 ;; Find the first line we should include in the region to fill.
4318 (if start (progn (beginning-of-line) (point))
4319 (save-excursion
4320 (while (and (zerop (forward-line -1))
4321 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4322 ;; We may have gone to far. Go forward again.
4323 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4324 (forward-line 1))
4325 (point)))
4326 ;; Find the beginning of the first line past the region to fill.
4327 (save-excursion
4328 (while (progn (forward-line 1)
4329 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4330 (point)))
4331 ;; Remove existing hashes
cff301be
SM
4332 (save-excursion
4333 (goto-char (point-min))
4334 (while (progn (forward-line 1) (< (point) (point-max)))
4335 (skip-chars-forward " \t")
4336 (and (looking-at "#+")
4337 (delete-char (- (match-end 0) (match-beginning 0))))))
f83d2997
KH
4338
4339 ;; Lines with only hashes on them can be paragraph boundaries.
4340 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
4341 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
4342 (fill-prefix comment-fill-prefix))
4343 (fill-paragraph justify)))
4344 (if (and start)
5c8b7eaf 4345 (progn
f83d2997
KH
4346 (goto-char start)
4347 (if (> dc 0)
83261a2f 4348 (progn (delete-char dc) (insert spaces)))
f83d2997
KH
4349 (if (or (= (current-column) c) iteration) nil
4350 (setq comment-column c)
4351 (indent-for-comment)
4352 ;; Repeat once more, flagging as iteration
4353 (cperl-fill-paragraph justify t)))))))
4354
4355(defun cperl-do-auto-fill ()
4356 ;; Break out if the line is short enough
4357 (if (> (save-excursion
4358 (end-of-line)
4359 (current-column))
4360 fill-column)
83261a2f
SM
4361 (let ((c (save-excursion (beginning-of-line)
4362 (cperl-to-comment-or-eol) (point)))
8038e2cf 4363 (s (memq (following-char) '(?\s ?\t))) marker)
82eb0dae
SM
4364 (if (>= c (point))
4365 ;; Don't break line inside code: only inside comment.
4366 nil
83261a2f 4367 (setq marker (point-marker))
82eb0dae 4368 (fill-paragraph nil)
83261a2f
SM
4369 (goto-char marker)
4370 ;; Is not enough, sometimes marker is a start of line
4371 (if (bolp) (progn (re-search-forward "#+[ \t]*")
4372 (goto-char (match-end 0))))
4373 ;; Following space could have gone:
8038e2cf 4374 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
83261a2f
SM
4375 (insert " ")
4376 (backward-char 1))
4377 ;; Previous space could have gone:
8038e2cf 4378 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
f83d2997 4379
f83d2997
KH
4380(defun cperl-imenu-addback (lst &optional isback name)
4381 ;; We suppose that the lst is a DAG, unless the first element only
4382 ;; loops back, and ISBACK is set. Thus this function cannot be
4383 ;; applied twice without ISBACK set.
4384 (cond ((not cperl-imenu-addback) lst)
4385 (t
5c8b7eaf 4386 (or name
f83d2997 4387 (setq name "+++BACK+++"))
83261a2f
SM
4388 (mapcar (lambda (elt)
4389 (if (and (listp elt) (listp (cdr elt)))
4390 (progn
4391 ;; In the other order it goes up
4392 ;; one level only ;-(
4393 (setcdr elt (cons (cons name lst)
4394 (cdr elt)))
4395 (cperl-imenu-addback (cdr elt) t name))))
f83d2997
KH
4396 (if isback (cdr lst) lst))
4397 lst)))
4398
80585273 4399(defun cperl-imenu--create-perl-index (&optional regexp)
f83d2997 4400 (require 'imenu) ; May be called from TAGS creator
5c8b7eaf 4401 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
f83d2997
KH
4402 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
4403 (index-meth-alist '()) meth
6c389151 4404 packages ends-ranges p marker
f83d2997
KH
4405 (prev-pos 0) char fchar index index1 name (end-range 0) package)
4406 (goto-char (point-min))
6c389151 4407 (cperl-update-syntaxification (point-max) (point-max))
f83d2997
KH
4408 ;; Search for the function
4409 (progn ;;save-match-data
4410 (while (re-search-forward
80585273 4411 (or regexp cperl-imenu--function-name-regexp-perl)
f83d2997 4412 nil t)
f83d2997
KH
4413 (cond
4414 ((and ; Skip some noise if building tags
4415 (match-beginning 2) ; package or sub
4416 (eq (char-after (match-beginning 2)) ?p) ; package
4417 (not (save-match-data
83261a2f 4418 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
f83d2997
KH
4419 nil)
4420 ((and
4421 (match-beginning 2) ; package or sub
6c389151 4422 ;; Skip if quoted (will not skip multi-line ''-strings :-():
f83d2997
KH
4423 (null (get-text-property (match-beginning 1) 'syntax-table))
4424 (null (get-text-property (match-beginning 1) 'syntax-type))
4425 (null (get-text-property (match-beginning 1) 'in-pod)))
4426 (save-excursion
4427 (goto-char (match-beginning 2))
83261a2f 4428 (setq fchar (following-char)))
f83d2997
KH
4429 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4430 ;; (goto-char (match-end 0))) ; Messes what follows
6c389151 4431 (setq char (following-char) ; ?\; for "sub foo () ;"
f83d2997
KH
4432 meth nil
4433 p (point))
4434 (while (and ends-ranges (>= p (car ends-ranges)))
4435 ;; delete obsolete entries
4436 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
4437 (setq package (or (car packages) "")
4438 end-range (or (car ends-ranges) 0))
4439 (if (eq fchar ?p)
4440 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4441 name (progn
4442 (set-text-properties 0 (length name) nil name)
4443 name)
5c8b7eaf 4444 package (concat name "::")
f83d2997 4445 name (concat "package " name)
5c8b7eaf 4446 end-range
f83d2997
KH
4447 (save-excursion
4448 (parse-partial-sexp (point) (point-max) -1) (point))
4449 ends-ranges (cons end-range ends-ranges)
4450 packages (cons package packages)))
4451 ;; )
4452 ;; Skip this function name if it is a prototype declaration.
4453 (if (and (eq fchar ?s) (eq char ?\;)) nil
6c389151
SM
4454 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4455 marker (make-marker))
4456 (set-text-properties 0 (length name) nil name)
4457 (set-marker marker (match-end 3))
a1506d29 4458 (if (eq fchar ?p)
6c389151 4459 (setq name (concat "package " name))
f83d2997
KH
4460 (cond ((string-match "[:']" name)
4461 (setq meth t))
4462 ((> p end-range) nil)
5c8b7eaf 4463 (t
f83d2997 4464 (setq name (concat package name) meth t))))
6c389151 4465 (setq index (cons name marker))
a1506d29 4466 (if (eq fchar ?p)
f83d2997
KH
4467 (push index index-pack-alist)
4468 (push index index-alist))
4469 (if meth (push index index-meth-alist))
4470 (push index index-unsorted-alist)))
83261a2f 4471 ((match-beginning 5) ; POD section
f83d2997
KH
4472 ;; (beginning-of-line)
4473 (setq index (imenu-example--name-and-position)
4474 name (buffer-substring (match-beginning 6) (match-end 6)))
4475 (set-text-properties 0 (length name) nil name)
4476 (if (eq (char-after (match-beginning 5)) ?2)
4477 (setq name (concat " " name)))
4478 (setcar index name)
4479 (setq index1 (cons (concat "=" name) (cdr index)))
4480 (push index index-pod-alist)
4481 (push index1 index-unsorted-alist)))))
5c8b7eaf 4482 (setq index-alist
f83d2997
KH
4483 (if (default-value 'imenu-sort-function)
4484 (sort index-alist (default-value 'imenu-sort-function))
83261a2f 4485 (nreverse index-alist)))
f83d2997
KH
4486 (and index-pod-alist
4487 (push (cons "+POD headers+..."
4488 (nreverse index-pod-alist))
4489 index-alist))
4490 (and (or index-pack-alist index-meth-alist)
4491 (let ((lst index-pack-alist) hier-list pack elt group name)
4492 ;; Remove "package ", reverse and uniquify.
4493 (while lst
4494 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
4495 (if (assoc name hier-list) nil
4496 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
4497 (setq lst index-meth-alist)
4498 (while lst
4499 (setq elt (car lst) lst (cdr lst))
4500 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
4501 (setq pack (substring (car elt) 0 (match-beginning 0)))
5c8b7eaf 4502 (if (setq group (assoc pack hier-list))
f83d2997
KH
4503 (if (listp (cdr group))
4504 ;; Have some functions already
5c8b7eaf
SS
4505 (setcdr group
4506 (cons (cons (substring
f83d2997
KH
4507 (car elt)
4508 (+ 2 (match-beginning 0)))
4509 (cdr elt))
4510 (cdr group)))
5c8b7eaf 4511 (setcdr group (list (cons (substring
f83d2997
KH
4512 (car elt)
4513 (+ 2 (match-beginning 0)))
4514 (cdr elt)))))
5c8b7eaf
SS
4515 (setq hier-list
4516 (cons (cons pack
4517 (list (cons (substring
f83d2997
KH
4518 (car elt)
4519 (+ 2 (match-beginning 0)))
4520 (cdr elt))))
4521 hier-list))))))
4522 (push (cons "+Hierarchy+..."
4523 hier-list)
4524 index-alist)))
4525 (and index-pack-alist
4526 (push (cons "+Packages+..."
4527 (nreverse index-pack-alist))
4528 index-alist))
5c8b7eaf 4529 (and (or index-pack-alist index-pod-alist
f83d2997
KH
4530 (default-value 'imenu-sort-function))
4531 index-unsorted-alist
4532 (push (cons "+Unsorted List+..."
4533 (nreverse index-unsorted-alist))
4534 index-alist))
4535 (cperl-imenu-addback index-alist)))
4536
6c389151 4537\f
6c389151
SM
4538;; Suggested by Mark A. Hershberger
4539(defun cperl-outline-level ()
4540 (looking-at outline-regexp)
4541 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4542 ((match-beginning 2)
4543 (if (eq (char-after (match-beginning 2)) ?p)
4544 0 ; package
4545 1)) ; sub
4546 ((match-beginning 5)
4547 (if (eq (char-after (match-beginning 5)) ?1)
4548 1 ; head1
4549 2)) ; head2
4550 (t 3))) ; should not happen
4551
4552\f
a1506d29 4553(defvar cperl-compilation-error-regexp-alist
f83d2997
KH
4554 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4555 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
4556 2 3))
4557 "Alist that specifies how to match errors in perl output.")
4558
4559(if (fboundp 'eval-after-load)
4560 (eval-after-load
83261a2f
SM
4561 "mode-compile"
4562 '(setq perl-compilation-error-regexp-alist
4563 cperl-compilation-error-regexp-alist)))
f83d2997
KH
4564
4565
f83d2997
KH
4566(defun cperl-windowed-init ()
4567 "Initialization under windowed version."
db133cb6
RS
4568 (if (or (featurep 'ps-print) cperl-faces-init)
4569 ;; Need to init anyway:
4570 (or cperl-faces-init (cperl-init-faces))
4571 (add-hook 'font-lock-mode-hook
4572 (function
4573 (lambda ()
996e2616 4574 (if (memq major-mode '(perl-mode cperl-mode))
db133cb6
RS
4575 (progn
4576 (or cperl-faces-init (cperl-init-faces)))))))
4577 (if (fboundp 'eval-after-load)
4578 (eval-after-load
83261a2f
SM
4579 "ps-print"
4580 '(or cperl-faces-init (cperl-init-faces))))))
db133cb6 4581
5efe6a56 4582(defvar cperl-font-lock-keywords-1 nil
80585273 4583 "Additional expressions to highlight in Perl mode. Minimal set.")
5efe6a56 4584(defvar cperl-font-lock-keywords nil
80585273 4585 "Additional expressions to highlight in Perl mode. Default set.")
5efe6a56 4586(defvar cperl-font-lock-keywords-2 nil
80585273
DL
4587 "Additional expressions to highlight in Perl mode. Maximal set")
4588
db133cb6
RS
4589(defun cperl-load-font-lock-keywords ()
4590 (or cperl-faces-init (cperl-init-faces))
5efe6a56 4591 cperl-font-lock-keywords)
db133cb6
RS
4592
4593(defun cperl-load-font-lock-keywords-1 ()
4594 (or cperl-faces-init (cperl-init-faces))
5efe6a56 4595 cperl-font-lock-keywords-1)
db133cb6
RS
4596
4597(defun cperl-load-font-lock-keywords-2 ()
4598 (or cperl-faces-init (cperl-init-faces))
5efe6a56 4599 cperl-font-lock-keywords-2)
f83d2997 4600
5bd52f0e
RS
4601(defun cperl-init-faces-weak ()
4602 ;; Allow `cperl-find-pods-heres' to run.
4603 (or (boundp 'font-lock-constant-face)
4604 (cperl-force-face font-lock-constant-face
4605 "Face for constant and label names")
4606 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4607 ))
4608
f83d2997 4609(defun cperl-init-faces ()
5bd52f0e 4610 (condition-case errs
f83d2997
KH
4611 (progn
4612 (require 'font-lock)
4613 (and (fboundp 'font-lock-fontify-anchored-keywords)
4614 (featurep 'font-lock-extra)
4615 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
4616 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
f83d2997
KH
4617 (if (fboundp 'font-lock-fontify-anchored-keywords)
4618 (setq font-lock-anchored t))
5c8b7eaf 4619 (setq
f83d2997
KH
4620 t-font-lock-keywords
4621 (list
ac6857fb 4622 `("[ \t]+$" 0 ',cperl-invalid-face t)
f83d2997
KH
4623 (cons
4624 (concat
4625 "\\(^\\|[^$@%&\\]\\)\\<\\("
4626 (mapconcat
4627 'identity
4628 '("if" "until" "while" "elsif" "else" "unless" "for"
4629 "foreach" "continue" "exit" "die" "last" "goto" "next"
4630 "redo" "return" "local" "exec" "sub" "do" "dump" "use"
6c389151 4631 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
f83d2997
KH
4632 "\\|") ; Flow control
4633 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
4634 ; In what follows we use `type' style
4635 ; for overwritable builtins
4636 (list
4637 (concat
4638 "\\(^\\|[^$@%&\\]\\)\\<\\("
4639 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4640 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4641 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4642 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4643 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4644 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4645 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4646 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4647 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4648 ;; "gethostbyname" "gethostent" "getlogin"
4649 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4650 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4651 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4652 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4653 ;; "getservbyport" "getservent" "getsockname"
4654 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4655 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5bd52f0e 4656 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
f83d2997
KH
4657 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4658 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4659 ;; "quotemeta" "rand" "read" "readdir" "readline"
4660 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4661 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4662 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4663 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4664 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4665 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4666 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4667 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
6c389151 4668 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
f83d2997
KH
4669 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4670 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4671 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5c8b7eaf 4672 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
f83d2997
KH
4673 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
4674 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
4675 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
4676 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
4677 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
4678 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
4679 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
4680 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
4681 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
4682 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
4683 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
4684 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
4685 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
4686 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
4687 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5bd52f0e 4688 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
f83d2997
KH
4689 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
4690 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
4691 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
4692 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
4693 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
4694 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
4695 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
4696 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
6c389151 4697 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
f83d2997
KH
4698 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
4699 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
4700 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
4701 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
4702 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4703 "\\)\\>") 2 'font-lock-type-face)
4704 ;; In what follows we use `other' style
4705 ;; for nonoverwritable builtins
4706 ;; Somehow 's', 'm' are not auto-generated???
4707 (list
4708 (concat
4709 "\\(^\\|[^$@%&\\]\\)\\<\\("
6c389151 4710 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
f83d2997
KH
4711 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4712 ;; "eval" "exists" "for" "foreach" "format" "goto"
4713 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4714 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4715 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4716 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4717 ;; "undef" "unless" "unshift" "untie" "until" "use"
4718 ;; "while" "y"
6c389151 4719 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
f83d2997 4720 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
6c389151
SM
4721 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
4722 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
f83d2997 4723 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5bd52f0e 4724 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
f83d2997
KH
4725 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
4726 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
4727 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
4728 "\\|[sm]" ; Added manually
e4c067b5 4729 "\\)\\>") 2 'cperl-nonoverridable)
f83d2997
KH
4730 ;; (mapconcat 'identity
4731 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4732 ;; "#include" "#define" "#undef")
4733 ;; "\\|")
4734 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
4735 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5bd52f0e 4736 '("\\<sub[ \t]+\\([^ \t{;()]+\\)[ \t]*\\(([^()]*)[ \t]*\\)?[#{\n]" 1
f83d2997
KH
4737 font-lock-function-name-face)
4738 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4739 2 font-lock-function-name-face)
4740 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
4741 1 font-lock-function-name-face)
4742 (cond ((featurep 'font-lock-extra)
5c8b7eaf 4743 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
f83d2997
KH
4744 (2 font-lock-string-face t)
4745 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
4746 (font-lock-anchored
4747 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4748 (2 font-lock-string-face t)
4749 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4750 nil nil
4751 (1 font-lock-string-face t))))
4752 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4753 2 font-lock-string-face t)))
db133cb6 4754 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
f83d2997 4755 font-lock-string-face t)
5c8b7eaf 4756 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
83261a2f 4757 font-lock-constant-face) ; labels
f83d2997 4758 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
883212ce 4759 2 font-lock-constant-face)
6c389151
SM
4760 ;; Uncomment to get perl-mode-like vars
4761 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4762 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4763 ;;; (2 (cons font-lock-variable-name-face '(underline))))
f83d2997 4764 (cond ((featurep 'font-lock-extra)
6c389151 4765 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
f83d2997
KH
4766 (3 font-lock-variable-name-face)
4767 (4 '(another 4 nil
4768 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4769 (1 font-lock-variable-name-face)
5c8b7eaf 4770 (2 '(restart 2 nil) nil t)))
f83d2997
KH
4771 nil t))) ; local variables, multiple
4772 (font-lock-anchored
6c389151 4773 '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
f83d2997
KH
4774 (3 font-lock-variable-name-face)
4775 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)"
4776 nil nil
4777 (1 font-lock-variable-name-face))))
6c389151 4778 (t '("^[ \t{}]*\\(my\\|local\\our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
f83d2997 4779 3 font-lock-variable-name-face)))
6c389151 4780 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
eb6121fc 4781 4 font-lock-variable-name-face)
9ed9fd35
DP
4782 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
4783 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
eb6121fc 4784 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
a1506d29 4785 (setq
f83d2997
KH
4786 t-font-lock-keywords-1
4787 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
83261a2f 4788 (not cperl-xemacs-p) ; not yet as of XEmacs 19.12
f83d2997
KH
4789 '(
4790 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
4791 (if (eq (char-after (match-beginning 2)) ?%)
e6572f79
MB
4792 'cperl-hash
4793 'cperl-array)
f83d2997
KH
4794 t) ; arrays and hashes
4795 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
4796 1
5c8b7eaf 4797 (if (= (- (match-end 2) (match-beginning 2)) 1)
f83d2997 4798 (if (eq (char-after (match-beginning 3)) ?{)
e6572f79
MB
4799 'cperl-hash
4800 'cperl-array) ; arrays and hashes
f83d2997
KH
4801 font-lock-variable-name-face) ; Just to put something
4802 t)
4803 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4804 ;;; Too much noise from \s* @s[ and friends
5c8b7eaf 4805 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
f83d2997
KH
4806 ;;(3 font-lock-function-name-face t t)
4807 ;;(4
4808 ;; (if (cperl-slash-is-regexp)
4809 ;; font-lock-function-name-face 'default) nil t))
4810 )))
6c389151
SM
4811 (if cperl-highlight-variables-indiscriminately
4812 (setq t-font-lock-keywords-1
4813 (append t-font-lock-keywords-1
4814 (list '("[$*]{?\\(\\sw+\\)" 1
4815 font-lock-variable-name-face)))))
a1506d29 4816 (setq cperl-font-lock-keywords-1
5bd52f0e
RS
4817 (if cperl-syntaxify-by-font-lock
4818 (cons 'cperl-fontify-update
4819 t-font-lock-keywords)
4820 t-font-lock-keywords)
5efe6a56
SM
4821 cperl-font-lock-keywords cperl-font-lock-keywords-1
4822 cperl-font-lock-keywords-2 (append
6c389151
SM
4823 cperl-font-lock-keywords-1
4824 t-font-lock-keywords-1)))
f83d2997
KH
4825 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
4826 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
db133cb6 4827 (eval ; Avoid a warning
83261a2f
SM
4828 '(font-lock-require-faces
4829 (list
4830 ;; Color-light Color-dark Gray-light Gray-dark Mono
4831 (list 'font-lock-comment-face
4832 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
4833 nil
4834 [nil nil t t t]
4835 [nil nil t t t]
4836 nil)
4837 (list 'font-lock-string-face
4838 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
4839 nil
4840 nil
4841 [nil nil t t t]
4842 nil)
4843 (list 'font-lock-function-name-face
4844 (vector
4845 "Blue" "LightSkyBlue" "Gray50" "LightGray"
4846 (cdr (assq 'background-color ; if mono
4847 (frame-parameters))))
4848 (vector
4849 nil nil nil nil
4850 (cdr (assq 'foreground-color ; if mono
4851 (frame-parameters))))
4852 [nil nil t t t]
4853 nil
4854 nil)
4855 (list 'font-lock-variable-name-face
4856 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
4857 nil
4858 [nil nil t t t]
4859 [nil nil t t t]
4860 nil)
4861 (list 'font-lock-type-face
4862 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
4863 nil
4864 [nil nil t t t]
4865 nil
4866 [nil nil t t t])
4867 (list 'font-lock-constant-face
4868 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
4869 nil
4870 [nil nil t t t]
4871 nil
4872 [nil nil t t t])
e4c067b5 4873 (list 'cperl-nonoverridable
83261a2f
SM
4874 ["chartreuse3" ("orchid1" "orange")
4875 nil "Gray80"]
4876 [nil nil "gray90"]
4877 [nil nil nil t t]
4878 [nil nil t t]
4879 [nil nil t t t])
e4c067b5 4880 (list 'cperl-array
83261a2f
SM
4881 ["blue" "yellow" nil "Gray80"]
4882 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4883 "gray90"]
4884 t
4885 nil
4886 nil)
e4c067b5 4887 (list 'cperl-hash
83261a2f
SM
4888 ["red" "red" nil "Gray80"]
4889 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4890 "gray90"]
4891 t
4892 t
4893 nil))))
5bd52f0e 4894 ;; Do it the dull way, without choose-color
f83d2997
KH
4895 (defvar cperl-guessed-background nil
4896 "Display characteristics as guessed by cperl.")
83261a2f 4897 ;; (or (fboundp 'x-color-defined-p)
15ca5699 4898 ;; (defalias 'x-color-defined-p
83261a2f
SM
4899 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4900 ;; ;; XEmacs >= 19.12
4901 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4902 ;; ;; XEmacs 19.11
4903 ;; (t 'x-valid-color-name-p))))
5c8b7eaf 4904 (cperl-force-face font-lock-constant-face
5bd52f0e
RS
4905 "Face for constant and label names")
4906 (cperl-force-face font-lock-variable-name-face
4907 "Face for variable names")
4908 (cperl-force-face font-lock-type-face
4909 "Face for data types")
e4c067b5 4910 (cperl-force-face cperl-nonoverridable
5bd52f0e
RS
4911 "Face for data types from another group")
4912 (cperl-force-face font-lock-comment-face
4913 "Face for comments")
4914 (cperl-force-face font-lock-function-name-face
4915 "Face for function names")
e4c067b5 4916 (cperl-force-face cperl-hash
5bd52f0e 4917 "Face for hashes")
e4c067b5 4918 (cperl-force-face cperl-array
5bd52f0e
RS
4919 "Face for arrays")
4920 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4921 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4922 ;;(or (boundp 'font-lock-type-face)
4923 ;; (defconst font-lock-type-face
4924 ;; 'font-lock-type-face
4925 ;; "Face to use for data types."))
4926 ;;(or (boundp 'cperl-nonoverridable-face)
4927 ;; (defconst cperl-nonoverridable-face
e4c067b5 4928 ;; 'cperl-nonoverridable
5bd52f0e
RS
4929 ;; "Face to use for data types from another group."))
4930 ;;(if (not cperl-xemacs-p) nil
4931 ;; (or (boundp 'font-lock-comment-face)
4932 ;; (defconst font-lock-comment-face
4933 ;; 'font-lock-comment-face
4934 ;; "Face to use for comments."))
4935 ;; (or (boundp 'font-lock-keyword-face)
4936 ;; (defconst font-lock-keyword-face
4937 ;; 'font-lock-keyword-face
4938 ;; "Face to use for keywords."))
4939 ;; (or (boundp 'font-lock-function-name-face)
4940 ;; (defconst font-lock-function-name-face
4941 ;; 'font-lock-function-name-face
4942 ;; "Face to use for function names.")))
4943 (if (and
e4c067b5 4944 (not (cperl-is-face 'cperl-array))
5c8b7eaf 4945 (cperl-is-face 'font-lock-emphasized-face))
e4c067b5 4946 (copy-face 'font-lock-emphasized-face 'cperl-array))
5bd52f0e 4947 (if (and
e4c067b5 4948 (not (cperl-is-face 'cperl-hash))
5c8b7eaf 4949 (cperl-is-face 'font-lock-other-emphasized-face))
e4c067b5 4950 (copy-face 'font-lock-other-emphasized-face 'cperl-hash))
5bd52f0e 4951 (if (and
e4c067b5 4952 (not (cperl-is-face 'cperl-nonoverridable))
5c8b7eaf 4953 (cperl-is-face 'font-lock-other-type-face))
e4c067b5 4954 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable))
5bd52f0e
RS
4955 ;;(or (boundp 'cperl-hash-face)
4956 ;; (defconst cperl-hash-face
e4c067b5 4957 ;; 'cperl-hash
5bd52f0e
RS
4958 ;; "Face to use for hashes."))
4959 ;;(or (boundp 'cperl-array-face)
4960 ;; (defconst cperl-array-face
e4c067b5 4961 ;; 'cperl-array
5bd52f0e 4962 ;; "Face to use for arrays."))
f83d2997
KH
4963 ;; Here we try to guess background
4964 (let ((background
4965 (if (boundp 'font-lock-background-mode)
4966 font-lock-background-mode
5c8b7eaf 4967 'light))
83261a2f 4968 (face-list (and (fboundp 'face-list) (face-list))))
5bd52f0e
RS
4969;;;; (fset 'cperl-is-face
4970;;;; (cond ((fboundp 'find-face)
4971;;;; (symbol-function 'find-face))
4972;;;; (face-list
4973;;;; (function (lambda (face) (member face face-list))))
4974;;;; (t
4975;;;; (function (lambda (face) (boundp face))))))
f83d2997
KH
4976 (defvar cperl-guessed-background
4977 (if (and (boundp 'font-lock-display-type)
4978 (eq font-lock-display-type 'grayscale))
4979 'gray
4980 background)
4981 "Background as guessed by CPerl mode")
83261a2f
SM
4982 (and (not (cperl-is-face 'font-lock-constant-face))
4983 (cperl-is-face 'font-lock-reference-face)
4984 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
db133cb6 4985 (if (cperl-is-face 'font-lock-type-face) nil
f83d2997
KH
4986 (copy-face 'default 'font-lock-type-face)
4987 (cond
4988 ((eq background 'light)
4989 (set-face-foreground 'font-lock-type-face
4990 (if (x-color-defined-p "seagreen")
4991 "seagreen"
4992 "sea green")))
4993 ((eq background 'dark)
4994 (set-face-foreground 'font-lock-type-face
4995 (if (x-color-defined-p "os2pink")
4996 "os2pink"
4997 "pink")))
4998 (t
4999 (set-face-background 'font-lock-type-face "gray90"))))
e4c067b5 5000 (if (cperl-is-face 'cperl-nonoverridable)
f83d2997 5001 nil
e4c067b5 5002 (copy-face 'font-lock-type-face 'cperl-nonoverridable)
f83d2997
KH
5003 (cond
5004 ((eq background 'light)
e4c067b5 5005 (set-face-foreground 'cperl-nonoverridable
f83d2997
KH
5006 (if (x-color-defined-p "chartreuse3")
5007 "chartreuse3"
5008 "chartreuse")))
5009 ((eq background 'dark)
e4c067b5 5010 (set-face-foreground 'cperl-nonoverridable
f83d2997
KH
5011 (if (x-color-defined-p "orchid1")
5012 "orchid1"
5013 "orange")))))
5bd52f0e
RS
5014;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
5015;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
5016;;; (cond
5017;;; ((eq background 'light)
5018;;; (set-face-background 'font-lock-other-emphasized-face
5019;;; (if (x-color-defined-p "lightyellow2")
5020;;; "lightyellow2"
5021;;; (if (x-color-defined-p "lightyellow")
5022;;; "lightyellow"
5023;;; "light yellow"))))
5024;;; ((eq background 'dark)
5025;;; (set-face-background 'font-lock-other-emphasized-face
5026;;; (if (x-color-defined-p "navy")
5027;;; "navy"
5028;;; (if (x-color-defined-p "darkgreen")
5029;;; "darkgreen"
5030;;; "dark green"))))
5031;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
5032;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
5033;;; (copy-face 'bold 'font-lock-emphasized-face)
5034;;; (cond
5035;;; ((eq background 'light)
5036;;; (set-face-background 'font-lock-emphasized-face
5037;;; (if (x-color-defined-p "lightyellow2")
5038;;; "lightyellow2"
5039;;; "lightyellow")))
5040;;; ((eq background 'dark)
5041;;; (set-face-background 'font-lock-emphasized-face
5042;;; (if (x-color-defined-p "navy")
5043;;; "navy"
5044;;; (if (x-color-defined-p "darkgreen")
5045;;; "darkgreen"
5046;;; "dark green"))))
5047;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
db133cb6 5048 (if (cperl-is-face 'font-lock-variable-name-face) nil
f83d2997 5049 (copy-face 'italic 'font-lock-variable-name-face))
db133cb6 5050 (if (cperl-is-face 'font-lock-constant-face) nil
883212ce 5051 (copy-face 'italic 'font-lock-constant-face))))
f83d2997 5052 (setq cperl-faces-init t))
5bd52f0e 5053 (error (message "cperl-init-faces (ignored): %s" errs))))
f83d2997
KH
5054
5055
5056(defun cperl-ps-print-init ()
5057 "Initialization of `ps-print' components for faces used in CPerl."
5bd52f0e
RS
5058 (eval-after-load "ps-print"
5059 '(setq ps-bold-faces
5c8b7eaf 5060 ;; font-lock-variable-name-face
5bd52f0e 5061 ;; font-lock-constant-face
e4c067b5 5062 (append '(cperl-array cperl-hash)
5bd52f0e
RS
5063 ps-bold-faces)
5064 ps-italic-faces
5065 ;; font-lock-constant-face
e4c067b5 5066 (append '(cperl-nonoverridable cperl-hash)
5bd52f0e
RS
5067 ps-italic-faces)
5068 ps-underlined-faces
5069 ;; font-lock-type-face
e4c067b5 5070 (append '(cperl-array cperl-hash underline cperl-nonoverridable)
5bd52f0e
RS
5071 ps-underlined-faces))))
5072
5073(defvar ps-print-face-extension-alist)
5074
5075(defun cperl-ps-print (&optional file)
5076 "Pretty-print in CPerl style.
5077If optional argument FILE is an empty string, prints to printer, otherwise
5078to the file FILE. If FILE is nil, prompts for a file name.
5079
5080Style of printout regulated by the variable `cperl-ps-print-face-properties'."
5081 (interactive)
5c8b7eaf
SS
5082 (or file
5083 (setq file (read-from-minibuffer
5bd52f0e
RS
5084 "Print to file (if empty - to printer): "
5085 (concat (buffer-file-name) ".ps")
5086 nil nil 'file-name-history)))
5087 (or (> (length file) 0)
5088 (setq file nil))
5089 (require 'ps-print) ; To get ps-print-face-extension-alist
5090 (let ((ps-print-color-p t)
5091 (ps-print-face-extension-alist ps-print-face-extension-alist))
5092 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
5093 (ps-print-buffer-with-faces file)))
5094
5095;;; (defun cperl-ps-print-init ()
5096;;; "Initialization of `ps-print' components for faces used in CPerl."
5097;;; ;; Guard against old versions
5098;;; (defvar ps-underlined-faces nil)
5099;;; (defvar ps-bold-faces nil)
5100;;; (defvar ps-italic-faces nil)
5101;;; (setq ps-bold-faces
5102;;; (append '(font-lock-emphasized-face
e4c067b5 5103;;; cperl-array
5c8b7eaf
SS
5104;;; font-lock-keyword-face
5105;;; font-lock-variable-name-face
5106;;; font-lock-constant-face
5107;;; font-lock-reference-face
5bd52f0e 5108;;; font-lock-other-emphasized-face
e4c067b5 5109;;; cperl-hash)
5bd52f0e
RS
5110;;; ps-bold-faces))
5111;;; (setq ps-italic-faces
e4c067b5 5112;;; (append '(cperl-nonoverridable
5c8b7eaf
SS
5113;;; font-lock-constant-face
5114;;; font-lock-reference-face
5bd52f0e 5115;;; font-lock-other-emphasized-face
e4c067b5 5116;;; cperl-hash)
5bd52f0e
RS
5117;;; ps-italic-faces))
5118;;; (setq ps-underlined-faces
5119;;; (append '(font-lock-emphasized-face
e4c067b5 5120;;; cperl-array
5bd52f0e 5121;;; font-lock-other-emphasized-face
e4c067b5
MB
5122;;; cperl-hash
5123;;; cperl-nonoverridable font-lock-type-face)
5bd52f0e
RS
5124;;; ps-underlined-faces))
5125;;; (cons 'font-lock-type-face ps-underlined-faces))
f83d2997
KH
5126
5127
5128(if (cperl-enable-font-lock) (cperl-windowed-init))
5129
db133cb6 5130(defconst cperl-styles-entries
5c8b7eaf
SS
5131 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
5132 cperl-label-offset cperl-extra-newline-before-brace
bab27c0c 5133 cperl-merge-trailing-else
db133cb6
RS
5134 cperl-continued-statement-offset))
5135
5136(defconst cperl-style-alist
83261a2f 5137 '(("CPerl" ; =GNU without extra-newline-before-brace
db133cb6
RS
5138 (cperl-indent-level . 2)
5139 (cperl-brace-offset . 0)
5140 (cperl-continued-brace-offset . 0)
5141 (cperl-label-offset . -2)
5142 (cperl-extra-newline-before-brace . nil)
bab27c0c 5143 (cperl-merge-trailing-else . t)
db133cb6 5144 (cperl-continued-statement-offset . 2))
83261a2f 5145 ("PerlStyle" ; CPerl with 4 as indent
db133cb6
RS
5146 (cperl-indent-level . 4)
5147 (cperl-brace-offset . 0)
5148 (cperl-continued-brace-offset . 0)
5149 (cperl-label-offset . -4)
5150 (cperl-extra-newline-before-brace . nil)
bab27c0c 5151 (cperl-merge-trailing-else . t)
db133cb6
RS
5152 (cperl-continued-statement-offset . 4))
5153 ("GNU"
5154 (cperl-indent-level . 2)
5155 (cperl-brace-offset . 0)
5156 (cperl-continued-brace-offset . 0)
5157 (cperl-label-offset . -2)
5158 (cperl-extra-newline-before-brace . t)
bab27c0c 5159 (cperl-merge-trailing-else . nil)
db133cb6
RS
5160 (cperl-continued-statement-offset . 2))
5161 ("K&R"
5162 (cperl-indent-level . 5)
5163 (cperl-brace-offset . 0)
5164 (cperl-continued-brace-offset . -5)
5165 (cperl-label-offset . -5)
5166 ;;(cperl-extra-newline-before-brace . nil) ; ???
bab27c0c 5167 (cperl-merge-trailing-else . nil)
db133cb6
RS
5168 (cperl-continued-statement-offset . 5))
5169 ("BSD"
5170 (cperl-indent-level . 4)
5171 (cperl-brace-offset . 0)
5172 (cperl-continued-brace-offset . -4)
5173 (cperl-label-offset . -4)
5174 ;;(cperl-extra-newline-before-brace . nil) ; ???
5175 (cperl-continued-statement-offset . 4))
5176 ("C++"
5177 (cperl-indent-level . 4)
5178 (cperl-brace-offset . 0)
5179 (cperl-continued-brace-offset . -4)
5180 (cperl-label-offset . -4)
5181 (cperl-continued-statement-offset . 4)
bab27c0c 5182 (cperl-merge-trailing-else . nil)
db133cb6
RS
5183 (cperl-extra-newline-before-brace . t))
5184 ("Current")
5185 ("Whitesmith"
5186 (cperl-indent-level . 4)
5187 (cperl-brace-offset . 0)
5188 (cperl-continued-brace-offset . 0)
5189 (cperl-label-offset . -4)
5190 ;;(cperl-extra-newline-before-brace . nil) ; ???
5191 (cperl-continued-statement-offset . 4)))
5192 "(Experimental) list of variables to set to get a particular indentation style.
5bd52f0e 5193Should be used via `cperl-set-style' or via Perl menu.")
db133cb6 5194
f83d2997 5195(defun cperl-set-style (style)
f94a632a 5196 "Set CPerl mode variables to use one of several different indentation styles.
f83d2997 5197The arguments are a string representing the desired style.
5c8b7eaf 5198The list of styles is in `cperl-style-alist', available styles
db133cb6
RS
5199are GNU, K&R, BSD, C++ and Whitesmith.
5200
5201The current value of style is memorized (unless there is a memorized
5202data already), may be restored by `cperl-set-style-back'.
5203
5204Chosing \"Current\" style will not change style, so this may be used for
5205side-effect of memorizing only."
5c8b7eaf 5206 (interactive
15ca5699 5207 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
db133cb6 5208 cperl-style-alist)))
f83d2997 5209 (list (completing-read "Enter style: " list nil 'insist))))
db133cb6
RS
5210 (or cperl-old-style
5211 (setq cperl-old-style
5212 (mapcar (function
5213 (lambda (name)
5214 (cons name (eval name))))
5215 cperl-styles-entries)))
5216 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
f83d2997
KH
5217 (while style
5218 (setq setting (car style) style (cdr style))
db133cb6
RS
5219 (set (car setting) (cdr setting)))))
5220
5221(defun cperl-set-style-back ()
810fb442 5222 "Restore a style memorized by `cperl-set-style'."
db133cb6
RS
5223 (interactive)
5224 (or cperl-old-style (error "The style was not changed"))
5225 (let (setting)
5226 (while cperl-old-style
5c8b7eaf 5227 (setq setting (car cperl-old-style)
db133cb6
RS
5228 cperl-old-style (cdr cperl-old-style))
5229 (set (car setting) (cdr setting)))))
f83d2997
KH
5230
5231(defun cperl-check-syntax ()
5232 (interactive)
5233 (require 'mode-compile)
db133cb6
RS
5234 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
5235 (eval '(mode-compile)))) ; Avoid a warning
f83d2997
KH
5236
5237(defun cperl-info-buffer (type)
5238 ;; Returns buffer with documentation. Creates if missing.
5239 ;; If TYPE, this vars buffer.
5240 ;; Special care is taken to not stomp over an existing info buffer
5241 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
5242 (info (get-buffer bname))
5243 (oldbuf (get-buffer "*info*")))
5244 (if info info
5245 (save-window-excursion
5246 ;; Get Info running
5247 (require 'info)
5248 (cond (oldbuf
5249 (set-buffer oldbuf)
5250 (rename-buffer "*info-perl-tmp*")))
5251 (save-window-excursion
5252 (info))
5253 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
5254 (set-buffer "*info*")
5255 (rename-buffer bname)
5256 (cond (oldbuf
5257 (set-buffer "*info-perl-tmp*")
5258 (rename-buffer "*info*")
5259 (set-buffer bname)))
029cb4d5 5260 (make-local-variable 'window-min-height)
f83d2997
KH
5261 (setq window-min-height 2)
5262 (current-buffer)))))
5263
5264(defun cperl-word-at-point (&optional p)
f94a632a 5265 "Return the word at point or at P."
f83d2997
KH
5266 (save-excursion
5267 (if p (goto-char p))
5268 (or (cperl-word-at-point-hard)
5269 (progn
5270 (require 'etags)
5271 (funcall (or (and (boundp 'find-tag-default-function)
5272 find-tag-default-function)
5273 (get major-mode 'find-tag-default-function)
5274 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
5275 ;; automatically used within `find-tag-default':
5276 'find-tag-default))))))
5277
5278(defun cperl-info-on-command (command)
f94a632a 5279 "Show documentation for Perl command COMMAND in other window.
f83d2997
KH
5280If perl-info buffer is shown in some frame, uses this frame.
5281Customized by setting variables `cperl-shrink-wrap-info-frame',
5282`cperl-max-help-size'."
5c8b7eaf 5283 (interactive
f83d2997 5284 (let* ((default (cperl-word-at-point))
5c8b7eaf 5285 (read (read-string
83261a2f
SM
5286 (format "Find doc for Perl function (default %s): "
5287 default))))
5c8b7eaf 5288 (list (if (equal read "")
83261a2f
SM
5289 default
5290 read))))
f83d2997
KH
5291
5292 (let ((buffer (current-buffer))
5293 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
5294 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5295 max-height char-height buf-list)
5296 (if (string-match "^-[a-zA-Z]$" command)
5297 (setq cmd-desc "^-X[ \t\n]"))
5298 (setq isvar (string-match "^[$@%]" command)
5299 buf (cperl-info-buffer isvar)
5300 iniwin (selected-window)
5301 fr1 (window-frame iniwin))
5302 (set-buffer buf)
fc49c9c6 5303 (goto-char (point-min))
5c8b7eaf 5304 (or isvar
f83d2997
KH
5305 (progn (re-search-forward "^-X[ \t\n]")
5306 (forward-line -1)))
5307 (if (re-search-forward cmd-desc nil t)
5308 (progn
5309 ;; Go back to beginning of the group (ex, for qq)
5310 (if (re-search-backward "^[ \t\n\f]")
5311 (forward-line 1))
5312 (beginning-of-line)
5c8b7eaf 5313 ;; Get some of
f83d2997
KH
5314 (setq pos (point)
5315 buf-list (list buf "*info-perl-var*" "*info-perl*"))
5316 (while (and (not win) buf-list)
5317 (setq win (get-buffer-window (car buf-list) t))
5318 (setq buf-list (cdr buf-list)))
5319 (or (not win)
5320 (eq (window-buffer win) buf)
5321 (set-window-buffer win buf))
5322 (and win (setq fr2 (window-frame win)))
5323 (if (or (not fr2) (eq fr1 fr2))
5324 (pop-to-buffer buf)
5325 (special-display-popup-frame buf) ; Make it visible
5326 (select-window win))
5327 (goto-char pos) ; Needed (?!).
5328 ;; Resize
5329 (setq iniheight (window-height)
5330 frheight (frame-height)
5331 not-loner (< iniheight (1- frheight))) ; Are not alone
5c8b7eaf 5332 (cond ((if not-loner cperl-max-help-size
f83d2997 5333 cperl-shrink-wrap-info-frame)
5c8b7eaf
SS
5334 (setq height
5335 (+ 2
5336 (count-lines
5337 pos
f83d2997
KH
5338 (save-excursion
5339 (if (re-search-forward
5340 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
5341 (match-beginning 0) (point-max)))))
5c8b7eaf 5342 max-height
f83d2997
KH
5343 (if not-loner
5344 (/ (* (- frheight 3) cperl-max-help-size) 100)
5345 (setq char-height (frame-char-height))
5346 ;; Non-functioning under OS/2:
5347 (if (eq char-height 1) (setq char-height 18))
5348 ;; Title, menubar, + 2 for slack
83261a2f 5349 (- (/ (x-display-pixel-height) char-height) 4)))
f83d2997
KH
5350 (if (> height max-height) (setq height max-height))
5351 ;;(message "was %s doing %s" iniheight height)
5352 (if not-loner
5353 (enlarge-window (- height iniheight))
5354 (set-frame-height (window-frame win) (1+ height)))))
5355 (set-window-start (selected-window) pos))
5356 (message "No entry for %s found." command))
5357 ;;(pop-to-buffer buffer)
5358 (select-window iniwin)))
5359
5360(defun cperl-info-on-current-command ()
029cb4d5 5361 "Show documentation for Perl command at point in other window."
f83d2997
KH
5362 (interactive)
5363 (cperl-info-on-command (cperl-word-at-point)))
5364
5365(defun cperl-imenu-info-imenu-search ()
5366 (if (looking-at "^-X[ \t\n]") nil
5367 (re-search-backward
5368 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
5369 (forward-line 1)))
5370
5c8b7eaf 5371(defun cperl-imenu-info-imenu-name ()
f83d2997
KH
5372 (buffer-substring
5373 (match-beginning 1) (match-end 1)))
5374
5375(defun cperl-imenu-on-info ()
5376 (interactive)
5377 (let* ((buffer (current-buffer))
5378 imenu-create-index-function
5c8b7eaf
SS
5379 imenu-prev-index-position-function
5380 imenu-extract-index-name-function
f83d2997
KH
5381 (index-item (save-restriction
5382 (save-window-excursion
5383 (set-buffer (cperl-info-buffer nil))
5c8b7eaf 5384 (setq imenu-create-index-function
f83d2997
KH
5385 'imenu-default-create-index-function
5386 imenu-prev-index-position-function
5387 'cperl-imenu-info-imenu-search
5388 imenu-extract-index-name-function
5389 'cperl-imenu-info-imenu-name)
5390 (imenu-choose-buffer-index)))))
5391 (and index-item
5392 (progn
5393 (push-mark)
5394 (pop-to-buffer "*info-perl*")
5395 (cond
5396 ((markerp (cdr index-item))
5397 (goto-char (marker-position (cdr index-item))))
5398 (t
5399 (goto-char (cdr index-item))))
5400 (set-window-start (selected-window) (point))
5401 (pop-to-buffer buffer)))))
5402
5403(defun cperl-lineup (beg end &optional step minshift)
5404 "Lineup construction in a region.
5405Beginning of region should be at the start of a construction.
5406All first occurrences of this construction in the lines that are
5407partially contained in the region are lined up at the same column.
5408
5409MINSHIFT is the minimal amount of space to insert before the construction.
5410STEP is the tabwidth to position constructions.
029cb4d5 5411If STEP is nil, `cperl-lineup-step' will be used
15ca5699 5412\(or `cperl-indent-level', if `cperl-lineup-step' is nil).
f83d2997
KH
5413Will not move the position at the start to the left."
5414 (interactive "r")
5415 (let (search col tcol seen b e)
5416 (save-excursion
5417 (goto-char end)
5418 (end-of-line)
5419 (setq end (point-marker))
5420 (goto-char beg)
5421 (skip-chars-forward " \t\f")
5422 (setq beg (point-marker))
5423 (indent-region beg end nil)
5424 (goto-char beg)
5425 (setq col (current-column))
5426 (if (looking-at "[a-zA-Z0-9_]")
5427 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
5428 (setq search
5c8b7eaf
SS
5429 (concat "\\<"
5430 (regexp-quote
f83d2997
KH
5431 (buffer-substring (match-beginning 0)
5432 (match-end 0))) "\\>"))
5433 (error "Cannot line up in a middle of the word"))
5434 (if (looking-at "$")
5435 (error "Cannot line up end of line"))
5436 (setq search (regexp-quote (char-to-string (following-char)))))
5437 (setq step (or step cperl-lineup-step cperl-indent-level))
5438 (or minshift (setq minshift 1))
5439 (while (progn
5440 (beginning-of-line 2)
5c8b7eaf 5441 (and (< (point) end)
f83d2997
KH
5442 (re-search-forward search end t)
5443 (goto-char (match-beginning 0))))
5444 (setq tcol (current-column) seen t)
5445 (if (> tcol col) (setq col tcol)))
5446 (or seen
5447 (error "The construction to line up occurred only once"))
5448 (goto-char beg)
5449 (setq col (+ col minshift))
5450 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5c8b7eaf 5451 (while
f83d2997
KH
5452 (progn
5453 (setq e (point))
5454 (skip-chars-backward " \t")
5455 (delete-region (point) e)
b5b0cb34 5456 (indent-to-column col) ;(make-string (- col (current-column)) ?\s))
5c8b7eaf
SS
5457 (beginning-of-line 2)
5458 (and (< (point) end)
f83d2997
KH
5459 (re-search-forward search end t)
5460 (goto-char (match-beginning 0)))))))) ; No body
5461
5462(defun cperl-etags (&optional add all files)
5463 "Run etags with appropriate options for Perl files.
5464If optional argument ALL is `recursive', will process Perl files
5465in subdirectories too."
5466 (interactive)
5467 (let ((cmd "etags")
5468 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5469 res)
5470 (if add (setq args (cons "-a" args)))
5471 (or files (setq files (list buffer-file-name)))
5472 (cond
5473 ((eq all 'recursive)
5474 ;;(error "Not implemented: recursive")
5c8b7eaf 5475 (setq args (append (list "-e"
f83d2997
KH
5476 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
5477 use File::Find;
5478 find(\\&wanted, '.');
5c8b7eaf 5479 exec @ARGV;"
f83d2997
KH
5480 cmd) args)
5481 cmd "perl"))
5c8b7eaf 5482 (all
f83d2997 5483 ;;(error "Not implemented: all")
5c8b7eaf 5484 (setq args (append (list "-e"
f83d2997 5485 "push @ARGV, <*.PL *.pl *.pm>;
5c8b7eaf 5486 exec @ARGV;"
f83d2997
KH
5487 cmd) args)
5488 cmd "perl"))
5489 (t
5490 (setq args (append args files))))
5491 (setq res (apply 'call-process cmd nil nil nil args))
5492 (or (eq res 0)
5493 (message "etags returned \"%s\"" res))))
5494
5495(defun cperl-toggle-auto-newline ()
5496 "Toggle the state of `cperl-auto-newline'."
5497 (interactive)
5498 (setq cperl-auto-newline (not cperl-auto-newline))
5c8b7eaf 5499 (message "Newlines will %sbe auto-inserted now."
f83d2997
KH
5500 (if cperl-auto-newline "" "not ")))
5501
5502(defun cperl-toggle-abbrev ()
5503 "Toggle the state of automatic keyword expansion in CPerl mode."
5504 (interactive)
5505 (abbrev-mode (if abbrev-mode 0 1))
5c8b7eaf 5506 (message "Perl control structure will %sbe auto-inserted now."
f83d2997
KH
5507 (if abbrev-mode "" "not ")))
5508
5509
5510(defun cperl-toggle-electric ()
5511 "Toggle the state of parentheses doubling in CPerl mode."
5512 (interactive)
5513 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5c8b7eaf 5514 (message "Parentheses will %sbe auto-doubled now."
f83d2997
KH
5515 (if (cperl-val 'cperl-electric-parens) "" "not ")))
5516
db133cb6 5517(defun cperl-toggle-autohelp ()
f739b53b
SM
5518 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
5519Delay of auto-help controlled by `cperl-lazy-help-time'."
db133cb6
RS
5520 (interactive)
5521 (if (fboundp 'run-with-idle-timer)
5522 (progn
5523 (if cperl-lazy-installed
f739b53b 5524 (cperl-lazy-unstall)
db133cb6 5525 (cperl-lazy-install))
5c8b7eaf 5526 (message "Perl help messages will %sbe automatically shown now."
db133cb6
RS
5527 (if cperl-lazy-installed "" "not ")))
5528 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
5529
5530(defun cperl-toggle-construct-fix ()
5531 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5532 (interactive)
5c8b7eaf 5533 (setq cperl-indent-region-fix-constructs
5bd52f0e
RS
5534 (if cperl-indent-region-fix-constructs
5535 nil
5536 1))
5c8b7eaf 5537 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
db133cb6
RS
5538 (if cperl-indent-region-fix-constructs "" "not ")))
5539
f83d2997
KH
5540;;;; Tags file creation.
5541
5542(defvar cperl-tmp-buffer " *cperl-tmp*")
5543
5544(defun cperl-setup-tmp-buf ()
5545 (set-buffer (get-buffer-create cperl-tmp-buffer))
5546 (set-syntax-table cperl-mode-syntax-table)
5547 (buffer-disable-undo)
5548 (auto-fill-mode 0)
5549 (if cperl-use-syntax-table-text-property-for-tags
5550 (progn
029cb4d5 5551 (make-local-variable 'parse-sexp-lookup-properties)
f83d2997
KH
5552 ;; Do not introduce variable if not needed, we check it!
5553 (set 'parse-sexp-lookup-properties t))))
5554
5555(defun cperl-xsub-scan ()
f83d2997 5556 (require 'imenu)
5c8b7eaf 5557 (let ((index-alist '())
f83d2997
KH
5558 (prev-pos 0) index index1 name package prefix)
5559 (goto-char (point-min))
f83d2997
KH
5560 ;; Search for the function
5561 (progn ;;save-match-data
5562 (while (re-search-forward
5563 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5564 nil t)
f83d2997 5565 (cond
83261a2f 5566 ((match-beginning 2) ; SECTION
f83d2997
KH
5567 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
5568 (goto-char (match-beginning 0))
5569 (skip-chars-forward " \t")
5570 (forward-char 1)
5571 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
5572 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
5573 (setq prefix nil)))
5574 ((not package) nil) ; C language section
5575 ((match-beginning 3) ; XSUB
5576 (goto-char (1+ (match-beginning 3)))
5577 (setq index (imenu-example--name-and-position))
5578 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
5579 (if (and prefix (string-match (concat "^" prefix) name))
5580 (setq name (substring name (length prefix))))
5581 (cond ((string-match "::" name) nil)
5582 (t
5583 (setq index1 (cons (concat package "::" name) (cdr index)))
5584 (push index1 index-alist)))
5585 (setcar index name)
5586 (push index index-alist))
5587 (t ; BOOT: section
5588 ;; (beginning-of-line)
5589 (setq index (imenu-example--name-and-position))
5590 (setcar index (concat package "::BOOT:"))
5591 (push index index-alist)))))
f83d2997
KH
5592 index-alist))
5593
6c389151
SM
5594(defvar cperl-unreadable-ok nil)
5595
5596(defun cperl-find-tags (ifile xs topdir)
83261a2f
SM
5597 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
5598 (cperl-pod-here-fontify nil) f file)
f83d2997
KH
5599 (save-excursion
5600 (if b (set-buffer b)
83261a2f 5601 (cperl-setup-tmp-buf))
f83d2997 5602 (erase-buffer)
6c389151
SM
5603 (condition-case err
5604 (setq file (car (insert-file-contents ifile)))
5605 (error (if cperl-unreadable-ok nil
5606 (if (y-or-n-p
5607 (format "File %s unreadable. Continue? " ifile))
5608 (setq cperl-unreadable-ok t)
5609 (error "Aborting: unreadable file %s" ifile)))))
a1506d29 5610 (if (not file)
6c389151 5611 (message "Unreadable file %s" ifile)
83261a2f
SM
5612 (message "Scanning file %s ..." file)
5613 (if (and cperl-use-syntax-table-text-property-for-tags
5614 (not xs))
5615 (condition-case err ; after __END__ may have garbage
5616 (cperl-find-pods-heres nil nil noninteractive)
5617 (error (message "While scanning for syntax: %s" err))))
5618 (if xs
5619 (setq lst (cperl-xsub-scan))
5620 (setq ind (cperl-imenu--create-perl-index))
5621 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
5622 (setq lst
5623 (mapcar
5624 (function
5625 (lambda (elt)
5626 (cond ((string-match "^[_a-zA-Z]" (car elt))
5627 (goto-char (cdr elt))
5628 (beginning-of-line) ; pos should be of the start of the line
5629 (list (car elt)
5630 (point)
5631 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
5632 (buffer-substring (progn
5633 (goto-char (cdr elt))
5634 ;; After name now...
5635 (or (eolp) (forward-char 1))
5636 (point))
5637 (progn
5638 (beginning-of-line)
5639 (point))))))))
5640 lst))
5641 (erase-buffer)
5642 (while lst
5643 (setq elt (car lst) lst (cdr lst))
5644 (if elt
5645 (progn
5646 (insert (elt elt 3)
5647 127
5648 (if (string-match "^package " (car elt))
5649 (substring (car elt) 8)
5650 (car elt) )
5651 1
5652 (number-to-string (elt elt 2)) ; Line
5653 ","
5654 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
5655 "\n")
5656 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
5657 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
5658 (elt elt 3)))
5659 ;; Need to insert the name without package as well
15ca5699 5660 (setq lst (cons (cons (substring (elt elt 3)
83261a2f
SM
5661 (match-beginning 1)
5662 (match-end 1))
5663 (cdr elt))
5664 lst))))))
5665 (setq pos (point))
5666 (goto-char 1)
5667 (setq rel file)
5668 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5669 (set-text-properties 0 (length rel) nil rel)
5670 (and (equal topdir (substring rel 0 (length topdir)))
5671 (setq rel (substring file (length topdir))))
5672 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
5673 (setq ret (buffer-substring 1 (point-max)))
5674 (erase-buffer)
5675 (or noninteractive
5676 (message "Scanning file %s finished" file))
5677 ret))))
f83d2997
KH
5678
5679(defun cperl-add-tags-recurse-noxs ()
5680 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5681Use as
5682 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 5683 -f cperl-add-tags-recurse
f83d2997
KH
5684"
5685 (cperl-write-tags nil nil t t nil t))
5686
5687(defun cperl-add-tags-recurse ()
5688 "Add to TAGS file data for Perl files in the current directory and kids.
5689Use as
5690 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 5691 -f cperl-add-tags-recurse
f83d2997
KH
5692"
5693 (cperl-write-tags nil nil t t))
5694
5695(defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
5696 ;; If INBUFFER, do not select buffer, and do not save
5697 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5698 (require 'etags)
5699 (if file nil
5700 (setq file (if dir default-directory (buffer-file-name)))
5701 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
5702 (or topdir
5703 (setq topdir default-directory))
5704 (let ((tags-file-name "TAGS")
5705 (case-fold-search (eq system-type 'emx))
6c389151 5706 xs rel tm)
f83d2997
KH
5707 (save-excursion
5708 (cond (inbuffer nil) ; Already there
5709 ((file-exists-p tags-file-name)
5bd52f0e
RS
5710 (if cperl-xemacs-p
5711 (visit-tags-table-buffer)
83261a2f 5712 (visit-tags-table-buffer tags-file-name)))
f83d2997
KH
5713 (t (set-buffer (find-file-noselect tags-file-name))))
5714 (cond
5715 (dir
5716 (cond ((eq erase 'ignore))
5717 (erase
5718 (erase-buffer)
5719 (setq erase 'ignore)))
a1506d29 5720 (let ((files
6c389151 5721 (condition-case err
a1506d29 5722 (directory-files file t
6c389151
SM
5723 (if recurse nil cperl-scan-files-regexp)
5724 t)
5725 (error
5726 (if cperl-unreadable-ok nil
5727 (if (y-or-n-p
5728 (format "Directory %s unreadable. Continue? " file))
a1506d29 5729 (setq cperl-unreadable-ok t
83261a2f 5730 tm nil) ; Return empty list
6c389151 5731 (error "Aborting: unreadable directory %s" file)))))))
15ca5699 5732 (mapcar (function
83261a2f
SM
5733 (lambda (file)
5734 (cond
5735 ((string-match cperl-noscan-files-regexp file)
5736 nil)
5737 ((not (file-directory-p file))
5738 (if (string-match cperl-scan-files-regexp file)
5739 (cperl-write-tags file erase recurse nil t noxs topdir)))
5740 ((not recurse) nil)
5741 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
5742 files)))
f83d2997
KH
5743 (t
5744 (setq xs (string-match "\\.xs$" file))
5745 (if (not (and xs noxs))
5746 (progn
5747 (cond ((eq erase 'ignore) (goto-char (point-max)))
83261a2f
SM
5748 (erase (erase-buffer))
5749 (t
5750 (goto-char 1)
5751 (setq rel file)
5752 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5753 (set-text-properties 0 (length rel) nil rel)
5754 (and (equal topdir (substring rel 0 (length topdir)))
5755 (setq rel (substring file (length topdir))))
5756 (if (search-forward (concat "\f\n" rel ",") nil t)
5757 (progn
5758 (search-backward "\f\n")
5759 (delete-region (point)
5760 (save-excursion
5761 (forward-char 1)
5762 (if (search-forward "\f\n"
5763 nil 'toend)
5764 (- (point) 2)
5765 (point-max)))))
5766 (goto-char (point-max)))))
f83d2997 5767 (insert (cperl-find-tags file xs topdir))))))
83261a2f
SM
5768 (if inbuffer nil ; Delegate to the caller
5769 (save-buffer 0) ; No backup
f83d2997
KH
5770 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
5771 (initialize-new-tags-table))))))
5772
5773(defvar cperl-tags-hier-regexp-list
5c8b7eaf 5774 (concat
f83d2997
KH
5775 "^\\("
5776 "\\(package\\)\\>"
5777 "\\|"
5778 "sub\\>[^\n]+::"
5779 "\\|"
5780 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
5781 "\\|"
5782 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
5783 "\\)"))
5784
5785(defvar cperl-hierarchy '(() ())
f94a632a 5786 "Global hierarchy of classes.")
f83d2997
KH
5787
5788(defun cperl-tags-hier-fill ()
5789 ;; Suppose we are in a tag table cooked by cperl.
5790 (goto-char 1)
5791 (let (type pack name pos line chunk ord cons1 file str info fileind)
5792 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5c8b7eaf 5793 (setq pos (match-beginning 0)
f83d2997
KH
5794 pack (match-beginning 2))
5795 (beginning-of-line)
5796 (if (looking-at (concat
5797 "\\([^\n]+\\)"
5798 "\C-?"
5799 "\\([^\n]+\\)"
5800 "\C-a"
5801 "\\([0-9]+\\)"
5802 ","
5803 "\\([0-9]+\\)"))
5804 (progn
5805 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
5806 name (buffer-substring (match-beginning 2) (match-end 2))
5807 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5bd52f0e 5808 line (buffer-substring (match-beginning 3) (match-end 3))
f83d2997 5809 ord (if pack 1 0)
f83d2997 5810 file (file-of-tag)
5bd52f0e
RS
5811 fileind (format "%s:%s" file line)
5812 ;; Moves to beginning of the next line:
5813 info (cperl-etags-snarf-tag file line))
f83d2997
KH
5814 ;; Move back
5815 (forward-char -1)
5816 ;; Make new member of hierarchy name ==> file ==> pos if needed
5817 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
5818 ;; Name known
5819 (setcdr cons1 (cons (cons fileind (vector file info))
5820 (cdr cons1)))
5821 ;; First occurrence of the name, start alist
5822 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5c8b7eaf 5823 (if pack
f83d2997
KH
5824 (setcar (cdr cperl-hierarchy)
5825 (cons cons1 (nth 1 cperl-hierarchy)))
5826 (setcar cperl-hierarchy
5827 (cons cons1 (car cperl-hierarchy)))))))
5828 (end-of-line))))
5829
5830(defun cperl-tags-hier-init (&optional update)
5831 "Show hierarchical menu of classes and methods.
5832Finds info about classes by a scan of loaded TAGS files.
5833Supposes that the TAGS files contain fully qualified function names.
5834One may build such TAGS files from CPerl mode menu."
5835 (interactive)
5836 (require 'etags)
5837 (require 'imenu)
5838 (if (or update (null (nth 2 cperl-hierarchy)))
83261a2f
SM
5839 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
5840 (or (nthcdr 2 elt)
5841 ;; Only in one file
5842 (setcdr elt (cdr (nth 1 elt)))))))
5843 pack name cons1 to l1 l2 l3 l4 b)
f83d2997
KH
5844 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5845 (setq cperl-hierarchy (list l1 l2 l3))
5bd52f0e
RS
5846 (if cperl-xemacs-p ; Not checked
5847 (progn
5848 (or tags-file-name
5849 ;; Does this work in XEmacs?
f83d2997
KH
5850 (call-interactively 'visit-tags-table))
5851 (message "Updating list of classes...")
5bd52f0e
RS
5852 (set-buffer (get-file-buffer tags-file-name))
5853 (cperl-tags-hier-fill))
5854 (or tags-table-list
5855 (call-interactively 'visit-tags-table))
5c8b7eaf 5856 (mapcar
f83d2997
KH
5857 (function
5858 (lambda (tagsfile)
5bd52f0e 5859 (message "Updating list of classes... %s" tagsfile)
f83d2997
KH
5860 (set-buffer (get-file-buffer tagsfile))
5861 (cperl-tags-hier-fill)))
5862 tags-table-list)
5bd52f0e 5863 (message "Updating list of classes... postprocessing..."))
f83d2997
KH
5864 (mapcar remover (car cperl-hierarchy))
5865 (mapcar remover (nth 1 cperl-hierarchy))
5866 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
5867 (cons "Methods: " (car cperl-hierarchy))))
5868 (cperl-tags-treeify to 1)
5869 (setcar (nthcdr 2 cperl-hierarchy)
5870 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
5871 (message "Updating list of classes: done, requesting display...")
5872 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5873 ))
5874 (or (nth 2 cperl-hierarchy)
5875 (error "No items found"))
5876 (setq update
5877;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
83261a2f
SM
5878 (if (if (fboundp 'display-popup-menus-p)
5879 (let ((f 'display-popup-menus-p))
5880 (funcall f))
5881 window-system)
f83d2997
KH
5882 (x-popup-menu t (nth 2 cperl-hierarchy))
5883 (require 'tmm)
5884 (tmm-prompt (nth 2 cperl-hierarchy))))
5885 (if (and update (listp update))
5886 (progn (while (cdr update) (setq update (cdr update)))
5887 (setq update (car update)))) ; Get the last from the list
5c8b7eaf 5888 (if (vectorp update)
f83d2997
KH
5889 (progn
5890 (find-file (elt update 0))
5bd52f0e 5891 (cperl-etags-goto-tag-location (elt update 1))))
f83d2997
KH
5892 (if (eq update -999) (cperl-tags-hier-init t)))
5893
5894(defun cperl-tags-treeify (to level)
5895 ;; cadr of `to' is read-write. On start it is a cons
5c8b7eaf 5896 (let* ((regexp (concat "^\\(" (mapconcat
f83d2997
KH
5897 'identity
5898 (make-list level "[_a-zA-Z0-9]+")
5899 "::")
5900 "\\)\\(::\\)?"))
5901 (packages (cdr (nth 1 to)))
5902 (methods (cdr (nth 2 to)))
5903 l1 head tail cons1 cons2 ord writeto packs recurse
5904 root-packages root-functions ms many_ms same_name ps
5905 (move-deeper
5c8b7eaf 5906 (function
f83d2997
KH
5907 (lambda (elt)
5908 (cond ((and (string-match regexp (car elt))
5909 (or (eq ord 1) (match-end 2)))
5910 (setq head (substring (car elt) 0 (match-end 1))
5c8b7eaf 5911 tail (if (match-end 2) (substring (car elt)
f83d2997
KH
5912 (match-end 2)))
5913 recurse t)
5914 (if (setq cons1 (assoc head writeto)) nil
5915 ;; Need to init new head
5916 (setcdr writeto (cons (list head (list "Packages: ")
5917 (list "Methods: "))
5918 (cdr writeto)))
5919 (setq cons1 (nth 1 writeto)))
5920 (setq cons2 (nth ord cons1)) ; Either packs or meths
5921 (setcdr cons2 (cons elt (cdr cons2))))
5922 ((eq ord 2)
5923 (setq root-functions (cons elt root-functions)))
5924 (t
5925 (setq root-packages (cons elt root-packages))))))))
5926 (setcdr to l1) ; Init to dynamic space
5927 (setq writeto to)
5928 (setq ord 1)
5929 (mapcar move-deeper packages)
5930 (setq ord 2)
5931 (mapcar move-deeper methods)
5932 (if recurse
5933 (mapcar (function (lambda (elt)
5934 (cperl-tags-treeify elt (1+ level))))
5935 (cdr to)))
5936 ;;Now clean up leaders with one child only
5937 (mapcar (function (lambda (elt)
5c8b7eaf 5938 (if (not (and (listp (cdr elt))
f83d2997
KH
5939 (eq (length elt) 2))) nil
5940 (setcar elt (car (nth 1 elt)))
5941 (setcdr elt (cdr (nth 1 elt))))))
5942 (cdr to))
5943 ;; Sort the roots of subtrees
5944 (if (default-value 'imenu-sort-function)
5945 (setcdr to
5946 (sort (cdr to) (default-value 'imenu-sort-function))))
5947 ;; Now add back functions removed from display
5948 (mapcar (function (lambda (elt)
5949 (setcdr to (cons elt (cdr to)))))
5950 (if (default-value 'imenu-sort-function)
5951 (nreverse
5952 (sort root-functions (default-value 'imenu-sort-function)))
5953 root-functions))
5954 ;; Now add back packages removed from display
5955 (mapcar (function (lambda (elt)
5c8b7eaf
SS
5956 (setcdr to (cons (cons (concat "package " (car elt))
5957 (cdr elt))
f83d2997
KH
5958 (cdr to)))))
5959 (if (default-value 'imenu-sort-function)
5c8b7eaf 5960 (nreverse
f83d2997 5961 (sort root-packages (default-value 'imenu-sort-function)))
83261a2f 5962 root-packages))))
f83d2997
KH
5963
5964;;;(x-popup-menu t
5c8b7eaf 5965;;; '(keymap "Name1"
f83d2997 5966;;; ("Ret1" "aa")
5c8b7eaf
SS
5967;;; ("Head1" "ab"
5968;;; keymap "Name2"
f83d2997
KH
5969;;; ("Tail1" "x") ("Tail2" "y"))))
5970
5971(defun cperl-list-fold (list name limit)
5972 (let (list1 list2 elt1 (num 0))
5973 (if (<= (length list) limit) list
5974 (setq list1 nil list2 nil)
5975 (while list
5c8b7eaf 5976 (setq num (1+ num)
f83d2997
KH
5977 elt1 (car list)
5978 list (cdr list))
5979 (if (<= num imenu-max-items)
5980 (setq list2 (cons elt1 list2))
5981 (setq list1 (cons (cons name
5982 (nreverse list2))
5983 list1)
5984 list2 (list elt1)
5985 num 1)))
5986 (nreverse (cons (cons name
5987 (nreverse list2))
5988 list1)))))
5989
5990(defun cperl-menu-to-keymap (menu &optional name)
5991 (let (list)
5c8b7eaf
SS
5992 (cons 'keymap
5993 (mapcar
5994 (function
f83d2997
KH
5995 (lambda (elt)
5996 (cond ((listp (cdr elt))
5997 (setq list (cperl-list-fold
5998 (cdr elt) (car elt) imenu-max-items))
5999 (cons nil
6000 (cons (car elt)
6001 (cperl-menu-to-keymap list))))
6002 (t
6003 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
6004 (cperl-list-fold menu "Root" imenu-max-items)))))
6005
6006\f
6007(defvar cperl-bad-style-regexp
6008 (mapconcat 'identity
83261a2f 6009 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
15ca5699 6010 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
83261a2f 6011 "\\|")
f83d2997
KH
6012 "Finds places such that insertion of a whitespace may help a lot.")
6013
5c8b7eaf 6014(defvar cperl-not-bad-style-regexp
15ca5699 6015 (mapconcat
83261a2f 6016 'identity
f83d2997
KH
6017 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
6018 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
6019 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
6020 "<\\$?\\sw+\\(\\.\\sw+\\)?>" ; <IN> <stdin.h>
5bd52f0e 6021 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
f83d2997
KH
6022 "-[0-9]" ; -5
6023 "\\+\\+" ; ++var
6024 "--" ; --var
6025 ".->" ; a->b
6026 "->" ; a SPACE ->b
6027 "\\[-" ; a[-1]
5bd52f0e 6028 "\\\\[&$@*\\\\]" ; \&func
f83d2997 6029 "^=" ; =head
5bd52f0e
RS
6030 "\\$." ; $|
6031 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
f83d2997
KH
6032 "||"
6033 "&&"
6034 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
83261a2f 6035 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
f83d2997
KH
6036 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6037 ;;"[*/+-|&<.]+="
6038 )
6039 "\\|")
6040 "If matches at the start of match found by `my-bad-c-style-regexp',
6041insertion of a whitespace will not help.")
6042
6043(defvar found-bad)
6044
6045(defun cperl-find-bad-style ()
6046 "Find places in the buffer where insertion of a whitespace may help.
6047Prompts user for insertion of spaces.
6048Currently it is tuned to C and Perl syntax."
6049 (interactive)
6050 (let (found-bad (p (point)))
6051 (setq last-nonmenu-event 13) ; To disable popup
f8fd4f55
RS
6052 (with-no-warnings ; It is useful to push the mark here.
6053 (beginning-of-buffer))
f83d2997 6054 (map-y-or-n-p "Insert space here? "
83261a2f 6055 (lambda (arg) (insert " "))
f83d2997 6056 'cperl-next-bad-style
5c8b7eaf 6057 '("location" "locations" "insert a space into")
f83d2997
KH
6058 '((?\C-r (lambda (arg)
6059 (let ((buffer-quit-function
6060 'exit-recursive-edit))
6061 (message "Exit with Esc Esc")
6062 (recursive-edit)
6063 t)) ; Consider acted upon
5c8b7eaf 6064 "edit, exit with Esc Esc")
f83d2997
KH
6065 (?e (lambda (arg)
6066 (let ((buffer-quit-function
6067 'exit-recursive-edit))
6068 (message "Exit with Esc Esc")
6069 (recursive-edit)
6070 t)) ; Consider acted upon
6071 "edit, exit with Esc Esc"))
6072 t)
6073 (if found-bad (goto-char found-bad)
6074 (goto-char p)
6075 (message "No appropriate place found"))))
6076
6077(defun cperl-next-bad-style ()
6078 (let (p (not-found t) (point (point)) found)
6079 (while (and not-found
6080 (re-search-forward cperl-bad-style-regexp nil 'to-end))
6081 (setq p (point))
6082 (goto-char (match-beginning 0))
6083 (if (or
6084 (looking-at cperl-not-bad-style-regexp)
6085 ;; Check for a < -b and friends
6086 (and (eq (following-char) ?\-)
6087 (save-excursion
6088 (skip-chars-backward " \t\n")
07cb2aa3 6089 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
f83d2997
KH
6090 ;; Now check for syntax type
6091 (save-match-data
6092 (setq found (point))
6093 (beginning-of-defun)
6094 (let ((pps (parse-partial-sexp (point) found)))
6095 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
6096 (goto-char (match-end 0))
6097 (goto-char (1- p))
6098 (setq not-found nil
6099 found-bad found)))
6100 (not not-found)))
6101
f1d851ae 6102\f
f83d2997 6103;;; Getting help
5c8b7eaf 6104(defvar cperl-have-help-regexp
f83d2997
KH
6105 ;;(concat "\\("
6106 (mapconcat
6107 'identity
83261a2f 6108 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
f83d2997
KH
6109 "[$@]\\^[a-zA-Z]" ; Special variable
6110 "[$@][^ \n\t]" ; Special variable
6111 "-[a-zA-Z]" ; File test
6112 "\\\\[a-zA-Z0]" ; Special chars
83261a2f 6113 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
f83d2997
KH
6114 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
6115 "[a-zA-Z_0-9:]+" ; symbol or number
6116 "x="
83261a2f 6117 "#!")
f83d2997 6118 ;;"\\)\\|\\("
83261a2f
SM
6119 "\\|")
6120 ;;"\\)"
6121 ;;)
f83d2997
KH
6122 "Matches places in the buffer we can find help for.")
6123
6124(defvar cperl-message-on-help-error t)
6125(defvar cperl-help-from-timer nil)
6126
6127(defun cperl-word-at-point-hard ()
6128 ;; Does not save-excursion
6129 ;; Get to the something meaningful
6130 (or (eobp) (eolp) (forward-char 1))
5c8b7eaf 6131 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
f83d2997
KH
6132 (save-excursion (beginning-of-line) (point))
6133 'to-beg)
6134 ;; (cond
6135 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6136 ;; (skip-chars-backward " \n\t\r({[]});,")
6137 ;; (or (bobp) (backward-char 1))))
6138 ;; Try to backtrace
6139 (cond
6140 ((looking-at "[a-zA-Z0-9_:]") ; symbol
6141 (skip-chars-backward "a-zA-Z0-9_:")
5c8b7eaf 6142 (cond
f83d2997
KH
6143 ((and (eq (preceding-char) ?^) ; $^I
6144 (eq (char-after (- (point) 2)) ?\$))
6145 (forward-char -2))
6146 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
6147 (forward-char -1))
6148 ((and (eq (preceding-char) ?\=)
6149 (eq (current-column) 1))
6150 (forward-char -1))) ; =head1
6151 (if (and (eq (preceding-char) ?\<)
6152 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
6153 (forward-char -1)))
6154 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
6155 (forward-char -1))
6156 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
6157 (forward-char -1))
6158 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
6159 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
6160 (cond
6161 ((and (eq (preceding-char) ?\$)
6162 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
6163 (forward-char -1))
6164 ((and (eq (following-char) ?\>)
6165 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
6166 (save-excursion
6167 (forward-sexp -1)
6168 (and (eq (preceding-char) ?\<)
6169 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
6170 (search-backward "<"))))
6171 ((and (eq (following-char) ?\$)
6172 (eq (preceding-char) ?\<)
6173 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
6174 (forward-char -1)))
6175 (if (looking-at cperl-have-help-regexp)
6176 (buffer-substring (match-beginning 0) (match-end 0))))
6177
6178(defun cperl-get-help ()
6179 "Get one-line docs on the symbol at the point.
6180The data for these docs is a little bit obsolete and may be in fact longer
6181than a line. Your contribution to update/shorten it is appreciated."
6182 (interactive)
6183 (save-match-data ; May be called "inside" query-replace
6184 (save-excursion
6185 (let ((word (cperl-word-at-point-hard)))
6186 (if word
6187 (if (and cperl-help-from-timer ; Bail out if not in mainland
6188 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
6189 (or (memq (get-text-property (point) 'face)
6190 '(font-lock-comment-face font-lock-string-face))
6191 (memq (get-text-property (point) 'syntax-type)
6192 '(pod here-doc format))))
6193 nil
6194 (cperl-describe-perl-symbol word))
6195 (if cperl-message-on-help-error
5c8b7eaf 6196 (message "Nothing found for %s..."
f83d2997
KH
6197 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
6198
6199;;; Stolen from perl-descr.el by Johan Vromans:
6200
6201(defvar cperl-doc-buffer " *perl-doc*"
6202 "Where the documentation can be found.")
6203
6204(defun cperl-describe-perl-symbol (val)
6205 "Display the documentation of symbol at point, a Perl operator."
6206 (let ((enable-recursive-minibuffers t)
6207 args-file regexp)
6208 (cond
83261a2f
SM
6209 ((string-match "^[&*][a-zA-Z_]" val)
6210 (setq val (concat (substring val 0 1) "NAME")))
6211 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
6212 (setq val (concat "@" (substring val 1 (match-end 1)))))
6213 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
6214 (setq val (concat "%" (substring val 1 (match-end 1)))))
6215 ((and (string= val "x") (string-match "^x=" val))
6216 (setq val "x="))
6217 ((string-match "^\\$[\C-a-\C-z]" val)
6218 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
6219 ((string-match "^CORE::" val)
6220 (setq val "CORE::"))
6221 ((string-match "^SUPER::" val)
6222 (setq val "SUPER::"))
6223 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
6224 (setq val "<NAME>")))
5c8b7eaf 6225 (setq regexp (concat "^"
f83d2997 6226 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
5c8b7eaf 6227 (regexp-quote val)
f83d2997
KH
6228 "\\([ \t([/]\\|$\\)"))
6229
6230 ;; get the buffer with the documentation text
6231 (cperl-switch-to-doc-buffer)
6232
6233 ;; lookup in the doc
6234 (goto-char (point-min))
6235 (let ((case-fold-search nil))
5c8b7eaf 6236 (list
f83d2997
KH
6237 (if (re-search-forward regexp (point-max) t)
6238 (save-excursion
6239 (beginning-of-line 1)
6240 (let ((lnstart (point)))
6241 (end-of-line)
6242 (message "%s" (buffer-substring lnstart (point)))))
6243 (if cperl-message-on-help-error
6244 (message "No definition for %s" val)))))))
6245
83261a2f 6246(defvar cperl-short-docs 'please-ignore-this-line
f83d2997
KH
6247 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6248 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
f739b53b 6249... Range (list context); flip/flop [no flop when flip] (scalar context).
5c8b7eaf 6250! ... Logical negation.
f83d2997
KH
6251... != ... Numeric inequality.
6252... !~ ... Search pattern, substitution, or translation (negated).
6253$! In numeric context: errno. In a string context: error string.
6254$\" The separator which joins elements of arrays interpolated in strings.
f739b53b 6255$# The output format for printed numbers. Default is %.15g or close.
f83d2997
KH
6256$$ Process number of this script. Changes in the fork()ed child process.
6257$% The current page number of the currently selected output channel.
6258
6259 The following variables are always local to the current block:
6260
6261$1 Match of the 1st set of parentheses in the last match (auto-local).
6262$2 Match of the 2nd set of parentheses in the last match (auto-local).
6263$3 Match of the 3rd set of parentheses in the last match (auto-local).
6264$4 Match of the 4th set of parentheses in the last match (auto-local).
6265$5 Match of the 5th set of parentheses in the last match (auto-local).
6266$6 Match of the 6th set of parentheses in the last match (auto-local).
6267$7 Match of the 7th set of parentheses in the last match (auto-local).
6268$8 Match of the 8th set of parentheses in the last match (auto-local).
6269$9 Match of the 9th set of parentheses in the last match (auto-local).
6270$& The string matched by the last pattern match (auto-local).
6271$' The string after what was matched by the last match (auto-local).
6272$` The string before what was matched by the last match (auto-local).
6273
6274$( The real gid of this process.
6275$) The effective gid of this process.
6276$* Deprecated: Set to 1 to do multiline matching within a string.
6277$+ The last bracket matched by the last search pattern.
6278$, The output field separator for the print operator.
6279$- The number of lines left on the page.
6280$. The current input line number of the last filehandle that was read.
6281$/ The input record separator, newline by default.
f739b53b 6282$0 Name of the file containing the current perl script (read/write).
f83d2997
KH
6283$: String may be broken after these characters to fill ^-lines in a format.
6284$; Subscript separator for multi-dim array emulation. Default \"\\034\".
6285$< The real uid of this process.
6286$= The page length of the current output channel. Default is 60 lines.
6287$> The effective uid of this process.
6288$? The status returned by the last ``, pipe close or `system'.
6289$@ The perl error message from the last eval or do @var{EXPR} command.
6290$ARGV The name of the current file used with <> .
6291$[ Deprecated: The index of the first element/char in an array/string.
6292$\\ The output record separator for the print operator.
6293$] The perl version string as displayed with perl -v.
6294$^ The name of the current top-of-page format.
6295$^A The current value of the write() accumulator for format() lines.
6296$^D The value of the perl debug (-D) flags.
6297$^E Information about the last system error other than that provided by $!.
6298$^F The highest system file descriptor, ordinarily 2.
6299$^H The current set of syntax checks enabled by `use strict'.
6300$^I The value of the in-place edit extension (perl -i option).
6301$^L What formats output to perform a formfeed. Default is \f.
5bd52f0e 6302$^M A buffer for emergency memory allocation when running out of memory.
f83d2997
KH
6303$^O The operating system name under which this copy of Perl was built.
6304$^P Internal debugging flag.
6305$^T The time the script was started. Used by -A/-M/-C file tests.
6306$^W True if warnings are requested (perl -w flag).
6307$^X The name under which perl was invoked (argv[0] in C-speech).
6308$_ The default input and pattern-searching space.
5c8b7eaf 6309$| Auto-flush after write/print on current output channel? Default 0.
f83d2997
KH
6310$~ The name of the current report format.
6311... % ... Modulo division.
6312... %= ... Modulo division assignment.
6313%ENV Contains the current environment.
6314%INC List of files that have been require-d or do-ne.
6315%SIG Used to set signal handlers for various signals.
6316... & ... Bitwise and.
6317... && ... Logical and.
6318... &&= ... Logical and assignment.
6319... &= ... Bitwise and assignment.
6320... * ... Multiplication.
6321... ** ... Exponentiation.
6322*NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6323&NAME(arg0, ...) Subroutine call. Arguments go to @_.
6324... + ... Addition. +EXPR Makes EXPR into scalar context.
6325++ Auto-increment (magical on strings). ++EXPR EXPR++
6326... += ... Addition assignment.
6327, Comma operator.
6328... - ... Subtraction.
6329-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6330... -= ... Subtraction assignment.
6331-A Access time in days since script started.
6332-B File is a non-text (binary) file.
6333-C Inode change time in days since script started.
6334-M Age in days since script started.
6335-O File is owned by real uid.
6336-R File is readable by real uid.
6337-S File is a socket .
6338-T File is a text file.
6339-W File is writable by real uid.
6340-X File is executable by real uid.
6341-b File is a block special file.
6342-c File is a character special file.
6343-d File is a directory.
6344-e File exists .
6345-f File is a plain file.
6346-g File has setgid bit set.
6347-k File has sticky bit set.
6348-l File is a symbolic link.
6349-o File is owned by effective uid.
6350-p File is a named pipe (FIFO).
6351-r File is readable by effective uid.
6352-s File has non-zero size.
6353-t Tests if filehandle (STDIN by default) is opened to a tty.
6354-u File has setuid bit set.
6355-w File is writable by effective uid.
6356-x File is executable by effective uid.
6357-z File has zero size.
6358. Concatenate strings.
f739b53b 6359.. Range (list context); flip/flop (scalar context) operator.
f83d2997
KH
6360.= Concatenate assignment strings
6361... / ... Division. /PATTERN/ioxsmg Pattern match
6362... /= ... Division assignment.
6363/PATTERN/ioxsmg Pattern match.
f739b53b 6364... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
f83d2997
KH
6365<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6366<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6367<> Reads line from union of files in @ARGV (= command line) and STDIN.
6368... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6369... <= ... Numeric less than or equal to.
6370... <=> ... Numeric compare.
6371... = ... Assignment.
6372... == ... Numeric equality.
6373... =~ ... Search pattern, substitution, or translation
6374... > ... Numeric greater than.
6375... >= ... Numeric greater than or equal to.
6376... >> ... Bitwise shift right.
6377... >>= ... Bitwise shift right assignment.
6378... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6379?PATTERN? One-time pattern match.
6380@ARGV Command line arguments (not including the command name - see $0).
6381@INC List of places to look for perl scripts during do/include/use.
f739b53b 6382@_ Parameter array for subroutines; result of split() unless in list context.
f83d2997
KH
6383\\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
6384\\0 Octal char, e.g. \\033.
6385\\E Case modification terminator. See \\Q, \\L, and \\U.
6386\\L Lowercase until \\E . See also \l, lc.
6387\\U Upcase until \\E . See also \u, uc.
6388\\Q Quote metacharacters until \\E . See also quotemeta.
6389\\a Alarm character (octal 007).
6390\\b Backspace character (octal 010).
6391\\c Control character, e.g. \\c[ .
6392\\e Escape character (octal 033).
6393\\f Formfeed character (octal 014).
6394\\l Lowercase the next character. See also \\L and \\u, lcfirst.
6395\\n Newline character (octal 012 on most systems).
6396\\r Return character (octal 015 on most systems).
6397\\t Tab character (octal 011).
6398\\u Upcase the next character. See also \\U and \\l, ucfirst.
6399\\x Hex character, e.g. \\x1b.
6400... ^ ... Bitwise exclusive or.
6401__END__ Ends program source.
6402__DATA__ Ends program source.
6403__FILE__ Current (source) filename.
6404__LINE__ Current line in current source.
6405__PACKAGE__ Current package.
6406ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6407ARGVOUT Output filehandle with -i flag.
6408BEGIN { ... } Immediately executed (during compilation) piece of code.
6409END { ... } Pseudo-subroutine executed after the script finishes.
6c389151
SM
6410CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6411INIT { ... } Pseudo-subroutine executed before the script starts running.
f83d2997
KH
6412DATA Input filehandle for what follows after __END__ or __DATA__.
6413accept(NEWSOCKET,GENERICSOCKET)
6414alarm(SECONDS)
6415atan2(X,Y)
6416bind(SOCKET,NAME)
6417binmode(FILEHANDLE)
6418caller[(LEVEL)]
6419chdir(EXPR)
6420chmod(LIST)
6421chop[(LIST|VAR)]
6422chown(LIST)
6423chroot(FILENAME)
6424close(FILEHANDLE)
6425closedir(DIRHANDLE)
6426... cmp ... String compare.
6427connect(SOCKET,NAME)
6428continue of { block } continue { block }. Is executed after `next' or at end.
6429cos(EXPR)
6430crypt(PLAINTEXT,SALT)
6431dbmclose(%HASH)
6432dbmopen(%HASH,DBNAME,MODE)
6433defined(EXPR)
6434delete($HASH{KEY})
6435die(LIST)
6436do { ... }|SUBR while|until EXPR executes at least once
6437do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6438dump LABEL
6439each(%HASH)
6440endgrent
6441endhostent
6442endnetent
6443endprotoent
6444endpwent
6445endservent
6446eof[([FILEHANDLE])]
6447... eq ... String equality.
6448eval(EXPR) or eval { BLOCK }
6449exec(LIST)
6450exit(EXPR)
6451exp(EXPR)
6452fcntl(FILEHANDLE,FUNCTION,SCALAR)
6453fileno(FILEHANDLE)
6454flock(FILEHANDLE,OPERATION)
6455for (EXPR;EXPR;EXPR) { ... }
6456foreach [VAR] (@ARRAY) { ... }
6457fork
6458... ge ... String greater than or equal.
6459getc[(FILEHANDLE)]
6460getgrent
6461getgrgid(GID)
6462getgrnam(NAME)
6463gethostbyaddr(ADDR,ADDRTYPE)
6464gethostbyname(NAME)
6465gethostent
6466getlogin
6467getnetbyaddr(ADDR,ADDRTYPE)
6468getnetbyname(NAME)
6469getnetent
6470getpeername(SOCKET)
6471getpgrp(PID)
6472getppid
6473getpriority(WHICH,WHO)
6474getprotobyname(NAME)
6475getprotobynumber(NUMBER)
6476getprotoent
6477getpwent
6478getpwnam(NAME)
6479getpwuid(UID)
6480getservbyname(NAME,PROTO)
6481getservbyport(PORT,PROTO)
6482getservent
6483getsockname(SOCKET)
6484getsockopt(SOCKET,LEVEL,OPTNAME)
6485gmtime(EXPR)
6486goto LABEL
f83d2997
KH
6487... gt ... String greater than.
6488hex(EXPR)
6489if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6490index(STR,SUBSTR[,OFFSET])
6491int(EXPR)
6492ioctl(FILEHANDLE,FUNCTION,SCALAR)
6493join(EXPR,LIST)
6494keys(%HASH)
6495kill(LIST)
6496last [LABEL]
6497... le ... String less than or equal.
6498length(EXPR)
6499link(OLDFILE,NEWFILE)
6500listen(SOCKET,QUEUESIZE)
6501local(LIST)
6502localtime(EXPR)
6503log(EXPR)
6504lstat(EXPR|FILEHANDLE|VAR)
6505... lt ... String less than.
6506m/PATTERN/iogsmx
6507mkdir(FILENAME,MODE)
6508msgctl(ID,CMD,ARG)
6509msgget(KEY,FLAGS)
6510msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6511msgsnd(ID,MSG,FLAGS)
6512my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6c389151 6513our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
f83d2997
KH
6514... ne ... String inequality.
6515next [LABEL]
6516oct(EXPR)
6517open(FILEHANDLE[,EXPR])
6518opendir(DIRHANDLE,EXPR)
6519ord(EXPR) ASCII value of the first char of the string.
6520pack(TEMPLATE,LIST)
6521package NAME Introduces package context.
6522pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6523pop(ARRAY)
6524print [FILEHANDLE] [(LIST)]
6525printf [FILEHANDLE] (FORMAT,LIST)
6526push(ARRAY,LIST)
6527q/STRING/ Synonym for 'STRING'
6528qq/STRING/ Synonym for \"STRING\"
6529qx/STRING/ Synonym for `STRING`
6530rand[(EXPR)]
6531read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6532readdir(DIRHANDLE)
6533readlink(EXPR)
6534recv(SOCKET,SCALAR,LEN,FLAGS)
6535redo [LABEL]
6536rename(OLDNAME,NEWNAME)
6537require [FILENAME | PERL_VERSION]
6538reset[(EXPR)]
6539return(LIST)
6540reverse(LIST)
6541rewinddir(DIRHANDLE)
6542rindex(STR,SUBSTR[,OFFSET])
6543rmdir(FILENAME)
6544s/PATTERN/REPLACEMENT/gieoxsm
6545scalar(EXPR)
6546seek(FILEHANDLE,POSITION,WHENCE)
6547seekdir(DIRHANDLE,POS)
6548select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6549semctl(ID,SEMNUM,CMD,ARG)
6550semget(KEY,NSEMS,SIZE,FLAGS)
6551semop(KEY,...)
6552send(SOCKET,MSG,FLAGS[,TO])
6553setgrent
6554sethostent(STAYOPEN)
6555setnetent(STAYOPEN)
6556setpgrp(PID,PGRP)
6557setpriority(WHICH,WHO,PRIORITY)
6558setprotoent(STAYOPEN)
6559setpwent
6560setservent(STAYOPEN)
6561setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6562shift[(ARRAY)]
6563shmctl(ID,CMD,ARG)
6564shmget(KEY,SIZE,FLAGS)
6565shmread(ID,VAR,POS,SIZE)
6566shmwrite(ID,STRING,POS,SIZE)
6567shutdown(SOCKET,HOW)
6568sin(EXPR)
6569sleep[(EXPR)]
6570socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6571socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6572sort [SUBROUTINE] (LIST)
6573splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6574split[(/PATTERN/[,EXPR[,LIMIT]])]
6575sprintf(FORMAT,LIST)
6576sqrt(EXPR)
6577srand(EXPR)
6578stat(EXPR|FILEHANDLE|VAR)
6579study[(SCALAR)]
6580sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6581substr(EXPR,OFFSET[,LEN])
6582symlink(OLDFILE,NEWFILE)
6583syscall(LIST)
6584sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6585system(LIST)
6586syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6587tell[(FILEHANDLE)]
6588telldir(DIRHANDLE)
6589time
6590times
6591tr/SEARCHLIST/REPLACEMENTLIST/cds
6592truncate(FILE|EXPR,LENGTH)
6593umask[(EXPR)]
6594undef[(EXPR)]
6595unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6596unlink(LIST)
6597unpack(TEMPLATE,EXPR)
6598unshift(ARRAY,LIST)
6599until (EXPR) { ... } EXPR until EXPR
6600utime(LIST)
6601values(%HASH)
6602vec(EXPR,OFFSET,BITS)
6603wait
6604waitpid(PID,FLAGS)
6605wantarray Returns true if the sub/eval is called in list context.
6606warn(LIST)
6607while (EXPR) { ... } EXPR while EXPR
6608write[(EXPR|FILEHANDLE)]
6609... x ... Repeat string or array.
6610x= ... Repetition assignment.
6611y/SEARCHLIST/REPLACEMENTLIST/
6612... | ... Bitwise or.
6613... || ... Logical or.
6614~ ... Unary bitwise complement.
db133cb6 6615#! OS interpreter indicator. If contains `perl', used for options, and -x.
f83d2997
KH
6616AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6617CORE:: Prefix to access builtin function if imported sub obscures it.
6618SUPER:: Prefix to lookup for a method in @ISA classes.
6619DESTROY Shorthand for `sub DESTROY {...}'.
6620... EQ ... Obsolete synonym of `eq'.
6621... GE ... Obsolete synonym of `ge'.
6622... GT ... Obsolete synonym of `gt'.
6623... LE ... Obsolete synonym of `le'.
6624... LT ... Obsolete synonym of `lt'.
6625... NE ... Obsolete synonym of `ne'.
6626abs [ EXPR ] absolute value
6627... and ... Low-precedence synonym for &&.
6628bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6629chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6630chr Converts a number to char with the same ordinal.
6631else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6632elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
83261a2f 6633exists $HASH{KEY} True if the key exists.
f83d2997
KH
6634format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6635formline PICTURE, LIST Backdoor into \"format\" processing.
6636glob EXPR Synonym of <EXPR>.
6637lc [ EXPR ] Returns lowercased EXPR.
6638lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
db133cb6 6639grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
f83d2997
KH
6640map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6641no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6642not ... Low-precedence synonym for ! - negation.
6643... or ... Low-precedence synonym for ||.
6644pos STRING Set/Get end-position of the last match over this string, see \\G.
6645quotemeta [ EXPR ] Quote regexp metacharacters.
6646qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6647readline FH Synonym of <FH>.
6648readpipe CMD Synonym of `CMD`.
6649ref [ EXPR ] Type of EXPR when dereferenced.
6650sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6651tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6652tied Returns internal object for a tied data.
6653uc [ EXPR ] Returns upcased EXPR.
6654ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6655untie VAR Unlink an object from a simple Perl variable.
6656use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6657... xor ... Low-precedence synonym for exclusive or.
6658prototype \&SUB Returns prototype of the function given a reference.
6659=head1 Top-level heading.
6660=head2 Second-level heading.
6661=head3 Third-level heading (is there such?).
6662=over [ NUMBER ] Start list.
6663=item [ TITLE ] Start new item in the list.
6664=back End list.
6665=cut Switch from POD to Perl.
6666=pod Switch from Perl to POD.
6667")
6668
21df56d5 6669(defun cperl-switch-to-doc-buffer (&optional interactive)
f83d2997 6670 "Go to the perl documentation buffer and insert the documentation."
21df56d5 6671 (interactive "p")
f83d2997 6672 (let ((buf (get-buffer-create cperl-doc-buffer)))
21df56d5 6673 (if interactive
f83d2997
KH
6674 (switch-to-buffer-other-window buf)
6675 (set-buffer buf))
6676 (if (= (buffer-size) 0)
6677 (progn
6678 (insert (documentation-property 'cperl-short-docs
6679 'variable-documentation))
6680 (setq buffer-read-only t)))))
6681
6c389151 6682(defun cperl-beautify-regexp-piece (b e embed level)
f83d2997
KH
6683 ;; b is before the starting delimiter, e before the ending
6684 ;; e should be a marker, may be changed, but remains "correct".
6c389151
SM
6685 ;; EMBED is nil iff we process the whole REx.
6686 ;; The REx is guarantied to have //x
6687 ;; LEVEL shows how many levels deep to go
6688 ;; position at enter and at leave is not defined
6689 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
f83d2997
KH
6690 (if (not embed)
6691 (goto-char (1+ b))
6692 (goto-char b)
6c389151 6693 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
f83d2997
KH
6694 (forward-char 2)
6695 (delete-char 1)
6696 (forward-char 1))
6697 ((looking-at "(\\?[^a-zA-Z]")
6698 (forward-char 3))
6699 ((looking-at "(\\?") ; (?i)
6700 (forward-char 2))
6701 (t
6702 (forward-char 1))))
6703 (setq c (if embed (current-indentation) (1- (current-column)))
6704 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
6705 (or (looking-at "[ \t]*[\n#]")
6706 (progn
6707 (insert "\n")))
6708 (goto-char e)
6709 (beginning-of-line)
6710 (if (re-search-forward "[^ \t]" e t)
83261a2f 6711 (progn ; Something before the ending delimiter
f83d2997 6712 (goto-char e)
6c389151 6713 (delete-horizontal-space)
f83d2997
KH
6714 (insert "\n")
6715 (indent-to-column c)
6716 (set-marker e (point))))
6717 (goto-char b)
6718 (end-of-line 2)
6719 (while (< (point) (marker-position e))
6720 (beginning-of-line)
6721 (setq s (point)
6722 inline t)
6723 (skip-chars-forward " \t")
6724 (delete-region s (point))
6725 (indent-to-column c1)
6726 (while (and
6727 inline
5c8b7eaf 6728 (looking-at
f83d2997
KH
6729 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
6730 "\\|" ; Embedded variable
6731 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
6732 "\\|" ; $ ^
6733 "[$^]"
6734 "\\|" ; simple-code simple-code*?
6735 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
6736 "\\|" ; Class
6737 "\\(\\[\\)" ; 6
6738 "\\|" ; Grouping
6739 "\\((\\(\\?\\)?\\)" ; 7 8
6740 "\\|" ; |
83261a2f 6741 "\\(|\\)"))) ; 9
f83d2997
KH
6742 (goto-char (match-end 0))
6743 (setq spaces t)
6744 (cond ((match-beginning 1) ; Alphanum word + junk
6745 (forward-char -1))
6746 ((or (match-beginning 3) ; $ab[12]
6747 (and (match-beginning 5) ; X* X+ X{2,3}
6748 (eq (preceding-char) ?\{)))
6749 (forward-char -1)
6750 (forward-sexp 1))
6751 ((match-beginning 6) ; []
6752 (setq tmp (point))
6753 (if (looking-at "\\^?\\]")
6754 (goto-char (match-end 0)))
6c389151
SM
6755 ;; XXXX POSIX classes?!
6756 (while (and (not pos)
6757 (re-search-forward "\\[:\\|\\]" e t))
6758 (if (eq (preceding-char) ?:)
6759 (or (re-search-forward ":\\]" e t)
6760 (error "[:POSIX:]-group in []-group not terminated"))
6761 (setq pos t)))
6762 (or (eq (preceding-char) ?\])
6763 (error "[]-group not terminated"))
6764 (if (eq (following-char) ?\{)
f83d2997 6765 (progn
6c389151
SM
6766 (forward-sexp 1)
6767 (and (eq (following-char) ??)
6768 (forward-char 1)))
6769 (re-search-forward "\\=\\([*+?]\\??\\)" e t)))
f83d2997
KH
6770 ((match-beginning 7) ; ()
6771 (goto-char (match-beginning 0))
6c389151
SM
6772 (setq pos (current-column))
6773 (or (eq pos c1)
f83d2997 6774 (progn
6c389151 6775 (delete-horizontal-space)
f83d2997
KH
6776 (insert "\n")
6777 (indent-to-column c1)))
6778 (setq tmp (point))
6779 (forward-sexp 1)
6780 ;; (or (forward-sexp 1)
6781 ;; (progn
6782 ;; (goto-char tmp)
6783 ;; (error "()-group not terminated")))
6784 (set-marker m (1- (point)))
6785 (set-marker m1 (point))
6c389151
SM
6786 (if (= level 1)
6787 (if (progn ; indent rigidly if multiline
a1506d29 6788 ;; In fact does not make a lot of sense, since
6c389151
SM
6789 ;; the starting position can be already lost due
6790 ;; to insertion of "\n" and " "
6791 (goto-char tmp)
6792 (search-forward "\n" m1 t))
6793 (indent-rigidly (point) m1 (- c1 pos)))
6794 (setq level (1- level))
6795 (cond
6796 ((not (match-beginning 8))
6797 (cperl-beautify-regexp-piece tmp m t level))
6798 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
6799 t)
6800 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
6801 (goto-char (+ 2 tmp))
6802 (forward-sexp 1)
6803 (cperl-beautify-regexp-piece (point) m t level))
6804 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
6805 (goto-char (+ 3 tmp))
6806 (cperl-beautify-regexp-piece (point) m t level))
6807 (t
6808 (cperl-beautify-regexp-piece tmp m t level))))
f83d2997
KH
6809 (goto-char m1)
6810 (cond ((looking-at "[*+?]\\??")
6811 (goto-char (match-end 0)))
6812 ((eq (following-char) ?\{)
6813 (forward-sexp 1)
6814 (if (eq (following-char) ?\?)
6815 (forward-char))))
6816 (skip-chars-forward " \t")
6817 (setq spaces nil)
6818 (if (looking-at "[#\n]")
6819 (progn
6820 (or (eolp) (indent-for-comment))
6821 (beginning-of-line 2))
6c389151 6822 (delete-horizontal-space)
f83d2997
KH
6823 (insert "\n"))
6824 (end-of-line)
6825 (setq inline nil))
6826 ((match-beginning 9) ; |
6827 (forward-char -1)
6828 (setq tmp (point))
6829 (beginning-of-line)
6830 (if (re-search-forward "[^ \t]" tmp t)
6831 (progn
6832 (goto-char tmp)
6c389151 6833 (delete-horizontal-space)
f83d2997
KH
6834 (insert "\n"))
6835 ;; first at line
6836 (delete-region (point) tmp))
6837 (indent-to-column c)
6838 (forward-char 1)
6839 (skip-chars-forward " \t")
6840 (setq spaces nil)
6841 (if (looking-at "[#\n]")
6842 (beginning-of-line 2)
6c389151 6843 (delete-horizontal-space)
f83d2997
KH
6844 (insert "\n"))
6845 (end-of-line)
6846 (setq inline nil)))
6847 (or (looking-at "[ \t\n]")
6848 (not spaces)
6849 (insert " "))
6850 (skip-chars-forward " \t"))
83261a2f
SM
6851 (or (looking-at "[#\n]")
6852 (error "Unknown code `%s' in a regexp"
6853 (buffer-substring (point) (1+ (point)))))
6854 (and inline (end-of-line 2)))
f83d2997
KH
6855 ;; Special-case the last line of group
6856 (if (and (>= (point) (marker-position e))
6857 (/= (current-indentation) c))
6858 (progn
83261a2f
SM
6859 (beginning-of-line)
6860 (setq s (point))
6861 (skip-chars-forward " \t")
6862 (delete-region s (point))
6863 (indent-to-column c)))))
f83d2997
KH
6864
6865(defun cperl-make-regexp-x ()
db133cb6 6866 ;; Returns position of the start
6c389151 6867 ;; XXX this is called too often! Need to cache the result!
f83d2997
KH
6868 (save-excursion
6869 (or cperl-use-syntax-table-text-property
5bd52f0e 6870 (error "I need to have a regexp marked!"))
f83d2997 6871 ;; Find the start
db133cb6
RS
6872 (if (looking-at "\\s|")
6873 nil ; good already
5bd52f0e 6874 (if (looking-at "\\([smy]\\|qr\\)\\s|")
db133cb6 6875 (forward-char 1)
83261a2f 6876 (re-search-backward "\\s|"))) ; Assume it is scanned already.
f83d2997
KH
6877 ;;(forward-char 1)
6878 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
6879 (sub-p (eq (preceding-char) ?s)) s)
6880 (forward-sexp 1)
6881 (set-marker e (1- (point)))
6882 (setq delim (preceding-char))
6883 (if (and sub-p (eq delim (char-after (- (point) 2))))
6884 (error "Possible s/blah// - do not know how to deal with"))
6885 (if sub-p (forward-sexp 1))
5c8b7eaf 6886 (if (looking-at "\\sw*x")
f83d2997
KH
6887 (setq have-x t)
6888 (insert "x"))
6889 ;; Protect fragile " ", "#"
6890 (if have-x nil
6891 (goto-char (1+ b))
6892 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6893 (forward-char -1)
6894 (insert "\\")
6895 (forward-char 1)))
6896 b)))
6897
6c389151 6898(defun cperl-beautify-regexp (&optional deep)
f94a632a 6899 "Do it. (Experimental, may change semantics, recheck the result.)
f83d2997 6900We suppose that the regexp is scanned already."
6c389151 6901 (interactive "P")
0c602a0f 6902 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
6903 (save-excursion
6904 (goto-char (cperl-make-regexp-x))
6905 (let ((b (point)) (e (make-marker)))
6906 (forward-sexp 1)
6907 (set-marker e (1- (point)))
6908 (cperl-beautify-regexp-piece b e nil deep))))
f83d2997 6909
db133cb6
RS
6910(defun cperl-regext-to-level-start ()
6911 "Goto start of an enclosing group in regexp.
f83d2997
KH
6912We suppose that the regexp is scanned already."
6913 (interactive)
db133cb6 6914 (let ((limit (cperl-make-regexp-x)) done)
f83d2997
KH
6915 (while (not done)
6916 (or (eq (following-char) ?\()
db133cb6 6917 (search-backward "(" (1+ limit) t)
f83d2997
KH
6918 (error "Cannot find `(' which starts a group"))
6919 (setq done
6920 (save-excursion
6921 (skip-chars-backward "\\")
6922 (looking-at "\\(\\\\\\\\\\)*(")))
db133cb6
RS
6923 (or done (forward-char -1)))))
6924
6925(defun cperl-contract-level ()
5bd52f0e 6926 "Find an enclosing group in regexp and contract it.
db133cb6
RS
6927\(Experimental, may change semantics, recheck the result.)
6928We suppose that the regexp is scanned already."
6929 (interactive)
6c389151 6930 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
83261a2f
SM
6931 (cperl-regext-to-level-start)
6932 (let ((b (point)) (e (make-marker)) s c)
6933 (forward-sexp 1)
6934 (set-marker e (1- (point)))
6935 (goto-char b)
6936 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
6937 (cond
6938 ((match-beginning 1) ; #-comment
6939 (or c (setq c (current-indentation)))
6940 (beginning-of-line 2) ; Skip
6941 (setq s (point))
6942 (skip-chars-forward " \t")
6943 (delete-region s (point))
6944 (indent-to-column c))
6945 (t
6946 (delete-char -1)
6947 (just-one-space))))))
db133cb6
RS
6948
6949(defun cperl-contract-levels ()
5bd52f0e 6950 "Find an enclosing group in regexp and contract all the kids.
db133cb6
RS
6951\(Experimental, may change semantics, recheck the result.)
6952We suppose that the regexp is scanned already."
6953 (interactive)
6c389151
SM
6954 (save-excursion
6955 (condition-case nil
6956 (cperl-regext-to-level-start)
6957 (error ; We are outside outermost group
5efe6a56
SM
6958 (goto-char (cperl-make-regexp-x))))
6959 (let ((b (point)) (e (make-marker)) s c)
6960 (forward-sexp 1)
6961 (set-marker e (1- (point)))
6962 (goto-char (1+ b))
6963 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
a1506d29 6964 (cond
6c389151
SM
6965 ((match-beginning 1) ; Skip
6966 nil)
6967 (t ; Group
6968 (cperl-contract-level)))))))
f83d2997 6969
6c389151 6970(defun cperl-beautify-level (&optional deep)
f83d2997
KH
6971 "Find an enclosing group in regexp and beautify it.
6972\(Experimental, may change semantics, recheck the result.)
6973We suppose that the regexp is scanned already."
6c389151 6974 (interactive "P")
0c602a0f 6975 (setq deep (if deep (prefix-numeric-value deep) -1))
6c389151
SM
6976 (save-excursion
6977 (cperl-regext-to-level-start)
6978 (let ((b (point)) (e (make-marker)))
6979 (forward-sexp 1)
6980 (set-marker e (1- (point)))
6981 (cperl-beautify-regexp-piece b e nil deep))))
db133cb6
RS
6982
6983(defun cperl-invert-if-unless ()
6c389151 6984 "Change `if (A) {B}' into `B if A;' etc if possible."
db133cb6
RS
6985 (interactive)
6986 (or (looking-at "\\<")
83261a2f 6987 (forward-sexp -1))
6c389151 6988 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
db133cb6
RS
6989 (let ((pos1 (point))
6990 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6991 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
6992 (forward-sexp 2)
6993 (setq pos3 (point))
6994 (forward-sexp -1)
6995 (setq pos2 (point))
6996 (if (eq (following-char) ?\( )
6997 (progn
6998 (goto-char pos3)
6999 (forward-sexp 1)
7000 (setq pos5 (point))
7001 (forward-sexp -1)
7002 (setq pos4 (point))
7003 ;; XXXX In fact may be `A if (B); {C}' ...
7004 (if (and (eq (following-char) ?\{ )
7005 (progn
7006 (cperl-backward-to-noncomment pos3)
7007 (eq (preceding-char) ?\) )))
7008 (if (condition-case nil
7009 (progn
7010 (goto-char pos5)
7011 (forward-sexp 1)
7012 (forward-sexp -1)
7013 (looking-at "\\<els\\(e\\|if\\)\\>"))
7014 (error nil))
7015 (error
7016 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0)
7017 (goto-char (1- pos5))
7018 (cperl-backward-to-noncomment pos4)
7019 (if (eq (preceding-char) ?\;)
7020 (forward-char -1))
7021 (setq pos45 (point))
7022 (goto-char pos4)
7023 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
7024 (setq p (match-beginning 0)
7025 s1 (buffer-substring p (match-end 0))
7026 state (parse-partial-sexp pos4 p))
5c8b7eaf 7027 (or (nth 3 state)
db133cb6
RS
7028 (nth 4 state)
7029 (nth 5 state)
7030 (error "`%s' inside `%s' BLOCK" s1 s0))
7031 (goto-char (match-end 0)))
7032 ;; Finally got it
7033 (goto-char (1+ pos4))
7034 (skip-chars-forward " \t\n")
7035 (setq s2 (buffer-substring (point) pos45))
7036 (goto-char pos45)
7037 (or (looking-at ";?[ \t\n]*}")
7038 (progn
7039 (skip-chars-forward "; \t\n")
7040 (setq s2 (concat s2 "\n" (buffer-substring (point) (1- pos5))))))
7041 (and (equal s2 "")
7042 (setq s2 "1"))
7043 (goto-char (1- pos3))
7044 (cperl-backward-to-noncomment pos2)
7045 (or (looking-at "[ \t\n]*)")
7046 (goto-char (1- pos3)))
7047 (setq p (point))
7048 (goto-char (1+ pos2))
7049 (skip-chars-forward " \t\n")
7050 (setq s1 (buffer-substring (point) p))
7051 (delete-region pos4 pos5)
7052 (delete-region pos2 pos3)
7053 (goto-char pos1)
7054 (insert s2 " ")
7055 (just-one-space)
7056 (forward-word 1)
7057 (setq pos1 (point))
7058 (insert " " s1 ";")
6c389151 7059 (delete-horizontal-space)
db133cb6
RS
7060 (forward-char -1)
7061 (delete-horizontal-space)
7062 (goto-char pos1)
7063 (just-one-space)
7064 (cperl-indent-line))
7065 (error "`%s' (EXPR) not with an {BLOCK}" s0)))
7066 (error "`%s' not with an (EXPR)" s0)))
f94a632a 7067 (error "Not at `if', `unless', `while', `until', `for' or `foreach'")))
db133cb6 7068
5bd52f0e 7069;;; By Anthony Foiani <afoiani@uswest.com>
b7ec9e59
RS
7070;;; Getting help on modules in C-h f ?
7071;;; This is a modified version of `man'.
7072;;; Need to teach it how to lookup functions
7073(defun cperl-perldoc (word)
7074 "Run `perldoc' on WORD."
7075 (interactive
7076 (list (let* ((default-entry (cperl-word-at-point))
7077 (input (read-string
7078 (format "perldoc entry%s: "
7079 (if (string= default-entry "")
7080 ""
7081 (format " (default %s)" default-entry))))))
7082 (if (string= input "")
7083 (if (string= default-entry "")
7084 (error "No perldoc args given")
7085 default-entry)
7086 input))))
a8e1e57f 7087 (require 'man)
f739b53b
SM
7088 (let* ((case-fold-search nil)
7089 (is-func (and
b7ec9e59
RS
7090 (string-match "^[a-z]+$" word)
7091 (string-match (concat "^" word "\\>")
7092 (documentation-property
7093 'cperl-short-docs
7094 'variable-documentation))))
7095 (manual-program (if is-func "perldoc -f" "perldoc")))
f739b53b
SM
7096 (cond
7097 (cperl-xemacs-p
7098 (let ((Manual-program "perldoc")
7099 (Manual-switches (if is-func (list "-f"))))
7100 (manual-entry word)))
7101 (t
7102 (Man-getpage-in-background word)))))
b7ec9e59
RS
7103
7104(defun cperl-perldoc-at-point ()
7105 "Run a `perldoc' on the word around point."
7106 (interactive)
7107 (cperl-perldoc (cperl-word-at-point)))
7108
7109(defcustom pod2man-program "pod2man"
7110 "*File name for `pod2man'."
7111 :type 'file
7112 :group 'cperl)
7113
5bd52f0e 7114;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
b7ec9e59
RS
7115(defun cperl-pod-to-manpage ()
7116 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7117 (interactive)
7118 (require 'man)
7119 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
7120 (bufname (concat "Man " buffer-file-name))
7121 (buffer (generate-new-buffer bufname)))
7122 (save-excursion
7123 (set-buffer buffer)
7124 (let ((process-environment (copy-sequence process-environment)))
7125 ;; Prevent any attempt to use display terminal fanciness.
7126 (setenv "TERM" "dumb")
7127 (set-process-sentinel
7128 (start-process pod2man-program buffer "sh" "-c"
7129 (format (cperl-pod2man-build-command) pod2man-args))
7130 'Man-bgproc-sentinel)))))
7131
f739b53b
SM
7132;;; Updated version by him too
7133(defun cperl-build-manpage ()
7134 "Create a virtual manpage in Emacs from the POD in the file."
7135 (interactive)
7136 (require 'man)
7137 (cond
7138 (cperl-xemacs-p
7139 (let ((Manual-program "perldoc"))
7140 (manual-entry buffer-file-name)))
7141 (t
7142 (let* ((manual-program "perldoc"))
7143 (Man-getpage-in-background buffer-file-name)))))
7144
b7ec9e59
RS
7145(defun cperl-pod2man-build-command ()
7146 "Builds the entire background manpage and cleaning command."
7147 (let ((command (concat pod2man-program " %s 2>/dev/null"))
7148 (flist Man-filter-list))
7149 (while (and flist (car flist))
7150 (let ((pcom (car (car flist)))
7151 (pargs (cdr (car flist))))
7152 (setq command
7153 (concat command " | " pcom " "
7154 (mapconcat '(lambda (phrase)
7155 (if (not (stringp phrase))
7156 (error "Malformed Man-filter-list"))
7157 phrase)
7158 pargs " ")))
7159 (setq flist (cdr flist))))
7160 command))
db133cb6
RS
7161
7162(defun cperl-lazy-install ()) ; Avoid a warning
f739b53b 7163(defun cperl-lazy-unstall ()) ; Avoid a warning
f83d2997
KH
7164
7165(if (fboundp 'run-with-idle-timer)
7166 (progn
7167 (defvar cperl-help-shown nil
7168 "Non-nil means that the help was already shown now.")
7169
7170 (defvar cperl-lazy-installed nil
7171 "Non-nil means that the lazy-help handlers are installed now.")
7172
7173 (defun cperl-lazy-install ()
f739b53b
SM
7174 "Switches on Auto-Help on Perl constructs (put in the message area).
7175Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997
KH
7176 (interactive)
7177 (make-variable-buffer-local 'cperl-help-shown)
7178 (if (and (cperl-val 'cperl-lazy-help-time)
7179 (not cperl-lazy-installed))
7180 (progn
7181 (add-hook 'post-command-hook 'cperl-lazy-hook)
5c8b7eaf
SS
7182 (run-with-idle-timer
7183 (cperl-val 'cperl-lazy-help-time 1000000 5)
7184 t
f83d2997
KH
7185 'cperl-get-help-defer)
7186 (setq cperl-lazy-installed t))))
7187
7188 (defun cperl-lazy-unstall ()
f739b53b
SM
7189 "Switches off Auto-Help on Perl constructs (put in the message area).
7190Delay of auto-help controlled by `cperl-lazy-help-time'."
f83d2997
KH
7191 (interactive)
7192 (remove-hook 'post-command-hook 'cperl-lazy-hook)
7193 (cancel-function-timers 'cperl-get-help-defer)
7194 (setq cperl-lazy-installed nil))
7195
7196 (defun cperl-lazy-hook ()
7197 (setq cperl-help-shown nil))
7198
7199 (defun cperl-get-help-defer ()
83261a2f 7200 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
f83d2997
KH
7201 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
7202 (cperl-get-help)
7203 (setq cperl-help-shown t))))
7204 (cperl-lazy-install)))
7205
db133cb6
RS
7206
7207;;; Plug for wrong font-lock:
7208
7209(defun cperl-font-lock-unfontify-region-function (beg end)
f8fd4f55
RS
7210 ;; Simplified now that font-lock-unfontify-region uses save-buffer-state.
7211 (let (before-change-functions after-change-functions)
7212 (remove-text-properties beg end '(face nil))))
db133cb6
RS
7213
7214(defvar cperl-d-l nil)
7215(defun cperl-fontify-syntaxically (end)
5bd52f0e 7216 ;; Some vars for debugging only
6c389151 7217 ;; (message "Syntaxifying...")
83261a2f
SM
7218 (let ((dbg (point)) (iend end)
7219 (istate (car cperl-syntax-state))
7220 start)
5bd52f0e
RS
7221 (and cperl-syntaxify-unwind
7222 (setq end (cperl-unwind-to-safe t end)))
7223 (setq start (point))
db133cb6
RS
7224 (or cperl-syntax-done-to
7225 (setq cperl-syntax-done-to (point-min)))
7226 (if (or (not (boundp 'font-lock-hot-pass))
5bd52f0e
RS
7227 (eval 'font-lock-hot-pass)
7228 t) ; Not debugged otherwise
db133cb6
RS
7229 ;; Need to forget what is after `start'
7230 (setq start (min cperl-syntax-done-to start))
7231 ;; Fontification without a change
7232 (setq start (max cperl-syntax-done-to start)))
7233 (and (> end start)
7234 (setq cperl-syntax-done-to start) ; In case what follows fails
7235 (cperl-find-pods-heres start end t nil t))
5bd52f0e 7236 (if (eq cperl-syntaxify-by-font-lock 'message)
5c8b7eaf
SS
7237 (message "Syntaxified %s..%s from %s to %s(%s), state %s-->%s"
7238 dbg iend
7239 start end cperl-syntax-done-to
7240 istate (car cperl-syntax-state))) ; For debugging
83261a2f 7241 nil)) ; Do not iterate
db133cb6 7242
5bd52f0e
RS
7243(defun cperl-fontify-update (end)
7244 (let ((pos (point)) prop posend)
7245 (while (< pos end)
7246 (setq prop (get-text-property pos 'cperl-postpone))
7247 (setq posend (next-single-property-change pos 'cperl-postpone nil end))
7248 (and prop (put-text-property pos posend (car prop) (cdr prop)))
7249 (setq pos posend)))
83261a2f 7250 nil) ; Do not iterate
5bd52f0e
RS
7251
7252(defun cperl-update-syntaxification (from to)
7253 (if (and cperl-use-syntax-table-text-property
7254 cperl-syntaxify-by-font-lock
7255 (or (null cperl-syntax-done-to)
7256 (< cperl-syntax-done-to to)))
7257 (progn
7258 (save-excursion
7259 (goto-char from)
7260 (cperl-fontify-syntaxically to)))))
7261
5c8b7eaf 7262(defvar cperl-version
f739b53b 7263 (let ((v "Revision: 5.0"))
5bd52f0e
RS
7264 (string-match ":\\s *\\([0-9.]+\\)" v)
7265 (substring v (match-beginning 1) (match-end 1)))
7266 "Version of IZ-supported CPerl package this file is based on.")
7267
f83d2997
KH
7268(provide 'cperl-mode)
7269
ab5796a9 7270;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
f83d2997 7271;;; cperl-mode.el ends here