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