]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cperl-mode.el
* lisp/emacs-lisp/smie.el: Simplify the smie-rules-function return values.
[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,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 ;; 2008, 2009, 2010 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 (when (featurep 'xemacs)
1806 ;; This one is obsolete...
1807 (make-local-variable 'vc-header-alist)
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 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
1812 (make-local-variable 'compilation-error-regexp-alist-alist)
1813 (set 'compilation-error-regexp-alist-alist
1814 (cons (cons 'cperl (car cperl-compilation-error-regexp-alist))
1815 (symbol-value 'compilation-error-regexp-alist-alist)))
1816 (if (fboundp 'compilation-build-compilation-error-regexp-alist)
1817 (let ((f 'compilation-build-compilation-error-regexp-alist))
1818 (funcall f))
1819 (make-local-variable 'compilation-error-regexp-alist)
1820 (push 'cperl compilation-error-regexp-alist)))
1821 ((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
1822 (make-local-variable 'compilation-error-regexp-alist)
1823 (set 'compilation-error-regexp-alist
1824 (append cperl-compilation-error-regexp-alist
1825 (symbol-value 'compilation-error-regexp-alist)))))
1826 (make-local-variable 'font-lock-defaults)
1827 (setq font-lock-defaults
1828 (cond
1829 ((string< emacs-version "19.30")
1830 '(cperl-font-lock-keywords-2 nil nil ((?_ . "w"))))
1831 ((string< emacs-version "19.33") ; Which one to use?
1832 '((cperl-font-lock-keywords
1833 cperl-font-lock-keywords-1
1834 cperl-font-lock-keywords-2) nil nil ((?_ . "w"))))
1835 (t
1836 '((cperl-load-font-lock-keywords
1837 cperl-load-font-lock-keywords-1
1838 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
1839 (make-local-variable 'cperl-syntax-state)
1840 (setq cperl-syntax-state nil) ; reset syntaxification cache
1841 (if cperl-use-syntax-table-text-property
1842 (if (boundp 'syntax-propertize-function)
1843 (progn
1844 ;; Reset syntaxification cache.
1845 (set (make-local-variable 'cperl-syntax-done-to) nil)
1846 (set (make-local-variable 'syntax-propertize-function)
1847 (lambda (start end)
1848 (goto-char start) (cperl-fontify-syntaxically end))))
1849 (make-local-variable 'parse-sexp-lookup-properties)
1850 ;; Do not introduce variable if not needed, we check it!
1851 (set 'parse-sexp-lookup-properties t)
1852 ;; Fix broken font-lock:
1853 (or (boundp 'font-lock-unfontify-region-function)
1854 (set 'font-lock-unfontify-region-function
1855 'font-lock-default-unfontify-region))
1856 (unless (featurep 'xemacs) ; Our: just a plug for wrong font-lock
1857 (make-local-variable 'font-lock-unfontify-region-function)
1858 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1859 'cperl-font-lock-unfontify-region-function))
1860 (make-local-variable 'cperl-syntax-done-to)
1861 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
1862 (make-local-variable 'font-lock-syntactic-keywords)
1863 (setq font-lock-syntactic-keywords
1864 (if cperl-syntaxify-by-font-lock
1865 '((cperl-fontify-syntaxically))
1866 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1867 ;; used to ignore syntax-table text-properties. (t) is a hack
1868 ;; to make font-lock think that font-lock-syntactic-keywords
1869 ;; are defined.
1870 '(t)))))
1871 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
1872 (progn
1873 (setq cperl-font-lock-multiline t) ; Not localized...
1874 (set (make-local-variable 'font-lock-multiline) t))
1875 (make-local-variable 'font-lock-fontify-region-function)
1876 (set 'font-lock-fontify-region-function ; not present with old Emacs
1877 'cperl-font-lock-fontify-region-function))
1878 (make-local-variable 'font-lock-fontify-region-function)
1879 (set 'font-lock-fontify-region-function ; not present with old Emacs
1880 'cperl-font-lock-fontify-region-function)
1881 (make-local-variable 'cperl-old-style)
1882 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1883 (set (make-local-variable 'normal-auto-fill-function)
1884 'cperl-do-auto-fill)
1885 (or (fboundp 'cperl-old-auto-fill-mode)
1886 (progn
1887 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1888 (defun auto-fill-mode (&optional arg)
1889 (interactive "P")
1890 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1891 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1892 (setq auto-fill-function 'cperl-do-auto-fill))))))
1893 (if (cperl-enable-font-lock)
1894 (if (cperl-val 'cperl-font-lock)
1895 (progn (or cperl-faces-init (cperl-init-faces))
1896 (font-lock-mode 1))))
1897 (set (make-local-variable 'facemenu-add-face-function)
1898 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
1899 (and (boundp 'msb-menu-cond)
1900 (not cperl-msb-fixed)
1901 (cperl-msb-fix))
1902 (if (featurep 'easymenu)
1903 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
1904 (run-mode-hooks 'cperl-mode-hook)
1905 (if cperl-hook-after-change
1906 (add-hook 'after-change-functions 'cperl-after-change-function nil t))
1907 ;; After hooks since fontification will break this
1908 (if cperl-pod-here-scan
1909 (or cperl-syntaxify-by-font-lock
1910 (progn (or cperl-faces-init (cperl-init-faces-weak))
1911 (cperl-find-pods-heres)))))
1912 \f
1913 ;; Fix for perldb - make default reasonable
1914 (defun cperl-db ()
1915 (interactive)
1916 (require 'gud)
1917 (perldb (read-from-minibuffer "Run perldb (like this): "
1918 (if (consp gud-perldb-history)
1919 (car gud-perldb-history)
1920 (concat "perl " ;;(file-name-nondirectory
1921 ;; I have problems
1922 ;; in OS/2
1923 ;; otherwise
1924 (buffer-file-name)))
1925 nil nil
1926 '(gud-perldb-history . 1))))
1927 \f
1928 (defun cperl-msb-fix ()
1929 ;; Adds perl files to msb menu, supposes that msb is already loaded
1930 (setq cperl-msb-fixed t)
1931 (let* ((l (length msb-menu-cond))
1932 (last (nth (1- l) msb-menu-cond))
1933 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1934 (handle (1- (nth 1 last))))
1935 (setcdr precdr (list
1936 (list
1937 '(memq major-mode '(cperl-mode perl-mode))
1938 handle
1939 "Perl Files (%d)")
1940 last))))
1941 \f
1942 ;; This is used by indent-for-comment
1943 ;; to decide how much to indent a comment in CPerl code
1944 ;; based on its context. Do fallback if comment is found wrong.
1945
1946 (defvar cperl-wrong-comment)
1947 (defvar cperl-st-cfence '(14)) ; Comment-fence
1948 (defvar cperl-st-sfence '(15)) ; String-fence
1949 (defvar cperl-st-punct '(1))
1950 (defvar cperl-st-word '(2))
1951 (defvar cperl-st-bra '(4 . ?\>))
1952 (defvar cperl-st-ket '(5 . ?\<))
1953
1954
1955 (defun cperl-comment-indent () ; called at point at supposed comment
1956 (let ((p (point)) (c (current-column)) was phony)
1957 (if (and (not cperl-indent-comment-at-column-0)
1958 (looking-at "^#"))
1959 0 ; Existing comment at bol stays there.
1960 ;; Wrong comment found
1961 (save-excursion
1962 (setq was (cperl-to-comment-or-eol)
1963 phony (eq (get-text-property (point) 'syntax-table)
1964 cperl-st-cfence))
1965 (if phony
1966 (progn ; Too naive???
1967 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1968 (if (eq (preceding-char) ?\#)
1969 (forward-char -1))
1970 (setq was nil)))
1971 (if (= (point) p) ; Our caller found a correct place
1972 (progn
1973 (skip-chars-backward " \t")
1974 (setq was (current-column))
1975 (if (eq was 0)
1976 comment-column
1977 (max (1+ was) ; Else indent at comment column
1978 comment-column)))
1979 ;; No, the caller found a random place; we need to edit ourselves
1980 (if was nil
1981 (insert comment-start)
1982 (backward-char (length comment-start)))
1983 (setq cperl-wrong-comment t)
1984 (cperl-make-indent comment-column 1) ; Indent min 1
1985 c)))))
1986
1987 ;;;(defun cperl-comment-indent-fallback ()
1988 ;;; "Is called if the standard comment-search procedure fails.
1989 ;;;Point is at start of real comment."
1990 ;;; (let ((c (current-column)) target cnt prevc)
1991 ;;; (if (= c comment-column) nil
1992 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1993 ;;; (setq target (max (1+ (setq prevc
1994 ;;; (current-column))) ; Else indent at comment column
1995 ;;; comment-column))
1996 ;;; (if (= c comment-column) nil
1997 ;;; (delete-backward-char cnt)
1998 ;;; (while (< prevc target)
1999 ;;; (insert "\t")
2000 ;;; (setq prevc (current-column)))
2001 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2002 ;;; (while (< prevc target)
2003 ;;; (insert " ")
2004 ;;; (setq prevc (current-column)))))))
2005
2006 (defun cperl-indent-for-comment ()
2007 "Substitute for `indent-for-comment' in CPerl."
2008 (interactive)
2009 (let (cperl-wrong-comment)
2010 (indent-for-comment)
2011 (if cperl-wrong-comment ; set by `cperl-comment-indent'
2012 (progn (cperl-to-comment-or-eol)
2013 (forward-char (length comment-start))))))
2014
2015 (defun cperl-comment-region (b e arg)
2016 "Comment or uncomment each line in the region in CPerl mode.
2017 See `comment-region'."
2018 (interactive "r\np")
2019 (let ((comment-start "#"))
2020 (comment-region b e arg)))
2021
2022 (defun cperl-uncomment-region (b e arg)
2023 "Uncomment or comment each line in the region in CPerl mode.
2024 See `comment-region'."
2025 (interactive "r\np")
2026 (let ((comment-start "#"))
2027 (comment-region b e (- arg))))
2028
2029 (defvar cperl-brace-recursing nil)
2030
2031 (defun cperl-electric-brace (arg &optional only-before)
2032 "Insert character and correct line's indentation.
2033 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2034 place (even in empty line), but not after. If after \")\" and the inserted
2035 char is \"{\", insert extra newline before only if
2036 `cperl-extra-newline-before-brace'."
2037 (interactive "P")
2038 (let (insertpos
2039 (other-end (if (and cperl-electric-parens-mark
2040 (cperl-mark-active)
2041 (< (mark) (point)))
2042 (mark)
2043 nil)))
2044 (if (and other-end
2045 (not cperl-brace-recursing)
2046 (cperl-val 'cperl-electric-parens)
2047 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2048 ;; Need to insert a matching pair
2049 (progn
2050 (save-excursion
2051 (setq insertpos (point-marker))
2052 (goto-char other-end)
2053 (setq last-command-event ?\{)
2054 (cperl-electric-lbrace arg insertpos))
2055 (forward-char 1))
2056 ;; Check whether we close something "usual" with `}'
2057 (if (and (eq last-command-event ?\})
2058 (not
2059 (condition-case nil
2060 (save-excursion
2061 (up-list (- (prefix-numeric-value arg)))
2062 ;;(cperl-after-block-p (point-min))
2063 (or (cperl-after-expr-p nil "{;)")
2064 ;; after sub, else, continue
2065 (cperl-after-block-p nil 'pre)))
2066 (error nil))))
2067 ;; Just insert the guy
2068 (self-insert-command (prefix-numeric-value arg))
2069 (if (and (not arg) ; No args, end (of empty line or auto)
2070 (eolp)
2071 (or (and (null only-before)
2072 (save-excursion
2073 (skip-chars-backward " \t")
2074 (bolp)))
2075 (and (eq last-command-event ?\{) ; Do not insert newline
2076 ;; if after ")" and `cperl-extra-newline-before-brace'
2077 ;; is nil, do not insert extra newline.
2078 (not cperl-extra-newline-before-brace)
2079 (save-excursion
2080 (skip-chars-backward " \t")
2081 (eq (preceding-char) ?\))))
2082 (if cperl-auto-newline
2083 (progn (cperl-indent-line) (newline) t) nil)))
2084 (progn
2085 (self-insert-command (prefix-numeric-value arg))
2086 (cperl-indent-line)
2087 (if cperl-auto-newline
2088 (setq insertpos (1- (point))))
2089 (if (and cperl-auto-newline (null only-before))
2090 (progn
2091 (newline)
2092 (cperl-indent-line)))
2093 (save-excursion
2094 (if insertpos (progn (goto-char insertpos)
2095 (search-forward (make-string
2096 1 last-command-event))
2097 (setq insertpos (1- (point)))))
2098 (delete-char -1))))
2099 (if insertpos
2100 (save-excursion
2101 (goto-char insertpos)
2102 (self-insert-command (prefix-numeric-value arg)))
2103 (self-insert-command (prefix-numeric-value arg)))))))
2104
2105 (defun cperl-electric-lbrace (arg &optional end)
2106 "Insert character, correct line's indentation, correct quoting by space."
2107 (interactive "P")
2108 (let ((cperl-brace-recursing t)
2109 (cperl-auto-newline cperl-auto-newline)
2110 (other-end (or end
2111 (if (and cperl-electric-parens-mark
2112 (cperl-mark-active)
2113 (> (mark) (point)))
2114 (save-excursion
2115 (goto-char (mark))
2116 (point-marker))
2117 nil)))
2118 pos after)
2119 (and (cperl-val 'cperl-electric-lbrace-space)
2120 (eq (preceding-char) ?$)
2121 (save-excursion
2122 (skip-chars-backward "$")
2123 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
2124 (insert ?\s))
2125 ;; Check whether we are in comment
2126 (if (and
2127 (save-excursion
2128 (beginning-of-line)
2129 (not (looking-at "[ \t]*#")))
2130 (cperl-after-expr-p nil "{;)"))
2131 nil
2132 (setq cperl-auto-newline nil))
2133 (cperl-electric-brace arg)
2134 (and (cperl-val 'cperl-electric-parens)
2135 (eq last-command-event ?{)
2136 (memq last-command-event
2137 (append cperl-electric-parens-string nil))
2138 (or (if other-end (goto-char (marker-position other-end)))
2139 t)
2140 (setq last-command-event ?} pos (point))
2141 (progn (cperl-electric-brace arg t)
2142 (goto-char pos)))))
2143
2144 (defun cperl-electric-paren (arg)
2145 "Insert an opening parenthesis or a matching pair of parentheses.
2146 See `cperl-electric-parens'."
2147 (interactive "P")
2148 (let ((beg (point-at-bol))
2149 (other-end (if (and cperl-electric-parens-mark
2150 (cperl-mark-active)
2151 (> (mark) (point)))
2152 (save-excursion
2153 (goto-char (mark))
2154 (point-marker))
2155 nil)))
2156 (if (and (cperl-val 'cperl-electric-parens)
2157 (memq last-command-event
2158 (append cperl-electric-parens-string nil))
2159 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2160 ;;(not (save-excursion (search-backward "#" beg t)))
2161 (if (eq last-command-event ?<)
2162 (progn
2163 ;; This code is too electric, see Bug#3943.
2164 ;; (and abbrev-mode ; later it is too late, may be after `for'
2165 ;; (expand-abbrev))
2166 (cperl-after-expr-p nil "{;(,:="))
2167 1))
2168 (progn
2169 (self-insert-command (prefix-numeric-value arg))
2170 (if other-end (goto-char (marker-position other-end)))
2171 (insert (make-string
2172 (prefix-numeric-value arg)
2173 (cdr (assoc last-command-event '((?{ .?})
2174 (?[ . ?])
2175 (?( . ?))
2176 (?< . ?>))))))
2177 (forward-char (- (prefix-numeric-value arg))))
2178 (self-insert-command (prefix-numeric-value arg)))))
2179
2180 (defun cperl-electric-rparen (arg)
2181 "Insert a matching pair of parentheses if marking is active.
2182 If not, or if we are not at the end of marking range, would self-insert.
2183 Affected by `cperl-electric-parens'."
2184 (interactive "P")
2185 (let ((beg (point-at-bol))
2186 (other-end (if (and cperl-electric-parens-mark
2187 (cperl-val 'cperl-electric-parens)
2188 (memq last-command-event
2189 (append cperl-electric-parens-string nil))
2190 (cperl-mark-active)
2191 (< (mark) (point)))
2192 (mark)
2193 nil))
2194 p)
2195 (if (and other-end
2196 (cperl-val 'cperl-electric-parens)
2197 (memq last-command-event '( ?\) ?\] ?\} ?\> ))
2198 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2199 ;;(not (save-excursion (search-backward "#" beg t)))
2200 )
2201 (progn
2202 (self-insert-command (prefix-numeric-value arg))
2203 (setq p (point))
2204 (if other-end (goto-char other-end))
2205 (insert (make-string
2206 (prefix-numeric-value arg)
2207 (cdr (assoc last-command-event '((?\} . ?\{)
2208 (?\] . ?\[)
2209 (?\) . ?\()
2210 (?\> . ?\<))))))
2211 (goto-char (1+ p)))
2212 (self-insert-command (prefix-numeric-value arg)))))
2213
2214 (defun cperl-electric-keyword ()
2215 "Insert a construction appropriate after a keyword.
2216 Help message may be switched off by setting `cperl-message-electric-keyword'
2217 to nil."
2218 (let ((beg (point-at-bol))
2219 (dollar (and (eq last-command-event ?$)
2220 (eq this-command 'self-insert-command)))
2221 (delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
2222 (memq this-command '(self-insert-command newline))))
2223 my do)
2224 (and (save-excursion
2225 (condition-case nil
2226 (progn
2227 (backward-sexp 1)
2228 (setq do (looking-at "do\\>")))
2229 (error nil))
2230 (cperl-after-expr-p nil "{;:"))
2231 (save-excursion
2232 (not
2233 (re-search-backward
2234 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2235 beg t)))
2236 (save-excursion (or (not (re-search-backward "^=" nil t))
2237 (or
2238 (looking-at "=cut")
2239 (and cperl-use-syntax-table-text-property
2240 (not (eq (get-text-property (point)
2241 'syntax-type)
2242 'pod))))))
2243 (save-excursion (forward-sexp -1)
2244 (not (memq (following-char) (append "$@%&*" nil))))
2245 (progn
2246 (and (eq (preceding-char) ?y)
2247 (progn ; "foreachmy"
2248 (forward-char -2)
2249 (insert " ")
2250 (forward-char 2)
2251 (setq my t dollar t
2252 delete
2253 (memq this-command '(self-insert-command newline)))))
2254 (and dollar (insert " $"))
2255 (cperl-indent-line)
2256 ;;(insert " () {\n}")
2257 (cond
2258 (cperl-extra-newline-before-brace
2259 (insert (if do "\n" " ()\n"))
2260 (insert "{")
2261 (cperl-indent-line)
2262 (insert "\n")
2263 (cperl-indent-line)
2264 (insert "\n}")
2265 (and do (insert " while ();")))
2266 (t
2267 (insert (if do " {\n} while ();" " () {\n}"))))
2268 (or (looking-at "[ \t]\\|$") (insert " "))
2269 (cperl-indent-line)
2270 (if dollar (progn (search-backward "$")
2271 (if my
2272 (forward-char 1)
2273 (delete-char 1)))
2274 (search-backward ")")
2275 (if (eq last-command-event ?\()
2276 (progn ; Avoid "if (())"
2277 (delete-backward-char 1)
2278 (delete-backward-char -1))))
2279 (if delete
2280 (cperl-putback-char cperl-del-back-ch))
2281 (if cperl-message-electric-keyword
2282 (message "Precede char by C-q to avoid expansion"))))))
2283
2284 (defun cperl-ensure-newlines (n &optional pos)
2285 "Make sure there are N newlines after the point."
2286 (or pos (setq pos (point)))
2287 (if (looking-at "\n")
2288 (forward-char 1)
2289 (insert "\n"))
2290 (if (> n 1)
2291 (cperl-ensure-newlines (1- n) pos)
2292 (goto-char pos)))
2293
2294 (defun cperl-electric-pod ()
2295 "Insert a POD chunk appropriate after a =POD directive."
2296 (let ((delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
2297 (memq this-command '(self-insert-command newline))))
2298 head1 notlast name p really-delete over)
2299 (and (save-excursion
2300 (forward-word -1)
2301 (and
2302 (eq (preceding-char) ?=)
2303 (progn
2304 (setq head1 (looking-at "head1\\>[ \t]*$"))
2305 (setq over (and (looking-at "over\\>[ \t]*$")
2306 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
2307 (forward-char -1)
2308 (bolp))
2309 (or
2310 (get-text-property (point) 'in-pod)
2311 (cperl-after-expr-p nil "{;:")
2312 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
2313 (not (looking-at "\n*=cut"))
2314 (or (not cperl-use-syntax-table-text-property)
2315 (eq (get-text-property (point) 'syntax-type) 'pod))))))
2316 (progn
2317 (save-excursion
2318 (setq notlast (re-search-forward "^\n=" nil t)))
2319 (or notlast
2320 (progn
2321 (insert "\n\n=cut")
2322 (cperl-ensure-newlines 2)
2323 (forward-word -2)
2324 (if (and head1
2325 (not
2326 (save-excursion
2327 (forward-char -1)
2328 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
2329 nil t)))) ; Only one
2330 (progn
2331 (forward-word 1)
2332 (setq name (file-name-sans-extension
2333 (file-name-nondirectory (buffer-file-name)))
2334 p (point))
2335 (insert " NAME\n\n" name
2336 " - \n\n=head1 SYNOPSIS\n\n\n\n"
2337 "=head1 DESCRIPTION")
2338 (cperl-ensure-newlines 4)
2339 (goto-char p)
2340 (forward-word 2)
2341 (end-of-line)
2342 (setq really-delete t))
2343 (forward-word 1))))
2344 (if over
2345 (progn
2346 (setq p (point))
2347 (insert "\n\n=item \n\n\n\n"
2348 "=back")
2349 (cperl-ensure-newlines 2)
2350 (goto-char p)
2351 (forward-word 1)
2352 (end-of-line)
2353 (setq really-delete t)))
2354 (if (and delete really-delete)
2355 (cperl-putback-char cperl-del-back-ch))))))
2356
2357 (defun cperl-electric-else ()
2358 "Insert a construction appropriate after a keyword.
2359 Help message may be switched off by setting `cperl-message-electric-keyword'
2360 to nil."
2361 (let ((beg (point-at-bol)))
2362 (and (save-excursion
2363 (backward-sexp 1)
2364 (cperl-after-expr-p nil "{;:"))
2365 (save-excursion
2366 (not
2367 (re-search-backward
2368 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2369 beg t)))
2370 (save-excursion (or (not (re-search-backward "^=" nil t))
2371 (looking-at "=cut")
2372 (and cperl-use-syntax-table-text-property
2373 (not (eq (get-text-property (point)
2374 'syntax-type)
2375 'pod)))))
2376 (progn
2377 (cperl-indent-line)
2378 ;;(insert " {\n\n}")
2379 (cond
2380 (cperl-extra-newline-before-brace
2381 (insert "\n")
2382 (insert "{")
2383 (cperl-indent-line)
2384 (insert "\n\n}"))
2385 (t
2386 (insert " {\n\n}")))
2387 (or (looking-at "[ \t]\\|$") (insert " "))
2388 (cperl-indent-line)
2389 (forward-line -1)
2390 (cperl-indent-line)
2391 (cperl-putback-char cperl-del-back-ch)
2392 (setq this-command 'cperl-electric-else)
2393 (if cperl-message-electric-keyword
2394 (message "Precede char by C-q to avoid expansion"))))))
2395
2396 (defun cperl-linefeed ()
2397 "Go to end of line, open a new line and indent appropriately.
2398 If in POD, insert appropriate lines."
2399 (interactive)
2400 (let ((beg (point-at-bol))
2401 (end (point-at-eol))
2402 (pos (point)) start over cut res)
2403 (if (and ; Check if we need to split:
2404 ; i.e., on a boundary and inside "{...}"
2405 (save-excursion (cperl-to-comment-or-eol)
2406 (>= (point) pos)) ; Not in a comment
2407 (or (save-excursion
2408 (skip-chars-backward " \t" beg)
2409 (forward-char -1)
2410 (looking-at "[;{]")) ; After { or ; + spaces
2411 (looking-at "[ \t]*}") ; Before }
2412 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2413 (save-excursion
2414 (and
2415 (eq (car (parse-partial-sexp pos end -1)) -1)
2416 ; Leave the level of parens
2417 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2418 ; Are at end
2419 (cperl-after-block-p (point-min))
2420 (progn
2421 (backward-sexp 1)
2422 (setq start (point-marker))
2423 (<= start pos))))) ; Redundant? Are after the
2424 ; start of parens group.
2425 (progn
2426 (skip-chars-backward " \t")
2427 (or (memq (preceding-char) (append ";{" nil))
2428 (insert ";"))
2429 (insert "\n")
2430 (forward-line -1)
2431 (cperl-indent-line)
2432 (goto-char start)
2433 (or (looking-at "{[ \t]*$") ; If there is a statement
2434 ; before, move it to separate line
2435 (progn
2436 (forward-char 1)
2437 (insert "\n")
2438 (cperl-indent-line)))
2439 (forward-line 1) ; We are on the target line
2440 (cperl-indent-line)
2441 (beginning-of-line)
2442 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2443 ; after, move it to separate line
2444 (progn
2445 (end-of-line)
2446 (search-backward "}" beg)
2447 (skip-chars-backward " \t")
2448 (or (memq (preceding-char) (append ";{" nil))
2449 (insert ";"))
2450 (insert "\n")
2451 (cperl-indent-line)
2452 (forward-line -1)))
2453 (forward-line -1) ; We are on the line before target
2454 (end-of-line)
2455 (newline-and-indent))
2456 (end-of-line) ; else - no splitting
2457 (cond
2458 ((and (looking-at "\n[ \t]*{$")
2459 (save-excursion
2460 (skip-chars-backward " \t")
2461 (eq (preceding-char) ?\)))) ; Probably if () {} group
2462 ; with an extra newline.
2463 (forward-line 2)
2464 (cperl-indent-line))
2465 ((save-excursion ; In POD header
2466 (forward-paragraph -1)
2467 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2468 ;; We are after \n now, so look for the rest
2469 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2470 (progn
2471 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2472 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2473 t)))
2474 (if (and over
2475 (progn
2476 (forward-paragraph -1)
2477 (forward-word 1)
2478 (setq pos (point))
2479 (setq cut (buffer-substring (point) (point-at-eol)))
2480 (delete-char (- (point-at-eol) (point)))
2481 (setq res (expand-abbrev))
2482 (save-excursion
2483 (goto-char pos)
2484 (insert cut))
2485 res))
2486 nil
2487 (cperl-ensure-newlines (if cut 2 4))
2488 (forward-line 2)))
2489 ((get-text-property (point) 'in-pod) ; In POD section
2490 (cperl-ensure-newlines 4)
2491 (forward-line 2))
2492 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2493 (forward-line 1)
2494 (cperl-indent-line))
2495 (t
2496 (newline-and-indent))))))
2497
2498 (defun cperl-electric-semi (arg)
2499 "Insert character and correct line's indentation."
2500 (interactive "P")
2501 (if cperl-auto-newline
2502 (cperl-electric-terminator arg)
2503 (self-insert-command (prefix-numeric-value arg))
2504 (if cperl-autoindent-on-semi
2505 (cperl-indent-line))))
2506
2507 (defun cperl-electric-terminator (arg)
2508 "Insert character and correct line's indentation."
2509 (interactive "P")
2510 (let ((end (point))
2511 (auto (and cperl-auto-newline
2512 (or (not (eq last-command-event ?:))
2513 cperl-auto-newline-after-colon)))
2514 insertpos)
2515 (if (and ;;(not arg)
2516 (eolp)
2517 (not (save-excursion
2518 (beginning-of-line)
2519 (skip-chars-forward " \t")
2520 (or
2521 ;; Ignore in comment lines
2522 (= (following-char) ?#)
2523 ;; Colon is special only after a label
2524 ;; So quickly rule out most other uses of colon
2525 ;; and do no indentation for them.
2526 (and (eq last-command-event ?:)
2527 (save-excursion
2528 (forward-word 1)
2529 (skip-chars-forward " \t")
2530 (and (< (point) end)
2531 (progn (goto-char (- end 1))
2532 (not (looking-at ":"))))))
2533 (progn
2534 (beginning-of-defun)
2535 (let ((pps (parse-partial-sexp (point) end)))
2536 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2537 (progn
2538 (self-insert-command (prefix-numeric-value arg))
2539 ;;(forward-char -1)
2540 (if auto (setq insertpos (point-marker)))
2541 ;;(forward-char 1)
2542 (cperl-indent-line)
2543 (if auto
2544 (progn
2545 (newline)
2546 (cperl-indent-line)))
2547 (save-excursion
2548 (if insertpos (goto-char (1- (marker-position insertpos)))
2549 (forward-char -1))
2550 (delete-char 1))))
2551 (if insertpos
2552 (save-excursion
2553 (goto-char insertpos)
2554 (self-insert-command (prefix-numeric-value arg)))
2555 (self-insert-command (prefix-numeric-value arg)))))
2556
2557 (defun cperl-electric-backspace (arg)
2558 "Backspace, or remove whitespace around the point inserted by an electric key.
2559 Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2560 (interactive "p")
2561 (if (and cperl-auto-newline
2562 (memq last-command '(cperl-electric-semi
2563 cperl-electric-terminator
2564 cperl-electric-lbrace))
2565 (memq (preceding-char) '(?\s ?\t ?\n)))
2566 (let (p)
2567 (if (eq last-command 'cperl-electric-lbrace)
2568 (skip-chars-forward " \t\n"))
2569 (setq p (point))
2570 (skip-chars-backward " \t\n")
2571 (delete-region (point) p))
2572 (and (eq last-command 'cperl-electric-else)
2573 ;; We are removing the whitespace *inside* cperl-electric-else
2574 (setq this-command 'cperl-electric-else-really))
2575 (if (and cperl-auto-newline
2576 (eq last-command 'cperl-electric-else-really)
2577 (memq (preceding-char) '(?\s ?\t ?\n)))
2578 (let (p)
2579 (skip-chars-forward " \t\n")
2580 (setq p (point))
2581 (skip-chars-backward " \t\n")
2582 (delete-region (point) p))
2583 (if cperl-electric-backspace-untabify
2584 (backward-delete-char-untabify arg)
2585 (delete-backward-char arg)))))
2586
2587 (put 'cperl-electric-backspace 'delete-selection 'supersede)
2588
2589 (defun cperl-inside-parens-p () ;; NOT USED????
2590 (condition-case ()
2591 (save-excursion
2592 (save-restriction
2593 (narrow-to-region (point)
2594 (progn (beginning-of-defun) (point)))
2595 (goto-char (point-max))
2596 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2597 (error nil)))
2598 \f
2599 (defun cperl-indent-command (&optional whole-exp)
2600 "Indent current line as Perl code, or in some cases insert a tab character.
2601 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2602 line. Otherwise, indent the current line only if point is at the left margin
2603 or in the line's indentation; otherwise insert a tab.
2604
2605 A numeric argument, regardless of its value,
2606 means indent rigidly all the lines of the expression starting after point
2607 so that this line becomes properly indented.
2608 The relative indentation among the lines of the expression are preserved."
2609 (interactive "P")
2610 (cperl-update-syntaxification (point) (point))
2611 (if whole-exp
2612 ;; If arg, always indent this line as Perl
2613 ;; and shift remaining lines of expression the same amount.
2614 (let ((shift-amt (cperl-indent-line))
2615 beg end)
2616 (save-excursion
2617 (if cperl-tab-always-indent
2618 (beginning-of-line))
2619 (setq beg (point))
2620 (forward-sexp 1)
2621 (setq end (point))
2622 (goto-char beg)
2623 (forward-line 1)
2624 (setq beg (point)))
2625 (if (and shift-amt (> end beg))
2626 (indent-code-rigidly beg end shift-amt "#")))
2627 (if (and (not cperl-tab-always-indent)
2628 (save-excursion
2629 (skip-chars-backward " \t")
2630 (not (bolp))))
2631 (insert-tab)
2632 (cperl-indent-line))))
2633
2634 (defun cperl-indent-line (&optional parse-data)
2635 "Indent current line as Perl code.
2636 Return the amount the indentation changed by."
2637 (let ((case-fold-search nil)
2638 (pos (- (point-max) (point)))
2639 indent i beg shift-amt)
2640 (setq indent (cperl-calculate-indent parse-data)
2641 i indent)
2642 (beginning-of-line)
2643 (setq beg (point))
2644 (cond ((or (eq indent nil) (eq indent t))
2645 (setq indent (current-indentation) i nil))
2646 ;;((eq indent t) ; Never?
2647 ;; (setq indent (cperl-calculate-indent-within-comment)))
2648 ;;((looking-at "[ \t]*#")
2649 ;; (setq indent 0))
2650 (t
2651 (skip-chars-forward " \t")
2652 (if (listp indent) (setq indent (car indent)))
2653 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2654 (not (looking-at "[smy]:\\|tr:")))
2655 (and (> indent 0)
2656 (setq indent (max cperl-min-label-indent
2657 (+ indent cperl-label-offset)))))
2658 ((= (following-char) ?})
2659 (setq indent (- indent cperl-indent-level)))
2660 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2661 (setq indent (+ indent cperl-close-paren-offset)))
2662 ((= (following-char) ?{)
2663 (setq indent (+ indent cperl-brace-offset))))))
2664 (skip-chars-forward " \t")
2665 (setq shift-amt (and i (- indent (current-column))))
2666 (if (or (not shift-amt)
2667 (zerop shift-amt))
2668 (if (> (- (point-max) pos) (point))
2669 (goto-char (- (point-max) pos)))
2670 ;;;(delete-region beg (point))
2671 ;;;(indent-to indent)
2672 (cperl-make-indent indent)
2673 ;; If initial point was within line's indentation,
2674 ;; position after the indentation. Else stay at same point in text.
2675 (if (> (- (point-max) pos) (point))
2676 (goto-char (- (point-max) pos))))
2677 shift-amt))
2678
2679 (defun cperl-after-label ()
2680 ;; Returns true if the point is after label. Does not do save-excursion.
2681 (and (eq (preceding-char) ?:)
2682 (memq (char-syntax (char-after (- (point) 2)))
2683 '(?w ?_))
2684 (progn
2685 (backward-sexp)
2686 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2687
2688 (defun cperl-get-state (&optional parse-start start-state)
2689 ;; returns list (START STATE DEPTH PRESTART),
2690 ;; START is a good place to start parsing, or equal to
2691 ;; PARSE-START if preset,
2692 ;; STATE is what is returned by `parse-partial-sexp'.
2693 ;; DEPTH is true is we are immediately after end of block
2694 ;; which contains START.
2695 ;; PRESTART is the position basing on which START was found.
2696 (save-excursion
2697 (let ((start-point (point)) depth state start prestart)
2698 (if (and parse-start
2699 (<= parse-start start-point))
2700 (goto-char parse-start)
2701 (beginning-of-defun)
2702 (setq start-state nil))
2703 (setq prestart (point))
2704 (if start-state nil
2705 ;; Try to go out, if sub is not on the outermost level
2706 (while (< (point) start-point)
2707 (setq start (point) parse-start start depth nil
2708 state (parse-partial-sexp start start-point -1))
2709 (if (> (car state) -1) nil
2710 ;; The current line could start like }}}, so the indentation
2711 ;; corresponds to a different level than what we reached
2712 (setq depth t)
2713 (beginning-of-line 2))) ; Go to the next line.
2714 (if start (goto-char start))) ; Not at the start of file
2715 (setq start (point))
2716 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2717 (list start state depth prestart))))
2718
2719 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2720
2721 (defun cperl-beginning-of-property (p prop &optional lim)
2722 "Given that P has a property PROP, find where the property starts.
2723 Will not look before LIM."
2724 ;;; XXXX What to do at point-max???
2725 (or (previous-single-property-change (cperl-1+ p) prop lim)
2726 (point-min))
2727 ;;; (cond ((eq p (point-min))
2728 ;;; p)
2729 ;;; ((and lim (<= p lim))
2730 ;;; p)
2731 ;;; ((not (get-text-property (1- p) prop))
2732 ;;; p)
2733 ;;; (t (or (previous-single-property-change p look-prop lim)
2734 ;;; (point-min))))
2735 )
2736
2737 (defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
2738 ;; the sniffer logic to understand what the current line MEANS.
2739 (cperl-update-syntaxification (point) (point))
2740 (let ((res (get-text-property (point) 'syntax-type)))
2741 (save-excursion
2742 (cond
2743 ((and (memq res '(pod here-doc here-doc-delim format))
2744 (not (get-text-property (point) 'indentable)))
2745 (vector res))
2746 ;; before start of POD - whitespace found since do not have 'pod!
2747 ((looking-at "[ \t]*\n=")
2748 (error "Spaces before POD section!"))
2749 ((and (not cperl-indent-left-aligned-comments)
2750 (looking-at "^#"))
2751 [comment-special:at-beginning-of-line])
2752 ((get-text-property (point) 'in-pod)
2753 [in-pod])
2754 (t
2755 (beginning-of-line)
2756 (let* ((indent-point (point))
2757 (char-after-pos (save-excursion
2758 (skip-chars-forward " \t")
2759 (point)))
2760 (char-after (char-after char-after-pos))
2761 (pre-indent-point (point))
2762 p prop look-prop is-block delim)
2763 (save-excursion ; Know we are not in POD, find appropriate pos before
2764 (cperl-backward-to-noncomment nil)
2765 (setq p (max (point-min) (1- (point)))
2766 prop (get-text-property p 'syntax-type)
2767 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2768 'syntax-type))
2769 (if (memq prop '(pod here-doc format here-doc-delim))
2770 (progn
2771 (goto-char (cperl-beginning-of-property p look-prop))
2772 (beginning-of-line)
2773 (setq pre-indent-point (point)))))
2774 (goto-char pre-indent-point) ; Orig line skipping preceeding pod/etc
2775 (let* ((case-fold-search nil)
2776 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2777 (start (or (nth 2 parse-data) ; last complete sexp terminated
2778 (nth 0 s-s))) ; Good place to start parsing
2779 (state (nth 1 s-s))
2780 (containing-sexp (car (cdr state)))
2781 old-indent)
2782 (if (and
2783 ;;containing-sexp ;; We are buggy at toplevel :-(
2784 parse-data)
2785 (progn
2786 (setcar parse-data pre-indent-point)
2787 (setcar (cdr parse-data) state)
2788 (or (nth 2 parse-data)
2789 (setcar (cddr parse-data) start))
2790 ;; Before this point: end of statement
2791 (setq old-indent (nth 3 parse-data))))
2792 (cond ((get-text-property (point) 'indentable)
2793 ;; indent to "after" the surrounding open
2794 ;; (same offset as `cperl-beautify-regexp-piece'),
2795 ;; skip blanks if we do not close the expression.
2796 (setq delim ; We do not close the expression
2797 (get-text-property
2798 (cperl-1+ char-after-pos) 'indentable)
2799 p (1+ (cperl-beginning-of-property
2800 (point) 'indentable))
2801 is-block ; misused for: preceeding line in REx
2802 (save-excursion ; Find preceeding line
2803 (cperl-backward-to-noncomment p)
2804 (beginning-of-line)
2805 (if (<= (point) p)
2806 (progn ; get indent from the first line
2807 (goto-char p)
2808 (skip-chars-forward " \t")
2809 (if (memq (char-after (point))
2810 (append "#\n" nil))
2811 nil ; Can't use intentation of this line...
2812 (point)))
2813 (skip-chars-forward " \t")
2814 (point)))
2815 prop (parse-partial-sexp p char-after-pos))
2816 (cond ((not delim) ; End the REx, ignore is-block
2817 (vector 'indentable 'terminator p is-block))
2818 (is-block ; Indent w.r.t. preceeding line
2819 (vector 'indentable 'cont-line char-after-pos
2820 is-block char-after p))
2821 (t ; No preceeding line...
2822 (vector 'indentable 'first-line p))))
2823 ((get-text-property char-after-pos 'REx-part2)
2824 (vector 'REx-part2 (point)))
2825 ((nth 4 state)
2826 [comment])
2827 ((nth 3 state)
2828 [string])
2829 ;; XXXX Do we need to special-case this?
2830 ((null containing-sexp)
2831 ;; Line is at top level. May be data or function definition,
2832 ;; or may be function argument declaration.
2833 ;; Indent like the previous top level line
2834 ;; unless that ends in a closeparen without semicolon,
2835 ;; in which case this line is the first argument decl.
2836 (skip-chars-forward " \t")
2837 (cperl-backward-to-noncomment (or old-indent (point-min)))
2838 (setq state
2839 (or (bobp)
2840 (eq (point) old-indent) ; old-indent was at comment
2841 (eq (preceding-char) ?\;)
2842 ;; Had ?\) too
2843 (and (eq (preceding-char) ?\})
2844 (cperl-after-block-and-statement-beg
2845 (point-min))) ; Was start - too close
2846 (memq char-after (append ")]}" nil))
2847 (and (eq (preceding-char) ?\:) ; label
2848 (progn
2849 (forward-sexp -1)
2850 (skip-chars-backward " \t")
2851 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2852 (get-text-property (point) 'first-format-line)))
2853
2854 ;; Look at previous line that's at column 0
2855 ;; to determine whether we are in top-level decls
2856 ;; or function's arg decls. Set basic-indent accordingly.
2857 ;; Now add a little if this is a continuation line.
2858 (and state
2859 parse-data
2860 (not (eq char-after ?\C-j))
2861 (setcdr (cddr parse-data)
2862 (list pre-indent-point)))
2863 (vector 'toplevel start char-after state (nth 2 s-s)))
2864 ((not
2865 (or (setq is-block
2866 (and (setq delim (= (char-after containing-sexp) ?{))
2867 (save-excursion ; Is it a hash?
2868 (goto-char containing-sexp)
2869 (cperl-block-p))))
2870 cperl-indent-parens-as-block))
2871 ;; group is an expression, not a block:
2872 ;; indent to just after the surrounding open parens,
2873 ;; skip blanks if we do not close the expression.
2874 (goto-char (1+ containing-sexp))
2875 (or (memq char-after
2876 (append (if delim "}" ")]}") nil))
2877 (looking-at "[ \t]*\\(#\\|$\\)")
2878 (skip-chars-forward " \t"))
2879 (setq old-indent (point)) ; delim=is-brace
2880 (vector 'in-parens char-after (point) delim containing-sexp))
2881 (t
2882 ;; Statement level. Is it a continuation or a new statement?
2883 ;; Find previous non-comment character.
2884 (goto-char pre-indent-point) ; Skip one level of POD/etc
2885 (cperl-backward-to-noncomment containing-sexp)
2886 ;; Back up over label lines, since they don't
2887 ;; affect whether our line is a continuation.
2888 ;; (Had \, too)
2889 (while;;(or (eq (preceding-char) ?\,)
2890 (and (eq (preceding-char) ?:)
2891 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2892 (memq (char-syntax (char-after (- (point) 2)))
2893 '(?w ?_))))
2894 ;;)
2895 ;; This is always FALSE?
2896 (if (eq (preceding-char) ?\,)
2897 ;; Will go to beginning of line, essentially.
2898 ;; Will ignore embedded sexpr XXXX.
2899 (cperl-backward-to-start-of-continued-exp containing-sexp))
2900 (beginning-of-line)
2901 (cperl-backward-to-noncomment containing-sexp))
2902 ;; Now we get non-label preceeding the indent point
2903 (if (not (or (eq (1- (point)) containing-sexp)
2904 (memq (preceding-char)
2905 (append (if is-block " ;{" " ,;{") '(nil)))
2906 (and (eq (preceding-char) ?\})
2907 (cperl-after-block-and-statement-beg
2908 containing-sexp))
2909 (get-text-property (point) 'first-format-line)))
2910 ;; This line is continuation of preceding line's statement;
2911 ;; indent `cperl-continued-statement-offset' more than the
2912 ;; previous line of the statement.
2913 ;;
2914 ;; There might be a label on this line, just
2915 ;; consider it bad style and ignore it.
2916 (progn
2917 (cperl-backward-to-start-of-continued-exp containing-sexp)
2918 (vector 'continuation (point) char-after is-block delim))
2919 ;; This line starts a new statement.
2920 ;; Position following last unclosed open brace
2921 (goto-char containing-sexp)
2922 ;; Is line first statement after an open-brace?
2923 (or
2924 ;; If no, find that first statement and indent like
2925 ;; it. If the first statement begins with label, do
2926 ;; not believe when the indentation of the label is too
2927 ;; small.
2928 (save-excursion
2929 (forward-char 1)
2930 (let ((colon-line-end 0))
2931 (while
2932 (progn (skip-chars-forward " \t\n")
2933 ;; s: foo : bar :x is NOT label
2934 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2935 (not (looking-at "[sym]:\\|tr:"))))
2936 ;; Skip over comments and labels following openbrace.
2937 (cond ((= (following-char) ?\#)
2938 (forward-line 1))
2939 ((= (following-char) ?\=)
2940 (goto-char
2941 (or (next-single-property-change (point) 'in-pod)
2942 (point-max)))) ; do not loop if no syntaxification
2943 ;; label:
2944 (t
2945 (setq colon-line-end (point-at-eol))
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 (point-at-eol)) 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 (point-at-eol)
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 preceeding } (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 preceeds 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 (point-at-eol)) 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 (setq tmp-end (point-at-eol)))
5044 (setq done t))))
5045 (setq tmp-end (point-at-eol)))
5046 (goto-char tmp-end)
5047 (setq tmp-end (point-marker)))
5048 (if cperl-indent-region-fix-constructs
5049 (cperl-fix-line-spacing tmp-end))
5050 (cperl-indent-region (point) tmp-end))))
5051
5052 (defun cperl-fix-line-spacing (&optional end parse-data)
5053 "Improve whitespace in a conditional/loop construct.
5054 Returns some position at the last line."
5055 (interactive)
5056 (or end
5057 (setq end (point-max)))
5058 (let ((ee (point-at-eol))
5059 (cperl-indent-region-fix-constructs
5060 (or cperl-indent-region-fix-constructs 1))
5061 p pp ml have-brace ret)
5062 (save-excursion
5063 (beginning-of-line)
5064 (setq ret (point))
5065 ;; }? continue
5066 ;; blah; }
5067 (if (not
5068 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5069 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5070 nil ; Do not need to do anything
5071 ;; Looking at:
5072 ;; }
5073 ;; else
5074 (if cperl-merge-trailing-else
5075 (if (looking-at
5076 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5077 (progn
5078 (search-forward "}")
5079 (setq p (point))
5080 (skip-chars-forward " \t\n")
5081 (delete-region p (point))
5082 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5083 (beginning-of-line)))
5084 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5085 (save-excursion
5086 (search-forward "}")
5087 (delete-horizontal-space)
5088 (insert "\n")
5089 (setq ret (point))
5090 (if (cperl-indent-line parse-data)
5091 (progn
5092 (cperl-fix-line-spacing end parse-data)
5093 (setq ret (point)))))))
5094 ;; Looking at:
5095 ;; } else
5096 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5097 (progn
5098 (search-forward "}")
5099 (delete-horizontal-space)
5100 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5101 (beginning-of-line)))
5102 ;; Looking at:
5103 ;; else {
5104 (if (looking-at
5105 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5106 (progn
5107 (forward-word 1)
5108 (delete-horizontal-space)
5109 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5110 (beginning-of-line)))
5111 ;; Looking at:
5112 ;; foreach my $var
5113 (if (looking-at
5114 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5115 (progn
5116 (forward-word 2)
5117 (delete-horizontal-space)
5118 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5119 (beginning-of-line)))
5120 ;; Looking at:
5121 ;; foreach my $var (
5122 (if (looking-at
5123 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5124 (progn
5125 (forward-sexp 3)
5126 (delete-horizontal-space)
5127 (insert
5128 (make-string cperl-indent-region-fix-constructs ?\s))
5129 (beginning-of-line)))
5130 ;; Looking at (with or without "}" at start, ending after "({"):
5131 ;; } foreach my $var () OR {
5132 (if (looking-at
5133 "[ \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]*{")
5134 (progn
5135 (setq ml (match-beginning 8)) ; "(" or "{" after control word
5136 (re-search-forward "[({]")
5137 (forward-char -1)
5138 (setq p (point))
5139 (if (eq (following-char) ?\( )
5140 (progn
5141 (forward-sexp 1)
5142 (setq pp (point))) ; past parenth-group
5143 ;; after `else' or nothing
5144 (if ml ; after `else'
5145 (skip-chars-backward " \t\n")
5146 (beginning-of-line))
5147 (setq pp nil))
5148 ;; Now after the sexp before the brace
5149 ;; Multiline expr should be special
5150 (setq ml (and pp (save-excursion (goto-char p)
5151 (search-forward "\n" pp t))))
5152 (if (and (or (not pp) (< pp end)) ; Do not go too far...
5153 (looking-at "[ \t\n]*{"))
5154 (progn
5155 (cond
5156 ((bolp) ; Were before `{', no if/else/etc
5157 nil)
5158 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
5159 (delete-horizontal-space)
5160 (if (if ml
5161 cperl-extra-newline-before-brace-multiline
5162 cperl-extra-newline-before-brace)
5163 (progn
5164 (delete-horizontal-space)
5165 (insert "\n")
5166 (setq ret (point))
5167 (if (cperl-indent-line parse-data)
5168 (progn
5169 (cperl-fix-line-spacing end parse-data)
5170 (setq ret (point)))))
5171 (insert
5172 (make-string cperl-indent-region-fix-constructs ?\s))))
5173 ((and (looking-at "[ \t]*\n")
5174 (not (if ml
5175 cperl-extra-newline-before-brace-multiline
5176 cperl-extra-newline-before-brace)))
5177 (setq pp (point))
5178 (skip-chars-forward " \t\n")
5179 (delete-region pp (point))
5180 (insert
5181 (make-string cperl-indent-region-fix-constructs ?\ )))
5182 ((and (looking-at "[\t ]*{")
5183 (if ml cperl-extra-newline-before-brace-multiline
5184 cperl-extra-newline-before-brace))
5185 (delete-horizontal-space)
5186 (insert "\n")
5187 (setq ret (point))
5188 (if (cperl-indent-line parse-data)
5189 (progn
5190 (cperl-fix-line-spacing end parse-data)
5191 (setq ret (point))))))
5192 ;; Now we are before `{'
5193 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5194 (progn
5195 (skip-chars-forward " \t\n")
5196 (setq pp (point))
5197 (forward-sexp 1)
5198 (setq p (point))
5199 (goto-char pp)
5200 (setq ml (search-forward "\n" p t))
5201 (if (or cperl-break-one-line-blocks-when-indent ml)
5202 ;; not good: multi-line BLOCK
5203 (progn
5204 (goto-char (1+ pp))
5205 (delete-horizontal-space)
5206 (insert "\n")
5207 (setq ret (point))
5208 (if (cperl-indent-line parse-data)
5209 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5210 (beginning-of-line)
5211 (setq p (point) pp (point-at-eol)) ; May be different from ee.
5212 ;; Now check whether there is a hanging `}'
5213 ;; Looking at:
5214 ;; } blah
5215 (if (and
5216 cperl-fix-hanging-brace-when-indent
5217 have-brace
5218 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5219 (condition-case nil
5220 (progn
5221 (up-list 1)
5222 (if (and (<= (point) pp)
5223 (eq (preceding-char) ?\} )
5224 (cperl-after-block-and-statement-beg (point-min)))
5225 t
5226 (goto-char p)
5227 nil))
5228 (error nil)))
5229 (progn
5230 (forward-char -1)
5231 (skip-chars-backward " \t")
5232 (if (bolp)
5233 ;; `}' was the first thing on the line, insert NL *after* it.
5234 (progn
5235 (cperl-indent-line parse-data)
5236 (search-forward "}")
5237 (delete-horizontal-space)
5238 (insert "\n"))
5239 (delete-horizontal-space)
5240 (or (eq (preceding-char) ?\;)
5241 (bolp)
5242 (and (eq (preceding-char) ?\} )
5243 (cperl-after-block-p (point-min)))
5244 (insert ";"))
5245 (insert "\n")
5246 (setq ret (point)))
5247 (if (cperl-indent-line parse-data)
5248 (setq ret (cperl-fix-line-spacing end parse-data)))
5249 (beginning-of-line)))))
5250 ret))
5251
5252 (defvar cperl-update-start) ; Do not need to make them local
5253 (defvar cperl-update-end)
5254 (defun cperl-delay-update-hook (beg end old-len)
5255 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5256 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
5257
5258 (defun cperl-indent-region (start end)
5259 "Simple variant of indentation of region in CPerl mode.
5260 Should be slow. Will not indent comment if it starts at `comment-indent'
5261 or looks like continuation of the comment on the previous line.
5262 Indents all the lines whose first character is between START and END
5263 inclusive.
5264
5265 If `cperl-indent-region-fix-constructs', will improve spacing on
5266 conditional/loop constructs."
5267 (interactive "r")
5268 (cperl-update-syntaxification end end)
5269 (save-excursion
5270 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
5271 (let ((indent-info (if cperl-emacs-can-parse
5272 (list nil nil nil) ; Cannot use '(), since will modify
5273 nil))
5274 (pm 0)
5275 after-change-functions ; Speed it up!
5276 st comm old-comm-indent new-comm-indent p pp i empty)
5277 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
5278 (goto-char start)
5279 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5280 (current-column))
5281 new-comm-indent old-comm-indent)
5282 (goto-char start)
5283 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5284 (or (bolp) (beginning-of-line 2))
5285 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5286 (setq st (point))
5287 (if (or
5288 (setq empty (looking-at "[ \t]*\n"))
5289 (and (setq comm (looking-at "[ \t]*#"))
5290 (or (eq (current-indentation) (or old-comm-indent
5291 comment-column))
5292 (setq old-comm-indent nil))))
5293 (if (and old-comm-indent
5294 (not empty)
5295 (= (current-indentation) old-comm-indent)
5296 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5297 (not (eq (get-text-property (point) 'syntax-table)
5298 cperl-st-cfence)))
5299 (let ((comment-column new-comm-indent))
5300 (indent-for-comment)))
5301 (progn
5302 (setq i (cperl-indent-line indent-info))
5303 (or comm
5304 (not i)
5305 (progn
5306 (if cperl-indent-region-fix-constructs
5307 (goto-char (cperl-fix-line-spacing end indent-info)))
5308 (if (setq old-comm-indent
5309 (and (cperl-to-comment-or-eol)
5310 (not (memq (get-text-property (point)
5311 'syntax-type)
5312 '(pod here-doc)))
5313 (not (eq (get-text-property (point)
5314 'syntax-table)
5315 cperl-st-cfence))
5316 (current-column)))
5317 (progn (indent-for-comment)
5318 (skip-chars-backward " \t")
5319 (skip-chars-backward "#")
5320 (setq new-comm-indent (current-column))))))))
5321 (beginning-of-line 2)))
5322 ;; Now run the update hooks
5323 (and after-change-functions
5324 cperl-update-end
5325 (save-excursion
5326 (goto-char cperl-update-end)
5327 (insert " ")
5328 (delete-char -1)
5329 (goto-char cperl-update-start)
5330 (insert " ")
5331 (delete-char -1))))))
5332
5333 ;; Stolen from lisp-mode with a lot of improvements
5334
5335 (defun cperl-fill-paragraph (&optional justify iteration)
5336 "Like `fill-paragraph', but handle CPerl comments.
5337 If any of the current line is a comment, fill the comment or the
5338 block of it that point is in, preserving the comment's initial
5339 indentation and initial hashes. Behaves usually outside of comment."
5340 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
5341 (let (;; Non-nil if the current line contains a comment.
5342 has-comment
5343 fill-paragraph-function ; do not recurse
5344 ;; If has-comment, the appropriate fill-prefix for the comment.
5345 comment-fill-prefix
5346 ;; Line that contains code and comment (or nil)
5347 start
5348 c spaces len dc (comment-column comment-column))
5349 ;; Figure out what kind of comment we are looking at.
5350 (save-excursion
5351 (beginning-of-line)
5352 (cond
5353
5354 ;; A line with nothing but a comment on it?
5355 ((looking-at "[ \t]*#[# \t]*")
5356 (setq has-comment t
5357 comment-fill-prefix (buffer-substring (match-beginning 0)
5358 (match-end 0))))
5359
5360 ;; A line with some code, followed by a comment? Remember that the
5361 ;; semi which starts the comment shouldn't be part of a string or
5362 ;; character.
5363 ((cperl-to-comment-or-eol)
5364 (setq has-comment t)
5365 (looking-at "#+[ \t]*")
5366 (setq start (point) c (current-column)
5367 comment-fill-prefix
5368 (concat (make-string (current-column) ?\s)
5369 (buffer-substring (match-beginning 0) (match-end 0)))
5370 spaces (progn (skip-chars-backward " \t")
5371 (buffer-substring (point) start))
5372 dc (- c (current-column)) len (- start (point))
5373 start (point-marker))
5374 (delete-char len)
5375 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
5376 (if (not has-comment)
5377 (fill-paragraph justify) ; Do the usual thing outside of comment
5378 ;; Narrow to include only the comment, and then fill the region.
5379 (save-restriction
5380 (narrow-to-region
5381 ;; Find the first line we should include in the region to fill.
5382 (if start (progn (beginning-of-line) (point))
5383 (save-excursion
5384 (while (and (zerop (forward-line -1))
5385 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5386 ;; We may have gone to far. Go forward again.
5387 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5388 (forward-line 1))
5389 (point)))
5390 ;; Find the beginning of the first line past the region to fill.
5391 (save-excursion
5392 (while (progn (forward-line 1)
5393 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5394 (point)))
5395 ;; Remove existing hashes
5396 (goto-char (point-min))
5397 (save-excursion
5398 (while (progn (forward-line 1) (< (point) (point-max)))
5399 (skip-chars-forward " \t")
5400 (if (looking-at "#+")
5401 (progn
5402 (if (and (eq (point) (match-beginning 0))
5403 (not (eq (point) (match-end 0)))) nil
5404 (error
5405 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5406 (delete-char (- (match-end 0) (match-beginning 0)))))))
5407
5408 ;; Lines with only hashes on them can be paragraph boundaries.
5409 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5410 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5411 (fill-prefix comment-fill-prefix))
5412 (fill-paragraph justify)))
5413 (if (and start)
5414 (progn
5415 (goto-char start)
5416 (if (> dc 0)
5417 (progn (delete-char dc) (insert spaces)))
5418 (if (or (= (current-column) c) iteration) nil
5419 (setq comment-column c)
5420 (indent-for-comment)
5421 ;; Repeat once more, flagging as iteration
5422 (cperl-fill-paragraph justify t))))))
5423 t)
5424
5425 (defun cperl-do-auto-fill ()
5426 ;; Break out if the line is short enough
5427 (if (> (save-excursion
5428 (end-of-line)
5429 (current-column))
5430 fill-column)
5431 (let ((c (save-excursion (beginning-of-line)
5432 (cperl-to-comment-or-eol) (point)))
5433 (s (memq (following-char) '(?\s ?\t))) marker)
5434 (if (>= c (point))
5435 ;; Don't break line inside code: only inside comment.
5436 nil
5437 (setq marker (point-marker))
5438 (fill-paragraph nil)
5439 (goto-char marker)
5440 ;; Is not enough, sometimes marker is a start of line
5441 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5442 (goto-char (match-end 0))))
5443 ;; Following space could have gone:
5444 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
5445 (insert " ")
5446 (backward-char 1))
5447 ;; Previous space could have gone:
5448 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
5449
5450 (defun cperl-imenu-addback (lst &optional isback name)
5451 ;; We suppose that the lst is a DAG, unless the first element only
5452 ;; loops back, and ISBACK is set. Thus this function cannot be
5453 ;; applied twice without ISBACK set.
5454 (cond ((not cperl-imenu-addback) lst)
5455 (t
5456 (or name
5457 (setq name "+++BACK+++"))
5458 (mapc (lambda (elt)
5459 (if (and (listp elt) (listp (cdr elt)))
5460 (progn
5461 ;; In the other order it goes up
5462 ;; one level only ;-(
5463 (setcdr elt (cons (cons name lst)
5464 (cdr elt)))
5465 (cperl-imenu-addback (cdr elt) t name))))
5466 (if isback (cdr lst) lst))
5467 lst)))
5468
5469 (defun cperl-imenu--create-perl-index (&optional regexp)
5470 (require 'imenu) ; May be called from TAGS creator
5471 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
5472 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5473 (index-meth-alist '()) meth
5474 packages ends-ranges p marker is-proto
5475 (prev-pos 0) is-pack index index1 name (end-range 0) package)
5476 (goto-char (point-min))
5477 (cperl-update-syntaxification (point-max) (point-max))
5478 ;; Search for the function
5479 (progn ;;save-match-data
5480 (while (re-search-forward
5481 (or regexp cperl-imenu--function-name-regexp-perl)
5482 nil t)
5483 ;; 2=package-group, 5=package-name 8=sub-name
5484 (cond
5485 ((and ; Skip some noise if building tags
5486 (match-beginning 5) ; package name
5487 ;;(eq (char-after (match-beginning 2)) ?p) ; package
5488 (not (save-match-data
5489 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
5490 nil)
5491 ((and
5492 (or (match-beginning 2)
5493 (match-beginning 8)) ; package or sub
5494 ;; Skip if quoted (will not skip multi-line ''-strings :-():
5495 (null (get-text-property (match-beginning 1) 'syntax-table))
5496 (null (get-text-property (match-beginning 1) 'syntax-type))
5497 (null (get-text-property (match-beginning 1) 'in-pod)))
5498 (setq is-pack (match-beginning 2))
5499 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5500 ;; (goto-char (match-end 0))) ; Messes what follows
5501 (setq meth nil
5502 p (point))
5503 (while (and ends-ranges (>= p (car ends-ranges)))
5504 ;; delete obsolete entries
5505 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5506 (setq package (or (car packages) "")
5507 end-range (or (car ends-ranges) 0))
5508 (if is-pack ; doing "package"
5509 (progn
5510 (if (match-beginning 5) ; named package
5511 (setq name (buffer-substring (match-beginning 5)
5512 (match-end 5))
5513 name (progn
5514 (set-text-properties 0 (length name) nil name)
5515 name)
5516 package (concat name "::")
5517 name (concat "package " name))
5518 ;; Support nameless packages
5519 (setq name "package;" package ""))
5520 (setq end-range
5521 (save-excursion
5522 (parse-partial-sexp (point) (point-max) -1) (point))
5523 ends-ranges (cons end-range ends-ranges)
5524 packages (cons package packages)))
5525 (setq is-proto
5526 (or (eq (following-char) ?\;)
5527 (eq 0 (get-text-property (point) 'attrib-group)))))
5528 ;; Skip this function name if it is a prototype declaration.
5529 (if (and is-proto (not is-pack)) nil
5530 (or is-pack
5531 (setq name
5532 (buffer-substring (match-beginning 8) (match-end 8)))
5533 (set-text-properties 0 (length name) nil name))
5534 (setq marker (make-marker))
5535 (set-marker marker (match-end (if is-pack 2 8)))
5536 (cond (is-pack nil)
5537 ((string-match "[:']" name)
5538 (setq meth t))
5539 ((> p end-range) nil)
5540 (t
5541 (setq name (concat package name) meth t)))
5542 (setq index (cons name marker))
5543 (if is-pack
5544 (push index index-pack-alist)
5545 (push index index-alist))
5546 (if meth (push index index-meth-alist))
5547 (push index index-unsorted-alist)))
5548 ((match-beginning 16) ; POD section
5549 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5550 marker (make-marker))
5551 (set-marker marker (match-beginning 17))
5552 (set-text-properties 0 (length name) nil name)
5553 (setq name (concat (make-string
5554 (* 3 (- (char-after (match-beginning 16)) ?1))
5555 ?\ )
5556 name)
5557 index (cons name marker))
5558 (setq index1 (cons (concat "=" name) (cdr index)))
5559 (push index index-pod-alist)
5560 (push index1 index-unsorted-alist)))))
5561 (setq index-alist
5562 (if (default-value 'imenu-sort-function)
5563 (sort index-alist (default-value 'imenu-sort-function))
5564 (nreverse index-alist)))
5565 (and index-pod-alist
5566 (push (cons "+POD headers+..."
5567 (nreverse index-pod-alist))
5568 index-alist))
5569 (and (or index-pack-alist index-meth-alist)
5570 (let ((lst index-pack-alist) hier-list pack elt group name)
5571 ;; Remove "package ", reverse and uniquify.
5572 (while lst
5573 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5574 (if (assoc name hier-list) nil
5575 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5576 (setq lst index-meth-alist)
5577 (while lst
5578 (setq elt (car lst) lst (cdr lst))
5579 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5580 (setq pack (substring (car elt) 0 (match-beginning 0)))
5581 (if (setq group (assoc pack hier-list))
5582 (if (listp (cdr group))
5583 ;; Have some functions already
5584 (setcdr group
5585 (cons (cons (substring
5586 (car elt)
5587 (+ 2 (match-beginning 0)))
5588 (cdr elt))
5589 (cdr group)))
5590 (setcdr group (list (cons (substring
5591 (car elt)
5592 (+ 2 (match-beginning 0)))
5593 (cdr elt)))))
5594 (setq hier-list
5595 (cons (cons pack
5596 (list (cons (substring
5597 (car elt)
5598 (+ 2 (match-beginning 0)))
5599 (cdr elt))))
5600 hier-list))))))
5601 (push (cons "+Hierarchy+..."
5602 hier-list)
5603 index-alist)))
5604 (and index-pack-alist
5605 (push (cons "+Packages+..."
5606 (nreverse index-pack-alist))
5607 index-alist))
5608 (and (or index-pack-alist index-pod-alist
5609 (default-value 'imenu-sort-function))
5610 index-unsorted-alist
5611 (push (cons "+Unsorted List+..."
5612 (nreverse index-unsorted-alist))
5613 index-alist))
5614 (cperl-imenu-addback index-alist)))
5615
5616 \f
5617 ;; Suggested by Mark A. Hershberger
5618 (defun cperl-outline-level ()
5619 (looking-at outline-regexp)
5620 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
5621 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5622 ((match-beginning 2) 0) ; package
5623 ((match-beginning 8) 1) ; sub
5624 ((match-beginning 16)
5625 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5626 (t 5))) ; should not happen
5627
5628 \f
5629 (defun cperl-windowed-init ()
5630 "Initialization under windowed version."
5631 (cond ((featurep 'ps-print)
5632 (or cperl-faces-init
5633 (progn
5634 (and (boundp 'font-lock-multiline)
5635 (setq cperl-font-lock-multiline t))
5636 (cperl-init-faces))))
5637 ((not cperl-faces-init)
5638 (add-hook 'font-lock-mode-hook
5639 (function
5640 (lambda ()
5641 (if (memq major-mode '(perl-mode cperl-mode))
5642 (progn
5643 (or cperl-faces-init (cperl-init-faces)))))))
5644 (if (fboundp 'eval-after-load)
5645 (eval-after-load
5646 "ps-print"
5647 '(or cperl-faces-init (cperl-init-faces)))))))
5648
5649 (defvar cperl-font-lock-keywords-1 nil
5650 "Additional expressions to highlight in Perl mode. Minimal set.")
5651 (defvar cperl-font-lock-keywords nil
5652 "Additional expressions to highlight in Perl mode. Default set.")
5653 (defvar cperl-font-lock-keywords-2 nil
5654 "Additional expressions to highlight in Perl mode. Maximal set")
5655
5656 (defun cperl-load-font-lock-keywords ()
5657 (or cperl-faces-init (cperl-init-faces))
5658 cperl-font-lock-keywords)
5659
5660 (defun cperl-load-font-lock-keywords-1 ()
5661 (or cperl-faces-init (cperl-init-faces))
5662 cperl-font-lock-keywords-1)
5663
5664 (defun cperl-load-font-lock-keywords-2 ()
5665 (or cperl-faces-init (cperl-init-faces))
5666 cperl-font-lock-keywords-2)
5667
5668 (defun cperl-init-faces-weak ()
5669 ;; Allow `cperl-find-pods-heres' to run.
5670 (or (boundp 'font-lock-constant-face)
5671 (cperl-force-face font-lock-constant-face
5672 "Face for constant and label names"))
5673 (or (boundp 'font-lock-warning-face)
5674 (cperl-force-face font-lock-warning-face
5675 "Face for things which should stand out"))
5676 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5677 )
5678
5679 (defun cperl-init-faces ()
5680 (condition-case errs
5681 (progn
5682 (require 'font-lock)
5683 (and (fboundp 'font-lock-fontify-anchored-keywords)
5684 (featurep 'font-lock-extra)
5685 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5686 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
5687 (if (fboundp 'font-lock-fontify-anchored-keywords)
5688 (setq font-lock-anchored t))
5689 (setq
5690 t-font-lock-keywords
5691 (list
5692 `("[ \t]+$" 0 ',cperl-invalid-face t)
5693 (cons
5694 (concat
5695 "\\(^\\|[^$@%&\\]\\)\\<\\("
5696 (mapconcat
5697 'identity
5698 '("if" "until" "while" "elsif" "else" "unless" "for"
5699 "foreach" "continue" "exit" "die" "last" "goto" "next"
5700 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
5701 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
5702 "\\|") ; Flow control
5703 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5704 ; In what follows we use `type' style
5705 ; for overwritable builtins
5706 (list
5707 (concat
5708 "\\(^\\|[^$@%&\\]\\)\\<\\("
5709 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5710 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5711 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5712 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5713 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5714 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5715 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5716 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5717 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5718 ;; "gethostbyname" "gethostent" "getlogin"
5719 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5720 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5721 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5722 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5723 ;; "getservbyport" "getservent" "getsockname"
5724 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5725 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5726 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
5727 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5728 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5729 ;; "quotemeta" "rand" "read" "readdir" "readline"
5730 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5731 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5732 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5733 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5734 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5735 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5736 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5737 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
5738 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
5739 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5740 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5741 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5742 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
5743 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5744 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5745 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5746 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5747 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5748 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5749 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5750 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5751 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5752 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5753 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5754 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5755 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5756 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5757 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5758 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
5759 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5760 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5761 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5762 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5763 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5764 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5765 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5766 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
5767 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
5768 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5769 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5770 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5771 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5772 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5773 "\\)\\>") 2 'font-lock-type-face)
5774 ;; In what follows we use `other' style
5775 ;; for nonoverwritable builtins
5776 ;; Somehow 's', 'm' are not auto-generated???
5777 (list
5778 (concat
5779 "\\(^\\|[^$@%&\\]\\)\\<\\("
5780 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
5781 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5782 ;; "eval" "exists" "for" "foreach" "format" "goto"
5783 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
5784 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
5785 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5786 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5787 ;; "undef" "unless" "unshift" "untie" "until" "use"
5788 ;; "while" "y"
5789 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
5790 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
5791 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5792 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
5793 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5794 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
5795 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5796 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5797 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5798 "\\|[sm]" ; Added manually
5799 "\\)\\>") 2 'cperl-nonoverridable-face)
5800 ;; (mapconcat 'identity
5801 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5802 ;; "#include" "#define" "#undef")
5803 ;; "\\|")
5804 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5805 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5806 ;; This highlights declarations and definitions differenty.
5807 ;; We do not try to highlight in the case of attributes:
5808 ;; it is already done by `cperl-find-pods-heres'
5809 (list (concat "\\<sub"
5810 cperl-white-and-comment-rex ; whitespace/comments
5811 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5812 "\\("
5813 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5814 "([^()]*)\\)?" ; prototype
5815 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5816 "[{;]")
5817 2 (if cperl-font-lock-multiline
5818 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5819 'font-lock-function-name-face
5820 'font-lock-variable-name-face)
5821 ;; need to manually set 'multiline' for older font-locks
5822 '(progn
5823 (if (< 1 (count-lines (match-beginning 0)
5824 (match-end 0)))
5825 (put-text-property
5826 (+ 3 (match-beginning 0)) (match-end 0)
5827 'syntax-type 'multiline))
5828 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5829 'font-lock-function-name-face
5830 'font-lock-variable-name-face))))
5831 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5832 2 font-lock-function-name-face)
5833 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5834 1 font-lock-function-name-face)
5835 (cond ((featurep 'font-lock-extra)
5836 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5837 (2 font-lock-string-face t)
5838 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5839 (font-lock-anchored
5840 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5841 (2 font-lock-string-face t)
5842 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5843 nil nil
5844 (1 font-lock-string-face t))))
5845 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5846 2 font-lock-string-face t)))
5847 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
5848 font-lock-string-face t)
5849 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
5850 font-lock-constant-face) ; labels
5851 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
5852 2 font-lock-constant-face)
5853 ;; Uncomment to get perl-mode-like vars
5854 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5855 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5856 ;;; (2 (cons font-lock-variable-name-face '(underline))))
5857 (cond ((featurep 'font-lock-extra)
5858 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5859 (3 font-lock-variable-name-face)
5860 (4 '(another 4 nil
5861 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5862 (1 font-lock-variable-name-face)
5863 (2 '(restart 2 nil) nil t)))
5864 nil t))) ; local variables, multiple
5865 (font-lock-anchored
5866 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
5867 `(,(concat "\\<\\(my\\|local\\|our\\)"
5868 cperl-maybe-white-and-comment-rex
5869 "\\(("
5870 cperl-maybe-white-and-comment-rex
5871 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5872 (5 ,(if cperl-font-lock-multiline
5873 'font-lock-variable-name-face
5874 '(progn (setq cperl-font-lock-multiline-start
5875 (match-beginning 0))
5876 'font-lock-variable-name-face)))
5877 (,(concat "\\="
5878 cperl-maybe-white-and-comment-rex
5879 ","
5880 cperl-maybe-white-and-comment-rex
5881 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5882 ;; Bug in font-lock: limit is used not only to limit
5883 ;; searches, but to set the "extend window for
5884 ;; facification" property. Thus we need to minimize.
5885 ,(if cperl-font-lock-multiline
5886 '(if (match-beginning 3)
5887 (save-excursion
5888 (goto-char (match-beginning 3))
5889 (condition-case nil
5890 (forward-sexp 1)
5891 (error
5892 (condition-case nil
5893 (forward-char 200)
5894 (error nil)))) ; typeahead
5895 (1- (point))) ; report limit
5896 (forward-char -2)) ; disable continued expr
5897 '(if (match-beginning 3)
5898 (point-max) ; No limit for continuation
5899 (forward-char -2))) ; disable continued expr
5900 ,(if cperl-font-lock-multiline
5901 nil
5902 '(progn ; Do at end
5903 ;; "my" may be already fontified (POD),
5904 ;; so cperl-font-lock-multiline-start is nil
5905 (if (or (not cperl-font-lock-multiline-start)
5906 (> 2 (count-lines
5907 cperl-font-lock-multiline-start
5908 (point))))
5909 nil
5910 (put-text-property
5911 (1+ cperl-font-lock-multiline-start) (point)
5912 'syntax-type 'multiline))
5913 (setq cperl-font-lock-multiline-start nil)))
5914 (3 font-lock-variable-name-face))))
5915 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
5916 3 font-lock-variable-name-face)))
5917 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
5918 4 font-lock-variable-name-face)
5919 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
5920 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
5921 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
5922 (setq
5923 t-font-lock-keywords-1
5924 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
5925 ;; not yet as of XEmacs 19.12, works with 21.1.11
5926 (or
5927 (not (featurep 'xemacs))
5928 (string< "21.1.9" emacs-version)
5929 (and (string< "21.1.10" emacs-version)
5930 (string< emacs-version "21.1.2")))
5931 '(
5932 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5933 (if (eq (char-after (match-beginning 2)) ?%)
5934 'cperl-hash-face
5935 'cperl-array-face)
5936 t) ; arrays and hashes
5937 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5938 1
5939 (if (= (- (match-end 2) (match-beginning 2)) 1)
5940 (if (eq (char-after (match-beginning 3)) ?{)
5941 'cperl-hash-face
5942 'cperl-array-face) ; arrays and hashes
5943 font-lock-variable-name-face) ; Just to put something
5944 t)
5945 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5946 (1 cperl-array-face)
5947 (2 font-lock-variable-name-face))
5948 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5949 (1 cperl-hash-face)
5950 (2 font-lock-variable-name-face))
5951 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5952 ;;; Too much noise from \s* @s[ and friends
5953 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
5954 ;;(3 font-lock-function-name-face t t)
5955 ;;(4
5956 ;; (if (cperl-slash-is-regexp)
5957 ;; font-lock-function-name-face 'default) nil t))
5958 )))
5959 (if cperl-highlight-variables-indiscriminately
5960 (setq t-font-lock-keywords-1
5961 (append t-font-lock-keywords-1
5962 (list '("\\([$*]{?\\sw+\\)" 1
5963 font-lock-variable-name-face)))))
5964 (setq cperl-font-lock-keywords-1
5965 (if cperl-syntaxify-by-font-lock
5966 (cons 'cperl-fontify-update
5967 t-font-lock-keywords)
5968 t-font-lock-keywords)
5969 cperl-font-lock-keywords cperl-font-lock-keywords-1
5970 cperl-font-lock-keywords-2 (append
5971 cperl-font-lock-keywords-1
5972 t-font-lock-keywords-1)))
5973 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5974 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
5975 (eval ; Avoid a warning
5976 '(font-lock-require-faces
5977 (list
5978 ;; Color-light Color-dark Gray-light Gray-dark Mono
5979 (list 'font-lock-comment-face
5980 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5981 nil
5982 [nil nil t t t]
5983 [nil nil t t t]
5984 nil)
5985 (list 'font-lock-string-face
5986 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5987 nil
5988 nil
5989 [nil nil t t t]
5990 nil)
5991 (list 'font-lock-function-name-face
5992 (vector
5993 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5994 (cdr (assq 'background-color ; if mono
5995 (frame-parameters))))
5996 (vector
5997 nil nil nil nil
5998 (cdr (assq 'foreground-color ; if mono
5999 (frame-parameters))))
6000 [nil nil t t t]
6001 nil
6002 nil)
6003 (list 'font-lock-variable-name-face
6004 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6005 nil
6006 [nil nil t t t]
6007 [nil nil t t t]
6008 nil)
6009 (list 'font-lock-type-face
6010 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6011 nil
6012 [nil nil t t t]
6013 nil
6014 [nil nil t t t])
6015 (list 'font-lock-warning-face
6016 ["Pink" "Red" "Gray50" "LightGray"]
6017 ["gray20" "gray90"
6018 "gray80" "gray20"]
6019 [nil nil t t t]
6020 nil
6021 [nil nil t t t]
6022 )
6023 (list 'font-lock-constant-face
6024 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6025 nil
6026 [nil nil t t t]
6027 nil
6028 [nil nil t t t])
6029 (list 'cperl-nonoverridable-face
6030 ["chartreuse3" ("orchid1" "orange")
6031 nil "Gray80"]
6032 [nil nil "gray90"]
6033 [nil nil nil t t]
6034 [nil nil t t]
6035 [nil nil t t t])
6036 (list 'cperl-array-face
6037 ["blue" "yellow" nil "Gray80"]
6038 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6039 "gray90"]
6040 t
6041 nil
6042 nil)
6043 (list 'cperl-hash-face
6044 ["red" "red" nil "Gray80"]
6045 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6046 "gray90"]
6047 t
6048 t
6049 nil))))
6050 ;; Do it the dull way, without choose-color
6051 (defvar cperl-guessed-background nil
6052 "Display characteristics as guessed by cperl.")
6053 ;; (or (fboundp 'x-color-defined-p)
6054 ;; (defalias 'x-color-defined-p
6055 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6056 ;; ;; XEmacs >= 19.12
6057 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6058 ;; ;; XEmacs 19.11
6059 ;; (t 'x-valid-color-name-p))))
6060 (cperl-force-face font-lock-constant-face
6061 "Face for constant and label names")
6062 (cperl-force-face font-lock-variable-name-face
6063 "Face for variable names")
6064 (cperl-force-face font-lock-type-face
6065 "Face for data types")
6066 (cperl-force-face cperl-nonoverridable-face
6067 "Face for data types from another group")
6068 (cperl-force-face font-lock-warning-face
6069 "Face for things which should stand out")
6070 (cperl-force-face font-lock-comment-face
6071 "Face for comments")
6072 (cperl-force-face font-lock-function-name-face
6073 "Face for function names")
6074 (cperl-force-face cperl-hash-face
6075 "Face for hashes")
6076 (cperl-force-face cperl-array-face
6077 "Face for arrays")
6078 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6079 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6080 ;;(or (boundp 'font-lock-type-face)
6081 ;; (defconst font-lock-type-face
6082 ;; 'font-lock-type-face
6083 ;; "Face to use for data types."))
6084 ;;(or (boundp 'cperl-nonoverridable-face)
6085 ;; (defconst cperl-nonoverridable-face
6086 ;; 'cperl-nonoverridable-face
6087 ;; "Face to use for data types from another group."))
6088 ;;(if (not (featurep 'xemacs)) nil
6089 ;; (or (boundp 'font-lock-comment-face)
6090 ;; (defconst font-lock-comment-face
6091 ;; 'font-lock-comment-face
6092 ;; "Face to use for comments."))
6093 ;; (or (boundp 'font-lock-keyword-face)
6094 ;; (defconst font-lock-keyword-face
6095 ;; 'font-lock-keyword-face
6096 ;; "Face to use for keywords."))
6097 ;; (or (boundp 'font-lock-function-name-face)
6098 ;; (defconst font-lock-function-name-face
6099 ;; 'font-lock-function-name-face
6100 ;; "Face to use for function names.")))
6101 (if (and
6102 (not (cperl-is-face 'cperl-array-face))
6103 (cperl-is-face 'font-lock-emphasized-face))
6104 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
6105 (if (and
6106 (not (cperl-is-face 'cperl-hash-face))
6107 (cperl-is-face 'font-lock-other-emphasized-face))
6108 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
6109 (if (and
6110 (not (cperl-is-face 'cperl-nonoverridable-face))
6111 (cperl-is-face 'font-lock-other-type-face))
6112 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
6113 ;;(or (boundp 'cperl-hash-face)
6114 ;; (defconst cperl-hash-face
6115 ;; 'cperl-hash-face
6116 ;; "Face to use for hashes."))
6117 ;;(or (boundp 'cperl-array-face)
6118 ;; (defconst cperl-array-face
6119 ;; 'cperl-array-face
6120 ;; "Face to use for arrays."))
6121 ;; Here we try to guess background
6122 (let ((background
6123 (if (boundp 'font-lock-background-mode)
6124 font-lock-background-mode
6125 'light))
6126 (face-list (and (fboundp 'face-list) (face-list))))
6127 ;;;; (fset 'cperl-is-face
6128 ;;;; (cond ((fboundp 'find-face)
6129 ;;;; (symbol-function 'find-face))
6130 ;;;; (face-list
6131 ;;;; (function (lambda (face) (member face face-list))))
6132 ;;;; (t
6133 ;;;; (function (lambda (face) (boundp face))))))
6134 (defvar cperl-guessed-background
6135 (if (and (boundp 'font-lock-display-type)
6136 (eq font-lock-display-type 'grayscale))
6137 'gray
6138 background)
6139 "Background as guessed by CPerl mode")
6140 (and (not (cperl-is-face 'font-lock-constant-face))
6141 (cperl-is-face 'font-lock-reference-face)
6142 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
6143 (if (cperl-is-face 'font-lock-type-face) nil
6144 (copy-face 'default 'font-lock-type-face)
6145 (cond
6146 ((eq background 'light)
6147 (set-face-foreground 'font-lock-type-face
6148 (if (x-color-defined-p "seagreen")
6149 "seagreen"
6150 "sea green")))
6151 ((eq background 'dark)
6152 (set-face-foreground 'font-lock-type-face
6153 (if (x-color-defined-p "os2pink")
6154 "os2pink"
6155 "pink")))
6156 (t
6157 (set-face-background 'font-lock-type-face "gray90"))))
6158 (if (cperl-is-face 'cperl-nonoverridable-face)
6159 nil
6160 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
6161 (cond
6162 ((eq background 'light)
6163 (set-face-foreground 'cperl-nonoverridable-face
6164 (if (x-color-defined-p "chartreuse3")
6165 "chartreuse3"
6166 "chartreuse")))
6167 ((eq background 'dark)
6168 (set-face-foreground 'cperl-nonoverridable-face
6169 (if (x-color-defined-p "orchid1")
6170 "orchid1"
6171 "orange")))))
6172 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6173 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6174 ;;; (cond
6175 ;;; ((eq background 'light)
6176 ;;; (set-face-background 'font-lock-other-emphasized-face
6177 ;;; (if (x-color-defined-p "lightyellow2")
6178 ;;; "lightyellow2"
6179 ;;; (if (x-color-defined-p "lightyellow")
6180 ;;; "lightyellow"
6181 ;;; "light yellow"))))
6182 ;;; ((eq background 'dark)
6183 ;;; (set-face-background 'font-lock-other-emphasized-face
6184 ;;; (if (x-color-defined-p "navy")
6185 ;;; "navy"
6186 ;;; (if (x-color-defined-p "darkgreen")
6187 ;;; "darkgreen"
6188 ;;; "dark green"))))
6189 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6190 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6191 ;;; (copy-face 'bold 'font-lock-emphasized-face)
6192 ;;; (cond
6193 ;;; ((eq background 'light)
6194 ;;; (set-face-background 'font-lock-emphasized-face
6195 ;;; (if (x-color-defined-p "lightyellow2")
6196 ;;; "lightyellow2"
6197 ;;; "lightyellow")))
6198 ;;; ((eq background 'dark)
6199 ;;; (set-face-background 'font-lock-emphasized-face
6200 ;;; (if (x-color-defined-p "navy")
6201 ;;; "navy"
6202 ;;; (if (x-color-defined-p "darkgreen")
6203 ;;; "darkgreen"
6204 ;;; "dark green"))))
6205 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
6206 (if (cperl-is-face 'font-lock-variable-name-face) nil
6207 (copy-face 'italic 'font-lock-variable-name-face))
6208 (if (cperl-is-face 'font-lock-constant-face) nil
6209 (copy-face 'italic 'font-lock-constant-face))))
6210 (setq cperl-faces-init t))
6211 (error (message "cperl-init-faces (ignored): %s" errs))))
6212
6213
6214 (defun cperl-ps-print-init ()
6215 "Initialization of `ps-print' components for faces used in CPerl."
6216 (eval-after-load "ps-print"
6217 '(setq ps-bold-faces
6218 ;; font-lock-variable-name-face
6219 ;; font-lock-constant-face
6220 (append '(cperl-array-face cperl-hash-face)
6221 ps-bold-faces)
6222 ps-italic-faces
6223 ;; font-lock-constant-face
6224 (append '(cperl-nonoverridable-face cperl-hash-face)
6225 ps-italic-faces)
6226 ps-underlined-faces
6227 ;; font-lock-type-face
6228 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
6229 ps-underlined-faces))))
6230
6231 (defvar ps-print-face-extension-alist)
6232
6233 (defun cperl-ps-print (&optional file)
6234 "Pretty-print in CPerl style.
6235 If optional argument FILE is an empty string, prints to printer, otherwise
6236 to the file FILE. If FILE is nil, prompts for a file name.
6237
6238 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6239 (interactive)
6240 (or file
6241 (setq file (read-from-minibuffer
6242 "Print to file (if empty - to printer): "
6243 (concat (buffer-file-name) ".ps")
6244 nil nil 'file-name-history)))
6245 (or (> (length file) 0)
6246 (setq file nil))
6247 (require 'ps-print) ; To get ps-print-face-extension-alist
6248 (let ((ps-print-color-p t)
6249 (ps-print-face-extension-alist ps-print-face-extension-alist))
6250 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6251 (ps-print-buffer-with-faces file)))
6252
6253 ;;; (defun cperl-ps-print-init ()
6254 ;;; "Initialization of `ps-print' components for faces used in CPerl."
6255 ;;; ;; Guard against old versions
6256 ;;; (defvar ps-underlined-faces nil)
6257 ;;; (defvar ps-bold-faces nil)
6258 ;;; (defvar ps-italic-faces nil)
6259 ;;; (setq ps-bold-faces
6260 ;;; (append '(font-lock-emphasized-face
6261 ;;; cperl-array-face
6262 ;;; font-lock-keyword-face
6263 ;;; font-lock-variable-name-face
6264 ;;; font-lock-constant-face
6265 ;;; font-lock-reference-face
6266 ;;; font-lock-other-emphasized-face
6267 ;;; cperl-hash-face)
6268 ;;; ps-bold-faces))
6269 ;;; (setq ps-italic-faces
6270 ;;; (append '(cperl-nonoverridable-face
6271 ;;; font-lock-constant-face
6272 ;;; font-lock-reference-face
6273 ;;; font-lock-other-emphasized-face
6274 ;;; cperl-hash-face)
6275 ;;; ps-italic-faces))
6276 ;;; (setq ps-underlined-faces
6277 ;;; (append '(font-lock-emphasized-face
6278 ;;; cperl-array-face
6279 ;;; font-lock-other-emphasized-face
6280 ;;; cperl-hash-face
6281 ;;; cperl-nonoverridable-face font-lock-type-face)
6282 ;;; ps-underlined-faces))
6283 ;;; (cons 'font-lock-type-face ps-underlined-faces))
6284
6285
6286 (if (cperl-enable-font-lock) (cperl-windowed-init))
6287
6288 (defconst cperl-styles-entries
6289 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6290 cperl-label-offset cperl-extra-newline-before-brace
6291 cperl-extra-newline-before-brace-multiline
6292 cperl-merge-trailing-else
6293 cperl-continued-statement-offset))
6294
6295 (defconst cperl-style-examples
6296 "##### Numbers etc are: cperl-indent-level cperl-brace-offset
6297 ##### cperl-continued-brace-offset cperl-label-offset
6298 ##### cperl-continued-statement-offset
6299 ##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6300
6301 ########### (Do not forget cperl-extra-newline-before-brace-multiline)
6302
6303 ### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6304 if (foo) {
6305 bar
6306 baz;
6307 label:
6308 {
6309 boon;
6310 }
6311 } else {
6312 stop;
6313 }
6314
6315 ### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6316 if (foo) {
6317 bar
6318 baz;
6319 label:
6320 {
6321 boon;
6322 }
6323 } else {
6324 stop;
6325 }
6326
6327 ### GNU 2/0/0/-2/2/nil/t
6328 if (foo)
6329 {
6330 bar
6331 baz;
6332 label:
6333 {
6334 boon;
6335 }
6336 }
6337 else
6338 {
6339 stop;
6340 }
6341
6342 ### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6343 if (foo)
6344 {
6345 bar
6346 baz;
6347 label:
6348 {
6349 boon;
6350 }
6351 }
6352 else
6353 {
6354 stop;
6355 }
6356
6357 ### BSD (=C++, but will not change preexisting merge-trailing-else
6358 ### and extra-newline-before-brace ) 4/0/-4/-4/4
6359 if (foo)
6360 {
6361 bar
6362 baz;
6363 label:
6364 {
6365 boon;
6366 }
6367 }
6368 else
6369 {
6370 stop;
6371 }
6372
6373 ### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6374 ### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6375 if (foo)
6376 {
6377 bar
6378 baz;
6379 label:
6380 {
6381 boon;
6382 }
6383 }
6384 else
6385 {
6386 stop;
6387 }
6388
6389 ### Whitesmith (=PerlStyle, but will not change preexisting
6390 ### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6391 if (foo)
6392 {
6393 bar
6394 baz;
6395 label:
6396 {
6397 boon;
6398 }
6399 }
6400 else
6401 {
6402 stop;
6403 }
6404 "
6405 "Examples of if/else with different indent styles (with v4.23).")
6406
6407 (defconst cperl-style-alist
6408 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
6409 (cperl-indent-level . 2)
6410 (cperl-brace-offset . 0)
6411 (cperl-continued-brace-offset . 0)
6412 (cperl-label-offset . -2)
6413 (cperl-continued-statement-offset . 2)
6414 (cperl-extra-newline-before-brace . nil)
6415 (cperl-extra-newline-before-brace-multiline . nil)
6416 (cperl-merge-trailing-else . t))
6417
6418 ("PerlStyle" ; CPerl with 4 as indent
6419 (cperl-indent-level . 4)
6420 (cperl-brace-offset . 0)
6421 (cperl-continued-brace-offset . 0)
6422 (cperl-label-offset . -4)
6423 (cperl-continued-statement-offset . 4)
6424 (cperl-extra-newline-before-brace . nil)
6425 (cperl-extra-newline-before-brace-multiline . nil)
6426 (cperl-merge-trailing-else . t))
6427
6428 ("GNU"
6429 (cperl-indent-level . 2)
6430 (cperl-brace-offset . 0)
6431 (cperl-continued-brace-offset . 0)
6432 (cperl-label-offset . -2)
6433 (cperl-continued-statement-offset . 2)
6434 (cperl-extra-newline-before-brace . t)
6435 (cperl-extra-newline-before-brace-multiline . t)
6436 (cperl-merge-trailing-else . nil))
6437
6438 ("K&R"
6439 (cperl-indent-level . 5)
6440 (cperl-brace-offset . 0)
6441 (cperl-continued-brace-offset . -5)
6442 (cperl-label-offset . -5)
6443 (cperl-continued-statement-offset . 5)
6444 ;;(cperl-extra-newline-before-brace . nil) ; ???
6445 ;;(cperl-extra-newline-before-brace-multiline . nil)
6446 (cperl-merge-trailing-else . nil))
6447
6448 ("BSD"
6449 (cperl-indent-level . 4)
6450 (cperl-brace-offset . 0)
6451 (cperl-continued-brace-offset . -4)
6452 (cperl-label-offset . -4)
6453 (cperl-continued-statement-offset . 4)
6454 ;;(cperl-extra-newline-before-brace . nil) ; ???
6455 ;;(cperl-extra-newline-before-brace-multiline . nil)
6456 ;;(cperl-merge-trailing-else . nil) ; ???
6457 )
6458
6459 ("C++"
6460 (cperl-indent-level . 4)
6461 (cperl-brace-offset . 0)
6462 (cperl-continued-brace-offset . -4)
6463 (cperl-label-offset . -4)
6464 (cperl-continued-statement-offset . 4)
6465 (cperl-extra-newline-before-brace . t)
6466 (cperl-extra-newline-before-brace-multiline . t)
6467 (cperl-merge-trailing-else . nil))
6468
6469 ("Whitesmith"
6470 (cperl-indent-level . 4)
6471 (cperl-brace-offset . 0)
6472 (cperl-continued-brace-offset . 0)
6473 (cperl-label-offset . -4)
6474 (cperl-continued-statement-offset . 4)
6475 ;;(cperl-extra-newline-before-brace . nil) ; ???
6476 ;;(cperl-extra-newline-before-brace-multiline . nil)
6477 ;;(cperl-merge-trailing-else . nil) ; ???
6478 )
6479 ("Current"))
6480 "List of variables to set to get a particular indentation style.
6481 Should be used via `cperl-set-style' or via Perl menu.
6482
6483 See examples in `cperl-style-examples'.")
6484
6485 (defun cperl-set-style (style)
6486 "Set CPerl mode variables to use one of several different indentation styles.
6487 The arguments are a string representing the desired style.
6488 The list of styles is in `cperl-style-alist', available styles
6489 are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
6490
6491 The current value of style is memorized (unless there is a memorized
6492 data already), may be restored by `cperl-set-style-back'.
6493
6494 Chosing \"Current\" style will not change style, so this may be used for
6495 side-effect of memorizing only. Examples in `cperl-style-examples'."
6496 (interactive
6497 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
6498 cperl-style-alist)))
6499 (list (completing-read "Enter style: " list nil 'insist))))
6500 (or cperl-old-style
6501 (setq cperl-old-style
6502 (mapcar (function
6503 (lambda (name)
6504 (cons name (eval name))))
6505 cperl-styles-entries)))
6506 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
6507 (while style
6508 (setq setting (car style) style (cdr style))
6509 (set (car setting) (cdr setting)))))
6510
6511 (defun cperl-set-style-back ()
6512 "Restore a style memorized by `cperl-set-style'."
6513 (interactive)
6514 (or cperl-old-style (error "The style was not changed"))
6515 (let (setting)
6516 (while cperl-old-style
6517 (setq setting (car cperl-old-style)
6518 cperl-old-style (cdr cperl-old-style))
6519 (set (car setting) (cdr setting)))))
6520
6521 (defun cperl-check-syntax ()
6522 (interactive)
6523 (require 'mode-compile)
6524 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6525 (eval '(mode-compile)))) ; Avoid a warning
6526
6527 (defun cperl-info-buffer (type)
6528 ;; Returns buffer with documentation. Creates if missing.
6529 ;; If TYPE, this vars buffer.
6530 ;; Special care is taken to not stomp over an existing info buffer
6531 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6532 (info (get-buffer bname))
6533 (oldbuf (get-buffer "*info*")))
6534 (if info info
6535 (save-window-excursion
6536 ;; Get Info running
6537 (require 'info)
6538 (cond (oldbuf
6539 (set-buffer oldbuf)
6540 (rename-buffer "*info-perl-tmp*")))
6541 (save-window-excursion
6542 (info))
6543 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6544 (set-buffer "*info*")
6545 (rename-buffer bname)
6546 (cond (oldbuf
6547 (set-buffer "*info-perl-tmp*")
6548 (rename-buffer "*info*")
6549 (set-buffer bname)))
6550 (make-local-variable 'window-min-height)
6551 (setq window-min-height 2)
6552 (current-buffer)))))
6553
6554 (defun cperl-word-at-point (&optional p)
6555 "Return the word at point or at P."
6556 (save-excursion
6557 (if p (goto-char p))
6558 (or (cperl-word-at-point-hard)
6559 (progn
6560 (require 'etags)
6561 (funcall (or (and (boundp 'find-tag-default-function)
6562 find-tag-default-function)
6563 (get major-mode 'find-tag-default-function)
6564 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6565 ;; automatically used within `find-tag-default':
6566 'find-tag-default))))))
6567
6568 (defun cperl-info-on-command (command)
6569 "Show documentation for Perl command COMMAND in other window.
6570 If perl-info buffer is shown in some frame, uses this frame.
6571 Customized by setting variables `cperl-shrink-wrap-info-frame',
6572 `cperl-max-help-size'."
6573 (interactive
6574 (let* ((default (cperl-word-at-point))
6575 (read (read-string
6576 (format "Find doc for Perl function (default %s): "
6577 default))))
6578 (list (if (equal read "")
6579 default
6580 read))))
6581
6582 (let ((buffer (current-buffer))
6583 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6584 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6585 max-height char-height buf-list)
6586 (if (string-match "^-[a-zA-Z]$" command)
6587 (setq cmd-desc "^-X[ \t\n]"))
6588 (setq isvar (string-match "^[$@%]" command)
6589 buf (cperl-info-buffer isvar)
6590 iniwin (selected-window)
6591 fr1 (window-frame iniwin))
6592 (set-buffer buf)
6593 (goto-char (point-min))
6594 (or isvar
6595 (progn (re-search-forward "^-X[ \t\n]")
6596 (forward-line -1)))
6597 (if (re-search-forward cmd-desc nil t)
6598 (progn
6599 ;; Go back to beginning of the group (ex, for qq)
6600 (if (re-search-backward "^[ \t\n\f]")
6601 (forward-line 1))
6602 (beginning-of-line)
6603 ;; Get some of
6604 (setq pos (point)
6605 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6606 (while (and (not win) buf-list)
6607 (setq win (get-buffer-window (car buf-list) t))
6608 (setq buf-list (cdr buf-list)))
6609 (or (not win)
6610 (eq (window-buffer win) buf)
6611 (set-window-buffer win buf))
6612 (and win (setq fr2 (window-frame win)))
6613 (if (or (not fr2) (eq fr1 fr2))
6614 (pop-to-buffer buf)
6615 (special-display-popup-frame buf) ; Make it visible
6616 (select-window win))
6617 (goto-char pos) ; Needed (?!).
6618 ;; Resize
6619 (setq iniheight (window-height)
6620 frheight (frame-height)
6621 not-loner (< iniheight (1- frheight))) ; Are not alone
6622 (cond ((if not-loner cperl-max-help-size
6623 cperl-shrink-wrap-info-frame)
6624 (setq height
6625 (+ 2
6626 (count-lines
6627 pos
6628 (save-excursion
6629 (if (re-search-forward
6630 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6631 (match-beginning 0) (point-max)))))
6632 max-height
6633 (if not-loner
6634 (/ (* (- frheight 3) cperl-max-help-size) 100)
6635 (setq char-height (frame-char-height))
6636 ;; Non-functioning under OS/2:
6637 (if (eq char-height 1) (setq char-height 18))
6638 ;; Title, menubar, + 2 for slack
6639 (- (/ (display-pixel-height) char-height) 4)))
6640 (if (> height max-height) (setq height max-height))
6641 ;;(message "was %s doing %s" iniheight height)
6642 (if not-loner
6643 (enlarge-window (- height iniheight))
6644 (set-frame-height (window-frame win) (1+ height)))))
6645 (set-window-start (selected-window) pos))
6646 (message "No entry for %s found." command))
6647 ;;(pop-to-buffer buffer)
6648 (select-window iniwin)))
6649
6650 (defun cperl-info-on-current-command ()
6651 "Show documentation for Perl command at point in other window."
6652 (interactive)
6653 (cperl-info-on-command (cperl-word-at-point)))
6654
6655 (defun cperl-imenu-info-imenu-search ()
6656 (if (looking-at "^-X[ \t\n]") nil
6657 (re-search-backward
6658 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6659 (forward-line 1)))
6660
6661 (defun cperl-imenu-info-imenu-name ()
6662 (buffer-substring
6663 (match-beginning 1) (match-end 1)))
6664
6665 (defun cperl-imenu-on-info ()
6666 "Shows imenu for Perl Info Buffer.
6667 Opens Perl Info buffer if needed."
6668 (interactive)
6669 (let* ((buffer (current-buffer))
6670 imenu-create-index-function
6671 imenu-prev-index-position-function
6672 imenu-extract-index-name-function
6673 (index-item (save-restriction
6674 (save-window-excursion
6675 (set-buffer (cperl-info-buffer nil))
6676 (setq imenu-create-index-function
6677 'imenu-default-create-index-function
6678 imenu-prev-index-position-function
6679 'cperl-imenu-info-imenu-search
6680 imenu-extract-index-name-function
6681 'cperl-imenu-info-imenu-name)
6682 (imenu-choose-buffer-index)))))
6683 (and index-item
6684 (progn
6685 (push-mark)
6686 (pop-to-buffer "*info-perl*")
6687 (cond
6688 ((markerp (cdr index-item))
6689 (goto-char (marker-position (cdr index-item))))
6690 (t
6691 (goto-char (cdr index-item))))
6692 (set-window-start (selected-window) (point))
6693 (pop-to-buffer buffer)))))
6694
6695 (defun cperl-lineup (beg end &optional step minshift)
6696 "Lineup construction in a region.
6697 Beginning of region should be at the start of a construction.
6698 All first occurrences of this construction in the lines that are
6699 partially contained in the region are lined up at the same column.
6700
6701 MINSHIFT is the minimal amount of space to insert before the construction.
6702 STEP is the tabwidth to position constructions.
6703 If STEP is nil, `cperl-lineup-step' will be used
6704 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
6705 Will not move the position at the start to the left."
6706 (interactive "r")
6707 (let (search col tcol seen b)
6708 (save-excursion
6709 (goto-char end)
6710 (end-of-line)
6711 (setq end (point-marker))
6712 (goto-char beg)
6713 (skip-chars-forward " \t\f")
6714 (setq beg (point-marker))
6715 (indent-region beg end nil)
6716 (goto-char beg)
6717 (setq col (current-column))
6718 (if (looking-at "[a-zA-Z0-9_]")
6719 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6720 (setq search
6721 (concat "\\<"
6722 (regexp-quote
6723 (buffer-substring (match-beginning 0)
6724 (match-end 0))) "\\>"))
6725 (error "Cannot line up in a middle of the word"))
6726 (if (looking-at "$")
6727 (error "Cannot line up end of line"))
6728 (setq search (regexp-quote (char-to-string (following-char)))))
6729 (setq step (or step cperl-lineup-step cperl-indent-level))
6730 (or minshift (setq minshift 1))
6731 (while (progn
6732 (beginning-of-line 2)
6733 (and (< (point) end)
6734 (re-search-forward search end t)
6735 (goto-char (match-beginning 0))))
6736 (setq tcol (current-column) seen t)
6737 (if (> tcol col) (setq col tcol)))
6738 (or seen
6739 (error "The construction to line up occurred only once"))
6740 (goto-char beg)
6741 (setq col (+ col minshift))
6742 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
6743 (while
6744 (progn
6745 (cperl-make-indent col)
6746 (beginning-of-line 2)
6747 (and (< (point) end)
6748 (re-search-forward search end t)
6749 (goto-char (match-beginning 0)))))))) ; No body
6750
6751 (defun cperl-etags (&optional add all files) ;; NOT USED???
6752 "Run etags with appropriate options for Perl files.
6753 If optional argument ALL is `recursive', will process Perl files
6754 in subdirectories too."
6755 (interactive)
6756 (let ((cmd "etags")
6757 (args '("-l" "none" "-r"
6758 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6759 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6760 "-r"
6761 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6762 "-r"
6763 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
6764 res)
6765 (if add (setq args (cons "-a" args)))
6766 (or files (setq files (list buffer-file-name)))
6767 (cond
6768 ((eq all 'recursive)
6769 ;;(error "Not implemented: recursive")
6770 (setq args (append (list "-e"
6771 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6772 use File::Find;
6773 find(\\&wanted, '.');
6774 exec @ARGV;"
6775 cmd) args)
6776 cmd "perl"))
6777 (all
6778 ;;(error "Not implemented: all")
6779 (setq args (append (list "-e"
6780 "push @ARGV, <*.PL *.pl *.pm>;
6781 exec @ARGV;"
6782 cmd) args)
6783 cmd "perl"))
6784 (t
6785 (setq args (append args files))))
6786 (setq res (apply 'call-process cmd nil nil nil args))
6787 (or (eq res 0)
6788 (message "etags returned \"%s\"" res))))
6789
6790 (defun cperl-toggle-auto-newline ()
6791 "Toggle the state of `cperl-auto-newline'."
6792 (interactive)
6793 (setq cperl-auto-newline (not cperl-auto-newline))
6794 (message "Newlines will %sbe auto-inserted now."
6795 (if cperl-auto-newline "" "not ")))
6796
6797 (defun cperl-toggle-abbrev ()
6798 "Toggle the state of automatic keyword expansion in CPerl mode."
6799 (interactive)
6800 (abbrev-mode (if abbrev-mode 0 1))
6801 (message "Perl control structure will %sbe auto-inserted now."
6802 (if abbrev-mode "" "not ")))
6803
6804
6805 (defun cperl-toggle-electric ()
6806 "Toggle the state of parentheses doubling in CPerl mode."
6807 (interactive)
6808 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
6809 (message "Parentheses will %sbe auto-doubled now."
6810 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6811
6812 (defun cperl-toggle-autohelp ()
6813 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6814 Delay of auto-help controlled by `cperl-lazy-help-time'."
6815 (interactive)
6816 (if (fboundp 'run-with-idle-timer)
6817 (progn
6818 (if cperl-lazy-installed
6819 (cperl-lazy-unstall)
6820 (cperl-lazy-install))
6821 (message "Perl help messages will %sbe automatically shown now."
6822 (if cperl-lazy-installed "" "not ")))
6823 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6824
6825 (defun cperl-toggle-construct-fix ()
6826 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6827 (interactive)
6828 (setq cperl-indent-region-fix-constructs
6829 (if cperl-indent-region-fix-constructs
6830 nil
6831 1))
6832 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
6833 (if cperl-indent-region-fix-constructs "" "not ")))
6834
6835 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6836 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6837 Nonpositive numeric argument disables debugging messages. The message
6838 summarizes which regions it was decided to rescan for syntactic constructs.
6839
6840 The message looks like this:
6841
6842 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6843
6844 Numbers are character positions in the buffer. REQ provides the range to
6845 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6846 for correct operation it should start and end outside any special syntactic
6847 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6848 by CPerl."
6849 (interactive "P")
6850 (or arg
6851 (setq arg (if (eq cperl-syntaxify-by-font-lock
6852 (if backtrace 'backtrace 'message)) 0 1)))
6853 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6854 (setq cperl-syntaxify-by-font-lock arg)
6855 (message "Debugging messages of syntax unwind %sabled."
6856 (if (eq arg t) "dis" "en")))
6857
6858 ;;;; Tags file creation.
6859
6860 (defvar cperl-tmp-buffer " *cperl-tmp*")
6861
6862 (defun cperl-setup-tmp-buf ()
6863 (set-buffer (get-buffer-create cperl-tmp-buffer))
6864 (set-syntax-table cperl-mode-syntax-table)
6865 (buffer-disable-undo)
6866 (auto-fill-mode 0)
6867 (if cperl-use-syntax-table-text-property-for-tags
6868 (progn
6869 (make-local-variable 'parse-sexp-lookup-properties)
6870 ;; Do not introduce variable if not needed, we check it!
6871 (set 'parse-sexp-lookup-properties t))))
6872
6873 ;; Copied from imenu-example--name-and-position.
6874 (defvar imenu-use-markers)
6875
6876 (defun cperl-imenu-name-and-position ()
6877 "Return the current/previous sexp and its (beginning) location.
6878 Does not move point."
6879 (save-excursion
6880 (forward-sexp -1)
6881 (let ((beg (if imenu-use-markers (point-marker) (point)))
6882 (end (progn (forward-sexp) (point))))
6883 (cons (buffer-substring beg end)
6884 beg))))
6885
6886 (defun cperl-xsub-scan ()
6887 (require 'imenu)
6888 (let ((index-alist '())
6889 (prev-pos 0) index index1 name package prefix)
6890 (goto-char (point-min))
6891 ;; Search for the function
6892 (progn ;;save-match-data
6893 (while (re-search-forward
6894 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6895 nil t)
6896 (cond
6897 ((match-beginning 2) ; SECTION
6898 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6899 (goto-char (match-beginning 0))
6900 (skip-chars-forward " \t")
6901 (forward-char 1)
6902 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6903 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6904 (setq prefix nil)))
6905 ((not package) nil) ; C language section
6906 ((match-beginning 3) ; XSUB
6907 (goto-char (1+ (match-beginning 3)))
6908 (setq index (cperl-imenu-name-and-position))
6909 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6910 (if (and prefix (string-match (concat "^" prefix) name))
6911 (setq name (substring name (length prefix))))
6912 (cond ((string-match "::" name) nil)
6913 (t
6914 (setq index1 (cons (concat package "::" name) (cdr index)))
6915 (push index1 index-alist)))
6916 (setcar index name)
6917 (push index index-alist))
6918 (t ; BOOT: section
6919 ;; (beginning-of-line)
6920 (setq index (cperl-imenu-name-and-position))
6921 (setcar index (concat package "::BOOT:"))
6922 (push index index-alist)))))
6923 index-alist))
6924
6925 (defvar cperl-unreadable-ok nil)
6926
6927 (defun cperl-find-tags (ifile xs topdir)
6928 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6929 (cperl-pod-here-fontify nil) f file)
6930 (save-excursion
6931 (if b (set-buffer b)
6932 (cperl-setup-tmp-buf))
6933 (erase-buffer)
6934 (condition-case err
6935 (setq file (car (insert-file-contents ifile)))
6936 (error (if cperl-unreadable-ok nil
6937 (if (y-or-n-p
6938 (format "File %s unreadable. Continue? " ifile))
6939 (setq cperl-unreadable-ok t)
6940 (error "Aborting: unreadable file %s" ifile)))))
6941 (if (not file)
6942 (message "Unreadable file %s" ifile)
6943 (message "Scanning file %s ..." file)
6944 (if (and cperl-use-syntax-table-text-property-for-tags
6945 (not xs))
6946 (condition-case err ; after __END__ may have garbage
6947 (cperl-find-pods-heres nil nil noninteractive)
6948 (error (message "While scanning for syntax: %s" err))))
6949 (if xs
6950 (setq lst (cperl-xsub-scan))
6951 (setq ind (cperl-imenu--create-perl-index))
6952 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6953 (setq lst
6954 (mapcar
6955 (function
6956 (lambda (elt)
6957 (cond ((string-match "^[_a-zA-Z]" (car elt))
6958 (goto-char (cdr elt))
6959 (beginning-of-line) ; pos should be of the start of the line
6960 (list (car elt)
6961 (point)
6962 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6963 (buffer-substring (progn
6964 (goto-char (cdr elt))
6965 ;; After name now...
6966 (or (eolp) (forward-char 1))
6967 (point))
6968 (progn
6969 (beginning-of-line)
6970 (point))))))))
6971 lst))
6972 (erase-buffer)
6973 (while lst
6974 (setq elt (car lst) lst (cdr lst))
6975 (if elt
6976 (progn
6977 (insert (elt elt 3)
6978 127
6979 (if (string-match "^package " (car elt))
6980 (substring (car elt) 8)
6981 (car elt) )
6982 1
6983 (number-to-string (elt elt 2)) ; Line
6984 ","
6985 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6986 "\n")
6987 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6988 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
6989 (elt elt 3)))
6990 ;; Need to insert the name without package as well
6991 (setq lst (cons (cons (substring (elt elt 3)
6992 (match-beginning 1)
6993 (match-end 1))
6994 (cdr elt))
6995 lst))))))
6996 (setq pos (point))
6997 (goto-char 1)
6998 (setq rel file)
6999 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7000 (set-text-properties 0 (length rel) nil rel)
7001 (and (equal topdir (substring rel 0 (length topdir)))
7002 (setq rel (substring file (length topdir))))
7003 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7004 (setq ret (buffer-substring 1 (point-max)))
7005 (erase-buffer)
7006 (or noninteractive
7007 (message "Scanning file %s finished" file))
7008 ret))))
7009
7010 (defun cperl-add-tags-recurse-noxs ()
7011 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
7012 Use as
7013 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7014 -f cperl-add-tags-recurse-noxs
7015 "
7016 (cperl-write-tags nil nil t t nil t))
7017
7018 (defun cperl-add-tags-recurse-noxs-fullpath ()
7019 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7020 Writes down fullpath, so TAGS is relocatable (but if the build directory
7021 is relocated, the file TAGS inside it breaks). Use as
7022 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7023 -f cperl-add-tags-recurse-noxs-fullpath
7024 "
7025 (cperl-write-tags nil nil t t nil t ""))
7026
7027 (defun cperl-add-tags-recurse ()
7028 "Add to TAGS file data for Perl files in the current directory and kids.
7029 Use as
7030 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7031 -f cperl-add-tags-recurse
7032 "
7033 (cperl-write-tags nil nil t t))
7034
7035 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7036 ;; If INBUFFER, do not select buffer, and do not save
7037 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7038 (require 'etags)
7039 (if file nil
7040 (setq file (if dir default-directory (buffer-file-name)))
7041 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7042 (or topdir
7043 (setq topdir default-directory))
7044 (let ((tags-file-name "TAGS")
7045 (case-fold-search (eq system-type 'emx))
7046 xs rel tm)
7047 (save-excursion
7048 (cond (inbuffer nil) ; Already there
7049 ((file-exists-p tags-file-name)
7050 (if (featurep 'xemacs)
7051 (visit-tags-table-buffer)
7052 (visit-tags-table-buffer tags-file-name)))
7053 (t (set-buffer (find-file-noselect tags-file-name))))
7054 (cond
7055 (dir
7056 (cond ((eq erase 'ignore))
7057 (erase
7058 (erase-buffer)
7059 (setq erase 'ignore)))
7060 (let ((files
7061 (condition-case err
7062 (directory-files file t
7063 (if recurse nil cperl-scan-files-regexp)
7064 t)
7065 (error
7066 (if cperl-unreadable-ok nil
7067 (if (y-or-n-p
7068 (format "Directory %s unreadable. Continue? " file))
7069 (setq cperl-unreadable-ok t
7070 tm nil) ; Return empty list
7071 (error "Aborting: unreadable directory %s" file)))))))
7072 (mapc (function
7073 (lambda (file)
7074 (cond
7075 ((string-match cperl-noscan-files-regexp file)
7076 nil)
7077 ((not (file-directory-p file))
7078 (if (string-match cperl-scan-files-regexp file)
7079 (cperl-write-tags file erase recurse nil t noxs topdir)))
7080 ((not recurse) nil)
7081 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7082 files)))
7083 (t
7084 (setq xs (string-match "\\.xs$" file))
7085 (if (not (and xs noxs))
7086 (progn
7087 (cond ((eq erase 'ignore) (goto-char (point-max)))
7088 (erase (erase-buffer))
7089 (t
7090 (goto-char 1)
7091 (setq rel file)
7092 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7093 (set-text-properties 0 (length rel) nil rel)
7094 (and (equal topdir (substring rel 0 (length topdir)))
7095 (setq rel (substring file (length topdir))))
7096 (if (search-forward (concat "\f\n" rel ",") nil t)
7097 (progn
7098 (search-backward "\f\n")
7099 (delete-region (point)
7100 (save-excursion
7101 (forward-char 1)
7102 (if (search-forward "\f\n"
7103 nil 'toend)
7104 (- (point) 2)
7105 (point-max)))))
7106 (goto-char (point-max)))))
7107 (insert (cperl-find-tags file xs topdir))))))
7108 (if inbuffer nil ; Delegate to the caller
7109 (save-buffer 0) ; No backup
7110 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7111 (initialize-new-tags-table))))))
7112
7113 (defvar cperl-tags-hier-regexp-list
7114 (concat
7115 "^\\("
7116 "\\(package\\)\\>"
7117 "\\|"
7118 "sub\\>[^\n]+::"
7119 "\\|"
7120 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7121 "\\|"
7122 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7123 "\\)"))
7124
7125 (defvar cperl-hierarchy '(() ())
7126 "Global hierarchy of classes.")
7127
7128 (defun cperl-tags-hier-fill ()
7129 ;; Suppose we are in a tag table cooked by cperl.
7130 (goto-char 1)
7131 (let (type pack name pos line chunk ord cons1 file str info fileind)
7132 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
7133 (setq pos (match-beginning 0)
7134 pack (match-beginning 2))
7135 (beginning-of-line)
7136 (if (looking-at (concat
7137 "\\([^\n]+\\)"
7138 "\C-?"
7139 "\\([^\n]+\\)"
7140 "\C-a"
7141 "\\([0-9]+\\)"
7142 ","
7143 "\\([0-9]+\\)"))
7144 (progn
7145 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7146 name (buffer-substring (match-beginning 2) (match-end 2))
7147 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
7148 line (buffer-substring (match-beginning 3) (match-end 3))
7149 ord (if pack 1 0)
7150 file (file-of-tag)
7151 fileind (format "%s:%s" file line)
7152 ;; Moves to beginning of the next line:
7153 info (cperl-etags-snarf-tag file line))
7154 ;; Move back
7155 (forward-char -1)
7156 ;; Make new member of hierarchy name ==> file ==> pos if needed
7157 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7158 ;; Name known
7159 (setcdr cons1 (cons (cons fileind (vector file info))
7160 (cdr cons1)))
7161 ;; First occurrence of the name, start alist
7162 (setq cons1 (cons name (list (cons fileind (vector file info)))))
7163 (if pack
7164 (setcar (cdr cperl-hierarchy)
7165 (cons cons1 (nth 1 cperl-hierarchy)))
7166 (setcar cperl-hierarchy
7167 (cons cons1 (car cperl-hierarchy)))))))
7168 (end-of-line))))
7169
7170 (declare-function x-popup-menu "menu.c" (position menu))
7171
7172 (defun cperl-tags-hier-init (&optional update)
7173 "Show hierarchical menu of classes and methods.
7174 Finds info about classes by a scan of loaded TAGS files.
7175 Supposes that the TAGS files contain fully qualified function names.
7176 One may build such TAGS files from CPerl mode menu."
7177 (interactive)
7178 (require 'etags)
7179 (require 'imenu)
7180 (if (or update (null (nth 2 cperl-hierarchy)))
7181 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7182 (or (nthcdr 2 elt)
7183 ;; Only in one file
7184 (setcdr elt (cdr (nth 1 elt)))))))
7185 pack name cons1 to l1 l2 l3 l4 b)
7186 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7187 (setq cperl-hierarchy (list l1 l2 l3))
7188 (if (featurep 'xemacs) ; Not checked
7189 (progn
7190 (or tags-file-name
7191 ;; Does this work in XEmacs?
7192 (call-interactively 'visit-tags-table))
7193 (message "Updating list of classes...")
7194 (set-buffer (get-file-buffer tags-file-name))
7195 (cperl-tags-hier-fill))
7196 (or tags-table-list
7197 (call-interactively 'visit-tags-table))
7198 (mapc
7199 (function
7200 (lambda (tagsfile)
7201 (message "Updating list of classes... %s" tagsfile)
7202 (set-buffer (get-file-buffer tagsfile))
7203 (cperl-tags-hier-fill)))
7204 tags-table-list)
7205 (message "Updating list of classes... postprocessing..."))
7206 (mapc remover (car cperl-hierarchy))
7207 (mapc remover (nth 1 cperl-hierarchy))
7208 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7209 (cons "Methods: " (car cperl-hierarchy))))
7210 (cperl-tags-treeify to 1)
7211 (setcar (nthcdr 2 cperl-hierarchy)
7212 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7213 (message "Updating list of classes: done, requesting display...")
7214 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7215 ))
7216 (or (nth 2 cperl-hierarchy)
7217 (error "No items found"))
7218 (setq update
7219 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
7220 (if (if (fboundp 'display-popup-menus-p)
7221 (let ((f 'display-popup-menus-p))
7222 (funcall f))
7223 window-system)
7224 (x-popup-menu t (nth 2 cperl-hierarchy))
7225 (require 'tmm)
7226 (tmm-prompt (nth 2 cperl-hierarchy))))
7227 (if (and update (listp update))
7228 (progn (while (cdr update) (setq update (cdr update)))
7229 (setq update (car update)))) ; Get the last from the list
7230 (if (vectorp update)
7231 (progn
7232 (find-file (elt update 0))
7233 (cperl-etags-goto-tag-location (elt update 1))))
7234 (if (eq update -999) (cperl-tags-hier-init t)))
7235
7236 (defun cperl-tags-treeify (to level)
7237 ;; cadr of `to' is read-write. On start it is a cons
7238 (let* ((regexp (concat "^\\(" (mapconcat
7239 'identity
7240 (make-list level "[_a-zA-Z0-9]+")
7241 "::")
7242 "\\)\\(::\\)?"))
7243 (packages (cdr (nth 1 to)))
7244 (methods (cdr (nth 2 to)))
7245 l1 head tail cons1 cons2 ord writeto packs recurse
7246 root-packages root-functions ms many_ms same_name ps
7247 (move-deeper
7248 (function
7249 (lambda (elt)
7250 (cond ((and (string-match regexp (car elt))
7251 (or (eq ord 1) (match-end 2)))
7252 (setq head (substring (car elt) 0 (match-end 1))
7253 tail (if (match-end 2) (substring (car elt)
7254 (match-end 2)))
7255 recurse t)
7256 (if (setq cons1 (assoc head writeto)) nil
7257 ;; Need to init new head
7258 (setcdr writeto (cons (list head (list "Packages: ")
7259 (list "Methods: "))
7260 (cdr writeto)))
7261 (setq cons1 (nth 1 writeto)))
7262 (setq cons2 (nth ord cons1)) ; Either packs or meths
7263 (setcdr cons2 (cons elt (cdr cons2))))
7264 ((eq ord 2)
7265 (setq root-functions (cons elt root-functions)))
7266 (t
7267 (setq root-packages (cons elt root-packages))))))))
7268 (setcdr to l1) ; Init to dynamic space
7269 (setq writeto to)
7270 (setq ord 1)
7271 (mapc move-deeper packages)
7272 (setq ord 2)
7273 (mapc move-deeper methods)
7274 (if recurse
7275 (mapc (function (lambda (elt)
7276 (cperl-tags-treeify elt (1+ level))))
7277 (cdr to)))
7278 ;;Now clean up leaders with one child only
7279 (mapc (function (lambda (elt)
7280 (if (not (and (listp (cdr elt))
7281 (eq (length elt) 2))) nil
7282 (setcar elt (car (nth 1 elt)))
7283 (setcdr elt (cdr (nth 1 elt))))))
7284 (cdr to))
7285 ;; Sort the roots of subtrees
7286 (if (default-value 'imenu-sort-function)
7287 (setcdr to
7288 (sort (cdr to) (default-value 'imenu-sort-function))))
7289 ;; Now add back functions removed from display
7290 (mapc (function (lambda (elt)
7291 (setcdr to (cons elt (cdr to)))))
7292 (if (default-value 'imenu-sort-function)
7293 (nreverse
7294 (sort root-functions (default-value 'imenu-sort-function)))
7295 root-functions))
7296 ;; Now add back packages removed from display
7297 (mapc (function (lambda (elt)
7298 (setcdr to (cons (cons (concat "package " (car elt))
7299 (cdr elt))
7300 (cdr to)))))
7301 (if (default-value 'imenu-sort-function)
7302 (nreverse
7303 (sort root-packages (default-value 'imenu-sort-function)))
7304 root-packages))))
7305
7306 ;;;(x-popup-menu t
7307 ;;; '(keymap "Name1"
7308 ;;; ("Ret1" "aa")
7309 ;;; ("Head1" "ab"
7310 ;;; keymap "Name2"
7311 ;;; ("Tail1" "x") ("Tail2" "y"))))
7312
7313 (defun cperl-list-fold (list name limit)
7314 (let (list1 list2 elt1 (num 0))
7315 (if (<= (length list) limit) list
7316 (setq list1 nil list2 nil)
7317 (while list
7318 (setq num (1+ num)
7319 elt1 (car list)
7320 list (cdr list))
7321 (if (<= num imenu-max-items)
7322 (setq list2 (cons elt1 list2))
7323 (setq list1 (cons (cons name
7324 (nreverse list2))
7325 list1)
7326 list2 (list elt1)
7327 num 1)))
7328 (nreverse (cons (cons name
7329 (nreverse list2))
7330 list1)))))
7331
7332 (defun cperl-menu-to-keymap (menu &optional name)
7333 (let (list)
7334 (cons 'keymap
7335 (mapcar
7336 (function
7337 (lambda (elt)
7338 (cond ((listp (cdr elt))
7339 (setq list (cperl-list-fold
7340 (cdr elt) (car elt) imenu-max-items))
7341 (cons nil
7342 (cons (car elt)
7343 (cperl-menu-to-keymap list))))
7344 (t
7345 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7346 (cperl-list-fold menu "Root" imenu-max-items)))))
7347
7348 \f
7349 (defvar cperl-bad-style-regexp
7350 (mapconcat 'identity
7351 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
7352 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
7353 "\\|")
7354 "Finds places such that insertion of a whitespace may help a lot.")
7355
7356 (defvar cperl-not-bad-style-regexp
7357 (mapconcat
7358 'identity
7359 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7360 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7361 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
7362 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
7363 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
7364 "-[0-9]" ; -5
7365 "\\+\\+" ; ++var
7366 "--" ; --var
7367 ".->" ; a->b
7368 "->" ; a SPACE ->b
7369 "\\[-" ; a[-1]
7370 "\\\\[&$@*\\\\]" ; \&func
7371 "^=" ; =head
7372 "\\$." ; $|
7373 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
7374 "||"
7375 "&&"
7376 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
7377 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
7378 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7379 ;;"[*/+-|&<.]+="
7380 )
7381 "\\|")
7382 "If matches at the start of match found by `my-bad-c-style-regexp',
7383 insertion of a whitespace will not help.")
7384
7385 (defvar found-bad)
7386
7387 (defun cperl-find-bad-style ()
7388 "Find places in the buffer where insertion of a whitespace may help.
7389 Prompts user for insertion of spaces.
7390 Currently it is tuned to C and Perl syntax."
7391 (interactive)
7392 (let (found-bad (p (point)))
7393 (setq last-nonmenu-event 13) ; To disable popup
7394 (goto-char (point-min))
7395 (map-y-or-n-p "Insert space here? "
7396 (lambda (arg) (insert " "))
7397 'cperl-next-bad-style
7398 '("location" "locations" "insert a space into")
7399 '((?\C-r (lambda (arg)
7400 (let ((buffer-quit-function
7401 'exit-recursive-edit))
7402 (message "Exit with Esc Esc")
7403 (recursive-edit)
7404 t)) ; Consider acted upon
7405 "edit, exit with Esc Esc")
7406 (?e (lambda (arg)
7407 (let ((buffer-quit-function
7408 'exit-recursive-edit))
7409 (message "Exit with Esc Esc")
7410 (recursive-edit)
7411 t)) ; Consider acted upon
7412 "edit, exit with Esc Esc"))
7413 t)
7414 (if found-bad (goto-char found-bad)
7415 (goto-char p)
7416 (message "No appropriate place found"))))
7417
7418 (defun cperl-next-bad-style ()
7419 (let (p (not-found t) (point (point)) found)
7420 (while (and not-found
7421 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7422 (setq p (point))
7423 (goto-char (match-beginning 0))
7424 (if (or
7425 (looking-at cperl-not-bad-style-regexp)
7426 ;; Check for a < -b and friends
7427 (and (eq (following-char) ?\-)
7428 (save-excursion
7429 (skip-chars-backward " \t\n")
7430 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
7431 ;; Now check for syntax type
7432 (save-match-data
7433 (setq found (point))
7434 (beginning-of-defun)
7435 (let ((pps (parse-partial-sexp (point) found)))
7436 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7437 (goto-char (match-end 0))
7438 (goto-char (1- p))
7439 (setq not-found nil
7440 found-bad found)))
7441 (not not-found)))
7442
7443 \f
7444 ;;; Getting help
7445 (defvar cperl-have-help-regexp
7446 ;;(concat "\\("
7447 (mapconcat
7448 'identity
7449 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
7450 "[$@]\\^[a-zA-Z]" ; Special variable
7451 "[$@][^ \n\t]" ; Special variable
7452 "-[a-zA-Z]" ; File test
7453 "\\\\[a-zA-Z0]" ; Special chars
7454 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
7455 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7456 "[a-zA-Z_0-9:]+" ; symbol or number
7457 "x="
7458 "#!")
7459 ;;"\\)\\|\\("
7460 "\\|")
7461 ;;"\\)"
7462 ;;)
7463 "Matches places in the buffer we can find help for.")
7464
7465 (defvar cperl-message-on-help-error t)
7466 (defvar cperl-help-from-timer nil)
7467
7468 (defun cperl-word-at-point-hard ()
7469 ;; Does not save-excursion
7470 ;; Get to the something meaningful
7471 (or (eobp) (eolp) (forward-char 1))
7472 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
7473 (point-at-bol)
7474 'to-beg)
7475 ;; (cond
7476 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7477 ;; (skip-chars-backward " \n\t\r({[]});,")
7478 ;; (or (bobp) (backward-char 1))))
7479 ;; Try to backtrace
7480 (cond
7481 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7482 (skip-chars-backward "a-zA-Z0-9_:")
7483 (cond
7484 ((and (eq (preceding-char) ?^) ; $^I
7485 (eq (char-after (- (point) 2)) ?\$))
7486 (forward-char -2))
7487 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7488 (forward-char -1))
7489 ((and (eq (preceding-char) ?\=)
7490 (eq (current-column) 1))
7491 (forward-char -1))) ; =head1
7492 (if (and (eq (preceding-char) ?\<)
7493 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7494 (forward-char -1)))
7495 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7496 (forward-char -1))
7497 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7498 (forward-char -1))
7499 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7500 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7501 (cond
7502 ((and (eq (preceding-char) ?\$)
7503 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7504 (forward-char -1))
7505 ((and (eq (following-char) ?\>)
7506 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7507 (save-excursion
7508 (forward-sexp -1)
7509 (and (eq (preceding-char) ?\<)
7510 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7511 (search-backward "<"))))
7512 ((and (eq (following-char) ?\$)
7513 (eq (preceding-char) ?\<)
7514 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7515 (forward-char -1)))
7516 (if (looking-at cperl-have-help-regexp)
7517 (buffer-substring (match-beginning 0) (match-end 0))))
7518
7519 (defun cperl-get-help ()
7520 "Get one-line docs on the symbol at the point.
7521 The data for these docs is a little bit obsolete and may be in fact longer
7522 than a line. Your contribution to update/shorten it is appreciated."
7523 (interactive)
7524 (save-match-data ; May be called "inside" query-replace
7525 (save-excursion
7526 (let ((word (cperl-word-at-point-hard)))
7527 (if word
7528 (if (and cperl-help-from-timer ; Bail out if not in mainland
7529 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7530 (or (memq (get-text-property (point) 'face)
7531 '(font-lock-comment-face font-lock-string-face))
7532 (memq (get-text-property (point) 'syntax-type)
7533 '(pod here-doc format))))
7534 nil
7535 (cperl-describe-perl-symbol word))
7536 (if cperl-message-on-help-error
7537 (message "Nothing found for %s..."
7538 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7539
7540 ;;; Stolen from perl-descr.el by Johan Vromans:
7541
7542 (defvar cperl-doc-buffer " *perl-doc*"
7543 "Where the documentation can be found.")
7544
7545 (defun cperl-describe-perl-symbol (val)
7546 "Display the documentation of symbol at point, a Perl operator."
7547 (let ((enable-recursive-minibuffers t)
7548 args-file regexp)
7549 (cond
7550 ((string-match "^[&*][a-zA-Z_]" val)
7551 (setq val (concat (substring val 0 1) "NAME")))
7552 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7553 (setq val (concat "@" (substring val 1 (match-end 1)))))
7554 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7555 (setq val (concat "%" (substring val 1 (match-end 1)))))
7556 ((and (string= val "x") (string-match "^x=" val))
7557 (setq val "x="))
7558 ((string-match "^\\$[\C-a-\C-z]" val)
7559 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7560 ((string-match "^CORE::" val)
7561 (setq val "CORE::"))
7562 ((string-match "^SUPER::" val)
7563 (setq val "SUPER::"))
7564 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7565 (setq val "<NAME>")))
7566 (setq regexp (concat "^"
7567 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
7568 (regexp-quote val)
7569 "\\([ \t([/]\\|$\\)"))
7570
7571 ;; get the buffer with the documentation text
7572 (cperl-switch-to-doc-buffer)
7573
7574 ;; lookup in the doc
7575 (goto-char (point-min))
7576 (let ((case-fold-search nil))
7577 (list
7578 (if (re-search-forward regexp (point-max) t)
7579 (save-excursion
7580 (beginning-of-line 1)
7581 (let ((lnstart (point)))
7582 (end-of-line)
7583 (message "%s" (buffer-substring lnstart (point)))))
7584 (if cperl-message-on-help-error
7585 (message "No definition for %s" val)))))))
7586
7587 (defvar cperl-short-docs 'please-ignore-this-line
7588 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7589 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
7590 ... Range (list context); flip/flop [no flop when flip] (scalar context).
7591 ! ... Logical negation.
7592 ... != ... Numeric inequality.
7593 ... !~ ... Search pattern, substitution, or translation (negated).
7594 $! In numeric context: errno. In a string context: error string.
7595 $\" The separator which joins elements of arrays interpolated in strings.
7596 $# The output format for printed numbers. Default is %.15g or close.
7597 $$ Process number of this script. Changes in the fork()ed child process.
7598 $% The current page number of the currently selected output channel.
7599
7600 The following variables are always local to the current block:
7601
7602 $1 Match of the 1st set of parentheses in the last match (auto-local).
7603 $2 Match of the 2nd set of parentheses in the last match (auto-local).
7604 $3 Match of the 3rd set of parentheses in the last match (auto-local).
7605 $4 Match of the 4th set of parentheses in the last match (auto-local).
7606 $5 Match of the 5th set of parentheses in the last match (auto-local).
7607 $6 Match of the 6th set of parentheses in the last match (auto-local).
7608 $7 Match of the 7th set of parentheses in the last match (auto-local).
7609 $8 Match of the 8th set of parentheses in the last match (auto-local).
7610 $9 Match of the 9th set of parentheses in the last match (auto-local).
7611 $& The string matched by the last pattern match (auto-local).
7612 $' The string after what was matched by the last match (auto-local).
7613 $` The string before what was matched by the last match (auto-local).
7614
7615 $( The real gid of this process.
7616 $) The effective gid of this process.
7617 $* Deprecated: Set to 1 to do multiline matching within a string.
7618 $+ The last bracket matched by the last search pattern.
7619 $, The output field separator for the print operator.
7620 $- The number of lines left on the page.
7621 $. The current input line number of the last filehandle that was read.
7622 $/ The input record separator, newline by default.
7623 $0 Name of the file containing the current perl script (read/write).
7624 $: String may be broken after these characters to fill ^-lines in a format.
7625 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
7626 $< The real uid of this process.
7627 $= The page length of the current output channel. Default is 60 lines.
7628 $> The effective uid of this process.
7629 $? The status returned by the last ``, pipe close or `system'.
7630 $@ The perl error message from the last eval or do @var{EXPR} command.
7631 $ARGV The name of the current file used with <> .
7632 $[ Deprecated: The index of the first element/char in an array/string.
7633 $\\ The output record separator for the print operator.
7634 $] The perl version string as displayed with perl -v.
7635 $^ The name of the current top-of-page format.
7636 $^A The current value of the write() accumulator for format() lines.
7637 $^D The value of the perl debug (-D) flags.
7638 $^E Information about the last system error other than that provided by $!.
7639 $^F The highest system file descriptor, ordinarily 2.
7640 $^H The current set of syntax checks enabled by `use strict'.
7641 $^I The value of the in-place edit extension (perl -i option).
7642 $^L What formats output to perform a formfeed. Default is \\f.
7643 $^M A buffer for emergency memory allocation when running out of memory.
7644 $^O The operating system name under which this copy of Perl was built.
7645 $^P Internal debugging flag.
7646 $^T The time the script was started. Used by -A/-M/-C file tests.
7647 $^W True if warnings are requested (perl -w flag).
7648 $^X The name under which perl was invoked (argv[0] in C-speech).
7649 $_ The default input and pattern-searching space.
7650 $| Auto-flush after write/print on current output channel? Default 0.
7651 $~ The name of the current report format.
7652 ... % ... Modulo division.
7653 ... %= ... Modulo division assignment.
7654 %ENV Contains the current environment.
7655 %INC List of files that have been require-d or do-ne.
7656 %SIG Used to set signal handlers for various signals.
7657 ... & ... Bitwise and.
7658 ... && ... Logical and.
7659 ... &&= ... Logical and assignment.
7660 ... &= ... Bitwise and assignment.
7661 ... * ... Multiplication.
7662 ... ** ... Exponentiation.
7663 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7664 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
7665 ... + ... Addition. +EXPR Makes EXPR into scalar context.
7666 ++ Auto-increment (magical on strings). ++EXPR EXPR++
7667 ... += ... Addition assignment.
7668 , Comma operator.
7669 ... - ... Subtraction.
7670 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7671 ... -= ... Subtraction assignment.
7672 -A Access time in days since script started.
7673 -B File is a non-text (binary) file.
7674 -C Inode change time in days since script started.
7675 -M Age in days since script started.
7676 -O File is owned by real uid.
7677 -R File is readable by real uid.
7678 -S File is a socket .
7679 -T File is a text file.
7680 -W File is writable by real uid.
7681 -X File is executable by real uid.
7682 -b File is a block special file.
7683 -c File is a character special file.
7684 -d File is a directory.
7685 -e File exists .
7686 -f File is a plain file.
7687 -g File has setgid bit set.
7688 -k File has sticky bit set.
7689 -l File is a symbolic link.
7690 -o File is owned by effective uid.
7691 -p File is a named pipe (FIFO).
7692 -r File is readable by effective uid.
7693 -s File has non-zero size.
7694 -t Tests if filehandle (STDIN by default) is opened to a tty.
7695 -u File has setuid bit set.
7696 -w File is writable by effective uid.
7697 -x File is executable by effective uid.
7698 -z File has zero size.
7699 . Concatenate strings.
7700 .. Range (list context); flip/flop (scalar context) operator.
7701 .= Concatenate assignment strings
7702 ... / ... Division. /PATTERN/ioxsmg Pattern match
7703 ... /= ... Division assignment.
7704 /PATTERN/ioxsmg Pattern match.
7705 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
7706 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7707 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7708 <> Reads line from union of files in @ARGV (= command line) and STDIN.
7709 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7710 ... <= ... Numeric less than or equal to.
7711 ... <=> ... Numeric compare.
7712 ... = ... Assignment.
7713 ... == ... Numeric equality.
7714 ... =~ ... Search pattern, substitution, or translation
7715 ... > ... Numeric greater than.
7716 ... >= ... Numeric greater than or equal to.
7717 ... >> ... Bitwise shift right.
7718 ... >>= ... Bitwise shift right assignment.
7719 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7720 ?PATTERN? One-time pattern match.
7721 @ARGV Command line arguments (not including the command name - see $0).
7722 @INC List of places to look for perl scripts during do/include/use.
7723 @_ Parameter array for subroutines; result of split() unless in list context.
7724 \\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
7725 \\0 Octal char, e.g. \\033.
7726 \\E Case modification terminator. See \\Q, \\L, and \\U.
7727 \\L Lowercase until \\E . See also \\l, lc.
7728 \\U Upcase until \\E . See also \\u, uc.
7729 \\Q Quote metacharacters until \\E . See also quotemeta.
7730 \\a Alarm character (octal 007).
7731 \\b Backspace character (octal 010).
7732 \\c Control character, e.g. \\c[ .
7733 \\e Escape character (octal 033).
7734 \\f Formfeed character (octal 014).
7735 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
7736 \\n Newline character (octal 012 on most systems).
7737 \\r Return character (octal 015 on most systems).
7738 \\t Tab character (octal 011).
7739 \\u Upcase the next character. See also \\U and \\l, ucfirst.
7740 \\x Hex character, e.g. \\x1b.
7741 ... ^ ... Bitwise exclusive or.
7742 __END__ Ends program source.
7743 __DATA__ Ends program source.
7744 __FILE__ Current (source) filename.
7745 __LINE__ Current line in current source.
7746 __PACKAGE__ Current package.
7747 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7748 ARGVOUT Output filehandle with -i flag.
7749 BEGIN { ... } Immediately executed (during compilation) piece of code.
7750 END { ... } Pseudo-subroutine executed after the script finishes.
7751 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7752 INIT { ... } Pseudo-subroutine executed before the script starts running.
7753 DATA Input filehandle for what follows after __END__ or __DATA__.
7754 accept(NEWSOCKET,GENERICSOCKET)
7755 alarm(SECONDS)
7756 atan2(X,Y)
7757 bind(SOCKET,NAME)
7758 binmode(FILEHANDLE)
7759 caller[(LEVEL)]
7760 chdir(EXPR)
7761 chmod(LIST)
7762 chop[(LIST|VAR)]
7763 chown(LIST)
7764 chroot(FILENAME)
7765 close(FILEHANDLE)
7766 closedir(DIRHANDLE)
7767 ... cmp ... String compare.
7768 connect(SOCKET,NAME)
7769 continue of { block } continue { block }. Is executed after `next' or at end.
7770 cos(EXPR)
7771 crypt(PLAINTEXT,SALT)
7772 dbmclose(%HASH)
7773 dbmopen(%HASH,DBNAME,MODE)
7774 defined(EXPR)
7775 delete($HASH{KEY})
7776 die(LIST)
7777 do { ... }|SUBR while|until EXPR executes at least once
7778 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7779 dump LABEL
7780 each(%HASH)
7781 endgrent
7782 endhostent
7783 endnetent
7784 endprotoent
7785 endpwent
7786 endservent
7787 eof[([FILEHANDLE])]
7788 ... eq ... String equality.
7789 eval(EXPR) or eval { BLOCK }
7790 exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
7791 exit(EXPR)
7792 exp(EXPR)
7793 fcntl(FILEHANDLE,FUNCTION,SCALAR)
7794 fileno(FILEHANDLE)
7795 flock(FILEHANDLE,OPERATION)
7796 for (EXPR;EXPR;EXPR) { ... }
7797 foreach [VAR] (@ARRAY) { ... }
7798 fork
7799 ... ge ... String greater than or equal.
7800 getc[(FILEHANDLE)]
7801 getgrent
7802 getgrgid(GID)
7803 getgrnam(NAME)
7804 gethostbyaddr(ADDR,ADDRTYPE)
7805 gethostbyname(NAME)
7806 gethostent
7807 getlogin
7808 getnetbyaddr(ADDR,ADDRTYPE)
7809 getnetbyname(NAME)
7810 getnetent
7811 getpeername(SOCKET)
7812 getpgrp(PID)
7813 getppid
7814 getpriority(WHICH,WHO)
7815 getprotobyname(NAME)
7816 getprotobynumber(NUMBER)
7817 getprotoent
7818 getpwent
7819 getpwnam(NAME)
7820 getpwuid(UID)
7821 getservbyname(NAME,PROTO)
7822 getservbyport(PORT,PROTO)
7823 getservent
7824 getsockname(SOCKET)
7825 getsockopt(SOCKET,LEVEL,OPTNAME)
7826 gmtime(EXPR)
7827 goto LABEL
7828 ... gt ... String greater than.
7829 hex(EXPR)
7830 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7831 index(STR,SUBSTR[,OFFSET])
7832 int(EXPR)
7833 ioctl(FILEHANDLE,FUNCTION,SCALAR)
7834 join(EXPR,LIST)
7835 keys(%HASH)
7836 kill(LIST)
7837 last [LABEL]
7838 ... le ... String less than or equal.
7839 length(EXPR)
7840 link(OLDFILE,NEWFILE)
7841 listen(SOCKET,QUEUESIZE)
7842 local(LIST)
7843 localtime(EXPR)
7844 log(EXPR)
7845 lstat(EXPR|FILEHANDLE|VAR)
7846 ... lt ... String less than.
7847 m/PATTERN/iogsmx
7848 mkdir(FILENAME,MODE)
7849 msgctl(ID,CMD,ARG)
7850 msgget(KEY,FLAGS)
7851 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7852 msgsnd(ID,MSG,FLAGS)
7853 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
7854 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
7855 ... ne ... String inequality.
7856 next [LABEL]
7857 oct(EXPR)
7858 open(FILEHANDLE[,EXPR])
7859 opendir(DIRHANDLE,EXPR)
7860 ord(EXPR) ASCII value of the first char of the string.
7861 pack(TEMPLATE,LIST)
7862 package NAME Introduces package context.
7863 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7864 pop(ARRAY)
7865 print [FILEHANDLE] [(LIST)]
7866 printf [FILEHANDLE] (FORMAT,LIST)
7867 push(ARRAY,LIST)
7868 q/STRING/ Synonym for 'STRING'
7869 qq/STRING/ Synonym for \"STRING\"
7870 qx/STRING/ Synonym for `STRING`
7871 rand[(EXPR)]
7872 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7873 readdir(DIRHANDLE)
7874 readlink(EXPR)
7875 recv(SOCKET,SCALAR,LEN,FLAGS)
7876 redo [LABEL]
7877 rename(OLDNAME,NEWNAME)
7878 require [FILENAME | PERL_VERSION]
7879 reset[(EXPR)]
7880 return(LIST)
7881 reverse(LIST)
7882 rewinddir(DIRHANDLE)
7883 rindex(STR,SUBSTR[,OFFSET])
7884 rmdir(FILENAME)
7885 s/PATTERN/REPLACEMENT/gieoxsm
7886 scalar(EXPR)
7887 seek(FILEHANDLE,POSITION,WHENCE)
7888 seekdir(DIRHANDLE,POS)
7889 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7890 semctl(ID,SEMNUM,CMD,ARG)
7891 semget(KEY,NSEMS,SIZE,FLAGS)
7892 semop(KEY,...)
7893 send(SOCKET,MSG,FLAGS[,TO])
7894 setgrent
7895 sethostent(STAYOPEN)
7896 setnetent(STAYOPEN)
7897 setpgrp(PID,PGRP)
7898 setpriority(WHICH,WHO,PRIORITY)
7899 setprotoent(STAYOPEN)
7900 setpwent
7901 setservent(STAYOPEN)
7902 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7903 shift[(ARRAY)]
7904 shmctl(ID,CMD,ARG)
7905 shmget(KEY,SIZE,FLAGS)
7906 shmread(ID,VAR,POS,SIZE)
7907 shmwrite(ID,STRING,POS,SIZE)
7908 shutdown(SOCKET,HOW)
7909 sin(EXPR)
7910 sleep[(EXPR)]
7911 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7912 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7913 sort [SUBROUTINE] (LIST)
7914 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7915 split[(/PATTERN/[,EXPR[,LIMIT]])]
7916 sprintf(FORMAT,LIST)
7917 sqrt(EXPR)
7918 srand(EXPR)
7919 stat(EXPR|FILEHANDLE|VAR)
7920 study[(SCALAR)]
7921 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7922 substr(EXPR,OFFSET[,LEN])
7923 symlink(OLDFILE,NEWFILE)
7924 syscall(LIST)
7925 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7926 system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
7927 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7928 tell[(FILEHANDLE)]
7929 telldir(DIRHANDLE)
7930 time
7931 times
7932 tr/SEARCHLIST/REPLACEMENTLIST/cds
7933 truncate(FILE|EXPR,LENGTH)
7934 umask[(EXPR)]
7935 undef[(EXPR)]
7936 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7937 unlink(LIST)
7938 unpack(TEMPLATE,EXPR)
7939 unshift(ARRAY,LIST)
7940 until (EXPR) { ... } EXPR until EXPR
7941 utime(LIST)
7942 values(%HASH)
7943 vec(EXPR,OFFSET,BITS)
7944 wait
7945 waitpid(PID,FLAGS)
7946 wantarray Returns true if the sub/eval is called in list context.
7947 warn(LIST)
7948 while (EXPR) { ... } EXPR while EXPR
7949 write[(EXPR|FILEHANDLE)]
7950 ... x ... Repeat string or array.
7951 x= ... Repetition assignment.
7952 y/SEARCHLIST/REPLACEMENTLIST/
7953 ... | ... Bitwise or.
7954 ... || ... Logical or.
7955 ~ ... Unary bitwise complement.
7956 #! OS interpreter indicator. If contains `perl', used for options, and -x.
7957 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7958 CORE:: Prefix to access builtin function if imported sub obscures it.
7959 SUPER:: Prefix to lookup for a method in @ISA classes.
7960 DESTROY Shorthand for `sub DESTROY {...}'.
7961 ... EQ ... Obsolete synonym of `eq'.
7962 ... GE ... Obsolete synonym of `ge'.
7963 ... GT ... Obsolete synonym of `gt'.
7964 ... LE ... Obsolete synonym of `le'.
7965 ... LT ... Obsolete synonym of `lt'.
7966 ... NE ... Obsolete synonym of `ne'.
7967 abs [ EXPR ] absolute value
7968 ... and ... Low-precedence synonym for &&.
7969 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7970 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7971 chr Converts a number to char with the same ordinal.
7972 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7973 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7974 exists $HASH{KEY} True if the key exists.
7975 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7976 formline PICTURE, LIST Backdoor into \"format\" processing.
7977 glob EXPR Synonym of <EXPR>.
7978 lc [ EXPR ] Returns lowercased EXPR.
7979 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
7980 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
7981 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7982 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7983 not ... Low-precedence synonym for ! - negation.
7984 ... or ... Low-precedence synonym for ||.
7985 pos STRING Set/Get end-position of the last match over this string, see \\G.
7986 quotemeta [ EXPR ] Quote regexp metacharacters.
7987 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7988 readline FH Synonym of <FH>.
7989 readpipe CMD Synonym of `CMD`.
7990 ref [ EXPR ] Type of EXPR when dereferenced.
7991 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7992 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7993 tied Returns internal object for a tied data.
7994 uc [ EXPR ] Returns upcased EXPR.
7995 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
7996 untie VAR Unlink an object from a simple Perl variable.
7997 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
7998 ... xor ... Low-precedence synonym for exclusive or.
7999 prototype \\&SUB Returns prototype of the function given a reference.
8000 =head1 Top-level heading.
8001 =head2 Second-level heading.
8002 =head3 Third-level heading (is there such?).
8003 =over [ NUMBER ] Start list.
8004 =item [ TITLE ] Start new item in the list.
8005 =back End list.
8006 =cut Switch from POD to Perl.
8007 =pod Switch from Perl to POD.
8008 ")
8009
8010 (defun cperl-switch-to-doc-buffer (&optional interactive)
8011 "Go to the perl documentation buffer and insert the documentation."
8012 (interactive "p")
8013 (let ((buf (get-buffer-create cperl-doc-buffer)))
8014 (if interactive
8015 (switch-to-buffer-other-window buf)
8016 (set-buffer buf))
8017 (if (= (buffer-size) 0)
8018 (progn
8019 (insert (documentation-property 'cperl-short-docs
8020 'variable-documentation))
8021 (setq buffer-read-only t)))))
8022
8023 (defun cperl-beautify-regexp-piece (b e embed level)
8024 ;; b is before the starting delimiter, e before the ending
8025 ;; e should be a marker, may be changed, but remains "correct".
8026 ;; EMBED is nil if we process the whole REx.
8027 ;; The REx is guaranteed to have //x
8028 ;; LEVEL shows how many levels deep to go
8029 ;; position at enter and at leave is not defined
8030 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8031 (if embed
8032 (progn
8033 (goto-char b)
8034 (setq c (if (eq embed t) (current-indentation) (current-column)))
8035 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8036 (forward-char 2)
8037 (delete-char 1)
8038 (forward-char 1))
8039 ((looking-at "(\\?[^a-zA-Z]")
8040 (forward-char 3))
8041 ((looking-at "(\\?") ; (?i)
8042 (forward-char 2))
8043 (t
8044 (forward-char 1))))
8045 (goto-char (1+ b))
8046 (setq c (1- (current-column))))
8047 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
8048 (or (looking-at "[ \t]*[\n#]")
8049 (progn
8050 (insert "\n")))
8051 (goto-char e)
8052 (beginning-of-line)
8053 (if (re-search-forward "[^ \t]" e t)
8054 (progn ; Something before the ending delimiter
8055 (goto-char e)
8056 (delete-horizontal-space)
8057 (insert "\n")
8058 (cperl-make-indent c)
8059 (set-marker e (point))))
8060 (goto-char b)
8061 (end-of-line 2)
8062 (while (< (point) (marker-position e))
8063 (beginning-of-line)
8064 (setq s (point)
8065 inline t)
8066 (skip-chars-forward " \t")
8067 (delete-region s (point))
8068 (cperl-make-indent c1)
8069 (while (and
8070 inline
8071 (looking-at
8072 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8073 "\\|" ; Embedded variable
8074 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8075 "\\|" ; $ ^
8076 "[$^]"
8077 "\\|" ; simple-code simple-code*?
8078 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8079 "\\|" ; Class
8080 "\\(\\[\\)" ; 6
8081 "\\|" ; Grouping
8082 "\\((\\(\\?\\)?\\)" ; 7 8
8083 "\\|" ; |
8084 "\\(|\\)"))) ; 9
8085 (goto-char (match-end 0))
8086 (setq spaces t)
8087 (cond ((match-beginning 1) ; Alphanum word + junk
8088 (forward-char -1))
8089 ((or (match-beginning 3) ; $ab[12]
8090 (and (match-beginning 5) ; X* X+ X{2,3}
8091 (eq (preceding-char) ?\{)))
8092 (forward-char -1)
8093 (forward-sexp 1))
8094 ((and ; [], already syntaxified
8095 (match-beginning 6)
8096 cperl-regexp-scan
8097 cperl-use-syntax-table-text-property)
8098 (forward-char -1)
8099 (forward-sexp 1)
8100 (or (eq (preceding-char) ?\])
8101 (error "[]-group not terminated"))
8102 (re-search-forward
8103 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8104 ((match-beginning 6) ; []
8105 (setq tmp (point))
8106 (if (looking-at "\\^?\\]")
8107 (goto-char (match-end 0)))
8108 ;; XXXX POSIX classes?!
8109 (while (and (not pos)
8110 (re-search-forward "\\[:\\|\\]" e t))
8111 (if (eq (preceding-char) ?:)
8112 (or (re-search-forward ":\\]" e t)
8113 (error "[:POSIX:]-group in []-group not terminated"))
8114 (setq pos t)))
8115 (or (eq (preceding-char) ?\])
8116 (error "[]-group not terminated"))
8117 (re-search-forward
8118 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8119 ((match-beginning 7) ; ()
8120 (goto-char (match-beginning 0))
8121 (setq pos (current-column))
8122 (or (eq pos c1)
8123 (progn
8124 (delete-horizontal-space)
8125 (insert "\n")
8126 (cperl-make-indent c1)))
8127 (setq tmp (point))
8128 (forward-sexp 1)
8129 ;; (or (forward-sexp 1)
8130 ;; (progn
8131 ;; (goto-char tmp)
8132 ;; (error "()-group not terminated")))
8133 (set-marker m (1- (point)))
8134 (set-marker m1 (point))
8135 (if (= level 1)
8136 (if (progn ; indent rigidly if multiline
8137 ;; In fact does not make a lot of sense, since
8138 ;; the starting position can be already lost due
8139 ;; to insertion of "\n" and " "
8140 (goto-char tmp)
8141 (search-forward "\n" m1 t))
8142 (indent-rigidly (point) m1 (- c1 pos)))
8143 (setq level (1- level))
8144 (cond
8145 ((not (match-beginning 8))
8146 (cperl-beautify-regexp-piece tmp m t level))
8147 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8148 t)
8149 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8150 (goto-char (+ 2 tmp))
8151 (forward-sexp 1)
8152 (cperl-beautify-regexp-piece (point) m t level))
8153 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8154 (goto-char (+ 3 tmp))
8155 (cperl-beautify-regexp-piece (point) m t level))
8156 (t
8157 (cperl-beautify-regexp-piece tmp m t level))))
8158 (goto-char m1)
8159 (cond ((looking-at "[*+?]\\??")
8160 (goto-char (match-end 0)))
8161 ((eq (following-char) ?\{)
8162 (forward-sexp 1)
8163 (if (eq (following-char) ?\?)
8164 (forward-char))))
8165 (skip-chars-forward " \t")
8166 (setq spaces nil)
8167 (if (looking-at "[#\n]")
8168 (progn
8169 (or (eolp) (indent-for-comment))
8170 (beginning-of-line 2))
8171 (delete-horizontal-space)
8172 (insert "\n"))
8173 (end-of-line)
8174 (setq inline nil))
8175 ((match-beginning 9) ; |
8176 (forward-char -1)
8177 (setq tmp (point))
8178 (beginning-of-line)
8179 (if (re-search-forward "[^ \t]" tmp t)
8180 (progn
8181 (goto-char tmp)
8182 (delete-horizontal-space)
8183 (insert "\n"))
8184 ;; first at line
8185 (delete-region (point) tmp))
8186 (cperl-make-indent c)
8187 (forward-char 1)
8188 (skip-chars-forward " \t")
8189 (setq spaces nil)
8190 (if (looking-at "[#\n]")
8191 (beginning-of-line 2)
8192 (delete-horizontal-space)
8193 (insert "\n"))
8194 (end-of-line)
8195 (setq inline nil)))
8196 (or (looking-at "[ \t\n]")
8197 (not spaces)
8198 (insert " "))
8199 (skip-chars-forward " \t"))
8200 (or (looking-at "[#\n]")
8201 (error "Unknown code `%s' in a regexp"
8202 (buffer-substring (point) (1+ (point)))))
8203 (and inline (end-of-line 2)))
8204 ;; Special-case the last line of group
8205 (if (and (>= (point) (marker-position e))
8206 (/= (current-indentation) c))
8207 (progn
8208 (beginning-of-line)
8209 (cperl-make-indent c)))))
8210
8211 (defun cperl-make-regexp-x ()
8212 ;; Returns position of the start
8213 ;; XXX this is called too often! Need to cache the result!
8214 (save-excursion
8215 (or cperl-use-syntax-table-text-property
8216 (error "I need to have a regexp marked!"))
8217 ;; Find the start
8218 (if (looking-at "\\s|")
8219 nil ; good already
8220 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8221 (and (eq (preceding-char) ?q)
8222 (looking-at "\\(r\\)\\s|")))
8223 (goto-char (match-end 1))
8224 (re-search-backward "\\s|"))) ; Assume it is scanned already.
8225 ;;(forward-char 1)
8226 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8227 (sub-p (eq (preceding-char) ?s)) s)
8228 (forward-sexp 1)
8229 (set-marker e (1- (point)))
8230 (setq delim (preceding-char))
8231 (if (and sub-p (eq delim (char-after (- (point) 2))))
8232 (error "Possible s/blah// - do not know how to deal with"))
8233 (if sub-p (forward-sexp 1))
8234 (if (looking-at "\\sw*x")
8235 (setq have-x t)
8236 (insert "x"))
8237 ;; Protect fragile " ", "#"
8238 (if have-x nil
8239 (goto-char (1+ b))
8240 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8241 (forward-char -1)
8242 (insert "\\")
8243 (forward-char 1)))
8244 b)))
8245
8246 (defun cperl-beautify-regexp (&optional deep)
8247 "Do it. (Experimental, may change semantics, recheck the result.)
8248 We suppose that the regexp is scanned already."
8249 (interactive "P")
8250 (setq deep (if deep (prefix-numeric-value deep) -1))
8251 (save-excursion
8252 (goto-char (cperl-make-regexp-x))
8253 (let ((b (point)) (e (make-marker)))
8254 (forward-sexp 1)
8255 (set-marker e (1- (point)))
8256 (cperl-beautify-regexp-piece b e nil deep))))
8257
8258 (defun cperl-regext-to-level-start ()
8259 "Goto start of an enclosing group in regexp.
8260 We suppose that the regexp is scanned already."
8261 (interactive)
8262 (let ((limit (cperl-make-regexp-x)) done)
8263 (while (not done)
8264 (or (eq (following-char) ?\()
8265 (search-backward "(" (1+ limit) t)
8266 (error "Cannot find `(' which starts a group"))
8267 (setq done
8268 (save-excursion
8269 (skip-chars-backward "\\")
8270 (looking-at "\\(\\\\\\\\\\)*(")))
8271 (or done (forward-char -1)))))
8272
8273 (defun cperl-contract-level ()
8274 "Find an enclosing group in regexp and contract it.
8275 \(Experimental, may change semantics, recheck the result.)
8276 We suppose that the regexp is scanned already."
8277 (interactive)
8278 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
8279 (cperl-regext-to-level-start)
8280 (let ((b (point)) (e (make-marker)) c)
8281 (forward-sexp 1)
8282 (set-marker e (1- (point)))
8283 (goto-char b)
8284 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8285 (cond
8286 ((match-beginning 1) ; #-comment
8287 (or c (setq c (current-indentation)))
8288 (beginning-of-line 2) ; Skip
8289 (cperl-make-indent c))
8290 (t
8291 (delete-char -1)
8292 (just-one-space))))))
8293
8294 (defun cperl-contract-levels ()
8295 "Find an enclosing group in regexp and contract all the kids.
8296 \(Experimental, may change semantics, recheck the result.)
8297 We suppose that the regexp is scanned already."
8298 (interactive)
8299 (save-excursion
8300 (condition-case nil
8301 (cperl-regext-to-level-start)
8302 (error ; We are outside outermost group
8303 (goto-char (cperl-make-regexp-x))))
8304 (let ((b (point)) (e (make-marker)) s c)
8305 (forward-sexp 1)
8306 (set-marker e (1- (point)))
8307 (goto-char (1+ b))
8308 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
8309 (cond
8310 ((match-beginning 1) ; Skip
8311 nil)
8312 (t ; Group
8313 (cperl-contract-level)))))))
8314
8315 (defun cperl-beautify-level (&optional deep)
8316 "Find an enclosing group in regexp and beautify it.
8317 \(Experimental, may change semantics, recheck the result.)
8318 We suppose that the regexp is scanned already."
8319 (interactive "P")
8320 (setq deep (if deep (prefix-numeric-value deep) -1))
8321 (save-excursion
8322 (cperl-regext-to-level-start)
8323 (let ((b (point)) (e (make-marker)))
8324 (forward-sexp 1)
8325 (set-marker e (1- (point)))
8326 (cperl-beautify-regexp-piece b e 'level deep))))
8327
8328 (defun cperl-invert-if-unless-modifiers ()
8329 "Change `B if A;' into `if (A) {B}' etc if possible.
8330 \(Unfinished.)"
8331 (interactive)
8332 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8333 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8334 (and (= (char-syntax (preceding-char)) ?w)
8335 (forward-sexp -1))
8336 (setq pre-if (point))
8337 (cperl-backward-to-start-of-expr)
8338 (setq pre-B (point))
8339 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8340 (cperl-forward-to-end-of-expr)
8341 (setq post-A (point))
8342 (goto-char pre-if)
8343 (or (looking-at w-rex)
8344 ;; Find the position
8345 (progn (goto-char post-A)
8346 (while (and
8347 (not (looking-at w-rex))
8348 (> (point) pre-B))
8349 (forward-sexp -1))
8350 (setq pre-if (point))))
8351 (or (looking-at w-rex)
8352 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8353 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8354 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8355 ;; First, simple part: find code boundaries
8356 (forward-sexp 1)
8357 (setq post-if (point))
8358 (forward-sexp -2)
8359 (forward-sexp 1)
8360 (setq post-B (point))
8361 (cperl-backward-to-start-of-expr)
8362 (setq pre-B (point))
8363 (setq B (buffer-substring pre-B post-B))
8364 (goto-char pre-if)
8365 (forward-sexp 2)
8366 (forward-sexp -1)
8367 ;; May be after $, @, $# etc of a variable
8368 (skip-chars-backward "$@%#")
8369 (setq pre-A (point))
8370 (cperl-forward-to-end-of-expr)
8371 (setq post-A (point))
8372 (setq A (buffer-substring pre-A post-A))
8373 ;; Now modify (from end, to not break the stuff)
8374 (skip-chars-forward " \t;")
8375 (delete-region pre-A (point)) ; we move to pre-A
8376 (insert "\n" B ";\n}")
8377 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8378 (delete-region pre-if post-if)
8379 (delete-region pre-B post-B)
8380 (goto-char pre-B)
8381 (insert if-string " (" A ") {")
8382 (setq post-B (point))
8383 (if (looking-at "[ \t]+$")
8384 (delete-horizontal-space)
8385 (if (looking-at "[ \t]*#")
8386 (cperl-indent-for-comment)
8387 (just-one-space)))
8388 (forward-line 1)
8389 (if (looking-at "[ \t]*$")
8390 (progn ; delete line
8391 (delete-horizontal-space)
8392 (delete-region (point) (1+ (point)))))
8393 (cperl-indent-line)
8394 (goto-char (1- post-B))
8395 (forward-sexp 1)
8396 (cperl-indent-line)
8397 (goto-char pre-B)))
8398
8399 (defun cperl-invert-if-unless ()
8400 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8401 If the cursor is not on the leading keyword of the BLOCK flavor of
8402 construct, will assume it is the STATEMENT flavor, so will try to find
8403 the appropriate statement modifier."
8404 (interactive)
8405 (and (= (char-syntax (preceding-char)) ?w)
8406 (forward-sexp -1))
8407 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
8408 (let ((pre-if (point))
8409 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8410 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
8411 (forward-sexp 2)
8412 (setq post-A (point))
8413 (forward-sexp -1)
8414 (setq pre-A (point))
8415 (setq is-block (and (eq (following-char) ?\( )
8416 (save-excursion
8417 (condition-case nil
8418 (progn
8419 (forward-sexp 2)
8420 (forward-sexp -1)
8421 (eq (following-char) ?\{ ))
8422 (error nil)))))
8423 (if is-block
8424 (progn
8425 (goto-char post-A)
8426 (forward-sexp 1)
8427 (setq post-B (point))
8428 (forward-sexp -1)
8429 (setq pre-B (point))
8430 (if (and (eq (following-char) ?\{ )
8431 (progn
8432 (cperl-backward-to-noncomment post-A)
8433 (eq (preceding-char) ?\) )))
8434 (if (condition-case nil
8435 (progn
8436 (goto-char post-B)
8437 (forward-sexp 1)
8438 (forward-sexp -1)
8439 (looking-at "\\<els\\(e\\|if\\)\\>"))
8440 (error nil))
8441 (error
8442 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8443 (goto-char (1- post-B))
8444 (cperl-backward-to-noncomment pre-B)
8445 (if (eq (preceding-char) ?\;)
8446 (forward-char -1))
8447 (setq end-B-code (point))
8448 (goto-char pre-B)
8449 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
8450 (setq p (match-beginning 0)
8451 A (buffer-substring p (match-end 0))
8452 state (parse-partial-sexp pre-B p))
8453 (or (nth 3 state)
8454 (nth 4 state)
8455 (nth 5 state)
8456 (error "`%s' inside `%s' BLOCK" A if-string))
8457 (goto-char (match-end 0)))
8458 ;; Finally got it
8459 (goto-char (1+ pre-B))
8460 (skip-chars-forward " \t\n")
8461 (setq B (buffer-substring (point) end-B-code))
8462 (goto-char end-B-code)
8463 (or (looking-at ";?[ \t\n]*}")
8464 (progn
8465 (skip-chars-forward "; \t\n")
8466 (setq B-comment
8467 (buffer-substring (point) (1- post-B)))))
8468 (and (equal B "")
8469 (setq B "1"))
8470 (goto-char (1- post-A))
8471 (cperl-backward-to-noncomment pre-A)
8472 (or (looking-at "[ \t\n]*)")
8473 (goto-char (1- post-A)))
8474 (setq p (point))
8475 (goto-char (1+ pre-A))
8476 (skip-chars-forward " \t\n")
8477 (setq A (buffer-substring (point) p))
8478 (delete-region pre-B post-B)
8479 (delete-region pre-A post-A)
8480 (goto-char pre-if)
8481 (insert B " ")
8482 (and B-comment (insert B-comment " "))
8483 (just-one-space)
8484 (forward-word 1)
8485 (setq pre-A (point))
8486 (insert " " A ";")
8487 (delete-horizontal-space)
8488 (setq post-B (point))
8489 (if (looking-at "#")
8490 (indent-for-comment))
8491 (goto-char post-B)
8492 (forward-char -1)
8493 (delete-horizontal-space)
8494 (goto-char pre-A)
8495 (just-one-space)
8496 (goto-char pre-if)
8497 (setq pre-A (set-marker (make-marker) pre-A))
8498 (while (<= (point) (marker-position pre-A))
8499 (cperl-indent-line)
8500 (forward-line 1))
8501 (goto-char (marker-position pre-A))
8502 (if B-comment
8503 (progn
8504 (forward-line -1)
8505 (indent-for-comment)
8506 (goto-char (marker-position pre-A)))))
8507 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8508 ;; (error "`%s' not with an (EXPR)" if-string)
8509 (forward-sexp -1)
8510 (cperl-invert-if-unless-modifiers)))
8511 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8512 (cperl-invert-if-unless-modifiers)))
8513
8514 ;;; By Anthony Foiani <afoiani@uswest.com>
8515 ;;; Getting help on modules in C-h f ?
8516 ;;; This is a modified version of `man'.
8517 ;;; Need to teach it how to lookup functions
8518 ;;;###autoload
8519 (defun cperl-perldoc (word)
8520 "Run `perldoc' on WORD."
8521 (interactive
8522 (list (let* ((default-entry (cperl-word-at-point))
8523 (input (read-string
8524 (format "perldoc entry%s: "
8525 (if (string= default-entry "")
8526 ""
8527 (format " (default %s)" default-entry))))))
8528 (if (string= input "")
8529 (if (string= default-entry "")
8530 (error "No perldoc args given")
8531 default-entry)
8532 input))))
8533 (require 'man)
8534 (let* ((case-fold-search nil)
8535 (is-func (and
8536 (string-match "^[a-z]+$" word)
8537 (string-match (concat "^" word "\\>")
8538 (documentation-property
8539 'cperl-short-docs
8540 'variable-documentation))))
8541 (Man-switches "")
8542 (manual-program (if is-func "perldoc -f" "perldoc")))
8543 (cond
8544 ((featurep 'xemacs)
8545 (let ((Manual-program "perldoc")
8546 (Manual-switches (if is-func (list "-f"))))
8547 (manual-entry word)))
8548 (t
8549 (Man-getpage-in-background word)))))
8550
8551 ;;;###autoload
8552 (defun cperl-perldoc-at-point ()
8553 "Run a `perldoc' on the word around point."
8554 (interactive)
8555 (cperl-perldoc (cperl-word-at-point)))
8556
8557 (defcustom pod2man-program "pod2man"
8558 "*File name for `pod2man'."
8559 :type 'file
8560 :group 'cperl)
8561
8562 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
8563 (defun cperl-pod-to-manpage ()
8564 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8565 (interactive)
8566 (require 'man)
8567 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8568 (bufname (concat "Man " buffer-file-name))
8569 (buffer (generate-new-buffer bufname)))
8570 (with-current-buffer buffer
8571 (let ((process-environment (copy-sequence process-environment)))
8572 ;; Prevent any attempt to use display terminal fanciness.
8573 (setenv "TERM" "dumb")
8574 (set-process-sentinel
8575 (start-process pod2man-program buffer "sh" "-c"
8576 (format (cperl-pod2man-build-command) pod2man-args))
8577 'Man-bgproc-sentinel)))))
8578
8579 ;;; Updated version by him too
8580 (defun cperl-build-manpage ()
8581 "Create a virtual manpage in Emacs from the POD in the file."
8582 (interactive)
8583 (require 'man)
8584 (cond
8585 ((featurep 'xemacs)
8586 (let ((Manual-program "perldoc"))
8587 (manual-entry buffer-file-name)))
8588 (t
8589 (let* ((manual-program "perldoc")
8590 (Man-switches ""))
8591 (Man-getpage-in-background buffer-file-name)))))
8592
8593 (defun cperl-pod2man-build-command ()
8594 "Builds the entire background manpage and cleaning command."
8595 (let ((command (concat pod2man-program " %s 2>/dev/null"))
8596 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
8597 (while (and flist (car flist))
8598 (let ((pcom (car (car flist)))
8599 (pargs (cdr (car flist))))
8600 (setq command
8601 (concat command " | " pcom " "
8602 (mapconcat '(lambda (phrase)
8603 (if (not (stringp phrase))
8604 (error "Malformed Man-filter-list"))
8605 phrase)
8606 pargs " ")))
8607 (setq flist (cdr flist))))
8608 command))
8609
8610
8611 (defun cperl-next-interpolated-REx-1 ()
8612 "Move point to next REx which has interpolated parts without //o.
8613 Skips RExes consisting of one interpolated variable.
8614
8615 Note that skipped RExen are not performance hits."
8616 (interactive "")
8617 (cperl-next-interpolated-REx 1))
8618
8619 (defun cperl-next-interpolated-REx-0 ()
8620 "Move point to next REx which has interpolated parts without //o."
8621 (interactive "")
8622 (cperl-next-interpolated-REx 0))
8623
8624 (defun cperl-next-interpolated-REx (&optional skip beg limit)
8625 "Move point to next REx which has interpolated parts.
8626 SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8627 point and the limit of search (default to point and end of buffer).
8628
8629 SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8630 semantic may be used as a numeric argument.
8631
8632 Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8633 a result of qr//, this is not a performance hit), t for the rest."
8634 (interactive "P")
8635 (if (numberp skip) (setq skip (list 0 skip)))
8636 (or beg (setq beg (point)))
8637 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8638 (let (pp)
8639 (and (eq (get-text-property beg 'syntax-type) 'string)
8640 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8641 (cperl-map-pods-heres
8642 (function (lambda (s e p)
8643 (if (memq (get-text-property s 'REx-interpolated) skip)
8644 t
8645 (setq pp s)
8646 nil))) ; nil stops
8647 'REx-interpolated beg limit)
8648 (if pp (goto-char pp)
8649 (message "No more interpolated REx"))))
8650
8651 ;;; Initial version contributed by Trey Belew
8652 (defun cperl-here-doc-spell (&optional beg end)
8653 "Spell-check HERE-documents in the Perl buffer.
8654 If a region is highlighted, restricts to the region."
8655 (interactive "")
8656 (cperl-pod-spell t beg end))
8657
8658 (defun cperl-pod-spell (&optional do-heres beg end)
8659 "Spell-check POD documentation.
8660 If invoked with prefix argument, will do HERE-DOCs instead.
8661 If a region is highlighted, restricts to the region."
8662 (interactive "P")
8663 (save-excursion
8664 (let (beg end)
8665 (if (cperl-mark-active)
8666 (setq beg (min (mark) (point))
8667 end (max (mark) (point)))
8668 (setq beg (point-min)
8669 end (point-max)))
8670 (cperl-map-pods-heres (function
8671 (lambda (s e p)
8672 (if do-heres
8673 (setq e (save-excursion
8674 (goto-char e)
8675 (forward-line -1)
8676 (point))))
8677 (ispell-region s e)
8678 t))
8679 (if do-heres 'here-doc-group 'in-pod)
8680 beg end))))
8681
8682 (defun cperl-map-pods-heres (func &optional prop s end)
8683 "Executes a function over regions of pods or here-documents.
8684 PROP is the text-property to search for; default to `in-pod'. Stop when
8685 function returns nil."
8686 (let (pos posend has-prop (cont t))
8687 (or prop (setq prop 'in-pod))
8688 (or s (setq s (point-min)))
8689 (or end (setq end (point-max)))
8690 (cperl-update-syntaxification end end)
8691 (save-excursion
8692 (goto-char (setq pos s))
8693 (while (and cont (< pos end))
8694 (setq has-prop (get-text-property pos prop))
8695 (setq posend (next-single-property-change pos prop nil end))
8696 (and has-prop
8697 (setq cont (funcall func pos posend prop)))
8698 (setq pos posend)))))
8699
8700 ;;; Based on code by Masatake YAMATO:
8701 (defun cperl-get-here-doc-region (&optional pos pod)
8702 "Return HERE document region around the point.
8703 Return nil if the point is not in a HERE document region. If POD is non-nil,
8704 will return a POD section if point is in a POD section."
8705 (or pos (setq pos (point)))
8706 (cperl-update-syntaxification pos pos)
8707 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8708 (and pod
8709 (eq 'pod (get-text-property pos 'syntax-type))))
8710 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8711 (e (next-single-property-change pos 'syntax-type)))
8712 (cons b (or e (point-max))))))
8713
8714 (defun cperl-narrow-to-here-doc (&optional pos)
8715 "Narrows editing region to the HERE-DOC at POS.
8716 POS defaults to the point."
8717 (interactive "d")
8718 (or pos (setq pos (point)))
8719 (let ((p (cperl-get-here-doc-region pos)))
8720 (or p (error "Not inside a HERE document"))
8721 (narrow-to-region (car p) (cdr p))
8722 (message
8723 "When you are finished with narrow editing, type C-x n w")))
8724
8725 (defun cperl-select-this-pod-or-here-doc (&optional pos)
8726 "Select the HERE-DOC (or POD section) at POS.
8727 POS defaults to the point."
8728 (interactive "d")
8729 (let ((p (cperl-get-here-doc-region pos t)))
8730 (if p
8731 (progn
8732 (goto-char (car p))
8733 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8734 (message "I do not think POS is in POD or a HERE-doc..."))))
8735
8736 (defun cperl-facemenu-add-face-function (face end)
8737 "A callback to process user-initiated font-change requests.
8738 Translates `bold', `italic', and `bold-italic' requests to insertion of
8739 corresponding POD directives, and `underline' to C<> POD directive.
8740
8741 Such requests are usually bound to M-o LETTER."
8742 (or (get-text-property (point) 'in-pod)
8743 (error "Faces can only be set within POD"))
8744 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8745 (cdr (or (assq face '((bold . "B<")
8746 (italic . "I<")
8747 (bold-italic . "B<I<")
8748 (underline . "C<")))
8749 (error "Face %s not configured for cperl-mode"
8750 face))))
8751 \f
8752 (defun cperl-time-fontification (&optional l step lim)
8753 "Times how long it takes to do incremental fontification in a region.
8754 L is the line to start at, STEP is the number of lines to skip when
8755 doing next incremental fontification, LIM is the maximal number of
8756 incremental fontification to perform. Messages are accumulated in
8757 *Messages* buffer.
8758
8759 May be used for pinpointing which construct slows down buffer fontification:
8760 start with default arguments, then refine the slowdown regions."
8761 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8762 (or l (setq l 1))
8763 (or step (setq step 500))
8764 (or lim (setq lim 40))
8765 (let* ((timems (function (lambda ()
8766 (let ((tt (current-time)))
8767 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8768 (tt (funcall timems)) (c 0) delta tot)
8769 (goto-char (point-min))
8770 (forward-line (1- l))
8771 (cperl-mode)
8772 (setq tot (- (- tt (setq tt (funcall timems)))))
8773 (message "cperl-mode at %s: %s" l tot)
8774 (while (and (< c lim) (not (eobp)))
8775 (forward-line step)
8776 (setq l (+ l step))
8777 (setq c (1+ c))
8778 (cperl-update-syntaxification (point) (point))
8779 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8780 (message "to %s:%6s,%7s" l delta tot))
8781 tot))
8782
8783 (defvar font-lock-cache-position)
8784
8785 (defun cperl-emulate-lazy-lock (&optional window-size)
8786 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8787 Start fontifying the buffer from the start (or end) using the given
8788 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8789 goes backwards; default is -50. This function is not CPerl-specific; it
8790 may be used to debug problems with delayed incremental fontification."
8791 (interactive
8792 "nSize of window for incremental fontification, negative goes backwards: ")
8793 (or window-size (setq window-size -50))
8794 (let ((pos (if (> window-size 0)
8795 (point-min)
8796 (point-max)))
8797 p)
8798 (goto-char pos)
8799 (normal-mode)
8800 ;; Why needed??? With older font-locks???
8801 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8802 (while (if (> window-size 0)
8803 (< pos (point-max))
8804 (> pos (point-min)))
8805 (setq p (progn
8806 (forward-line window-size)
8807 (point)))
8808 (font-lock-fontify-region (min p pos) (max p pos))
8809 (setq pos p))))
8810
8811 \f
8812 (defun cperl-lazy-install ()) ; Avoid a warning
8813 (defun cperl-lazy-unstall ()) ; Avoid a warning
8814
8815 (if (fboundp 'run-with-idle-timer)
8816 (progn
8817 (defvar cperl-help-shown nil
8818 "Non-nil means that the help was already shown now.")
8819
8820 (defvar cperl-lazy-installed nil
8821 "Non-nil means that the lazy-help handlers are installed now.")
8822
8823 (defun cperl-lazy-install ()
8824 "Switches on Auto-Help on Perl constructs (put in the message area).
8825 Delay of auto-help controlled by `cperl-lazy-help-time'."
8826 (interactive)
8827 (make-local-variable 'cperl-help-shown)
8828 (if (and (cperl-val 'cperl-lazy-help-time)
8829 (not cperl-lazy-installed))
8830 (progn
8831 (add-hook 'post-command-hook 'cperl-lazy-hook)
8832 (run-with-idle-timer
8833 (cperl-val 'cperl-lazy-help-time 1000000 5)
8834 t
8835 'cperl-get-help-defer)
8836 (setq cperl-lazy-installed t))))
8837
8838 (defun cperl-lazy-unstall ()
8839 "Switches off Auto-Help on Perl constructs (put in the message area).
8840 Delay of auto-help controlled by `cperl-lazy-help-time'."
8841 (interactive)
8842 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8843 (cancel-function-timers 'cperl-get-help-defer)
8844 (setq cperl-lazy-installed nil))
8845
8846 (defun cperl-lazy-hook ()
8847 (setq cperl-help-shown nil))
8848
8849 (defun cperl-get-help-defer ()
8850 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
8851 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8852 (cperl-get-help)
8853 (setq cperl-help-shown t))))
8854 (cperl-lazy-install)))
8855
8856
8857 ;;; Plug for wrong font-lock:
8858
8859 (defun cperl-font-lock-unfontify-region-function (beg end)
8860 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8861 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8862 before-change-functions after-change-functions
8863 deactivate-mark buffer-file-name buffer-file-truename)
8864 (remove-text-properties beg end '(face nil))
8865 (if (and (not modified) (buffer-modified-p))
8866 (set-buffer-modified-p nil))))
8867
8868 (defun cperl-font-lock-fontify-region-function (beg end loudly)
8869 "Extends the region to safe positions, then calls the default function.
8870 Newer `font-lock's can do it themselves.
8871 We unwind only as far as needed for fontification. Syntaxification may
8872 do extra unwind via `cperl-unwind-to-safe'."
8873 (save-excursion
8874 (goto-char beg)
8875 (while (and beg
8876 (progn
8877 (beginning-of-line)
8878 (eq (get-text-property (setq beg (point)) 'syntax-type)
8879 'multiline)))
8880 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8881 (goto-char beg)))
8882 (setq beg (point))
8883 (goto-char end)
8884 (while (and end
8885 (progn
8886 (or (bolp) (condition-case nil
8887 (forward-line 1)
8888 (error nil)))
8889 (eq (get-text-property (setq end (point)) 'syntax-type)
8890 'multiline)))
8891 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8892 (goto-char end))
8893 (setq end (point)))
8894 (font-lock-default-fontify-region beg end loudly))
8895
8896 (defvar cperl-d-l nil)
8897 (defun cperl-fontify-syntaxically (end)
8898 ;; Some vars for debugging only
8899 ;; (message "Syntaxifying...")
8900 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
8901 (istate (car cperl-syntax-state))
8902 start from-start edebug-backtrace-buffer)
8903 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8904 (progn
8905 (require 'edebug)
8906 (let ((f 'edebug-backtrace))
8907 (funcall f)))) ; Avoid compile-time warning
8908 (or cperl-syntax-done-to
8909 (setq cperl-syntax-done-to (point-min)
8910 from-start t))
8911 (setq start (if (and cperl-hook-after-change
8912 (not from-start))
8913 cperl-syntax-done-to ; Fontify without change; ignore start
8914 ;; Need to forget what is after `start'
8915 (min cperl-syntax-done-to (point))))
8916 (goto-char start)
8917 (beginning-of-line)
8918 (setq start (point))
8919 (and cperl-syntaxify-unwind
8920 (setq end (cperl-unwind-to-safe t end)
8921 start (point)))
8922 (and (> end start)
8923 (setq cperl-syntax-done-to start) ; In case what follows fails
8924 (cperl-find-pods-heres start end t nil t))
8925 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8926 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8927 dbg iend start end idone cperl-syntax-done-to
8928 istate (car cperl-syntax-state))) ; For debugging
8929 nil)) ; Do not iterate
8930
8931 (defun cperl-fontify-update (end)
8932 (let ((pos (point-min)) prop posend)
8933 (setq end (point-max))
8934 (while (< pos end)
8935 (setq prop (get-text-property pos 'cperl-postpone)
8936 posend (next-single-property-change pos 'cperl-postpone nil end))
8937 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8938 (setq pos posend)))
8939 nil) ; Do not iterate
8940
8941 (defun cperl-fontify-update-bad (end)
8942 ;; Since fontification happens with different region than syntaxification,
8943 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8944 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8945 (if prop
8946 (setq pos (or (cperl-beginning-of-property
8947 (cperl-1+ pos) 'cperl-postpone)
8948 (point-min))))
8949 (while (< pos end)
8950 (setq posend (next-single-property-change pos 'cperl-postpone))
8951 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8952 (setq pos posend)
8953 (setq prop (get-text-property pos 'cperl-postpone))))
8954 nil) ; Do not iterate
8955
8956 ;; Called when any modification is made to buffer text.
8957 (defun cperl-after-change-function (beg end old-len)
8958 ;; We should have been informed about changes by `font-lock'. Since it
8959 ;; does not inform as which calls are defered, do it ourselves
8960 (if cperl-syntax-done-to
8961 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8962
8963 (defun cperl-update-syntaxification (from to)
8964 (if (and cperl-use-syntax-table-text-property
8965 cperl-syntaxify-by-font-lock
8966 (or (null cperl-syntax-done-to)
8967 (< cperl-syntax-done-to to)))
8968 (progn
8969 (save-excursion
8970 (goto-char from)
8971 (cperl-fontify-syntaxically to)))))
8972
8973 (defvar cperl-version
8974 (let ((v "Revision: 6.2"))
8975 (string-match ":\\s *\\([0-9.]+\\)" v)
8976 (substring v (match-beginning 1) (match-end 1)))
8977 "Version of IZ-supported CPerl package this file is based on.")
8978
8979 (defun cperl-mode-unload-function ()
8980 "Unload the Cperl mode library."
8981 (let ((new-mode (if (eq (symbol-function 'perl-mode) 'cperl-mode)
8982 'fundamental-mode
8983 'perl-mode)))
8984 (dolist (buf (buffer-list))
8985 (with-current-buffer buf
8986 (when (eq major-mode 'cperl-mode)
8987 (funcall new-mode)))))
8988 ;; continue standard unloading
8989 nil)
8990
8991 (provide 'cperl-mode)
8992
8993 ;;; cperl-mode.el ends here