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