]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cperl-mode.el
Add 2012 to FSF copyright years for Emacs files (do not merge to trunk)
[gnu-emacs] / lisp / progmodes / cperl-mode.el
1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
5 ;; Free Software Foundation, Inc.
6
7 ;; Author: Ilya Zakharevich
8 ;; Bob Olson
9 ;; Maintainer: Ilya Zakharevich <ilyaz@cpan.org>
10 ;; Keywords: languages, Perl
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26
27 ;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
28
29 ;;; Commentary:
30
31 ;; You can either fine-tune the bells and whistles of this mode or
32 ;; bulk enable them by putting
33
34 ;; (setq cperl-hairy t)
35
36 ;; in your .emacs file. (Emacs rulers do not consider it politically
37 ;; correct to make whistles enabled by default.)
38
39 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
40 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
41 ;; `cperl-praise', `cperl-speed'. <<<<<<
42
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.
46
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.
52
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:
58
59 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
60
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
68 ;;; Code:
69 \f
70 (defvar vc-rcs-header)
71 (defvar vc-sccs-header)
72
73 (eval-when-compile
74 (condition-case nil
75 (require 'custom)
76 (error nil))
77 (condition-case nil
78 (require 'man)
79 (error nil))
80 (defvar cperl-can-font-lock
81 (or (featurep 'xemacs)
82 (and (boundp 'emacs-major-version)
83 (or window-system
84 (> emacs-major-version 20)))))
85 (if cperl-can-font-lock
86 (require 'font-lock))
87 (defvar msb-menu-cond)
88 (defvar gud-perldb-history)
89 (defvar font-lock-background-mode) ; not in Emacs
90 (defvar font-lock-display-type) ; ditto
91 (defvar paren-backwards-message) ; Not in newer XEmacs?
92 (or (fboundp 'defgroup)
93 (defmacro defgroup (name val doc &rest arr)
94 nil))
95 (or (fboundp 'custom-declare-variable)
96 (defmacro defcustom (name val doc &rest arr)
97 `(defvar ,name ,val ,doc)))
98 (or (and (fboundp 'custom-declare-variable)
99 (string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
100 (defmacro defface (&rest arr)
101 nil))
102 ;; Avoid warning (tmp definitions)
103 (or (fboundp 'x-color-defined-p)
104 (defmacro x-color-defined-p (col)
105 (cond ((fboundp 'color-defined-p) `(color-defined-p ,col))
106 ;; XEmacs >= 19.12
107 ((fboundp 'valid-color-name-p) `(valid-color-name-p ,col))
108 ;; XEmacs 19.11
109 ((fboundp 'x-valid-color-name-p) `(x-valid-color-name-p ,col))
110 (t '(error "Cannot implement color-defined-p")))))
111 (defmacro cperl-is-face (arg) ; Takes quoted arg
112 (cond ((fboundp 'find-face)
113 `(find-face ,arg))
114 (;;(and (fboundp 'face-list)
115 ;; (face-list))
116 (fboundp 'face-list)
117 `(member ,arg (and (fboundp 'face-list)
118 (face-list))))
119 (t
120 `(boundp ,arg))))
121 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
122 (cond ((fboundp 'make-face)
123 `(make-face (quote ,arg)))
124 (t
125 `(defvar ,arg (quote ,arg) ,descr))))
126 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
127 `(progn
128 (or (cperl-is-face (quote ,arg))
129 (cperl-make-face ,arg ,descr))
130 (or (boundp (quote ,arg)) ; We use unquoted variants too
131 (defvar ,arg (quote ,arg) ,descr))))
132 (if (featurep 'xemacs)
133 (defmacro cperl-etags-snarf-tag (file line)
134 `(progn
135 (beginning-of-line 2)
136 (list ,file ,line)))
137 (defmacro cperl-etags-snarf-tag (file line)
138 `(etags-snarf-tag)))
139 (if (featurep 'xemacs)
140 (defmacro cperl-etags-goto-tag-location (elt)
141 ;;(progn
142 ;; (switch-to-buffer (get-file-buffer (elt ,elt 0)))
143 ;; (set-buffer (get-file-buffer (elt ,elt 0)))
144 ;; Probably will not work due to some save-excursion???
145 ;; Or save-file-position?
146 ;; (message "Did I get to line %s?" (elt ,elt 1))
147 `(goto-line (string-to-int (elt ,elt 1))))
148 ;;)
149 (defmacro cperl-etags-goto-tag-location (elt)
150 `(etags-goto-tag-location ,elt))))
151
152 (defvar cperl-can-font-lock
153 (or (featurep 'xemacs)
154 (and (boundp 'emacs-major-version)
155 (or window-system
156 (> emacs-major-version 20)))))
157
158 (defun cperl-choose-color (&rest list)
159 (let (answer)
160 (while list
161 (or answer
162 (if (or (x-color-defined-p (car list))
163 (null (cdr list)))
164 (setq answer (car list))))
165 (setq list (cdr list)))
166 answer))
167
168 (defgroup cperl nil
169 "Major mode for editing Perl code."
170 :prefix "cperl-"
171 :group 'languages
172 :version "20.3")
173
174 (defgroup cperl-indentation-details nil
175 "Indentation."
176 :prefix "cperl-"
177 :group 'cperl)
178
179 (defgroup cperl-affected-by-hairy nil
180 "Variables affected by `cperl-hairy'."
181 :prefix "cperl-"
182 :group 'cperl)
183
184 (defgroup cperl-autoinsert-details nil
185 "Auto-insert tuneup."
186 :prefix "cperl-"
187 :group 'cperl)
188
189 (defgroup cperl-faces nil
190 "Fontification colors."
191 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
192 :prefix "cperl-"
193 :group 'cperl)
194
195 (defgroup cperl-speed nil
196 "Speed vs. validity tuneup."
197 :prefix "cperl-"
198 :group 'cperl)
199
200 (defgroup cperl-help-system nil
201 "Help system tuneup."
202 :prefix "cperl-"
203 :group 'cperl)
204
205 \f
206 (defcustom cperl-extra-newline-before-brace nil
207 "*Non-nil means that if, elsif, while, until, else, for, foreach
208 and do constructs look like:
209
210 if ()
211 {
212 }
213
214 instead of:
215
216 if () {
217 }"
218 :type 'boolean
219 :group 'cperl-autoinsert-details)
220
221 (defcustom cperl-extra-newline-before-brace-multiline
222 cperl-extra-newline-before-brace
223 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
224 for constructs with multiline if/unless/while/until/for/foreach condition."
225 :type 'boolean
226 :group 'cperl-autoinsert-details)
227
228 (defcustom cperl-indent-level 2
229 "*Indentation of CPerl statements with respect to containing block."
230 :type 'integer
231 :group 'cperl-indentation-details)
232
233 ;; Is is not unusual to put both things like perl-indent-level and
234 ;; cperl-indent-level in the local variable section of a file. If only
235 ;; one of perl-mode and cperl-mode is in use, a warning will be issued
236 ;; about the variable. Autoload these here, so that no warning is
237 ;; issued when using either perl-mode or cperl-mode.
238 ;;;###autoload(put 'cperl-indent-level 'safe-local-variable 'integerp)
239 ;;;###autoload(put 'cperl-brace-offset 'safe-local-variable 'integerp)
240 ;;;###autoload(put 'cperl-continued-brace-offset 'safe-local-variable 'integerp)
241 ;;;###autoload(put 'cperl-label-offset 'safe-local-variable 'integerp)
242 ;;;###autoload(put 'cperl-continued-statement-offset 'safe-local-variable 'integerp)
243 ;;;###autoload(put 'cperl-extra-newline-before-brace 'safe-local-variable 'booleanp)
244 ;;;###autoload(put 'cperl-merge-trailing-else 'safe-local-variable 'booleanp)
245
246 (defcustom cperl-lineup-step nil
247 "*`cperl-lineup' will always lineup at multiple of this number.
248 If nil, the value of `cperl-indent-level' will be used."
249 :type '(choice (const nil) integer)
250 :group 'cperl-indentation-details)
251
252 (defcustom cperl-brace-imaginary-offset 0
253 "*Imagined indentation of a Perl open brace that actually follows a statement.
254 An open brace following other text is treated as if it were this far
255 to the right of the start of its line."
256 :type 'integer
257 :group 'cperl-indentation-details)
258
259 (defcustom cperl-brace-offset 0
260 "*Extra indentation for braces, compared with other text in same context."
261 :type 'integer
262 :group 'cperl-indentation-details)
263 (defcustom cperl-label-offset -2
264 "*Offset of CPerl label lines relative to usual indentation."
265 :type 'integer
266 :group 'cperl-indentation-details)
267 (defcustom cperl-min-label-indent 1
268 "*Minimal offset of CPerl label lines."
269 :type 'integer
270 :group 'cperl-indentation-details)
271 (defcustom cperl-continued-statement-offset 2
272 "*Extra indent for lines not starting new statements."
273 :type 'integer
274 :group 'cperl-indentation-details)
275 (defcustom cperl-continued-brace-offset 0
276 "*Extra indent for substatements that start with open-braces.
277 This is in addition to cperl-continued-statement-offset."
278 :type 'integer
279 :group 'cperl-indentation-details)
280 (defcustom cperl-close-paren-offset -1
281 "*Extra indent for substatements that start with close-parenthesis."
282 :type 'integer
283 :group 'cperl-indentation-details)
284
285 (defcustom cperl-indent-wrt-brace t
286 "*Non-nil means indent statements in if/etc block relative brace, not if/etc.
287 Versions 5.2 ... 5.20 behaved as if this were `nil'."
288 :type 'boolean
289 :group 'cperl-indentation-details)
290
291 (defcustom cperl-auto-newline nil
292 "*Non-nil means automatically newline before and after braces,
293 and after colons and semicolons, inserted in CPerl code. The following
294 \\[cperl-electric-backspace] will remove the inserted whitespace.
295 Insertion after colons requires both this variable and
296 `cperl-auto-newline-after-colon' set."
297 :type 'boolean
298 :group 'cperl-autoinsert-details)
299
300 (defcustom cperl-autoindent-on-semi nil
301 "*Non-nil means automatically indent after insertion of (semi)colon.
302 Active if `cperl-auto-newline' is false."
303 :type 'boolean
304 :group 'cperl-autoinsert-details)
305
306 (defcustom cperl-auto-newline-after-colon nil
307 "*Non-nil means automatically newline even after colons.
308 Subject to `cperl-auto-newline' setting."
309 :type 'boolean
310 :group 'cperl-autoinsert-details)
311
312 (defcustom cperl-tab-always-indent t
313 "*Non-nil means TAB in CPerl mode should always reindent the current line,
314 regardless of where in the line point is when the TAB command is used."
315 :type 'boolean
316 :group 'cperl-indentation-details)
317
318 (defcustom cperl-font-lock nil
319 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
320 Can be overwritten by `cperl-hairy' if nil."
321 :type '(choice (const null) boolean)
322 :group 'cperl-affected-by-hairy)
323
324 (defcustom cperl-electric-lbrace-space nil
325 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
326 Can be overwritten by `cperl-hairy' if nil."
327 :type '(choice (const null) boolean)
328 :group 'cperl-affected-by-hairy)
329
330 (defcustom cperl-electric-parens-string "({[]})<"
331 "*String of parentheses that should be electric in CPerl.
332 Closing ones are electric only if the region is highlighted."
333 :type 'string
334 :group 'cperl-affected-by-hairy)
335
336 (defcustom cperl-electric-parens nil
337 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
338 Can be overwritten by `cperl-hairy' if nil."
339 :type '(choice (const null) boolean)
340 :group 'cperl-affected-by-hairy)
341
342 (defvar zmacs-regions) ; Avoid warning
343
344 (defcustom cperl-electric-parens-mark
345 (and window-system
346 (or (and (boundp 'transient-mark-mode) ; For Emacs
347 transient-mark-mode)
348 (and (boundp 'zmacs-regions) ; For XEmacs
349 zmacs-regions)))
350 "*Not-nil means that electric parens look for active mark.
351 Default is yes if there is visual feedback on mark."
352 :type 'boolean
353 :group 'cperl-autoinsert-details)
354
355 (defcustom cperl-electric-linefeed nil
356 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
357 In any case these two mean plain and hairy linefeeds together.
358 Can be overwritten by `cperl-hairy' if nil."
359 :type '(choice (const null) boolean)
360 :group 'cperl-affected-by-hairy)
361
362 (defcustom cperl-electric-keywords nil
363 "*Not-nil (and non-null) means keywords are electric in CPerl.
364 Can be overwritten by `cperl-hairy' if nil.
365
366 Uses `abbrev-mode' to do the expansion. If you want to use your
367 own abbrevs in cperl-mode, but do not want keywords to be
368 electric, you must redefine `cperl-mode-abbrev-table': do
369 \\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in
370 that paragraph, delete the words that appear at the ends of lines and
371 that begin with \"cperl-electric\".
372 "
373 :type '(choice (const null) boolean)
374 :group 'cperl-affected-by-hairy)
375
376 (defcustom cperl-electric-backspace-untabify t
377 "*Not-nil means electric-backspace will untabify in CPerl."
378 :type 'boolean
379 :group 'cperl-autoinsert-details)
380
381 (defcustom cperl-hairy nil
382 "*Not-nil means most of the bells and whistles are enabled in CPerl.
383 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
384 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
385 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
386 `cperl-lazy-help-time'."
387 :type 'boolean
388 :group 'cperl-affected-by-hairy)
389
390 (defcustom cperl-comment-column 32
391 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
392 :type 'integer
393 :group 'cperl-indentation-details)
394
395 (defcustom cperl-indent-comment-at-column-0 nil
396 "*Non-nil means that comment started at column 0 should be indentable."
397 :type 'boolean
398 :group 'cperl-indentation-details)
399
400 (defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
401 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
402 :type '(repeat string)
403 :group 'cperl)
404
405 (defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
406 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
407 :type '(repeat string)
408 :group 'cperl)
409
410 ;; This became obsolete...
411 (defvar cperl-vc-header-alist nil)
412 (make-obsolete-variable
413 'cperl-vc-header-alist
414 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead."
415 "22.1")
416
417 (defcustom cperl-clobber-mode-lists
418 (not
419 (and
420 (boundp 'interpreter-mode-alist)
421 (assoc "miniperl" interpreter-mode-alist)
422 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
423 "*Whether to install us into `interpreter-' and `extension' mode lists."
424 :type 'boolean
425 :group 'cperl)
426
427 (defcustom cperl-info-on-command-no-prompt nil
428 "*Not-nil (and non-null) means not to prompt on C-h f.
429 The opposite behavior is always available if prefixed with C-c.
430 Can be overwritten by `cperl-hairy' if nil."
431 :type '(choice (const null) boolean)
432 :group 'cperl-affected-by-hairy)
433
434 (defcustom cperl-clobber-lisp-bindings nil
435 "*Not-nil (and non-null) means not overwrite C-h f.
436 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
437 Can be overwritten by `cperl-hairy' if nil."
438 :type '(choice (const null) boolean)
439 :group 'cperl-affected-by-hairy)
440
441 (defcustom cperl-lazy-help-time nil
442 "*Not-nil (and non-null) means to show lazy help after given idle time.
443 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
444 :type '(choice (const null) (const nil) integer)
445 :group 'cperl-affected-by-hairy)
446
447 (defcustom cperl-pod-face 'font-lock-comment-face
448 "*Face for POD highlighting."
449 :type 'face
450 :group 'cperl-faces)
451
452 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
453 "*Face for POD highlighting.
454 Font for POD headers."
455 :type 'face
456 :group 'cperl-faces)
457
458 (defcustom cperl-here-face 'font-lock-string-face
459 "*Face for here-docs highlighting."
460 :type 'face
461 :group 'cperl-faces)
462
463 ;;; Some double-evaluation happened with font-locks... Needed with 21.2...
464 (defvar cperl-singly-quote-face (featurep 'xemacs))
465
466 (defcustom cperl-invalid-face 'underline
467 "*Face for highlighting trailing whitespace."
468 :type 'face
469 :version "21.1"
470 :group 'cperl-faces)
471
472 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
473 "*Not-nil after evaluation means to highlight POD and here-docs sections."
474 :type 'boolean
475 :group 'cperl-faces)
476
477 (defcustom cperl-fontify-m-as-s t
478 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
479 :type 'boolean
480 :group 'cperl-faces)
481
482 (defcustom cperl-highlight-variables-indiscriminately nil
483 "*Non-nil means perform additional highlighting on variables.
484 Currently only changes how scalar variables are highlighted.
485 Note that that variable is only read at initialization time for
486 the variable `cperl-font-lock-keywords-2', so changing it after you've
487 entered CPerl mode the first time will have no effect."
488 :type 'boolean
489 :group 'cperl)
490
491 (defcustom cperl-pod-here-scan t
492 "*Not-nil means look for POD and here-docs sections during startup.
493 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
494 :type 'boolean
495 :group 'cperl-speed)
496
497 (defcustom cperl-regexp-scan t
498 "*Not-nil means make marking of regular expression more thorough.
499 Effective only with `cperl-pod-here-scan'."
500 :type 'boolean
501 :group 'cperl-speed)
502
503 (defcustom cperl-hook-after-change t
504 "*Not-nil means install hook to know which regions of buffer are changed.
505 May significantly speed up delayed fontification. Changes take effect
506 after reload."
507 :type 'boolean
508 :group 'cperl-speed)
509
510 (defcustom cperl-imenu-addback nil
511 "*Not-nil means add backreferences to generated `imenu's.
512 May require patched `imenu' and `imenu-go'. Obsolete."
513 :type 'boolean
514 :group 'cperl-help-system)
515
516 (defcustom cperl-max-help-size 66
517 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
518 :type '(choice integer (const nil))
519 :group 'cperl-help-system)
520
521 (defcustom cperl-shrink-wrap-info-frame t
522 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
523 :type 'boolean
524 :group 'cperl-help-system)
525
526 (defcustom cperl-info-page "perl"
527 "*Name of the info page containing perl docs.
528 Older version of this page was called `perl5', newer `perl'."
529 :type 'string
530 :group 'cperl-help-system)
531
532 (defcustom cperl-use-syntax-table-text-property
533 (boundp 'parse-sexp-lookup-properties)
534 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
535 :type 'boolean
536 :group 'cperl-speed)
537
538 (defcustom cperl-use-syntax-table-text-property-for-tags
539 cperl-use-syntax-table-text-property
540 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
541 :type 'boolean
542 :group 'cperl-speed)
543
544 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
545 "*Regexp to match files to scan when generating TAGS."
546 :type 'regexp
547 :group 'cperl)
548
549 (defcustom cperl-noscan-files-regexp
550 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
551 "*Regexp to match files/dirs to skip when generating TAGS."
552 :type 'regexp
553 :group 'cperl)
554
555 (defcustom cperl-regexp-indent-step nil
556 "*Indentation used when beautifying regexps.
557 If nil, the value of `cperl-indent-level' will be used."
558 :type '(choice integer (const nil))
559 :group 'cperl-indentation-details)
560
561 (defcustom cperl-indent-left-aligned-comments t
562 "*Non-nil means that the comment starting in leftmost column should indent."
563 :type 'boolean
564 :group 'cperl-indentation-details)
565
566 (defcustom cperl-under-as-char nil
567 "*Non-nil means that the _ (underline) should be treated as word char."
568 :type 'boolean
569 :group 'cperl)
570
571 (defcustom cperl-extra-perl-args ""
572 "*Extra arguments to use when starting Perl.
573 Currently used with `cperl-check-syntax' only."
574 :type 'string
575 :group 'cperl)
576
577 (defcustom cperl-message-electric-keyword t
578 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
579 :type 'boolean
580 :group 'cperl-help-system)
581
582 (defcustom cperl-indent-region-fix-constructs 1
583 "*Amount of space to insert between `}' and `else' or `elsif'
584 in `cperl-indent-region'. Set to nil to leave as is. Values other
585 than 1 and nil will probably not work."
586 :type '(choice (const nil) (const 1))
587 :group 'cperl-indentation-details)
588
589 (defcustom cperl-break-one-line-blocks-when-indent t
590 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
591 need to be reformatted into multiline ones when indenting a region."
592 :type 'boolean
593 :group 'cperl-indentation-details)
594
595 (defcustom cperl-fix-hanging-brace-when-indent t
596 "*Non-nil means that BLOCK-end `}' may be put on a separate line
597 when indenting a region.
598 Braces followed by else/elsif/while/until are excepted."
599 :type 'boolean
600 :group 'cperl-indentation-details)
601
602 (defcustom cperl-merge-trailing-else t
603 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
604 may be merged to be on the same line when indenting a region."
605 :type 'boolean
606 :group 'cperl-indentation-details)
607
608 (defcustom cperl-indent-parens-as-block nil
609 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
610 but for trailing \",\" inside the group, which won't increase indentation.
611 One should tune up `cperl-close-paren-offset' as well."
612 :type 'boolean
613 :group 'cperl-indentation-details)
614
615 (defcustom cperl-syntaxify-by-font-lock
616 (and cperl-can-font-lock
617 (boundp 'parse-sexp-lookup-properties))
618 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
619 :type '(choice (const message) boolean)
620 :group 'cperl-speed)
621
622 (defcustom cperl-syntaxify-unwind
623 t
624 "*Non-nil means that CPerl unwinds to a start of a long construction
625 when syntaxifying a chunk of buffer."
626 :type 'boolean
627 :group 'cperl-speed)
628
629 (defcustom cperl-syntaxify-for-menu
630 t
631 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
632 This way enabling/disabling of menu items is more correct."
633 :type 'boolean
634 :group 'cperl-speed)
635
636 (defcustom cperl-ps-print-face-properties
637 '((font-lock-keyword-face nil nil bold shadow)
638 (font-lock-variable-name-face nil nil bold)
639 (font-lock-function-name-face nil nil bold italic box)
640 (font-lock-constant-face nil "LightGray" bold)
641 (cperl-array-face nil "LightGray" bold underline)
642 (cperl-hash-face nil "LightGray" bold italic underline)
643 (font-lock-comment-face nil "LightGray" italic)
644 (font-lock-string-face nil nil italic underline)
645 (cperl-nonoverridable-face nil nil italic underline)
646 (font-lock-type-face nil nil underline)
647 (font-lock-warning-face nil "LightGray" bold italic box)
648 (underline nil "LightGray" strikeout))
649 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
650 :type '(repeat (cons symbol
651 (cons (choice (const nil) string)
652 (cons (choice (const nil) string)
653 (repeat symbol)))))
654 :group 'cperl-faces)
655
656 (defvar cperl-dark-background
657 (cperl-choose-color "navy" "os2blue" "darkgreen"))
658 (defvar cperl-dark-foreground
659 (cperl-choose-color "orchid1" "orange"))
660
661 (defface cperl-nonoverridable-face
662 `((((class grayscale) (background light))
663 (:background "Gray90" :slant italic :underline t))
664 (((class grayscale) (background dark))
665 (:foreground "Gray80" :slant italic :underline t :weight bold))
666 (((class color) (background light))
667 (:foreground "chartreuse3"))
668 (((class color) (background dark))
669 (:foreground ,cperl-dark-foreground))
670 (t (:weight bold :underline t)))
671 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
672 :group 'cperl-faces)
673
674 (defface cperl-array-face
675 `((((class grayscale) (background light))
676 (:background "Gray90" :weight bold))
677 (((class grayscale) (background dark))
678 (:foreground "Gray80" :weight bold))
679 (((class color) (background light))
680 (:foreground "Blue" :background "lightyellow2" :weight bold))
681 (((class color) (background dark))
682 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
683 (t (:weight bold)))
684 "Font Lock mode face used to highlight array names."
685 :group 'cperl-faces)
686
687 (defface cperl-hash-face
688 `((((class grayscale) (background light))
689 (:background "Gray90" :weight bold :slant italic))
690 (((class grayscale) (background dark))
691 (:foreground "Gray80" :weight bold :slant italic))
692 (((class color) (background light))
693 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
694 (((class color) (background dark))
695 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
696 (t (:weight bold :slant italic)))
697 "Font Lock mode face used to highlight hash names."
698 :group 'cperl-faces)
699
700 \f
701
702 ;;; Short extra-docs.
703
704 (defvar cperl-tips 'please-ignore-this-line
705 "Get maybe newer version of this package from
706 http://ilyaz.org/software/emacs
707 Subdirectory `cperl-mode' may contain yet newer development releases and/or
708 patches to related files.
709
710 For best results apply to an older Emacs the patches from
711 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
712 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
713 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
714 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
715
716 Get support packages choose-color.el (or font-lock-extra.el before
717 19.30), imenu-go.el from the same place. \(Look for other files there
718 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
719 later you should use choose-color.el *instead* of font-lock-extra.el
720 \(and you will not get smart highlighting in C :-().
721
722 Note that to enable Compile choices in the menu you need to install
723 mode-compile.el.
724
725 If your Emacs does not default to `cperl-mode' on Perl files, and you
726 want it to: put the following into your .emacs file:
727
728 (defalias 'perl-mode 'cperl-mode)
729
730 Get perl5-info from
731 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
732 Also, one can generate a newer documentation running `pod2texi' converter
733 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
734
735 If you use imenu-go, run imenu on perl5-info buffer (you can do it
736 from Perl menu). If many files are related, generate TAGS files from
737 Tools/Tags submenu in Perl menu.
738
739 If some class structure is too complicated, use Tools/Hierarchy-view
740 from Perl menu, or hierarchic view of imenu. The second one uses the
741 current buffer only, the first one requires generation of TAGS from
742 Perl/Tools/Tags menu beforehand.
743
744 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
745
746 Switch auto-help on/off with Perl/Tools/Auto-help.
747
748 Though with contemporary Emaxen CPerl mode should maintain the correct
749 parsing of Perl even when editing, sometimes it may be lost. Fix this by
750
751 \\[normal-mode]
752
753 In cases of more severe confusion sometimes it is helpful to do
754
755 \\[load-library] cperl-mode RET
756 \\[normal-mode]
757
758 Before reporting (non-)problems look in the problem section of online
759 micro-docs on what I know about CPerl problems.")
760
761 (defvar cperl-problems 'please-ignore-this-line
762 "Description of problems in CPerl mode.
763 Some faces will not be shown on some versions of Emacs unless you
764 install choose-color.el, available from
765 http://ilyaz.org/software/emacs
766
767 `fill-paragraph' on a comment may leave the point behind the
768 paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
769 to detect it and bulk out).
770
771 See documentation of a variable `cperl-problems-old-emaxen' for the
772 problems which disappear if you upgrade Emacs to a reasonably new
773 version (20.3 for Emacs, and those of 2004 for XEmacs).")
774
775 (defvar cperl-problems-old-emaxen 'please-ignore-this-line
776 "Description of problems in CPerl mode specific for older Emacs versions.
777
778 Emacs had a _very_ restricted syntax parsing engine until version
779 20.1. Most problems below are corrected starting from this version of
780 Emacs, and all of them should be fixed in version 20.3. (Or apply
781 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
782 this respect (until 2003).
783
784 Note that even with newer Emacsen in some very rare cases the details
785 of interaction of `font-lock' and syntaxification may be not cleaned
786 up yet. You may get slightly different colors basing on the order of
787 fontification and syntaxification. Say, the initial faces is correct,
788 but editing the buffer breaks this.
789
790 Even with older Emacsen CPerl mode tries to corrects some Emacs
791 misunderstandings, however, for efficiency reasons the degree of
792 correction is different for different operations. The partially
793 corrected problems are: POD sections, here-documents, regexps. The
794 operations are: highlighting, indentation, electric keywords, electric
795 braces.
796
797 This may be confusing, since the regexp s#//#/#\; may be highlighted
798 as a comment, but it will be recognized as a regexp by the indentation
799 code. Or the opposite case, when a POD section is highlighted, but
800 may break the indentation of the following code (though indentation
801 should work if the balance of delimiters is not broken by POD).
802
803 The main trick (to make $ a \"backslash\") makes constructions like
804 ${aaa} look like unbalanced braces. The only trick I can think of is
805 to insert it as $ {aaa} (valid in perl5, not in perl4).
806
807 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
808 as /($|\\s)/. Note that such a transposition is not always possible.
809
810 The solution is to upgrade your Emacs or patch an older one. Note
811 that Emacs 20.2 has some bugs related to `syntax-table' text
812 properties. Patches are available on the main CPerl download site,
813 and on CPAN.
814
815 If these bugs cannot be fixed on your machine (say, you have an inferior
816 environment and cannot recompile), you may still disable all the fancy stuff
817 via `cperl-use-syntax-table-text-property'.")
818
819 (defvar cperl-praise 'please-ignore-this-line
820 "Advantages of CPerl mode.
821
822 0) It uses the newest `syntax-table' property ;-);
823
824 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
825 mode - but the latter number may have improved too in last years) even
826 with old Emaxen which do not support `syntax-table' property.
827
828 When using `syntax-table' property for syntax assist hints, it should
829 handle 99.995% of lines correct - or somesuch. It automatically
830 updates syntax assist hints when you edit your script.
831
832 2) It is generally believed to be \"the most user-friendly Emacs
833 package\" whatever it may mean (I doubt that the people who say similar
834 things tried _all_ the rest of Emacs ;-), but this was not a lonely
835 voice);
836
837 3) Everything is customizable, one-by-one or in a big sweep;
838
839 4) It has many easily-accessible \"tools\":
840 a) Can run program, check syntax, start debugger;
841 b) Can lineup vertically \"middles\" of rows, like `=' in
842 a = b;
843 cc = d;
844 c) Can insert spaces where this impoves readability (in one
845 interactive sweep over the buffer);
846 d) Has support for imenu, including:
847 1) Separate unordered list of \"interesting places\";
848 2) Separate TOC of POD sections;
849 3) Separate list of packages;
850 4) Hierarchical view of methods in (sub)packages;
851 5) and functions (by the full name - with package);
852 e) Has an interface to INFO docs for Perl; The interface is
853 very flexible, including shrink-wrapping of
854 documentation buffer/frame;
855 f) Has a builtin list of one-line explanations for perl constructs.
856 g) Can show these explanations if you stay long enough at the
857 corresponding place (or on demand);
858 h) Has an enhanced fontification (using 3 or 4 additional faces
859 comparing to font-lock - basically, different
860 namespaces in Perl have different colors);
861 i) Can construct TAGS basing on its knowledge of Perl syntax,
862 the standard menu has 6 different way to generate
863 TAGS (if \"by directory\", .xs files - with C-language
864 bindings - are included in the scan);
865 j) Can build a hierarchical view of classes (via imenu) basing
866 on generated TAGS file;
867 k) Has electric parentheses, electric newlines, uses Abbrev
868 for electric logical constructs
869 while () {}
870 with different styles of expansion (context sensitive
871 to be not so bothering). Electric parentheses behave
872 \"as they should\" in a presence of a visible region.
873 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
874 m) Can convert from
875 if (A) { B }
876 to
877 B if A;
878
879 n) Highlights (by user-choice) either 3-delimiters constructs
880 (such as tr/a/b/), or regular expressions and `y/tr';
881 o) Highlights trailing whitespace;
882 p) Is able to manipulate Perl Regular Expressions to ease
883 conversion to a more readable form.
884 q) Can ispell POD sections and HERE-DOCs.
885 r) Understands comments and character classes inside regular
886 expressions; can find matching () and [] in a regular expression.
887 s) Allows indentation of //x-style regular expressions;
888 t) Highlights different symbols in regular expressions according
889 to their function; much less problems with backslashitis;
890 u) Allows to find regular expressions which contain interpolated parts.
891
892 5) The indentation engine was very smart, but most of tricks may be
893 not needed anymore with the support for `syntax-table' property. Has
894 progress indicator for indentation (with `imenu' loaded).
895
896 6) Indent-region improves inline-comments as well; also corrects
897 whitespace *inside* the conditional/loop constructs.
898
899 7) Fill-paragraph correctly handles multi-line comments;
900
901 8) Can switch to different indentation styles by one command, and restore
902 the settings present before the switch.
903
904 9) When doing indentation of control constructs, may correct
905 line-breaks/spacing between elements of the construct.
906
907 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
908 capable syntax engines).
909
910 11) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
911 ")
912
913 (defvar cperl-speed 'please-ignore-this-line
914 "This is an incomplete compendium of what is available in other parts
915 of CPerl documentation. (Please inform me if I skept anything.)
916
917 There is a perception that CPerl is slower than alternatives. This part
918 of documentation is designed to overcome this misconception.
919
920 *By default* CPerl tries to enable the most comfortable settings.
921 From most points of view, correctly working package is infinitely more
922 comfortable than a non-correctly working one, thus by default CPerl
923 prefers correctness over speed. Below is the guide how to change
924 settings if your preferences are different.
925
926 A) Speed of loading the file. When loading file, CPerl may perform a
927 scan which indicates places which cannot be parsed by primitive Emacs
928 syntax-parsing routines, and marks them up so that either
929
930 A1) CPerl may work around these deficiencies (for big chunks, mostly
931 PODs and HERE-documents), or
932 A2) On capable Emaxen CPerl will use improved syntax-handlings
933 which reads mark-up hints directly.
934
935 The scan in case A2 is much more comprehensive, thus may be slower.
936
937 User can disable syntax-engine-helping scan of A2 by setting
938 `cperl-use-syntax-table-text-property'
939 variable to nil (if it is set to t).
940
941 One can disable the scan altogether (both A1 and A2) by setting
942 `cperl-pod-here-scan'
943 to nil.
944
945 B) Speed of editing operations.
946
947 One can add a (minor) speedup to editing operations by setting
948 `cperl-use-syntax-table-text-property'
949 variable to nil (if it is set to t). This will disable
950 syntax-engine-helping scan, thus will make many more Perl
951 constructs be wrongly recognized by CPerl, thus may lead to
952 wrongly matched parentheses, wrong indentation, etc.
953
954 One can unset `cperl-syntaxify-unwind'. This might speed up editing
955 of, say, long POD sections.")
956
957 (defvar cperl-tips-faces 'please-ignore-this-line
958 "CPerl mode uses following faces for highlighting:
959
960 `cperl-array-face' Array names
961 `cperl-hash-face' Hash names
962 `font-lock-comment-face' Comments, PODs and whatever is considered
963 syntaxically to be not code
964 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
965 2-arg operators s/y/tr/ or of RExen,
966 `font-lock-warning-face' Special-cased m// and s//foo/,
967 `font-lock-function-name-face' _ as a target of a file tests, file tests,
968 subroutine names at the moment of definition
969 (except those conflicting with Perl operators),
970 package names (when recognized), format names
971 `font-lock-keyword-face' Control flow switch constructs, declarators
972 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
973 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
974 literal parts and the terminator of formats
975 and whatever is syntaxically considered
976 as string literals
977 `font-lock-type-face' Overridable keywords
978 `font-lock-variable-name-face' Variable declarations, indirect array and
979 hash names, POD headers/item names
980 `cperl-invalid-face' Trailing whitespace
981
982 Note that in several situations the highlighting tries to inform about
983 possible confusion, such as different colors for function names in
984 declarations depending on what they (do not) override, or special cases
985 m// and s/// which do not do what one would expect them to do.
986
987 Help with best setup of these faces for printout requested (for each of
988 the faces: please specify bold, italic, underline, shadow and box.)
989
990 In regular expressions (including character classes):
991 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
992 `font-lock-constant-face': Delimiters
993 `font-lock-warning-face' Special-cased m// and s//foo/,
994 Mismatched closing delimiters, parens
995 we couldn't match, misplaced quantifiers,
996 unrecognized escape sequences
997 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
998 `font-lock-type-face' escape sequences with arguments (\\x \\23 \\p \\N)
999 and others match-a-char escape sequences
1000 `font-lock-keyword-face' Capturing parens, and |
1001 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
1002 \"Range -\" in character classes
1003 `font-lock-builtin-face' \"Remaining\" 0-length constructs, multipliers
1004 ?+*{}, not-capturing parens, leading
1005 backslashes of escape sequences
1006 `font-lock-variable-name-face' Interpolated constructs, embedded code,
1007 POSIX classes (inside charclasses)
1008 `font-lock-comment-face' Embedded comments
1009
1010 ")
1011
1012 \f
1013
1014 ;;; Portability stuff:
1015
1016 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
1017 `(define-key cperl-mode-map
1018 ,(if xemacs-key
1019 `(if (featurep 'xemacs) ,xemacs-key ,emacs-key)
1020 emacs-key)
1021 ,definition))
1022
1023 (defvar cperl-del-back-ch
1024 (car (append (where-is-internal 'delete-backward-char)
1025 (where-is-internal 'backward-delete-char-untabify)))
1026 "Character generated by key bound to `delete-backward-char'.")
1027
1028 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
1029 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
1030
1031 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
1032 (if (featurep 'xemacs)
1033 (progn
1034 ;; "Active regions" are on: use region only if active
1035 ;; "Active regions" are off: use region unconditionally
1036 (defun cperl-use-region-p ()
1037 (if zmacs-regions (mark) t)))
1038 (defun cperl-use-region-p ()
1039 (if transient-mark-mode mark-active t))
1040 (defun cperl-mark-active () mark-active))
1041
1042 (defsubst cperl-enable-font-lock ()
1043 cperl-can-font-lock)
1044
1045 (defun cperl-putback-char (c) ; Emacs 19
1046 (set 'unread-command-events (list c))) ; Avoid undefined warning
1047
1048 (if (featurep 'xemacs)
1049 (defun cperl-putback-char (c) ; XEmacs >= 19.12
1050 (setq unread-command-events (list (eval '(character-to-event c))))))
1051
1052 (or (fboundp 'uncomment-region)
1053 (defun uncomment-region (beg end)
1054 (interactive "r")
1055 (comment-region beg end -1)))
1056
1057 (defvar cperl-do-not-fontify
1058 (if (string< emacs-version "19.30")
1059 'fontified
1060 'lazy-lock)
1061 "Text property which inhibits refontification.")
1062
1063 (defsubst cperl-put-do-not-fontify (from to &optional post)
1064 ;; If POST, do not do it with postponed fontification
1065 (if (and post cperl-syntaxify-by-font-lock)
1066 nil
1067 (put-text-property (max (point-min) (1- from))
1068 to cperl-do-not-fontify t)))
1069
1070 (defcustom cperl-mode-hook nil
1071 "Hook run by CPerl mode."
1072 :type 'hook
1073 :group 'cperl)
1074
1075 (defvar cperl-syntax-state nil)
1076 (defvar cperl-syntax-done-to nil)
1077 (defvar cperl-emacs-can-parse (> (length (save-excursion
1078 (parse-partial-sexp (point) (point)))) 9))
1079 \f
1080 ;; Make customization possible "in reverse"
1081 (defsubst cperl-val (symbol &optional default hairy)
1082 (cond
1083 ((eq (symbol-value symbol) 'null) default)
1084 (cperl-hairy (or hairy t))
1085 (t (symbol-value symbol))))
1086 \f
1087
1088 (defun cperl-make-indent (column &optional minimum keep)
1089 "Makes indent of the current line the requested amount.
1090 Unless KEEP, removes the old indentation. Works around a bug in ancient
1091 versions of Emacs."
1092 (let ((prop (get-text-property (point) 'syntax-type)))
1093 (or keep
1094 (delete-horizontal-space))
1095 (indent-to column minimum)
1096 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1097 (and prop
1098 (> (current-column) 0)
1099 (save-excursion
1100 (beginning-of-line)
1101 (or (get-text-property (point) 'syntax-type)
1102 (and (looking-at "\\=[ \t]")
1103 (put-text-property (point) (match-end 0)
1104 'syntax-type prop)))))))
1105
1106 ;;; Probably it is too late to set these guys already, but it can help later:
1107
1108 ;;;(and cperl-clobber-mode-lists
1109 ;;;(setq auto-mode-alist
1110 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1111 ;;;(and (boundp 'interpreter-mode-alist)
1112 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
1113 ;;; '(("miniperl" . perl-mode))))))
1114 (eval-when-compile
1115 (mapc (lambda (p)
1116 (condition-case nil
1117 (require p)
1118 (error nil)))
1119 '(imenu easymenu etags timer man info))
1120 (if (fboundp 'ps-extend-face-list)
1121 (defmacro cperl-ps-extend-face-list (arg)
1122 `(ps-extend-face-list ,arg))
1123 (defmacro cperl-ps-extend-face-list (arg)
1124 `(error "This version of Emacs has no `ps-extend-face-list'")))
1125 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1126 ;; macros instead of defsubsts don't work on Emacs, so we do the
1127 ;; expansion manually. Any other suggestions?
1128 (require 'cl))
1129
1130 (defvar cperl-mode-abbrev-table nil
1131 "Abbrev table in use in CPerl mode buffers.")
1132
1133 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1134
1135 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
1136
1137 (if cperl-mode-map nil
1138 (setq cperl-mode-map (make-sparse-keymap))
1139 (cperl-define-key "{" 'cperl-electric-lbrace)
1140 (cperl-define-key "[" 'cperl-electric-paren)
1141 (cperl-define-key "(" 'cperl-electric-paren)
1142 (cperl-define-key "<" 'cperl-electric-paren)
1143 (cperl-define-key "}" 'cperl-electric-brace)
1144 (cperl-define-key "]" 'cperl-electric-rparen)
1145 (cperl-define-key ")" 'cperl-electric-rparen)
1146 (cperl-define-key ";" 'cperl-electric-semi)
1147 (cperl-define-key ":" 'cperl-electric-terminator)
1148 (cperl-define-key "\C-j" 'newline-and-indent)
1149 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
1150 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
1151 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1152 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
1153 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1154 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
1155 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
1156 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
1157 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
1158 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
1159 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
1160 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx)
1161 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0)
1162 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1)
1163 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
1164 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
1165 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
1166 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1167 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1168 [(control meta |)])
1169 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1170 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1171 (cperl-define-key "\177" 'cperl-electric-backspace)
1172 (cperl-define-key "\t" 'cperl-indent-command)
1173 ;; don't clobber the backspace binding:
1174 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1175 [(control c) (control h) F])
1176 (if (cperl-val 'cperl-clobber-lisp-bindings)
1177 (progn
1178 (cperl-define-key "\C-hf"
1179 ;;(concat (char-to-string help-char) "f") ; does not work
1180 'cperl-info-on-command
1181 [(control h) f])
1182 (cperl-define-key "\C-hv"
1183 ;;(concat (char-to-string help-char) "v") ; does not work
1184 'cperl-get-help
1185 [(control h) v])
1186 (cperl-define-key "\C-c\C-hf"
1187 ;;(concat (char-to-string help-char) "f") ; does not work
1188 (key-binding "\C-hf")
1189 [(control c) (control h) f])
1190 (cperl-define-key "\C-c\C-hv"
1191 ;;(concat (char-to-string help-char) "v") ; does not work
1192 (key-binding "\C-hv")
1193 [(control c) (control h) v]))
1194 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1195 [(control c) (control h) f])
1196 (cperl-define-key "\C-c\C-hv"
1197 ;;(concat (char-to-string help-char) "v") ; does not work
1198 'cperl-get-help
1199 [(control c) (control h) v]))
1200 (if (and (featurep 'xemacs)
1201 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1202 (progn
1203 ;; substitute-key-definition is usefulness-deenhanced...
1204 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1205 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1206 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1207 (or (boundp 'fill-paragraph-function)
1208 (substitute-key-definition
1209 'fill-paragraph 'cperl-fill-paragraph
1210 cperl-mode-map global-map))
1211 (substitute-key-definition
1212 'indent-sexp 'cperl-indent-exp
1213 cperl-mode-map global-map)
1214 (substitute-key-definition
1215 'indent-region 'cperl-indent-region
1216 cperl-mode-map global-map)
1217 (substitute-key-definition
1218 'indent-for-comment 'cperl-indent-for-comment
1219 cperl-mode-map global-map)))
1220
1221 (defvar cperl-menu)
1222 (defvar cperl-lazy-installed)
1223 (defvar cperl-old-style nil)
1224 (condition-case nil
1225 (progn
1226 (require 'easymenu)
1227 (easy-menu-define
1228 cperl-menu cperl-mode-map "Menu for CPerl mode"
1229 '("Perl"
1230 ["Beginning of function" beginning-of-defun t]
1231 ["End of function" end-of-defun t]
1232 ["Mark function" mark-defun t]
1233 ["Indent expression" cperl-indent-exp t]
1234 ["Fill paragraph/comment" fill-paragraph t]
1235 "----"
1236 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1237 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1238 ("Regexp"
1239 ["Beautify" cperl-beautify-regexp
1240 cperl-use-syntax-table-text-property]
1241 ["Beautify one level deep" (cperl-beautify-regexp 1)
1242 cperl-use-syntax-table-text-property]
1243 ["Beautify a group" cperl-beautify-level
1244 cperl-use-syntax-table-text-property]
1245 ["Beautify a group one level deep" (cperl-beautify-level 1)
1246 cperl-use-syntax-table-text-property]
1247 ["Contract a group" cperl-contract-level
1248 cperl-use-syntax-table-text-property]
1249 ["Contract groups" cperl-contract-levels
1250 cperl-use-syntax-table-text-property]
1251 "----"
1252 ["Find next interpolated" cperl-next-interpolated-REx
1253 (next-single-property-change (point-min) 'REx-interpolated)]
1254 ["Find next interpolated (no //o)"
1255 cperl-next-interpolated-REx-0
1256 (or (text-property-any (point-min) (point-max) 'REx-interpolated t)
1257 (text-property-any (point-min) (point-max) 'REx-interpolated 1))]
1258 ["Find next interpolated (neither //o nor whole-REx)"
1259 cperl-next-interpolated-REx-1
1260 (text-property-any (point-min) (point-max) 'REx-interpolated t)])
1261 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
1262 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1263 "----"
1264 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1265 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1266 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1267 "----"
1268 ["Run" mode-compile (fboundp 'mode-compile)]
1269 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1270 (get-buffer "*compilation*"))]
1271 ["Next error" next-error (get-buffer "*compilation*")]
1272 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1273 "----"
1274 ["Debugger" cperl-db t]
1275 "----"
1276 ("Tools"
1277 ["Imenu" imenu (fboundp 'imenu)]
1278 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
1279 "----"
1280 ["Ispell PODs" cperl-pod-spell
1281 ;; Better not to update syntaxification here:
1282 ;; debugging syntaxificatio can be broken by this???
1283 (or
1284 (get-text-property (point-min) 'in-pod)
1285 (< (progn
1286 (and cperl-syntaxify-for-menu
1287 (cperl-update-syntaxification (point-max) (point-max)))
1288 (next-single-property-change (point-min) 'in-pod nil (point-max)))
1289 (point-max)))]
1290 ["Ispell HERE-DOCs" cperl-here-doc-spell
1291 (< (progn
1292 (and cperl-syntaxify-for-menu
1293 (cperl-update-syntaxification (point-max) (point-max)))
1294 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
1295 (point-max))]
1296 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
1297 (eq 'here-doc (progn
1298 (and cperl-syntaxify-for-menu
1299 (cperl-update-syntaxification (point) (point)))
1300 (get-text-property (point) 'syntax-type)))]
1301 ["Select this HERE-DOC or POD section"
1302 cperl-select-this-pod-or-here-doc
1303 (memq (progn
1304 (and cperl-syntaxify-for-menu
1305 (cperl-update-syntaxification (point) (point)))
1306 (get-text-property (point) 'syntax-type))
1307 '(here-doc pod))]
1308 "----"
1309 ["CPerl pretty print (exprmntl)" cperl-ps-print
1310 (fboundp 'ps-extend-face-list)]
1311 "----"
1312 ["Syntaxify region" cperl-find-pods-heres-region
1313 (cperl-use-region-p)]
1314 ["Profile syntaxification" cperl-time-fontification t]
1315 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
1316 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
1317 ["Debug backtrace on syntactic scan (BEWARE!!!)"
1318 (cperl-toggle-set-debug-unwind nil t) t]
1319 "----"
1320 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1321 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1322 ("Tags"
1323 ;;; ["Create tags for current file" cperl-etags t]
1324 ;;; ["Add tags for current file" (cperl-etags t) t]
1325 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1326 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1327 ;;; ["Create tags for Perl files in (sub)directories"
1328 ;;; (cperl-etags nil 'recursive) t]
1329 ;;; ["Add tags for Perl files in (sub)directories"
1330 ;;; (cperl-etags t 'recursive) t])
1331 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1332 ["Create tags for current file" (cperl-write-tags nil t) t]
1333 ["Add tags for current file" (cperl-write-tags) t]
1334 ["Create tags for Perl files in directory"
1335 (cperl-write-tags nil t nil t) t]
1336 ["Add tags for Perl files in directory"
1337 (cperl-write-tags nil nil nil t) t]
1338 ["Create tags for Perl files in (sub)directories"
1339 (cperl-write-tags nil t t t) t]
1340 ["Add tags for Perl files in (sub)directories"
1341 (cperl-write-tags nil nil t t) t]))
1342 ("Perl docs"
1343 ["Define word at point" imenu-go-find-at-position
1344 (fboundp 'imenu-go-find-at-position)]
1345 ["Help on function" cperl-info-on-command t]
1346 ["Help on function at point" cperl-info-on-current-command t]
1347 ["Help on symbol at point" cperl-get-help t]
1348 ["Perldoc" cperl-perldoc t]
1349 ["Perldoc on word at point" cperl-perldoc-at-point t]
1350 ["View manpage of POD in this file" cperl-build-manpage t]
1351 ["Auto-help on" cperl-lazy-install
1352 (and (fboundp 'run-with-idle-timer)
1353 (not cperl-lazy-installed))]
1354 ["Auto-help off" cperl-lazy-unstall
1355 (and (fboundp 'run-with-idle-timer)
1356 cperl-lazy-installed)])
1357 ("Toggle..."
1358 ["Auto newline" cperl-toggle-auto-newline t]
1359 ["Electric parens" cperl-toggle-electric t]
1360 ["Electric keywords" cperl-toggle-abbrev t]
1361 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1362 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
1363 ["Auto fill" auto-fill-mode t])
1364 ("Indent styles..."
1365 ["CPerl" (cperl-set-style "CPerl") t]
1366 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1367 ["GNU" (cperl-set-style "GNU") t]
1368 ["C++" (cperl-set-style "C++") t]
1369 ["K&R" (cperl-set-style "K&R") t]
1370 ["BSD" (cperl-set-style "BSD") t]
1371 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1372 ["Memorize Current" (cperl-set-style "Current") t]
1373 ["Memorized" (cperl-set-style-back) cperl-old-style])
1374 ("Micro-docs"
1375 ["Tips" (describe-variable 'cperl-tips) t]
1376 ["Problems" (describe-variable 'cperl-problems) t]
1377 ["Speed" (describe-variable 'cperl-speed) t]
1378 ["Praise" (describe-variable 'cperl-praise) t]
1379 ["Faces" (describe-variable 'cperl-tips-faces) t]
1380 ["CPerl mode" (describe-function 'cperl-mode) t]
1381 ["CPerl version"
1382 (message "The version of master-file for this CPerl is %s-Emacs"
1383 cperl-version) t]))))
1384 (error nil))
1385
1386 (autoload 'c-macro-expand "cmacexp"
1387 "Display the result of expanding all C macros occurring in the region.
1388 The expansion is entirely correct because it uses the C preprocessor."
1389 t)
1390
1391 ;;; These two must be unwound, otherwise take exponential time
1392 (defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
1393 "Regular expression to match optional whitespace with interpspersed comments.
1394 Should contain exactly one group.")
1395
1396 ;;; This one is tricky to unwind; still very inefficient...
1397 (defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
1398 "Regular expression to match whitespace with interpspersed comments.
1399 Should contain exactly one group.")
1400
1401
1402 ;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1403 ;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1404 ;;; Details of groups in this may be used in several functions; see comments
1405 ;;; near mentioned above variable(s)...
1406 ;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1407 (defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
1408 "Match the text after `sub' in a subroutine declaration.
1409 If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
1410 of attributes (if present), or end of the name or prototype (whatever is
1411 the last)."
1412 (concat ; Assume n groups before this...
1413 "\\(" ; n+1=name-group
1414 cperl-white-and-comment-rex ; n+2=pre-name
1415 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
1416 "\\)" ; END n+1=name-group
1417 (if named "" "?")
1418 "\\(" ; n+4=proto-group
1419 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
1420 "\\(([^()]*)\\)" ; n+6=prototype
1421 "\\)?" ; END n+4=proto-group
1422 "\\(" ; n+7=attr-group
1423 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
1424 "\\(" ; n+9=start-attr
1425 ":"
1426 (if attr (concat
1427 "\\("
1428 cperl-maybe-white-and-comment-rex ; whitespace-comments
1429 "\\(\\sw\\|_\\)+" ; attr-name
1430 ;; attr-arg (1 level of internal parens allowed!)
1431 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
1432 "\\(" ; optional : (XXX allows trailing???)
1433 cperl-maybe-white-and-comment-rex ; whitespace-comments
1434 ":\\)?"
1435 "\\)+")
1436 "[^:]")
1437 "\\)"
1438 "\\)?" ; END n+6=proto-group
1439 ))
1440
1441 ;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1442 ;;; and `cperl-outline-level'.
1443 ;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
1444 (defvar cperl-imenu--function-name-regexp-perl
1445 (concat
1446 "^\\(" ; 1 = all
1447 "\\([ \t]*package" ; 2 = package-group
1448 "\\(" ; 3 = package-name-group
1449 cperl-white-and-comment-rex ; 4 = pre-package-name
1450 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
1451 "\\|"
1452 "[ \t]*sub"
1453 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1454 cperl-maybe-white-and-comment-rex ; 15=pre-block
1455 "\\|"
1456 "=head\\([1-4]\\)[ \t]+" ; 16=level
1457 "\\([^\n]+\\)$" ; 17=text
1458 "\\)"))
1459
1460 (defvar cperl-outline-regexp
1461 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1462
1463 (defvar cperl-mode-syntax-table nil
1464 "Syntax table in use in CPerl mode buffers.")
1465
1466 (defvar cperl-string-syntax-table nil
1467 "Syntax table in use in CPerl mode string-like chunks.")
1468
1469 (defsubst cperl-1- (p)
1470 (max (point-min) (1- p)))
1471
1472 (defsubst cperl-1+ (p)
1473 (min (point-max) (1+ p)))
1474
1475 (if cperl-mode-syntax-table
1476 ()
1477 (setq cperl-mode-syntax-table (make-syntax-table))
1478 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1479 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1480 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1481 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1482 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1483 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1484 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1485 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1486 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1487 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1488 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1489 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
1490 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1491 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1492 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1493 (if cperl-under-as-char
1494 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1495 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1496 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1497 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1498 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
1499 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
1500 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
1501 (modify-syntax-entry ?\" "." cperl-string-syntax-table)
1502 (modify-syntax-entry ?' "." cperl-string-syntax-table)
1503 (modify-syntax-entry ?` "." cperl-string-syntax-table)
1504 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
1505
1506
1507 \f
1508 (defvar cperl-faces-init nil)
1509 ;; Fix for msb.el
1510 (defvar cperl-msb-fixed nil)
1511 (defvar cperl-use-major-mode 'cperl-mode)
1512 (defvar cperl-font-lock-multiline-start nil)
1513 (defvar cperl-font-lock-multiline nil)
1514 (defvar cperl-font-locking nil)
1515
1516 ;; NB as it stands the code in cperl-mode assumes this only has one
1517 ;; element. If Xemacs 19 support were dropped, this could all be simplified.
1518 (defvar cperl-compilation-error-regexp-alist
1519 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1520 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
1521 2 3))
1522 "Alist that specifies how to match errors in perl output.")
1523
1524 (defvar compilation-error-regexp-alist)
1525
1526 ;;;###autoload
1527 (defun cperl-mode ()
1528 "Major mode for editing Perl code.
1529 Expression and list commands understand all C brackets.
1530 Tab indents for Perl code.
1531 Paragraphs are separated by blank lines only.
1532 Delete converts tabs to spaces as it moves back.
1533
1534 Various characters in Perl almost always come in pairs: {}, (), [],
1535 sometimes <>. When the user types the first, she gets the second as
1536 well, with optional special formatting done on {}. (Disabled by
1537 default.) You can always quote (with \\[quoted-insert]) the left
1538 \"paren\" to avoid the expansion. The processing of < is special,
1539 since most the time you mean \"less\". CPerl mode tries to guess
1540 whether you want to type pair <>, and inserts is if it
1541 appropriate. You can set `cperl-electric-parens-string' to the string that
1542 contains the parenths from the above list you want to be electrical.
1543 Electricity of parenths is controlled by `cperl-electric-parens'.
1544 You may also set `cperl-electric-parens-mark' to have electric parens
1545 look for active mark and \"embrace\" a region if possible.'
1546
1547 CPerl mode provides expansion of the Perl control constructs:
1548
1549 if, else, elsif, unless, while, until, continue, do,
1550 for, foreach, formy and foreachmy.
1551
1552 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1553
1554 The user types the keyword immediately followed by a space, which
1555 causes the construct to be expanded, and the point is positioned where
1556 she is most likely to want to be. eg. when the user types a space
1557 following \"if\" the following appears in the buffer: if () { or if ()
1558 } { } and the cursor is between the parentheses. The user can then
1559 type some boolean expression within the parens. Having done that,
1560 typing \\[cperl-linefeed] places you - appropriately indented - on a
1561 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1562 directive line, then appropriate number of new lines is inserted).
1563
1564 If CPerl decides that you want to insert \"English\" style construct like
1565
1566 bite if angry;
1567
1568 it will not do any expansion. See also help on variable
1569 `cperl-extra-newline-before-brace'. (Note that one can switch the
1570 help message on expansion by setting `cperl-message-electric-keyword'
1571 to nil.)
1572
1573 \\[cperl-linefeed] is a convenience replacement for typing carriage
1574 return. It places you in the next line with proper indentation, or if
1575 you type it inside the inline block of control construct, like
1576
1577 foreach (@lines) {print; print}
1578
1579 and you are on a boundary of a statement inside braces, it will
1580 transform the construct into a multiline and will place you into an
1581 appropriately indented blank line. If you need a usual
1582 `newline-and-indent' behavior, it is on \\[newline-and-indent],
1583 see documentation on `cperl-electric-linefeed'.
1584
1585 Use \\[cperl-invert-if-unless] to change a construction of the form
1586
1587 if (A) { B }
1588
1589 into
1590
1591 B if A;
1592
1593 \\{cperl-mode-map}
1594
1595 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1596 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1597 on electric space between $ and {, `cperl-electric-parens-string' is
1598 the string that contains parentheses that should be electric in CPerl
1599 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1600 setting `cperl-electric-keywords' enables electric expansion of
1601 control structures in CPerl. `cperl-electric-linefeed' governs which
1602 one of two linefeed behavior is preferable. You can enable all these
1603 options simultaneously (recommended mode of use) by setting
1604 `cperl-hairy' to t. In this case you can switch separate options off
1605 by setting them to `null'. Note that one may undo the extra
1606 whitespace inserted by semis and braces in `auto-newline'-mode by
1607 consequent \\[cperl-electric-backspace].
1608
1609 If your site has perl5 documentation in info format, you can use commands
1610 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1611 These keys run commands `cperl-info-on-current-command' and
1612 `cperl-info-on-command', which one is which is controlled by variable
1613 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1614 \(in turn affected by `cperl-hairy').
1615
1616 Even if you have no info-format documentation, short one-liner-style
1617 help is available on \\[cperl-get-help], and one can run perldoc or
1618 man via menu.
1619
1620 It is possible to show this help automatically after some idle time.
1621 This is regulated by variable `cperl-lazy-help-time'. Default with
1622 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1623 secs idle time . It is also possible to switch this on/off from the
1624 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1625
1626 Use \\[cperl-lineup] to vertically lineup some construction - put the
1627 beginning of the region at the start of construction, and make region
1628 span the needed amount of lines.
1629
1630 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1631 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1632 here-docs sections. With capable Emaxen results of scan are used
1633 for indentation too, otherwise they are used for highlighting only.
1634
1635 Variables controlling indentation style:
1636 `cperl-tab-always-indent'
1637 Non-nil means TAB in CPerl mode should always reindent the current line,
1638 regardless of where in the line point is when the TAB command is used.
1639 `cperl-indent-left-aligned-comments'
1640 Non-nil means that the comment starting in leftmost column should indent.
1641 `cperl-auto-newline'
1642 Non-nil means automatically newline before and after braces,
1643 and after colons and semicolons, inserted in Perl code. The following
1644 \\[cperl-electric-backspace] will remove the inserted whitespace.
1645 Insertion after colons requires both this variable and
1646 `cperl-auto-newline-after-colon' set.
1647 `cperl-auto-newline-after-colon'
1648 Non-nil means automatically newline even after colons.
1649 Subject to `cperl-auto-newline' setting.
1650 `cperl-indent-level'
1651 Indentation of Perl statements within surrounding block.
1652 The surrounding block's indentation is the indentation
1653 of the line on which the open-brace appears.
1654 `cperl-continued-statement-offset'
1655 Extra indentation given to a substatement, such as the
1656 then-clause of an if, or body of a while, or just a statement continuation.
1657 `cperl-continued-brace-offset'
1658 Extra indentation given to a brace that starts a substatement.
1659 This is in addition to `cperl-continued-statement-offset'.
1660 `cperl-brace-offset'
1661 Extra indentation for line if it starts with an open brace.
1662 `cperl-brace-imaginary-offset'
1663 An open brace following other text is treated as if it the line started
1664 this far to the right of the actual line indentation.
1665 `cperl-label-offset'
1666 Extra indentation for line that is a label.
1667 `cperl-min-label-indent'
1668 Minimal indentation for line that is a label.
1669
1670 Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1671 `cperl-indent-level' 5 4 2 4
1672 `cperl-brace-offset' 0 0 0 0
1673 `cperl-continued-brace-offset' -5 -4 0 0
1674 `cperl-label-offset' -5 -4 -2 -4
1675 `cperl-continued-statement-offset' 5 4 2 4
1676
1677 CPerl knows several indentation styles, and may bulk set the
1678 corresponding variables. Use \\[cperl-set-style] to do this. Use
1679 \\[cperl-set-style-back] to restore the memorized preexisting values
1680 \(both available from menu). See examples in `cperl-style-examples'.
1681
1682 Part of the indentation style is how different parts of if/elsif/else
1683 statements are broken into lines; in CPerl, this is reflected on how
1684 templates for these constructs are created (controlled by
1685 `cperl-extra-newline-before-brace'), and how reflow-logic should treat
1686 \"continuation\" blocks of else/elsif/continue, controlled by the same
1687 variable, and by `cperl-extra-newline-before-brace-multiline',
1688 `cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
1689
1690 If `cperl-indent-level' is 0, the statement after opening brace in
1691 column 0 is indented on
1692 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1693
1694 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1695 with no args.
1696
1697 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1698 or as help on variables `cperl-tips', `cperl-problems',
1699 `cperl-praise', `cperl-speed'."
1700 (interactive)
1701 (kill-all-local-variables)
1702 (use-local-map cperl-mode-map)
1703 (if (cperl-val 'cperl-electric-linefeed)
1704 (progn
1705 (local-set-key "\C-J" 'cperl-linefeed)
1706 (local-set-key "\C-C\C-J" 'newline-and-indent)))
1707 (if (and
1708 (cperl-val 'cperl-clobber-lisp-bindings)
1709 (cperl-val 'cperl-info-on-command-no-prompt))
1710 (progn
1711 ;; don't clobber the backspace binding:
1712 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1713 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1714 [(control c) (control h) f])))
1715 (setq major-mode cperl-use-major-mode)
1716 (setq mode-name "CPerl")
1717 (let ((prev-a-c abbrevs-changed))
1718 (define-abbrev-table 'cperl-mode-abbrev-table '(
1719 ("if" "if" cperl-electric-keyword 0)
1720 ("elsif" "elsif" cperl-electric-keyword 0)
1721 ("while" "while" cperl-electric-keyword 0)
1722 ("until" "until" cperl-electric-keyword 0)
1723 ("unless" "unless" cperl-electric-keyword 0)
1724 ("else" "else" cperl-electric-else 0)
1725 ("continue" "continue" cperl-electric-else 0)
1726 ("for" "for" cperl-electric-keyword 0)
1727 ("foreach" "foreach" cperl-electric-keyword 0)
1728 ("formy" "formy" cperl-electric-keyword 0)
1729 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1730 ("do" "do" cperl-electric-keyword 0)
1731 ("=pod" "=pod" cperl-electric-pod 0)
1732 ("=over" "=over" cperl-electric-pod 0)
1733 ("=head1" "=head1" cperl-electric-pod 0)
1734 ("=head2" "=head2" cperl-electric-pod 0)
1735 ("pod" "pod" cperl-electric-pod 0)
1736 ("over" "over" cperl-electric-pod 0)
1737 ("head1" "head1" cperl-electric-pod 0)
1738 ("head2" "head2" cperl-electric-pod 0)))
1739 (setq abbrevs-changed prev-a-c))
1740 (setq local-abbrev-table cperl-mode-abbrev-table)
1741 (if (cperl-val 'cperl-electric-keywords)
1742 (abbrev-mode 1))
1743 (set-syntax-table cperl-mode-syntax-table)
1744 ;; Until Emacs is multi-threaded, we do not actually need it local:
1745 (make-local-variable 'cperl-font-lock-multiline-start)
1746 (make-local-variable 'cperl-font-locking)
1747 (make-local-variable 'outline-regexp)
1748 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1749 (setq outline-regexp cperl-outline-regexp)
1750 (make-local-variable 'outline-level)
1751 (setq outline-level 'cperl-outline-level)
1752 (make-local-variable 'paragraph-start)
1753 (setq paragraph-start (concat "^$\\|" page-delimiter))
1754 (make-local-variable 'paragraph-separate)
1755 (setq paragraph-separate paragraph-start)
1756 (make-local-variable 'paragraph-ignore-fill-prefix)
1757 (setq paragraph-ignore-fill-prefix t)
1758 (if (featurep 'xemacs)
1759 (progn
1760 (make-local-variable 'paren-backwards-message)
1761 (set 'paren-backwards-message t)))
1762 (make-local-variable 'indent-line-function)
1763 (setq indent-line-function 'cperl-indent-line)
1764 (make-local-variable 'require-final-newline)
1765 (setq require-final-newline mode-require-final-newline)
1766 (make-local-variable 'comment-start)
1767 (setq comment-start "# ")
1768 (make-local-variable 'comment-end)
1769 (setq comment-end "")
1770 (make-local-variable 'comment-column)
1771 (setq comment-column cperl-comment-column)
1772 (make-local-variable 'comment-start-skip)
1773 (setq comment-start-skip "#+ *")
1774 (make-local-variable 'defun-prompt-regexp)
1775 ;;; "[ \t]*sub"
1776 ;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1777 ;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1778 (setq defun-prompt-regexp
1779 (concat "^[ \t]*\\(sub"
1780 (cperl-after-sub-regexp 'named 'attr-groups)
1781 "\\|" ; per toke.c
1782 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
1783 "\\)"
1784 cperl-maybe-white-and-comment-rex))
1785 (make-local-variable 'comment-indent-function)
1786 (setq comment-indent-function 'cperl-comment-indent)
1787 (and (boundp 'fill-paragraph-function)
1788 (progn
1789 (make-local-variable 'fill-paragraph-function)
1790 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
1791 (make-local-variable 'parse-sexp-ignore-comments)
1792 (setq parse-sexp-ignore-comments t)
1793 (make-local-variable 'indent-region-function)
1794 (setq indent-region-function 'cperl-indent-region)
1795 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1796 (make-local-variable 'imenu-create-index-function)
1797 (setq imenu-create-index-function
1798 (function cperl-imenu--create-perl-index))
1799 (make-local-variable 'imenu-sort-function)
1800 (setq imenu-sort-function nil)
1801 (make-local-variable 'vc-rcs-header)
1802 (set 'vc-rcs-header cperl-vc-rcs-header)
1803 (make-local-variable 'vc-sccs-header)
1804 (set 'vc-sccs-header cperl-vc-sccs-header)
1805 ;; This one is obsolete...
1806 (make-local-variable 'vc-header-alist)
1807 (with-no-warnings
1808 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
1809 `((SCCS ,(car cperl-vc-sccs-header))
1810 (RCS ,(car cperl-vc-rcs-header)))))
1811 )
1812 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
1813 (make-local-variable 'compilation-error-regexp-alist-alist)
1814 (set 'compilation-error-regexp-alist-alist
1815 (cons (cons 'cperl (car cperl-compilation-error-regexp-alist))
1816 (symbol-value 'compilation-error-regexp-alist-alist)))
1817 (if (fboundp 'compilation-build-compilation-error-regexp-alist)
1818 (let ((f 'compilation-build-compilation-error-regexp-alist))
1819 (funcall f))
1820 (make-local-variable 'compilation-error-regexp-alist)
1821 (push 'cperl compilation-error-regexp-alist)))
1822 ((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
1823 (make-local-variable 'compilation-error-regexp-alist)
1824 (set 'compilation-error-regexp-alist
1825 (append cperl-compilation-error-regexp-alist
1826 (symbol-value 'compilation-error-regexp-alist)))))
1827 (make-local-variable 'font-lock-defaults)
1828 (setq font-lock-defaults
1829 (cond
1830 ((string< emacs-version "19.30")
1831 '(cperl-font-lock-keywords-2 nil nil ((?_ . "w"))))
1832 ((string< emacs-version "19.33") ; Which one to use?
1833 '((cperl-font-lock-keywords
1834 cperl-font-lock-keywords-1
1835 cperl-font-lock-keywords-2) nil nil ((?_ . "w"))))
1836 (t
1837 '((cperl-load-font-lock-keywords
1838 cperl-load-font-lock-keywords-1
1839 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
1840 (make-local-variable 'cperl-syntax-state)
1841 (setq cperl-syntax-state nil) ; reset syntaxification cache
1842 (if cperl-use-syntax-table-text-property
1843 (progn
1844 (make-local-variable 'parse-sexp-lookup-properties)
1845 ;; Do not introduce variable if not needed, we check it!
1846 (set 'parse-sexp-lookup-properties t)
1847 ;; Fix broken font-lock:
1848 (or (boundp 'font-lock-unfontify-region-function)
1849 (set 'font-lock-unfontify-region-function
1850 'font-lock-default-unfontify-region))
1851 (unless (featurep 'xemacs) ; Our: just a plug for wrong font-lock
1852 (make-local-variable 'font-lock-unfontify-region-function)
1853 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1854 'cperl-font-lock-unfontify-region-function))
1855 (make-local-variable 'cperl-syntax-done-to)
1856 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
1857 (make-local-variable 'font-lock-syntactic-keywords)
1858 (setq font-lock-syntactic-keywords
1859 (if cperl-syntaxify-by-font-lock
1860 '((cperl-fontify-syntaxically))
1861 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1862 ;; used to ignore syntax-table text-properties. (t) is a hack
1863 ;; to make font-lock think that font-lock-syntactic-keywords
1864 ;; are defined.
1865 '(t)))))
1866 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
1867 (progn
1868 (setq cperl-font-lock-multiline t) ; Not localized...
1869 (set (make-local-variable 'font-lock-multiline) t))
1870 (make-local-variable 'font-lock-fontify-region-function)
1871 (set 'font-lock-fontify-region-function ; not present with old Emacs
1872 'cperl-font-lock-fontify-region-function))
1873 (make-local-variable 'font-lock-fontify-region-function)
1874 (set 'font-lock-fontify-region-function ; not present with old Emacs
1875 'cperl-font-lock-fontify-region-function)
1876 (make-local-variable 'cperl-old-style)
1877 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1878 (set (make-local-variable 'normal-auto-fill-function)
1879 'cperl-do-auto-fill)
1880 (or (fboundp 'cperl-old-auto-fill-mode)
1881 (progn
1882 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1883 (defun auto-fill-mode (&optional arg)
1884 (interactive "P")
1885 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1886 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1887 (setq auto-fill-function 'cperl-do-auto-fill))))))
1888 (if (cperl-enable-font-lock)
1889 (if (cperl-val 'cperl-font-lock)
1890 (progn (or cperl-faces-init (cperl-init-faces))
1891 (font-lock-mode 1))))
1892 (set (make-local-variable 'facemenu-add-face-function)
1893 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
1894 (and (boundp 'msb-menu-cond)
1895 (not cperl-msb-fixed)
1896 (cperl-msb-fix))
1897 (if (featurep 'easymenu)
1898 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
1899 (run-mode-hooks 'cperl-mode-hook)
1900 (if cperl-hook-after-change
1901 (add-hook 'after-change-functions 'cperl-after-change-function nil t))
1902 ;; After hooks since fontification will break this
1903 (if cperl-pod-here-scan
1904 (or cperl-syntaxify-by-font-lock
1905 (progn (or cperl-faces-init (cperl-init-faces-weak))
1906 (cperl-find-pods-heres)))))
1907 \f
1908 ;; Fix for perldb - make default reasonable
1909 (defun cperl-db ()
1910 (interactive)
1911 (require 'gud)
1912 (perldb (read-from-minibuffer "Run perldb (like this): "
1913 (if (consp gud-perldb-history)
1914 (car gud-perldb-history)
1915 (concat "perl " ;;(file-name-nondirectory
1916 ;; I have problems
1917 ;; in OS/2
1918 ;; otherwise
1919 (buffer-file-name)))
1920 nil nil
1921 '(gud-perldb-history . 1))))
1922 \f
1923 (defun cperl-msb-fix ()
1924 ;; Adds perl files to msb menu, supposes that msb is already loaded
1925 (setq cperl-msb-fixed t)
1926 (let* ((l (length msb-menu-cond))
1927 (last (nth (1- l) msb-menu-cond))
1928 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1929 (handle (1- (nth 1 last))))
1930 (setcdr precdr (list
1931 (list
1932 '(memq major-mode '(cperl-mode perl-mode))
1933 handle
1934 "Perl Files (%d)")
1935 last))))
1936 \f
1937 ;; This is used by indent-for-comment
1938 ;; to decide how much to indent a comment in CPerl code
1939 ;; based on its context. Do fallback if comment is found wrong.
1940
1941 (defvar cperl-wrong-comment)
1942 (defvar cperl-st-cfence '(14)) ; Comment-fence
1943 (defvar cperl-st-sfence '(15)) ; String-fence
1944 (defvar cperl-st-punct '(1))
1945 (defvar cperl-st-word '(2))
1946 (defvar cperl-st-bra '(4 . ?\>))
1947 (defvar cperl-st-ket '(5 . ?\<))
1948
1949
1950 (defun cperl-comment-indent () ; called at point at supposed comment
1951 (let ((p (point)) (c (current-column)) was phony)
1952 (if (and (not cperl-indent-comment-at-column-0)
1953 (looking-at "^#"))
1954 0 ; Existing comment at bol stays there.
1955 ;; Wrong comment found
1956 (save-excursion
1957 (setq was (cperl-to-comment-or-eol)
1958 phony (eq (get-text-property (point) 'syntax-table)
1959 cperl-st-cfence))
1960 (if phony
1961 (progn ; Too naive???
1962 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1963 (if (eq (preceding-char) ?\#)
1964 (forward-char -1))
1965 (setq was nil)))
1966 (if (= (point) p) ; Our caller found a correct place
1967 (progn
1968 (skip-chars-backward " \t")
1969 (setq was (current-column))
1970 (if (eq was 0)
1971 comment-column
1972 (max (1+ was) ; Else indent at comment column
1973 comment-column)))
1974 ;; No, the caller found a random place; we need to edit ourselves
1975 (if was nil
1976 (insert comment-start)
1977 (backward-char (length comment-start)))
1978 (setq cperl-wrong-comment t)
1979 (cperl-make-indent comment-column 1) ; Indent min 1
1980 c)))))
1981
1982 ;;;(defun cperl-comment-indent-fallback ()
1983 ;;; "Is called if the standard comment-search procedure fails.
1984 ;;;Point is at start of real comment."
1985 ;;; (let ((c (current-column)) target cnt prevc)
1986 ;;; (if (= c comment-column) nil
1987 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1988 ;;; (setq target (max (1+ (setq prevc
1989 ;;; (current-column))) ; Else indent at comment column
1990 ;;; comment-column))
1991 ;;; (if (= c comment-column) nil
1992 ;;; (delete-backward-char cnt)
1993 ;;; (while (< prevc target)
1994 ;;; (insert "\t")
1995 ;;; (setq prevc (current-column)))
1996 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1997 ;;; (while (< prevc target)
1998 ;;; (insert " ")
1999 ;;; (setq prevc (current-column)))))))
2000
2001 (defun cperl-indent-for-comment ()
2002 "Substitute for `indent-for-comment' in CPerl."
2003 (interactive)
2004 (let (cperl-wrong-comment)
2005 (indent-for-comment)
2006 (if cperl-wrong-comment ; set by `cperl-comment-indent'
2007 (progn (cperl-to-comment-or-eol)
2008 (forward-char (length comment-start))))))
2009
2010 (defun cperl-comment-region (b e arg)
2011 "Comment or uncomment each line in the region in CPerl mode.
2012 See `comment-region'."
2013 (interactive "r\np")
2014 (let ((comment-start "#"))
2015 (comment-region b e arg)))
2016
2017 (defun cperl-uncomment-region (b e arg)
2018 "Uncomment or comment each line in the region in CPerl mode.
2019 See `comment-region'."
2020 (interactive "r\np")
2021 (let ((comment-start "#"))
2022 (comment-region b e (- arg))))
2023
2024 (defvar cperl-brace-recursing nil)
2025
2026 (defun cperl-electric-brace (arg &optional only-before)
2027 "Insert character and correct line's indentation.
2028 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2029 place (even in empty line), but not after. If after \")\" and the inserted
2030 char is \"{\", insert extra newline before only if
2031 `cperl-extra-newline-before-brace'."
2032 (interactive "P")
2033 (let (insertpos
2034 (other-end (if (and cperl-electric-parens-mark
2035 (cperl-mark-active)
2036 (< (mark) (point)))
2037 (mark)
2038 nil)))
2039 (if (and other-end
2040 (not cperl-brace-recursing)
2041 (cperl-val 'cperl-electric-parens)
2042 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2043 ;; Need to insert a matching pair
2044 (progn
2045 (save-excursion
2046 (setq insertpos (point-marker))
2047 (goto-char other-end)
2048 (setq last-command-event ?\{)
2049 (cperl-electric-lbrace arg insertpos))
2050 (forward-char 1))
2051 ;; Check whether we close something "usual" with `}'
2052 (if (and (eq last-command-event ?\})
2053 (not
2054 (condition-case nil
2055 (save-excursion
2056 (up-list (- (prefix-numeric-value arg)))
2057 ;;(cperl-after-block-p (point-min))
2058 (or (cperl-after-expr-p nil "{;)")
2059 ;; after sub, else, continue
2060 (cperl-after-block-p nil 'pre)))
2061 (error nil))))
2062 ;; Just insert the guy
2063 (self-insert-command (prefix-numeric-value arg))
2064 (if (and (not arg) ; No args, end (of empty line or auto)
2065 (eolp)
2066 (or (and (null only-before)
2067 (save-excursion
2068 (skip-chars-backward " \t")
2069 (bolp)))
2070 (and (eq last-command-event ?\{) ; Do not insert newline
2071 ;; if after ")" and `cperl-extra-newline-before-brace'
2072 ;; is nil, do not insert extra newline.
2073 (not cperl-extra-newline-before-brace)
2074 (save-excursion
2075 (skip-chars-backward " \t")
2076 (eq (preceding-char) ?\))))
2077 (if cperl-auto-newline
2078 (progn (cperl-indent-line) (newline) t) nil)))
2079 (progn
2080 (self-insert-command (prefix-numeric-value arg))
2081 (cperl-indent-line)
2082 (if cperl-auto-newline
2083 (setq insertpos (1- (point))))
2084 (if (and cperl-auto-newline (null only-before))
2085 (progn
2086 (newline)
2087 (cperl-indent-line)))
2088 (save-excursion
2089 (if insertpos (progn (goto-char insertpos)
2090 (search-forward (make-string
2091 1 last-command-event))
2092 (setq insertpos (1- (point)))))
2093 (delete-char -1))))
2094 (if insertpos
2095 (save-excursion
2096 (goto-char insertpos)
2097 (self-insert-command (prefix-numeric-value arg)))
2098 (self-insert-command (prefix-numeric-value arg)))))))
2099
2100 (defun cperl-electric-lbrace (arg &optional end)
2101 "Insert character, correct line's indentation, correct quoting by space."
2102 (interactive "P")
2103 (let ((cperl-brace-recursing t)
2104 (cperl-auto-newline cperl-auto-newline)
2105 (other-end (or end
2106 (if (and cperl-electric-parens-mark
2107 (cperl-mark-active)
2108 (> (mark) (point)))
2109 (save-excursion
2110 (goto-char (mark))
2111 (point-marker))
2112 nil)))
2113 pos after)
2114 (and (cperl-val 'cperl-electric-lbrace-space)
2115 (eq (preceding-char) ?$)
2116 (save-excursion
2117 (skip-chars-backward "$")
2118 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
2119 (insert ?\s))
2120 ;; Check whether we are in comment
2121 (if (and
2122 (save-excursion
2123 (beginning-of-line)
2124 (not (looking-at "[ \t]*#")))
2125 (cperl-after-expr-p nil "{;)"))
2126 nil
2127 (setq cperl-auto-newline nil))
2128 (cperl-electric-brace arg)
2129 (and (cperl-val 'cperl-electric-parens)
2130 (eq last-command-event ?{)
2131 (memq last-command-event
2132 (append cperl-electric-parens-string nil))
2133 (or (if other-end (goto-char (marker-position other-end)))
2134 t)
2135 (setq last-command-event ?} pos (point))
2136 (progn (cperl-electric-brace arg t)
2137 (goto-char pos)))))
2138
2139 (defun cperl-electric-paren (arg)
2140 "Insert an opening parenthesis or a matching pair of parentheses.
2141 See `cperl-electric-parens'."
2142 (interactive "P")
2143 (let ((beg (save-excursion (beginning-of-line) (point)))
2144 (other-end (if (and cperl-electric-parens-mark
2145 (cperl-mark-active)
2146 (> (mark) (point)))
2147 (save-excursion
2148 (goto-char (mark))
2149 (point-marker))
2150 nil)))
2151 (if (and (cperl-val 'cperl-electric-parens)
2152 (memq last-command-event
2153 (append cperl-electric-parens-string nil))
2154 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2155 ;;(not (save-excursion (search-backward "#" beg t)))
2156 (if (eq last-command-event ?<)
2157 (progn
2158 ;; This code is too electric, see Bug#3943.
2159 ;; (and abbrev-mode ; later it is too late, may be after `for'
2160 ;; (expand-abbrev))
2161 (cperl-after-expr-p nil "{;(,:="))
2162 1))
2163 (progn
2164 (self-insert-command (prefix-numeric-value arg))
2165 (if other-end (goto-char (marker-position other-end)))
2166 (insert (make-string
2167 (prefix-numeric-value arg)
2168 (cdr (assoc last-command-event '((?{ .?})
2169 (?[ . ?])
2170 (?( . ?))
2171 (?< . ?>))))))
2172 (forward-char (- (prefix-numeric-value arg))))
2173 (self-insert-command (prefix-numeric-value arg)))))
2174
2175 (defun cperl-electric-rparen (arg)
2176 "Insert a matching pair of parentheses if marking is active.
2177 If not, or if we are not at the end of marking range, would self-insert.
2178 Affected by `cperl-electric-parens'."
2179 (interactive "P")
2180 (let ((beg (save-excursion (beginning-of-line) (point)))
2181 (other-end (if (and cperl-electric-parens-mark
2182 (cperl-val 'cperl-electric-parens)
2183 (memq last-command-event
2184 (append cperl-electric-parens-string nil))
2185 (cperl-mark-active)
2186 (< (mark) (point)))
2187 (mark)
2188 nil))
2189 p)
2190 (if (and other-end
2191 (cperl-val 'cperl-electric-parens)
2192 (memq last-command-event '( ?\) ?\] ?\} ?\> ))
2193 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2194 ;;(not (save-excursion (search-backward "#" beg t)))
2195 )
2196 (progn
2197 (self-insert-command (prefix-numeric-value arg))
2198 (setq p (point))
2199 (if other-end (goto-char other-end))
2200 (insert (make-string
2201 (prefix-numeric-value arg)
2202 (cdr (assoc last-command-event '((?\} . ?\{)
2203 (?\] . ?\[)
2204 (?\) . ?\()
2205 (?\> . ?\<))))))
2206 (goto-char (1+ p)))
2207 (self-insert-command (prefix-numeric-value arg)))))
2208
2209 (defun cperl-electric-keyword ()
2210 "Insert a construction appropriate after a keyword.
2211 Help message may be switched off by setting `cperl-message-electric-keyword'
2212 to nil."
2213 (let ((beg (save-excursion (beginning-of-line) (point)))
2214 (dollar (and (eq last-command-event ?$)
2215 (eq this-command 'self-insert-command)))
2216 (delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
2217 (memq this-command '(self-insert-command newline))))
2218 my do)
2219 (and (save-excursion
2220 (condition-case nil
2221 (progn
2222 (backward-sexp 1)
2223 (setq do (looking-at "do\\>")))
2224 (error nil))
2225 (cperl-after-expr-p nil "{;:"))
2226 (save-excursion
2227 (not
2228 (re-search-backward
2229 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2230 beg t)))
2231 (save-excursion (or (not (re-search-backward "^=" nil t))
2232 (or
2233 (looking-at "=cut")
2234 (and cperl-use-syntax-table-text-property
2235 (not (eq (get-text-property (point)
2236 'syntax-type)
2237 'pod))))))
2238 (save-excursion (forward-sexp -1)
2239 (not (memq (following-char) (append "$@%&*" nil))))
2240 (progn
2241 (and (eq (preceding-char) ?y)
2242 (progn ; "foreachmy"
2243 (forward-char -2)
2244 (insert " ")
2245 (forward-char 2)
2246 (setq my t dollar t
2247 delete
2248 (memq this-command '(self-insert-command newline)))))
2249 (and dollar (insert " $"))
2250 (cperl-indent-line)
2251 ;;(insert " () {\n}")
2252 (cond
2253 (cperl-extra-newline-before-brace
2254 (insert (if do "\n" " ()\n"))
2255 (insert "{")
2256 (cperl-indent-line)
2257 (insert "\n")
2258 (cperl-indent-line)
2259 (insert "\n}")
2260 (and do (insert " while ();")))
2261 (t
2262 (insert (if do " {\n} while ();" " () {\n}"))))
2263 (or (looking-at "[ \t]\\|$") (insert " "))
2264 (cperl-indent-line)
2265 (if dollar (progn (search-backward "$")
2266 (if my
2267 (forward-char 1)
2268 (delete-char 1)))
2269 (search-backward ")")
2270 (if (eq last-command-event ?\()
2271 (progn ; Avoid "if (())"
2272 (delete-backward-char 1)
2273 (delete-backward-char -1))))
2274 (if delete
2275 (cperl-putback-char cperl-del-back-ch))
2276 (if cperl-message-electric-keyword
2277 (message "Precede char by C-q to avoid expansion"))))))
2278
2279 (defun cperl-ensure-newlines (n &optional pos)
2280 "Make sure there are N newlines after the point."
2281 (or pos (setq pos (point)))
2282 (if (looking-at "\n")
2283 (forward-char 1)
2284 (insert "\n"))
2285 (if (> n 1)
2286 (cperl-ensure-newlines (1- n) pos)
2287 (goto-char pos)))
2288
2289 (defun cperl-electric-pod ()
2290 "Insert a POD chunk appropriate after a =POD directive."
2291 (let ((delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
2292 (memq this-command '(self-insert-command newline))))
2293 head1 notlast name p really-delete over)
2294 (and (save-excursion
2295 (forward-word -1)
2296 (and
2297 (eq (preceding-char) ?=)
2298 (progn
2299 (setq head1 (looking-at "head1\\>[ \t]*$"))
2300 (setq over (and (looking-at "over\\>[ \t]*$")
2301 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
2302 (forward-char -1)
2303 (bolp))
2304 (or
2305 (get-text-property (point) 'in-pod)
2306 (cperl-after-expr-p nil "{;:")
2307 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
2308 (not (looking-at "\n*=cut"))
2309 (or (not cperl-use-syntax-table-text-property)
2310 (eq (get-text-property (point) 'syntax-type) 'pod))))))
2311 (progn
2312 (save-excursion
2313 (setq notlast (re-search-forward "^\n=" nil t)))
2314 (or notlast
2315 (progn
2316 (insert "\n\n=cut")
2317 (cperl-ensure-newlines 2)
2318 (forward-word -2)
2319 (if (and head1
2320 (not
2321 (save-excursion
2322 (forward-char -1)
2323 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
2324 nil t)))) ; Only one
2325 (progn
2326 (forward-word 1)
2327 (setq name (file-name-sans-extension
2328 (file-name-nondirectory (buffer-file-name)))
2329 p (point))
2330 (insert " NAME\n\n" name
2331 " - \n\n=head1 SYNOPSIS\n\n\n\n"
2332 "=head1 DESCRIPTION")
2333 (cperl-ensure-newlines 4)
2334 (goto-char p)
2335 (forward-word 2)
2336 (end-of-line)
2337 (setq really-delete t))
2338 (forward-word 1))))
2339 (if over
2340 (progn
2341 (setq p (point))
2342 (insert "\n\n=item \n\n\n\n"
2343 "=back")
2344 (cperl-ensure-newlines 2)
2345 (goto-char p)
2346 (forward-word 1)
2347 (end-of-line)
2348 (setq really-delete t)))
2349 (if (and delete really-delete)
2350 (cperl-putback-char cperl-del-back-ch))))))
2351
2352 (defun cperl-electric-else ()
2353 "Insert a construction appropriate after a keyword.
2354 Help message may be switched off by setting `cperl-message-electric-keyword'
2355 to nil."
2356 (let ((beg (save-excursion (beginning-of-line) (point))))
2357 (and (save-excursion
2358 (backward-sexp 1)
2359 (cperl-after-expr-p nil "{;:"))
2360 (save-excursion
2361 (not
2362 (re-search-backward
2363 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2364 beg t)))
2365 (save-excursion (or (not (re-search-backward "^=" nil t))
2366 (looking-at "=cut")
2367 (and cperl-use-syntax-table-text-property
2368 (not (eq (get-text-property (point)
2369 'syntax-type)
2370 'pod)))))
2371 (progn
2372 (cperl-indent-line)
2373 ;;(insert " {\n\n}")
2374 (cond
2375 (cperl-extra-newline-before-brace
2376 (insert "\n")
2377 (insert "{")
2378 (cperl-indent-line)
2379 (insert "\n\n}"))
2380 (t
2381 (insert " {\n\n}")))
2382 (or (looking-at "[ \t]\\|$") (insert " "))
2383 (cperl-indent-line)
2384 (forward-line -1)
2385 (cperl-indent-line)
2386 (cperl-putback-char cperl-del-back-ch)
2387 (setq this-command 'cperl-electric-else)
2388 (if cperl-message-electric-keyword
2389 (message "Precede char by C-q to avoid expansion"))))))
2390
2391 (defun cperl-linefeed ()
2392 "Go to end of line, open a new line and indent appropriately.
2393 If in POD, insert appropriate lines."
2394 (interactive)
2395 (let ((beg (save-excursion (beginning-of-line) (point)))
2396 (end (save-excursion (end-of-line) (point)))
2397 (pos (point)) start over cut res)
2398 (if (and ; Check if we need to split:
2399 ; i.e., on a boundary and inside "{...}"
2400 (save-excursion (cperl-to-comment-or-eol)
2401 (>= (point) pos)) ; Not in a comment
2402 (or (save-excursion
2403 (skip-chars-backward " \t" beg)
2404 (forward-char -1)
2405 (looking-at "[;{]")) ; After { or ; + spaces
2406 (looking-at "[ \t]*}") ; Before }
2407 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2408 (save-excursion
2409 (and
2410 (eq (car (parse-partial-sexp pos end -1)) -1)
2411 ; Leave the level of parens
2412 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2413 ; Are at end
2414 (cperl-after-block-p (point-min))
2415 (progn
2416 (backward-sexp 1)
2417 (setq start (point-marker))
2418 (<= start pos))))) ; Redundant? Are after the
2419 ; start of parens group.
2420 (progn
2421 (skip-chars-backward " \t")
2422 (or (memq (preceding-char) (append ";{" nil))
2423 (insert ";"))
2424 (insert "\n")
2425 (forward-line -1)
2426 (cperl-indent-line)
2427 (goto-char start)
2428 (or (looking-at "{[ \t]*$") ; If there is a statement
2429 ; before, move it to separate line
2430 (progn
2431 (forward-char 1)
2432 (insert "\n")
2433 (cperl-indent-line)))
2434 (forward-line 1) ; We are on the target line
2435 (cperl-indent-line)
2436 (beginning-of-line)
2437 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2438 ; after, move it to separate line
2439 (progn
2440 (end-of-line)
2441 (search-backward "}" beg)
2442 (skip-chars-backward " \t")
2443 (or (memq (preceding-char) (append ";{" nil))
2444 (insert ";"))
2445 (insert "\n")
2446 (cperl-indent-line)
2447 (forward-line -1)))
2448 (forward-line -1) ; We are on the line before target
2449 (end-of-line)
2450 (newline-and-indent))
2451 (end-of-line) ; else - no splitting
2452 (cond
2453 ((and (looking-at "\n[ \t]*{$")
2454 (save-excursion
2455 (skip-chars-backward " \t")
2456 (eq (preceding-char) ?\)))) ; Probably if () {} group
2457 ; with an extra newline.
2458 (forward-line 2)
2459 (cperl-indent-line))
2460 ((save-excursion ; In POD header
2461 (forward-paragraph -1)
2462 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2463 ;; We are after \n now, so look for the rest
2464 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2465 (progn
2466 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2467 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2468 t)))
2469 (if (and over
2470 (progn
2471 (forward-paragraph -1)
2472 (forward-word 1)
2473 (setq pos (point))
2474 (setq cut (buffer-substring (point)
2475 (save-excursion
2476 (end-of-line)
2477 (point))))
2478 (delete-char (- (save-excursion (end-of-line) (point))
2479 (point)))
2480 (setq res (expand-abbrev))
2481 (save-excursion
2482 (goto-char pos)
2483 (insert cut))
2484 res))
2485 nil
2486 (cperl-ensure-newlines (if cut 2 4))
2487 (forward-line 2)))
2488 ((get-text-property (point) 'in-pod) ; In POD section
2489 (cperl-ensure-newlines 4)
2490 (forward-line 2))
2491 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2492 (forward-line 1)
2493 (cperl-indent-line))
2494 (t
2495 (newline-and-indent))))))
2496
2497 (defun cperl-electric-semi (arg)
2498 "Insert character and correct line's indentation."
2499 (interactive "P")
2500 (if cperl-auto-newline
2501 (cperl-electric-terminator arg)
2502 (self-insert-command (prefix-numeric-value arg))
2503 (if cperl-autoindent-on-semi
2504 (cperl-indent-line))))
2505
2506 (defun cperl-electric-terminator (arg)
2507 "Insert character and correct line's indentation."
2508 (interactive "P")
2509 (let ((end (point))
2510 (auto (and cperl-auto-newline
2511 (or (not (eq last-command-event ?:))
2512 cperl-auto-newline-after-colon)))
2513 insertpos)
2514 (if (and ;;(not arg)
2515 (eolp)
2516 (not (save-excursion
2517 (beginning-of-line)
2518 (skip-chars-forward " \t")
2519 (or
2520 ;; Ignore in comment lines
2521 (= (following-char) ?#)
2522 ;; Colon is special only after a label
2523 ;; So quickly rule out most other uses of colon
2524 ;; and do no indentation for them.
2525 (and (eq last-command-event ?:)
2526 (save-excursion
2527 (forward-word 1)
2528 (skip-chars-forward " \t")
2529 (and (< (point) end)
2530 (progn (goto-char (- end 1))
2531 (not (looking-at ":"))))))
2532 (progn
2533 (beginning-of-defun)
2534 (let ((pps (parse-partial-sexp (point) end)))
2535 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2536 (progn
2537 (self-insert-command (prefix-numeric-value arg))
2538 ;;(forward-char -1)
2539 (if auto (setq insertpos (point-marker)))
2540 ;;(forward-char 1)
2541 (cperl-indent-line)
2542 (if auto
2543 (progn
2544 (newline)
2545 (cperl-indent-line)))
2546 (save-excursion
2547 (if insertpos (goto-char (1- (marker-position insertpos)))
2548 (forward-char -1))
2549 (delete-char 1))))
2550 (if insertpos
2551 (save-excursion
2552 (goto-char insertpos)
2553 (self-insert-command (prefix-numeric-value arg)))
2554 (self-insert-command (prefix-numeric-value arg)))))
2555
2556 (defun cperl-electric-backspace (arg)
2557 "Backspace, or remove whitespace around the point inserted by an electric key.
2558 Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2559 (interactive "p")
2560 (if (and cperl-auto-newline
2561 (memq last-command '(cperl-electric-semi
2562 cperl-electric-terminator
2563 cperl-electric-lbrace))
2564 (memq (preceding-char) '(?\s ?\t ?\n)))
2565 (let (p)
2566 (if (eq last-command 'cperl-electric-lbrace)
2567 (skip-chars-forward " \t\n"))
2568 (setq p (point))
2569 (skip-chars-backward " \t\n")
2570 (delete-region (point) p))
2571 (and (eq last-command 'cperl-electric-else)
2572 ;; We are removing the whitespace *inside* cperl-electric-else
2573 (setq this-command 'cperl-electric-else-really))
2574 (if (and cperl-auto-newline
2575 (eq last-command 'cperl-electric-else-really)
2576 (memq (preceding-char) '(?\s ?\t ?\n)))
2577 (let (p)
2578 (skip-chars-forward " \t\n")
2579 (setq p (point))
2580 (skip-chars-backward " \t\n")
2581 (delete-region (point) p))
2582 (if cperl-electric-backspace-untabify
2583 (backward-delete-char-untabify arg)
2584 (delete-backward-char arg)))))
2585
2586 (put 'cperl-electric-backspace 'delete-selection 'supersede)
2587
2588 (defun cperl-inside-parens-p () ;; NOT USED????
2589 (condition-case ()
2590 (save-excursion
2591 (save-restriction
2592 (narrow-to-region (point)
2593 (progn (beginning-of-defun) (point)))
2594 (goto-char (point-max))
2595 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2596 (error nil)))
2597 \f
2598 (defun cperl-indent-command (&optional whole-exp)
2599 "Indent current line as Perl code, or in some cases insert a tab character.
2600 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2601 line. Otherwise, indent the current line only if point is at the left margin
2602 or in the line's indentation; otherwise insert a tab.
2603
2604 A numeric argument, regardless of its value,
2605 means indent rigidly all the lines of the expression starting after point
2606 so that this line becomes properly indented.
2607 The relative indentation among the lines of the expression are preserved."
2608 (interactive "P")
2609 (cperl-update-syntaxification (point) (point))
2610 (if whole-exp
2611 ;; If arg, always indent this line as Perl
2612 ;; and shift remaining lines of expression the same amount.
2613 (let ((shift-amt (cperl-indent-line))
2614 beg end)
2615 (save-excursion
2616 (if cperl-tab-always-indent
2617 (beginning-of-line))
2618 (setq beg (point))
2619 (forward-sexp 1)
2620 (setq end (point))
2621 (goto-char beg)
2622 (forward-line 1)
2623 (setq beg (point)))
2624 (if (and shift-amt (> end beg))
2625 (indent-code-rigidly beg end shift-amt "#")))
2626 (if (and (not cperl-tab-always-indent)
2627 (save-excursion
2628 (skip-chars-backward " \t")
2629 (not (bolp))))
2630 (insert-tab)
2631 (cperl-indent-line))))
2632
2633 (defun cperl-indent-line (&optional parse-data)
2634 "Indent current line as Perl code.
2635 Return the amount the indentation changed by."
2636 (let ((case-fold-search nil)
2637 (pos (- (point-max) (point)))
2638 indent i beg shift-amt)
2639 (setq indent (cperl-calculate-indent parse-data)
2640 i indent)
2641 (beginning-of-line)
2642 (setq beg (point))
2643 (cond ((or (eq indent nil) (eq indent t))
2644 (setq indent (current-indentation) i nil))
2645 ;;((eq indent t) ; Never?
2646 ;; (setq indent (cperl-calculate-indent-within-comment)))
2647 ;;((looking-at "[ \t]*#")
2648 ;; (setq indent 0))
2649 (t
2650 (skip-chars-forward " \t")
2651 (if (listp indent) (setq indent (car indent)))
2652 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2653 (not (looking-at "[smy]:\\|tr:")))
2654 (and (> indent 0)
2655 (setq indent (max cperl-min-label-indent
2656 (+ indent cperl-label-offset)))))
2657 ((= (following-char) ?})
2658 (setq indent (- indent cperl-indent-level)))
2659 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2660 (setq indent (+ indent cperl-close-paren-offset)))
2661 ((= (following-char) ?{)
2662 (setq indent (+ indent cperl-brace-offset))))))
2663 (skip-chars-forward " \t")
2664 (setq shift-amt (and i (- indent (current-column))))
2665 (if (or (not shift-amt)
2666 (zerop shift-amt))
2667 (if (> (- (point-max) pos) (point))
2668 (goto-char (- (point-max) pos)))
2669 ;;;(delete-region beg (point))
2670 ;;;(indent-to indent)
2671 (cperl-make-indent indent)
2672 ;; If initial point was within line's indentation,
2673 ;; position after the indentation. Else stay at same point in text.
2674 (if (> (- (point-max) pos) (point))
2675 (goto-char (- (point-max) pos))))
2676 shift-amt))
2677
2678 (defun cperl-after-label ()
2679 ;; Returns true if the point is after label. Does not do save-excursion.
2680 (and (eq (preceding-char) ?:)
2681 (memq (char-syntax (char-after (- (point) 2)))
2682 '(?w ?_))
2683 (progn
2684 (backward-sexp)
2685 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2686
2687 (defun cperl-get-state (&optional parse-start start-state)
2688 ;; returns list (START STATE DEPTH PRESTART),
2689 ;; START is a good place to start parsing, or equal to
2690 ;; PARSE-START if preset,
2691 ;; STATE is what is returned by `parse-partial-sexp'.
2692 ;; DEPTH is true is we are immediately after end of block
2693 ;; which contains START.
2694 ;; PRESTART is the position basing on which START was found.
2695 (save-excursion
2696 (let ((start-point (point)) depth state start prestart)
2697 (if (and parse-start
2698 (<= parse-start start-point))
2699 (goto-char parse-start)
2700 (beginning-of-defun)
2701 (setq start-state nil))
2702 (setq prestart (point))
2703 (if start-state nil
2704 ;; Try to go out, if sub is not on the outermost level
2705 (while (< (point) start-point)
2706 (setq start (point) parse-start start depth nil
2707 state (parse-partial-sexp start start-point -1))
2708 (if (> (car state) -1) nil
2709 ;; The current line could start like }}}, so the indentation
2710 ;; corresponds to a different level than what we reached
2711 (setq depth t)
2712 (beginning-of-line 2))) ; Go to the next line.
2713 (if start (goto-char start))) ; Not at the start of file
2714 (setq start (point))
2715 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2716 (list start state depth prestart))))
2717
2718 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2719
2720 (defun cperl-beginning-of-property (p prop &optional lim)
2721 "Given that P has a property PROP, find where the property starts.
2722 Will not look before LIM."
2723 ;;; XXXX What to do at point-max???
2724 (or (previous-single-property-change (cperl-1+ p) prop lim)
2725 (point-min))
2726 ;;; (cond ((eq p (point-min))
2727 ;;; p)
2728 ;;; ((and lim (<= p lim))
2729 ;;; p)
2730 ;;; ((not (get-text-property (1- p) prop))
2731 ;;; p)
2732 ;;; (t (or (previous-single-property-change p look-prop lim)
2733 ;;; (point-min))))
2734 )
2735
2736 (defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
2737 ;; the sniffer logic to understand what the current line MEANS.
2738 (cperl-update-syntaxification (point) (point))
2739 (let ((res (get-text-property (point) 'syntax-type)))
2740 (save-excursion
2741 (cond
2742 ((and (memq res '(pod here-doc here-doc-delim format))
2743 (not (get-text-property (point) 'indentable)))
2744 (vector res))
2745 ;; before start of POD - whitespace found since do not have 'pod!
2746 ((looking-at "[ \t]*\n=")
2747 (error "Spaces before POD section!"))
2748 ((and (not cperl-indent-left-aligned-comments)
2749 (looking-at "^#"))
2750 [comment-special:at-beginning-of-line])
2751 ((get-text-property (point) 'in-pod)
2752 [in-pod])
2753 (t
2754 (beginning-of-line)
2755 (let* ((indent-point (point))
2756 (char-after-pos (save-excursion
2757 (skip-chars-forward " \t")
2758 (point)))
2759 (char-after (char-after char-after-pos))
2760 (pre-indent-point (point))
2761 p prop look-prop is-block delim)
2762 (save-excursion ; Know we are not in POD, find appropriate pos before
2763 (cperl-backward-to-noncomment nil)
2764 (setq p (max (point-min) (1- (point)))
2765 prop (get-text-property p 'syntax-type)
2766 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2767 'syntax-type))
2768 (if (memq prop '(pod here-doc format here-doc-delim))
2769 (progn
2770 (goto-char (cperl-beginning-of-property p look-prop))
2771 (beginning-of-line)
2772 (setq pre-indent-point (point)))))
2773 (goto-char pre-indent-point) ; Orig line skipping preceding pod/etc
2774 (let* ((case-fold-search nil)
2775 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2776 (start (or (nth 2 parse-data) ; last complete sexp terminated
2777 (nth 0 s-s))) ; Good place to start parsing
2778 (state (nth 1 s-s))
2779 (containing-sexp (car (cdr state)))
2780 old-indent)
2781 (if (and
2782 ;;containing-sexp ;; We are buggy at toplevel :-(
2783 parse-data)
2784 (progn
2785 (setcar parse-data pre-indent-point)
2786 (setcar (cdr parse-data) state)
2787 (or (nth 2 parse-data)
2788 (setcar (cddr parse-data) start))
2789 ;; Before this point: end of statement
2790 (setq old-indent (nth 3 parse-data))))
2791 (cond ((get-text-property (point) 'indentable)
2792 ;; indent to "after" the surrounding open
2793 ;; (same offset as `cperl-beautify-regexp-piece'),
2794 ;; skip blanks if we do not close the expression.
2795 (setq delim ; We do not close the expression
2796 (get-text-property
2797 (cperl-1+ char-after-pos) 'indentable)
2798 p (1+ (cperl-beginning-of-property
2799 (point) 'indentable))
2800 is-block ; misused for: preceding line in REx
2801 (save-excursion ; Find preceding line
2802 (cperl-backward-to-noncomment p)
2803 (beginning-of-line)
2804 (if (<= (point) p)
2805 (progn ; get indent from the first line
2806 (goto-char p)
2807 (skip-chars-forward " \t")
2808 (if (memq (char-after (point))
2809 (append "#\n" nil))
2810 nil ; Can't use intentation of this line...
2811 (point)))
2812 (skip-chars-forward " \t")
2813 (point)))
2814 prop (parse-partial-sexp p char-after-pos))
2815 (cond ((not delim) ; End the REx, ignore is-block
2816 (vector 'indentable 'terminator p is-block))
2817 (is-block ; Indent w.r.t. preceding line
2818 (vector 'indentable 'cont-line char-after-pos
2819 is-block char-after p))
2820 (t ; No preceding line...
2821 (vector 'indentable 'first-line p))))
2822 ((get-text-property char-after-pos 'REx-part2)
2823 (vector 'REx-part2 (point)))
2824 ((nth 4 state)
2825 [comment])
2826 ((nth 3 state)
2827 [string])
2828 ;; XXXX Do we need to special-case this?
2829 ((null containing-sexp)
2830 ;; Line is at top level. May be data or function definition,
2831 ;; or may be function argument declaration.
2832 ;; Indent like the previous top level line
2833 ;; unless that ends in a closeparen without semicolon,
2834 ;; in which case this line is the first argument decl.
2835 (skip-chars-forward " \t")
2836 (cperl-backward-to-noncomment (or old-indent (point-min)))
2837 (setq state
2838 (or (bobp)
2839 (eq (point) old-indent) ; old-indent was at comment
2840 (eq (preceding-char) ?\;)
2841 ;; Had ?\) too
2842 (and (eq (preceding-char) ?\})
2843 (cperl-after-block-and-statement-beg
2844 (point-min))) ; Was start - too close
2845 (memq char-after (append ")]}" nil))
2846 (and (eq (preceding-char) ?\:) ; label
2847 (progn
2848 (forward-sexp -1)
2849 (skip-chars-backward " \t")
2850 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2851 (get-text-property (point) 'first-format-line)))
2852
2853 ;; Look at previous line that's at column 0
2854 ;; to determine whether we are in top-level decls
2855 ;; or function's arg decls. Set basic-indent accordingly.
2856 ;; Now add a little if this is a continuation line.
2857 (and state
2858 parse-data
2859 (not (eq char-after ?\C-j))
2860 (setcdr (cddr parse-data)
2861 (list pre-indent-point)))
2862 (vector 'toplevel start char-after state (nth 2 s-s)))
2863 ((not
2864 (or (setq is-block
2865 (and (setq delim (= (char-after containing-sexp) ?{))
2866 (save-excursion ; Is it a hash?
2867 (goto-char containing-sexp)
2868 (cperl-block-p))))
2869 cperl-indent-parens-as-block))
2870 ;; group is an expression, not a block:
2871 ;; indent to just after the surrounding open parens,
2872 ;; skip blanks if we do not close the expression.
2873 (goto-char (1+ containing-sexp))
2874 (or (memq char-after
2875 (append (if delim "}" ")]}") nil))
2876 (looking-at "[ \t]*\\(#\\|$\\)")
2877 (skip-chars-forward " \t"))
2878 (setq old-indent (point)) ; delim=is-brace
2879 (vector 'in-parens char-after (point) delim containing-sexp))
2880 (t
2881 ;; Statement level. Is it a continuation or a new statement?
2882 ;; Find previous non-comment character.
2883 (goto-char pre-indent-point) ; Skip one level of POD/etc
2884 (cperl-backward-to-noncomment containing-sexp)
2885 ;; Back up over label lines, since they don't
2886 ;; affect whether our line is a continuation.
2887 ;; (Had \, too)
2888 (while;;(or (eq (preceding-char) ?\,)
2889 (and (eq (preceding-char) ?:)
2890 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2891 (memq (char-syntax (char-after (- (point) 2)))
2892 '(?w ?_))))
2893 ;;)
2894 ;; This is always FALSE?
2895 (if (eq (preceding-char) ?\,)
2896 ;; Will go to beginning of line, essentially.
2897 ;; Will ignore embedded sexpr XXXX.
2898 (cperl-backward-to-start-of-continued-exp containing-sexp))
2899 (beginning-of-line)
2900 (cperl-backward-to-noncomment containing-sexp))
2901 ;; Now we get non-label preceding the indent point
2902 (if (not (or (eq (1- (point)) containing-sexp)
2903 (memq (preceding-char)
2904 (append (if is-block " ;{" " ,;{") '(nil)))
2905 (and (eq (preceding-char) ?\})
2906 (cperl-after-block-and-statement-beg
2907 containing-sexp))
2908 (get-text-property (point) 'first-format-line)))
2909 ;; This line is continuation of preceding line's statement;
2910 ;; indent `cperl-continued-statement-offset' more than the
2911 ;; previous line of the statement.
2912 ;;
2913 ;; There might be a label on this line, just
2914 ;; consider it bad style and ignore it.
2915 (progn
2916 (cperl-backward-to-start-of-continued-exp containing-sexp)
2917 (vector 'continuation (point) char-after is-block delim))
2918 ;; This line starts a new statement.
2919 ;; Position following last unclosed open brace
2920 (goto-char containing-sexp)
2921 ;; Is line first statement after an open-brace?
2922 (or
2923 ;; If no, find that first statement and indent like
2924 ;; it. If the first statement begins with label, do
2925 ;; not believe when the indentation of the label is too
2926 ;; small.
2927 (save-excursion
2928 (forward-char 1)
2929 (let ((colon-line-end 0))
2930 (while
2931 (progn (skip-chars-forward " \t\n")
2932 ;; s: foo : bar :x is NOT label
2933 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2934 (not (looking-at "[sym]:\\|tr:"))))
2935 ;; Skip over comments and labels following openbrace.
2936 (cond ((= (following-char) ?\#)
2937 (forward-line 1))
2938 ((= (following-char) ?\=)
2939 (goto-char
2940 (or (next-single-property-change (point) 'in-pod)
2941 (point-max)))) ; do not loop if no syntaxification
2942 ;; label:
2943 (t
2944 (save-excursion (end-of-line)
2945 (setq colon-line-end (point)))
2946 (search-forward ":"))))
2947 ;; We are at beginning of code (NOT label or comment)
2948 ;; First, the following code counts
2949 ;; if it is before the line we want to indent.
2950 (and (< (point) indent-point)
2951 (vector 'have-prev-sibling (point) colon-line-end
2952 containing-sexp))))
2953 (progn
2954 ;; If no previous statement,
2955 ;; indent it relative to line brace is on.
2956
2957 ;; For open-braces not the first thing in a line,
2958 ;; add in cperl-brace-imaginary-offset.
2959
2960 ;; If first thing on a line: ?????
2961 ;; Move back over whitespace before the openbrace.
2962 (setq ; brace first thing on a line
2963 old-indent (progn (skip-chars-backward " \t") (bolp)))
2964 ;; Should we indent w.r.t. earlier than start?
2965 ;; Move to start of control group, possibly on a different line
2966 (or cperl-indent-wrt-brace
2967 (cperl-backward-to-noncomment (point-min)))
2968 ;; If the openbrace is preceded by a parenthesized exp,
2969 ;; move to the beginning of that;
2970 (if (eq (preceding-char) ?\))
2971 (progn
2972 (forward-sexp -1)
2973 (cperl-backward-to-noncomment (point-min))))
2974 ;; In the case it starts a subroutine, indent with
2975 ;; respect to `sub', not with respect to the
2976 ;; first thing on the line, say in the case of
2977 ;; anonymous sub in a hash.
2978 (if (and;; Is it a sub in group starting on this line?
2979 (cond ((get-text-property (point) 'attrib-group)
2980 (goto-char (cperl-beginning-of-property
2981 (point) 'attrib-group)))
2982 ((eq (preceding-char) ?b)
2983 (forward-sexp -1)
2984 (looking-at "sub\\>")))
2985 (setq p (nth 1 ; start of innermost containing list
2986 (parse-partial-sexp
2987 (save-excursion (beginning-of-line)
2988 (point))
2989 (point)))))
2990 (progn
2991 (goto-char (1+ p)) ; enclosing block on the same line
2992 (skip-chars-forward " \t")
2993 (vector 'code-start-in-block containing-sexp char-after
2994 (and delim (not is-block)) ; is a HASH
2995 old-indent ; brace first thing on a line
2996 t (point) ; have something before...
2997 )
2998 ;;(current-column)
2999 )
3000 ;; Get initial indentation of the line we are on.
3001 ;; If line starts with label, calculate label indentation
3002 (vector 'code-start-in-block containing-sexp char-after
3003 (and delim (not is-block)) ; is a HASH
3004 old-indent ; brace first thing on a line
3005 nil (point))))))))))))))) ; nothing interesting before
3006
3007 (defvar cperl-indent-rules-alist
3008 '((pod nil) ; via `syntax-type' property
3009 (here-doc nil) ; via `syntax-type' property
3010 (here-doc-delim nil) ; via `syntax-type' property
3011 (format nil) ; via `syntax-type' property
3012 (in-pod nil) ; via `in-pod' property
3013 (comment-special:at-beginning-of-line nil)
3014 (string t)
3015 (comment nil))
3016 "Alist of indentation rules for CPerl mode.
3017 The values mean:
3018 nil: do not indent;
3019 number: add this amount of indentation.")
3020
3021 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3022 "Return appropriate indentation for current line as Perl code.
3023 In usual case returns an integer: the column to indent to.
3024 Returns nil if line starts inside a string, t if in a comment.
3025
3026 Will not correct the indentation for labels, but will correct it for braces
3027 and closing parentheses and brackets."
3028 ;; This code is still a broken architecture: in some cases we need to
3029 ;; compensate for some modifications which `cperl-indent-line' will add later
3030 (save-excursion
3031 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3032 (cond
3033 ;;((or (null i) (eq i t) (numberp i))
3034 ;; i)
3035 ((vectorp i)
3036 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3037 (cond
3038 (what (cadr what)) ; Load from table
3039 ;;
3040 ;; Indenters for regular expressions with //x and qw()
3041 ;;
3042 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3043 (goto-char (elt i 1))
3044 (condition-case nil ; Use indentation of the 1st part
3045 (forward-sexp -1))
3046 (current-column))
3047 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3048 (cond ;;; [indentable terminator start-pos is-block]
3049 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3050 (goto-char (elt i 2)) ; After opening parens
3051 (1- (current-column)))
3052 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3053 (goto-char (elt i 2))
3054 (+ (or cperl-regexp-indent-step cperl-indent-level)
3055 -1
3056 (current-column)))
3057 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3058 ;; Indent as the level after closing parens
3059 (goto-char (elt i 2)) ; indent line
3060 (skip-chars-forward " \t)") ; Skip closing parens
3061 (setq p (point))
3062 (goto-char (elt i 3)) ; previous line
3063 (skip-chars-forward " \t)") ; Skip closing parens
3064 ;; Number of parens in between:
3065 (setq p (nth 0 (parse-partial-sexp (point) p))
3066 what (elt i 4)) ; First char on current line
3067 (goto-char (elt i 3)) ; previous line
3068 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3069 (cond ((eq what ?\) )
3070 (- cperl-close-paren-offset)) ; compensate
3071 ((eq what ?\| )
3072 (- (or cperl-regexp-indent-step cperl-indent-level)))
3073 (t 0))
3074 (if (eq (following-char) ?\| )
3075 (or cperl-regexp-indent-step cperl-indent-level)
3076 0)
3077 (current-column)))
3078 (t
3079 (error "Unrecognized value of indent: %s" i))))
3080 ;;
3081 ;; Indenter for stuff at toplevel
3082 ;;
3083 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3084 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3085 (goto-char (elt i 1)) ; start = Good place to start parsing
3086 (- (current-indentation) ;
3087 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3088 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3089 ;; Look at previous line that's at column 0
3090 ;; to determine whether we are in top-level decls
3091 ;; or function's arg decls. Set basic-indent accordingly.
3092 ;; Now add a little if this is a continuation line.
3093 (if (elt i 3) ; state (XXX What is the semantic???)
3094 0
3095 cperl-continued-statement-offset)))
3096 ;;
3097 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3098 ;;
3099 ((eq 'in-parens (elt i 0))
3100 ;; in-parens char-after old-indent-point is-brace containing-sexp
3101
3102 ;; group is an expression, not a block:
3103 ;; indent to just after the surrounding open parens,
3104 ;; skip blanks if we do not close the expression.
3105 (+ (progn
3106 (goto-char (elt i 2)) ; old-indent-point
3107 (current-column))
3108 (if (and (elt i 3) ; is-brace
3109 (eq (elt i 1) ?\})) ; char-after
3110 ;; Correct indentation of trailing ?\}
3111 (+ cperl-indent-level cperl-close-paren-offset)
3112 0)))
3113 ;;
3114 ;; Indenter for continuation lines
3115 ;;
3116 ((eq 'continuation (elt i 0))
3117 ;; [continuation statement-start char-after is-block is-brace]
3118 (goto-char (elt i 1)) ; statement-start
3119 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
3120 0 ; Closing parenth
3121 cperl-continued-statement-offset)
3122 (if (or (elt i 3) ; is-block
3123 (not (elt i 4)) ; is-brace
3124 (not (eq (elt i 2) ?\}))) ; char-after
3125 0
3126 ;; Now it is a hash reference
3127 (+ cperl-indent-level cperl-close-paren-offset))
3128 ;; Labels do not take :: ...
3129 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3130 (if (> (current-indentation) cperl-min-label-indent)
3131 (- (current-indentation) cperl-label-offset)
3132 ;; Do not move `parse-data', this should
3133 ;; be quick anyway (this comment comes
3134 ;; from different location):
3135 (cperl-calculate-indent))
3136 (current-column))
3137 (if (eq (elt i 2) ?\{) ; char-after
3138 cperl-continued-brace-offset 0)))
3139 ;;
3140 ;; Indenter for lines in a block which are not leading lines
3141 ;;
3142 ((eq 'have-prev-sibling (elt i 0))
3143 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
3144 (goto-char (elt i 1)) ; sibling-beg
3145 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
3146 (if (> (current-indentation)
3147 cperl-min-label-indent)
3148 (- (current-indentation) cperl-label-offset)
3149 ;; Do not believe: `max' was involved in calculation of indent
3150 (+ cperl-indent-level
3151 (save-excursion
3152 (goto-char (elt i 3)) ; block-start
3153 (current-indentation))))
3154 (current-column)))
3155 ;;
3156 ;; Indenter for the first line in a block
3157 ;;
3158 ((eq 'code-start-in-block (elt i 0))
3159 ;;[code-start-in-block before-brace char-after
3160 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3161 ;; group-starts-before-start-of-sub start-of-control-group]
3162 (goto-char (elt i 1))
3163 ;; For open brace in column zero, don't let statement
3164 ;; start there too. If cperl-indent-level=0,
3165 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3166 (+ (if (and (bolp) (zerop cperl-indent-level))
3167 (+ cperl-brace-offset cperl-continued-statement-offset)
3168 cperl-indent-level)
3169 (if (and (elt i 3) ; is-a-HASH-ref
3170 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3171 (+ cperl-indent-level cperl-close-paren-offset)
3172 0)
3173 ;; Unless openbrace is the first nonwhite thing on the line,
3174 ;; add the cperl-brace-imaginary-offset.
3175 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3176 cperl-brace-imaginary-offset)
3177 (progn
3178 (goto-char (elt i 6)) ; start-of-control-group
3179 (if (elt i 5) ; group-starts-before-start-of-sub
3180 (current-column)
3181 ;; Get initial indentation of the line we are on.
3182 ;; If line starts with label, calculate label indentation
3183 (if (save-excursion
3184 (beginning-of-line)
3185 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3186 (if (> (current-indentation) cperl-min-label-indent)
3187 (- (current-indentation) cperl-label-offset)
3188 ;; Do not move `parse-data', this should
3189 ;; be quick anyway:
3190 (cperl-calculate-indent))
3191 (current-indentation))))))
3192 (t
3193 (error "Unrecognized value of indent: %s" i))))
3194 (t
3195 (error "Got strange value of indent: %s" i))))))
3196
3197 (defun cperl-calculate-indent-within-comment ()
3198 "Return the indentation amount for line, assuming that
3199 the current line is to be regarded as part of a block comment."
3200 (let (end star-start)
3201 (save-excursion
3202 (beginning-of-line)
3203 (skip-chars-forward " \t")
3204 (setq end (point))
3205 (and (= (following-char) ?#)
3206 (forward-line -1)
3207 (cperl-to-comment-or-eol)
3208 (setq end (point)))
3209 (goto-char end)
3210 (current-column))))
3211
3212
3213 (defun cperl-to-comment-or-eol ()
3214 "Go to position before comment on the current line, or to end of line.
3215 Returns true if comment is found. In POD will not move the point."
3216 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3217 ;; then looks for literal # or end-of-line.
3218 (let (state stop-in cpoint (lim (progn (end-of-line) (point))) pr e)
3219 (or cperl-font-locking
3220 (cperl-update-syntaxification lim lim))
3221 (beginning-of-line)
3222 (if (setq pr (get-text-property (point) 'syntax-type))
3223 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3224 (if (or (eq pr 'pod)
3225 (if (or (not e) (> e lim)) ; deep inside a group
3226 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
3227 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
3228 ;; Else - need to do it the hard way
3229 (and (and e (<= e lim))
3230 (goto-char e))
3231 (while (not stop-in)
3232 (setq state (parse-partial-sexp (point) lim nil nil nil t))
3233 ; stop at comment
3234 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3235 (if (nth 4 state) ; After `#';
3236 ; (nth 2 state) can be
3237 ; beginning of m,s,qq and so
3238 ; on
3239 (if (nth 2 state)
3240 (progn
3241 (setq cpoint (point))
3242 (goto-char (nth 2 state))
3243 (cond
3244 ((looking-at "\\(s\\|tr\\)\\>")
3245 (or (re-search-forward
3246 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3247 lim 'move)
3248 (setq stop-in t)))
3249 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3250 (or (re-search-forward
3251 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3252 lim 'move)
3253 (setq stop-in t)))
3254 (t ; It was fair comment
3255 (setq stop-in t) ; Finish
3256 (goto-char (1- cpoint)))))
3257 (setq stop-in t) ; Finish
3258 (forward-char -1))
3259 (setq stop-in t))) ; Finish
3260 (nth 4 state))))
3261
3262 (defsubst cperl-modify-syntax-type (at how)
3263 (if (< at (point-max))
3264 (progn
3265 (put-text-property at (1+ at) 'syntax-table how)
3266 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
3267
3268 (defun cperl-protect-defun-start (s e)
3269 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3270 (save-excursion
3271 (goto-char s)
3272 (while (re-search-forward "^\\s(" e 'to-end)
3273 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3274
3275 (defun cperl-commentify (bb e string &optional noface)
3276 (if cperl-use-syntax-table-text-property
3277 (if (eq noface 'n) ; Only immediate
3278 nil
3279 ;; We suppose that e is _after_ the end of construction, as after eol.
3280 (setq string (if string cperl-st-sfence cperl-st-cfence))
3281 (if (> bb (- e 2))
3282 ;; one-char string/comment?!
3283 (cperl-modify-syntax-type bb cperl-st-punct)
3284 (cperl-modify-syntax-type bb string)
3285 (cperl-modify-syntax-type (1- e) string))
3286 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
3287 (put-text-property (1+ bb) (1- e)
3288 'syntax-table cperl-string-syntax-table))
3289 (cperl-protect-defun-start bb e))
3290 ;; Fontify
3291 (or noface
3292 (not cperl-pod-here-fontify)
3293 (put-text-property bb e 'face (if string 'font-lock-string-face
3294 'font-lock-comment-face)))))
3295
3296 (defvar cperl-starters '(( ?\( . ?\) )
3297 ( ?\[ . ?\] )
3298 ( ?\{ . ?\} )
3299 ( ?\< . ?\> )))
3300
3301 (defun cperl-cached-syntax-table (st)
3302 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3303 All the entries of the syntax table are \".\", except for a backslash, which
3304 is quoting."
3305 (if (car-safe st)
3306 (car st)
3307 (setcar st (make-syntax-table))
3308 (setq st (car st))
3309 (let ((i 0))
3310 (while (< i 256)
3311 (modify-syntax-entry i "." st)
3312 (setq i (1+ i))))
3313 (modify-syntax-entry ?\\ "\\" st)
3314 st))
3315
3316 (defun cperl-forward-re (lim end is-2arg st-l err-l argument
3317 &optional ostart oend)
3318 "Find the end of a regular expression or a stringish construct (q[] etc).
3319 The point should be before the starting delimiter.
3320
3321 Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3322 is s/// or tr/// like expression. If END is nil, generates an error
3323 message if needed. If SET-ST is non-nil, will use (or generate) a
3324 cached syntax table in ST-L. If ERR-L is non-nil, will store the
3325 error message in its CAR (unless it already contains some error
3326 message). ARGUMENT should be the name of the construct (used in error
3327 messages). OSTART, OEND may be set in recursive calls when processing
3328 the second argument of 2ARG construct.
3329
3330 Works *before* syntax recognition is done. In IS-2ARG situation may
3331 modify syntax-type text property if the situation is too hard."
3332 (let (b starter ender st i i2 go-forward reset-st set-st)
3333 (skip-chars-forward " \t")
3334 ;; ender means matching-char matcher.
3335 (setq b (point)
3336 starter (if (eobp) 0 (char-after b))
3337 ender (cdr (assoc starter cperl-starters)))
3338 ;; What if starter == ?\\ ????
3339 (setq st (cperl-cached-syntax-table st-l))
3340 (setq set-st t)
3341 ;; Whether we have an intermediate point
3342 (setq i nil)
3343 ;; Prepare the syntax table:
3344 (if (not ender) ; m/blah/, s/x//, s/x/y/
3345 (modify-syntax-entry starter "$" st)
3346 (modify-syntax-entry starter (concat "(" (list ender)) st)
3347 (modify-syntax-entry ender (concat ")" (list starter)) st))
3348 (condition-case bb
3349 (progn
3350 ;; We use `$' syntax class to find matching stuff, but $$
3351 ;; is recognized the same as $, so we need to check this manually.
3352 (if (and (eq starter (char-after (cperl-1+ b)))
3353 (not ender))
3354 ;; $ has TeXish matching rules, so $$ equiv $...
3355 (forward-char 2)
3356 (setq reset-st (syntax-table))
3357 (set-syntax-table st)
3358 (forward-sexp 1)
3359 (if (<= (point) (1+ b))
3360 (error "Unfinished regular expression"))
3361 (set-syntax-table reset-st)
3362 (setq reset-st nil)
3363 ;; Now the problem is with m;blah;;
3364 (and (not ender)
3365 (eq (preceding-char)
3366 (char-after (- (point) 2)))
3367 (save-excursion
3368 (forward-char -2)
3369 (= 0 (% (skip-chars-backward "\\\\") 2)))
3370 (forward-char -1)))
3371 ;; Now we are after the first part.
3372 (and is-2arg ; Have trailing part
3373 (not ender)
3374 (eq (following-char) starter) ; Empty trailing part
3375 (progn
3376 (or (eq (char-syntax (following-char)) ?.)
3377 ;; Make trailing letter into punctuation
3378 (cperl-modify-syntax-type (point) cperl-st-punct))
3379 (setq is-2arg nil go-forward t))) ; Ignore the tail
3380 (if is-2arg ; Not number => have second part
3381 (progn
3382 (setq i (point) i2 i)
3383 (if ender
3384 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
3385 (progn
3386 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3387 (goto-char (match-end 0))
3388 (skip-chars-forward " \t\n\f"))
3389 (setq i2 (point))))
3390 (forward-char -1))
3391 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3392 (if ender (modify-syntax-entry ender "." st))
3393 (setq set-st nil)
3394 (setq ender (cperl-forward-re lim end nil st-l err-l
3395 argument starter ender)
3396 ender (nth 2 ender)))))
3397 (error (goto-char lim)
3398 (setq set-st nil)
3399 (if reset-st
3400 (set-syntax-table reset-st))
3401 (or end
3402 (and cperl-brace-recursing
3403 (or (eq ostart ?\{)
3404 (eq starter ?\{)))
3405 (message
3406 "End of `%s%s%c ... %c' string/RE not found: %s"
3407 argument
3408 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3409 starter (or ender starter) bb)
3410 (or (car err-l) (setcar err-l b)))))
3411 (if set-st
3412 (progn
3413 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3414 (if ender (modify-syntax-entry ender "." st))))
3415 ;; i: have 2 args, after end of the first arg
3416 ;; i2: start of the second arg, if any (before delim if `ender').
3417 ;; ender: the last arg bounded by parens-like chars, the second one of them
3418 ;; starter: the starting delimiter of the first arg
3419 ;; go-forward: has 2 args, and the second part is empty
3420 (list i i2 ender starter go-forward)))
3421
3422 (defun cperl-forward-group-in-re (&optional st-l)
3423 "Find the end of a group in a REx.
3424 Return the error message (if any). Does not work if delimiter is `)'.
3425 Works before syntax recognition is done."
3426 ;; Works *before* syntax recognition is done
3427 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3428 (let (st b reset-st)
3429 (condition-case b
3430 (progn
3431 (setq st (cperl-cached-syntax-table st-l))
3432 (modify-syntax-entry ?\( "()" st)
3433 (modify-syntax-entry ?\) ")(" st)
3434 (setq reset-st (syntax-table))
3435 (set-syntax-table st)
3436 (forward-sexp 1))
3437 (error (message
3438 "cperl-forward-group-in-re: error %s" b)))
3439 ;; now restore the initial state
3440 (if st
3441 (progn
3442 (modify-syntax-entry ?\( "." st)
3443 (modify-syntax-entry ?\) "." st)))
3444 (if reset-st
3445 (set-syntax-table reset-st))
3446 b))
3447
3448
3449 (defvar font-lock-string-face)
3450 ;;(defvar font-lock-reference-face)
3451 (defvar font-lock-constant-face)
3452 (defsubst cperl-postpone-fontification (b e type val &optional now)
3453 ;; Do after syntactic fontification?
3454 (if cperl-syntaxify-by-font-lock
3455 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3456 (put-text-property b e type val)))
3457
3458 ;;; Here is how the global structures (those which cannot be
3459 ;;; recognized locally) are marked:
3460 ;; a) PODs:
3461 ;; Start-to-end is marked `in-pod' ==> t
3462 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3463 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3464 ;; b) HEREs:
3465 ;; Start-to-end is marked `here-doc-group' ==> t
3466 ;; The body is marked `syntax-type' ==> `here-doc'
3467 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3468 ;; c) FORMATs:
3469 ;; First line (to =) marked `first-format-line' ==> t
3470 ;; After-this--to-end is marked `syntax-type' ==> `format'
3471 ;; d) 'Q'uoted string:
3472 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3473 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3474 ;; second part of s///e is marked `syntax-type' ==> `multiline'
3475 ;; e) Attributes of subroutines: `attrib-group' ==> t
3476 ;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3477 ;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3478
3479 ;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3480 ;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
3481
3482 (defun cperl-unwind-to-safe (before &optional end)
3483 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3484 (let ((pos (point)) opos)
3485 (while (and pos (progn
3486 (beginning-of-line)
3487 (get-text-property (setq pos (point)) 'syntax-type)))
3488 (setq opos pos
3489 pos (cperl-beginning-of-property pos 'syntax-type))
3490 (if (eq pos (point-min))
3491 (setq pos nil))
3492 (if pos
3493 (if before
3494 (progn
3495 (goto-char (cperl-1- pos))
3496 (beginning-of-line)
3497 (setq pos (point)))
3498 (goto-char (setq pos (cperl-1- pos))))
3499 ;; Up to the start
3500 (goto-char (point-min))))
3501 ;; Skip empty lines
3502 (and (looking-at "\n*=")
3503 (/= 0 (skip-chars-backward "\n"))
3504 (forward-char))
3505 (setq pos (point))
3506 (if end
3507 ;; Do the same for end, going small steps
3508 (save-excursion
3509 (while (and end (get-text-property end 'syntax-type))
3510 (setq pos end
3511 end (next-single-property-change end 'syntax-type nil (point-max)))
3512 (if end (progn (goto-char end)
3513 (or (bolp) (forward-line 1))
3514 (setq end (point)))))
3515 (or end pos)))))
3516
3517 ;;; These are needed for byte-compile (at least with v19)
3518 (defvar cperl-nonoverridable-face)
3519 (defvar font-lock-variable-name-face)
3520 (defvar font-lock-function-name-face)
3521 (defvar font-lock-keyword-face)
3522 (defvar font-lock-builtin-face)
3523 (defvar font-lock-type-face)
3524 (defvar font-lock-comment-face)
3525 (defvar font-lock-warning-face)
3526
3527 (defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3528 "Syntaxically mark (and fontify) attributes of a subroutine.
3529 Should be called with the point before leading colon of an attribute."
3530 ;; Works *before* syntax recognition is done
3531 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3532 (let (st b p reset-st after-first (start (point)) start1 end1)
3533 (condition-case b
3534 (while (looking-at
3535 (concat
3536 "\\(" ; 1=optional? colon
3537 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3538 "\\)"
3539 (if after-first "?" "")
3540 ;; No space between name and paren allowed...
3541 "\\(\\sw+\\)" ; 3=name
3542 "\\((\\)?")) ; 4=optional paren
3543 (and (match-beginning 1)
3544 (cperl-postpone-fontification
3545 (match-beginning 0) (cperl-1+ (match-beginning 0))
3546 'face font-lock-constant-face))
3547 (setq start1 (match-beginning 3) end1 (match-end 3))
3548 (cperl-postpone-fontification start1 end1
3549 'face font-lock-constant-face)
3550 (goto-char end1) ; end or before `('
3551 (if (match-end 4) ; Have attribute arguments...
3552 (progn
3553 (if st nil
3554 (setq st (cperl-cached-syntax-table st-l))
3555 (modify-syntax-entry ?\( "()" st)
3556 (modify-syntax-entry ?\) ")(" st))
3557 (setq reset-st (syntax-table) p (point))
3558 (set-syntax-table st)
3559 (forward-sexp 1)
3560 (set-syntax-table reset-st)
3561 (setq reset-st nil)
3562 (cperl-commentify p (point) t))) ; mark as string
3563 (forward-comment (buffer-size))
3564 (setq after-first t))
3565 (error (message
3566 "L%d: attribute `%s': %s"
3567 (count-lines (point-min) (point))
3568 (and start1 end1 (buffer-substring start1 end1)) b)
3569 (setq start nil)))
3570 (and start
3571 (progn
3572 (put-text-property start (point)
3573 'attrib-group (if (looking-at "{") t 0))
3574 (and pos
3575 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3576 ;; Apparently, we do not need `multiline': faces added now
3577 (put-text-property (+ 3 pos) (cperl-1+ (point))
3578 'syntax-type 'sub-decl))
3579 (and b-fname ; Fontify here: the following condition
3580 (cperl-postpone-fontification ; is too hard to determine by
3581 b-fname e-fname 'face ; a REx, so do it here
3582 (if (looking-at "{")
3583 font-lock-function-name-face
3584 font-lock-variable-name-face)))))
3585 ;; now restore the initial state
3586 (if st
3587 (progn
3588 (modify-syntax-entry ?\( "." st)
3589 (modify-syntax-entry ?\) "." st)))
3590 (if reset-st
3591 (set-syntax-table reset-st))))
3592
3593 (defsubst cperl-look-at-leading-count (is-x-REx e)
3594 (if (and
3595 (< (point) e)
3596 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3597 (1- e) t)) ; return nil on failure, no moving
3598 (if (eq ?\{ (preceding-char)) nil
3599 (cperl-postpone-fontification
3600 (1- (point)) (point)
3601 'face font-lock-warning-face))))
3602
3603 ;; Do some smarter-highlighting
3604 ;; XXXX Currently ignores alphanum/dash delims,
3605 (defsubst cperl-highlight-charclass (endbracket dashface bsface onec-space)
3606 (let ((l '(1 5 7)) ll lle lll
3607 ;; 2 groups, the first takes the whole match (include \[trnfabe])
3608 (singleChar (concat "\\(" "[^\\\\]" "\\|" "\\\\[^cdg-mo-qsu-zA-Z0-9_]" "\\|" "\\\\c." "\\|" "\\\\x" "\\([0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}\\)" "\\|" "\\\\0?[0-7][0-7]?[0-7]?" "\\|" "\\\\N{[^{}]*}" "\\)")))
3609 (while ; look for unescaped - between non-classes
3610 (re-search-forward
3611 ;; On 19.33, certain simplifications lead
3612 ;; to bugs (as in [^a-z] \\| [trnfabe] )
3613 (concat ; 1: SingleChar (include \[trnfabe])
3614 singleChar
3615 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^cdg-mo-qsu-zA-Z0-9_]" "\\|" "\\\\c." "\\|" "\\\\x" "\\([0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}\\)" "\\|" "\\\\0?[0-7][0-7]?[0-7]?" "\\|" "\\\\N{[^{}]*}" "\\)"
3616 "\\(" ; 3: DASH SingleChar (match optionally)
3617 "\\(-\\)" ; 4: DASH
3618 singleChar ; 5: SingleChar
3619 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^cdg-mo-qsu-zA-Z0-9_]" "\\|" "\\\\c." "\\|" "\\\\x" "\\([0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}\\)" "\\|" "\\\\0?[0-7][0-7]?[0-7]?" "\\|" "\\\\N{[^{}]*}" "\\)"
3620 "\\)?"
3621 "\\|"
3622 "\\(" ; 7: other escapes
3623 "\\\\[pP]" "\\([^{]\\|{[^{}]*}\\)"
3624 "\\|" "\\\\[^pP]" "\\)"
3625 )
3626 endbracket 'toend)
3627 (if (match-beginning 4)
3628 (cperl-postpone-fontification
3629 (match-beginning 4) (match-end 4)
3630 'face dashface))
3631 ;; save match data (for looking-at)
3632 (setq lll (mapcar (function (lambda (elt) (cons (match-beginning elt)
3633 (match-end elt)))) l))
3634 (while lll
3635 (setq ll (car lll))
3636 (setq lle (cdr ll)
3637 ll (car ll))
3638 ;; (message "Got %s of %s" ll l)
3639 (if (and ll (eq (char-after ll) ?\\ ))
3640 (save-excursion
3641 (goto-char ll)
3642 (cperl-postpone-fontification ll (1+ ll)
3643 'face bsface)
3644 (if (looking-at "\\\\[a-zA-Z0-9]")
3645 (cperl-postpone-fontification (1+ ll) lle
3646 'face onec-space))))
3647 (setq lll (cdr lll))))
3648 (goto-char endbracket) ; just in case something misbehaves???
3649 t))
3650
3651 ;;; Debugging this may require (setq max-specpdl-size 2000)...
3652 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
3653 "Scans the buffer for hard-to-parse Perl constructions.
3654 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3655 the sections using `cperl-pod-head-face', `cperl-pod-face',
3656 `cperl-here-face'."
3657 (interactive)
3658 (or min (setq min (point-min)
3659 cperl-syntax-state nil
3660 cperl-syntax-done-to min))
3661 (or max (setq max (point-max)))
3662 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3663 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3664 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
3665 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3666 (modified (buffer-modified-p)) overshoot is-o-REx name
3667 (after-change-functions nil)
3668 (cperl-font-locking t)
3669 (use-syntax-state (and cperl-syntax-state
3670 (>= min (car cperl-syntax-state))))
3671 (state-point (if use-syntax-state
3672 (car cperl-syntax-state)
3673 (point-min)))
3674 (state (if use-syntax-state
3675 (cdr cperl-syntax-state)))
3676 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3677 (st-l (list nil)) (err-l (list nil))
3678 ;; Somehow font-lock may be not loaded yet...
3679 ;; (e.g., when building TAGS via command-line call)
3680 (font-lock-string-face (if (boundp 'font-lock-string-face)
3681 font-lock-string-face
3682 'font-lock-string-face))
3683 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
3684 font-lock-constant-face
3685 'font-lock-constant-face))
3686 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
3687 (if (boundp 'font-lock-function-name-face)
3688 font-lock-function-name-face
3689 'font-lock-function-name-face))
3690 (font-lock-variable-name-face ; interpolated vars and ({})-code
3691 (if (boundp 'font-lock-variable-name-face)
3692 font-lock-variable-name-face
3693 'font-lock-variable-name-face))
3694 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3695 (if (boundp 'font-lock-function-name-face)
3696 font-lock-function-name-face
3697 'font-lock-function-name-face))
3698 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3699 (if (boundp 'font-lock-constant-face)
3700 font-lock-constant-face
3701 'font-lock-constant-face))
3702 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3703 (if (boundp 'font-lock-builtin-face)
3704 font-lock-builtin-face
3705 'font-lock-builtin-face))
3706 (font-lock-comment-face
3707 (if (boundp 'font-lock-comment-face)
3708 font-lock-comment-face
3709 'font-lock-comment-face))
3710 (font-lock-warning-face
3711 (if (boundp 'font-lock-warning-face)
3712 font-lock-warning-face
3713 'font-lock-warning-face))
3714 (my-cperl-REx-ctl-face ; (|)
3715 (if (boundp 'font-lock-keyword-face)
3716 font-lock-keyword-face
3717 'font-lock-keyword-face))
3718 (my-cperl-REx-modifiers-face ; //gims
3719 (if (boundp 'cperl-nonoverridable-face)
3720 cperl-nonoverridable-face
3721 'cperl-nonoverridable-face))
3722 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3723 (if (boundp 'font-lock-type-face)
3724 font-lock-type-face
3725 'font-lock-type-face))
3726 (stop-point (if ignore-max
3727 (point-max)
3728 max))
3729 (search
3730 (concat
3731 "\\(\\`\n?\\|^\n\\)=" ; POD
3732 "\\|"
3733 ;; One extra () before this:
3734 "<<" ; HERE-DOC
3735 "\\(" ; 1 + 1
3736 ;; First variant "BLAH" or just ``.
3737 "[ \t]*" ; Yes, whitespace is allowed!
3738 "\\([\"'`]\\)" ; 2 + 1 = 3
3739 "\\([^\"'`\n]*\\)" ; 3 + 1
3740 "\\3"
3741 "\\|"
3742 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3743 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3744 ;; Do not have <<= or << 30 or <<30 or << $blah.
3745 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3746 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3747 "\\)"
3748 "\\|"
3749 ;; 1+6 extra () before this:
3750 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
3751 (if cperl-use-syntax-table-text-property
3752 (concat
3753 "\\|"
3754 ;; 1+6+2=9 extra () before this:
3755 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
3756 "\\|"
3757 ;; 1+6+2+1=10 extra () before this:
3758 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3759 "\\|"
3760 ;; 1+6+2+1+1=11 extra () before this
3761 "\\<sub\\>" ; sub with proto/attr
3762 "\\("
3763 cperl-white-and-comment-rex
3764 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3765 "\\("
3766 cperl-maybe-white-and-comment-rex
3767 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
3768 "\\|"
3769 ;; 1+6+2+1+1+6=17 extra () before this:
3770 "\\$\\(['{]\\)" ; $' or ${foo}
3771 "\\|"
3772 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3773 ;; we do not support intervening comments...):
3774 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3775 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
3776 "\\|"
3777 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3778 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
3779 "\\|"
3780 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
3781 ""))))
3782 (unwind-protect
3783 (progn
3784 (save-excursion
3785 (or non-inter
3786 (message "Scanning for \"hard\" Perl constructions..."))
3787 ;;(message "find: %s --> %s" min max)
3788 (and cperl-pod-here-fontify
3789 ;; We had evals here, do not know why...
3790 (setq face cperl-pod-face
3791 head-face cperl-pod-head-face
3792 here-face cperl-here-face))
3793 (remove-text-properties min max
3794 '(syntax-type t in-pod t syntax-table t
3795 attrib-group t
3796 REx-interpolated t
3797 cperl-postpone t
3798 syntax-subtype t
3799 rear-nonsticky t
3800 front-sticky t
3801 here-doc-group t
3802 first-format-line t
3803 REx-part2 t
3804 indentable t))
3805 ;; Need to remove face as well...
3806 (goto-char min)
3807 (and (eq system-type 'emx)
3808 (eq (point) 1)
3809 (let ((case-fold-search t))
3810 (looking-at "extproc[ \t]")) ; Analogue of #!
3811 (cperl-commentify min
3812 (save-excursion (end-of-line) (point))
3813 nil))
3814 (while (and
3815 (< (point) max)
3816 (re-search-forward search max t))
3817 (setq tmpend nil) ; Valid for most cases
3818 (setq b (match-beginning 0)
3819 state (save-excursion (parse-partial-sexp
3820 state-point b nil nil state))
3821 state-point b)
3822 (cond
3823 ;; 1+6+2+1+1+6=17 extra () before this:
3824 ;; "\\$\\(['{]\\)"
3825 ((match-beginning 18) ; $' or ${foo}
3826 (if (eq (preceding-char) ?\') ; $'
3827 (progn
3828 (setq b (1- (point))
3829 state (parse-partial-sexp
3830 state-point (1- b) nil nil state)
3831 state-point (1- b))
3832 (if (nth 3 state) ; in string
3833 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3834 (goto-char (1+ b)))
3835 ;; else: ${
3836 (setq bb (match-beginning 0))
3837 (cperl-modify-syntax-type bb cperl-st-punct)))
3838 ;; No processing in strings/comments beyond this point:
3839 ((or (nth 3 state) (nth 4 state))
3840 t) ; Do nothing in comment/string
3841 ((match-beginning 1) ; POD section
3842 ;; "\\(\\`\n?\\|^\n\\)="
3843 (setq b (match-beginning 0)
3844 state (parse-partial-sexp
3845 state-point b nil nil state)
3846 state-point b)
3847 (if (or (nth 3 state) (nth 4 state)
3848 (looking-at "cut\\>"))
3849 (if (or (nth 3 state) (nth 4 state) ignore-max)
3850 nil ; Doing a chunk only
3851 (message "=cut is not preceded by a POD section")
3852 (or (car err-l) (setcar err-l (point))))
3853 (beginning-of-line)
3854
3855 (setq b (point)
3856 bb b
3857 tb (match-beginning 0)
3858 b1 nil) ; error condition
3859 ;; We do not search to max, since we may be called from
3860 ;; some hook of fontification, and max is random
3861 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3862 (progn
3863 (goto-char b)
3864 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3865 (progn
3866 (message "=cut is not preceded by an empty line")
3867 (setq b1 t)
3868 (or (car err-l) (setcar err-l b))))))
3869 (beginning-of-line 2) ; An empty line after =cut is not POD!
3870 (setq e (point))
3871 (and (> e max)
3872 (progn
3873 (remove-text-properties
3874 max e '(syntax-type t in-pod t syntax-table t
3875 attrib-group t
3876 REx-interpolated t
3877 cperl-postpone t
3878 syntax-subtype t
3879 here-doc-group t
3880 rear-nonsticky t
3881 front-sticky t
3882 first-format-line t
3883 REx-part2 t
3884 indentable t))
3885 (setq tmpend tb)))
3886 (put-text-property b e 'in-pod t)
3887 (put-text-property b e 'syntax-type 'in-pod)
3888 (goto-char b)
3889 (while (re-search-forward "\n\n[ \t]" e t)
3890 ;; We start 'pod 1 char earlier to include the preceding line
3891 (beginning-of-line)
3892 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3893 (cperl-put-do-not-fontify b (point) t)
3894 ;; mark the non-literal parts as PODs
3895 (if cperl-pod-here-fontify
3896 (cperl-postpone-fontification b (point) 'face face t))
3897 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3898 (beginning-of-line)
3899 (setq b (point)))
3900 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3901 (cperl-put-do-not-fontify (point) e t)
3902 (if cperl-pod-here-fontify
3903 (progn
3904 ;; mark the non-literal parts as PODs
3905 (cperl-postpone-fontification (point) e 'face face t)
3906 (goto-char bb)
3907 (if (looking-at
3908 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3909 ;; mark the headers
3910 (cperl-postpone-fontification
3911 (match-beginning 1) (match-end 1)
3912 'face head-face))
3913 (while (re-search-forward
3914 ;; One paragraph
3915 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3916 e 'toend)
3917 ;; mark the headers
3918 (cperl-postpone-fontification
3919 (match-beginning 1) (match-end 1)
3920 'face head-face))))
3921 (cperl-commentify bb e nil)
3922 (goto-char e)
3923 (or (eq e (point-max))
3924 (forward-char -1)))) ; Prepare for immediate POD start.
3925 ;; Here document
3926 ;; We can do many here-per-line;
3927 ;; but multiline quote on the same line as <<HERE confuses us...
3928 ;; ;; One extra () before this:
3929 ;;"<<"
3930 ;; "\\(" ; 1 + 1
3931 ;; ;; First variant "BLAH" or just ``.
3932 ;; "[ \t]*" ; Yes, whitespace is allowed!
3933 ;; "\\([\"'`]\\)" ; 2 + 1
3934 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3935 ;; "\\3"
3936 ;; "\\|"
3937 ;; ;; Second variant: Identifier or \ID or empty
3938 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3939 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3940 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3941 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3942 ;; "\\)"
3943 ((match-beginning 2) ; 1 + 1
3944 (setq b (point)
3945 tb (match-beginning 0)
3946 c (and ; not HERE-DOC
3947 (match-beginning 5)
3948 (save-match-data
3949 (or (looking-at "[ \t]*(") ; << function_call()
3950 (save-excursion ; 1 << func_name, or $foo << 10
3951 (condition-case nil
3952 (progn
3953 (goto-char tb)
3954 ;;; XXX What to do: foo <<bar ???
3955 ;;; XXX Need to support print {a} <<B ???
3956 (forward-sexp -1)
3957 (save-match-data
3958 ; $foo << b; $f .= <<B;
3959 ; ($f+1) << b; a($f) . <<B;
3960 ; foo 1, <<B; $x{a} <<b;
3961 (cond
3962 ((looking-at "[0-9$({]")
3963 (forward-sexp 1)
3964 (and
3965 (looking-at "[ \t]*<<")
3966 (condition-case nil
3967 ;; print $foo <<EOF
3968 (progn
3969 (forward-sexp -2)
3970 (not
3971 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
3972 (error t)))))))
3973 (error nil))) ; func(<<EOF)
3974 (and (not (match-beginning 6)) ; Empty
3975 (looking-at
3976 "[ \t]*[=0-9$@%&(]"))))))
3977 (if c ; Not here-doc
3978 nil ; Skip it.
3979 (setq c (match-end 2)) ; 1 + 1
3980 (if (match-beginning 5) ;4 + 1
3981 (setq b1 (match-beginning 5) ; 4 + 1
3982 e1 (match-end 5)) ; 4 + 1
3983 (setq b1 (match-beginning 4) ; 3 + 1
3984 e1 (match-end 4))) ; 3 + 1
3985 (setq tag (buffer-substring b1 e1)
3986 qtag (regexp-quote tag))
3987 (cond (cperl-pod-here-fontify
3988 ;; Highlight the starting delimiter
3989 (cperl-postpone-fontification
3990 b1 e1 'face my-cperl-delimiters-face)
3991 (cperl-put-do-not-fontify b1 e1 t)))
3992 (forward-line)
3993 (setq i (point))
3994 (if end-of-here-doc
3995 (goto-char end-of-here-doc))
3996 (setq b (point))
3997 ;; We do not search to max, since we may be called from
3998 ;; some hook of fontification, and max is random
3999 (or (and (re-search-forward (concat "^" qtag "$")
4000 stop-point 'toend)
4001 ;;;(eq (following-char) ?\n) ; XXXX WHY???
4002 )
4003 (progn ; Pretend we matched at the end
4004 (goto-char (point-max))
4005 (re-search-forward "\\'")
4006 (message "End of here-document `%s' not found." tag)
4007 (or (car err-l) (setcar err-l b))))
4008 (if cperl-pod-here-fontify
4009 (progn
4010 ;; Highlight the ending delimiter
4011 (cperl-postpone-fontification
4012 (match-beginning 0) (match-end 0)
4013 'face my-cperl-delimiters-face)
4014 (cperl-put-do-not-fontify b (match-end 0) t)
4015 ;; Highlight the HERE-DOC
4016 (cperl-postpone-fontification b (match-beginning 0)
4017 'face here-face)))
4018 (setq e1 (cperl-1+ (match-end 0)))
4019 (put-text-property b (match-beginning 0)
4020 'syntax-type 'here-doc)
4021 (put-text-property (match-beginning 0) e1
4022 'syntax-type 'here-doc-delim)
4023 (put-text-property b e1 'here-doc-group t)
4024 ;; This makes insertion at the start of HERE-DOC update
4025 ;; the whole construct:
4026 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
4027 (cperl-commentify b e1 nil)
4028 (cperl-put-do-not-fontify b (match-end 0) t)
4029 ;; Cache the syntax info...
4030 (setq cperl-syntax-state (cons state-point state))
4031 ;; ... and process the rest of the line...
4032 (setq overshoot
4033 (elt ; non-inter ignore-max
4034 (cperl-find-pods-heres c i t end t e1) 1))
4035 (if (and overshoot (> overshoot (point)))
4036 (goto-char overshoot)
4037 (setq overshoot e1))
4038 (if (> e1 max)
4039 (setq tmpend tb))))
4040 ;; format
4041 ((match-beginning 8)
4042 ;; 1+6=7 extra () before this:
4043 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4044 (setq b (point)
4045 name (if (match-beginning 8) ; 7 + 1
4046 (buffer-substring (match-beginning 8) ; 7 + 1
4047 (match-end 8)) ; 7 + 1
4048 "")
4049 tb (match-beginning 0))
4050 (setq argument nil)
4051 (put-text-property (save-excursion
4052 (beginning-of-line)
4053 (point))
4054 b 'first-format-line 't)
4055 (if cperl-pod-here-fontify
4056 (while (and (eq (forward-line) 0)
4057 (not (looking-at "^[.;]$")))
4058 (cond
4059 ((looking-at "^#")) ; Skip comments
4060 ((and argument ; Skip argument multi-lines
4061 (looking-at "^[ \t]*{"))
4062 (forward-sexp 1)
4063 (setq argument nil))
4064 (argument ; Skip argument lines
4065 (setq argument nil))
4066 (t ; Format line
4067 (setq b1 (point))
4068 (setq argument (looking-at "^[^\n]*[@^]"))
4069 (end-of-line)
4070 ;; Highlight the format line
4071 (cperl-postpone-fontification b1 (point)
4072 'face font-lock-string-face)
4073 (cperl-commentify b1 (point) nil)
4074 (cperl-put-do-not-fontify b1 (point) t))))
4075 ;; We do not search to max, since we may be called from
4076 ;; some hook of fontification, and max is random
4077 (re-search-forward "^[.;]$" stop-point 'toend))
4078 (beginning-of-line)
4079 (if (looking-at "^\\.$") ; ";" is not supported yet
4080 (progn
4081 ;; Highlight the ending delimiter
4082 (cperl-postpone-fontification (point) (+ (point) 2)
4083 'face font-lock-string-face)
4084 (cperl-commentify (point) (+ (point) 2) nil)
4085 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
4086 (message "End of format `%s' not found." name)
4087 (or (car err-l) (setcar err-l b)))
4088 (forward-line)
4089 (if (> (point) max)
4090 (setq tmpend tb))
4091 (put-text-property b (point) 'syntax-type 'format))
4092 ;; qq-like String or Regexp:
4093 ((or (match-beginning 10) (match-beginning 11))
4094 ;; 1+6+2=9 extra () before this:
4095 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
4096 ;; "\\|"
4097 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
4098 (setq b1 (if (match-beginning 10) 10 11)
4099 argument (buffer-substring
4100 (match-beginning b1) (match-end b1))
4101 b (point) ; end of qq etc
4102 i b
4103 c (char-after (match-beginning b1))
4104 bb (char-after (1- (match-beginning b1))) ; tmp holder
4105 ;; bb == "Not a stringy"
4106 bb (if (eq b1 10) ; user variables/whatever
4107 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4108 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4109 ((eq bb ?\:) ; $opt::s
4110 (eq (char-after
4111 (- (match-beginning b1) 2))
4112 ?\:))
4113 ((eq bb ?\>) ; $foo->s
4114 (eq (char-after
4115 (- (match-beginning b1) 2))
4116 ?\-))
4117 ((eq bb ?\&)
4118 (not (eq (char-after ; &&m/blah/
4119 (- (match-beginning b1) 2))
4120 ?\&)))
4121 (t t)))
4122 ;; <file> or <$file>
4123 (and (eq c ?\<)
4124 ;; Do not stringify <FH>, <$fh> :
4125 (save-match-data
4126 (looking-at
4127 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
4128 tb (match-beginning 0))
4129 (goto-char (match-beginning b1))
4130 (cperl-backward-to-noncomment (point-min))
4131 (or bb
4132 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
4133 (setq argument ""
4134 b1 nil
4135 bb ; Not a regexp?
4136 (not
4137 ;; What is below: regexp-p?
4138 (and
4139 (or (memq (preceding-char)
4140 (append (if (memq c '(?\? ?\<))
4141 ;; $a++ ? 1 : 2
4142 "~{(=|&*!,;:["
4143 "~{(=|&+-*!,;:[") nil))
4144 (and (eq (preceding-char) ?\})
4145 (cperl-after-block-p (point-min)))
4146 (and (eq (char-syntax (preceding-char)) ?w)
4147 (progn
4148 (forward-sexp -1)
4149 ;; After these keywords `/' starts a RE. One should add all the
4150 ;; functions/builtins which expect an argument, but ...
4151 (if (eq (preceding-char) ?-)
4152 ;; -d ?foo? is a RE
4153 (looking-at "[a-zA-Z]\\>")
4154 (and
4155 (not (memq (preceding-char)
4156 '(?$ ?@ ?& ?%)))
4157 (looking-at
4158 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4159 (and (eq (preceding-char) ?.)
4160 (eq (char-after (- (point) 2)) ?.))
4161 (bobp))
4162 ;; m|blah| ? foo : bar;
4163 (not
4164 (and (eq c ?\?)
4165 cperl-use-syntax-table-text-property
4166 (not (bobp))
4167 (progn
4168 (forward-char -1)
4169 (looking-at "\\s|"))))))
4170 b (1- b))
4171 ;; s y tr m
4172 ;; Check for $a -> y
4173 (setq b1 (preceding-char)
4174 go (point))
4175 (if (and (eq b1 ?>)
4176 (eq (char-after (- go 2)) ?-))
4177 ;; Not a regexp
4178 (setq bb t))))
4179 (or bb
4180 (progn
4181 (goto-char b)
4182 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4183 (goto-char (match-end 0))
4184 (skip-chars-forward " \t\n\f"))
4185 (cond ((and (eq (following-char) ?\})
4186 (eq b1 ?\{))
4187 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4188 (goto-char (1- go))
4189 (skip-chars-backward " \t\n\f")
4190 (if (memq (preceding-char) (append "$@%&*" nil))
4191 (setq bb t) ; @{y}
4192 (condition-case nil
4193 (forward-sexp -1)
4194 (error nil)))
4195 (if (or bb
4196 (looking-at ; $foo -> {s}
4197 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4198 (and ; $foo[12] -> {s}
4199 (memq (following-char) '(?\{ ?\[))
4200 (progn
4201 (forward-sexp 1)
4202 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4203 (setq bb t)
4204 (goto-char b)))
4205 ((and (eq (following-char) ?=)
4206 (eq (char-after (1+ (point))) ?\>))
4207 ;; Check for { foo => 1, s => 2 }
4208 ;; Apparently s=> is never a substitution...
4209 (setq bb t))
4210 ((and (eq (following-char) ?:)
4211 (eq b1 ?\{) ; Check for $ { s::bar }
4212 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
4213 (progn
4214 (goto-char (1- go))
4215 (skip-chars-backward " \t\n\f")
4216 (memq (preceding-char)
4217 (append "$@%&*" nil))))
4218 (setq bb t))
4219 ((eobp)
4220 (setq bb t)))))
4221 (if bb
4222 (goto-char i)
4223 ;; Skip whitespace and comments...
4224 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4225 (goto-char (match-end 0))
4226 (skip-chars-forward " \t\n\f"))
4227 (if (> (point) b)
4228 (put-text-property b (point) 'syntax-type 'prestring))
4229 ;; qtag means two-arg matcher, may be reset to
4230 ;; 2 or 3 later if some special quoting is needed.
4231 ;; e1 means matching-char matcher.
4232 (setq b (point) ; before the first delimiter
4233 ;; has 2 args
4234 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
4235 ;; We do not search to max, since we may be called from
4236 ;; some hook of fontification, and max is random
4237 i (cperl-forward-re stop-point end
4238 i2
4239 st-l err-l argument)
4240 ;; If `go', then it is considered as 1-arg, `b1' is nil
4241 ;; as in s/foo//x; the point is before final "slash"
4242 b1 (nth 1 i) ; start of the second part
4243 tag (nth 2 i) ; ender-char, true if second part
4244 ; is with matching chars []
4245 go (nth 4 i) ; There is a 1-char part after the end
4246 i (car i) ; intermediate point
4247 e1 (point) ; end
4248 ;; Before end of the second part if non-matching: ///
4249 tail (if (and i (not tag))
4250 (1- e1))
4251 e (if i i e1) ; end of the first part
4252 qtag nil ; need to preserve backslashitis
4253 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4254 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
4255 ;; Commenting \\ is dangerous, what about ( ?
4256 (and i tail
4257 (eq (char-after i) ?\\)
4258 (setq qtag t))
4259 (and (if go (looking-at ".\\sw*x")
4260 (looking-at "\\sw*x")) ; qr//x
4261 (setq is-x-REx t))
4262 (and (if go (looking-at ".\\sw*o")
4263 (looking-at "\\sw*o")) ; //o
4264 (setq is-o-REx t))
4265 (if (null i)
4266 ;; Considered as 1arg form
4267 (progn
4268 (cperl-commentify b (point) t)
4269 (put-text-property b (point) 'syntax-type 'string)
4270 (if (or is-x-REx
4271 ;; ignore other text properties:
4272 (string-match "^qw$" argument))
4273 (put-text-property b (point) 'indentable t))
4274 (and go
4275 (setq e1 (cperl-1+ e1))
4276 (or (eobp)
4277 (forward-char 1))))
4278 (cperl-commentify b i t)
4279 (if (looking-at "\\sw*e") ; s///e
4280 (progn
4281 ;; Cache the syntax info...
4282 (setq cperl-syntax-state (cons state-point state))
4283 (and
4284 ;; silent:
4285 (car (cperl-find-pods-heres b1 (1- (point)) t end))
4286 ;; Error
4287 (goto-char (1+ max)))
4288 (if (and tag (eq (preceding-char) ?\>))
4289 (progn
4290 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
4291 (cperl-modify-syntax-type i cperl-st-bra)))
4292 (put-text-property b i 'syntax-type 'string)
4293 (put-text-property i (point) 'syntax-type 'multiline)
4294 (if is-x-REx
4295 (put-text-property b i 'indentable t)))
4296 (cperl-commentify b1 (point) t)
4297 (put-text-property b (point) 'syntax-type 'string)
4298 (if is-x-REx
4299 (put-text-property b i 'indentable t))
4300 (if qtag
4301 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
4302 (setq tail nil)))
4303 ;; Now: tail: if the second part is non-matching without ///e
4304 (if (eq (char-syntax (following-char)) ?w)
4305 (progn
4306 (forward-word 1) ; skip modifiers s///s
4307 (if tail (cperl-commentify tail (point) t))
4308 (cperl-postpone-fontification
4309 e1 (point) 'face my-cperl-REx-modifiers-face)))
4310 ;; Check whether it is m// which means "previous match"
4311 ;; and highlight differently
4312 (setq is-REx
4313 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4314 (or (not (= (length argument) 0))
4315 (not (eq c ?\<)))))
4316 (if (and is-REx
4317 (eq e (+ 2 b))
4318 ;; split // *is* using zero-pattern
4319 (save-excursion
4320 (condition-case nil
4321 (progn
4322 (goto-char tb)
4323 (forward-sexp -1)
4324 (not (looking-at "split\\>")))
4325 (error t))))
4326 (cperl-postpone-fontification
4327 b e 'face font-lock-warning-face)
4328 (if (or i2 ; Has 2 args
4329 (and cperl-fontify-m-as-s
4330 (or
4331 (string-match "^\\(m\\|qr\\)$" argument)
4332 (and (eq 0 (length argument))
4333 (not (eq ?\< (char-after b)))))))
4334 (progn
4335 (cperl-postpone-fontification
4336 b (cperl-1+ b) 'face my-cperl-delimiters-face)
4337 (cperl-postpone-fontification
4338 (1- e) e 'face my-cperl-delimiters-face)))
4339 (if (and is-REx cperl-regexp-scan)
4340 ;; Process RExen: embedded comments, charclasses and ]
4341 ;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4342 ;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4343 ;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4344 ;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4345 ;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4346 ;;;m^a[\^b]c^ + m.a[^b]\.c.;
4347 (save-excursion
4348 (goto-char (1+ b))
4349 ;; First
4350 (cperl-look-at-leading-count is-x-REx e)
4351 (setq hairy-RE
4352 (concat
4353 (if is-x-REx
4354 (if (eq (char-after b) ?\#)
4355 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4356 "\\((\\?#\\)\\|\\(#\\)")
4357 ;; keep the same count: add a fake group
4358 (if (eq (char-after b) ?\#)
4359 "\\((\\?\\\\#\\)\\(\\)"
4360 "\\((\\?#\\)\\(\\)"))
4361 "\\|"
4362 "\\(\\[\\)" ; 3=[
4363 "\\|"
4364 "\\(]\\)" ; 4=]
4365 "\\|"
4366 ;; XXXX Will not be able to use it in s)))
4367 (if (eq (char-after b) ?\) )
4368 "\\())))\\)" ; Will never match
4369 (if (eq (char-after b) ?? )
4370 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4371 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4372 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4373 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4374 "\\(" ;; XXXX 1-char variables, exc. |()\s
4375 "[$@]"
4376 "\\("
4377 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4378 "\\|"
4379 "{[^{}]*}" ; only one-level allowed
4380 "\\|"
4381 "[^{(|) \t\r\n\f]"
4382 "\\)"
4383 "\\(" ;;8,9:code part of array/hash elt
4384 "\\(" "->" "\\)?"
4385 "\\[[^][]*\\]"
4386 "\\|"
4387 "{[^{}]*}"
4388 "\\)*"
4389 ;; XXXX: what if u is delim?
4390 "\\|"
4391 "[)^|$.*?+]"
4392 "\\|"
4393 "{[0-9]+}"
4394 "\\|"
4395 "{[0-9]+,[0-9]*}"
4396 "\\|"
4397 "\\\\[luLUEQbBAzZG]"
4398 "\\|"
4399 "(" ; Group opener
4400 "\\(" ; 10 group opener follower
4401 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4402 "\\|"
4403 "\\?[:=!>?{]" ; "?" something
4404 "\\|"
4405 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4406 "\\|"
4407 "\\?([0-9]+)" ; (?(1)foo|bar)
4408 "\\|"
4409 "\\?<[=!]"
4410 ;;;"\\|"
4411 ;;; "\\?"
4412 "\\)?"
4413 "\\)"
4414 "\\|"
4415 "\\\\\\(.\\)" ; 12=\SYMBOL
4416 ))
4417 (while
4418 (and (< (point) (1- e))
4419 (re-search-forward hairy-RE (1- e) 'to-end))
4420 (goto-char (match-beginning 0))
4421 (setq REx-subgr-start (point)
4422 was-subgr (following-char))
4423 (cond
4424 ((match-beginning 6) ; 0-length builtins, groups
4425 (goto-char (match-end 0))
4426 (if (match-beginning 11)
4427 (goto-char (match-beginning 11)))
4428 (if (>= (point) e)
4429 (goto-char (1- e)))
4430 (cperl-postpone-fontification
4431 (match-beginning 0) (point)
4432 'face
4433 (cond
4434 ((eq was-subgr ?\) )
4435 (condition-case nil
4436 (save-excursion
4437 (forward-sexp -1)
4438 (if (> (point) b)
4439 (if (if (eq (char-after b) ?? )
4440 (looking-at "(\\\\\\?")
4441 (eq (char-after (1+ (point))) ?\?))
4442 my-cperl-REx-0length-face
4443 my-cperl-REx-ctl-face)
4444 font-lock-warning-face))
4445 (error font-lock-warning-face)))
4446 ((eq was-subgr ?\| )
4447 my-cperl-REx-ctl-face)
4448 ((eq was-subgr ?\$ )
4449 (if (> (point) (1+ REx-subgr-start))
4450 (progn
4451 (put-text-property
4452 (match-beginning 0) (point)
4453 'REx-interpolated
4454 (if is-o-REx 0
4455 (if (and (eq (match-beginning 0)
4456 (1+ b))
4457 (eq (point)
4458 (1- e))) 1 t)))
4459 font-lock-variable-name-face)
4460 my-cperl-REx-spec-char-face))
4461 ((memq was-subgr (append "^." nil) )
4462 my-cperl-REx-spec-char-face)
4463 ((eq was-subgr ?\( )
4464 (if (not (match-beginning 10))
4465 my-cperl-REx-ctl-face
4466 my-cperl-REx-0length-face))
4467 (t my-cperl-REx-0length-face)))
4468 (if (and (memq was-subgr (append "(|" nil))
4469 (not (string-match "(\\?[-imsx]+)"
4470 (match-string 0))))
4471 (cperl-look-at-leading-count is-x-REx e))
4472 (setq was-subgr nil)) ; We do stuff here
4473 ((match-beginning 12) ; \SYMBOL
4474 (forward-char 2)
4475 (if (>= (point) e)
4476 (goto-char (1- e))
4477 ;; How many chars to not highlight:
4478 ;; 0-len special-alnums in other branch =>
4479 ;; Generic: \non-alnum (1), \alnum (1+face)
4480 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4481 (setq REx-subgr-start (point)
4482 qtag (preceding-char))
4483 (cperl-postpone-fontification
4484 (- (point) 2) (- (point) 1) 'face
4485 (if (memq qtag
4486 (append "ghijkmoqvFHIJKMORTVY" nil))
4487 font-lock-warning-face
4488 my-cperl-REx-0length-face))
4489 (if (and (eq (char-after b) qtag)
4490 (memq qtag (append ".])^$|*?+" nil)))
4491 (progn
4492 (if (and cperl-use-syntax-table-text-property
4493 (eq qtag ?\) ))
4494 (put-text-property
4495 REx-subgr-start (1- (point))
4496 'syntax-table cperl-st-punct))
4497 (cperl-postpone-fontification
4498 (1- (point)) (point) 'face
4499 ; \] can't appear below
4500 (if (memq qtag (append ".]^$" nil))
4501 'my-cperl-REx-spec-char-face
4502 (if (memq qtag (append "*?+" nil))
4503 'my-cperl-REx-0length-face
4504 'my-cperl-REx-ctl-face))))) ; )|
4505 ;; Test for arguments:
4506 (cond
4507 ;; This is not pretty: the 5.8.7 logic:
4508 ;; \0numx -> octal (up to total 3 dig)
4509 ;; \DIGIT -> backref unless \0
4510 ;; \DIGITs -> backref if valid
4511 ;; otherwise up to 3 -> octal
4512 ;; Do not try to distinguish, we guess
4513 ((or (and (memq qtag (append "01234567" nil))
4514 (re-search-forward
4515 "\\=[01234567]?[01234567]?"
4516 (1- e) 'to-end))
4517 (and (memq qtag (append "89" nil))
4518 (re-search-forward
4519 "\\=[0123456789]*" (1- e) 'to-end))
4520 (and (eq qtag ?x)
4521 (re-search-forward
4522 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4523 (1- e) 'to-end))
4524 (and (memq qtag (append "pPN" nil))
4525 (re-search-forward "\\={[^{}]+}\\|."
4526 (1- e) 'to-end))
4527 (eq (char-syntax qtag) ?w))
4528 (cperl-postpone-fontification
4529 (1- REx-subgr-start) (point)
4530 'face my-cperl-REx-length1-face))))
4531 (setq was-subgr nil)) ; We do stuff here
4532 ((match-beginning 3) ; [charclass]
4533 ;; Highlight leader, trailer, POSIX classes
4534 (forward-char 1)
4535 (if (eq (char-after b) ?^ )
4536 (and (eq (following-char) ?\\ )
4537 (eq (char-after (cperl-1+ (point)))
4538 ?^ )
4539 (forward-char 2))
4540 (and (eq (following-char) ?^ )
4541 (forward-char 1)))
4542 (setq argument b ; continue? & end of last POSIX
4543 tag nil ; list of POSIX classes
4544 qtag (point)) ; after leading ^ if present
4545 (if (eq (char-after b) ?\] )
4546 (and (eq (following-char) ?\\ )
4547 (eq (char-after (cperl-1+ (point)))
4548 ?\] )
4549 (setq qtag (1+ qtag))
4550 (forward-char 2))
4551 (and (eq (following-char) ?\] )
4552 (forward-char 1)))
4553 (setq REx-subgr-end qtag) ;EndOf smart-highlighed
4554 ;; Apparently, I can't put \] into a charclass
4555 ;; in m]]: m][\\\]\]] produces [\\]]
4556 ;;; POSIX? [:word:] [:^word:] only inside []
4557 ;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4558 (while ; look for unescaped ]
4559 (and argument
4560 (re-search-forward
4561 (if (eq (char-after b) ?\] )
4562 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4563 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4564 (1- e) 'toend))
4565 ;; Is this ] an end of POSIX class?
4566 (if (save-excursion
4567 (and
4568 (search-backward "[" argument t)
4569 (< REx-subgr-start (point))
4570 (setq argument (point)) ; POSIX-start
4571 (or ; Should work with delim = \
4572 (not (eq (preceding-char) ?\\ ))
4573 ;; XXXX Double \\ is needed with 19.33
4574 (= (% (skip-chars-backward "\\\\") 2) 0))
4575 (looking-at
4576 (cond
4577 ((eq (char-after b) ?\] )
4578 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4579 ((eq (char-after b) ?\: )
4580 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4581 ((eq (char-after b) ?^ )
4582 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
4583 ((eq (char-syntax (char-after b))
4584 ?w)
4585 (concat
4586 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4587 (char-to-string (char-after b))
4588 "\\|\\sw\\)+:\]"))
4589 (t "\\\\*\\[:\\^?\\sw*:]")))
4590 (goto-char REx-subgr-end)
4591 (cperl-highlight-charclass
4592 argument my-cperl-REx-spec-char-face
4593 my-cperl-REx-0length-face my-cperl-REx-length1-face)))
4594 (setq tag (cons (cons argument (point))
4595 tag)
4596 argument (point)
4597 REx-subgr-end argument) ; continue
4598 (setq argument nil)))
4599 (and argument
4600 (message "Couldn't find end of charclass in a REx, pos=%s"
4601 REx-subgr-start))
4602 (setq argument (1- (point)))
4603 (goto-char REx-subgr-end)
4604 (cperl-highlight-charclass
4605 argument my-cperl-REx-spec-char-face
4606 my-cperl-REx-0length-face my-cperl-REx-length1-face)
4607 (forward-char 1)
4608 ;; Highlight starter, trailer, POSIX
4609 (if (and cperl-use-syntax-table-text-property
4610 (> (- (point) 2) REx-subgr-start))
4611 (put-text-property
4612 (1+ REx-subgr-start) (1- (point))
4613 'syntax-table cperl-st-punct))
4614 (cperl-postpone-fontification
4615 REx-subgr-start qtag
4616 'face my-cperl-REx-spec-char-face)
4617 (cperl-postpone-fontification
4618 (1- (point)) (point) 'face
4619 my-cperl-REx-spec-char-face)
4620 (if (eq (char-after b) ?\] )
4621 (cperl-postpone-fontification
4622 (- (point) 2) (1- (point))
4623 'face my-cperl-REx-0length-face))
4624 (while tag
4625 (cperl-postpone-fontification
4626 (car (car tag)) (cdr (car tag))
4627 'face font-lock-variable-name-face) ;my-cperl-REx-length1-face
4628 (setq tag (cdr tag)))
4629 (setq was-subgr nil)) ; did facing already
4630 ;; Now rare stuff:
4631 ((and (match-beginning 2) ; #-comment
4632 (/= (match-beginning 2) (match-end 2)))
4633 (beginning-of-line 2)
4634 (if (> (point) e)
4635 (goto-char (1- e))))
4636 ((match-beginning 4) ; character "]"
4637 (setq was-subgr nil) ; We do stuff here
4638 (goto-char (match-end 0))
4639 (if cperl-use-syntax-table-text-property
4640 (put-text-property
4641 (1- (point)) (point)
4642 'syntax-table cperl-st-punct))
4643 (cperl-postpone-fontification
4644 (1- (point)) (point)
4645 'face font-lock-warning-face))
4646 ((match-beginning 5) ; before (?{}) (??{})
4647 (setq tag (match-end 0))
4648 (if (or (setq qtag
4649 (cperl-forward-group-in-re st-l))
4650 (and (>= (point) e)
4651 (setq qtag "no matching `)' found"))
4652 (and (not (eq (char-after (- (point) 2))
4653 ?\} ))
4654 (setq qtag "Can't find })")))
4655 (progn
4656 (goto-char (1- e))
4657 (message "%s" qtag))
4658 (cperl-postpone-fontification
4659 (1- tag) (1- (point))
4660 'face font-lock-variable-name-face)
4661 (cperl-postpone-fontification
4662 REx-subgr-start (1- tag)
4663 'face my-cperl-REx-spec-char-face)
4664 (cperl-postpone-fontification
4665 (1- (point)) (point)
4666 'face my-cperl-REx-spec-char-face)
4667 (if cperl-use-syntax-table-text-property
4668 (progn
4669 (put-text-property
4670 (- (point) 2) (1- (point))
4671 'syntax-table cperl-st-cfence)
4672 (put-text-property
4673 (+ REx-subgr-start 2)
4674 (+ REx-subgr-start 3)
4675 'syntax-table cperl-st-cfence))))
4676 (setq was-subgr nil))
4677 (t ; (?#)-comment
4678 ;; Inside "(" and "\" arn't special in any way
4679 ;; Works also if the outside delimiters are ().
4680 (or;;(if (eq (char-after b) ?\) )
4681 ;;(re-search-forward
4682 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4683 ;; (1- e) 'toend)
4684 (search-forward ")" (1- e) 'toend)
4685 ;;)
4686 (message
4687 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4688 REx-subgr-start))))
4689 (if (>= (point) e)
4690 (goto-char (1- e)))
4691 (cond
4692 (was-subgr
4693 (setq REx-subgr-end (point))
4694 (cperl-commentify
4695 REx-subgr-start REx-subgr-end nil)
4696 (cperl-postpone-fontification
4697 REx-subgr-start REx-subgr-end
4698 'face font-lock-comment-face))))))
4699 (if (and is-REx is-x-REx)
4700 (put-text-property (1+ b) (1- e)
4701 'syntax-subtype 'x-REx)))
4702 (if (and i2 e1 (or (not b1) (> e1 b1)))
4703 (progn ; No errors finding the second part...
4704 (cperl-postpone-fontification
4705 (1- e1) e1 'face my-cperl-delimiters-face)
4706 (if (and (not (eobp))
4707 (assoc (char-after b) cperl-starters))
4708 (progn
4709 (cperl-postpone-fontification
4710 b1 (1+ b1) 'face my-cperl-delimiters-face)
4711 (put-text-property b1 (1+ b1)
4712 'REx-part2 t)))))
4713 (if (> (point) max)
4714 (setq tmpend tb))))
4715 ((match-beginning 17) ; sub with prototype or attribute
4716 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4717 ;;"\\<sub\\>\\(" ;12
4718 ;; cperl-white-and-comment-rex ;13
4719 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4720 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4721 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4722 (setq b1 (match-beginning 14) e1 (match-end 14))
4723 (if (memq (char-after (1- b))
4724 '(?\$ ?\@ ?\% ?\& ?\*))
4725 nil
4726 (goto-char b)
4727 (if (eq (char-after (match-beginning 17)) ?\( )
4728 (progn
4729 (cperl-commentify ; Prototypes; mark as string
4730 (match-beginning 17) (match-end 17) t)
4731 (goto-char (match-end 0))
4732 ;; Now look for attributes after prototype:
4733 (forward-comment (buffer-size))
4734 (and (looking-at ":[^:]")
4735 (cperl-find-sub-attrs st-l b1 e1 b)))
4736 ;; treat attributes without prototype
4737 (goto-char (match-beginning 17))
4738 (cperl-find-sub-attrs st-l b1 e1 b))))
4739 ;; 1+6+2+1+1+6+1=18 extra () before this:
4740 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4741 ((match-beginning 19) ; old $abc'efg syntax
4742 (setq bb (match-end 0))
4743 ;;;(if (nth 3 state) nil ; in string
4744 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
4745 (goto-char bb))
4746 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
4747 ;; "__\\(END\\|DATA\\)__"
4748 ((match-beginning 20) ; __END__, __DATA__
4749 (setq bb (match-end 0))
4750 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4751 (cperl-commentify b bb nil)
4752 (setq end t))
4753 ;; "\\\\\\(['`\"($]\\)"
4754 ((match-beginning 21)
4755 ;; Trailing backslash; make non-quoting outside string/comment
4756 (setq bb (match-end 0))
4757 (goto-char b)
4758 (skip-chars-backward "\\\\")
4759 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4760 (cperl-modify-syntax-type b cperl-st-punct)
4761 (goto-char bb))
4762 (t (error "Error in regexp of the sniffer")))
4763 (if (> (point) stop-point)
4764 (progn
4765 (if end
4766 (message "Garbage after __END__/__DATA__ ignored")
4767 (message "Unbalanced syntax found while scanning")
4768 (or (car err-l) (setcar err-l b)))
4769 (goto-char stop-point))))
4770 (setq cperl-syntax-state (cons state-point state)
4771 ;; Do not mark syntax as done past tmpend???
4772 cperl-syntax-done-to (or tmpend (max (point) max)))
4773 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4774 )
4775 (if (car err-l) (goto-char (car err-l))
4776 (or non-inter
4777 (message "Scanning for \"hard\" Perl constructions... done"))))
4778 (and (buffer-modified-p)
4779 (not modified)
4780 (set-buffer-modified-p nil))
4781 ;; I do not understand what this is doing here. It breaks font-locking
4782 ;; because it resets the syntax-table from font-lock-syntax-table to
4783 ;; cperl-mode-syntax-table.
4784 ;; (set-syntax-table cperl-mode-syntax-table)
4785 )
4786 (list (car err-l) overshoot)))
4787
4788 (defun cperl-find-pods-heres-region (min max)
4789 (interactive "r")
4790 (cperl-find-pods-heres min max))
4791
4792 (defun cperl-backward-to-noncomment (lim)
4793 ;; Stops at lim or after non-whitespace that is not in comment
4794 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
4795 (let (stop p pr)
4796 (while (and (not stop) (> (point) (or lim (point-min))))
4797 (skip-chars-backward " \t\n\f" lim)
4798 (setq p (point))
4799 (beginning-of-line)
4800 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4801 '(pod here-doc here-doc-delim))
4802 (progn
4803 (cperl-unwind-to-safe nil)
4804 (setq pr (get-text-property (point) 'syntax-type))))
4805 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4806 (not (memq pr '(string prestring))))
4807 (progn (cperl-to-comment-or-eol) (bolp))
4808 (progn
4809 (skip-chars-backward " \t")
4810 (if (< p (point)) (goto-char p))
4811 (setq stop t))))))
4812
4813 ;; Used only in `cperl-calculate-indent'...
4814 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4815 ;; Positions is before ?\{. Checks whether it starts a block.
4816 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4817 (cperl-backward-to-noncomment (point-min))
4818 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4819 ; Label may be mixed up with `$blah :'
4820 (save-excursion (cperl-after-label))
4821 (get-text-property (cperl-1- (point)) 'attrib-group)
4822 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4823 (progn
4824 (backward-sexp)
4825 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4826 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4827 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
4828 ;; sub bless::foo {}
4829 (progn
4830 (cperl-backward-to-noncomment (point-min))
4831 (and (eq (preceding-char) ?b)
4832 (progn
4833 (forward-sexp -1)
4834 (looking-at "sub[ \t\n\f#]")))))))))
4835
4836 ;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4837 ;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4838 ;;; may be a part of an in-statement construct, such as
4839 ;;; ${something()}, print {FH} $data.
4840 ;;; Moreover, one takes positive approach (looks for else,grep etc)
4841 ;;; another negative (looks for bless,tr etc)
4842 (defun cperl-after-block-p (lim &optional pre-block)
4843 "Return true if the preceding } (if PRE-BLOCK, following {) delimits a block.
4844 Would not look before LIM. Assumes that LIM is a good place to begin a
4845 statement. The kind of block we treat here is one after which a new
4846 statement would start; thus the block in ${func()} does not count."
4847 (save-excursion
4848 (condition-case nil
4849 (progn
4850 (or pre-block (forward-sexp -1))
4851 (cperl-backward-to-noncomment lim)
4852 (or (eq (point) lim)
4853 ;; if () {} // sub f () {} // sub f :a(') {}
4854 (eq (preceding-char) ?\) )
4855 ;; label: {}
4856 (save-excursion (cperl-after-label))
4857 ;; sub :attr {}
4858 (get-text-property (cperl-1- (point)) 'attrib-group)
4859 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
4860 (save-excursion
4861 (forward-sexp -1)
4862 ;; else {} but not else::func {}
4863 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4864 (not (looking-at "\\(\\sw\\|_\\)+::")))
4865 ;; sub f {}
4866 (progn
4867 (cperl-backward-to-noncomment lim)
4868 (and (eq (preceding-char) ?b)
4869 (progn
4870 (forward-sexp -1)
4871 (looking-at "sub[ \t\n\f#]"))))))
4872 ;; What precedes is not word... XXXX Last statement in sub???
4873 (cperl-after-expr-p lim))))
4874 (error nil))))
4875
4876 (defun cperl-after-expr-p (&optional lim chars test)
4877 "Return true if the position is good for start of expression.
4878 TEST is the expression to evaluate at the found position. If absent,
4879 CHARS is a string that contains good characters to have before us (however,
4880 `}' is treated \"smartly\" if it is not in the list)."
4881 (let ((lim (or lim (point-min)))
4882 stop p pr)
4883 (cperl-update-syntaxification (point) (point))
4884 (save-excursion
4885 (while (and (not stop) (> (point) lim))
4886 (skip-chars-backward " \t\n\f" lim)
4887 (setq p (point))
4888 (beginning-of-line)
4889 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4890 ;; '(pod here-doc here-doc-delim))
4891 (if (get-text-property (point) 'here-doc-group)
4892 (progn
4893 (goto-char
4894 (cperl-beginning-of-property (point) 'here-doc-group))
4895 (beginning-of-line 0)))
4896 (if (get-text-property (point) 'in-pod)
4897 (progn
4898 (goto-char
4899 (cperl-beginning-of-property (point) 'in-pod))
4900 (beginning-of-line 0)))
4901 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
4902 ;; Else: last iteration, or a label
4903 (cperl-to-comment-or-eol) ; Will not move past "." after a format
4904 (skip-chars-backward " \t")
4905 (if (< p (point)) (goto-char p))
4906 (setq p (point))
4907 (if (and (eq (preceding-char) ?:)
4908 (progn
4909 (forward-char -1)
4910 (skip-chars-backward " \t\n\f" lim)
4911 (memq (char-syntax (preceding-char)) '(?w ?_))))
4912 (forward-sexp -1) ; Possibly label. Skip it
4913 (goto-char p)
4914 (setq stop t))))
4915 (or (bobp) ; ???? Needed
4916 (eq (point) lim)
4917 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
4918 (progn
4919 (if test (eval test)
4920 (or (memq (preceding-char) (append (or chars "{;") nil))
4921 (and (eq (preceding-char) ?\})
4922 (cperl-after-block-p lim))
4923 (and (eq (following-char) ?.) ; in format: see comment above
4924 (eq (get-text-property (point) 'syntax-type)
4925 'format)))))))))
4926
4927 (defun cperl-backward-to-start-of-expr (&optional lim)
4928 (condition-case nil
4929 (progn
4930 (while (and (or (not lim)
4931 (> (point) lim))
4932 (not (cperl-after-expr-p lim)))
4933 (forward-sexp -1)
4934 ;; May be after $, @, $# etc of a variable
4935 (skip-chars-backward "$@%#")))
4936 (error nil)))
4937
4938 (defun cperl-at-end-of-expr (&optional lim)
4939 ;; Since the SEXP approach below is very fragile, do some overengineering
4940 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4941 (condition-case nil
4942 (save-excursion
4943 ;; If nothing interesting after, does as (forward-sexp -1);
4944 ;; otherwise fails, or ends at a start of following sexp.
4945 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4946 ;; may be stuck after @ or $; just put some stupid workaround now:
4947 (let ((p (point)))
4948 (forward-sexp 1)
4949 (forward-sexp -1)
4950 (while (memq (preceding-char) (append "%&@$*" nil))
4951 (forward-char -1))
4952 (or (< (point) p)
4953 (cperl-after-expr-p lim))))
4954 (error t))))
4955
4956 (defun cperl-forward-to-end-of-expr (&optional lim)
4957 (let ((p (point))))
4958 (condition-case nil
4959 (progn
4960 (while (and (< (point) (or lim (point-max)))
4961 (not (cperl-at-end-of-expr)))
4962 (forward-sexp 1)))
4963 (error nil)))
4964
4965 (defun cperl-backward-to-start-of-continued-exp (lim)
4966 (if (memq (preceding-char) (append ")]}\"'`" nil))
4967 (forward-sexp -1))
4968 (beginning-of-line)
4969 (if (<= (point) lim)
4970 (goto-char (1+ lim)))
4971 (skip-chars-forward " \t"))
4972
4973 (defun cperl-after-block-and-statement-beg (lim)
4974 ;; We assume that we are after ?\}
4975 (and
4976 (cperl-after-block-p lim)
4977 (save-excursion
4978 (forward-sexp -1)
4979 (cperl-backward-to-noncomment (point-min))
4980 (or (bobp)
4981 (eq (point) lim)
4982 (not (= (char-syntax (preceding-char)) ?w))
4983 (progn
4984 (forward-sexp -1)
4985 (not
4986 (looking-at
4987 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
4988
4989 \f
4990 (defun cperl-indent-exp ()
4991 "Simple variant of indentation of continued-sexp.
4992
4993 Will not indent comment if it starts at `comment-indent' or looks like
4994 continuation of the comment on the previous line.
4995
4996 If `cperl-indent-region-fix-constructs', will improve spacing on
4997 conditional/loop constructs."
4998 (interactive)
4999 (save-excursion
5000 (let ((tmp-end (progn (end-of-line) (point))) top done)
5001 (save-excursion
5002 (beginning-of-line)
5003 (while (null done)
5004 (setq top (point))
5005 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
5006 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
5007 (setq top (point))) ; Get the outermost parenths in line
5008 (goto-char top)
5009 (while (< (point) tmp-end)
5010 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5011 (or (eolp) (forward-sexp 1)))
5012 (if (> (point) tmp-end) ; Yes, there an unfinished block
5013 nil
5014 (if (eq ?\) (preceding-char))
5015 (progn ;; Plan B: find by REGEXP block followup this line
5016 (setq top (point))
5017 (condition-case nil
5018 (progn
5019 (forward-sexp -2)
5020 (if (eq (following-char) ?$ ) ; for my $var (list)
5021 (progn
5022 (forward-sexp -1)
5023 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5024 (forward-sexp -1))))
5025 (if (looking-at
5026 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5027 "\\|for\\(each\\)?\\>\\(\\("
5028 cperl-maybe-white-and-comment-rex
5029 "\\(my\\|local\\|our\\)\\)?"
5030 cperl-maybe-white-and-comment-rex
5031 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5032 (progn
5033 (goto-char top)
5034 (forward-sexp 1)
5035 (setq top (point)))))
5036 (error (setq done t)))
5037 (goto-char top))
5038 (if (looking-at ; Try Plan C: continuation block
5039 (concat cperl-maybe-white-and-comment-rex
5040 "\\<\\(else\\|elsif\|continue\\)\\>"))
5041 (progn
5042 (goto-char (match-end 0))
5043 (save-excursion
5044 (end-of-line)
5045 (setq tmp-end (point))))
5046 (setq done t))))
5047 (save-excursion
5048 (end-of-line)
5049 (setq tmp-end (point))))
5050 (goto-char tmp-end)
5051 (setq tmp-end (point-marker)))
5052 (if cperl-indent-region-fix-constructs
5053 (cperl-fix-line-spacing tmp-end))
5054 (cperl-indent-region (point) tmp-end))))
5055
5056 (defun cperl-fix-line-spacing (&optional end parse-data)
5057 "Improve whitespace in a conditional/loop construct.
5058 Returns some position at the last line."
5059 (interactive)
5060 (or end
5061 (setq end (point-max)))
5062 (let ((ee (save-excursion (end-of-line) (point)))
5063 (cperl-indent-region-fix-constructs
5064 (or cperl-indent-region-fix-constructs 1))
5065 p pp ml have-brace ret)
5066 (save-excursion
5067 (beginning-of-line)
5068 (setq ret (point))
5069 ;; }? continue
5070 ;; blah; }
5071 (if (not
5072 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5073 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5074 nil ; Do not need to do anything
5075 ;; Looking at:
5076 ;; }
5077 ;; else
5078 (if cperl-merge-trailing-else
5079 (if (looking-at
5080 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5081 (progn
5082 (search-forward "}")
5083 (setq p (point))
5084 (skip-chars-forward " \t\n")
5085 (delete-region p (point))
5086 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5087 (beginning-of-line)))
5088 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5089 (save-excursion
5090 (search-forward "}")
5091 (delete-horizontal-space)
5092 (insert "\n")
5093 (setq ret (point))
5094 (if (cperl-indent-line parse-data)
5095 (progn
5096 (cperl-fix-line-spacing end parse-data)
5097 (setq ret (point)))))))
5098 ;; Looking at:
5099 ;; } else
5100 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5101 (progn
5102 (search-forward "}")
5103 (delete-horizontal-space)
5104 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5105 (beginning-of-line)))
5106 ;; Looking at:
5107 ;; else {
5108 (if (looking-at
5109 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5110 (progn
5111 (forward-word 1)
5112 (delete-horizontal-space)
5113 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5114 (beginning-of-line)))
5115 ;; Looking at:
5116 ;; foreach my $var
5117 (if (looking-at
5118 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5119 (progn
5120 (forward-word 2)
5121 (delete-horizontal-space)
5122 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5123 (beginning-of-line)))
5124 ;; Looking at:
5125 ;; foreach my $var (
5126 (if (looking-at
5127 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5128 (progn
5129 (forward-sexp 3)
5130 (delete-horizontal-space)
5131 (insert
5132 (make-string cperl-indent-region-fix-constructs ?\s))
5133 (beginning-of-line)))
5134 ;; Looking at (with or without "}" at start, ending after "({"):
5135 ;; } foreach my $var () OR {
5136 (if (looking-at
5137 "[ \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]*{")
5138 (progn
5139 (setq ml (match-beginning 8)) ; "(" or "{" after control word
5140 (re-search-forward "[({]")
5141 (forward-char -1)
5142 (setq p (point))
5143 (if (eq (following-char) ?\( )
5144 (progn
5145 (forward-sexp 1)
5146 (setq pp (point))) ; past parenth-group
5147 ;; after `else' or nothing
5148 (if ml ; after `else'
5149 (skip-chars-backward " \t\n")
5150 (beginning-of-line))
5151 (setq pp nil))
5152 ;; Now after the sexp before the brace
5153 ;; Multiline expr should be special
5154 (setq ml (and pp (save-excursion (goto-char p)
5155 (search-forward "\n" pp t))))
5156 (if (and (or (not pp) (< pp end)) ; Do not go too far...
5157 (looking-at "[ \t\n]*{"))
5158 (progn
5159 (cond
5160 ((bolp) ; Were before `{', no if/else/etc
5161 nil)
5162 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
5163 (delete-horizontal-space)
5164 (if (if ml
5165 cperl-extra-newline-before-brace-multiline
5166 cperl-extra-newline-before-brace)
5167 (progn
5168 (delete-horizontal-space)
5169 (insert "\n")
5170 (setq ret (point))
5171 (if (cperl-indent-line parse-data)
5172 (progn
5173 (cperl-fix-line-spacing end parse-data)
5174 (setq ret (point)))))
5175 (insert
5176 (make-string cperl-indent-region-fix-constructs ?\s))))
5177 ((and (looking-at "[ \t]*\n")
5178 (not (if ml
5179 cperl-extra-newline-before-brace-multiline
5180 cperl-extra-newline-before-brace)))
5181 (setq pp (point))
5182 (skip-chars-forward " \t\n")
5183 (delete-region pp (point))
5184 (insert
5185 (make-string cperl-indent-region-fix-constructs ?\ )))
5186 ((and (looking-at "[\t ]*{")
5187 (if ml cperl-extra-newline-before-brace-multiline
5188 cperl-extra-newline-before-brace))
5189 (delete-horizontal-space)
5190 (insert "\n")
5191 (setq ret (point))
5192 (if (cperl-indent-line parse-data)
5193 (progn
5194 (cperl-fix-line-spacing end parse-data)
5195 (setq ret (point))))))
5196 ;; Now we are before `{'
5197 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5198 (progn
5199 (skip-chars-forward " \t\n")
5200 (setq pp (point))
5201 (forward-sexp 1)
5202 (setq p (point))
5203 (goto-char pp)
5204 (setq ml (search-forward "\n" p t))
5205 (if (or cperl-break-one-line-blocks-when-indent ml)
5206 ;; not good: multi-line BLOCK
5207 (progn
5208 (goto-char (1+ pp))
5209 (delete-horizontal-space)
5210 (insert "\n")
5211 (setq ret (point))
5212 (if (cperl-indent-line parse-data)
5213 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5214 (beginning-of-line)
5215 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
5216 ;; Now check whether there is a hanging `}'
5217 ;; Looking at:
5218 ;; } blah
5219 (if (and
5220 cperl-fix-hanging-brace-when-indent
5221 have-brace
5222 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5223 (condition-case nil
5224 (progn
5225 (up-list 1)
5226 (if (and (<= (point) pp)
5227 (eq (preceding-char) ?\} )
5228 (cperl-after-block-and-statement-beg (point-min)))
5229 t
5230 (goto-char p)
5231 nil))
5232 (error nil)))
5233 (progn
5234 (forward-char -1)
5235 (skip-chars-backward " \t")
5236 (if (bolp)
5237 ;; `}' was the first thing on the line, insert NL *after* it.
5238 (progn
5239 (cperl-indent-line parse-data)
5240 (search-forward "}")
5241 (delete-horizontal-space)
5242 (insert "\n"))
5243 (delete-horizontal-space)
5244 (or (eq (preceding-char) ?\;)
5245 (bolp)
5246 (and (eq (preceding-char) ?\} )
5247 (cperl-after-block-p (point-min)))
5248 (insert ";"))
5249 (insert "\n")
5250 (setq ret (point)))
5251 (if (cperl-indent-line parse-data)
5252 (setq ret (cperl-fix-line-spacing end parse-data)))
5253 (beginning-of-line)))))
5254 ret))
5255
5256 (defvar cperl-update-start) ; Do not need to make them local
5257 (defvar cperl-update-end)
5258 (defun cperl-delay-update-hook (beg end old-len)
5259 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5260 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
5261
5262 (defun cperl-indent-region (start end)
5263 "Simple variant of indentation of region in CPerl mode.
5264 Should be slow. Will not indent comment if it starts at `comment-indent'
5265 or looks like continuation of the comment on the previous line.
5266 Indents all the lines whose first character is between START and END
5267 inclusive.
5268
5269 If `cperl-indent-region-fix-constructs', will improve spacing on
5270 conditional/loop constructs."
5271 (interactive "r")
5272 (cperl-update-syntaxification end end)
5273 (save-excursion
5274 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
5275 (let ((indent-info (if cperl-emacs-can-parse
5276 (list nil nil nil) ; Cannot use '(), since will modify
5277 nil))
5278 (pm 0)
5279 after-change-functions ; Speed it up!
5280 st comm old-comm-indent new-comm-indent p pp i empty)
5281 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
5282 (goto-char start)
5283 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5284 (current-column))
5285 new-comm-indent old-comm-indent)
5286 (goto-char start)
5287 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5288 (or (bolp) (beginning-of-line 2))
5289 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5290 (setq st (point))
5291 (if (or
5292 (setq empty (looking-at "[ \t]*\n"))
5293 (and (setq comm (looking-at "[ \t]*#"))
5294 (or (eq (current-indentation) (or old-comm-indent
5295 comment-column))
5296 (setq old-comm-indent nil))))
5297 (if (and old-comm-indent
5298 (not empty)
5299 (= (current-indentation) old-comm-indent)
5300 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5301 (not (eq (get-text-property (point) 'syntax-table)
5302 cperl-st-cfence)))
5303 (let ((comment-column new-comm-indent))
5304 (indent-for-comment)))
5305 (progn
5306 (setq i (cperl-indent-line indent-info))
5307 (or comm
5308 (not i)
5309 (progn
5310 (if cperl-indent-region-fix-constructs
5311 (goto-char (cperl-fix-line-spacing end indent-info)))
5312 (if (setq old-comm-indent
5313 (and (cperl-to-comment-or-eol)
5314 (not (memq (get-text-property (point)
5315 'syntax-type)
5316 '(pod here-doc)))
5317 (not (eq (get-text-property (point)
5318 'syntax-table)
5319 cperl-st-cfence))
5320 (current-column)))
5321 (progn (indent-for-comment)
5322 (skip-chars-backward " \t")
5323 (skip-chars-backward "#")
5324 (setq new-comm-indent (current-column))))))))
5325 (beginning-of-line 2)))
5326 ;; Now run the update hooks
5327 (and after-change-functions
5328 cperl-update-end
5329 (save-excursion
5330 (goto-char cperl-update-end)
5331 (insert " ")
5332 (delete-char -1)
5333 (goto-char cperl-update-start)
5334 (insert " ")
5335 (delete-char -1))))))
5336
5337 ;; Stolen from lisp-mode with a lot of improvements
5338
5339 (defun cperl-fill-paragraph (&optional justify iteration)
5340 "Like `fill-paragraph', but handle CPerl comments.
5341 If any of the current line is a comment, fill the comment or the
5342 block of it that point is in, preserving the comment's initial
5343 indentation and initial hashes. Behaves usually outside of comment."
5344 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
5345 (let (;; Non-nil if the current line contains a comment.
5346 has-comment
5347 fill-paragraph-function ; do not recurse
5348 ;; If has-comment, the appropriate fill-prefix for the comment.
5349 comment-fill-prefix
5350 ;; Line that contains code and comment (or nil)
5351 start
5352 c spaces len dc (comment-column comment-column))
5353 ;; Figure out what kind of comment we are looking at.
5354 (save-excursion
5355 (beginning-of-line)
5356 (cond
5357
5358 ;; A line with nothing but a comment on it?
5359 ((looking-at "[ \t]*#[# \t]*")
5360 (setq has-comment t
5361 comment-fill-prefix (buffer-substring (match-beginning 0)
5362 (match-end 0))))
5363
5364 ;; A line with some code, followed by a comment? Remember that the
5365 ;; semi which starts the comment shouldn't be part of a string or
5366 ;; character.
5367 ((cperl-to-comment-or-eol)
5368 (setq has-comment t)
5369 (looking-at "#+[ \t]*")
5370 (setq start (point) c (current-column)
5371 comment-fill-prefix
5372 (concat (make-string (current-column) ?\s)
5373 (buffer-substring (match-beginning 0) (match-end 0)))
5374 spaces (progn (skip-chars-backward " \t")
5375 (buffer-substring (point) start))
5376 dc (- c (current-column)) len (- start (point))
5377 start (point-marker))
5378 (delete-char len)
5379 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
5380 (if (not has-comment)
5381 (fill-paragraph justify) ; Do the usual thing outside of comment
5382 ;; Narrow to include only the comment, and then fill the region.
5383 (save-restriction
5384 (narrow-to-region
5385 ;; Find the first line we should include in the region to fill.
5386 (if start (progn (beginning-of-line) (point))
5387 (save-excursion
5388 (while (and (zerop (forward-line -1))
5389 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5390 ;; We may have gone to far. Go forward again.
5391 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5392 (forward-line 1))
5393 (point)))
5394 ;; Find the beginning of the first line past the region to fill.
5395 (save-excursion
5396 (while (progn (forward-line 1)
5397 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5398 (point)))
5399 ;; Remove existing hashes
5400 (goto-char (point-min))
5401 (save-excursion
5402 (while (progn (forward-line 1) (< (point) (point-max)))
5403 (skip-chars-forward " \t")
5404 (if (looking-at "#+")
5405 (progn
5406 (if (and (eq (point) (match-beginning 0))
5407 (not (eq (point) (match-end 0)))) nil
5408 (error
5409 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5410 (delete-char (- (match-end 0) (match-beginning 0)))))))
5411
5412 ;; Lines with only hashes on them can be paragraph boundaries.
5413 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5414 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5415 (fill-prefix comment-fill-prefix))
5416 (fill-paragraph justify)))
5417 (if (and start)
5418 (progn
5419 (goto-char start)
5420 (if (> dc 0)
5421 (progn (delete-char dc) (insert spaces)))
5422 (if (or (= (current-column) c) iteration) nil
5423 (setq comment-column c)
5424 (indent-for-comment)
5425 ;; Repeat once more, flagging as iteration
5426 (cperl-fill-paragraph justify t))))))
5427 t)
5428
5429 (defun cperl-do-auto-fill ()
5430 ;; Break out if the line is short enough
5431 (if (> (save-excursion
5432 (end-of-line)
5433 (current-column))
5434 fill-column)
5435 (let ((c (save-excursion (beginning-of-line)
5436 (cperl-to-comment-or-eol) (point)))
5437 (s (memq (following-char) '(?\s ?\t))) marker)
5438 (if (>= c (point))
5439 ;; Don't break line inside code: only inside comment.
5440 nil
5441 (setq marker (point-marker))
5442 (fill-paragraph nil)
5443 (goto-char marker)
5444 ;; Is not enough, sometimes marker is a start of line
5445 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5446 (goto-char (match-end 0))))
5447 ;; Following space could have gone:
5448 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
5449 (insert " ")
5450 (backward-char 1))
5451 ;; Previous space could have gone:
5452 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
5453
5454 (defun cperl-imenu-addback (lst &optional isback name)
5455 ;; We suppose that the lst is a DAG, unless the first element only
5456 ;; loops back, and ISBACK is set. Thus this function cannot be
5457 ;; applied twice without ISBACK set.
5458 (cond ((not cperl-imenu-addback) lst)
5459 (t
5460 (or name
5461 (setq name "+++BACK+++"))
5462 (mapc (lambda (elt)
5463 (if (and (listp elt) (listp (cdr elt)))
5464 (progn
5465 ;; In the other order it goes up
5466 ;; one level only ;-(
5467 (setcdr elt (cons (cons name lst)
5468 (cdr elt)))
5469 (cperl-imenu-addback (cdr elt) t name))))
5470 (if isback (cdr lst) lst))
5471 lst)))
5472
5473 (defun cperl-imenu--create-perl-index (&optional regexp)
5474 (require 'imenu) ; May be called from TAGS creator
5475 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
5476 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5477 (index-meth-alist '()) meth
5478 packages ends-ranges p marker is-proto
5479 (prev-pos 0) is-pack index index1 name (end-range 0) package)
5480 (goto-char (point-min))
5481 (cperl-update-syntaxification (point-max) (point-max))
5482 ;; Search for the function
5483 (progn ;;save-match-data
5484 (while (re-search-forward
5485 (or regexp cperl-imenu--function-name-regexp-perl)
5486 nil t)
5487 ;; 2=package-group, 5=package-name 8=sub-name
5488 (cond
5489 ((and ; Skip some noise if building tags
5490 (match-beginning 5) ; package name
5491 ;;(eq (char-after (match-beginning 2)) ?p) ; package
5492 (not (save-match-data
5493 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
5494 nil)
5495 ((and
5496 (or (match-beginning 2)
5497 (match-beginning 8)) ; package or sub
5498 ;; Skip if quoted (will not skip multi-line ''-strings :-():
5499 (null (get-text-property (match-beginning 1) 'syntax-table))
5500 (null (get-text-property (match-beginning 1) 'syntax-type))
5501 (null (get-text-property (match-beginning 1) 'in-pod)))
5502 (setq is-pack (match-beginning 2))
5503 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5504 ;; (goto-char (match-end 0))) ; Messes what follows
5505 (setq meth nil
5506 p (point))
5507 (while (and ends-ranges (>= p (car ends-ranges)))
5508 ;; delete obsolete entries
5509 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5510 (setq package (or (car packages) "")
5511 end-range (or (car ends-ranges) 0))
5512 (if is-pack ; doing "package"
5513 (progn
5514 (if (match-beginning 5) ; named package
5515 (setq name (buffer-substring (match-beginning 5)
5516 (match-end 5))
5517 name (progn
5518 (set-text-properties 0 (length name) nil name)
5519 name)
5520 package (concat name "::")
5521 name (concat "package " name))
5522 ;; Support nameless packages
5523 (setq name "package;" package ""))
5524 (setq end-range
5525 (save-excursion
5526 (parse-partial-sexp (point) (point-max) -1) (point))
5527 ends-ranges (cons end-range ends-ranges)
5528 packages (cons package packages)))
5529 (setq is-proto
5530 (or (eq (following-char) ?\;)
5531 (eq 0 (get-text-property (point) 'attrib-group)))))
5532 ;; Skip this function name if it is a prototype declaration.
5533 (if (and is-proto (not is-pack)) nil
5534 (or is-pack
5535 (setq name
5536 (buffer-substring (match-beginning 8) (match-end 8)))
5537 (set-text-properties 0 (length name) nil name))
5538 (setq marker (make-marker))
5539 (set-marker marker (match-end (if is-pack 2 8)))
5540 (cond (is-pack nil)
5541 ((string-match "[:']" name)
5542 (setq meth t))
5543 ((> p end-range) nil)
5544 (t
5545 (setq name (concat package name) meth t)))
5546 (setq index (cons name marker))
5547 (if is-pack
5548 (push index index-pack-alist)
5549 (push index index-alist))
5550 (if meth (push index index-meth-alist))
5551 (push index index-unsorted-alist)))
5552 ((match-beginning 16) ; POD section
5553 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5554 marker (make-marker))
5555 (set-marker marker (match-beginning 17))
5556 (set-text-properties 0 (length name) nil name)
5557 (setq name (concat (make-string
5558 (* 3 (- (char-after (match-beginning 16)) ?1))
5559 ?\ )
5560 name)
5561 index (cons name marker))
5562 (setq index1 (cons (concat "=" name) (cdr index)))
5563 (push index index-pod-alist)
5564 (push index1 index-unsorted-alist)))))
5565 (setq index-alist
5566 (if (default-value 'imenu-sort-function)
5567 (sort index-alist (default-value 'imenu-sort-function))
5568 (nreverse index-alist)))
5569 (and index-pod-alist
5570 (push (cons "+POD headers+..."
5571 (nreverse index-pod-alist))
5572 index-alist))
5573 (and (or index-pack-alist index-meth-alist)
5574 (let ((lst index-pack-alist) hier-list pack elt group name)
5575 ;; Remove "package ", reverse and uniquify.
5576 (while lst
5577 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5578 (if (assoc name hier-list) nil
5579 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5580 (setq lst index-meth-alist)
5581 (while lst
5582 (setq elt (car lst) lst (cdr lst))
5583 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5584 (setq pack (substring (car elt) 0 (match-beginning 0)))
5585 (if (setq group (assoc pack hier-list))
5586 (if (listp (cdr group))
5587 ;; Have some functions already
5588 (setcdr group
5589 (cons (cons (substring
5590 (car elt)
5591 (+ 2 (match-beginning 0)))
5592 (cdr elt))
5593 (cdr group)))
5594 (setcdr group (list (cons (substring
5595 (car elt)
5596 (+ 2 (match-beginning 0)))
5597 (cdr elt)))))
5598 (setq hier-list
5599 (cons (cons pack
5600 (list (cons (substring
5601 (car elt)
5602 (+ 2 (match-beginning 0)))
5603 (cdr elt))))
5604 hier-list))))))
5605 (push (cons "+Hierarchy+..."
5606 hier-list)
5607 index-alist)))
5608 (and index-pack-alist
5609 (push (cons "+Packages+..."
5610 (nreverse index-pack-alist))
5611 index-alist))
5612 (and (or index-pack-alist index-pod-alist
5613 (default-value 'imenu-sort-function))
5614 index-unsorted-alist
5615 (push (cons "+Unsorted List+..."
5616 (nreverse index-unsorted-alist))
5617 index-alist))
5618 (cperl-imenu-addback index-alist)))
5619
5620 \f
5621 ;; Suggested by Mark A. Hershberger
5622 (defun cperl-outline-level ()
5623 (looking-at outline-regexp)
5624 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
5625 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5626 ((match-beginning 2) 0) ; package
5627 ((match-beginning 8) 1) ; sub
5628 ((match-beginning 16)
5629 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5630 (t 5))) ; should not happen
5631
5632 \f
5633 (defun cperl-windowed-init ()
5634 "Initialization under windowed version."
5635 (cond ((featurep 'ps-print)
5636 (or cperl-faces-init
5637 (progn
5638 (and (boundp 'font-lock-multiline)
5639 (setq cperl-font-lock-multiline t))
5640 (cperl-init-faces))))
5641 ((not cperl-faces-init)
5642 (add-hook 'font-lock-mode-hook
5643 (function
5644 (lambda ()
5645 (if (memq major-mode '(perl-mode cperl-mode))
5646 (progn
5647 (or cperl-faces-init (cperl-init-faces)))))))
5648 (if (fboundp 'eval-after-load)
5649 (eval-after-load
5650 "ps-print"
5651 '(or cperl-faces-init (cperl-init-faces)))))))
5652
5653 (defvar cperl-font-lock-keywords-1 nil
5654 "Additional expressions to highlight in Perl mode. Minimal set.")
5655 (defvar cperl-font-lock-keywords nil
5656 "Additional expressions to highlight in Perl mode. Default set.")
5657 (defvar cperl-font-lock-keywords-2 nil
5658 "Additional expressions to highlight in Perl mode. Maximal set")
5659
5660 (defun cperl-load-font-lock-keywords ()
5661 (or cperl-faces-init (cperl-init-faces))
5662 cperl-font-lock-keywords)
5663
5664 (defun cperl-load-font-lock-keywords-1 ()
5665 (or cperl-faces-init (cperl-init-faces))
5666 cperl-font-lock-keywords-1)
5667
5668 (defun cperl-load-font-lock-keywords-2 ()
5669 (or cperl-faces-init (cperl-init-faces))
5670 cperl-font-lock-keywords-2)
5671
5672 (defun cperl-init-faces-weak ()
5673 ;; Allow `cperl-find-pods-heres' to run.
5674 (or (boundp 'font-lock-constant-face)
5675 (cperl-force-face font-lock-constant-face
5676 "Face for constant and label names"))
5677 (or (boundp 'font-lock-warning-face)
5678 (cperl-force-face font-lock-warning-face
5679 "Face for things which should stand out"))
5680 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5681 )
5682
5683 (defun cperl-init-faces ()
5684 (condition-case errs
5685 (progn
5686 (require 'font-lock)
5687 (and (fboundp 'font-lock-fontify-anchored-keywords)
5688 (featurep 'font-lock-extra)
5689 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5690 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
5691 (if (fboundp 'font-lock-fontify-anchored-keywords)
5692 (setq font-lock-anchored t))
5693 (setq
5694 t-font-lock-keywords
5695 (list
5696 `("[ \t]+$" 0 ',cperl-invalid-face t)
5697 (cons
5698 (concat
5699 "\\(^\\|[^$@%&\\]\\)\\<\\("
5700 (mapconcat
5701 'identity
5702 '("if" "until" "while" "elsif" "else" "unless" "for"
5703 "foreach" "continue" "exit" "die" "last" "goto" "next"
5704 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
5705 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
5706 "\\|") ; Flow control
5707 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5708 ; In what follows we use `type' style
5709 ; for overwritable builtins
5710 (list
5711 (concat
5712 "\\(^\\|[^$@%&\\]\\)\\<\\("
5713 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5714 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5715 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5716 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5717 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5718 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5719 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5720 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5721 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5722 ;; "gethostbyname" "gethostent" "getlogin"
5723 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5724 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5725 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5726 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5727 ;; "getservbyport" "getservent" "getsockname"
5728 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5729 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5730 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
5731 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5732 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5733 ;; "quotemeta" "rand" "read" "readdir" "readline"
5734 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5735 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5736 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5737 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5738 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5739 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5740 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5741 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
5742 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
5743 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5744 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5745 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5746 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
5747 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5748 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5749 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5750 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5751 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5752 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5753 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5754 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5755 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5756 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5757 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5758 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5759 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5760 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5761 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5762 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
5763 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5764 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5765 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5766 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5767 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5768 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5769 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5770 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
5771 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
5772 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5773 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5774 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5775 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5776 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5777 "\\)\\>") 2 'font-lock-type-face)
5778 ;; In what follows we use `other' style
5779 ;; for nonoverwritable builtins
5780 ;; Somehow 's', 'm' are not auto-generated???
5781 (list
5782 (concat
5783 "\\(^\\|[^$@%&\\]\\)\\<\\("
5784 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
5785 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5786 ;; "eval" "exists" "for" "foreach" "format" "goto"
5787 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
5788 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
5789 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5790 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5791 ;; "undef" "unless" "unshift" "untie" "until" "use"
5792 ;; "while" "y"
5793 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
5794 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
5795 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5796 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
5797 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5798 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
5799 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5800 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5801 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5802 "\\|[sm]" ; Added manually
5803 "\\)\\>") 2 'cperl-nonoverridable-face)
5804 ;; (mapconcat 'identity
5805 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5806 ;; "#include" "#define" "#undef")
5807 ;; "\\|")
5808 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5809 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5810 ;; This highlights declarations and definitions differenty.
5811 ;; We do not try to highlight in the case of attributes:
5812 ;; it is already done by `cperl-find-pods-heres'
5813 (list (concat "\\<sub"
5814 cperl-white-and-comment-rex ; whitespace/comments
5815 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5816 "\\("
5817 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5818 "([^()]*)\\)?" ; prototype
5819 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5820 "[{;]")
5821 2 (if cperl-font-lock-multiline
5822 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5823 'font-lock-function-name-face
5824 'font-lock-variable-name-face)
5825 ;; need to manually set 'multiline' for older font-locks
5826 '(progn
5827 (if (< 1 (count-lines (match-beginning 0)
5828 (match-end 0)))
5829 (put-text-property
5830 (+ 3 (match-beginning 0)) (match-end 0)
5831 'syntax-type 'multiline))
5832 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5833 'font-lock-function-name-face
5834 'font-lock-variable-name-face))))
5835 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5836 2 font-lock-function-name-face)
5837 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5838 1 font-lock-function-name-face)
5839 (cond ((featurep 'font-lock-extra)
5840 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5841 (2 font-lock-string-face t)
5842 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5843 (font-lock-anchored
5844 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5845 (2 font-lock-string-face t)
5846 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5847 nil nil
5848 (1 font-lock-string-face t))))
5849 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5850 2 font-lock-string-face t)))
5851 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
5852 font-lock-string-face t)
5853 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
5854 font-lock-constant-face) ; labels
5855 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
5856 2 font-lock-constant-face)
5857 ;; Uncomment to get perl-mode-like vars
5858 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5859 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5860 ;;; (2 (cons font-lock-variable-name-face '(underline))))
5861 (cond ((featurep 'font-lock-extra)
5862 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5863 (3 font-lock-variable-name-face)
5864 (4 '(another 4 nil
5865 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5866 (1 font-lock-variable-name-face)
5867 (2 '(restart 2 nil) nil t)))
5868 nil t))) ; local variables, multiple
5869 (font-lock-anchored
5870 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
5871 `(,(concat "\\<\\(my\\|local\\|our\\)"
5872 cperl-maybe-white-and-comment-rex
5873 "\\(("
5874 cperl-maybe-white-and-comment-rex
5875 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5876 (5 ,(if cperl-font-lock-multiline
5877 'font-lock-variable-name-face
5878 '(progn (setq cperl-font-lock-multiline-start
5879 (match-beginning 0))
5880 'font-lock-variable-name-face)))
5881 (,(concat "\\="
5882 cperl-maybe-white-and-comment-rex
5883 ","
5884 cperl-maybe-white-and-comment-rex
5885 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5886 ;; Bug in font-lock: limit is used not only to limit
5887 ;; searches, but to set the "extend window for
5888 ;; facification" property. Thus we need to minimize.
5889 ,(if cperl-font-lock-multiline
5890 '(if (match-beginning 3)
5891 (save-excursion
5892 (goto-char (match-beginning 3))
5893 (condition-case nil
5894 (forward-sexp 1)
5895 (error
5896 (condition-case nil
5897 (forward-char 200)
5898 (error nil)))) ; typeahead
5899 (1- (point))) ; report limit
5900 (forward-char -2)) ; disable continued expr
5901 '(if (match-beginning 3)
5902 (point-max) ; No limit for continuation
5903 (forward-char -2))) ; disable continued expr
5904 ,(if cperl-font-lock-multiline
5905 nil
5906 '(progn ; Do at end
5907 ;; "my" may be already fontified (POD),
5908 ;; so cperl-font-lock-multiline-start is nil
5909 (if (or (not cperl-font-lock-multiline-start)
5910 (> 2 (count-lines
5911 cperl-font-lock-multiline-start
5912 (point))))
5913 nil
5914 (put-text-property
5915 (1+ cperl-font-lock-multiline-start) (point)
5916 'syntax-type 'multiline))
5917 (setq cperl-font-lock-multiline-start nil)))
5918 (3 font-lock-variable-name-face))))
5919 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
5920 3 font-lock-variable-name-face)))
5921 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
5922 4 font-lock-variable-name-face)
5923 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
5924 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
5925 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
5926 (setq
5927 t-font-lock-keywords-1
5928 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
5929 ;; not yet as of XEmacs 19.12, works with 21.1.11
5930 (or
5931 (not (featurep 'xemacs))
5932 (string< "21.1.9" emacs-version)
5933 (and (string< "21.1.10" emacs-version)
5934 (string< emacs-version "21.1.2")))
5935 '(
5936 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5937 (if (eq (char-after (match-beginning 2)) ?%)
5938 'cperl-hash-face
5939 'cperl-array-face)
5940 t) ; arrays and hashes
5941 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5942 1
5943 (if (= (- (match-end 2) (match-beginning 2)) 1)
5944 (if (eq (char-after (match-beginning 3)) ?{)
5945 'cperl-hash-face
5946 'cperl-array-face) ; arrays and hashes
5947 font-lock-variable-name-face) ; Just to put something
5948 t)
5949 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5950 (1 cperl-array-face)
5951 (2 font-lock-variable-name-face))
5952 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5953 (1 cperl-hash-face)
5954 (2 font-lock-variable-name-face))
5955 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5956 ;;; Too much noise from \s* @s[ and friends
5957 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
5958 ;;(3 font-lock-function-name-face t t)
5959 ;;(4
5960 ;; (if (cperl-slash-is-regexp)
5961 ;; font-lock-function-name-face 'default) nil t))
5962 )))
5963 (if cperl-highlight-variables-indiscriminately
5964 (setq t-font-lock-keywords-1
5965 (append t-font-lock-keywords-1
5966 (list '("\\([$*]{?\\sw+\\)" 1
5967 font-lock-variable-name-face)))))
5968 (setq cperl-font-lock-keywords-1
5969 (if cperl-syntaxify-by-font-lock
5970 (cons 'cperl-fontify-update
5971 t-font-lock-keywords)
5972 t-font-lock-keywords)
5973 cperl-font-lock-keywords cperl-font-lock-keywords-1
5974 cperl-font-lock-keywords-2 (append
5975 cperl-font-lock-keywords-1
5976 t-font-lock-keywords-1)))
5977 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5978 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
5979 (eval ; Avoid a warning
5980 '(font-lock-require-faces
5981 (list
5982 ;; Color-light Color-dark Gray-light Gray-dark Mono
5983 (list 'font-lock-comment-face
5984 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5985 nil
5986 [nil nil t t t]
5987 [nil nil t t t]
5988 nil)
5989 (list 'font-lock-string-face
5990 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5991 nil
5992 nil
5993 [nil nil t t t]
5994 nil)
5995 (list 'font-lock-function-name-face
5996 (vector
5997 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5998 (cdr (assq 'background-color ; if mono
5999 (frame-parameters))))
6000 (vector
6001 nil nil nil nil
6002 (cdr (assq 'foreground-color ; if mono
6003 (frame-parameters))))
6004 [nil nil t t t]
6005 nil
6006 nil)
6007 (list 'font-lock-variable-name-face
6008 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6009 nil
6010 [nil nil t t t]
6011 [nil nil t t t]
6012 nil)
6013 (list 'font-lock-type-face
6014 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6015 nil
6016 [nil nil t t t]
6017 nil
6018 [nil nil t t t])
6019 (list 'font-lock-warning-face
6020 ["Pink" "Red" "Gray50" "LightGray"]
6021 ["gray20" "gray90"
6022 "gray80" "gray20"]
6023 [nil nil t t t]
6024 nil
6025 [nil nil t t t]
6026 )
6027 (list 'font-lock-constant-face
6028 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6029 nil
6030 [nil nil t t t]
6031 nil
6032 [nil nil t t t])
6033 (list 'cperl-nonoverridable-face
6034 ["chartreuse3" ("orchid1" "orange")
6035 nil "Gray80"]
6036 [nil nil "gray90"]
6037 [nil nil nil t t]
6038 [nil nil t t]
6039 [nil nil t t t])
6040 (list 'cperl-array-face
6041 ["blue" "yellow" nil "Gray80"]
6042 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6043 "gray90"]
6044 t
6045 nil
6046 nil)
6047 (list 'cperl-hash-face
6048 ["red" "red" nil "Gray80"]
6049 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6050 "gray90"]
6051 t
6052 t
6053 nil))))
6054 ;; Do it the dull way, without choose-color
6055 (defvar cperl-guessed-background nil
6056 "Display characteristics as guessed by cperl.")
6057 ;; (or (fboundp 'x-color-defined-p)
6058 ;; (defalias 'x-color-defined-p
6059 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6060 ;; ;; XEmacs >= 19.12
6061 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6062 ;; ;; XEmacs 19.11
6063 ;; (t 'x-valid-color-name-p))))
6064 (cperl-force-face font-lock-constant-face
6065 "Face for constant and label names")
6066 (cperl-force-face font-lock-variable-name-face
6067 "Face for variable names")
6068 (cperl-force-face font-lock-type-face
6069 "Face for data types")
6070 (cperl-force-face cperl-nonoverridable-face
6071 "Face for data types from another group")
6072 (cperl-force-face font-lock-warning-face
6073 "Face for things which should stand out")
6074 (cperl-force-face font-lock-comment-face
6075 "Face for comments")
6076 (cperl-force-face font-lock-function-name-face
6077 "Face for function names")
6078 (cperl-force-face cperl-hash-face
6079 "Face for hashes")
6080 (cperl-force-face cperl-array-face
6081 "Face for arrays")
6082 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6083 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6084 ;;(or (boundp 'font-lock-type-face)
6085 ;; (defconst font-lock-type-face
6086 ;; 'font-lock-type-face
6087 ;; "Face to use for data types."))
6088 ;;(or (boundp 'cperl-nonoverridable-face)
6089 ;; (defconst cperl-nonoverridable-face
6090 ;; 'cperl-nonoverridable-face
6091 ;; "Face to use for data types from another group."))
6092 ;;(if (not (featurep 'xemacs)) nil
6093 ;; (or (boundp 'font-lock-comment-face)
6094 ;; (defconst font-lock-comment-face
6095 ;; 'font-lock-comment-face
6096 ;; "Face to use for comments."))
6097 ;; (or (boundp 'font-lock-keyword-face)
6098 ;; (defconst font-lock-keyword-face
6099 ;; 'font-lock-keyword-face
6100 ;; "Face to use for keywords."))
6101 ;; (or (boundp 'font-lock-function-name-face)
6102 ;; (defconst font-lock-function-name-face
6103 ;; 'font-lock-function-name-face
6104 ;; "Face to use for function names.")))
6105 (if (and
6106 (not (cperl-is-face 'cperl-array-face))
6107 (cperl-is-face 'font-lock-emphasized-face))
6108 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
6109 (if (and
6110 (not (cperl-is-face 'cperl-hash-face))
6111 (cperl-is-face 'font-lock-other-emphasized-face))
6112 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
6113 (if (and
6114 (not (cperl-is-face 'cperl-nonoverridable-face))
6115 (cperl-is-face 'font-lock-other-type-face))
6116 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
6117 ;;(or (boundp 'cperl-hash-face)
6118 ;; (defconst cperl-hash-face
6119 ;; 'cperl-hash-face
6120 ;; "Face to use for hashes."))
6121 ;;(or (boundp 'cperl-array-face)
6122 ;; (defconst cperl-array-face
6123 ;; 'cperl-array-face
6124 ;; "Face to use for arrays."))
6125 ;; Here we try to guess background
6126 (let ((background
6127 (if (boundp 'font-lock-background-mode)
6128 font-lock-background-mode
6129 'light))
6130 (face-list (and (fboundp 'face-list) (face-list))))
6131 ;;;; (fset 'cperl-is-face
6132 ;;;; (cond ((fboundp 'find-face)
6133 ;;;; (symbol-function 'find-face))
6134 ;;;; (face-list
6135 ;;;; (function (lambda (face) (member face face-list))))
6136 ;;;; (t
6137 ;;;; (function (lambda (face) (boundp face))))))
6138 (defvar cperl-guessed-background
6139 (if (and (boundp 'font-lock-display-type)
6140 (eq font-lock-display-type 'grayscale))
6141 'gray
6142 background)
6143 "Background as guessed by CPerl mode")
6144 (and (not (cperl-is-face 'font-lock-constant-face))
6145 (cperl-is-face 'font-lock-reference-face)
6146 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
6147 (if (cperl-is-face 'font-lock-type-face) nil
6148 (copy-face 'default 'font-lock-type-face)
6149 (cond
6150 ((eq background 'light)
6151 (set-face-foreground 'font-lock-type-face
6152 (if (x-color-defined-p "seagreen")
6153 "seagreen"
6154 "sea green")))
6155 ((eq background 'dark)
6156 (set-face-foreground 'font-lock-type-face
6157 (if (x-color-defined-p "os2pink")
6158 "os2pink"
6159 "pink")))
6160 (t
6161 (set-face-background 'font-lock-type-face "gray90"))))
6162 (if (cperl-is-face 'cperl-nonoverridable-face)
6163 nil
6164 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
6165 (cond
6166 ((eq background 'light)
6167 (set-face-foreground 'cperl-nonoverridable-face
6168 (if (x-color-defined-p "chartreuse3")
6169 "chartreuse3"
6170 "chartreuse")))
6171 ((eq background 'dark)
6172 (set-face-foreground 'cperl-nonoverridable-face
6173 (if (x-color-defined-p "orchid1")
6174 "orchid1"
6175 "orange")))))
6176 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6177 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6178 ;;; (cond
6179 ;;; ((eq background 'light)
6180 ;;; (set-face-background 'font-lock-other-emphasized-face
6181 ;;; (if (x-color-defined-p "lightyellow2")
6182 ;;; "lightyellow2"
6183 ;;; (if (x-color-defined-p "lightyellow")
6184 ;;; "lightyellow"
6185 ;;; "light yellow"))))
6186 ;;; ((eq background 'dark)
6187 ;;; (set-face-background 'font-lock-other-emphasized-face
6188 ;;; (if (x-color-defined-p "navy")
6189 ;;; "navy"
6190 ;;; (if (x-color-defined-p "darkgreen")
6191 ;;; "darkgreen"
6192 ;;; "dark green"))))
6193 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6194 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6195 ;;; (copy-face 'bold 'font-lock-emphasized-face)
6196 ;;; (cond
6197 ;;; ((eq background 'light)
6198 ;;; (set-face-background 'font-lock-emphasized-face
6199 ;;; (if (x-color-defined-p "lightyellow2")
6200 ;;; "lightyellow2"
6201 ;;; "lightyellow")))
6202 ;;; ((eq background 'dark)
6203 ;;; (set-face-background 'font-lock-emphasized-face
6204 ;;; (if (x-color-defined-p "navy")
6205 ;;; "navy"
6206 ;;; (if (x-color-defined-p "darkgreen")
6207 ;;; "darkgreen"
6208 ;;; "dark green"))))
6209 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
6210 (if (cperl-is-face 'font-lock-variable-name-face) nil
6211 (copy-face 'italic 'font-lock-variable-name-face))
6212 (if (cperl-is-face 'font-lock-constant-face) nil
6213 (copy-face 'italic 'font-lock-constant-face))))
6214 (setq cperl-faces-init t))
6215 (error (message "cperl-init-faces (ignored): %s" errs))))
6216
6217
6218 (defun cperl-ps-print-init ()
6219 "Initialization of `ps-print' components for faces used in CPerl."
6220 (eval-after-load "ps-print"
6221 '(setq ps-bold-faces
6222 ;; font-lock-variable-name-face
6223 ;; font-lock-constant-face
6224 (append '(cperl-array-face cperl-hash-face)
6225 ps-bold-faces)
6226 ps-italic-faces
6227 ;; font-lock-constant-face
6228 (append '(cperl-nonoverridable-face cperl-hash-face)
6229 ps-italic-faces)
6230 ps-underlined-faces
6231 ;; font-lock-type-face
6232 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
6233 ps-underlined-faces))))
6234
6235 (defvar ps-print-face-extension-alist)
6236
6237 (defun cperl-ps-print (&optional file)
6238 "Pretty-print in CPerl style.
6239 If optional argument FILE is an empty string, prints to printer, otherwise
6240 to the file FILE. If FILE is nil, prompts for a file name.
6241
6242 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6243 (interactive)
6244 (or file
6245 (setq file (read-from-minibuffer
6246 "Print to file (if empty - to printer): "
6247 (concat (buffer-file-name) ".ps")
6248 nil nil 'file-name-history)))
6249 (or (> (length file) 0)
6250 (setq file nil))
6251 (require 'ps-print) ; To get ps-print-face-extension-alist
6252 (let ((ps-print-color-p t)
6253 (ps-print-face-extension-alist ps-print-face-extension-alist))
6254 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6255 (ps-print-buffer-with-faces file)))
6256
6257 ;;; (defun cperl-ps-print-init ()
6258 ;;; "Initialization of `ps-print' components for faces used in CPerl."
6259 ;;; ;; Guard against old versions
6260 ;;; (defvar ps-underlined-faces nil)
6261 ;;; (defvar ps-bold-faces nil)
6262 ;;; (defvar ps-italic-faces nil)
6263 ;;; (setq ps-bold-faces
6264 ;;; (append '(font-lock-emphasized-face
6265 ;;; cperl-array-face
6266 ;;; font-lock-keyword-face
6267 ;;; font-lock-variable-name-face
6268 ;;; font-lock-constant-face
6269 ;;; font-lock-reference-face
6270 ;;; font-lock-other-emphasized-face
6271 ;;; cperl-hash-face)
6272 ;;; ps-bold-faces))
6273 ;;; (setq ps-italic-faces
6274 ;;; (append '(cperl-nonoverridable-face
6275 ;;; font-lock-constant-face
6276 ;;; font-lock-reference-face
6277 ;;; font-lock-other-emphasized-face
6278 ;;; cperl-hash-face)
6279 ;;; ps-italic-faces))
6280 ;;; (setq ps-underlined-faces
6281 ;;; (append '(font-lock-emphasized-face
6282 ;;; cperl-array-face
6283 ;;; font-lock-other-emphasized-face
6284 ;;; cperl-hash-face
6285 ;;; cperl-nonoverridable-face font-lock-type-face)
6286 ;;; ps-underlined-faces))
6287 ;;; (cons 'font-lock-type-face ps-underlined-faces))
6288
6289
6290 (if (cperl-enable-font-lock) (cperl-windowed-init))
6291
6292 (defconst cperl-styles-entries
6293 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6294 cperl-label-offset cperl-extra-newline-before-brace
6295 cperl-extra-newline-before-brace-multiline
6296 cperl-merge-trailing-else
6297 cperl-continued-statement-offset))
6298
6299 (defconst cperl-style-examples
6300 "##### Numbers etc are: cperl-indent-level cperl-brace-offset
6301 ##### cperl-continued-brace-offset cperl-label-offset
6302 ##### cperl-continued-statement-offset
6303 ##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6304
6305 ########### (Do not forget cperl-extra-newline-before-brace-multiline)
6306
6307 ### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6308 if (foo) {
6309 bar
6310 baz;
6311 label:
6312 {
6313 boon;
6314 }
6315 } else {
6316 stop;
6317 }
6318
6319 ### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6320 if (foo) {
6321 bar
6322 baz;
6323 label:
6324 {
6325 boon;
6326 }
6327 } else {
6328 stop;
6329 }
6330
6331 ### GNU 2/0/0/-2/2/nil/t
6332 if (foo)
6333 {
6334 bar
6335 baz;
6336 label:
6337 {
6338 boon;
6339 }
6340 }
6341 else
6342 {
6343 stop;
6344 }
6345
6346 ### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6347 if (foo)
6348 {
6349 bar
6350 baz;
6351 label:
6352 {
6353 boon;
6354 }
6355 }
6356 else
6357 {
6358 stop;
6359 }
6360
6361 ### BSD (=C++, but will not change preexisting merge-trailing-else
6362 ### and extra-newline-before-brace ) 4/0/-4/-4/4
6363 if (foo)
6364 {
6365 bar
6366 baz;
6367 label:
6368 {
6369 boon;
6370 }
6371 }
6372 else
6373 {
6374 stop;
6375 }
6376
6377 ### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6378 ### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6379 if (foo)
6380 {
6381 bar
6382 baz;
6383 label:
6384 {
6385 boon;
6386 }
6387 }
6388 else
6389 {
6390 stop;
6391 }
6392
6393 ### Whitesmith (=PerlStyle, but will not change preexisting
6394 ### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6395 if (foo)
6396 {
6397 bar
6398 baz;
6399 label:
6400 {
6401 boon;
6402 }
6403 }
6404 else
6405 {
6406 stop;
6407 }
6408 "
6409 "Examples of if/else with different indent styles (with v4.23).")
6410
6411 (defconst cperl-style-alist
6412 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
6413 (cperl-indent-level . 2)
6414 (cperl-brace-offset . 0)
6415 (cperl-continued-brace-offset . 0)
6416 (cperl-label-offset . -2)
6417 (cperl-continued-statement-offset . 2)
6418 (cperl-extra-newline-before-brace . nil)
6419 (cperl-extra-newline-before-brace-multiline . nil)
6420 (cperl-merge-trailing-else . t))
6421
6422 ("PerlStyle" ; CPerl with 4 as indent
6423 (cperl-indent-level . 4)
6424 (cperl-brace-offset . 0)
6425 (cperl-continued-brace-offset . 0)
6426 (cperl-label-offset . -4)
6427 (cperl-continued-statement-offset . 4)
6428 (cperl-extra-newline-before-brace . nil)
6429 (cperl-extra-newline-before-brace-multiline . nil)
6430 (cperl-merge-trailing-else . t))
6431
6432 ("GNU"
6433 (cperl-indent-level . 2)
6434 (cperl-brace-offset . 0)
6435 (cperl-continued-brace-offset . 0)
6436 (cperl-label-offset . -2)
6437 (cperl-continued-statement-offset . 2)
6438 (cperl-extra-newline-before-brace . t)
6439 (cperl-extra-newline-before-brace-multiline . t)
6440 (cperl-merge-trailing-else . nil))
6441
6442 ("K&R"
6443 (cperl-indent-level . 5)
6444 (cperl-brace-offset . 0)
6445 (cperl-continued-brace-offset . -5)
6446 (cperl-label-offset . -5)
6447 (cperl-continued-statement-offset . 5)
6448 ;;(cperl-extra-newline-before-brace . nil) ; ???
6449 ;;(cperl-extra-newline-before-brace-multiline . nil)
6450 (cperl-merge-trailing-else . nil))
6451
6452 ("BSD"
6453 (cperl-indent-level . 4)
6454 (cperl-brace-offset . 0)
6455 (cperl-continued-brace-offset . -4)
6456 (cperl-label-offset . -4)
6457 (cperl-continued-statement-offset . 4)
6458 ;;(cperl-extra-newline-before-brace . nil) ; ???
6459 ;;(cperl-extra-newline-before-brace-multiline . nil)
6460 ;;(cperl-merge-trailing-else . nil) ; ???
6461 )
6462
6463 ("C++"
6464 (cperl-indent-level . 4)
6465 (cperl-brace-offset . 0)
6466 (cperl-continued-brace-offset . -4)
6467 (cperl-label-offset . -4)
6468 (cperl-continued-statement-offset . 4)
6469 (cperl-extra-newline-before-brace . t)
6470 (cperl-extra-newline-before-brace-multiline . t)
6471 (cperl-merge-trailing-else . nil))
6472
6473 ("Whitesmith"
6474 (cperl-indent-level . 4)
6475 (cperl-brace-offset . 0)
6476 (cperl-continued-brace-offset . 0)
6477 (cperl-label-offset . -4)
6478 (cperl-continued-statement-offset . 4)
6479 ;;(cperl-extra-newline-before-brace . nil) ; ???
6480 ;;(cperl-extra-newline-before-brace-multiline . nil)
6481 ;;(cperl-merge-trailing-else . nil) ; ???
6482 )
6483 ("Current"))
6484 "List of variables to set to get a particular indentation style.
6485 Should be used via `cperl-set-style' or via Perl menu.
6486
6487 See examples in `cperl-style-examples'.")
6488
6489 (defun cperl-set-style (style)
6490 "Set CPerl mode variables to use one of several different indentation styles.
6491 The arguments are a string representing the desired style.
6492 The list of styles is in `cperl-style-alist', available styles
6493 are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
6494
6495 The current value of style is memorized (unless there is a memorized
6496 data already), may be restored by `cperl-set-style-back'.
6497
6498 Chosing \"Current\" style will not change style, so this may be used for
6499 side-effect of memorizing only. Examples in `cperl-style-examples'."
6500 (interactive
6501 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
6502 cperl-style-alist)))
6503 (list (completing-read "Enter style: " list nil 'insist))))
6504 (or cperl-old-style
6505 (setq cperl-old-style
6506 (mapcar (function
6507 (lambda (name)
6508 (cons name (eval name))))
6509 cperl-styles-entries)))
6510 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
6511 (while style
6512 (setq setting (car style) style (cdr style))
6513 (set (car setting) (cdr setting)))))
6514
6515 (defun cperl-set-style-back ()
6516 "Restore a style memorized by `cperl-set-style'."
6517 (interactive)
6518 (or cperl-old-style (error "The style was not changed"))
6519 (let (setting)
6520 (while cperl-old-style
6521 (setq setting (car cperl-old-style)
6522 cperl-old-style (cdr cperl-old-style))
6523 (set (car setting) (cdr setting)))))
6524
6525 (defun cperl-check-syntax ()
6526 (interactive)
6527 (require 'mode-compile)
6528 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6529 (eval '(mode-compile)))) ; Avoid a warning
6530
6531 (defun cperl-info-buffer (type)
6532 ;; Returns buffer with documentation. Creates if missing.
6533 ;; If TYPE, this vars buffer.
6534 ;; Special care is taken to not stomp over an existing info buffer
6535 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6536 (info (get-buffer bname))
6537 (oldbuf (get-buffer "*info*")))
6538 (if info info
6539 (save-window-excursion
6540 ;; Get Info running
6541 (require 'info)
6542 (cond (oldbuf
6543 (set-buffer oldbuf)
6544 (rename-buffer "*info-perl-tmp*")))
6545 (save-window-excursion
6546 (info))
6547 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6548 (set-buffer "*info*")
6549 (rename-buffer bname)
6550 (cond (oldbuf
6551 (set-buffer "*info-perl-tmp*")
6552 (rename-buffer "*info*")
6553 (set-buffer bname)))
6554 (make-local-variable 'window-min-height)
6555 (setq window-min-height 2)
6556 (current-buffer)))))
6557
6558 (defun cperl-word-at-point (&optional p)
6559 "Return the word at point or at P."
6560 (save-excursion
6561 (if p (goto-char p))
6562 (or (cperl-word-at-point-hard)
6563 (progn
6564 (require 'etags)
6565 (funcall (or (and (boundp 'find-tag-default-function)
6566 find-tag-default-function)
6567 (get major-mode 'find-tag-default-function)
6568 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6569 ;; automatically used within `find-tag-default':
6570 'find-tag-default))))))
6571
6572 (defun cperl-info-on-command (command)
6573 "Show documentation for Perl command COMMAND in other window.
6574 If perl-info buffer is shown in some frame, uses this frame.
6575 Customized by setting variables `cperl-shrink-wrap-info-frame',
6576 `cperl-max-help-size'."
6577 (interactive
6578 (let* ((default (cperl-word-at-point))
6579 (read (read-string
6580 (format "Find doc for Perl function (default %s): "
6581 default))))
6582 (list (if (equal read "")
6583 default
6584 read))))
6585
6586 (let ((buffer (current-buffer))
6587 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6588 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6589 max-height char-height buf-list)
6590 (if (string-match "^-[a-zA-Z]$" command)
6591 (setq cmd-desc "^-X[ \t\n]"))
6592 (setq isvar (string-match "^[$@%]" command)
6593 buf (cperl-info-buffer isvar)
6594 iniwin (selected-window)
6595 fr1 (window-frame iniwin))
6596 (set-buffer buf)
6597 (goto-char (point-min))
6598 (or isvar
6599 (progn (re-search-forward "^-X[ \t\n]")
6600 (forward-line -1)))
6601 (if (re-search-forward cmd-desc nil t)
6602 (progn
6603 ;; Go back to beginning of the group (ex, for qq)
6604 (if (re-search-backward "^[ \t\n\f]")
6605 (forward-line 1))
6606 (beginning-of-line)
6607 ;; Get some of
6608 (setq pos (point)
6609 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6610 (while (and (not win) buf-list)
6611 (setq win (get-buffer-window (car buf-list) t))
6612 (setq buf-list (cdr buf-list)))
6613 (or (not win)
6614 (eq (window-buffer win) buf)
6615 (set-window-buffer win buf))
6616 (and win (setq fr2 (window-frame win)))
6617 (if (or (not fr2) (eq fr1 fr2))
6618 (pop-to-buffer buf)
6619 (special-display-popup-frame buf) ; Make it visible
6620 (select-window win))
6621 (goto-char pos) ; Needed (?!).
6622 ;; Resize
6623 (setq iniheight (window-height)
6624 frheight (frame-height)
6625 not-loner (< iniheight (1- frheight))) ; Are not alone
6626 (cond ((if not-loner cperl-max-help-size
6627 cperl-shrink-wrap-info-frame)
6628 (setq height
6629 (+ 2
6630 (count-lines
6631 pos
6632 (save-excursion
6633 (if (re-search-forward
6634 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6635 (match-beginning 0) (point-max)))))
6636 max-height
6637 (if not-loner
6638 (/ (* (- frheight 3) cperl-max-help-size) 100)
6639 (setq char-height (frame-char-height))
6640 ;; Non-functioning under OS/2:
6641 (if (eq char-height 1) (setq char-height 18))
6642 ;; Title, menubar, + 2 for slack
6643 (- (/ (display-pixel-height) char-height) 4)))
6644 (if (> height max-height) (setq height max-height))
6645 ;;(message "was %s doing %s" iniheight height)
6646 (if not-loner
6647 (enlarge-window (- height iniheight))
6648 (set-frame-height (window-frame win) (1+ height)))))
6649 (set-window-start (selected-window) pos))
6650 (message "No entry for %s found." command))
6651 ;;(pop-to-buffer buffer)
6652 (select-window iniwin)))
6653
6654 (defun cperl-info-on-current-command ()
6655 "Show documentation for Perl command at point in other window."
6656 (interactive)
6657 (cperl-info-on-command (cperl-word-at-point)))
6658
6659 (defun cperl-imenu-info-imenu-search ()
6660 (if (looking-at "^-X[ \t\n]") nil
6661 (re-search-backward
6662 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6663 (forward-line 1)))
6664
6665 (defun cperl-imenu-info-imenu-name ()
6666 (buffer-substring
6667 (match-beginning 1) (match-end 1)))
6668
6669 (defun cperl-imenu-on-info ()
6670 "Shows imenu for Perl Info Buffer.
6671 Opens Perl Info buffer if needed."
6672 (interactive)
6673 (let* ((buffer (current-buffer))
6674 imenu-create-index-function
6675 imenu-prev-index-position-function
6676 imenu-extract-index-name-function
6677 (index-item (save-restriction
6678 (save-window-excursion
6679 (set-buffer (cperl-info-buffer nil))
6680 (setq imenu-create-index-function
6681 'imenu-default-create-index-function
6682 imenu-prev-index-position-function
6683 'cperl-imenu-info-imenu-search
6684 imenu-extract-index-name-function
6685 'cperl-imenu-info-imenu-name)
6686 (imenu-choose-buffer-index)))))
6687 (and index-item
6688 (progn
6689 (push-mark)
6690 (pop-to-buffer "*info-perl*")
6691 (cond
6692 ((markerp (cdr index-item))
6693 (goto-char (marker-position (cdr index-item))))
6694 (t
6695 (goto-char (cdr index-item))))
6696 (set-window-start (selected-window) (point))
6697 (pop-to-buffer buffer)))))
6698
6699 (defun cperl-lineup (beg end &optional step minshift)
6700 "Lineup construction in a region.
6701 Beginning of region should be at the start of a construction.
6702 All first occurrences of this construction in the lines that are
6703 partially contained in the region are lined up at the same column.
6704
6705 MINSHIFT is the minimal amount of space to insert before the construction.
6706 STEP is the tabwidth to position constructions.
6707 If STEP is nil, `cperl-lineup-step' will be used
6708 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
6709 Will not move the position at the start to the left."
6710 (interactive "r")
6711 (let (search col tcol seen b)
6712 (save-excursion
6713 (goto-char end)
6714 (end-of-line)
6715 (setq end (point-marker))
6716 (goto-char beg)
6717 (skip-chars-forward " \t\f")
6718 (setq beg (point-marker))
6719 (indent-region beg end nil)
6720 (goto-char beg)
6721 (setq col (current-column))
6722 (if (looking-at "[a-zA-Z0-9_]")
6723 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6724 (setq search
6725 (concat "\\<"
6726 (regexp-quote
6727 (buffer-substring (match-beginning 0)
6728 (match-end 0))) "\\>"))
6729 (error "Cannot line up in a middle of the word"))
6730 (if (looking-at "$")
6731 (error "Cannot line up end of line"))
6732 (setq search (regexp-quote (char-to-string (following-char)))))
6733 (setq step (or step cperl-lineup-step cperl-indent-level))
6734 (or minshift (setq minshift 1))
6735 (while (progn
6736 (beginning-of-line 2)
6737 (and (< (point) end)
6738 (re-search-forward search end t)
6739 (goto-char (match-beginning 0))))
6740 (setq tcol (current-column) seen t)
6741 (if (> tcol col) (setq col tcol)))
6742 (or seen
6743 (error "The construction to line up occurred only once"))
6744 (goto-char beg)
6745 (setq col (+ col minshift))
6746 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
6747 (while
6748 (progn
6749 (cperl-make-indent col)
6750 (beginning-of-line 2)
6751 (and (< (point) end)
6752 (re-search-forward search end t)
6753 (goto-char (match-beginning 0)))))))) ; No body
6754
6755 (defun cperl-etags (&optional add all files) ;; NOT USED???
6756 "Run etags with appropriate options for Perl files.
6757 If optional argument ALL is `recursive', will process Perl files
6758 in subdirectories too."
6759 (interactive)
6760 (let ((cmd "etags")
6761 (args '("-l" "none" "-r"
6762 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6763 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6764 "-r"
6765 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6766 "-r"
6767 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
6768 res)
6769 (if add (setq args (cons "-a" args)))
6770 (or files (setq files (list buffer-file-name)))
6771 (cond
6772 ((eq all 'recursive)
6773 ;;(error "Not implemented: recursive")
6774 (setq args (append (list "-e"
6775 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6776 use File::Find;
6777 find(\\&wanted, '.');
6778 exec @ARGV;"
6779 cmd) args)
6780 cmd "perl"))
6781 (all
6782 ;;(error "Not implemented: all")
6783 (setq args (append (list "-e"
6784 "push @ARGV, <*.PL *.pl *.pm>;
6785 exec @ARGV;"
6786 cmd) args)
6787 cmd "perl"))
6788 (t
6789 (setq args (append args files))))
6790 (setq res (apply 'call-process cmd nil nil nil args))
6791 (or (eq res 0)
6792 (message "etags returned \"%s\"" res))))
6793
6794 (defun cperl-toggle-auto-newline ()
6795 "Toggle the state of `cperl-auto-newline'."
6796 (interactive)
6797 (setq cperl-auto-newline (not cperl-auto-newline))
6798 (message "Newlines will %sbe auto-inserted now."
6799 (if cperl-auto-newline "" "not ")))
6800
6801 (defun cperl-toggle-abbrev ()
6802 "Toggle the state of automatic keyword expansion in CPerl mode."
6803 (interactive)
6804 (abbrev-mode (if abbrev-mode 0 1))
6805 (message "Perl control structure will %sbe auto-inserted now."
6806 (if abbrev-mode "" "not ")))
6807
6808
6809 (defun cperl-toggle-electric ()
6810 "Toggle the state of parentheses doubling in CPerl mode."
6811 (interactive)
6812 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
6813 (message "Parentheses will %sbe auto-doubled now."
6814 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6815
6816 (defun cperl-toggle-autohelp ()
6817 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6818 Delay of auto-help controlled by `cperl-lazy-help-time'."
6819 (interactive)
6820 (if (fboundp 'run-with-idle-timer)
6821 (progn
6822 (if cperl-lazy-installed
6823 (cperl-lazy-unstall)
6824 (cperl-lazy-install))
6825 (message "Perl help messages will %sbe automatically shown now."
6826 (if cperl-lazy-installed "" "not ")))
6827 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6828
6829 (defun cperl-toggle-construct-fix ()
6830 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6831 (interactive)
6832 (setq cperl-indent-region-fix-constructs
6833 (if cperl-indent-region-fix-constructs
6834 nil
6835 1))
6836 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
6837 (if cperl-indent-region-fix-constructs "" "not ")))
6838
6839 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6840 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6841 Nonpositive numeric argument disables debugging messages. The message
6842 summarizes which regions it was decided to rescan for syntactic constructs.
6843
6844 The message looks like this:
6845
6846 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6847
6848 Numbers are character positions in the buffer. REQ provides the range to
6849 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6850 for correct operation it should start and end outside any special syntactic
6851 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6852 by CPerl."
6853 (interactive "P")
6854 (or arg
6855 (setq arg (if (eq cperl-syntaxify-by-font-lock
6856 (if backtrace 'backtrace 'message)) 0 1)))
6857 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6858 (setq cperl-syntaxify-by-font-lock arg)
6859 (message "Debugging messages of syntax unwind %sabled."
6860 (if (eq arg t) "dis" "en")))
6861
6862 ;;;; Tags file creation.
6863
6864 (defvar cperl-tmp-buffer " *cperl-tmp*")
6865
6866 (defun cperl-setup-tmp-buf ()
6867 (set-buffer (get-buffer-create cperl-tmp-buffer))
6868 (set-syntax-table cperl-mode-syntax-table)
6869 (buffer-disable-undo)
6870 (auto-fill-mode 0)
6871 (if cperl-use-syntax-table-text-property-for-tags
6872 (progn
6873 (make-local-variable 'parse-sexp-lookup-properties)
6874 ;; Do not introduce variable if not needed, we check it!
6875 (set 'parse-sexp-lookup-properties t))))
6876
6877 ;; Copied from imenu-example--name-and-position.
6878 (defvar imenu-use-markers)
6879
6880 (defun cperl-imenu-name-and-position ()
6881 "Return the current/previous sexp and its (beginning) location.
6882 Does not move point."
6883 (save-excursion
6884 (forward-sexp -1)
6885 (let ((beg (if imenu-use-markers (point-marker) (point)))
6886 (end (progn (forward-sexp) (point))))
6887 (cons (buffer-substring beg end)
6888 beg))))
6889
6890 (defun cperl-xsub-scan ()
6891 (require 'imenu)
6892 (let ((index-alist '())
6893 (prev-pos 0) index index1 name package prefix)
6894 (goto-char (point-min))
6895 ;; Search for the function
6896 (progn ;;save-match-data
6897 (while (re-search-forward
6898 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6899 nil t)
6900 (cond
6901 ((match-beginning 2) ; SECTION
6902 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6903 (goto-char (match-beginning 0))
6904 (skip-chars-forward " \t")
6905 (forward-char 1)
6906 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6907 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6908 (setq prefix nil)))
6909 ((not package) nil) ; C language section
6910 ((match-beginning 3) ; XSUB
6911 (goto-char (1+ (match-beginning 3)))
6912 (setq index (cperl-imenu-name-and-position))
6913 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6914 (if (and prefix (string-match (concat "^" prefix) name))
6915 (setq name (substring name (length prefix))))
6916 (cond ((string-match "::" name) nil)
6917 (t
6918 (setq index1 (cons (concat package "::" name) (cdr index)))
6919 (push index1 index-alist)))
6920 (setcar index name)
6921 (push index index-alist))
6922 (t ; BOOT: section
6923 ;; (beginning-of-line)
6924 (setq index (cperl-imenu-name-and-position))
6925 (setcar index (concat package "::BOOT:"))
6926 (push index index-alist)))))
6927 index-alist))
6928
6929 (defvar cperl-unreadable-ok nil)
6930
6931 (defun cperl-find-tags (ifile xs topdir)
6932 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6933 (cperl-pod-here-fontify nil) f file)
6934 (save-excursion
6935 (if b (set-buffer b)
6936 (cperl-setup-tmp-buf))
6937 (erase-buffer)
6938 (condition-case err
6939 (setq file (car (insert-file-contents ifile)))
6940 (error (if cperl-unreadable-ok nil
6941 (if (y-or-n-p
6942 (format "File %s unreadable. Continue? " ifile))
6943 (setq cperl-unreadable-ok t)
6944 (error "Aborting: unreadable file %s" ifile)))))
6945 (if (not file)
6946 (message "Unreadable file %s" ifile)
6947 (message "Scanning file %s ..." file)
6948 (if (and cperl-use-syntax-table-text-property-for-tags
6949 (not xs))
6950 (condition-case err ; after __END__ may have garbage
6951 (cperl-find-pods-heres nil nil noninteractive)
6952 (error (message "While scanning for syntax: %s" err))))
6953 (if xs
6954 (setq lst (cperl-xsub-scan))
6955 (setq ind (cperl-imenu--create-perl-index))
6956 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6957 (setq lst
6958 (mapcar
6959 (function
6960 (lambda (elt)
6961 (cond ((string-match "^[_a-zA-Z]" (car elt))
6962 (goto-char (cdr elt))
6963 (beginning-of-line) ; pos should be of the start of the line
6964 (list (car elt)
6965 (point)
6966 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6967 (buffer-substring (progn
6968 (goto-char (cdr elt))
6969 ;; After name now...
6970 (or (eolp) (forward-char 1))
6971 (point))
6972 (progn
6973 (beginning-of-line)
6974 (point))))))))
6975 lst))
6976 (erase-buffer)
6977 (while lst
6978 (setq elt (car lst) lst (cdr lst))
6979 (if elt
6980 (progn
6981 (insert (elt elt 3)
6982 127
6983 (if (string-match "^package " (car elt))
6984 (substring (car elt) 8)
6985 (car elt) )
6986 1
6987 (number-to-string (elt elt 2)) ; Line
6988 ","
6989 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6990 "\n")
6991 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6992 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
6993 (elt elt 3)))
6994 ;; Need to insert the name without package as well
6995 (setq lst (cons (cons (substring (elt elt 3)
6996 (match-beginning 1)
6997 (match-end 1))
6998 (cdr elt))
6999 lst))))))
7000 (setq pos (point))
7001 (goto-char 1)
7002 (setq rel file)
7003 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7004 (set-text-properties 0 (length rel) nil rel)
7005 (and (equal topdir (substring rel 0 (length topdir)))
7006 (setq rel (substring file (length topdir))))
7007 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7008 (setq ret (buffer-substring 1 (point-max)))
7009 (erase-buffer)
7010 (or noninteractive
7011 (message "Scanning file %s finished" file))
7012 ret))))
7013
7014 (defun cperl-add-tags-recurse-noxs ()
7015 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
7016 Use as
7017 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7018 -f cperl-add-tags-recurse-noxs
7019 "
7020 (cperl-write-tags nil nil t t nil t))
7021
7022 (defun cperl-add-tags-recurse-noxs-fullpath ()
7023 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7024 Writes down fullpath, so TAGS is relocatable (but if the build directory
7025 is relocated, the file TAGS inside it breaks). Use as
7026 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7027 -f cperl-add-tags-recurse-noxs-fullpath
7028 "
7029 (cperl-write-tags nil nil t t nil t ""))
7030
7031 (defun cperl-add-tags-recurse ()
7032 "Add to TAGS file data for Perl files in the current directory and kids.
7033 Use as
7034 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7035 -f cperl-add-tags-recurse
7036 "
7037 (cperl-write-tags nil nil t t))
7038
7039 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7040 ;; If INBUFFER, do not select buffer, and do not save
7041 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7042 (require 'etags)
7043 (if file nil
7044 (setq file (if dir default-directory (buffer-file-name)))
7045 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7046 (or topdir
7047 (setq topdir default-directory))
7048 (let ((tags-file-name "TAGS")
7049 (case-fold-search (eq system-type 'emx))
7050 xs rel tm)
7051 (save-excursion
7052 (cond (inbuffer nil) ; Already there
7053 ((file-exists-p tags-file-name)
7054 (if (featurep 'xemacs)
7055 (visit-tags-table-buffer)
7056 (visit-tags-table-buffer tags-file-name)))
7057 (t (set-buffer (find-file-noselect tags-file-name))))
7058 (cond
7059 (dir
7060 (cond ((eq erase 'ignore))
7061 (erase
7062 (erase-buffer)
7063 (setq erase 'ignore)))
7064 (let ((files
7065 (condition-case err
7066 (directory-files file t
7067 (if recurse nil cperl-scan-files-regexp)
7068 t)
7069 (error
7070 (if cperl-unreadable-ok nil
7071 (if (y-or-n-p
7072 (format "Directory %s unreadable. Continue? " file))
7073 (setq cperl-unreadable-ok t
7074 tm nil) ; Return empty list
7075 (error "Aborting: unreadable directory %s" file)))))))
7076 (mapc (function
7077 (lambda (file)
7078 (cond
7079 ((string-match cperl-noscan-files-regexp file)
7080 nil)
7081 ((not (file-directory-p file))
7082 (if (string-match cperl-scan-files-regexp file)
7083 (cperl-write-tags file erase recurse nil t noxs topdir)))
7084 ((not recurse) nil)
7085 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7086 files)))
7087 (t
7088 (setq xs (string-match "\\.xs$" file))
7089 (if (not (and xs noxs))
7090 (progn
7091 (cond ((eq erase 'ignore) (goto-char (point-max)))
7092 (erase (erase-buffer))
7093 (t
7094 (goto-char 1)
7095 (setq rel file)
7096 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7097 (set-text-properties 0 (length rel) nil rel)
7098 (and (equal topdir (substring rel 0 (length topdir)))
7099 (setq rel (substring file (length topdir))))
7100 (if (search-forward (concat "\f\n" rel ",") nil t)
7101 (progn
7102 (search-backward "\f\n")
7103 (delete-region (point)
7104 (save-excursion
7105 (forward-char 1)
7106 (if (search-forward "\f\n"
7107 nil 'toend)
7108 (- (point) 2)
7109 (point-max)))))
7110 (goto-char (point-max)))))
7111 (insert (cperl-find-tags file xs topdir))))))
7112 (if inbuffer nil ; Delegate to the caller
7113 (save-buffer 0) ; No backup
7114 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7115 (initialize-new-tags-table))))))
7116
7117 (defvar cperl-tags-hier-regexp-list
7118 (concat
7119 "^\\("
7120 "\\(package\\)\\>"
7121 "\\|"
7122 "sub\\>[^\n]+::"
7123 "\\|"
7124 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7125 "\\|"
7126 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7127 "\\)"))
7128
7129 (defvar cperl-hierarchy '(() ())
7130 "Global hierarchy of classes.")
7131
7132 (defun cperl-tags-hier-fill ()
7133 ;; Suppose we are in a tag table cooked by cperl.
7134 (goto-char 1)
7135 (let (type pack name pos line chunk ord cons1 file str info fileind)
7136 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
7137 (setq pos (match-beginning 0)
7138 pack (match-beginning 2))
7139 (beginning-of-line)
7140 (if (looking-at (concat
7141 "\\([^\n]+\\)"
7142 "\C-?"
7143 "\\([^\n]+\\)"
7144 "\C-a"
7145 "\\([0-9]+\\)"
7146 ","
7147 "\\([0-9]+\\)"))
7148 (progn
7149 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7150 name (buffer-substring (match-beginning 2) (match-end 2))
7151 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
7152 line (buffer-substring (match-beginning 3) (match-end 3))
7153 ord (if pack 1 0)
7154 file (file-of-tag)
7155 fileind (format "%s:%s" file line)
7156 ;; Moves to beginning of the next line:
7157 info (cperl-etags-snarf-tag file line))
7158 ;; Move back
7159 (forward-char -1)
7160 ;; Make new member of hierarchy name ==> file ==> pos if needed
7161 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7162 ;; Name known
7163 (setcdr cons1 (cons (cons fileind (vector file info))
7164 (cdr cons1)))
7165 ;; First occurrence of the name, start alist
7166 (setq cons1 (cons name (list (cons fileind (vector file info)))))
7167 (if pack
7168 (setcar (cdr cperl-hierarchy)
7169 (cons cons1 (nth 1 cperl-hierarchy)))
7170 (setcar cperl-hierarchy
7171 (cons cons1 (car cperl-hierarchy)))))))
7172 (end-of-line))))
7173
7174 (declare-function x-popup-menu "menu.c" (position menu))
7175
7176 (defun cperl-tags-hier-init (&optional update)
7177 "Show hierarchical menu of classes and methods.
7178 Finds info about classes by a scan of loaded TAGS files.
7179 Supposes that the TAGS files contain fully qualified function names.
7180 One may build such TAGS files from CPerl mode menu."
7181 (interactive)
7182 (require 'etags)
7183 (require 'imenu)
7184 (if (or update (null (nth 2 cperl-hierarchy)))
7185 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7186 (or (nthcdr 2 elt)
7187 ;; Only in one file
7188 (setcdr elt (cdr (nth 1 elt)))))))
7189 pack name cons1 to l1 l2 l3 l4 b)
7190 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7191 (setq cperl-hierarchy (list l1 l2 l3))
7192 (if (featurep 'xemacs) ; Not checked
7193 (progn
7194 (or tags-file-name
7195 ;; Does this work in XEmacs?
7196 (call-interactively 'visit-tags-table))
7197 (message "Updating list of classes...")
7198 (set-buffer (get-file-buffer tags-file-name))
7199 (cperl-tags-hier-fill))
7200 (or tags-table-list
7201 (call-interactively 'visit-tags-table))
7202 (mapc
7203 (function
7204 (lambda (tagsfile)
7205 (message "Updating list of classes... %s" tagsfile)
7206 (set-buffer (get-file-buffer tagsfile))
7207 (cperl-tags-hier-fill)))
7208 tags-table-list)
7209 (message "Updating list of classes... postprocessing..."))
7210 (mapc remover (car cperl-hierarchy))
7211 (mapc remover (nth 1 cperl-hierarchy))
7212 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7213 (cons "Methods: " (car cperl-hierarchy))))
7214 (cperl-tags-treeify to 1)
7215 (setcar (nthcdr 2 cperl-hierarchy)
7216 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7217 (message "Updating list of classes: done, requesting display...")
7218 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7219 ))
7220 (or (nth 2 cperl-hierarchy)
7221 (error "No items found"))
7222 (setq update
7223 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
7224 (if (if (fboundp 'display-popup-menus-p)
7225 (let ((f 'display-popup-menus-p))
7226 (funcall f))
7227 window-system)
7228 (x-popup-menu t (nth 2 cperl-hierarchy))
7229 (require 'tmm)
7230 (tmm-prompt (nth 2 cperl-hierarchy))))
7231 (if (and update (listp update))
7232 (progn (while (cdr update) (setq update (cdr update)))
7233 (setq update (car update)))) ; Get the last from the list
7234 (if (vectorp update)
7235 (progn
7236 (find-file (elt update 0))
7237 (cperl-etags-goto-tag-location (elt update 1))))
7238 (if (eq update -999) (cperl-tags-hier-init t)))
7239
7240 (defun cperl-tags-treeify (to level)
7241 ;; cadr of `to' is read-write. On start it is a cons
7242 (let* ((regexp (concat "^\\(" (mapconcat
7243 'identity
7244 (make-list level "[_a-zA-Z0-9]+")
7245 "::")
7246 "\\)\\(::\\)?"))
7247 (packages (cdr (nth 1 to)))
7248 (methods (cdr (nth 2 to)))
7249 l1 head tail cons1 cons2 ord writeto packs recurse
7250 root-packages root-functions ms many_ms same_name ps
7251 (move-deeper
7252 (function
7253 (lambda (elt)
7254 (cond ((and (string-match regexp (car elt))
7255 (or (eq ord 1) (match-end 2)))
7256 (setq head (substring (car elt) 0 (match-end 1))
7257 tail (if (match-end 2) (substring (car elt)
7258 (match-end 2)))
7259 recurse t)
7260 (if (setq cons1 (assoc head writeto)) nil
7261 ;; Need to init new head
7262 (setcdr writeto (cons (list head (list "Packages: ")
7263 (list "Methods: "))
7264 (cdr writeto)))
7265 (setq cons1 (nth 1 writeto)))
7266 (setq cons2 (nth ord cons1)) ; Either packs or meths
7267 (setcdr cons2 (cons elt (cdr cons2))))
7268 ((eq ord 2)
7269 (setq root-functions (cons elt root-functions)))
7270 (t
7271 (setq root-packages (cons elt root-packages))))))))
7272 (setcdr to l1) ; Init to dynamic space
7273 (setq writeto to)
7274 (setq ord 1)
7275 (mapc move-deeper packages)
7276 (setq ord 2)
7277 (mapc move-deeper methods)
7278 (if recurse
7279 (mapc (function (lambda (elt)
7280 (cperl-tags-treeify elt (1+ level))))
7281 (cdr to)))
7282 ;;Now clean up leaders with one child only
7283 (mapc (function (lambda (elt)
7284 (if (not (and (listp (cdr elt))
7285 (eq (length elt) 2))) nil
7286 (setcar elt (car (nth 1 elt)))
7287 (setcdr elt (cdr (nth 1 elt))))))
7288 (cdr to))
7289 ;; Sort the roots of subtrees
7290 (if (default-value 'imenu-sort-function)
7291 (setcdr to
7292 (sort (cdr to) (default-value 'imenu-sort-function))))
7293 ;; Now add back functions removed from display
7294 (mapc (function (lambda (elt)
7295 (setcdr to (cons elt (cdr to)))))
7296 (if (default-value 'imenu-sort-function)
7297 (nreverse
7298 (sort root-functions (default-value 'imenu-sort-function)))
7299 root-functions))
7300 ;; Now add back packages removed from display
7301 (mapc (function (lambda (elt)
7302 (setcdr to (cons (cons (concat "package " (car elt))
7303 (cdr elt))
7304 (cdr to)))))
7305 (if (default-value 'imenu-sort-function)
7306 (nreverse
7307 (sort root-packages (default-value 'imenu-sort-function)))
7308 root-packages))))
7309
7310 ;;;(x-popup-menu t
7311 ;;; '(keymap "Name1"
7312 ;;; ("Ret1" "aa")
7313 ;;; ("Head1" "ab"
7314 ;;; keymap "Name2"
7315 ;;; ("Tail1" "x") ("Tail2" "y"))))
7316
7317 (defun cperl-list-fold (list name limit)
7318 (let (list1 list2 elt1 (num 0))
7319 (if (<= (length list) limit) list
7320 (setq list1 nil list2 nil)
7321 (while list
7322 (setq num (1+ num)
7323 elt1 (car list)
7324 list (cdr list))
7325 (if (<= num imenu-max-items)
7326 (setq list2 (cons elt1 list2))
7327 (setq list1 (cons (cons name
7328 (nreverse list2))
7329 list1)
7330 list2 (list elt1)
7331 num 1)))
7332 (nreverse (cons (cons name
7333 (nreverse list2))
7334 list1)))))
7335
7336 (defun cperl-menu-to-keymap (menu &optional name)
7337 (let (list)
7338 (cons 'keymap
7339 (mapcar
7340 (function
7341 (lambda (elt)
7342 (cond ((listp (cdr elt))
7343 (setq list (cperl-list-fold
7344 (cdr elt) (car elt) imenu-max-items))
7345 (cons nil
7346 (cons (car elt)
7347 (cperl-menu-to-keymap list))))
7348 (t
7349 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7350 (cperl-list-fold menu "Root" imenu-max-items)))))
7351
7352 \f
7353 (defvar cperl-bad-style-regexp
7354 (mapconcat 'identity
7355 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
7356 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
7357 "\\|")
7358 "Finds places such that insertion of a whitespace may help a lot.")
7359
7360 (defvar cperl-not-bad-style-regexp
7361 (mapconcat
7362 'identity
7363 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7364 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7365 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
7366 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
7367 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
7368 "-[0-9]" ; -5
7369 "\\+\\+" ; ++var
7370 "--" ; --var
7371 ".->" ; a->b
7372 "->" ; a SPACE ->b
7373 "\\[-" ; a[-1]
7374 "\\\\[&$@*\\\\]" ; \&func
7375 "^=" ; =head
7376 "\\$." ; $|
7377 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
7378 "||"
7379 "&&"
7380 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
7381 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
7382 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7383 ;;"[*/+-|&<.]+="
7384 )
7385 "\\|")
7386 "If matches at the start of match found by `my-bad-c-style-regexp',
7387 insertion of a whitespace will not help.")
7388
7389 (defvar found-bad)
7390
7391 (defun cperl-find-bad-style ()
7392 "Find places in the buffer where insertion of a whitespace may help.
7393 Prompts user for insertion of spaces.
7394 Currently it is tuned to C and Perl syntax."
7395 (interactive)
7396 (let (found-bad (p (point)))
7397 (setq last-nonmenu-event 13) ; To disable popup
7398 (goto-char (point-min))
7399 (map-y-or-n-p "Insert space here? "
7400 (lambda (arg) (insert " "))
7401 'cperl-next-bad-style
7402 '("location" "locations" "insert a space into")
7403 '((?\C-r (lambda (arg)
7404 (let ((buffer-quit-function
7405 'exit-recursive-edit))
7406 (message "Exit with Esc Esc")
7407 (recursive-edit)
7408 t)) ; Consider acted upon
7409 "edit, exit with Esc Esc")
7410 (?e (lambda (arg)
7411 (let ((buffer-quit-function
7412 'exit-recursive-edit))
7413 (message "Exit with Esc Esc")
7414 (recursive-edit)
7415 t)) ; Consider acted upon
7416 "edit, exit with Esc Esc"))
7417 t)
7418 (if found-bad (goto-char found-bad)
7419 (goto-char p)
7420 (message "No appropriate place found"))))
7421
7422 (defun cperl-next-bad-style ()
7423 (let (p (not-found t) (point (point)) found)
7424 (while (and not-found
7425 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7426 (setq p (point))
7427 (goto-char (match-beginning 0))
7428 (if (or
7429 (looking-at cperl-not-bad-style-regexp)
7430 ;; Check for a < -b and friends
7431 (and (eq (following-char) ?\-)
7432 (save-excursion
7433 (skip-chars-backward " \t\n")
7434 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
7435 ;; Now check for syntax type
7436 (save-match-data
7437 (setq found (point))
7438 (beginning-of-defun)
7439 (let ((pps (parse-partial-sexp (point) found)))
7440 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7441 (goto-char (match-end 0))
7442 (goto-char (1- p))
7443 (setq not-found nil
7444 found-bad found)))
7445 (not not-found)))
7446
7447 \f
7448 ;;; Getting help
7449 (defvar cperl-have-help-regexp
7450 ;;(concat "\\("
7451 (mapconcat
7452 'identity
7453 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
7454 "[$@]\\^[a-zA-Z]" ; Special variable
7455 "[$@][^ \n\t]" ; Special variable
7456 "-[a-zA-Z]" ; File test
7457 "\\\\[a-zA-Z0]" ; Special chars
7458 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
7459 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7460 "[a-zA-Z_0-9:]+" ; symbol or number
7461 "x="
7462 "#!")
7463 ;;"\\)\\|\\("
7464 "\\|")
7465 ;;"\\)"
7466 ;;)
7467 "Matches places in the buffer we can find help for.")
7468
7469 (defvar cperl-message-on-help-error t)
7470 (defvar cperl-help-from-timer nil)
7471
7472 (defun cperl-word-at-point-hard ()
7473 ;; Does not save-excursion
7474 ;; Get to the something meaningful
7475 (or (eobp) (eolp) (forward-char 1))
7476 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
7477 (save-excursion (beginning-of-line) (point))
7478 'to-beg)
7479 ;; (cond
7480 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7481 ;; (skip-chars-backward " \n\t\r({[]});,")
7482 ;; (or (bobp) (backward-char 1))))
7483 ;; Try to backtrace
7484 (cond
7485 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7486 (skip-chars-backward "a-zA-Z0-9_:")
7487 (cond
7488 ((and (eq (preceding-char) ?^) ; $^I
7489 (eq (char-after (- (point) 2)) ?\$))
7490 (forward-char -2))
7491 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7492 (forward-char -1))
7493 ((and (eq (preceding-char) ?\=)
7494 (eq (current-column) 1))
7495 (forward-char -1))) ; =head1
7496 (if (and (eq (preceding-char) ?\<)
7497 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7498 (forward-char -1)))
7499 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7500 (forward-char -1))
7501 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7502 (forward-char -1))
7503 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7504 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7505 (cond
7506 ((and (eq (preceding-char) ?\$)
7507 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7508 (forward-char -1))
7509 ((and (eq (following-char) ?\>)
7510 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7511 (save-excursion
7512 (forward-sexp -1)
7513 (and (eq (preceding-char) ?\<)
7514 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7515 (search-backward "<"))))
7516 ((and (eq (following-char) ?\$)
7517 (eq (preceding-char) ?\<)
7518 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7519 (forward-char -1)))
7520 (if (looking-at cperl-have-help-regexp)
7521 (buffer-substring (match-beginning 0) (match-end 0))))
7522
7523 (defun cperl-get-help ()
7524 "Get one-line docs on the symbol at the point.
7525 The data for these docs is a little bit obsolete and may be in fact longer
7526 than a line. Your contribution to update/shorten it is appreciated."
7527 (interactive)
7528 (save-match-data ; May be called "inside" query-replace
7529 (save-excursion
7530 (let ((word (cperl-word-at-point-hard)))
7531 (if word
7532 (if (and cperl-help-from-timer ; Bail out if not in mainland
7533 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7534 (or (memq (get-text-property (point) 'face)
7535 '(font-lock-comment-face font-lock-string-face))
7536 (memq (get-text-property (point) 'syntax-type)
7537 '(pod here-doc format))))
7538 nil
7539 (cperl-describe-perl-symbol word))
7540 (if cperl-message-on-help-error
7541 (message "Nothing found for %s..."
7542 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7543
7544 ;;; Stolen from perl-descr.el by Johan Vromans:
7545
7546 (defvar cperl-doc-buffer " *perl-doc*"
7547 "Where the documentation can be found.")
7548
7549 (defun cperl-describe-perl-symbol (val)
7550 "Display the documentation of symbol at point, a Perl operator."
7551 (let ((enable-recursive-minibuffers t)
7552 args-file regexp)
7553 (cond
7554 ((string-match "^[&*][a-zA-Z_]" val)
7555 (setq val (concat (substring val 0 1) "NAME")))
7556 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7557 (setq val (concat "@" (substring val 1 (match-end 1)))))
7558 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7559 (setq val (concat "%" (substring val 1 (match-end 1)))))
7560 ((and (string= val "x") (string-match "^x=" val))
7561 (setq val "x="))
7562 ((string-match "^\\$[\C-a-\C-z]" val)
7563 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7564 ((string-match "^CORE::" val)
7565 (setq val "CORE::"))
7566 ((string-match "^SUPER::" val)
7567 (setq val "SUPER::"))
7568 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7569 (setq val "<NAME>")))
7570 (setq regexp (concat "^"
7571 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
7572 (regexp-quote val)
7573 "\\([ \t([/]\\|$\\)"))
7574
7575 ;; get the buffer with the documentation text
7576 (cperl-switch-to-doc-buffer)
7577
7578 ;; lookup in the doc
7579 (goto-char (point-min))
7580 (let ((case-fold-search nil))
7581 (list
7582 (if (re-search-forward regexp (point-max) t)
7583 (save-excursion
7584 (beginning-of-line 1)
7585 (let ((lnstart (point)))
7586 (end-of-line)
7587 (message "%s" (buffer-substring lnstart (point)))))
7588 (if cperl-message-on-help-error
7589 (message "No definition for %s" val)))))))
7590
7591 (defvar cperl-short-docs 'please-ignore-this-line
7592 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7593 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
7594 ... Range (list context); flip/flop [no flop when flip] (scalar context).
7595 ! ... Logical negation.
7596 ... != ... Numeric inequality.
7597 ... !~ ... Search pattern, substitution, or translation (negated).
7598 $! In numeric context: errno. In a string context: error string.
7599 $\" The separator which joins elements of arrays interpolated in strings.
7600 $# The output format for printed numbers. Default is %.15g or close.
7601 $$ Process number of this script. Changes in the fork()ed child process.
7602 $% The current page number of the currently selected output channel.
7603
7604 The following variables are always local to the current block:
7605
7606 $1 Match of the 1st set of parentheses in the last match (auto-local).
7607 $2 Match of the 2nd set of parentheses in the last match (auto-local).
7608 $3 Match of the 3rd set of parentheses in the last match (auto-local).
7609 $4 Match of the 4th set of parentheses in the last match (auto-local).
7610 $5 Match of the 5th set of parentheses in the last match (auto-local).
7611 $6 Match of the 6th set of parentheses in the last match (auto-local).
7612 $7 Match of the 7th set of parentheses in the last match (auto-local).
7613 $8 Match of the 8th set of parentheses in the last match (auto-local).
7614 $9 Match of the 9th set of parentheses in the last match (auto-local).
7615 $& The string matched by the last pattern match (auto-local).
7616 $' The string after what was matched by the last match (auto-local).
7617 $` The string before what was matched by the last match (auto-local).
7618
7619 $( The real gid of this process.
7620 $) The effective gid of this process.
7621 $* Deprecated: Set to 1 to do multiline matching within a string.
7622 $+ The last bracket matched by the last search pattern.
7623 $, The output field separator for the print operator.
7624 $- The number of lines left on the page.
7625 $. The current input line number of the last filehandle that was read.
7626 $/ The input record separator, newline by default.
7627 $0 Name of the file containing the current perl script (read/write).
7628 $: String may be broken after these characters to fill ^-lines in a format.
7629 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
7630 $< The real uid of this process.
7631 $= The page length of the current output channel. Default is 60 lines.
7632 $> The effective uid of this process.
7633 $? The status returned by the last ``, pipe close or `system'.
7634 $@ The perl error message from the last eval or do @var{EXPR} command.
7635 $ARGV The name of the current file used with <> .
7636 $[ Deprecated: The index of the first element/char in an array/string.
7637 $\\ The output record separator for the print operator.
7638 $] The perl version string as displayed with perl -v.
7639 $^ The name of the current top-of-page format.
7640 $^A The current value of the write() accumulator for format() lines.
7641 $^D The value of the perl debug (-D) flags.
7642 $^E Information about the last system error other than that provided by $!.
7643 $^F The highest system file descriptor, ordinarily 2.
7644 $^H The current set of syntax checks enabled by `use strict'.
7645 $^I The value of the in-place edit extension (perl -i option).
7646 $^L What formats output to perform a formfeed. Default is \\f.
7647 $^M A buffer for emergency memory allocation when running out of memory.
7648 $^O The operating system name under which this copy of Perl was built.
7649 $^P Internal debugging flag.
7650 $^T The time the script was started. Used by -A/-M/-C file tests.
7651 $^W True if warnings are requested (perl -w flag).
7652 $^X The name under which perl was invoked (argv[0] in C-speech).
7653 $_ The default input and pattern-searching space.
7654 $| Auto-flush after write/print on current output channel? Default 0.
7655 $~ The name of the current report format.
7656 ... % ... Modulo division.
7657 ... %= ... Modulo division assignment.
7658 %ENV Contains the current environment.
7659 %INC List of files that have been require-d or do-ne.
7660 %SIG Used to set signal handlers for various signals.
7661 ... & ... Bitwise and.
7662 ... && ... Logical and.
7663 ... &&= ... Logical and assignment.
7664 ... &= ... Bitwise and assignment.
7665 ... * ... Multiplication.
7666 ... ** ... Exponentiation.
7667 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7668 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
7669 ... + ... Addition. +EXPR Makes EXPR into scalar context.
7670 ++ Auto-increment (magical on strings). ++EXPR EXPR++
7671 ... += ... Addition assignment.
7672 , Comma operator.
7673 ... - ... Subtraction.
7674 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7675 ... -= ... Subtraction assignment.
7676 -A Access time in days since script started.
7677 -B File is a non-text (binary) file.
7678 -C Inode change time in days since script started.
7679 -M Age in days since script started.
7680 -O File is owned by real uid.
7681 -R File is readable by real uid.
7682 -S File is a socket .
7683 -T File is a text file.
7684 -W File is writable by real uid.
7685 -X File is executable by real uid.
7686 -b File is a block special file.
7687 -c File is a character special file.
7688 -d File is a directory.
7689 -e File exists .
7690 -f File is a plain file.
7691 -g File has setgid bit set.
7692 -k File has sticky bit set.
7693 -l File is a symbolic link.
7694 -o File is owned by effective uid.
7695 -p File is a named pipe (FIFO).
7696 -r File is readable by effective uid.
7697 -s File has non-zero size.
7698 -t Tests if filehandle (STDIN by default) is opened to a tty.
7699 -u File has setuid bit set.
7700 -w File is writable by effective uid.
7701 -x File is executable by effective uid.
7702 -z File has zero size.
7703 . Concatenate strings.
7704 .. Range (list context); flip/flop (scalar context) operator.
7705 .= Concatenate assignment strings
7706 ... / ... Division. /PATTERN/ioxsmg Pattern match
7707 ... /= ... Division assignment.
7708 /PATTERN/ioxsmg Pattern match.
7709 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
7710 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7711 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7712 <> Reads line from union of files in @ARGV (= command line) and STDIN.
7713 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7714 ... <= ... Numeric less than or equal to.
7715 ... <=> ... Numeric compare.
7716 ... = ... Assignment.
7717 ... == ... Numeric equality.
7718 ... =~ ... Search pattern, substitution, or translation
7719 ... > ... Numeric greater than.
7720 ... >= ... Numeric greater than or equal to.
7721 ... >> ... Bitwise shift right.
7722 ... >>= ... Bitwise shift right assignment.
7723 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7724 ?PATTERN? One-time pattern match.
7725 @ARGV Command line arguments (not including the command name - see $0).
7726 @INC List of places to look for perl scripts during do/include/use.
7727 @_ Parameter array for subroutines; result of split() unless in list context.
7728 \\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
7729 \\0 Octal char, e.g. \\033.
7730 \\E Case modification terminator. See \\Q, \\L, and \\U.
7731 \\L Lowercase until \\E . See also \\l, lc.
7732 \\U Upcase until \\E . See also \\u, uc.
7733 \\Q Quote metacharacters until \\E . See also quotemeta.
7734 \\a Alarm character (octal 007).
7735 \\b Backspace character (octal 010).
7736 \\c Control character, e.g. \\c[ .
7737 \\e Escape character (octal 033).
7738 \\f Formfeed character (octal 014).
7739 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
7740 \\n Newline character (octal 012 on most systems).
7741 \\r Return character (octal 015 on most systems).
7742 \\t Tab character (octal 011).
7743 \\u Upcase the next character. See also \\U and \\l, ucfirst.
7744 \\x Hex character, e.g. \\x1b.
7745 ... ^ ... Bitwise exclusive or.
7746 __END__ Ends program source.
7747 __DATA__ Ends program source.
7748 __FILE__ Current (source) filename.
7749 __LINE__ Current line in current source.
7750 __PACKAGE__ Current package.
7751 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7752 ARGVOUT Output filehandle with -i flag.
7753 BEGIN { ... } Immediately executed (during compilation) piece of code.
7754 END { ... } Pseudo-subroutine executed after the script finishes.
7755 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7756 INIT { ... } Pseudo-subroutine executed before the script starts running.
7757 DATA Input filehandle for what follows after __END__ or __DATA__.
7758 accept(NEWSOCKET,GENERICSOCKET)
7759 alarm(SECONDS)
7760 atan2(X,Y)
7761 bind(SOCKET,NAME)
7762 binmode(FILEHANDLE)
7763 caller[(LEVEL)]
7764 chdir(EXPR)
7765 chmod(LIST)
7766 chop[(LIST|VAR)]
7767 chown(LIST)
7768 chroot(FILENAME)
7769 close(FILEHANDLE)
7770 closedir(DIRHANDLE)
7771 ... cmp ... String compare.
7772 connect(SOCKET,NAME)
7773 continue of { block } continue { block }. Is executed after `next' or at end.
7774 cos(EXPR)
7775 crypt(PLAINTEXT,SALT)
7776 dbmclose(%HASH)
7777 dbmopen(%HASH,DBNAME,MODE)
7778 defined(EXPR)
7779 delete($HASH{KEY})
7780 die(LIST)
7781 do { ... }|SUBR while|until EXPR executes at least once
7782 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7783 dump LABEL
7784 each(%HASH)
7785 endgrent
7786 endhostent
7787 endnetent
7788 endprotoent
7789 endpwent
7790 endservent
7791 eof[([FILEHANDLE])]
7792 ... eq ... String equality.
7793 eval(EXPR) or eval { BLOCK }
7794 exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
7795 exit(EXPR)
7796 exp(EXPR)
7797 fcntl(FILEHANDLE,FUNCTION,SCALAR)
7798 fileno(FILEHANDLE)
7799 flock(FILEHANDLE,OPERATION)
7800 for (EXPR;EXPR;EXPR) { ... }
7801 foreach [VAR] (@ARRAY) { ... }
7802 fork
7803 ... ge ... String greater than or equal.
7804 getc[(FILEHANDLE)]
7805 getgrent
7806 getgrgid(GID)
7807 getgrnam(NAME)
7808 gethostbyaddr(ADDR,ADDRTYPE)
7809 gethostbyname(NAME)
7810 gethostent
7811 getlogin
7812 getnetbyaddr(ADDR,ADDRTYPE)
7813 getnetbyname(NAME)
7814 getnetent
7815 getpeername(SOCKET)
7816 getpgrp(PID)
7817 getppid
7818 getpriority(WHICH,WHO)
7819 getprotobyname(NAME)
7820 getprotobynumber(NUMBER)
7821 getprotoent
7822 getpwent
7823 getpwnam(NAME)
7824 getpwuid(UID)
7825 getservbyname(NAME,PROTO)
7826 getservbyport(PORT,PROTO)
7827 getservent
7828 getsockname(SOCKET)
7829 getsockopt(SOCKET,LEVEL,OPTNAME)
7830 gmtime(EXPR)
7831 goto LABEL
7832 ... gt ... String greater than.
7833 hex(EXPR)
7834 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7835 index(STR,SUBSTR[,OFFSET])
7836 int(EXPR)
7837 ioctl(FILEHANDLE,FUNCTION,SCALAR)
7838 join(EXPR,LIST)
7839 keys(%HASH)
7840 kill(LIST)
7841 last [LABEL]
7842 ... le ... String less than or equal.
7843 length(EXPR)
7844 link(OLDFILE,NEWFILE)
7845 listen(SOCKET,QUEUESIZE)
7846 local(LIST)
7847 localtime(EXPR)
7848 log(EXPR)
7849 lstat(EXPR|FILEHANDLE|VAR)
7850 ... lt ... String less than.
7851 m/PATTERN/iogsmx
7852 mkdir(FILENAME,MODE)
7853 msgctl(ID,CMD,ARG)
7854 msgget(KEY,FLAGS)
7855 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7856 msgsnd(ID,MSG,FLAGS)
7857 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
7858 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
7859 ... ne ... String inequality.
7860 next [LABEL]
7861 oct(EXPR)
7862 open(FILEHANDLE[,EXPR])
7863 opendir(DIRHANDLE,EXPR)
7864 ord(EXPR) ASCII value of the first char of the string.
7865 pack(TEMPLATE,LIST)
7866 package NAME Introduces package context.
7867 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7868 pop(ARRAY)
7869 print [FILEHANDLE] [(LIST)]
7870 printf [FILEHANDLE] (FORMAT,LIST)
7871 push(ARRAY,LIST)
7872 q/STRING/ Synonym for 'STRING'
7873 qq/STRING/ Synonym for \"STRING\"
7874 qx/STRING/ Synonym for `STRING`
7875 rand[(EXPR)]
7876 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7877 readdir(DIRHANDLE)
7878 readlink(EXPR)
7879 recv(SOCKET,SCALAR,LEN,FLAGS)
7880 redo [LABEL]
7881 rename(OLDNAME,NEWNAME)
7882 require [FILENAME | PERL_VERSION]
7883 reset[(EXPR)]
7884 return(LIST)
7885 reverse(LIST)
7886 rewinddir(DIRHANDLE)
7887 rindex(STR,SUBSTR[,OFFSET])
7888 rmdir(FILENAME)
7889 s/PATTERN/REPLACEMENT/gieoxsm
7890 scalar(EXPR)
7891 seek(FILEHANDLE,POSITION,WHENCE)
7892 seekdir(DIRHANDLE,POS)
7893 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7894 semctl(ID,SEMNUM,CMD,ARG)
7895 semget(KEY,NSEMS,SIZE,FLAGS)
7896 semop(KEY,...)
7897 send(SOCKET,MSG,FLAGS[,TO])
7898 setgrent
7899 sethostent(STAYOPEN)
7900 setnetent(STAYOPEN)
7901 setpgrp(PID,PGRP)
7902 setpriority(WHICH,WHO,PRIORITY)
7903 setprotoent(STAYOPEN)
7904 setpwent
7905 setservent(STAYOPEN)
7906 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7907 shift[(ARRAY)]
7908 shmctl(ID,CMD,ARG)
7909 shmget(KEY,SIZE,FLAGS)
7910 shmread(ID,VAR,POS,SIZE)
7911 shmwrite(ID,STRING,POS,SIZE)
7912 shutdown(SOCKET,HOW)
7913 sin(EXPR)
7914 sleep[(EXPR)]
7915 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7916 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7917 sort [SUBROUTINE] (LIST)
7918 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7919 split[(/PATTERN/[,EXPR[,LIMIT]])]
7920 sprintf(FORMAT,LIST)
7921 sqrt(EXPR)
7922 srand(EXPR)
7923 stat(EXPR|FILEHANDLE|VAR)
7924 study[(SCALAR)]
7925 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7926 substr(EXPR,OFFSET[,LEN])
7927 symlink(OLDFILE,NEWFILE)
7928 syscall(LIST)
7929 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7930 system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
7931 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7932 tell[(FILEHANDLE)]
7933 telldir(DIRHANDLE)
7934 time
7935 times
7936 tr/SEARCHLIST/REPLACEMENTLIST/cds
7937 truncate(FILE|EXPR,LENGTH)
7938 umask[(EXPR)]
7939 undef[(EXPR)]
7940 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7941 unlink(LIST)
7942 unpack(TEMPLATE,EXPR)
7943 unshift(ARRAY,LIST)
7944 until (EXPR) { ... } EXPR until EXPR
7945 utime(LIST)
7946 values(%HASH)
7947 vec(EXPR,OFFSET,BITS)
7948 wait
7949 waitpid(PID,FLAGS)
7950 wantarray Returns true if the sub/eval is called in list context.
7951 warn(LIST)
7952 while (EXPR) { ... } EXPR while EXPR
7953 write[(EXPR|FILEHANDLE)]
7954 ... x ... Repeat string or array.
7955 x= ... Repetition assignment.
7956 y/SEARCHLIST/REPLACEMENTLIST/
7957 ... | ... Bitwise or.
7958 ... || ... Logical or.
7959 ~ ... Unary bitwise complement.
7960 #! OS interpreter indicator. If contains `perl', used for options, and -x.
7961 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7962 CORE:: Prefix to access builtin function if imported sub obscures it.
7963 SUPER:: Prefix to lookup for a method in @ISA classes.
7964 DESTROY Shorthand for `sub DESTROY {...}'.
7965 ... EQ ... Obsolete synonym of `eq'.
7966 ... GE ... Obsolete synonym of `ge'.
7967 ... GT ... Obsolete synonym of `gt'.
7968 ... LE ... Obsolete synonym of `le'.
7969 ... LT ... Obsolete synonym of `lt'.
7970 ... NE ... Obsolete synonym of `ne'.
7971 abs [ EXPR ] absolute value
7972 ... and ... Low-precedence synonym for &&.
7973 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7974 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7975 chr Converts a number to char with the same ordinal.
7976 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7977 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7978 exists $HASH{KEY} True if the key exists.
7979 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7980 formline PICTURE, LIST Backdoor into \"format\" processing.
7981 glob EXPR Synonym of <EXPR>.
7982 lc [ EXPR ] Returns lowercased EXPR.
7983 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
7984 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
7985 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7986 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7987 not ... Low-precedence synonym for ! - negation.
7988 ... or ... Low-precedence synonym for ||.
7989 pos STRING Set/Get end-position of the last match over this string, see \\G.
7990 quotemeta [ EXPR ] Quote regexp metacharacters.
7991 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7992 readline FH Synonym of <FH>.
7993 readpipe CMD Synonym of `CMD`.
7994 ref [ EXPR ] Type of EXPR when dereferenced.
7995 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7996 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7997 tied Returns internal object for a tied data.
7998 uc [ EXPR ] Returns upcased EXPR.
7999 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
8000 untie VAR Unlink an object from a simple Perl variable.
8001 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
8002 ... xor ... Low-precedence synonym for exclusive or.
8003 prototype \\&SUB Returns prototype of the function given a reference.
8004 =head1 Top-level heading.
8005 =head2 Second-level heading.
8006 =head3 Third-level heading (is there such?).
8007 =over [ NUMBER ] Start list.
8008 =item [ TITLE ] Start new item in the list.
8009 =back End list.
8010 =cut Switch from POD to Perl.
8011 =pod Switch from Perl to POD.
8012 ")
8013
8014 (defun cperl-switch-to-doc-buffer (&optional interactive)
8015 "Go to the perl documentation buffer and insert the documentation."
8016 (interactive "p")
8017 (let ((buf (get-buffer-create cperl-doc-buffer)))
8018 (if interactive
8019 (switch-to-buffer-other-window buf)
8020 (set-buffer buf))
8021 (if (= (buffer-size) 0)
8022 (progn
8023 (insert (documentation-property 'cperl-short-docs
8024 'variable-documentation))
8025 (setq buffer-read-only t)))))
8026
8027 (defun cperl-beautify-regexp-piece (b e embed level)
8028 ;; b is before the starting delimiter, e before the ending
8029 ;; e should be a marker, may be changed, but remains "correct".
8030 ;; EMBED is nil if we process the whole REx.
8031 ;; The REx is guaranteed to have //x
8032 ;; LEVEL shows how many levels deep to go
8033 ;; position at enter and at leave is not defined
8034 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8035 (if embed
8036 (progn
8037 (goto-char b)
8038 (setq c (if (eq embed t) (current-indentation) (current-column)))
8039 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8040 (forward-char 2)
8041 (delete-char 1)
8042 (forward-char 1))
8043 ((looking-at "(\\?[^a-zA-Z]")
8044 (forward-char 3))
8045 ((looking-at "(\\?") ; (?i)
8046 (forward-char 2))
8047 (t
8048 (forward-char 1))))
8049 (goto-char (1+ b))
8050 (setq c (1- (current-column))))
8051 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
8052 (or (looking-at "[ \t]*[\n#]")
8053 (progn
8054 (insert "\n")))
8055 (goto-char e)
8056 (beginning-of-line)
8057 (if (re-search-forward "[^ \t]" e t)
8058 (progn ; Something before the ending delimiter
8059 (goto-char e)
8060 (delete-horizontal-space)
8061 (insert "\n")
8062 (cperl-make-indent c)
8063 (set-marker e (point))))
8064 (goto-char b)
8065 (end-of-line 2)
8066 (while (< (point) (marker-position e))
8067 (beginning-of-line)
8068 (setq s (point)
8069 inline t)
8070 (skip-chars-forward " \t")
8071 (delete-region s (point))
8072 (cperl-make-indent c1)
8073 (while (and
8074 inline
8075 (looking-at
8076 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8077 "\\|" ; Embedded variable
8078 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8079 "\\|" ; $ ^
8080 "[$^]"
8081 "\\|" ; simple-code simple-code*?
8082 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8083 "\\|" ; Class
8084 "\\(\\[\\)" ; 6
8085 "\\|" ; Grouping
8086 "\\((\\(\\?\\)?\\)" ; 7 8
8087 "\\|" ; |
8088 "\\(|\\)"))) ; 9
8089 (goto-char (match-end 0))
8090 (setq spaces t)
8091 (cond ((match-beginning 1) ; Alphanum word + junk
8092 (forward-char -1))
8093 ((or (match-beginning 3) ; $ab[12]
8094 (and (match-beginning 5) ; X* X+ X{2,3}
8095 (eq (preceding-char) ?\{)))
8096 (forward-char -1)
8097 (forward-sexp 1))
8098 ((and ; [], already syntaxified
8099 (match-beginning 6)
8100 cperl-regexp-scan
8101 cperl-use-syntax-table-text-property)
8102 (forward-char -1)
8103 (forward-sexp 1)
8104 (or (eq (preceding-char) ?\])
8105 (error "[]-group not terminated"))
8106 (re-search-forward
8107 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8108 ((match-beginning 6) ; []
8109 (setq tmp (point))
8110 (if (looking-at "\\^?\\]")
8111 (goto-char (match-end 0)))
8112 ;; XXXX POSIX classes?!
8113 (while (and (not pos)
8114 (re-search-forward "\\[:\\|\\]" e t))
8115 (if (eq (preceding-char) ?:)
8116 (or (re-search-forward ":\\]" e t)
8117 (error "[:POSIX:]-group in []-group not terminated"))
8118 (setq pos t)))
8119 (or (eq (preceding-char) ?\])
8120 (error "[]-group not terminated"))
8121 (re-search-forward
8122 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8123 ((match-beginning 7) ; ()
8124 (goto-char (match-beginning 0))
8125 (setq pos (current-column))
8126 (or (eq pos c1)
8127 (progn
8128 (delete-horizontal-space)
8129 (insert "\n")
8130 (cperl-make-indent c1)))
8131 (setq tmp (point))
8132 (forward-sexp 1)
8133 ;; (or (forward-sexp 1)
8134 ;; (progn
8135 ;; (goto-char tmp)
8136 ;; (error "()-group not terminated")))
8137 (set-marker m (1- (point)))
8138 (set-marker m1 (point))
8139 (if (= level 1)
8140 (if (progn ; indent rigidly if multiline
8141 ;; In fact does not make a lot of sense, since
8142 ;; the starting position can be already lost due
8143 ;; to insertion of "\n" and " "
8144 (goto-char tmp)
8145 (search-forward "\n" m1 t))
8146 (indent-rigidly (point) m1 (- c1 pos)))
8147 (setq level (1- level))
8148 (cond
8149 ((not (match-beginning 8))
8150 (cperl-beautify-regexp-piece tmp m t level))
8151 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8152 t)
8153 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8154 (goto-char (+ 2 tmp))
8155 (forward-sexp 1)
8156 (cperl-beautify-regexp-piece (point) m t level))
8157 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8158 (goto-char (+ 3 tmp))
8159 (cperl-beautify-regexp-piece (point) m t level))
8160 (t
8161 (cperl-beautify-regexp-piece tmp m t level))))
8162 (goto-char m1)
8163 (cond ((looking-at "[*+?]\\??")
8164 (goto-char (match-end 0)))
8165 ((eq (following-char) ?\{)
8166 (forward-sexp 1)
8167 (if (eq (following-char) ?\?)
8168 (forward-char))))
8169 (skip-chars-forward " \t")
8170 (setq spaces nil)
8171 (if (looking-at "[#\n]")
8172 (progn
8173 (or (eolp) (indent-for-comment))
8174 (beginning-of-line 2))
8175 (delete-horizontal-space)
8176 (insert "\n"))
8177 (end-of-line)
8178 (setq inline nil))
8179 ((match-beginning 9) ; |
8180 (forward-char -1)
8181 (setq tmp (point))
8182 (beginning-of-line)
8183 (if (re-search-forward "[^ \t]" tmp t)
8184 (progn
8185 (goto-char tmp)
8186 (delete-horizontal-space)
8187 (insert "\n"))
8188 ;; first at line
8189 (delete-region (point) tmp))
8190 (cperl-make-indent c)
8191 (forward-char 1)
8192 (skip-chars-forward " \t")
8193 (setq spaces nil)
8194 (if (looking-at "[#\n]")
8195 (beginning-of-line 2)
8196 (delete-horizontal-space)
8197 (insert "\n"))
8198 (end-of-line)
8199 (setq inline nil)))
8200 (or (looking-at "[ \t\n]")
8201 (not spaces)
8202 (insert " "))
8203 (skip-chars-forward " \t"))
8204 (or (looking-at "[#\n]")
8205 (error "Unknown code `%s' in a regexp"
8206 (buffer-substring (point) (1+ (point)))))
8207 (and inline (end-of-line 2)))
8208 ;; Special-case the last line of group
8209 (if (and (>= (point) (marker-position e))
8210 (/= (current-indentation) c))
8211 (progn
8212 (beginning-of-line)
8213 (cperl-make-indent c)))))
8214
8215 (defun cperl-make-regexp-x ()
8216 ;; Returns position of the start
8217 ;; XXX this is called too often! Need to cache the result!
8218 (save-excursion
8219 (or cperl-use-syntax-table-text-property
8220 (error "I need to have a regexp marked!"))
8221 ;; Find the start
8222 (if (looking-at "\\s|")
8223 nil ; good already
8224 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8225 (and (eq (preceding-char) ?q)
8226 (looking-at "\\(r\\)\\s|")))
8227 (goto-char (match-end 1))
8228 (re-search-backward "\\s|"))) ; Assume it is scanned already.
8229 ;;(forward-char 1)
8230 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8231 (sub-p (eq (preceding-char) ?s)) s)
8232 (forward-sexp 1)
8233 (set-marker e (1- (point)))
8234 (setq delim (preceding-char))
8235 (if (and sub-p (eq delim (char-after (- (point) 2))))
8236 (error "Possible s/blah// - do not know how to deal with"))
8237 (if sub-p (forward-sexp 1))
8238 (if (looking-at "\\sw*x")
8239 (setq have-x t)
8240 (insert "x"))
8241 ;; Protect fragile " ", "#"
8242 (if have-x nil
8243 (goto-char (1+ b))
8244 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8245 (forward-char -1)
8246 (insert "\\")
8247 (forward-char 1)))
8248 b)))
8249
8250 (defun cperl-beautify-regexp (&optional deep)
8251 "Do it. (Experimental, may change semantics, recheck the result.)
8252 We suppose that the regexp is scanned already."
8253 (interactive "P")
8254 (setq deep (if deep (prefix-numeric-value deep) -1))
8255 (save-excursion
8256 (goto-char (cperl-make-regexp-x))
8257 (let ((b (point)) (e (make-marker)))
8258 (forward-sexp 1)
8259 (set-marker e (1- (point)))
8260 (cperl-beautify-regexp-piece b e nil deep))))
8261
8262 (defun cperl-regext-to-level-start ()
8263 "Goto start of an enclosing group in regexp.
8264 We suppose that the regexp is scanned already."
8265 (interactive)
8266 (let ((limit (cperl-make-regexp-x)) done)
8267 (while (not done)
8268 (or (eq (following-char) ?\()
8269 (search-backward "(" (1+ limit) t)
8270 (error "Cannot find `(' which starts a group"))
8271 (setq done
8272 (save-excursion
8273 (skip-chars-backward "\\")
8274 (looking-at "\\(\\\\\\\\\\)*(")))
8275 (or done (forward-char -1)))))
8276
8277 (defun cperl-contract-level ()
8278 "Find an enclosing group in regexp and contract it.
8279 \(Experimental, may change semantics, recheck the result.)
8280 We suppose that the regexp is scanned already."
8281 (interactive)
8282 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
8283 (cperl-regext-to-level-start)
8284 (let ((b (point)) (e (make-marker)) c)
8285 (forward-sexp 1)
8286 (set-marker e (1- (point)))
8287 (goto-char b)
8288 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8289 (cond
8290 ((match-beginning 1) ; #-comment
8291 (or c (setq c (current-indentation)))
8292 (beginning-of-line 2) ; Skip
8293 (cperl-make-indent c))
8294 (t
8295 (delete-char -1)
8296 (just-one-space))))))
8297
8298 (defun cperl-contract-levels ()
8299 "Find an enclosing group in regexp and contract all the kids.
8300 \(Experimental, may change semantics, recheck the result.)
8301 We suppose that the regexp is scanned already."
8302 (interactive)
8303 (save-excursion
8304 (condition-case nil
8305 (cperl-regext-to-level-start)
8306 (error ; We are outside outermost group
8307 (goto-char (cperl-make-regexp-x))))
8308 (let ((b (point)) (e (make-marker)) s c)
8309 (forward-sexp 1)
8310 (set-marker e (1- (point)))
8311 (goto-char (1+ b))
8312 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
8313 (cond
8314 ((match-beginning 1) ; Skip
8315 nil)
8316 (t ; Group
8317 (cperl-contract-level)))))))
8318
8319 (defun cperl-beautify-level (&optional deep)
8320 "Find an enclosing group in regexp and beautify it.
8321 \(Experimental, may change semantics, recheck the result.)
8322 We suppose that the regexp is scanned already."
8323 (interactive "P")
8324 (setq deep (if deep (prefix-numeric-value deep) -1))
8325 (save-excursion
8326 (cperl-regext-to-level-start)
8327 (let ((b (point)) (e (make-marker)))
8328 (forward-sexp 1)
8329 (set-marker e (1- (point)))
8330 (cperl-beautify-regexp-piece b e 'level deep))))
8331
8332 (defun cperl-invert-if-unless-modifiers ()
8333 "Change `B if A;' into `if (A) {B}' etc if possible.
8334 \(Unfinished.)"
8335 (interactive)
8336 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8337 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8338 (and (= (char-syntax (preceding-char)) ?w)
8339 (forward-sexp -1))
8340 (setq pre-if (point))
8341 (cperl-backward-to-start-of-expr)
8342 (setq pre-B (point))
8343 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8344 (cperl-forward-to-end-of-expr)
8345 (setq post-A (point))
8346 (goto-char pre-if)
8347 (or (looking-at w-rex)
8348 ;; Find the position
8349 (progn (goto-char post-A)
8350 (while (and
8351 (not (looking-at w-rex))
8352 (> (point) pre-B))
8353 (forward-sexp -1))
8354 (setq pre-if (point))))
8355 (or (looking-at w-rex)
8356 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8357 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8358 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8359 ;; First, simple part: find code boundaries
8360 (forward-sexp 1)
8361 (setq post-if (point))
8362 (forward-sexp -2)
8363 (forward-sexp 1)
8364 (setq post-B (point))
8365 (cperl-backward-to-start-of-expr)
8366 (setq pre-B (point))
8367 (setq B (buffer-substring pre-B post-B))
8368 (goto-char pre-if)
8369 (forward-sexp 2)
8370 (forward-sexp -1)
8371 ;; May be after $, @, $# etc of a variable
8372 (skip-chars-backward "$@%#")
8373 (setq pre-A (point))
8374 (cperl-forward-to-end-of-expr)
8375 (setq post-A (point))
8376 (setq A (buffer-substring pre-A post-A))
8377 ;; Now modify (from end, to not break the stuff)
8378 (skip-chars-forward " \t;")
8379 (delete-region pre-A (point)) ; we move to pre-A
8380 (insert "\n" B ";\n}")
8381 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8382 (delete-region pre-if post-if)
8383 (delete-region pre-B post-B)
8384 (goto-char pre-B)
8385 (insert if-string " (" A ") {")
8386 (setq post-B (point))
8387 (if (looking-at "[ \t]+$")
8388 (delete-horizontal-space)
8389 (if (looking-at "[ \t]*#")
8390 (cperl-indent-for-comment)
8391 (just-one-space)))
8392 (forward-line 1)
8393 (if (looking-at "[ \t]*$")
8394 (progn ; delete line
8395 (delete-horizontal-space)
8396 (delete-region (point) (1+ (point)))))
8397 (cperl-indent-line)
8398 (goto-char (1- post-B))
8399 (forward-sexp 1)
8400 (cperl-indent-line)
8401 (goto-char pre-B)))
8402
8403 (defun cperl-invert-if-unless ()
8404 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8405 If the cursor is not on the leading keyword of the BLOCK flavor of
8406 construct, will assume it is the STATEMENT flavor, so will try to find
8407 the appropriate statement modifier."
8408 (interactive)
8409 (and (= (char-syntax (preceding-char)) ?w)
8410 (forward-sexp -1))
8411 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
8412 (let ((pre-if (point))
8413 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8414 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
8415 (forward-sexp 2)
8416 (setq post-A (point))
8417 (forward-sexp -1)
8418 (setq pre-A (point))
8419 (setq is-block (and (eq (following-char) ?\( )
8420 (save-excursion
8421 (condition-case nil
8422 (progn
8423 (forward-sexp 2)
8424 (forward-sexp -1)
8425 (eq (following-char) ?\{ ))
8426 (error nil)))))
8427 (if is-block
8428 (progn
8429 (goto-char post-A)
8430 (forward-sexp 1)
8431 (setq post-B (point))
8432 (forward-sexp -1)
8433 (setq pre-B (point))
8434 (if (and (eq (following-char) ?\{ )
8435 (progn
8436 (cperl-backward-to-noncomment post-A)
8437 (eq (preceding-char) ?\) )))
8438 (if (condition-case nil
8439 (progn
8440 (goto-char post-B)
8441 (forward-sexp 1)
8442 (forward-sexp -1)
8443 (looking-at "\\<els\\(e\\|if\\)\\>"))
8444 (error nil))
8445 (error
8446 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8447 (goto-char (1- post-B))
8448 (cperl-backward-to-noncomment pre-B)
8449 (if (eq (preceding-char) ?\;)
8450 (forward-char -1))
8451 (setq end-B-code (point))
8452 (goto-char pre-B)
8453 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
8454 (setq p (match-beginning 0)
8455 A (buffer-substring p (match-end 0))
8456 state (parse-partial-sexp pre-B p))
8457 (or (nth 3 state)
8458 (nth 4 state)
8459 (nth 5 state)
8460 (error "`%s' inside `%s' BLOCK" A if-string))
8461 (goto-char (match-end 0)))
8462 ;; Finally got it
8463 (goto-char (1+ pre-B))
8464 (skip-chars-forward " \t\n")
8465 (setq B (buffer-substring (point) end-B-code))
8466 (goto-char end-B-code)
8467 (or (looking-at ";?[ \t\n]*}")
8468 (progn
8469 (skip-chars-forward "; \t\n")
8470 (setq B-comment
8471 (buffer-substring (point) (1- post-B)))))
8472 (and (equal B "")
8473 (setq B "1"))
8474 (goto-char (1- post-A))
8475 (cperl-backward-to-noncomment pre-A)
8476 (or (looking-at "[ \t\n]*)")
8477 (goto-char (1- post-A)))
8478 (setq p (point))
8479 (goto-char (1+ pre-A))
8480 (skip-chars-forward " \t\n")
8481 (setq A (buffer-substring (point) p))
8482 (delete-region pre-B post-B)
8483 (delete-region pre-A post-A)
8484 (goto-char pre-if)
8485 (insert B " ")
8486 (and B-comment (insert B-comment " "))
8487 (just-one-space)
8488 (forward-word 1)
8489 (setq pre-A (point))
8490 (insert " " A ";")
8491 (delete-horizontal-space)
8492 (setq post-B (point))
8493 (if (looking-at "#")
8494 (indent-for-comment))
8495 (goto-char post-B)
8496 (forward-char -1)
8497 (delete-horizontal-space)
8498 (goto-char pre-A)
8499 (just-one-space)
8500 (goto-char pre-if)
8501 (setq pre-A (set-marker (make-marker) pre-A))
8502 (while (<= (point) (marker-position pre-A))
8503 (cperl-indent-line)
8504 (forward-line 1))
8505 (goto-char (marker-position pre-A))
8506 (if B-comment
8507 (progn
8508 (forward-line -1)
8509 (indent-for-comment)
8510 (goto-char (marker-position pre-A)))))
8511 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8512 ;; (error "`%s' not with an (EXPR)" if-string)
8513 (forward-sexp -1)
8514 (cperl-invert-if-unless-modifiers)))
8515 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8516 (cperl-invert-if-unless-modifiers)))
8517
8518 ;;; By Anthony Foiani <afoiani@uswest.com>
8519 ;;; Getting help on modules in C-h f ?
8520 ;;; This is a modified version of `man'.
8521 ;;; Need to teach it how to lookup functions
8522 ;;;###autoload
8523 (defun cperl-perldoc (word)
8524 "Run `perldoc' on WORD."
8525 (interactive
8526 (list (let* ((default-entry (cperl-word-at-point))
8527 (input (read-string
8528 (format "perldoc entry%s: "
8529 (if (string= default-entry "")
8530 ""
8531 (format " (default %s)" default-entry))))))
8532 (if (string= input "")
8533 (if (string= default-entry "")
8534 (error "No perldoc args given")
8535 default-entry)
8536 input))))
8537 (require 'man)
8538 (let* ((case-fold-search nil)
8539 (is-func (and
8540 (string-match "^[a-z]+$" word)
8541 (string-match (concat "^" word "\\>")
8542 (documentation-property
8543 'cperl-short-docs
8544 'variable-documentation))))
8545 (Man-switches "")
8546 (manual-program (if is-func "perldoc -f" "perldoc")))
8547 (cond
8548 ((featurep 'xemacs)
8549 (let ((Manual-program "perldoc")
8550 (Manual-switches (if is-func (list "-f"))))
8551 (manual-entry word)))
8552 (t
8553 (Man-getpage-in-background word)))))
8554
8555 ;;;###autoload
8556 (defun cperl-perldoc-at-point ()
8557 "Run a `perldoc' on the word around point."
8558 (interactive)
8559 (cperl-perldoc (cperl-word-at-point)))
8560
8561 (defcustom pod2man-program "pod2man"
8562 "*File name for `pod2man'."
8563 :type 'file
8564 :group 'cperl)
8565
8566 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
8567 (defun cperl-pod-to-manpage ()
8568 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8569 (interactive)
8570 (require 'man)
8571 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8572 (bufname (concat "Man " buffer-file-name))
8573 (buffer (generate-new-buffer bufname)))
8574 (with-current-buffer buffer
8575 (let ((process-environment (copy-sequence process-environment)))
8576 ;; Prevent any attempt to use display terminal fanciness.
8577 (setenv "TERM" "dumb")
8578 (set-process-sentinel
8579 (start-process pod2man-program buffer "sh" "-c"
8580 (format (cperl-pod2man-build-command) pod2man-args))
8581 'Man-bgproc-sentinel)))))
8582
8583 ;;; Updated version by him too
8584 (defun cperl-build-manpage ()
8585 "Create a virtual manpage in Emacs from the POD in the file."
8586 (interactive)
8587 (require 'man)
8588 (cond
8589 ((featurep 'xemacs)
8590 (let ((Manual-program "perldoc"))
8591 (manual-entry buffer-file-name)))
8592 (t
8593 (let* ((manual-program "perldoc")
8594 (Man-switches ""))
8595 (Man-getpage-in-background buffer-file-name)))))
8596
8597 (defun cperl-pod2man-build-command ()
8598 "Builds the entire background manpage and cleaning command."
8599 (let ((command (concat pod2man-program " %s 2>/dev/null"))
8600 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
8601 (while (and flist (car flist))
8602 (let ((pcom (car (car flist)))
8603 (pargs (cdr (car flist))))
8604 (setq command
8605 (concat command " | " pcom " "
8606 (mapconcat '(lambda (phrase)
8607 (if (not (stringp phrase))
8608 (error "Malformed Man-filter-list"))
8609 phrase)
8610 pargs " ")))
8611 (setq flist (cdr flist))))
8612 command))
8613
8614
8615 (defun cperl-next-interpolated-REx-1 ()
8616 "Move point to next REx which has interpolated parts without //o.
8617 Skips RExes consisting of one interpolated variable.
8618
8619 Note that skipped RExen are not performance hits."
8620 (interactive "")
8621 (cperl-next-interpolated-REx 1))
8622
8623 (defun cperl-next-interpolated-REx-0 ()
8624 "Move point to next REx which has interpolated parts without //o."
8625 (interactive "")
8626 (cperl-next-interpolated-REx 0))
8627
8628 (defun cperl-next-interpolated-REx (&optional skip beg limit)
8629 "Move point to next REx which has interpolated parts.
8630 SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8631 point and the limit of search (default to point and end of buffer).
8632
8633 SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8634 semantic may be used as a numeric argument.
8635
8636 Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8637 a result of qr//, this is not a performance hit), t for the rest."
8638 (interactive "P")
8639 (if (numberp skip) (setq skip (list 0 skip)))
8640 (or beg (setq beg (point)))
8641 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8642 (let (pp)
8643 (and (eq (get-text-property beg 'syntax-type) 'string)
8644 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8645 (cperl-map-pods-heres
8646 (function (lambda (s e p)
8647 (if (memq (get-text-property s 'REx-interpolated) skip)
8648 t
8649 (setq pp s)
8650 nil))) ; nil stops
8651 'REx-interpolated beg limit)
8652 (if pp (goto-char pp)
8653 (message "No more interpolated REx"))))
8654
8655 ;;; Initial version contributed by Trey Belew
8656 (defun cperl-here-doc-spell (&optional beg end)
8657 "Spell-check HERE-documents in the Perl buffer.
8658 If a region is highlighted, restricts to the region."
8659 (interactive "")
8660 (cperl-pod-spell t beg end))
8661
8662 (defun cperl-pod-spell (&optional do-heres beg end)
8663 "Spell-check POD documentation.
8664 If invoked with prefix argument, will do HERE-DOCs instead.
8665 If a region is highlighted, restricts to the region."
8666 (interactive "P")
8667 (save-excursion
8668 (let (beg end)
8669 (if (cperl-mark-active)
8670 (setq beg (min (mark) (point))
8671 end (max (mark) (point)))
8672 (setq beg (point-min)
8673 end (point-max)))
8674 (cperl-map-pods-heres (function
8675 (lambda (s e p)
8676 (if do-heres
8677 (setq e (save-excursion
8678 (goto-char e)
8679 (forward-line -1)
8680 (point))))
8681 (ispell-region s e)
8682 t))
8683 (if do-heres 'here-doc-group 'in-pod)
8684 beg end))))
8685
8686 (defun cperl-map-pods-heres (func &optional prop s end)
8687 "Executes a function over regions of pods or here-documents.
8688 PROP is the text-property to search for; default to `in-pod'. Stop when
8689 function returns nil."
8690 (let (pos posend has-prop (cont t))
8691 (or prop (setq prop 'in-pod))
8692 (or s (setq s (point-min)))
8693 (or end (setq end (point-max)))
8694 (cperl-update-syntaxification end end)
8695 (save-excursion
8696 (goto-char (setq pos s))
8697 (while (and cont (< pos end))
8698 (setq has-prop (get-text-property pos prop))
8699 (setq posend (next-single-property-change pos prop nil end))
8700 (and has-prop
8701 (setq cont (funcall func pos posend prop)))
8702 (setq pos posend)))))
8703
8704 ;;; Based on code by Masatake YAMATO:
8705 (defun cperl-get-here-doc-region (&optional pos pod)
8706 "Return HERE document region around the point.
8707 Return nil if the point is not in a HERE document region. If POD is non-nil,
8708 will return a POD section if point is in a POD section."
8709 (or pos (setq pos (point)))
8710 (cperl-update-syntaxification pos pos)
8711 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8712 (and pod
8713 (eq 'pod (get-text-property pos 'syntax-type))))
8714 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8715 (e (next-single-property-change pos 'syntax-type)))
8716 (cons b (or e (point-max))))))
8717
8718 (defun cperl-narrow-to-here-doc (&optional pos)
8719 "Narrows editing region to the HERE-DOC at POS.
8720 POS defaults to the point."
8721 (interactive "d")
8722 (or pos (setq pos (point)))
8723 (let ((p (cperl-get-here-doc-region pos)))
8724 (or p (error "Not inside a HERE document"))
8725 (narrow-to-region (car p) (cdr p))
8726 (message
8727 "When you are finished with narrow editing, type C-x n w")))
8728
8729 (defun cperl-select-this-pod-or-here-doc (&optional pos)
8730 "Select the HERE-DOC (or POD section) at POS.
8731 POS defaults to the point."
8732 (interactive "d")
8733 (let ((p (cperl-get-here-doc-region pos t)))
8734 (if p
8735 (progn
8736 (goto-char (car p))
8737 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8738 (message "I do not think POS is in POD or a HERE-doc..."))))
8739
8740 (defun cperl-facemenu-add-face-function (face end)
8741 "A callback to process user-initiated font-change requests.
8742 Translates `bold', `italic', and `bold-italic' requests to insertion of
8743 corresponding POD directives, and `underline' to C<> POD directive.
8744
8745 Such requests are usually bound to M-o LETTER."
8746 (or (get-text-property (point) 'in-pod)
8747 (error "Faces can only be set within POD"))
8748 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8749 (cdr (or (assq face '((bold . "B<")
8750 (italic . "I<")
8751 (bold-italic . "B<I<")
8752 (underline . "C<")))
8753 (error "Face %s not configured for cperl-mode"
8754 face))))
8755 \f
8756 (defun cperl-time-fontification (&optional l step lim)
8757 "Times how long it takes to do incremental fontification in a region.
8758 L is the line to start at, STEP is the number of lines to skip when
8759 doing next incremental fontification, LIM is the maximal number of
8760 incremental fontification to perform. Messages are accumulated in
8761 *Messages* buffer.
8762
8763 May be used for pinpointing which construct slows down buffer fontification:
8764 start with default arguments, then refine the slowdown regions."
8765 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8766 (or l (setq l 1))
8767 (or step (setq step 500))
8768 (or lim (setq lim 40))
8769 (let* ((timems (function (lambda ()
8770 (let ((tt (current-time)))
8771 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8772 (tt (funcall timems)) (c 0) delta tot)
8773 (goto-char (point-min))
8774 (forward-line (1- l))
8775 (cperl-mode)
8776 (setq tot (- (- tt (setq tt (funcall timems)))))
8777 (message "cperl-mode at %s: %s" l tot)
8778 (while (and (< c lim) (not (eobp)))
8779 (forward-line step)
8780 (setq l (+ l step))
8781 (setq c (1+ c))
8782 (cperl-update-syntaxification (point) (point))
8783 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8784 (message "to %s:%6s,%7s" l delta tot))
8785 tot))
8786
8787 (defvar font-lock-cache-position)
8788
8789 (defun cperl-emulate-lazy-lock (&optional window-size)
8790 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8791 Start fontifying the buffer from the start (or end) using the given
8792 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8793 goes backwards; default is -50. This function is not CPerl-specific; it
8794 may be used to debug problems with delayed incremental fontification."
8795 (interactive
8796 "nSize of window for incremental fontification, negative goes backwards: ")
8797 (or window-size (setq window-size -50))
8798 (let ((pos (if (> window-size 0)
8799 (point-min)
8800 (point-max)))
8801 p)
8802 (goto-char pos)
8803 (normal-mode)
8804 ;; Why needed??? With older font-locks???
8805 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8806 (while (if (> window-size 0)
8807 (< pos (point-max))
8808 (> pos (point-min)))
8809 (setq p (progn
8810 (forward-line window-size)
8811 (point)))
8812 (font-lock-fontify-region (min p pos) (max p pos))
8813 (setq pos p))))
8814
8815 \f
8816 (defun cperl-lazy-install ()) ; Avoid a warning
8817 (defun cperl-lazy-unstall ()) ; Avoid a warning
8818
8819 (if (fboundp 'run-with-idle-timer)
8820 (progn
8821 (defvar cperl-help-shown nil
8822 "Non-nil means that the help was already shown now.")
8823
8824 (defvar cperl-lazy-installed nil
8825 "Non-nil means that the lazy-help handlers are installed now.")
8826
8827 (defun cperl-lazy-install ()
8828 "Switches on Auto-Help on Perl constructs (put in the message area).
8829 Delay of auto-help controlled by `cperl-lazy-help-time'."
8830 (interactive)
8831 (make-local-variable 'cperl-help-shown)
8832 (if (and (cperl-val 'cperl-lazy-help-time)
8833 (not cperl-lazy-installed))
8834 (progn
8835 (add-hook 'post-command-hook 'cperl-lazy-hook)
8836 (run-with-idle-timer
8837 (cperl-val 'cperl-lazy-help-time 1000000 5)
8838 t
8839 'cperl-get-help-defer)
8840 (setq cperl-lazy-installed t))))
8841
8842 (defun cperl-lazy-unstall ()
8843 "Switches off Auto-Help on Perl constructs (put in the message area).
8844 Delay of auto-help controlled by `cperl-lazy-help-time'."
8845 (interactive)
8846 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8847 (cancel-function-timers 'cperl-get-help-defer)
8848 (setq cperl-lazy-installed nil))
8849
8850 (defun cperl-lazy-hook ()
8851 (setq cperl-help-shown nil))
8852
8853 (defun cperl-get-help-defer ()
8854 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
8855 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8856 (cperl-get-help)
8857 (setq cperl-help-shown t))))
8858 (cperl-lazy-install)))
8859
8860
8861 ;;; Plug for wrong font-lock:
8862
8863 (defun cperl-font-lock-unfontify-region-function (beg end)
8864 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8865 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8866 before-change-functions after-change-functions
8867 deactivate-mark buffer-file-name buffer-file-truename)
8868 (remove-text-properties beg end '(face nil))
8869 (if (and (not modified) (buffer-modified-p))
8870 (set-buffer-modified-p nil))))
8871
8872 (defun cperl-font-lock-fontify-region-function (beg end loudly)
8873 "Extends the region to safe positions, then calls the default function.
8874 Newer `font-lock's can do it themselves.
8875 We unwind only as far as needed for fontification. Syntaxification may
8876 do extra unwind via `cperl-unwind-to-safe'."
8877 (save-excursion
8878 (goto-char beg)
8879 (while (and beg
8880 (progn
8881 (beginning-of-line)
8882 (eq (get-text-property (setq beg (point)) 'syntax-type)
8883 'multiline)))
8884 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8885 (goto-char beg)))
8886 (setq beg (point))
8887 (goto-char end)
8888 (while (and end
8889 (progn
8890 (or (bolp) (condition-case nil
8891 (forward-line 1)
8892 (error nil)))
8893 (eq (get-text-property (setq end (point)) 'syntax-type)
8894 'multiline)))
8895 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8896 (goto-char end))
8897 (setq end (point)))
8898 (font-lock-default-fontify-region beg end loudly))
8899
8900 (defvar cperl-d-l nil)
8901 (defun cperl-fontify-syntaxically (end)
8902 ;; Some vars for debugging only
8903 ;; (message "Syntaxifying...")
8904 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
8905 (istate (car cperl-syntax-state))
8906 start from-start edebug-backtrace-buffer)
8907 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8908 (progn
8909 (require 'edebug)
8910 (let ((f 'edebug-backtrace))
8911 (funcall f)))) ; Avoid compile-time warning
8912 (or cperl-syntax-done-to
8913 (setq cperl-syntax-done-to (point-min)
8914 from-start t))
8915 (setq start (if (and cperl-hook-after-change
8916 (not from-start))
8917 cperl-syntax-done-to ; Fontify without change; ignore start
8918 ;; Need to forget what is after `start'
8919 (min cperl-syntax-done-to (point))))
8920 (goto-char start)
8921 (beginning-of-line)
8922 (setq start (point))
8923 (and cperl-syntaxify-unwind
8924 (setq end (cperl-unwind-to-safe t end)
8925 start (point)))
8926 (and (> end start)
8927 (setq cperl-syntax-done-to start) ; In case what follows fails
8928 (cperl-find-pods-heres start end t nil t))
8929 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8930 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8931 dbg iend start end idone cperl-syntax-done-to
8932 istate (car cperl-syntax-state))) ; For debugging
8933 nil)) ; Do not iterate
8934
8935 (defun cperl-fontify-update (end)
8936 (let ((pos (point-min)) prop posend)
8937 (setq end (point-max))
8938 (while (< pos end)
8939 (setq prop (get-text-property pos 'cperl-postpone)
8940 posend (next-single-property-change pos 'cperl-postpone nil end))
8941 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8942 (setq pos posend)))
8943 nil) ; Do not iterate
8944
8945 (defun cperl-fontify-update-bad (end)
8946 ;; Since fontification happens with different region than syntaxification,
8947 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8948 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8949 (if prop
8950 (setq pos (or (cperl-beginning-of-property
8951 (cperl-1+ pos) 'cperl-postpone)
8952 (point-min))))
8953 (while (< pos end)
8954 (setq posend (next-single-property-change pos 'cperl-postpone))
8955 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8956 (setq pos posend)
8957 (setq prop (get-text-property pos 'cperl-postpone))))
8958 nil) ; Do not iterate
8959
8960 ;; Called when any modification is made to buffer text.
8961 (defun cperl-after-change-function (beg end old-len)
8962 ;; We should have been informed about changes by `font-lock'. Since it
8963 ;; does not inform as which calls are defered, do it ourselves
8964 (if cperl-syntax-done-to
8965 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8966
8967 (defun cperl-update-syntaxification (from to)
8968 (if (and cperl-use-syntax-table-text-property
8969 cperl-syntaxify-by-font-lock
8970 (or (null cperl-syntax-done-to)
8971 (< cperl-syntax-done-to to)))
8972 (progn
8973 (save-excursion
8974 (goto-char from)
8975 (cperl-fontify-syntaxically to)))))
8976
8977 (defvar cperl-version
8978 (let ((v "Revision: 6.2"))
8979 (string-match ":\\s *\\([0-9.]+\\)" v)
8980 (substring v (match-beginning 1) (match-end 1)))
8981 "Version of IZ-supported CPerl package this file is based on.")
8982
8983 (provide 'cperl-mode)
8984
8985 ;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
8986 ;;; cperl-mode.el ends here