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