1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1991-2017 Free Software Foundation, Inc.
5 ;; Author: Ilya Zakharevich
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: languages, Perl
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
29 ;; You can either fine-tune the bells and whistles of this mode or
30 ;; bulk enable them by putting
32 ;; (setq cperl-hairy t)
34 ;; in your .emacs file. (Emacs rulers do not consider it politically
35 ;; correct to make whistles enabled by default.)
37 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
38 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
39 ;; `cperl-praise', `cperl-speed'. <<<<<<
41 ;; The mode information (on C-h m) provides some customization help.
42 ;; If you use font-lock feature of this mode, it is advisable to use
43 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
45 ;; Faces used now: three faces for first-class and second-class keywords
46 ;; and control flow words, one for each: comments, string, labels,
47 ;; functions definitions and packages, arrays, hashes, and variable
48 ;; definitions. If you do not see all these faces, your font-lock does
49 ;; not define them, so you need to define them manually.
51 ;; This mode supports font-lock, imenu and mode-compile. In the
52 ;; hairy version font-lock is on, but you should activate imenu
53 ;; yourself (note that mode-compile is not standard yet). Well, you
54 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
55 ;; to bind it like that:
57 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
59 ;;; Font lock bugs as of v4.32:
61 ;; The following kinds of Perl code erroneously start strings:
63 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
64 ;; likewise with m, tr, y, q, qX instead of s
68 (defvar vc-rcs-header
)
69 (defvar vc-sccs-header
)
78 (defvar cperl-can-font-lock
79 (or (featurep 'xemacs
)
80 (and (boundp 'emacs-major-version
)
82 (> emacs-major-version
20)))))
83 (if cperl-can-font-lock
85 (defvar msb-menu-cond
)
86 (defvar gud-perldb-history
)
87 (defvar font-lock-background-mode
) ; not in Emacs
88 (defvar font-lock-display-type
) ; ditto
89 (defvar paren-backwards-message
) ; Not in newer XEmacs?
90 (or (fboundp 'defgroup
)
91 (defmacro defgroup
(name val doc
&rest arr
)
93 (or (fboundp 'custom-declare-variable
)
94 (defmacro defcustom
(name val doc
&rest arr
)
95 `(defvar ,name
,val
,doc
)))
96 (or (and (fboundp 'custom-declare-variable
)
97 (string< "19.31" emacs-version
)) ; Checked with 19.30: defface does not work
98 (defmacro defface
(&rest arr
)
100 ;; Avoid warning (tmp definitions)
101 (or (fboundp 'x-color-defined-p
)
102 (defmacro x-color-defined-p
(col)
103 (cond ((fboundp 'color-defined-p
) `(color-defined-p ,col
))
105 ((fboundp 'valid-color-name-p
) `(valid-color-name-p ,col
))
107 ((fboundp 'x-valid-color-name-p
) `(x-valid-color-name-p ,col
))
108 (t '(error "Cannot implement color-defined-p")))))
109 (defmacro cperl-is-face
(arg) ; Takes quoted arg
110 (cond ((fboundp 'find-face
)
112 (;;(and (fboundp 'face-list)
115 `(member ,arg
(and (fboundp 'face-list
)
119 (defmacro cperl-make-face
(arg descr
) ; Takes unquoted arg
120 (cond ((fboundp 'make-face
)
121 `(make-face (quote ,arg
)))
123 `(defvar ,arg
(quote ,arg
) ,descr
))))
124 (defmacro cperl-force-face
(arg descr
) ; Takes unquoted arg
126 (or (cperl-is-face (quote ,arg
))
127 (cperl-make-face ,arg
,descr
))
128 (or (boundp (quote ,arg
)) ; We use unquoted variants too
129 (defvar ,arg
(quote ,arg
) ,descr
))))
130 (if (featurep 'xemacs
)
131 (defmacro cperl-etags-snarf-tag
(file line
)
133 (beginning-of-line 2)
135 (defmacro cperl-etags-snarf-tag
(file line
)
137 (if (featurep 'xemacs
)
138 (defmacro cperl-etags-goto-tag-location
(elt)
140 ;; (switch-to-buffer (get-file-buffer (elt ,elt 0)))
141 ;; (set-buffer (get-file-buffer (elt ,elt 0)))
142 ;; Probably will not work due to some save-excursion???
143 ;; Or save-file-position?
144 ;; (message "Did I get to line %s?" (elt ,elt 1))
145 `(goto-line (string-to-int (elt ,elt
1))))
147 (defmacro cperl-etags-goto-tag-location
(elt)
148 `(etags-goto-tag-location ,elt
))))
150 (defvar cperl-can-font-lock
151 (or (featurep 'xemacs
)
152 (and (boundp 'emacs-major-version
)
154 (> emacs-major-version
20)))))
156 (defun cperl-choose-color (&rest list
)
160 (if (or (x-color-defined-p (car list
))
162 (setq answer
(car list
))))
163 (setq list
(cdr list
)))
167 "Major mode for editing Perl code."
172 (defgroup cperl-indentation-details nil
177 (defgroup cperl-affected-by-hairy nil
178 "Variables affected by `cperl-hairy'."
182 (defgroup cperl-autoinsert-details nil
183 "Auto-insert tuneup."
187 (defgroup cperl-faces nil
188 "Fontification colors."
189 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
193 (defgroup cperl-speed nil
194 "Speed vs. validity tuneup."
198 (defgroup cperl-help-system nil
199 "Help system tuneup."
204 (defcustom cperl-extra-newline-before-brace nil
205 "Non-nil means that if, elsif, while, until, else, for, foreach
206 and do constructs look like:
217 :group
'cperl-autoinsert-details
)
219 (defcustom cperl-extra-newline-before-brace-multiline
220 cperl-extra-newline-before-brace
221 "Non-nil means the same as `cperl-extra-newline-before-brace', but
222 for constructs with multiline if/unless/while/until/for/foreach condition."
224 :group
'cperl-autoinsert-details
)
226 (defcustom cperl-indent-level
2
227 "Indentation of CPerl statements with respect to containing block."
229 :group
'cperl-indentation-details
)
231 ;; Is is not unusual to put both things like perl-indent-level and
232 ;; cperl-indent-level in the local variable section of a file. If only
233 ;; one of perl-mode and cperl-mode is in use, a warning will be issued
234 ;; about the variable. Autoload these here, so that no warning is
235 ;; issued when using either perl-mode or cperl-mode.
236 ;;;###autoload(put 'cperl-indent-level 'safe-local-variable 'integerp)
237 ;;;###autoload(put 'cperl-brace-offset 'safe-local-variable 'integerp)
238 ;;;###autoload(put 'cperl-continued-brace-offset 'safe-local-variable 'integerp)
239 ;;;###autoload(put 'cperl-label-offset 'safe-local-variable 'integerp)
240 ;;;###autoload(put 'cperl-continued-statement-offset 'safe-local-variable 'integerp)
241 ;;;###autoload(put 'cperl-extra-newline-before-brace 'safe-local-variable 'booleanp)
242 ;;;###autoload(put 'cperl-merge-trailing-else 'safe-local-variable 'booleanp)
244 (defcustom cperl-lineup-step nil
245 "`cperl-lineup' will always lineup at multiple of this number.
246 If nil, the value of `cperl-indent-level' will be used."
247 :type
'(choice (const nil
) integer
)
248 :group
'cperl-indentation-details
)
250 (defcustom cperl-brace-imaginary-offset
0
251 "Imagined indentation of a Perl open brace that actually follows a statement.
252 An open brace following other text is treated as if it were this far
253 to the right of the start of its line."
255 :group
'cperl-indentation-details
)
257 (defcustom cperl-brace-offset
0
258 "Extra indentation for braces, compared with other text in same context."
260 :group
'cperl-indentation-details
)
261 (defcustom cperl-label-offset -
2
262 "Offset of CPerl label lines relative to usual indentation."
264 :group
'cperl-indentation-details
)
265 (defcustom cperl-min-label-indent
1
266 "Minimal offset of CPerl label lines."
268 :group
'cperl-indentation-details
)
269 (defcustom cperl-continued-statement-offset
2
270 "Extra indent for lines not starting new statements."
272 :group
'cperl-indentation-details
)
273 (defcustom cperl-continued-brace-offset
0
274 "Extra indent for substatements that start with open-braces.
275 This is in addition to cperl-continued-statement-offset."
277 :group
'cperl-indentation-details
)
278 (defcustom cperl-close-paren-offset -
1
279 "Extra indent for substatements that start with close-parenthesis."
281 :group
'cperl-indentation-details
)
283 (defcustom cperl-indent-wrt-brace t
284 "Non-nil means indent statements in if/etc block relative brace, not if/etc.
285 Versions 5.2 ... 5.20 behaved as if this were nil."
287 :group
'cperl-indentation-details
)
289 (defcustom cperl-auto-newline nil
290 "Non-nil means automatically newline before and after braces,
291 and after colons and semicolons, inserted in CPerl code. The following
292 \\[cperl-electric-backspace] will remove the inserted whitespace.
293 Insertion after colons requires both this variable and
294 `cperl-auto-newline-after-colon' set."
296 :group
'cperl-autoinsert-details
)
298 (defcustom cperl-autoindent-on-semi nil
299 "Non-nil means automatically indent after insertion of (semi)colon.
300 Active if `cperl-auto-newline' is false."
302 :group
'cperl-autoinsert-details
)
304 (defcustom cperl-auto-newline-after-colon nil
305 "Non-nil means automatically newline even after colons.
306 Subject to `cperl-auto-newline' setting."
308 :group
'cperl-autoinsert-details
)
310 (defcustom cperl-tab-always-indent t
311 "Non-nil means TAB in CPerl mode should always reindent the current line,
312 regardless of where in the line point is when the TAB command is used."
314 :group
'cperl-indentation-details
)
316 (defcustom cperl-font-lock nil
317 "Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
318 Can be overwritten by `cperl-hairy' if nil."
319 :type
'(choice (const null
) boolean
)
320 :group
'cperl-affected-by-hairy
)
322 (defcustom cperl-electric-lbrace-space nil
323 "Non-nil (and non-null) means { after $ should be preceded by ` '.
324 Can be overwritten by `cperl-hairy' if nil."
325 :type
'(choice (const null
) boolean
)
326 :group
'cperl-affected-by-hairy
)
328 (defcustom cperl-electric-parens-string
"({[]})<"
329 "String of parentheses that should be electric in CPerl.
330 Closing ones are electric only if the region is highlighted."
332 :group
'cperl-affected-by-hairy
)
334 (defcustom cperl-electric-parens nil
335 "Non-nil (and non-null) means parentheses should be electric in CPerl.
336 Can be overwritten by `cperl-hairy' if nil."
337 :type
'(choice (const null
) boolean
)
338 :group
'cperl-affected-by-hairy
)
340 (defvar zmacs-regions
) ; Avoid warning
342 (defcustom cperl-electric-parens-mark
344 (or (and (boundp 'transient-mark-mode
) ; For Emacs
346 (and (boundp 'zmacs-regions
) ; For XEmacs
348 "Not-nil means that electric parens look for active mark.
349 Default is yes if there is visual feedback on mark."
351 :group
'cperl-autoinsert-details
)
353 (defcustom cperl-electric-linefeed nil
354 "If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
355 In any case these two mean plain and hairy linefeeds together.
356 Can be overwritten by `cperl-hairy' if nil."
357 :type
'(choice (const null
) boolean
)
358 :group
'cperl-affected-by-hairy
)
360 (defcustom cperl-electric-keywords nil
361 "Not-nil (and non-null) means keywords are electric in CPerl.
362 Can be overwritten by `cperl-hairy' if nil.
364 Uses `abbrev-mode' to do the expansion. If you want to use your
365 own abbrevs in cperl-mode, but do not want keywords to be
366 electric, you must redefine `cperl-mode-abbrev-table': do
367 \\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in
368 that paragraph, delete the words that appear at the ends of lines and
369 that begin with \"cperl-electric\".
371 :type
'(choice (const null
) boolean
)
372 :group
'cperl-affected-by-hairy
)
374 (defcustom cperl-electric-backspace-untabify t
375 "Not-nil means electric-backspace will untabify in CPerl."
377 :group
'cperl-autoinsert-details
)
379 (defcustom cperl-hairy nil
380 "Not-nil means most of the bells and whistles are enabled in CPerl.
381 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
382 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
383 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
384 `cperl-lazy-help-time'."
386 :group
'cperl-affected-by-hairy
)
388 (defcustom cperl-comment-column
32
389 "Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
391 :group
'cperl-indentation-details
)
393 (defcustom cperl-indent-comment-at-column-0 nil
394 "Non-nil means that comment started at column 0 should be indentable."
396 :group
'cperl-indentation-details
)
398 (defcustom cperl-vc-sccs-header
'("($sccs) = ('%W\ %' =~ /(\\d+(\\.\\d+)+)/) ;")
399 "Special version of `vc-sccs-header' that is used in CPerl mode buffers."
400 :type
'(repeat string
)
403 (defcustom cperl-vc-rcs-header
'("($rcs) = (' $Id\ $ ' =~ /(\\d+(\\.\\d+)+)/);")
404 "Special version of `vc-rcs-header' that is used in CPerl mode buffers."
405 :type
'(repeat string
)
408 ;; This became obsolete...
409 (defvar cperl-vc-header-alist nil
)
410 (make-obsolete-variable
411 'cperl-vc-header-alist
412 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead."
415 ;; (defcustom cperl-clobber-mode-lists
418 ;; (boundp 'interpreter-mode-alist)
419 ;; (assoc "miniperl" interpreter-mode-alist)
420 ;; (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
421 ;; "Whether to install us into `interpreter-' and `extension' mode lists."
425 (defcustom cperl-info-on-command-no-prompt nil
426 "Not-nil (and non-null) means not to prompt on C-h f.
427 The opposite behavior is always available if prefixed with C-c.
428 Can be overwritten by `cperl-hairy' if nil."
429 :type
'(choice (const null
) boolean
)
430 :group
'cperl-affected-by-hairy
)
432 (defcustom cperl-clobber-lisp-bindings nil
433 "Not-nil (and non-null) means not overwrite C-h f.
434 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
435 Can be overwritten by `cperl-hairy' if nil."
436 :type
'(choice (const null
) boolean
)
437 :group
'cperl-affected-by-hairy
)
439 (defcustom cperl-lazy-help-time nil
440 "Not-nil (and non-null) means to show lazy help after given idle time.
441 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
442 :type
'(choice (const null
) (const nil
) integer
)
443 :group
'cperl-affected-by-hairy
)
445 (defcustom cperl-pod-face
'font-lock-comment-face
446 "Face for POD highlighting."
450 (defcustom cperl-pod-head-face
'font-lock-variable-name-face
451 "Face for POD highlighting.
452 Font for POD headers."
456 (defcustom cperl-here-face
'font-lock-string-face
457 "Face for here-docs highlighting."
461 ;;; Some double-evaluation happened with font-locks... Needed with 21.2...
462 (defvar cperl-singly-quote-face
(featurep 'xemacs
))
464 (defcustom cperl-invalid-face
'underline
465 "Face for highlighting trailing whitespace."
470 (defcustom cperl-pod-here-fontify
'(featurep 'font-lock
)
471 "Not-nil after evaluation means to highlight POD and here-docs sections."
475 (defcustom cperl-fontify-m-as-s t
476 "Not-nil means highlight 1arg regular expressions operators same as 2arg."
480 (defcustom cperl-highlight-variables-indiscriminately nil
481 "Non-nil means perform additional highlighting on variables.
482 Currently only changes how scalar variables are highlighted.
483 Note that that variable is only read at initialization time for
484 the variable `cperl-font-lock-keywords-2', so changing it after you've
485 entered CPerl mode the first time will have no effect."
489 (defcustom cperl-pod-here-scan t
490 "Not-nil means look for POD and here-docs sections during startup.
491 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
495 (defcustom cperl-regexp-scan t
496 "Not-nil means make marking of regular expression more thorough.
497 Effective only with `cperl-pod-here-scan'."
501 (defcustom cperl-hook-after-change t
502 "Not-nil means install hook to know which regions of buffer are changed.
503 May significantly speed up delayed fontification. Changes take effect
508 (defcustom cperl-imenu-addback nil
509 "Not-nil means add backreferences to generated `imenu's.
510 May require patched `imenu' and `imenu-go'. Obsolete."
512 :group
'cperl-help-system
)
514 (defcustom cperl-max-help-size
66
515 "Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
516 :type
'(choice integer
(const nil
))
517 :group
'cperl-help-system
)
519 (defcustom cperl-shrink-wrap-info-frame t
520 "Non-nil means shrink-wrapping of info-buffer-frame allowed."
522 :group
'cperl-help-system
)
524 (defcustom cperl-info-page
"perl"
525 "Name of the info page containing perl docs.
526 Older version of this page was called `perl5', newer `perl'."
528 :group
'cperl-help-system
)
530 (defcustom cperl-use-syntax-table-text-property
531 (boundp 'parse-sexp-lookup-properties
)
532 "Non-nil means CPerl sets up and uses `syntax-table' text property."
536 (defcustom cperl-use-syntax-table-text-property-for-tags
537 cperl-use-syntax-table-text-property
538 "Non-nil means: set up and use `syntax-table' text property generating TAGS."
542 (defcustom cperl-scan-files-regexp
"\\.\\([pP][Llm]\\|xs\\)$"
543 "Regexp to match files to scan when generating TAGS."
547 (defcustom cperl-noscan-files-regexp
548 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
549 "Regexp to match files/dirs to skip when generating TAGS."
553 (defcustom cperl-regexp-indent-step nil
554 "Indentation used when beautifying regexps.
555 If nil, the value of `cperl-indent-level' will be used."
556 :type
'(choice integer
(const nil
))
557 :group
'cperl-indentation-details
)
559 (defcustom cperl-indent-left-aligned-comments t
560 "Non-nil means that the comment starting in leftmost column should indent."
562 :group
'cperl-indentation-details
)
564 (defcustom cperl-under-as-char nil
565 "Non-nil means that the _ (underline) should be treated as word char."
568 (make-obsolete-variable 'cperl-under-as-char
'superword-mode
"24.4")
570 (defcustom cperl-extra-perl-args
""
571 "Extra arguments to use when starting Perl.
572 Currently used with `cperl-check-syntax' only."
576 (defcustom cperl-message-electric-keyword t
577 "Non-nil means that the `cperl-electric-keyword' prints a help message."
579 :group
'cperl-help-system
)
581 (defcustom cperl-indent-region-fix-constructs
1
582 "Amount of space to insert between `}' and `else' or `elsif'
583 in `cperl-indent-region'. Set to nil to leave as is. Values other
584 than 1 and nil will probably not work."
585 :type
'(choice (const nil
) (const 1))
586 :group
'cperl-indentation-details
)
588 (defcustom cperl-break-one-line-blocks-when-indent t
589 "Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
590 need to be reformatted into multiline ones when indenting a region."
592 :group
'cperl-indentation-details
)
594 (defcustom cperl-fix-hanging-brace-when-indent t
595 "Non-nil means that BLOCK-end `}' may be put on a separate line
596 when indenting a region.
597 Braces followed by else/elsif/while/until are excepted."
599 :group
'cperl-indentation-details
)
601 (defcustom cperl-merge-trailing-else t
602 "Non-nil means that BLOCK-end `}' followed by else/elsif/continue
603 may be merged to be on the same line when indenting a region."
605 :group
'cperl-indentation-details
)
607 (defcustom cperl-indent-parens-as-block nil
608 "Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
609 but for trailing \",\" inside the group, which won't increase indentation.
610 One should tune up `cperl-close-paren-offset' as well."
612 :group
'cperl-indentation-details
)
614 (defcustom cperl-syntaxify-by-font-lock
615 (and cperl-can-font-lock
616 (boundp 'parse-sexp-lookup-properties
))
617 "Non-nil means that CPerl uses the `font-lock' routines for syntaxification."
618 :type
'(choice (const message
) boolean
)
621 (defcustom cperl-syntaxify-unwind
623 "Non-nil means that CPerl unwinds to a start of a long construction
624 when syntaxifying a chunk of buffer."
628 (defcustom cperl-syntaxify-for-menu
630 "Non-nil means that CPerl syntaxifies up to the point before showing menu.
631 This way enabling/disabling of menu items is more correct."
635 (defcustom cperl-ps-print-face-properties
636 '((font-lock-keyword-face nil nil bold shadow
)
637 (font-lock-variable-name-face nil nil bold
)
638 (font-lock-function-name-face nil nil bold italic box
)
639 (font-lock-constant-face nil
"LightGray" bold
)
640 (cperl-array-face nil
"LightGray" bold underline
)
641 (cperl-hash-face nil
"LightGray" bold italic underline
)
642 (font-lock-comment-face nil
"LightGray" italic
)
643 (font-lock-string-face nil nil italic underline
)
644 (cperl-nonoverridable-face nil nil italic underline
)
645 (font-lock-type-face nil nil underline
)
646 (font-lock-warning-face nil
"LightGray" bold italic box
)
647 (underline nil
"LightGray" strikeout
))
648 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
649 :type
'(repeat (cons symbol
650 (cons (choice (const nil
) string
)
651 (cons (choice (const nil
) string
)
655 (defvar cperl-dark-background
656 (cperl-choose-color "navy" "os2blue" "darkgreen"))
657 (defvar cperl-dark-foreground
658 (cperl-choose-color "orchid1" "orange"))
660 (defface cperl-nonoverridable-face
661 `((((class grayscale
) (background light
))
662 (:background
"Gray90" :slant italic
:underline t
))
663 (((class grayscale
) (background dark
))
664 (:foreground
"Gray80" :slant italic
:underline t
:weight bold
))
665 (((class color
) (background light
))
666 (:foreground
"chartreuse3"))
667 (((class color
) (background dark
))
668 (:foreground
,cperl-dark-foreground
))
669 (t (:weight bold
:underline t
)))
670 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
673 (defface cperl-array-face
674 `((((class grayscale
) (background light
))
675 (:background
"Gray90" :weight bold
))
676 (((class grayscale
) (background dark
))
677 (:foreground
"Gray80" :weight bold
))
678 (((class color
) (background light
))
679 (:foreground
"Blue" :background
"lightyellow2" :weight bold
))
680 (((class color
) (background dark
))
681 (:foreground
"yellow" :background
,cperl-dark-background
:weight bold
))
683 "Font Lock mode face used to highlight array names."
686 (defface cperl-hash-face
687 `((((class grayscale
) (background light
))
688 (:background
"Gray90" :weight bold
:slant italic
))
689 (((class grayscale
) (background dark
))
690 (:foreground
"Gray80" :weight bold
:slant italic
))
691 (((class color
) (background light
))
692 (:foreground
"Red" :background
"lightyellow2" :weight bold
:slant italic
))
693 (((class color
) (background dark
))
694 (:foreground
"Red" :background
,cperl-dark-background
:weight bold
:slant italic
))
695 (t (:weight bold
:slant italic
)))
696 "Font Lock mode face used to highlight hash names."
701 ;;; Short extra-docs.
703 (defvar cperl-tips
'please-ignore-this-line
704 "Get maybe newer version of this package from
705 http://ilyaz.org/software/emacs
706 Subdirectory `cperl-mode' may contain yet newer development releases and/or
707 patches to related files.
709 For best results apply to an older Emacs the patches from
710 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
711 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
712 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
713 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
715 Get support packages choose-color.el (or font-lock-extra.el before
716 19.30), imenu-go.el from the same place. \(Look for other files there
717 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
718 later you should use choose-color.el *instead* of font-lock-extra.el
719 \(and you will not get smart highlighting in C :-().
721 Note that to enable Compile choices in the menu you need to install
724 If your Emacs does not default to `cperl-mode' on Perl files, and you
725 want it to: put the following into your .emacs file:
727 (defalias \\='perl-mode \\='cperl-mode)
730 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
731 Also, one can generate a newer documentation running `pod2texi' converter
732 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
734 If you use imenu-go, run imenu on perl5-info buffer (you can do it
735 from Perl menu). If many files are related, generate TAGS files from
736 Tools/Tags submenu in Perl menu.
738 If some class structure is too complicated, use Tools/Hierarchy-view
739 from Perl menu, or hierarchic view of imenu. The second one uses the
740 current buffer only, the first one requires generation of TAGS from
741 Perl/Tools/Tags menu beforehand.
743 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
745 Switch auto-help on/off with Perl/Tools/Auto-help.
747 Though with contemporary Emaxen CPerl mode should maintain the correct
748 parsing of Perl even when editing, sometimes it may be lost. Fix this by
752 In cases of more severe confusion sometimes it is helpful to do
754 \\[load-library] cperl-mode RET
757 Before reporting (non-)problems look in the problem section of online
758 micro-docs on what I know about CPerl problems.")
760 (defvar cperl-problems
'please-ignore-this-line
761 "Description of problems in CPerl mode.
762 Some faces will not be shown on some versions of Emacs unless you
763 install choose-color.el, available from
764 http://ilyaz.org/software/emacs
766 `fill-paragraph' on a comment may leave the point behind the
767 paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
768 to detect it and bulk out).
770 See documentation of a variable `cperl-problems-old-emaxen' for the
771 problems which disappear if you upgrade Emacs to a reasonably new
772 version (20.3 for Emacs, and those of 2004 for XEmacs).")
774 (defvar cperl-problems-old-emaxen
'please-ignore-this-line
775 "Description of problems in CPerl mode specific for older Emacs versions.
777 Emacs had a _very_ restricted syntax parsing engine until version
778 20.1. Most problems below are corrected starting from this version of
779 Emacs, and all of them should be fixed in version 20.3. (Or apply
780 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
781 this respect (until 2003).
783 Note that even with newer Emacsen in some very rare cases the details
784 of interaction of `font-lock' and syntaxification may be not cleaned
785 up yet. You may get slightly different colors basing on the order of
786 fontification and syntaxification. Say, the initial faces is correct,
787 but editing the buffer breaks this.
789 Even with older Emacsen CPerl mode tries to corrects some Emacs
790 misunderstandings, however, for efficiency reasons the degree of
791 correction is different for different operations. The partially
792 corrected problems are: POD sections, here-documents, regexps. The
793 operations are: highlighting, indentation, electric keywords, electric
796 This may be confusing, since the regexp s#//#/#; may be highlighted
797 as a comment, but it will be recognized as a regexp by the indentation
798 code. Or the opposite case, when a POD section is highlighted, but
799 may break the indentation of the following code (though indentation
800 should work if the balance of delimiters is not broken by POD).
802 The main trick (to make $ a \"backslash\") makes constructions like
803 ${aaa} look like unbalanced braces. The only trick I can think of is
804 to insert it as $ {aaa} (valid in perl5, not in perl4).
806 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
807 as /($|\\s)/. Note that such a transposition is not always possible.
809 The solution is to upgrade your Emacs or patch an older one. Note
810 that Emacs 20.2 has some bugs related to `syntax-table' text
811 properties. Patches are available on the main CPerl download site,
814 If these bugs cannot be fixed on your machine (say, you have an inferior
815 environment and cannot recompile), you may still disable all the fancy stuff
816 via `cperl-use-syntax-table-text-property'.")
818 (defvar cperl-praise
'please-ignore-this-line
819 "Advantages of CPerl mode.
821 0) It uses the newest `syntax-table' property ;-);
823 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
824 mode - but the latter number may have improved too in last years) even
825 with old Emaxen which do not support `syntax-table' property.
827 When using `syntax-table' property for syntax assist hints, it should
828 handle 99.995% of lines correct - or somesuch. It automatically
829 updates syntax assist hints when you edit your script.
831 2) It is generally believed to be \"the most user-friendly Emacs
832 package\" whatever it may mean (I doubt that the people who say similar
833 things tried _all_ the rest of Emacs ;-), but this was not a lonely
836 3) Everything is customizable, one-by-one or in a big sweep;
838 4) It has many easily-accessible \"tools\":
839 a) Can run program, check syntax, start debugger;
840 b) Can lineup vertically \"middles\" of rows, like `=' in
843 c) Can insert spaces where this improves readability (in one
844 interactive sweep over the buffer);
845 d) Has support for imenu, including:
846 1) Separate unordered list of \"interesting places\";
847 2) Separate TOC of POD sections;
848 3) Separate list of packages;
849 4) Hierarchical view of methods in (sub)packages;
850 5) and functions (by the full name - with package);
851 e) Has an interface to INFO docs for Perl; The interface is
852 very flexible, including shrink-wrapping of
853 documentation buffer/frame;
854 f) Has a builtin list of one-line explanations for perl constructs.
855 g) Can show these explanations if you stay long enough at the
856 corresponding place (or on demand);
857 h) Has an enhanced fontification (using 3 or 4 additional faces
858 comparing to font-lock - basically, different
859 namespaces in Perl have different colors);
860 i) Can construct TAGS basing on its knowledge of Perl syntax,
861 the standard menu has 6 different way to generate
862 TAGS (if \"by directory\", .xs files - with C-language
863 bindings - are included in the scan);
864 j) Can build a hierarchical view of classes (via imenu) basing
865 on generated TAGS file;
866 k) Has electric parentheses, electric newlines, uses Abbrev
867 for electric logical constructs
869 with different styles of expansion (context sensitive
870 to be not so bothering). Electric parentheses behave
871 \"as they should\" in a presence of a visible region.
872 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
878 n) Highlights (by user-choice) either 3-delimiters constructs
879 (such as tr/a/b/), or regular expressions and `y/tr';
880 o) Highlights trailing whitespace;
881 p) Is able to manipulate Perl Regular Expressions to ease
882 conversion to a more readable form.
883 q) Can ispell POD sections and HERE-DOCs.
884 r) Understands comments and character classes inside regular
885 expressions; can find matching () and [] in a regular expression.
886 s) Allows indentation of //x-style regular expressions;
887 t) Highlights different symbols in regular expressions according
888 to their function; much less problems with backslashitis;
889 u) Allows to find regular expressions which contain interpolated parts.
891 5) The indentation engine was very smart, but most of tricks may be
892 not needed anymore with the support for `syntax-table' property. Has
893 progress indicator for indentation (with `imenu' loaded).
895 6) Indent-region improves inline-comments as well; also corrects
896 whitespace *inside* the conditional/loop constructs.
898 7) Fill-paragraph correctly handles multi-line comments;
900 8) Can switch to different indentation styles by one command, and restore
901 the settings present before the switch.
903 9) When doing indentation of control constructs, may correct
904 line-breaks/spacing between elements of the construct.
906 10) Uses a linear-time algorithm for indentation of regions (on Emaxen with
907 capable syntax engines).
909 11) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
912 (defvar cperl-speed
'please-ignore-this-line
913 "This is an incomplete compendium of what is available in other parts
914 of CPerl documentation. (Please inform me if I skept anything.)
916 There is a perception that CPerl is slower than alternatives. This part
917 of documentation is designed to overcome this misconception.
919 *By default* CPerl tries to enable the most comfortable settings.
920 From most points of view, correctly working package is infinitely more
921 comfortable than a non-correctly working one, thus by default CPerl
922 prefers correctness over speed. Below is the guide how to change
923 settings if your preferences are different.
925 A) Speed of loading the file. When loading file, CPerl may perform a
926 scan which indicates places which cannot be parsed by primitive Emacs
927 syntax-parsing routines, and marks them up so that either
929 A1) CPerl may work around these deficiencies (for big chunks, mostly
930 PODs and HERE-documents), or
931 A2) On capable Emaxen CPerl will use improved syntax-handling
932 which reads mark-up hints directly.
934 The scan in case A2 is much more comprehensive, thus may be slower.
936 User can disable syntax-engine-helping scan of A2 by setting
937 `cperl-use-syntax-table-text-property'
938 variable to nil (if it is set to t).
940 One can disable the scan altogether (both A1 and A2) by setting
941 `cperl-pod-here-scan'
944 B) Speed of editing operations.
946 One can add a (minor) speedup to editing operations by setting
947 `cperl-use-syntax-table-text-property'
948 variable to nil (if it is set to t). This will disable
949 syntax-engine-helping scan, thus will make many more Perl
950 constructs be wrongly recognized by CPerl, thus may lead to
951 wrongly matched parentheses, wrong indentation, etc.
953 One can unset `cperl-syntaxify-unwind'. This might speed up editing
954 of, say, long POD sections.")
956 (defvar cperl-tips-faces
'please-ignore-this-line
957 "CPerl mode uses following faces for highlighting:
959 `cperl-array-face' Array names
960 `cperl-hash-face' Hash names
961 `font-lock-comment-face' Comments, PODs and whatever is considered
962 syntactically to be not code
963 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
964 2-arg operators s/y/tr/ or of RExen,
965 `font-lock-warning-face' Special-cased m// and s//foo/,
966 `font-lock-function-name-face' _ as a target of a file tests, file tests,
967 subroutine names at the moment of definition
968 (except those conflicting with Perl operators),
969 package names (when recognized), format names
970 `font-lock-keyword-face' Control flow switch constructs, declarators
971 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
972 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
973 literal parts and the terminator of formats
974 and whatever is syntactically considered
976 `font-lock-type-face' Overridable keywords
977 `font-lock-variable-name-face' Variable declarations, indirect array and
978 hash names, POD headers/item names
979 `cperl-invalid-face' Trailing whitespace
981 Note that in several situations the highlighting tries to inform about
982 possible confusion, such as different colors for function names in
983 declarations depending on what they (do not) override, or special cases
984 m// and s/// which do not do what one would expect them to do.
986 Help with best setup of these faces for printout requested (for each of
987 the faces: please specify bold, italic, underline, shadow and box.)
989 In regular expressions (including character classes):
990 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
991 `font-lock-constant-face': Delimiters
992 `font-lock-warning-face' Special-cased m// and s//foo/,
993 Mismatched closing delimiters, parens
994 we couldn't match, misplaced quantifiers,
995 unrecognized escape sequences
996 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
997 `font-lock-type-face' escape sequences with arguments (\\x \\23 \\p \\N)
998 and others match-a-char escape sequences
999 `font-lock-keyword-face' Capturing parens, and |
1000 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
1001 \"Range -\" in character classes
1002 `font-lock-builtin-face' \"Remaining\" 0-length constructs, multipliers
1003 ?+*{}, not-capturing parens, leading
1004 backslashes of escape sequences
1005 `font-lock-variable-name-face' Interpolated constructs, embedded code,
1006 POSIX classes (inside charclasses)
1007 `font-lock-comment-face' Embedded comments
1013 ;;; Portability stuff:
1015 (defmacro cperl-define-key
(emacs-key definition
&optional xemacs-key
)
1016 `(define-key cperl-mode-map
1018 `(if (featurep 'xemacs
) ,xemacs-key
,emacs-key
)
1022 (defvar cperl-del-back-ch
1023 (car (append (where-is-internal 'delete-backward-char
)
1024 (where-is-internal 'backward-delete-char-untabify
)))
1025 "Character generated by key bound to `delete-backward-char'.")
1027 (and (vectorp cperl-del-back-ch
) (= (length cperl-del-back-ch
) 1)
1028 (setq cperl-del-back-ch
(aref cperl-del-back-ch
0)))
1030 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
1031 (if (featurep 'xemacs
)
1033 ;; "Active regions" are on: use region only if active
1034 ;; "Active regions" are off: use region unconditionally
1035 (defun cperl-use-region-p ()
1036 (if zmacs-regions
(mark) t
)))
1037 (defun cperl-use-region-p ()
1038 (if transient-mark-mode mark-active t
))
1039 (defun cperl-mark-active () mark-active
))
1041 (defsubst cperl-enable-font-lock
()
1042 cperl-can-font-lock
)
1044 (defun cperl-putback-char (c) ; Emacs 19
1045 (push c unread-command-events
)) ; Avoid undefined warning
1047 (if (featurep 'xemacs
)
1048 (defun cperl-putback-char (c) ; XEmacs >= 19.12
1049 (push (eval '(character-to-event c
)) unread-command-events
)))
1051 (or (fboundp 'uncomment-region
)
1052 (defun uncomment-region (beg end
)
1054 (comment-region beg end -
1)))
1056 (defvar cperl-do-not-fontify
1057 (if (string< emacs-version
"19.30")
1060 "Text property which inhibits refontification.")
1062 (defsubst cperl-put-do-not-fontify
(from to
&optional post
)
1063 ;; If POST, do not do it with postponed fontification
1064 (if (and post cperl-syntaxify-by-font-lock
)
1066 (put-text-property (max (point-min) (1- from
))
1067 to cperl-do-not-fontify t
)))
1069 (defcustom cperl-mode-hook nil
1070 "Hook run by CPerl mode."
1074 (defvar cperl-syntax-state nil
)
1075 (defvar cperl-syntax-done-to nil
)
1076 (defvar cperl-emacs-can-parse
(> (length (save-excursion
1077 (parse-partial-sexp (point) (point)))) 9))
1079 ;; Make customization possible "in reverse"
1080 (defsubst cperl-val
(symbol &optional default hairy
)
1082 ((eq (symbol-value symbol
) 'null
) default
)
1083 (cperl-hairy (or hairy t
))
1084 (t (symbol-value symbol
))))
1087 (defun cperl-make-indent (column &optional minimum keep
)
1088 "Makes indent of the current line the requested amount.
1089 Unless KEEP, removes the old indentation. Works around a bug in ancient
1091 (let ((prop (get-text-property (point) 'syntax-type
)))
1093 (delete-horizontal-space))
1094 (indent-to column minimum
)
1095 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1097 (> (current-column) 0)
1100 (or (get-text-property (point) 'syntax-type
)
1101 (and (looking-at "\\=[ \t]")
1102 (put-text-property (point) (match-end 0)
1103 'syntax-type prop
)))))))
1105 ;;; Probably it is too late to set these guys already, but it can help later:
1107 ;;;(and cperl-clobber-mode-lists
1108 ;;;(setq auto-mode-alist
1109 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1110 ;;;(and (boundp 'interpreter-mode-alist)
1111 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
1112 ;;; '(("miniperl" . perl-mode))))))
1118 '(imenu easymenu etags timer man info
))
1119 (if (fboundp 'ps-extend-face-list
)
1120 (defmacro cperl-ps-extend-face-list
(arg)
1121 `(ps-extend-face-list ,arg
))
1122 (defmacro cperl-ps-extend-face-list
(arg)
1123 `(error "This version of Emacs has no `ps-extend-face-list'")))
1124 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1125 ;; macros instead of defsubsts don't work on Emacs, so we do the
1126 ;; expansion manually. Any other suggestions?
1129 (define-abbrev-table 'cperl-mode-abbrev-table
1131 ("if" "if" cperl-electric-keyword
:system t
)
1132 ("elsif" "elsif" cperl-electric-keyword
:system t
)
1133 ("while" "while" cperl-electric-keyword
:system t
)
1134 ("until" "until" cperl-electric-keyword
:system t
)
1135 ("unless" "unless" cperl-electric-keyword
:system t
)
1136 ("else" "else" cperl-electric-else
:system t
)
1137 ("continue" "continue" cperl-electric-else
:system t
)
1138 ("for" "for" cperl-electric-keyword
:system t
)
1139 ("foreach" "foreach" cperl-electric-keyword
:system t
)
1140 ("formy" "formy" cperl-electric-keyword
:system t
)
1141 ("foreachmy" "foreachmy" cperl-electric-keyword
:system t
)
1142 ("do" "do" cperl-electric-keyword
:system t
)
1143 ("=pod" "=pod" cperl-electric-pod
:system t
)
1144 ("=over" "=over" cperl-electric-pod
:system t
)
1145 ("=head1" "=head1" cperl-electric-pod
:system t
)
1146 ("=head2" "=head2" cperl-electric-pod
:system t
)
1147 ("pod" "pod" cperl-electric-pod
:system t
)
1148 ("over" "over" cperl-electric-pod
:system t
)
1149 ("head1" "head1" cperl-electric-pod
:system t
)
1150 ("head2" "head2" cperl-electric-pod
:system t
))
1151 "Abbrev table in use in CPerl mode buffers.")
1153 (add-hook 'edit-var-mode-alist
'(perl-mode (regexp .
"^cperl-")))
1155 (defvar cperl-mode-map
() "Keymap used in CPerl mode.")
1157 (if cperl-mode-map nil
1158 (setq cperl-mode-map
(make-sparse-keymap))
1159 (cperl-define-key "{" 'cperl-electric-lbrace
)
1160 (cperl-define-key "[" 'cperl-electric-paren
)
1161 (cperl-define-key "(" 'cperl-electric-paren
)
1162 (cperl-define-key "<" 'cperl-electric-paren
)
1163 (cperl-define-key "}" 'cperl-electric-brace
)
1164 (cperl-define-key "]" 'cperl-electric-rparen
)
1165 (cperl-define-key ")" 'cperl-electric-rparen
)
1166 (cperl-define-key ";" 'cperl-electric-semi
)
1167 (cperl-define-key ":" 'cperl-electric-terminator
)
1168 (cperl-define-key "\C-j" 'newline-and-indent
)
1169 (cperl-define-key "\C-c\C-j" 'cperl-linefeed
)
1170 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless
)
1171 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline
)
1172 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev
)
1173 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix
)
1174 (cperl-define-key "\C-c\C-f" 'auto-fill-mode
)
1175 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric
)
1176 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style
)
1177 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell
)
1178 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell
)
1179 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc
)
1180 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx
)
1181 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0
)
1182 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1
)
1183 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp
)
1184 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc
)
1185 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point
)
1186 (cperl-define-key "\e\C-q" 'cperl-indent-exp
) ; Usually not bound
1187 (cperl-define-key [?\C-\M-\|
] 'cperl-lineup
1189 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1190 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1191 (cperl-define-key "\177" 'cperl-electric-backspace
)
1192 (cperl-define-key "\t" 'cperl-indent-command
)
1193 ;; don't clobber the backspace binding:
1194 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1195 [(control c
) (control h
) F
])
1196 (if (cperl-val 'cperl-clobber-lisp-bindings
)
1198 (cperl-define-key "\C-hf"
1199 ;;(concat (char-to-string help-char) "f") ; does not work
1200 'cperl-info-on-command
1202 (cperl-define-key "\C-hv"
1203 ;;(concat (char-to-string help-char) "v") ; does not work
1206 (cperl-define-key "\C-c\C-hf"
1207 ;;(concat (char-to-string help-char) "f") ; does not work
1208 (key-binding "\C-hf")
1209 [(control c
) (control h
) f
])
1210 (cperl-define-key "\C-c\C-hv"
1211 ;;(concat (char-to-string help-char) "v") ; does not work
1212 (key-binding "\C-hv")
1213 [(control c
) (control h
) v
]))
1214 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1215 [(control c
) (control h
) f
])
1216 (cperl-define-key "\C-c\C-hv"
1217 ;;(concat (char-to-string help-char) "v") ; does not work
1219 [(control c
) (control h
) v
]))
1220 (if (and (featurep 'xemacs
)
1221 (<= emacs-minor-version
11) (<= emacs-major-version
19))
1223 ;; substitute-key-definition is usefulness-deenhanced...
1224 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1225 (cperl-define-key "\e;" 'cperl-indent-for-comment
)
1226 (cperl-define-key "\e\C-\\" 'cperl-indent-region
))
1227 (or (boundp 'fill-paragraph-function
)
1228 (substitute-key-definition
1229 'fill-paragraph
'cperl-fill-paragraph
1230 cperl-mode-map global-map
))
1231 (substitute-key-definition
1232 'indent-sexp
'cperl-indent-exp
1233 cperl-mode-map global-map
)
1234 (substitute-key-definition
1235 'indent-region
'cperl-indent-region
1236 cperl-mode-map global-map
)
1237 (substitute-key-definition
1238 'indent-for-comment
'cperl-indent-for-comment
1239 cperl-mode-map global-map
)))
1242 (defvar cperl-lazy-installed
)
1243 (defvar cperl-old-style nil
)
1248 cperl-menu cperl-mode-map
"Menu for CPerl mode"
1250 ["Beginning of function" beginning-of-defun
t]
1251 ["End of function" end-of-defun
t]
1252 ["Mark function" mark-defun
t]
1253 ["Indent expression" cperl-indent-exp t
]
1254 ["Fill paragraph/comment" fill-paragraph t
]
1256 ["Line up a construction" cperl-lineup
(cperl-use-region-p)]
1257 ["Invert if/unless/while etc" cperl-invert-if-unless t
]
1259 ["Beautify" cperl-beautify-regexp
1260 cperl-use-syntax-table-text-property
]
1261 ["Beautify one level deep" (cperl-beautify-regexp 1)
1262 cperl-use-syntax-table-text-property
]
1263 ["Beautify a group" cperl-beautify-level
1264 cperl-use-syntax-table-text-property
]
1265 ["Beautify a group one level deep" (cperl-beautify-level 1)
1266 cperl-use-syntax-table-text-property
]
1267 ["Contract a group" cperl-contract-level
1268 cperl-use-syntax-table-text-property
]
1269 ["Contract groups" cperl-contract-levels
1270 cperl-use-syntax-table-text-property
]
1272 ["Find next interpolated" cperl-next-interpolated-REx
1273 (next-single-property-change (point-min) 'REx-interpolated
)]
1274 ["Find next interpolated (no //o)"
1275 cperl-next-interpolated-REx-0
1276 (or (text-property-any (point-min) (point-max) 'REx-interpolated t
)
1277 (text-property-any (point-min) (point-max) 'REx-interpolated
1))]
1278 ["Find next interpolated (neither //o nor whole-REx)"
1279 cperl-next-interpolated-REx-1
1280 (text-property-any (point-min) (point-max) 'REx-interpolated t
)])
1281 ["Insert spaces if needed to fix style" cperl-find-bad-style t
]
1282 ["Refresh \"hard\" constructions" cperl-find-pods-heres t
]
1284 ["Indent region" cperl-indent-region
(cperl-use-region-p)]
1285 ["Comment region" cperl-comment-region
(cperl-use-region-p)]
1286 ["Uncomment region" cperl-uncomment-region
(cperl-use-region-p)]
1288 ["Run" mode-compile
(fboundp 'mode-compile
)]
1289 ["Kill" mode-compile-kill
(and (fboundp 'mode-compile-kill
)
1290 (get-buffer "*compilation*"))]
1291 ["Next error" next-error
(get-buffer "*compilation*")]
1292 ["Check syntax" cperl-check-syntax
(fboundp 'mode-compile
)]
1294 ["Debugger" cperl-db t
]
1297 ["Imenu" imenu
(fboundp 'imenu
)]
1298 ["Imenu on Perl Info" cperl-imenu-on-info
(featurep 'imenu
)]
1300 ["Ispell PODs" cperl-pod-spell
1301 ;; Better not to update syntaxification here:
1302 ;; debugging syntaxification can be broken by this???
1304 (get-text-property (point-min) 'in-pod
)
1306 (and cperl-syntaxify-for-menu
1307 (cperl-update-syntaxification (point-max) (point-max)))
1308 (next-single-property-change (point-min) 'in-pod nil
(point-max)))
1310 ["Ispell HERE-DOCs" cperl-here-doc-spell
1312 (and cperl-syntaxify-for-menu
1313 (cperl-update-syntaxification (point-max) (point-max)))
1314 (next-single-property-change (point-min) 'here-doc-group nil
(point-max)))
1316 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
1317 (eq 'here-doc
(progn
1318 (and cperl-syntaxify-for-menu
1319 (cperl-update-syntaxification (point) (point)))
1320 (get-text-property (point) 'syntax-type
)))]
1321 ["Select this HERE-DOC or POD section"
1322 cperl-select-this-pod-or-here-doc
1324 (and cperl-syntaxify-for-menu
1325 (cperl-update-syntaxification (point) (point)))
1326 (get-text-property (point) 'syntax-type
))
1329 ["CPerl pretty print (experimental)" cperl-ps-print
1330 (fboundp 'ps-extend-face-list
)]
1332 ["Syntaxify region" cperl-find-pods-heres-region
1333 (cperl-use-region-p)]
1334 ["Profile syntaxification" cperl-time-fontification t
]
1335 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t
]
1336 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t
]
1337 ["Debug backtrace on syntactic scan (BEWARE!!!)"
1338 (cperl-toggle-set-debug-unwind nil t
) t
]
1340 ["Class Hierarchy from TAGS" cperl-tags-hier-init t
]
1341 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1343 ;;; ["Create tags for current file" cperl-etags t]
1344 ;;; ["Add tags for current file" (cperl-etags t) t]
1345 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1346 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1347 ;;; ["Create tags for Perl files in (sub)directories"
1348 ;;; (cperl-etags nil 'recursive) t]
1349 ;;; ["Add tags for Perl files in (sub)directories"
1350 ;;; (cperl-etags t 'recursive) t])
1351 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1352 ["Create tags for current file" (cperl-write-tags nil t
) t
]
1353 ["Add tags for current file" (cperl-write-tags) t
]
1354 ["Create tags for Perl files in directory"
1355 (cperl-write-tags nil t nil t
) t
]
1356 ["Add tags for Perl files in directory"
1357 (cperl-write-tags nil nil nil t
) t
]
1358 ["Create tags for Perl files in (sub)directories"
1359 (cperl-write-tags nil t t t
) t
]
1360 ["Add tags for Perl files in (sub)directories"
1361 (cperl-write-tags nil nil t t
) t
]))
1363 ["Define word at point" imenu-go-find-at-position
1364 (fboundp 'imenu-go-find-at-position
)]
1365 ["Help on function" cperl-info-on-command t
]
1366 ["Help on function at point" cperl-info-on-current-command t
]
1367 ["Help on symbol at point" cperl-get-help t
]
1368 ["Perldoc" cperl-perldoc t
]
1369 ["Perldoc on word at point" cperl-perldoc-at-point t
]
1370 ["View manpage of POD in this file" cperl-build-manpage t
]
1371 ["Auto-help on" cperl-lazy-install
1372 (and (fboundp 'run-with-idle-timer
)
1373 (not cperl-lazy-installed
))]
1374 ["Auto-help off" cperl-lazy-unstall
1375 (and (fboundp 'run-with-idle-timer
)
1376 cperl-lazy-installed
)])
1378 ["Auto newline" cperl-toggle-auto-newline t
]
1379 ["Electric parens" cperl-toggle-electric t
]
1380 ["Electric keywords" cperl-toggle-abbrev t
]
1381 ["Fix whitespace on indent" cperl-toggle-construct-fix t
]
1382 ["Auto-help on Perl constructs" cperl-toggle-autohelp t
]
1383 ["Auto fill" auto-fill-mode t
])
1385 ["CPerl" (cperl-set-style "CPerl") t
]
1386 ["PerlStyle" (cperl-set-style "PerlStyle") t
]
1387 ["GNU" (cperl-set-style "GNU") t
]
1388 ["C++" (cperl-set-style "C++") t
]
1389 ["K&R" (cperl-set-style "K&R") t
]
1390 ["BSD" (cperl-set-style "BSD") t
]
1391 ["Whitesmith" (cperl-set-style "Whitesmith") t
]
1392 ["Memorize Current" (cperl-set-style "Current") t
]
1393 ["Memorized" (cperl-set-style-back) cperl-old-style
])
1395 ["Tips" (describe-variable 'cperl-tips
) t
]
1396 ["Problems" (describe-variable 'cperl-problems
) t
]
1397 ["Speed" (describe-variable 'cperl-speed
) t
]
1398 ["Praise" (describe-variable 'cperl-praise
) t
]
1399 ["Faces" (describe-variable 'cperl-tips-faces
) t
]
1400 ["CPerl mode" (describe-function 'cperl-mode
) t
]
1402 (message "The version of master-file for this CPerl is %s-Emacs"
1403 cperl-version
) t
]))))
1406 (autoload 'c-macro-expand
"cmacexp"
1407 "Display the result of expanding all C macros occurring in the region.
1408 The expansion is entirely correct because it uses the C preprocessor."
1411 ;;; These two must be unwound, otherwise take exponential time
1412 (defconst cperl-maybe-white-and-comment-rex
"[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
1413 "Regular expression to match optional whitespace with interspersed comments.
1414 Should contain exactly one group.")
1416 ;;; This one is tricky to unwind; still very inefficient...
1417 (defconst cperl-white-and-comment-rex
"\\([ \t\n]\\|#[^\n]*\n\\)+"
1418 "Regular expression to match whitespace with interspersed comments.
1419 Should contain exactly one group.")
1422 ;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1423 ;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1424 ;;; Details of groups in this may be used in several functions; see comments
1425 ;;; near mentioned above variable(s)...
1426 ;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1427 (defsubst cperl-after-sub-regexp
(named attr
) ; 9 groups without attr...
1428 "Match the text after `sub' in a subroutine declaration.
1429 If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
1430 of attributes (if present), or end of the name or prototype (whatever is
1432 (concat ; Assume n groups before this...
1433 "\\(" ; n+1=name-group
1434 cperl-white-and-comment-rex
; n+2=pre-name
1435 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
1436 "\\)" ; END n+1=name-group
1438 "\\(" ; n+4=proto-group
1439 cperl-maybe-white-and-comment-rex
; n+5=pre-proto
1440 "\\(([^()]*)\\)" ; n+6=prototype
1441 "\\)?" ; END n+4=proto-group
1442 "\\(" ; n+7=attr-group
1443 cperl-maybe-white-and-comment-rex
; n+8=pre-attr
1444 "\\(" ; n+9=start-attr
1448 cperl-maybe-white-and-comment-rex
; whitespace-comments
1449 "\\(\\sw\\|_\\)+" ; attr-name
1450 ;; attr-arg (1 level of internal parens allowed!)
1451 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
1452 "\\(" ; optional : (XXX allows trailing???)
1453 cperl-maybe-white-and-comment-rex
; whitespace-comments
1458 "\\)?" ; END n+6=proto-group
1461 ;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1462 ;;; and `cperl-outline-level'.
1463 ;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
1464 (defvar cperl-imenu--function-name-regexp-perl
1467 "\\([ \t]*package" ; 2 = package-group
1468 "\\(" ; 3 = package-name-group
1469 cperl-white-and-comment-rex
; 4 = pre-package-name
1470 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
1473 (cperl-after-sub-regexp 'named nil
) ; 8=name 11=proto 14=attr-start
1474 cperl-maybe-white-and-comment-rex
; 15=pre-block
1476 "=head\\([1-4]\\)[ \t]+" ; 16=level
1477 "\\([^\n]+\\)$" ; 17=text
1480 (defvar cperl-outline-regexp
1481 (concat cperl-imenu--function-name-regexp-perl
"\\|" "\\`"))
1483 (defvar cperl-mode-syntax-table nil
1484 "Syntax table in use in CPerl mode buffers.")
1486 (defvar cperl-string-syntax-table nil
1487 "Syntax table in use in CPerl mode string-like chunks.")
1489 (defsubst cperl-1-
(p)
1490 (max (point-min) (1- p
)))
1492 (defsubst cperl-1
+ (p)
1493 (min (point-max) (1+ p
)))
1495 (if cperl-mode-syntax-table
1497 (setq cperl-mode-syntax-table
(make-syntax-table))
1498 (modify-syntax-entry ?
\\ "\\" cperl-mode-syntax-table
)
1499 (modify-syntax-entry ?
/ "." cperl-mode-syntax-table
)
1500 (modify-syntax-entry ?
* "." cperl-mode-syntax-table
)
1501 (modify-syntax-entry ?
+ "." cperl-mode-syntax-table
)
1502 (modify-syntax-entry ?-
"." cperl-mode-syntax-table
)
1503 (modify-syntax-entry ?
= "." cperl-mode-syntax-table
)
1504 (modify-syntax-entry ?%
"." cperl-mode-syntax-table
)
1505 (modify-syntax-entry ?
< "." cperl-mode-syntax-table
)
1506 (modify-syntax-entry ?
> "." cperl-mode-syntax-table
)
1507 (modify-syntax-entry ?
& "." cperl-mode-syntax-table
)
1508 (modify-syntax-entry ?$
"\\" cperl-mode-syntax-table
)
1509 (modify-syntax-entry ?
\n ">" cperl-mode-syntax-table
)
1510 (modify-syntax-entry ?
# "<" cperl-mode-syntax-table
)
1511 (modify-syntax-entry ?
' "\"" cperl-mode-syntax-table
)
1512 (modify-syntax-entry ?
` "\"" cperl-mode-syntax-table
)
1513 (if cperl-under-as-char
1514 (modify-syntax-entry ?_
"w" cperl-mode-syntax-table
))
1515 (modify-syntax-entry ?
: "_" cperl-mode-syntax-table
)
1516 (modify-syntax-entry ?|
"." cperl-mode-syntax-table
)
1517 (setq cperl-string-syntax-table
(copy-syntax-table cperl-mode-syntax-table
))
1518 (modify-syntax-entry ?$
"." cperl-string-syntax-table
)
1519 (modify-syntax-entry ?\
{ "." cperl-string-syntax-table
)
1520 (modify-syntax-entry ?\
} "." cperl-string-syntax-table
)
1521 (modify-syntax-entry ?
\" "." cperl-string-syntax-table
)
1522 (modify-syntax-entry ?
' "." cperl-string-syntax-table
)
1523 (modify-syntax-entry ?
` "." cperl-string-syntax-table
)
1524 (modify-syntax-entry ?
# "." cperl-string-syntax-table
)) ; (?# comment )
1528 (defvar cperl-faces-init nil
)
1530 (defvar cperl-msb-fixed nil
)
1531 (defvar cperl-use-major-mode
'cperl-mode
)
1532 (defvar cperl-font-lock-multiline-start nil
)
1533 (defvar cperl-font-lock-multiline nil
)
1534 (defvar cperl-font-locking nil
)
1536 ;; NB as it stands the code in cperl-mode assumes this only has one
1537 ;; element. If XEmacs 19 support were dropped, this could all be simplified.
1538 (defvar cperl-compilation-error-regexp-alist
1539 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1540 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
1542 "Alist that specifies how to match errors in perl output.")
1544 (defvar compilation-error-regexp-alist
)
1547 (define-derived-mode cperl-mode prog-mode
"CPerl"
1548 "Major mode for editing Perl code.
1549 Expression and list commands understand all C brackets.
1550 Tab indents for Perl code.
1551 Paragraphs are separated by blank lines only.
1552 Delete converts tabs to spaces as it moves back.
1554 Various characters in Perl almost always come in pairs: {}, (), [],
1555 sometimes <>. When the user types the first, she gets the second as
1556 well, with optional special formatting done on {}. (Disabled by
1557 default.) You can always quote (with \\[quoted-insert]) the left
1558 \"paren\" to avoid the expansion. The processing of < is special,
1559 since most the time you mean \"less\". CPerl mode tries to guess
1560 whether you want to type pair <>, and inserts is if it
1561 appropriate. You can set `cperl-electric-parens-string' to the string that
1562 contains the parens from the above list you want to be electrical.
1563 Electricity of parens is controlled by `cperl-electric-parens'.
1564 You may also set `cperl-electric-parens-mark' to have electric parens
1565 look for active mark and \"embrace\" a region if possible.'
1567 CPerl mode provides expansion of the Perl control constructs:
1569 if, else, elsif, unless, while, until, continue, do,
1570 for, foreach, formy and foreachmy.
1572 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1574 The user types the keyword immediately followed by a space, which
1575 causes the construct to be expanded, and the point is positioned where
1576 she is most likely to want to be. E.g., when the user types a space
1577 following \"if\" the following appears in the buffer: if () { or if ()
1578 } { } and the cursor is between the parentheses. The user can then
1579 type some boolean expression within the parens. Having done that,
1580 typing \\[cperl-linefeed] places you - appropriately indented - on a
1581 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1582 directive line, then appropriate number of new lines is inserted).
1584 If CPerl decides that you want to insert \"English\" style construct like
1588 it will not do any expansion. See also help on variable
1589 `cperl-extra-newline-before-brace'. (Note that one can switch the
1590 help message on expansion by setting `cperl-message-electric-keyword'
1593 \\[cperl-linefeed] is a convenience replacement for typing carriage
1594 return. It places you in the next line with proper indentation, or if
1595 you type it inside the inline block of control construct, like
1597 foreach (@lines) {print; print}
1599 and you are on a boundary of a statement inside braces, it will
1600 transform the construct into a multiline and will place you into an
1601 appropriately indented blank line. If you need a usual
1602 `newline-and-indent' behavior, it is on \\[newline-and-indent],
1603 see documentation on `cperl-electric-linefeed'.
1605 Use \\[cperl-invert-if-unless] to change a construction of the form
1615 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1616 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1617 on electric space between $ and {, `cperl-electric-parens-string' is
1618 the string that contains parentheses that should be electric in CPerl
1619 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1620 setting `cperl-electric-keywords' enables electric expansion of
1621 control structures in CPerl. `cperl-electric-linefeed' governs which
1622 one of two linefeed behavior is preferable. You can enable all these
1623 options simultaneously (recommended mode of use) by setting
1624 `cperl-hairy' to t. In this case you can switch separate options off
1625 by setting them to `null'. Note that one may undo the extra
1626 whitespace inserted by semis and braces in `auto-newline'-mode by
1627 consequent \\[cperl-electric-backspace].
1629 If your site has perl5 documentation in info format, you can use commands
1630 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1631 These keys run commands `cperl-info-on-current-command' and
1632 `cperl-info-on-command', which one is which is controlled by variable
1633 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1634 \(in turn affected by `cperl-hairy').
1636 Even if you have no info-format documentation, short one-liner-style
1637 help is available on \\[cperl-get-help], and one can run perldoc or
1640 It is possible to show this help automatically after some idle time.
1641 This is regulated by variable `cperl-lazy-help-time'. Default with
1642 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1643 secs idle time . It is also possible to switch this on/off from the
1644 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1646 Use \\[cperl-lineup] to vertically lineup some construction - put the
1647 beginning of the region at the start of construction, and make region
1648 span the needed amount of lines.
1650 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1651 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1652 here-docs sections. With capable Emaxen results of scan are used
1653 for indentation too, otherwise they are used for highlighting only.
1655 Variables controlling indentation style:
1656 `cperl-tab-always-indent'
1657 Non-nil means TAB in CPerl mode should always reindent the current line,
1658 regardless of where in the line point is when the TAB command is used.
1659 `cperl-indent-left-aligned-comments'
1660 Non-nil means that the comment starting in leftmost column should indent.
1661 `cperl-auto-newline'
1662 Non-nil means automatically newline before and after braces,
1663 and after colons and semicolons, inserted in Perl code. The following
1664 \\[cperl-electric-backspace] will remove the inserted whitespace.
1665 Insertion after colons requires both this variable and
1666 `cperl-auto-newline-after-colon' set.
1667 `cperl-auto-newline-after-colon'
1668 Non-nil means automatically newline even after colons.
1669 Subject to `cperl-auto-newline' setting.
1670 `cperl-indent-level'
1671 Indentation of Perl statements within surrounding block.
1672 The surrounding block's indentation is the indentation
1673 of the line on which the open-brace appears.
1674 `cperl-continued-statement-offset'
1675 Extra indentation given to a substatement, such as the
1676 then-clause of an if, or body of a while, or just a statement continuation.
1677 `cperl-continued-brace-offset'
1678 Extra indentation given to a brace that starts a substatement.
1679 This is in addition to `cperl-continued-statement-offset'.
1680 `cperl-brace-offset'
1681 Extra indentation for line if it starts with an open brace.
1682 `cperl-brace-imaginary-offset'
1683 An open brace following other text is treated as if it the line started
1684 this far to the right of the actual line indentation.
1685 `cperl-label-offset'
1686 Extra indentation for line that is a label.
1687 `cperl-min-label-indent'
1688 Minimal indentation for line that is a label.
1690 Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1691 `cperl-indent-level' 5 4 2 4
1692 `cperl-brace-offset' 0 0 0 0
1693 `cperl-continued-brace-offset' -5 -4 0 0
1694 `cperl-label-offset' -5 -4 -2 -4
1695 `cperl-continued-statement-offset' 5 4 2 4
1697 CPerl knows several indentation styles, and may bulk set the
1698 corresponding variables. Use \\[cperl-set-style] to do this. Use
1699 \\[cperl-set-style-back] to restore the memorized preexisting values
1700 \(both available from menu). See examples in `cperl-style-examples'.
1702 Part of the indentation style is how different parts of if/elsif/else
1703 statements are broken into lines; in CPerl, this is reflected on how
1704 templates for these constructs are created (controlled by
1705 `cperl-extra-newline-before-brace'), and how reflow-logic should treat
1706 \"continuation\" blocks of else/elsif/continue, controlled by the same
1707 variable, and by `cperl-extra-newline-before-brace-multiline',
1708 `cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
1710 If `cperl-indent-level' is 0, the statement after opening brace in
1711 column 0 is indented on
1712 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1714 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1717 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1718 or as help on variables `cperl-tips', `cperl-problems',
1719 `cperl-praise', `cperl-speed'."
1720 (if (cperl-val 'cperl-electric-linefeed
)
1722 (local-set-key "\C-J" 'cperl-linefeed
)
1723 (local-set-key "\C-C\C-J" 'newline-and-indent
)))
1725 (cperl-val 'cperl-clobber-lisp-bindings
)
1726 (cperl-val 'cperl-info-on-command-no-prompt
))
1728 ;; don't clobber the backspace binding:
1729 (cperl-define-key "\C-hf" 'cperl-info-on-current-command
[(control h
) f
])
1730 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1731 [(control c
) (control h
) f
])))
1732 (setq local-abbrev-table cperl-mode-abbrev-table
)
1733 (if (cperl-val 'cperl-electric-keywords
)
1735 (set-syntax-table cperl-mode-syntax-table
)
1736 ;; Until Emacs is multi-threaded, we do not actually need it local:
1737 (make-local-variable 'cperl-font-lock-multiline-start
)
1738 (make-local-variable 'cperl-font-locking
)
1739 (make-local-variable 'outline-regexp
)
1740 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1741 (setq outline-regexp cperl-outline-regexp
)
1742 (make-local-variable 'outline-level
)
1743 (setq outline-level
'cperl-outline-level
)
1744 (make-local-variable 'add-log-current-defun-function
)
1745 (setq add-log-current-defun-function
1748 (if (re-search-backward "^sub[ \t]+\\([^({ \t\n]+\\)" nil t
)
1749 (match-string-no-properties 1)))))
1751 (make-local-variable 'paragraph-start
)
1752 (setq paragraph-start
(concat "^$\\|" page-delimiter
))
1753 (make-local-variable 'paragraph-separate
)
1754 (setq paragraph-separate paragraph-start
)
1755 (make-local-variable 'paragraph-ignore-fill-prefix
)
1756 (setq paragraph-ignore-fill-prefix t
)
1757 (if (featurep 'xemacs
)
1759 (make-local-variable 'paren-backwards-message
)
1760 (set 'paren-backwards-message t
)))
1761 (make-local-variable 'indent-line-function
)
1762 (setq indent-line-function
'cperl-indent-line
)
1763 (make-local-variable 'require-final-newline
)
1764 (setq require-final-newline mode-require-final-newline
)
1765 (make-local-variable 'comment-start
)
1766 (setq comment-start
"# ")
1767 (make-local-variable 'comment-end
)
1768 (setq comment-end
"")
1769 (make-local-variable 'comment-column
)
1770 (setq comment-column cperl-comment-column
)
1771 (make-local-variable 'comment-start-skip
)
1772 (setq comment-start-skip
"#+ *")
1773 (make-local-variable 'defun-prompt-regexp
)
1775 ;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1776 ;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1777 (setq defun-prompt-regexp
1778 (concat "^[ \t]*\\(sub"
1779 (cperl-after-sub-regexp 'named
'attr-groups
)
1781 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
1783 cperl-maybe-white-and-comment-rex
))
1784 (make-local-variable 'comment-indent-function
)
1785 (setq comment-indent-function
'cperl-comment-indent
)
1786 (and (boundp 'fill-paragraph-function
)
1788 (make-local-variable 'fill-paragraph-function
)
1789 (set 'fill-paragraph-function
'cperl-fill-paragraph
)))
1790 (make-local-variable 'parse-sexp-ignore-comments
)
1791 (setq parse-sexp-ignore-comments t
)
1792 (make-local-variable 'indent-region-function
)
1793 (setq indent-region-function
'cperl-indent-region
)
1794 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1795 (make-local-variable 'imenu-create-index-function
)
1796 (setq imenu-create-index-function
1797 (function cperl-imenu--create-perl-index
))
1798 (make-local-variable 'imenu-sort-function
)
1799 (setq imenu-sort-function nil
)
1800 (make-local-variable 'vc-rcs-header
)
1801 (set 'vc-rcs-header cperl-vc-rcs-header
)
1802 (make-local-variable 'vc-sccs-header
)
1803 (set 'vc-sccs-header cperl-vc-sccs-header
)
1804 (when (featurep 'xemacs
)
1805 ;; This one is obsolete...
1806 (make-local-variable 'vc-header-alist
)
1807 (set 'vc-header-alist
(or cperl-vc-header-alist
; Avoid warning
1808 `((SCCS ,(car cperl-vc-sccs-header
))
1809 (RCS ,(car cperl-vc-rcs-header
))))))
1810 (cond ((boundp 'compilation-error-regexp-alist-alist
);; xemacs 20.x
1811 (make-local-variable 'compilation-error-regexp-alist-alist
)
1812 (set 'compilation-error-regexp-alist-alist
1813 (cons (cons 'cperl
(car cperl-compilation-error-regexp-alist
))
1814 (symbol-value 'compilation-error-regexp-alist-alist
)))
1815 (if (fboundp 'compilation-build-compilation-error-regexp-alist
)
1816 (let ((f 'compilation-build-compilation-error-regexp-alist
))
1818 (make-local-variable 'compilation-error-regexp-alist
)
1819 (push 'cperl compilation-error-regexp-alist
)))
1820 ((boundp 'compilation-error-regexp-alist
);; xemacs 19.x
1821 (make-local-variable 'compilation-error-regexp-alist
)
1822 (set 'compilation-error-regexp-alist
1823 (append cperl-compilation-error-regexp-alist
1824 (symbol-value 'compilation-error-regexp-alist
)))))
1825 (make-local-variable 'font-lock-defaults
)
1826 (setq font-lock-defaults
1828 ((string< emacs-version
"19.30")
1829 '(cperl-font-lock-keywords-2 nil nil
((?_ .
"w"))))
1830 ((string< emacs-version
"19.33") ; Which one to use?
1831 '((cperl-font-lock-keywords
1832 cperl-font-lock-keywords-1
1833 cperl-font-lock-keywords-2
) nil nil
((?_ .
"w"))))
1835 '((cperl-load-font-lock-keywords
1836 cperl-load-font-lock-keywords-1
1837 cperl-load-font-lock-keywords-2
) nil nil
((?_ .
"w"))))))
1838 (make-local-variable 'cperl-syntax-state
)
1839 (setq cperl-syntax-state nil
) ; reset syntaxification cache
1840 (if cperl-use-syntax-table-text-property
1841 (if (eval-when-compile (fboundp 'syntax-propertize-rules
))
1843 ;; Reset syntaxification cache.
1844 (set (make-local-variable 'cperl-syntax-done-to
) nil
)
1845 (set (make-local-variable 'syntax-propertize-function
)
1848 ;; Even if cperl-fontify-syntaxically has already gone
1849 ;; beyond `start', syntax-propertize has just removed
1850 ;; syntax-table properties between start and end, so we have
1851 ;; to re-apply them.
1852 (setq cperl-syntax-done-to start
)
1853 (cperl-fontify-syntaxically end
))))
1854 (make-local-variable 'parse-sexp-lookup-properties
)
1855 ;; Do not introduce variable if not needed, we check it!
1856 (set 'parse-sexp-lookup-properties t
)
1857 ;; Fix broken font-lock:
1858 (or (boundp 'font-lock-unfontify-region-function
)
1859 (set 'font-lock-unfontify-region-function
1860 'font-lock-default-unfontify-region
))
1861 (unless (featurep 'xemacs
) ; Our: just a plug for wrong font-lock
1862 (make-local-variable 'font-lock-unfontify-region-function
)
1863 (set 'font-lock-unfontify-region-function
; not present with old Emacs
1864 'cperl-font-lock-unfontify-region-function
))
1865 (make-local-variable 'cperl-syntax-done-to
)
1866 (setq cperl-syntax-done-to nil
) ; reset syntaxification cache
1867 (make-local-variable 'font-lock-syntactic-keywords
)
1868 (setq font-lock-syntactic-keywords
1869 (if cperl-syntaxify-by-font-lock
1870 '((cperl-fontify-syntaxically))
1871 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1872 ;; used to ignore syntax-table text-properties. (t) is a hack
1873 ;; to make font-lock think that font-lock-syntactic-keywords
1876 (if (boundp 'font-lock-multiline
) ; Newer font-lock; use its facilities
1878 (setq cperl-font-lock-multiline t
) ; Not localized...
1879 (set (make-local-variable 'font-lock-multiline
) t
))
1880 (make-local-variable 'font-lock-fontify-region-function
)
1881 (set 'font-lock-fontify-region-function
; not present with old Emacs
1882 'cperl-font-lock-fontify-region-function
))
1883 (make-local-variable 'font-lock-fontify-region-function
)
1884 (set 'font-lock-fontify-region-function
; not present with old Emacs
1885 'cperl-font-lock-fontify-region-function
)
1886 (make-local-variable 'cperl-old-style
)
1887 (if (boundp 'normal-auto-fill-function
) ; 19.33 and later
1888 (set (make-local-variable 'normal-auto-fill-function
)
1889 'cperl-do-auto-fill
)
1890 (or (fboundp 'cperl-old-auto-fill-mode
)
1892 (fset 'cperl-old-auto-fill-mode
(symbol-function 'auto-fill-mode
))
1893 (defun auto-fill-mode (&optional arg
)
1895 (eval '(cperl-old-auto-fill-mode arg
)) ; Avoid a warning
1896 (and auto-fill-function
(memq major-mode
'(perl-mode cperl-mode
))
1897 (setq auto-fill-function
'cperl-do-auto-fill
))))))
1898 (if (cperl-enable-font-lock)
1899 (if (cperl-val 'cperl-font-lock
)
1900 (progn (or cperl-faces-init
(cperl-init-faces))
1901 (font-lock-mode 1))))
1902 (set (make-local-variable 'facemenu-add-face-function
)
1903 'cperl-facemenu-add-face-function
) ; XXXX What this guy is for???
1904 (and (boundp 'msb-menu-cond
)
1905 (not cperl-msb-fixed
)
1907 (if (fboundp 'easy-menu-add
)
1908 (easy-menu-add cperl-menu
)) ; A NOP in Emacs.
1909 (run-mode-hooks 'cperl-mode-hook
)
1910 (if cperl-hook-after-change
1911 (add-hook 'after-change-functions
'cperl-after-change-function nil t
))
1912 ;; After hooks since fontification will break this
1913 (if cperl-pod-here-scan
1914 (or cperl-syntaxify-by-font-lock
1915 (progn (or cperl-faces-init
(cperl-init-faces-weak))
1916 (cperl-find-pods-heres)))))
1918 ;; Fix for perldb - make default reasonable
1922 (perldb (read-from-minibuffer "Run perldb (like this): "
1923 (if (consp gud-perldb-history
)
1924 (car gud-perldb-history
)
1925 (concat "perl " ;;(file-name-nondirectory
1929 (buffer-file-name)))
1931 '(gud-perldb-history .
1))))
1933 (defun cperl-msb-fix ()
1934 ;; Adds perl files to msb menu, supposes that msb is already loaded
1935 (setq cperl-msb-fixed t
)
1936 (let* ((l (length msb-menu-cond
))
1937 (last (nth (1- l
) msb-menu-cond
))
1938 (precdr (nthcdr (- l
2) msb-menu-cond
)) ; cdr of this is last
1939 (handle (1- (nth 1 last
))))
1940 (setcdr precdr
(list
1942 '(memq major-mode
'(cperl-mode perl-mode
))
1947 ;; This is used by indent-for-comment
1948 ;; to decide how much to indent a comment in CPerl code
1949 ;; based on its context. Do fallback if comment is found wrong.
1951 (defvar cperl-wrong-comment
)
1952 (defvar cperl-st-cfence
'(14)) ; Comment-fence
1953 (defvar cperl-st-sfence
'(15)) ; String-fence
1954 (defvar cperl-st-punct
'(1))
1955 (defvar cperl-st-word
'(2))
1956 (defvar cperl-st-bra
'(4 . ?\
>))
1957 (defvar cperl-st-ket
'(5 . ?\
<))
1960 (defun cperl-comment-indent () ; called at point at supposed comment
1961 (let ((p (point)) (c (current-column)) was phony
)
1962 (if (and (not cperl-indent-comment-at-column-0
)
1964 0 ; Existing comment at bol stays there.
1965 ;; Wrong comment found
1967 (setq was
(cperl-to-comment-or-eol)
1968 phony
(eq (get-text-property (point) 'syntax-table
)
1971 (progn ; Too naive???
1972 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1973 (if (eq (preceding-char) ?\
#)
1976 (if (= (point) p
) ; Our caller found a correct place
1978 (skip-chars-backward " \t")
1979 (setq was
(current-column))
1982 (max (1+ was
) ; Else indent at comment column
1984 ;; No, the caller found a random place; we need to edit ourselves
1986 (insert comment-start
)
1987 (backward-char (length comment-start
)))
1988 (setq cperl-wrong-comment t
)
1989 (cperl-make-indent comment-column
1) ; Indent min 1
1992 ;;;(defun cperl-comment-indent-fallback ()
1993 ;;; "Is called if the standard comment-search procedure fails.
1994 ;;;Point is at start of real comment."
1995 ;;; (let ((c (current-column)) target cnt prevc)
1996 ;;; (if (= c comment-column) nil
1997 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1998 ;;; (setq target (max (1+ (setq prevc
1999 ;;; (current-column))) ; Else indent at comment column
2000 ;;; comment-column))
2001 ;;; (if (= c comment-column) nil
2002 ;;; (delete-backward-char cnt)
2003 ;;; (while (< prevc target)
2005 ;;; (setq prevc (current-column)))
2006 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2007 ;;; (while (< prevc target)
2009 ;;; (setq prevc (current-column)))))))
2011 (defun cperl-indent-for-comment ()
2012 "Substitute for `indent-for-comment' in CPerl."
2014 (let (cperl-wrong-comment)
2015 (indent-for-comment)
2016 (if cperl-wrong-comment
; set by `cperl-comment-indent'
2017 (progn (cperl-to-comment-or-eol)
2018 (forward-char (length comment-start
))))))
2020 (defun cperl-comment-region (b e arg
)
2021 "Comment or uncomment each line in the region in CPerl mode.
2022 See `comment-region'."
2023 (interactive "r\np")
2024 (let ((comment-start "#"))
2025 (comment-region b e arg
)))
2027 (defun cperl-uncomment-region (b e arg
)
2028 "Uncomment or comment each line in the region in CPerl mode.
2029 See `comment-region'."
2030 (interactive "r\np")
2031 (let ((comment-start "#"))
2032 (comment-region b e
(- arg
))))
2034 (defvar cperl-brace-recursing nil
)
2036 (defun cperl-electric-brace (arg &optional only-before
)
2037 "Insert character and correct line's indentation.
2038 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2039 place (even in empty line), but not after. If after \")\" and the inserted
2040 char is \"{\", insert extra newline before only if
2041 `cperl-extra-newline-before-brace'."
2044 (other-end (if (and cperl-electric-parens-mark
2050 (not cperl-brace-recursing
)
2051 (cperl-val 'cperl-electric-parens
)
2052 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2053 ;; Need to insert a matching pair
2056 (setq insertpos
(point-marker))
2057 (goto-char other-end
)
2058 (setq last-command-event ?\
{)
2059 (cperl-electric-lbrace arg insertpos
))
2061 ;; Check whether we close something "usual" with `}'
2062 (if (and (eq last-command-event ?\
})
2066 (up-list (- (prefix-numeric-value arg
)))
2067 ;;(cperl-after-block-p (point-min))
2068 (or (cperl-after-expr-p nil
"{;)")
2069 ;; after sub, else, continue
2070 (cperl-after-block-p nil
'pre
)))
2072 ;; Just insert the guy
2073 (self-insert-command (prefix-numeric-value arg
))
2074 (if (and (not arg
) ; No args, end (of empty line or auto)
2076 (or (and (null only-before
)
2078 (skip-chars-backward " \t")
2080 (and (eq last-command-event ?\
{) ; Do not insert newline
2081 ;; if after ")" and `cperl-extra-newline-before-brace'
2082 ;; is nil, do not insert extra newline.
2083 (not cperl-extra-newline-before-brace
)
2085 (skip-chars-backward " \t")
2086 (eq (preceding-char) ?\
))))
2087 (if cperl-auto-newline
2088 (progn (cperl-indent-line) (newline) t
) nil
)))
2090 (self-insert-command (prefix-numeric-value arg
))
2092 (if cperl-auto-newline
2093 (setq insertpos
(1- (point))))
2094 (if (and cperl-auto-newline
(null only-before
))
2097 (cperl-indent-line)))
2099 (if insertpos
(progn (goto-char insertpos
)
2100 (search-forward (make-string
2101 1 last-command-event
))
2102 (setq insertpos
(1- (point)))))
2106 (goto-char insertpos
)
2107 (self-insert-command (prefix-numeric-value arg
)))
2108 (self-insert-command (prefix-numeric-value arg
)))))))
2110 (defun cperl-electric-lbrace (arg &optional end
)
2111 "Insert character, correct line's indentation, correct quoting by space."
2113 (let ((cperl-brace-recursing t
)
2114 (cperl-auto-newline cperl-auto-newline
)
2116 (if (and cperl-electric-parens-mark
2124 (and (cperl-val 'cperl-electric-lbrace-space
)
2125 (eq (preceding-char) ?$
)
2127 (skip-chars-backward "$")
2128 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
2130 ;; Check whether we are in comment
2134 (not (looking-at "[ \t]*#")))
2135 (cperl-after-expr-p nil
"{;)"))
2137 (setq cperl-auto-newline nil
))
2138 (cperl-electric-brace arg
)
2139 (and (cperl-val 'cperl-electric-parens
)
2140 (eq last-command-event ?
{)
2141 (memq last-command-event
2142 (append cperl-electric-parens-string nil
))
2143 (or (if other-end
(goto-char (marker-position other-end
)))
2145 (setq last-command-event ?
} pos
(point))
2146 (progn (cperl-electric-brace arg t
)
2149 (defun cperl-electric-paren (arg)
2150 "Insert an opening parenthesis or a matching pair of parentheses.
2151 See `cperl-electric-parens'."
2153 (let ((beg (point-at-bol))
2154 (other-end (if (and cperl-electric-parens-mark
2161 (if (and (cperl-val 'cperl-electric-parens
)
2162 (memq last-command-event
2163 (append cperl-electric-parens-string nil
))
2164 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2165 ;;(not (save-excursion (search-backward "#" beg t)))
2166 (if (eq last-command-event ?
<)
2168 ;; This code is too electric, see Bug#3943.
2169 ;; (and abbrev-mode ; later it is too late, may be after `for'
2171 (cperl-after-expr-p nil
"{;(,:="))
2174 (self-insert-command (prefix-numeric-value arg
))
2175 (if other-end
(goto-char (marker-position other-end
)))
2176 (insert (make-string
2177 (prefix-numeric-value arg
)
2178 (cdr (assoc last-command-event
'((?
{ .?
})
2182 (forward-char (- (prefix-numeric-value arg
))))
2183 (self-insert-command (prefix-numeric-value arg
)))))
2185 (defun cperl-electric-rparen (arg)
2186 "Insert a matching pair of parentheses if marking is active.
2187 If not, or if we are not at the end of marking range, would self-insert.
2188 Affected by `cperl-electric-parens'."
2190 (let ((beg (point-at-bol))
2191 (other-end (if (and cperl-electric-parens-mark
2192 (cperl-val 'cperl-electric-parens
)
2193 (memq last-command-event
2194 (append cperl-electric-parens-string nil
))
2201 (cperl-val 'cperl-electric-parens
)
2202 (memq last-command-event
'( ?\
) ?\
] ?\
} ?\
> ))
2203 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2204 ;;(not (save-excursion (search-backward "#" beg t)))
2207 (self-insert-command (prefix-numeric-value arg
))
2209 (if other-end
(goto-char other-end
))
2210 (insert (make-string
2211 (prefix-numeric-value arg
)
2212 (cdr (assoc last-command-event
'((?\
} . ?\
{)
2217 (self-insert-command (prefix-numeric-value arg
)))))
2219 (defun cperl-electric-keyword ()
2220 "Insert a construction appropriate after a keyword.
2221 Help message may be switched off by setting `cperl-message-electric-keyword'
2223 (let ((beg (point-at-bol))
2224 (dollar (and (eq last-command-event ?$
)
2225 (eq this-command
'self-insert-command
)))
2226 (delete (and (memq last-command-event
'(?\s ?
\n ?
\t ?
\f))
2227 (memq this-command
'(self-insert-command newline
))))
2229 (and (save-excursion
2233 (setq do
(looking-at "do\\>")))
2235 (cperl-after-expr-p nil
"{;:"))
2239 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2241 (save-excursion (or (not (re-search-backward "^=" nil t
))
2244 (and cperl-use-syntax-table-text-property
2245 (not (eq (get-text-property (point)
2248 (save-excursion (forward-sexp -
1)
2249 (not (memq (following-char) (append "$@%&*" nil
))))
2251 (and (eq (preceding-char) ?y
)
2252 (progn ; "foreachmy"
2258 (memq this-command
'(self-insert-command newline
)))))
2259 (and dollar
(insert " $"))
2261 ;;(insert " () {\n}")
2263 (cperl-extra-newline-before-brace
2264 (insert (if do
"\n" " ()\n"))
2270 (and do
(insert " while ();")))
2272 (insert (if do
" {\n} while ();" " () {\n}"))))
2273 (or (looking-at "[ \t]\\|$") (insert " "))
2275 (if dollar
(progn (search-backward "$")
2279 (search-backward ")")
2280 (if (eq last-command-event ?\
()
2281 (progn ; Avoid "if (())"
2285 (cperl-putback-char cperl-del-back-ch
))
2286 (if cperl-message-electric-keyword
2287 (message "Precede char by C-q to avoid expansion"))))))
2289 (defun cperl-ensure-newlines (n &optional pos
)
2290 "Make sure there are N newlines after the point."
2291 (or pos
(setq pos
(point)))
2292 (if (looking-at "\n")
2296 (cperl-ensure-newlines (1- n
) pos
)
2299 (defun cperl-electric-pod ()
2300 "Insert a POD chunk appropriate after a =POD directive."
2301 (let ((delete (and (memq last-command-event
'(?\s ?
\n ?
\t ?
\f))
2302 (memq this-command
'(self-insert-command newline
))))
2303 head1 notlast name p really-delete over
)
2304 (and (save-excursion
2305 (forward-word-strictly -
1)
2307 (eq (preceding-char) ?
=)
2309 (setq head1
(looking-at "head1\\>[ \t]*$"))
2310 (setq over
(and (looking-at "over\\>[ \t]*$")
2311 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
2315 (get-text-property (point) 'in-pod
)
2316 (cperl-after-expr-p nil
"{;:")
2317 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t
)
2318 (not (looking-at "\n*=cut"))
2319 (or (not cperl-use-syntax-table-text-property
)
2320 (eq (get-text-property (point) 'syntax-type
) 'pod
))))))
2323 (setq notlast
(re-search-forward "^\n=" nil t
)))
2327 (cperl-ensure-newlines 2)
2328 (forward-word-strictly -
2)
2333 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
2334 nil t
)))) ; Only one
2336 (forward-word-strictly 1)
2337 (setq name
(file-name-base)
2339 (insert " NAME\n\n" name
2340 " - \n\n=head1 SYNOPSIS\n\n\n\n"
2341 "=head1 DESCRIPTION")
2342 (cperl-ensure-newlines 4)
2344 (forward-word-strictly 2)
2346 (setq really-delete t
))
2347 (forward-word-strictly 1))))
2351 (insert "\n\n=item \n\n\n\n"
2353 (cperl-ensure-newlines 2)
2355 (forward-word-strictly 1)
2357 (setq really-delete t
)))
2358 (if (and delete really-delete
)
2359 (cperl-putback-char cperl-del-back-ch
))))))
2361 (defun cperl-electric-else ()
2362 "Insert a construction appropriate after a keyword.
2363 Help message may be switched off by setting `cperl-message-electric-keyword'
2365 (let ((beg (point-at-bol)))
2366 (and (save-excursion
2368 (cperl-after-expr-p nil
"{;:"))
2372 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2374 (save-excursion (or (not (re-search-backward "^=" nil t
))
2376 (and cperl-use-syntax-table-text-property
2377 (not (eq (get-text-property (point)
2382 ;;(insert " {\n\n}")
2384 (cperl-extra-newline-before-brace
2390 (insert " {\n\n}")))
2391 (or (looking-at "[ \t]\\|$") (insert " "))
2395 (cperl-putback-char cperl-del-back-ch
)
2396 (setq this-command
'cperl-electric-else
)
2397 (if cperl-message-electric-keyword
2398 (message "Precede char by C-q to avoid expansion"))))))
2400 (defun cperl-linefeed ()
2401 "Go to end of line, open a new line and indent appropriately.
2402 If in POD, insert appropriate lines."
2404 (let ((beg (point-at-bol))
2405 (end (point-at-eol))
2406 (pos (point)) start over cut res
)
2407 (if (and ; Check if we need to split:
2408 ; i.e., on a boundary and inside "{...}"
2409 (save-excursion (cperl-to-comment-or-eol)
2410 (>= (point) pos
)) ; Not in a comment
2412 (skip-chars-backward " \t" beg
)
2414 (looking-at "[;{]")) ; After { or ; + spaces
2415 (looking-at "[ \t]*}") ; Before }
2416 (re-search-forward "\\=[ \t]*;" end t
)) ; Before spaces + ;
2419 (eq (car (parse-partial-sexp pos end -
1)) -
1)
2420 ; Leave the level of parens
2421 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2423 (cperl-after-block-p (point-min))
2426 (setq start
(point-marker))
2427 (<= start pos
))))) ; Redundant? Are after the
2428 ; start of parens group.
2430 (skip-chars-backward " \t")
2431 (or (memq (preceding-char) (append ";{" nil
))
2437 (or (looking-at "{[ \t]*$") ; If there is a statement
2438 ; before, move it to separate line
2442 (cperl-indent-line)))
2443 (forward-line 1) ; We are on the target line
2446 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2447 ; after, move it to separate line
2450 (search-backward "}" beg
)
2451 (skip-chars-backward " \t")
2452 (or (memq (preceding-char) (append ";{" nil
))
2457 (forward-line -
1) ; We are on the line before target
2459 (newline-and-indent))
2460 (end-of-line) ; else - no splitting
2462 ((and (looking-at "\n[ \t]*{$")
2464 (skip-chars-backward " \t")
2465 (eq (preceding-char) ?\
)))) ; Probably if () {} group
2466 ; with an extra newline.
2468 (cperl-indent-line))
2469 ((save-excursion ; In POD header
2470 (forward-paragraph -
1)
2471 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2472 ;; We are after \n now, so look for the rest
2473 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2475 (setq cut
(looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2476 (setq over
(looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2480 (forward-paragraph -
1)
2481 (forward-word-strictly 1)
2483 (setq cut
(buffer-substring (point) (point-at-eol)))
2484 (delete-char (- (point-at-eol) (point)))
2485 (setq res
(expand-abbrev))
2491 (cperl-ensure-newlines (if cut
2 4))
2493 ((get-text-property (point) 'in-pod
) ; In POD section
2494 (cperl-ensure-newlines 4)
2496 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2498 (cperl-indent-line))
2500 (newline-and-indent))))))
2502 (defun cperl-electric-semi (arg)
2503 "Insert character and correct line's indentation."
2505 (if cperl-auto-newline
2506 (cperl-electric-terminator arg
)
2507 (self-insert-command (prefix-numeric-value arg
))
2508 (if cperl-autoindent-on-semi
2509 (cperl-indent-line))))
2511 (defun cperl-electric-terminator (arg)
2512 "Insert character and correct line's indentation."
2515 (auto (and cperl-auto-newline
2516 (or (not (eq last-command-event ?
:))
2517 cperl-auto-newline-after-colon
)))
2519 (if (and ;;(not arg)
2521 (not (save-excursion
2523 (skip-chars-forward " \t")
2525 ;; Ignore in comment lines
2526 (= (following-char) ?
#)
2527 ;; Colon is special only after a label
2528 ;; So quickly rule out most other uses of colon
2529 ;; and do no indentation for them.
2530 (and (eq last-command-event ?
:)
2532 (forward-word-strictly 1)
2533 (skip-chars-forward " \t")
2534 (and (< (point) end
)
2535 (progn (goto-char (- end
1))
2536 (not (looking-at ":"))))))
2538 (beginning-of-defun)
2539 (let ((pps (parse-partial-sexp (point) end
)))
2540 (or (nth 3 pps
) (nth 4 pps
) (nth 5 pps
))))))))
2542 (self-insert-command (prefix-numeric-value arg
))
2544 (if auto
(setq insertpos
(point-marker)))
2550 (cperl-indent-line)))
2552 (if insertpos
(goto-char (1- (marker-position insertpos
)))
2557 (goto-char insertpos
)
2558 (self-insert-command (prefix-numeric-value arg
)))
2559 (self-insert-command (prefix-numeric-value arg
)))))
2561 (defun cperl-electric-backspace (arg)
2562 "Backspace, or remove whitespace around the point inserted by an electric key.
2563 Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2565 (if (and cperl-auto-newline
2566 (memq last-command
'(cperl-electric-semi
2567 cperl-electric-terminator
2568 cperl-electric-lbrace
))
2569 (memq (preceding-char) '(?\s ?
\t ?
\n)))
2571 (if (eq last-command
'cperl-electric-lbrace
)
2572 (skip-chars-forward " \t\n"))
2574 (skip-chars-backward " \t\n")
2575 (delete-region (point) p
))
2576 (and (eq last-command
'cperl-electric-else
)
2577 ;; We are removing the whitespace *inside* cperl-electric-else
2578 (setq this-command
'cperl-electric-else-really
))
2579 (if (and cperl-auto-newline
2580 (eq last-command
'cperl-electric-else-really
)
2581 (memq (preceding-char) '(?\s ?
\t ?
\n)))
2583 (skip-chars-forward " \t\n")
2585 (skip-chars-backward " \t\n")
2586 (delete-region (point) p
))
2587 (if cperl-electric-backspace-untabify
2588 (backward-delete-char-untabify arg
)
2589 (call-interactively 'delete-backward-char
)))))
2591 (put 'cperl-electric-backspace
'delete-selection
'supersede
)
2593 (defun cperl-inside-parens-p () ;; NOT USED????
2597 (narrow-to-region (point)
2598 (progn (beginning-of-defun) (point)))
2599 (goto-char (point-max))
2600 (= (char-after (or (scan-lists (point) -
1 1) (point-min))) ?\
()))
2603 (defun cperl-indent-command (&optional whole-exp
)
2604 "Indent current line as Perl code, or in some cases insert a tab character.
2605 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2606 line. Otherwise, indent the current line only if point is at the left margin
2607 or in the line's indentation; otherwise insert a tab.
2609 A numeric argument, regardless of its value,
2610 means indent rigidly all the lines of the expression starting after point
2611 so that this line becomes properly indented.
2612 The relative indentation among the lines of the expression are preserved."
2614 (cperl-update-syntaxification (point) (point))
2616 ;; If arg, always indent this line as Perl
2617 ;; and shift remaining lines of expression the same amount.
2618 (let ((shift-amt (cperl-indent-line))
2621 (if cperl-tab-always-indent
2622 (beginning-of-line))
2629 (if (and shift-amt
(> end beg
))
2630 (indent-code-rigidly beg end shift-amt
"#")))
2631 (if (and (not cperl-tab-always-indent
)
2633 (skip-chars-backward " \t")
2636 (cperl-indent-line))))
2638 (defun cperl-indent-line (&optional parse-data
)
2639 "Indent current line as Perl code.
2640 Return the amount the indentation changed by."
2641 (let ((case-fold-search nil
)
2642 (pos (- (point-max) (point)))
2643 indent i beg shift-amt
)
2644 (setq indent
(cperl-calculate-indent parse-data
)
2648 (cond ((or (eq indent nil
) (eq indent t
))
2649 (setq indent
(current-indentation) i nil
))
2650 ;;((eq indent t) ; Never?
2651 ;; (setq indent (cperl-calculate-indent-within-comment)))
2652 ;;((looking-at "[ \t]*#")
2655 (skip-chars-forward " \t")
2656 (if (listp indent
) (setq indent
(car indent
)))
2657 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2658 (not (looking-at "[smy]:\\|tr:")))
2660 (setq indent
(max cperl-min-label-indent
2661 (+ indent cperl-label-offset
)))))
2662 ((= (following-char) ?
})
2663 (setq indent
(- indent cperl-indent-level
)))
2664 ((memq (following-char) '(?\
) ?\
])) ; To line up with opening paren.
2665 (setq indent
(+ indent cperl-close-paren-offset
)))
2666 ((= (following-char) ?
{)
2667 (setq indent
(+ indent cperl-brace-offset
))))))
2668 (skip-chars-forward " \t")
2669 (setq shift-amt
(and i
(- indent
(current-column))))
2670 (if (or (not shift-amt
)
2672 (if (> (- (point-max) pos
) (point))
2673 (goto-char (- (point-max) pos
)))
2674 ;;;(delete-region beg (point))
2675 ;;;(indent-to indent)
2676 (cperl-make-indent indent
)
2677 ;; If initial point was within line's indentation,
2678 ;; position after the indentation. Else stay at same point in text.
2679 (if (> (- (point-max) pos
) (point))
2680 (goto-char (- (point-max) pos
))))
2683 (defun cperl-after-label ()
2684 ;; Returns true if the point is after label. Does not do save-excursion.
2685 (and (eq (preceding-char) ?
:)
2686 (memq (char-syntax (char-after (- (point) 2)))
2690 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2692 (defun cperl-get-state (&optional parse-start start-state
)
2693 ;; returns list (START STATE DEPTH PRESTART),
2694 ;; START is a good place to start parsing, or equal to
2695 ;; PARSE-START if preset,
2696 ;; STATE is what is returned by `parse-partial-sexp'.
2697 ;; DEPTH is true is we are immediately after end of block
2698 ;; which contains START.
2699 ;; PRESTART is the position basing on which START was found.
2701 (let ((start-point (point)) depth state start prestart
)
2702 (if (and parse-start
2703 (<= parse-start start-point
))
2704 (goto-char parse-start
)
2705 (beginning-of-defun)
2706 (setq start-state nil
))
2707 (setq prestart
(point))
2709 ;; Try to go out, if sub is not on the outermost level
2710 (while (< (point) start-point
)
2711 (setq start
(point) parse-start start depth nil
2712 state
(parse-partial-sexp start start-point -
1))
2713 (if (> (car state
) -
1) nil
2714 ;; The current line could start like }}}, so the indentation
2715 ;; corresponds to a different level than what we reached
2717 (beginning-of-line 2))) ; Go to the next line.
2718 (if start
(goto-char start
))) ; Not at the start of file
2719 (setq start
(point))
2720 (or state
(setq state
(parse-partial-sexp start start-point -
1 nil start-state
)))
2721 (list start state depth prestart
))))
2723 (defvar cperl-look-for-prop
'((pod in-pod
) (here-doc-delim here-doc-group
)))
2725 (defun cperl-beginning-of-property (p prop
&optional lim
)
2726 "Given that P has a property PROP, find where the property starts.
2727 Will not look before LIM."
2728 ;;; XXXX What to do at point-max???
2729 (or (previous-single-property-change (cperl-1+ p
) prop lim
)
2731 ;;; (cond ((eq p (point-min))
2733 ;;; ((and lim (<= p lim))
2735 ;;; ((not (get-text-property (1- p) prop))
2737 ;;; (t (or (previous-single-property-change p look-prop lim)
2741 (defun cperl-sniff-for-indent (&optional parse-data
) ; was parse-start
2742 ;; the sniffer logic to understand what the current line MEANS.
2743 (cperl-update-syntaxification (point) (point))
2744 (let ((res (get-text-property (point) 'syntax-type
)))
2747 ((and (memq res
'(pod here-doc here-doc-delim format
))
2748 (not (get-text-property (point) 'indentable
)))
2750 ;; before start of POD - whitespace found since do not have 'pod!
2751 ((looking-at "[ \t]*\n=")
2752 (error "Spaces before POD section!"))
2753 ((and (not cperl-indent-left-aligned-comments
)
2755 [comment-special
:at-beginning-of-line
])
2756 ((get-text-property (point) 'in-pod
)
2760 (let* ((indent-point (point))
2761 (char-after-pos (save-excursion
2762 (skip-chars-forward " \t")
2764 (char-after (char-after char-after-pos
))
2765 (pre-indent-point (point))
2766 p prop look-prop is-block delim
)
2767 (save-excursion ; Know we are not in POD, find appropriate pos before
2768 (cperl-backward-to-noncomment nil
)
2769 (setq p
(max (point-min) (1- (point)))
2770 prop
(get-text-property p
'syntax-type
)
2771 look-prop
(or (nth 1 (assoc prop cperl-look-for-prop
))
2773 (if (memq prop
'(pod here-doc format here-doc-delim
))
2775 (goto-char (cperl-beginning-of-property p look-prop
))
2777 (setq pre-indent-point
(point)))))
2778 (goto-char pre-indent-point
) ; Orig line skipping preceding pod/etc
2779 (let* ((case-fold-search nil
)
2780 (s-s (cperl-get-state (car parse-data
) (nth 1 parse-data
)))
2781 (start (or (nth 2 parse-data
) ; last complete sexp terminated
2782 (nth 0 s-s
))) ; Good place to start parsing
2784 (containing-sexp (car (cdr state
)))
2787 ;;containing-sexp ;; We are buggy at toplevel :-(
2790 (setcar parse-data pre-indent-point
)
2791 (setcar (cdr parse-data
) state
)
2792 (or (nth 2 parse-data
)
2793 (setcar (cddr parse-data
) start
))
2794 ;; Before this point: end of statement
2795 (setq old-indent
(nth 3 parse-data
))))
2796 (cond ((get-text-property (point) 'indentable
)
2797 ;; indent to "after" the surrounding open
2798 ;; (same offset as `cperl-beautify-regexp-piece'),
2799 ;; skip blanks if we do not close the expression.
2800 (setq delim
; We do not close the expression
2802 (cperl-1+ char-after-pos
) 'indentable
)
2803 p
(1+ (cperl-beginning-of-property
2804 (point) 'indentable
))
2805 is-block
; misused for: preceding line in REx
2806 (save-excursion ; Find preceding line
2807 (cperl-backward-to-noncomment p
)
2810 (progn ; get indent from the first line
2812 (skip-chars-forward " \t")
2813 (if (memq (char-after (point))
2815 nil
; Can't use indentation of this line...
2817 (skip-chars-forward " \t")
2819 prop
(parse-partial-sexp p char-after-pos
))
2820 (cond ((not delim
) ; End the REx, ignore is-block
2821 (vector 'indentable
'terminator p is-block
))
2822 (is-block ; Indent w.r.t. preceding line
2823 (vector 'indentable
'cont-line char-after-pos
2824 is-block char-after p
))
2825 (t ; No preceding line...
2826 (vector 'indentable
'first-line p
))))
2827 ((get-text-property char-after-pos
'REx-part2
)
2828 (vector 'REx-part2
(point)))
2833 ;; XXXX Do we need to special-case this?
2834 ((null containing-sexp)
2835 ;; Line is at top level. May be data or function definition,
2836 ;; or may be function argument declaration.
2837 ;; Indent like the previous top level line
2838 ;; unless that ends in a closeparen without semicolon,
2839 ;; in which case this line is the first argument decl.
2840 (skip-chars-forward " \t")
2841 (cperl-backward-to-noncomment (or old-indent (point-min)))
2844 (eq (point) old-indent) ; old-indent was at comment
2845 (eq (preceding-char) ?\;)
2847 (and (eq (preceding-char) ?\})
2848 (cperl-after-block-and-statement-beg
2849 (point-min))) ; Was start - too close
2850 (memq char-after (append ")]}" nil))
2851 (and (eq (preceding-char) ?\:) ; label
2854 (skip-chars-backward " \t")
2855 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2856 (get-text-property (point) 'first-format-line)))
2858 ;; Look at previous line that's at column 0
2859 ;; to determine whether we are in top-level decls
2860 ;; or function's arg decls. Set basic-indent accordingly.
2861 ;; Now add a little if this is a continuation line.
2864 (not (eq char-after ?\C-j))
2865 (setcdr (cddr parse-data)
2866 (list pre-indent-point)))
2867 (vector 'toplevel start char-after state (nth 2 s-s)))
2870 (and (setq delim (= (char-after containing-sexp) ?{))
2871 (save-excursion ; Is it a hash?
2872 (goto-char containing-sexp)
2874 cperl-indent-parens-as-block))
2875 ;; group is an expression, not a block:
2876 ;; indent to just after the surrounding open parens,
2877 ;; skip blanks if we do not close the expression.
2878 (goto-char (1+ containing-sexp))
2879 (or (memq char-after
2880 (append (if delim "}" ")]}") nil))
2881 (looking-at "[ \t]*\\(#\\|$\\)")
2882 (skip-chars-forward " \t"))
2883 (setq old-indent (point)) ; delim=is-brace
2884 (vector 'in-parens char-after (point) delim containing-sexp))
2886 ;; Statement level. Is it a continuation or a new statement?
2887 ;; Find previous non-comment character.
2888 (goto-char pre-indent-point) ; Skip one level of POD/etc
2889 (cperl-backward-to-noncomment containing-sexp)
2890 ;; Back up over label lines, since they don't
2891 ;; affect whether our line is a continuation.
2893 (while;;(or (eq (preceding-char) ?\,)
2894 (and (eq (preceding-char) ?:)
2895 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2896 (memq (char-syntax (char-after (- (point) 2)))
2899 ;; This is always FALSE?
2900 (if (eq (preceding-char) ?\,)
2901 ;; Will go to beginning of line, essentially.
2902 ;; Will ignore embedded sexpr XXXX.
2903 (cperl-backward-to-start-of-continued-exp containing-sexp))
2905 (cperl-backward-to-noncomment containing-sexp))
2906 ;; Now we get non-label preceding the indent point
2907 (if (not (or (eq (1- (point)) containing-sexp)
2908 (memq (preceding-char)
2909 (append (if is-block " ;{" " ,;{") '(nil)))
2910 (and (eq (preceding-char) ?\})
2911 (cperl-after-block-and-statement-beg
2913 (get-text-property (point) 'first-format-line)))
2914 ;; This line is continuation of preceding line's statement;
2915 ;; indent `cperl-continued-statement-offset' more than the
2916 ;; previous line of the statement.
2918 ;; There might be a label on this line, just
2919 ;; consider it bad style and ignore it.
2921 (cperl-backward-to-start-of-continued-exp containing-sexp)
2922 (vector 'continuation (point) char-after is-block delim))
2923 ;; This line starts a new statement.
2924 ;; Position following last unclosed open brace
2925 (goto-char containing-sexp)
2926 ;; Is line first statement after an open-brace?
2928 ;; If no, find that first statement and indent like
2929 ;; it. If the first statement begins with label, do
2930 ;; not believe when the indentation of the label is too
2934 (let ((colon-line-end 0))
2936 (progn (skip-chars-forward " \t\n")
2937 ;; s: foo : bar :x is NOT label
2938 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2939 (not (looking-at "[sym]:\\|tr:"))))
2940 ;; Skip over comments and labels following openbrace.
2941 (cond ((= (following-char) ?\#)
2943 ((= (following-char) ?\=)
2945 (or (next-single-property-change (point) 'in-pod)
2946 (point-max)))) ; do not loop if no syntaxification
2949 (setq colon-line-end (point-at-eol))
2950 (search-forward ":"))))
2951 ;; We are at beginning of code (NOT label or comment)
2952 ;; First, the following code counts
2953 ;; if it is before the line we want to indent.
2954 (and (< (point) indent-point)
2955 (vector 'have-prev-sibling (point) colon-line-end
2958 ;; If no previous statement,
2959 ;; indent it relative to line brace is on.
2961 ;; For open-braces not the first thing in a line,
2962 ;; add in cperl-brace-imaginary-offset.
2964 ;; If first thing on a line: ?????
2965 ;; Move back over whitespace before the openbrace.
2966 (setq ; brace first thing on a line
2967 old-indent (progn (skip-chars-backward " \t") (bolp)))
2968 ;; Should we indent w.r.t. earlier than start?
2969 ;; Move to start of control group, possibly on a different line
2970 (or cperl-indent-wrt-brace
2971 (cperl-backward-to-noncomment (point-min)))
2972 ;; If the openbrace is preceded by a parenthesized exp,
2973 ;; move to the beginning of that;
2974 (if (eq (preceding-char) ?\))
2977 (cperl-backward-to-noncomment (point-min))))
2978 ;; In the case it starts a subroutine, indent with
2979 ;; respect to `sub', not with respect to the
2980 ;; first thing on the line, say in the case of
2981 ;; anonymous sub in a hash.
2982 (if (and;; Is it a sub in group starting on this line?
2983 (cond ((get-text-property (point) 'attrib-group)
2984 (goto-char (cperl-beginning-of-property
2985 (point) 'attrib-group)))
2986 ((eq (preceding-char) ?b)
2988 (looking-at "sub\\>")))
2989 (setq p (nth 1 ; start of innermost containing list
2994 (goto-char (1+ p)) ; enclosing block on the same line
2995 (skip-chars-forward " \t")
2996 (vector 'code-start-in-block containing-sexp char-after
2997 (and delim (not is-block)) ; is a HASH
2998 old-indent ; brace first thing on a line
2999 t (point) ; have something before...
3003 ;; Get initial indentation of the line we are on.
3004 ;; If line starts with label, calculate label indentation
3005 (vector 'code-start-in-block containing-sexp char-after
3006 (and delim (not is-block)) ; is a HASH
3007 old-indent ; brace first thing on a line
3008 nil (point))))))))))))))) ; nothing interesting before
3010 (defvar cperl-indent-rules-alist
3011 '((pod nil) ; via `syntax-type' property
3012 (here-doc nil) ; via `syntax-type' property
3013 (here-doc-delim nil) ; via `syntax-type' property
3014 (format nil) ; via `syntax-type' property
3015 (in-pod nil) ; via `in-pod' property
3016 (comment-special:at-beginning-of-line nil)
3019 "Alist of indentation rules for CPerl mode.
3022 number: add this amount of indentation.")
3024 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3025 "Return appropriate indentation for current line as Perl code.
3026 In usual case returns an integer: the column to indent to.
3027 Returns nil if line starts inside a string, t if in a comment.
3029 Will not correct the indentation for labels, but will correct it for braces
3030 and closing parentheses and brackets."
3031 ;; This code is still a broken architecture: in some cases we need to
3032 ;; compensate for some modifications which `cperl-indent-line' will add later
3034 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3036 ;;((or (null i) (eq i t) (numberp i))
3039 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3041 (what (cadr what)) ; Load from table
3043 ;; Indenters for regular expressions with //x and qw()
3045 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3046 (goto-char (elt i 1))
3047 (condition-case nil ; Use indentation of the 1st part
3050 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3051 (cond ;;; [indentable terminator start-pos is-block]
3052 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3053 (goto-char (elt i 2)) ; After opening parens
3054 (1- (current-column)))
3055 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3056 (goto-char (elt i 2))
3057 (+ (or cperl-regexp-indent-step cperl-indent-level)
3060 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3061 ;; Indent as the level after closing parens
3062 (goto-char (elt i 2)) ; indent line
3063 (skip-chars-forward " \t)") ; Skip closing parens
3065 (goto-char (elt i 3)) ; previous line
3066 (skip-chars-forward " \t)") ; Skip closing parens
3067 ;; Number of parens in between:
3068 (setq p (nth 0 (parse-partial-sexp (point) p))
3069 what (elt i 4)) ; First char on current line
3070 (goto-char (elt i 3)) ; previous line
3071 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3072 (cond ((eq what ?\) )
3073 (- cperl-close-paren-offset)) ; compensate
3075 (- (or cperl-regexp-indent-step cperl-indent-level)))
3077 (if (eq (following-char) ?\| )
3078 (or cperl-regexp-indent-step cperl-indent-level)
3082 (error "Unrecognized value of indent: %s" i))))
3084 ;; Indenter for stuff at toplevel
3086 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3087 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3088 (goto-char (elt i 1)) ; start = Good place to start parsing
3089 (- (current-indentation) ;
3090 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3091 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3092 ;; Look at previous line that's at column 0
3093 ;; to determine whether we are in top-level decls
3094 ;; or function's arg decls. Set basic-indent accordingly.
3095 ;; Now add a little if this is a continuation line.
3096 (if (elt i 3) ; state (XXX What is the semantic???)
3098 cperl-continued-statement-offset)))
3100 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3102 ((eq 'in-parens (elt i 0))
3103 ;; in-parens char-after old-indent-point is-brace containing-sexp
3105 ;; group is an expression, not a block:
3106 ;; indent to just after the surrounding open parens,
3107 ;; skip blanks if we do not close the expression.
3109 (goto-char (elt i 2)) ; old-indent-point
3111 (if (and (elt i 3) ; is-brace
3112 (eq (elt i 1) ?\})) ; char-after
3113 ;; Correct indentation of trailing ?\}
3114 (+ cperl-indent-level cperl-close-paren-offset)
3117 ;; Indenter for continuation lines
3119 ((eq 'continuation (elt i 0))
3120 ;; [continuation statement-start char-after is-block is-brace]
3121 (goto-char (elt i 1)) ; statement-start
3122 (+ (if (or (memq (elt i 2) (append "}])" nil)) ; char-after
3123 (eq 'continuation ; do not stagger continuations
3124 (elt (cperl-sniff-for-indent parse-data) 0)))
3125 0 ; Closing parenthesis or continuation of a continuation
3126 cperl-continued-statement-offset)
3127 (if (or (elt i 3) ; is-block
3128 (not (elt i 4)) ; is-brace
3129 (not (eq (elt i 2) ?\}))) ; char-after
3131 ;; Now it is a hash reference
3132 (+ cperl-indent-level cperl-close-paren-offset))
3133 ;; Labels do not take :: ...
3134 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3135 (if (> (current-indentation) cperl-min-label-indent)
3136 (- (current-indentation) cperl-label-offset)
3137 ;; Do not move `parse-data', this should
3138 ;; be quick anyway (this comment comes
3139 ;; from different location):
3140 (cperl-calculate-indent))
3142 (if (eq (elt i 2) ?\{) ; char-after
3143 cperl-continued-brace-offset 0)))
3145 ;; Indenter for lines in a block which are not leading lines
3147 ((eq 'have-prev-sibling (elt i 0))
3148 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
3149 (goto-char (elt i 1)) ; sibling-beg
3150 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
3151 (if (> (current-indentation)
3152 cperl-min-label-indent)
3153 (- (current-indentation) cperl-label-offset)
3154 ;; Do not believe: `max' was involved in calculation of indent
3155 (+ cperl-indent-level
3157 (goto-char (elt i 3)) ; block-start
3158 (current-indentation))))
3161 ;; Indenter for the first line in a block
3163 ((eq 'code-start-in-block (elt i 0))
3164 ;;[code-start-in-block before-brace char-after
3165 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3166 ;; group-starts-before-start-of-sub start-of-control-group]
3167 (goto-char (elt i 1))
3168 ;; For open brace in column zero, don't let statement
3169 ;; start there too. If cperl-indent-level=0,
3170 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3171 (+ (if (and (bolp) (zerop cperl-indent-level))
3172 (+ cperl-brace-offset cperl-continued-statement-offset)
3174 (if (and (elt i 3) ; is-a-HASH-ref
3175 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3176 (+ cperl-indent-level cperl-close-paren-offset)
3178 ;; Unless openbrace is the first nonwhite thing on the line,
3179 ;; add the cperl-brace-imaginary-offset.
3180 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3181 cperl-brace-imaginary-offset)
3183 (goto-char (elt i 6)) ; start-of-control-group
3184 (if (elt i 5) ; group-starts-before-start-of-sub
3186 ;; Get initial indentation of the line we are on.
3187 ;; If line starts with label, calculate label indentation
3190 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3191 (if (> (current-indentation) cperl-min-label-indent)
3192 (- (current-indentation) cperl-label-offset)
3193 ;; Do not move `parse-data', this should
3195 (cperl-calculate-indent))
3196 (current-indentation))))))
3198 (error "Unrecognized value of indent: %s" i))))
3200 (error "Got strange value of indent: %s" i))))))
3202 (defun cperl-calculate-indent-within-comment ()
3203 "Return the indentation amount for line, assuming that
3204 the current line is to be regarded as part of a block comment."
3205 (let (end star-start)
3208 (skip-chars-forward " \t")
3210 (and (= (following-char) ?#)
3212 (cperl-to-comment-or-eol)
3218 (defun cperl-to-comment-or-eol ()
3219 "Go to position before comment on the current line, or to end of line.
3220 Returns true if comment is found. In POD will not move the point."
3221 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3222 ;; then looks for literal # or end-of-line.
3223 (let (state stop-in cpoint (lim (point-at-eol)) pr e)
3224 (or cperl-font-locking
3225 (cperl-update-syntaxification lim lim))
3227 (if (setq pr (get-text-property (point) 'syntax-type))
3228 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3229 (if (or (eq pr 'pod)
3230 (if (or (not e) (> e lim)) ; deep inside a group
3231 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
3232 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
3233 ;; Else - need to do it the hard way
3234 (and (and e (<= e lim))
3236 (while (not stop-in)
3237 (setq state (parse-partial-sexp (point) lim nil nil nil t))
3239 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3240 (if (nth 4 state) ; After `#';
3241 ; (nth 2 state) can be
3242 ; beginning of m,s,qq and so
3246 (setq cpoint (point))
3247 (goto-char (nth 2 state))
3249 ((looking-at "\\(s\\|tr\\)\\>")
3250 (or (re-search-forward
3251 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3254 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3255 (or (re-search-forward
3256 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3259 (t ; It was fair comment
3260 (setq stop-in t) ; Finish
3261 (goto-char (1- cpoint)))))
3262 (setq stop-in t) ; Finish
3264 (setq stop-in t))) ; Finish
3267 (defsubst cperl-modify-syntax-type (at how)
3268 (if (< at (point-max))
3270 (put-text-property at (1+ at) 'syntax-table how)
3271 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
3273 (defun cperl-protect-defun-start (s e)
3274 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3277 (while (re-search-forward "^\\s(" e 'to-end)
3278 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3280 (defun cperl-commentify (bb e string &optional noface)
3281 (if cperl-use-syntax-table-text-property
3282 (if (eq noface 'n) ; Only immediate
3284 ;; We suppose that e is _after_ the end of construction, as after eol.
3285 (setq string (if string cperl-st-sfence cperl-st-cfence))
3287 ;; one-char string/comment?!
3288 (cperl-modify-syntax-type bb cperl-st-punct)
3289 (cperl-modify-syntax-type bb string)
3290 (cperl-modify-syntax-type (1- e) string))
3291 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
3292 (put-text-property (1+ bb) (1- e)
3293 'syntax-table cperl-string-syntax-table))
3294 (cperl-protect-defun-start bb e))
3297 (not cperl-pod-here-fontify)
3298 (put-text-property bb e 'face (if string 'font-lock-string-face
3299 'font-lock-comment-face)))))
3301 (defvar cperl-starters '(( ?\( . ?\) )
3306 (defun cperl-cached-syntax-table (st)
3307 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3308 All the entries of the syntax table are \".\", except for a backslash, which
3312 (setcar st (make-syntax-table))
3316 (modify-syntax-entry i "." st)
3318 (modify-syntax-entry ?\\ "\\" st)
3321 (defun cperl-forward-re (lim end is-2arg st-l err-l argument
3322 &optional ostart oend)
3323 "Find the end of a regular expression or a stringish construct (q[] etc).
3324 The point should be before the starting delimiter.
3326 Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3327 is s/// or tr/// like expression. If END is nil, generates an error
3328 message if needed. If SET-ST is non-nil, will use (or generate) a
3329 cached syntax table in ST-L. If ERR-L is non-nil, will store the
3330 error message in its CAR (unless it already contains some error
3331 message). ARGUMENT should be the name of the construct (used in error
3332 messages). OSTART, OEND may be set in recursive calls when processing
3333 the second argument of 2ARG construct.
3335 Works *before* syntax recognition is done. In IS-2ARG situation may
3336 modify syntax-type text property if the situation is too hard."
3337 (let (b starter ender st i i2 go-forward reset-st set-st)
3338 (skip-chars-forward " \t")
3339 ;; ender means matching-char matcher.
3341 starter (if (eobp) 0 (char-after b))
3342 ender (cdr (assoc starter cperl-starters)))
3343 ;; What if starter == ?\\ ????
3344 (setq st (cperl-cached-syntax-table st-l))
3346 ;; Whether we have an intermediate point
3348 ;; Prepare the syntax table:
3349 (if (not ender) ; m/blah/, s/x//, s/x/y/
3350 (modify-syntax-entry starter "$" st)
3351 (modify-syntax-entry starter (concat "(" (list ender)) st)
3352 (modify-syntax-entry ender (concat ")" (list starter)) st))
3355 ;; We use `$' syntax class to find matching stuff, but $$
3356 ;; is recognized the same as $, so we need to check this manually.
3357 (if (and (eq starter (char-after (cperl-1+ b)))
3359 ;; $ has TeXish matching rules, so $$ equiv $...
3361 (setq reset-st (syntax-table))
3362 (set-syntax-table st)
3364 (if (<= (point) (1+ b))
3365 (error "Unfinished regular expression"))
3366 (set-syntax-table reset-st)
3368 ;; Now the problem is with m;blah;;
3370 (eq (preceding-char)
3371 (char-after (- (point) 2)))
3374 (= 0 (% (skip-chars-backward "\\\\") 2)))
3376 ;; Now we are after the first part.
3377 (and is-2arg ; Have trailing part
3379 (eq (following-char) starter) ; Empty trailing part
3381 (or (eq (char-syntax (following-char)) ?.)
3382 ;; Make trailing letter into punctuation
3383 (cperl-modify-syntax-type (point) cperl-st-punct))
3384 (setq is-2arg nil go-forward t))) ; Ignore the tail
3385 (if is-2arg ; Not number => have second part
3387 (setq i (point) i2 i)
3389 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
3391 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3392 (goto-char (match-end 0))
3393 (skip-chars-forward " \t\n\f"))
3396 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3397 (if ender (modify-syntax-entry ender "." st))
3399 (setq ender (cperl-forward-re lim end nil st-l err-l
3400 argument starter ender)
3401 ender (nth 2 ender)))))
3402 (error (goto-char lim)
3405 (set-syntax-table reset-st))
3407 (and cperl-brace-recursing
3411 "End of `%s%s%c ... %c' string/RE not found: %s"
3413 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3414 starter (or ender starter) bb)
3415 (or (car err-l) (setcar err-l b)))))
3418 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3419 (if ender (modify-syntax-entry ender "." st))))
3420 ;; i: have 2 args, after end of the first arg
3421 ;; i2: start of the second arg, if any (before delim if `ender').
3422 ;; ender: the last arg bounded by parens-like chars, the second one of them
3423 ;; starter: the starting delimiter of the first arg
3424 ;; go-forward: has 2 args, and the second part is empty
3425 (list i i2 ender starter go-forward)))
3427 (defun cperl-forward-group-in-re (&optional st-l)
3428 "Find the end of a group in a REx.
3429 Return the error message (if any). Does not work if delimiter is `)'.
3430 Works before syntax recognition is done."
3431 ;; Works *before* syntax recognition is done
3432 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3433 (let (st b reset-st)
3436 (setq st (cperl-cached-syntax-table st-l))
3437 (modify-syntax-entry ?\( "()" st)
3438 (modify-syntax-entry ?\) ")(" st)
3439 (setq reset-st (syntax-table))
3440 (set-syntax-table st)
3443 "cperl-forward-group-in-re: error %s" b)))
3444 ;; now restore the initial state
3447 (modify-syntax-entry ?\( "." st)
3448 (modify-syntax-entry ?\) "." st)))
3450 (set-syntax-table reset-st))
3454 (defvar font-lock-string-face)
3455 ;;(defvar font-lock-reference-face)
3456 (defvar font-lock-constant-face)
3457 (defsubst cperl-postpone-fontification (b e type val &optional now)
3458 ;; Do after syntactic fontification?
3459 (if cperl-syntaxify-by-font-lock
3460 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3461 (put-text-property b e type val)))
3463 ;;; Here is how the global structures (those which cannot be
3464 ;;; recognized locally) are marked:
3466 ;; Start-to-end is marked `in-pod' ==> t
3467 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3468 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3470 ;; Start-to-end is marked `here-doc-group' ==> t
3471 ;; The body is marked `syntax-type' ==> `here-doc'
3472 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3474 ;; First line (to =) marked `first-format-line' ==> t
3475 ;; After-this--to-end is marked `syntax-type' ==> `format'
3476 ;; d) 'Q'uoted string:
3477 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3478 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3479 ;; second part of s///e is marked `syntax-type' ==> `multiline'
3480 ;; e) Attributes of subroutines: `attrib-group' ==> t
3481 ;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3482 ;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3484 ;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3485 ;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
3487 (defun cperl-unwind-to-safe (before &optional end)
3488 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3489 (let ((pos (point)) opos)
3490 (while (and pos (progn
3492 (get-text-property (setq pos (point)) 'syntax-type)))
3494 pos (cperl-beginning-of-property pos 'syntax-type))
3495 (if (eq pos (point-min))
3500 (goto-char (cperl-1- pos))
3503 (goto-char (setq pos (cperl-1- pos))))
3505 (goto-char (point-min))))
3507 (and (looking-at "\n*=")
3508 (/= 0 (skip-chars-backward "\n"))
3512 ;; Do the same for end, going small steps
3514 (while (and end (< end (point-max))
3515 (get-text-property end 'syntax-type))
3517 end (next-single-property-change end 'syntax-type nil (point-max)))
3518 (if end (progn (goto-char end)
3519 (or (bolp) (forward-line 1))
3520 (setq end (point)))))
3523 ;;; These are needed for byte-compile (at least with v19)
3524 (defvar cperl-nonoverridable-face)
3525 (defvar font-lock-variable-name-face)
3526 (defvar font-lock-function-name-face)
3527 (defvar font-lock-keyword-face)
3528 (defvar font-lock-builtin-face)
3529 (defvar font-lock-type-face)
3530 (defvar font-lock-comment-face)
3531 (defvar font-lock-warning-face)
3533 (defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3534 "Syntactically mark (and fontify) attributes of a subroutine.
3535 Should be called with the point before leading colon of an attribute."
3536 ;; Works *before* syntax recognition is done
3537 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3538 (let (st b p reset-st after-first (start (point)) start1 end1)
3542 "\\(" ; 1=optional? colon
3543 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3545 (if after-first "?" "")
3546 ;; No space between name and paren allowed...
3547 "\\(\\sw+\\)" ; 3=name
3548 "\\((\\)?")) ; 4=optional paren
3549 (and (match-beginning 1)
3550 (cperl-postpone-fontification
3551 (match-beginning 0) (cperl-1+ (match-beginning 0))
3552 'face font-lock-constant-face))
3553 (setq start1 (match-beginning 3) end1 (match-end 3))
3554 (cperl-postpone-fontification start1 end1
3555 'face font-lock-constant-face)
3556 (goto-char end1) ; end or before `('
3557 (if (match-end 4) ; Have attribute arguments...
3560 (setq st (cperl-cached-syntax-table st-l))
3561 (modify-syntax-entry ?\( "()" st)
3562 (modify-syntax-entry ?\) ")(" st))
3563 (setq reset-st (syntax-table) p (point))
3564 (set-syntax-table st)
3566 (set-syntax-table reset-st)
3568 (cperl-commentify p (point) t))) ; mark as string
3569 (forward-comment (buffer-size))
3570 (setq after-first t))
3572 "L%d: attribute `%s': %s"
3573 (count-lines (point-min) (point))
3574 (and start1 end1 (buffer-substring start1 end1)) b)
3578 (put-text-property start (point)
3579 'attrib-group (if (looking-at "{") t 0))
3581 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3582 ;; Apparently, we do not need `multiline': faces added now
3583 (put-text-property (+ 3 pos) (cperl-1+ (point))
3584 'syntax-type 'sub-decl))
3585 (and b-fname ; Fontify here: the following condition
3586 (cperl-postpone-fontification ; is too hard to determine by
3587 b-fname e-fname 'face ; a REx, so do it here
3588 (if (looking-at "{")
3589 font-lock-function-name-face
3590 font-lock-variable-name-face)))))
3591 ;; now restore the initial state
3594 (modify-syntax-entry ?\( "." st)
3595 (modify-syntax-entry ?\) "." st)))
3597 (set-syntax-table reset-st))))
3599 (defsubst cperl-look-at-leading-count (is-x-REx e)
3602 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3603 (1- e) t)) ; return nil on failure, no moving
3604 (if (eq ?\{ (preceding-char)) nil
3605 (cperl-postpone-fontification
3606 (1- (point)) (point)
3607 'face font-lock-warning-face))))
3609 ;; Do some smarter-highlighting
3610 ;; XXXX Currently ignores alphanum/dash delims,
3611 (defsubst cperl-highlight-charclass (endbracket dashface bsface onec-space)
3612 (let ((l '(1 5 7)) ll lle lll
3613 ;; 2 groups, the first takes the whole match (include \[trnfabe])
3614 (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{[^{}]*}" "\\)")))
3615 (while ; look for unescaped - between non-classes
3617 ;; On 19.33, certain simplifications lead
3618 ;; to bugs (as in [^a-z] \\| [trnfabe] )
3619 (concat ; 1: SingleChar (include \[trnfabe])
3621 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3622 "\\(" ; 3: DASH SingleChar (match optionally)
3624 singleChar ; 5: SingleChar
3625 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3628 "\\(" ; 7: other escapes
3629 "\\\\[pP]" "\\([^{]\\|{[^{}]*}\\)"
3630 "\\|" "\\\\[^pP]" "\\)"
3633 (if (match-beginning 4)
3634 (cperl-postpone-fontification
3635 (match-beginning 4) (match-end 4)
3637 ;; save match data (for looking-at)
3638 (setq lll (mapcar (function (lambda (elt) (cons (match-beginning elt)
3639 (match-end elt)))) l))
3644 ;; (message "Got %s of %s" ll l)
3645 (if (and ll (eq (char-after ll) ?\\ ))
3648 (cperl-postpone-fontification ll (1+ ll)
3650 (if (looking-at "\\\\[a-zA-Z0-9]")
3651 (cperl-postpone-fontification (1+ ll) lle
3652 'face onec-space))))
3653 (setq lll (cdr lll))))
3654 (goto-char endbracket) ; just in case something misbehaves???
3657 ;;; Debugging this may require (setq max-specpdl-size 2000)...
3658 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
3659 "Scans the buffer for hard-to-parse Perl constructions.
3660 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3661 the sections using `cperl-pod-head-face', `cperl-pod-face',
3664 (or min (setq min (point-min)
3665 cperl-syntax-state nil
3666 cperl-syntax-done-to min))
3667 (or max (setq max (point-max)))
3668 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3669 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3670 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
3671 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3672 (modified (buffer-modified-p)) overshoot is-o-REx name
3673 (inhibit-modification-hooks t)
3674 (cperl-font-locking t)
3675 (use-syntax-state (and cperl-syntax-state
3676 (>= min (car cperl-syntax-state))))
3677 (state-point (if use-syntax-state
3678 (car cperl-syntax-state)
3680 (state (if use-syntax-state
3681 (cdr cperl-syntax-state)))
3682 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3683 (st-l (list nil)) (err-l (list nil))
3684 ;; Somehow font-lock may be not loaded yet...
3685 ;; (e.g., when building TAGS via command-line call)
3686 (font-lock-string-face (if (boundp 'font-lock-string-face)
3687 font-lock-string-face
3688 'font-lock-string-face))
3689 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
3690 font-lock-constant-face
3691 'font-lock-constant-face))
3692 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
3693 (if (boundp 'font-lock-function-name-face)
3694 font-lock-function-name-face
3695 'font-lock-function-name-face))
3696 (font-lock-variable-name-face ; interpolated vars and ({})-code
3697 (if (boundp 'font-lock-variable-name-face)
3698 font-lock-variable-name-face
3699 'font-lock-variable-name-face))
3700 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3701 (if (boundp 'font-lock-function-name-face)
3702 font-lock-function-name-face
3703 'font-lock-function-name-face))
3704 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3705 (if (boundp 'font-lock-constant-face)
3706 font-lock-constant-face
3707 'font-lock-constant-face))
3708 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3709 (if (boundp 'font-lock-builtin-face)
3710 font-lock-builtin-face
3711 'font-lock-builtin-face))
3712 (font-lock-comment-face
3713 (if (boundp 'font-lock-comment-face)
3714 font-lock-comment-face
3715 'font-lock-comment-face))
3716 (font-lock-warning-face
3717 (if (boundp 'font-lock-warning-face)
3718 font-lock-warning-face
3719 'font-lock-warning-face))
3720 (my-cperl-REx-ctl-face ; (|)
3721 (if (boundp 'font-lock-keyword-face)
3722 font-lock-keyword-face
3723 'font-lock-keyword-face))
3724 (my-cperl-REx-modifiers-face ; //gims
3725 (if (boundp 'cperl-nonoverridable-face)
3726 cperl-nonoverridable-face
3727 'cperl-nonoverridable-face))
3728 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3729 (if (boundp 'font-lock-type-face)
3731 'font-lock-type-face))
3732 (stop-point (if ignore-max
3737 "\\(\\`\n?\\|^\n\\)=" ; POD
3739 ;; One extra () before this:
3742 ;; First variant "BLAH" or just ``.
3743 "[ \t]*" ; Yes, whitespace is allowed!
3744 "\\([\"'`]\\)" ; 2 + 1 = 3
3745 "\\([^\"'`\n]*\\)" ; 3 + 1
3748 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3749 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3750 ;; Do not have <<= or << 30 or <<30 or << $blah.
3751 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3752 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3755 ;; 1+6 extra () before this:
3756 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
3757 (if cperl-use-syntax-table-text-property
3760 ;; 1+6+2=9 extra () before this:
3761 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
3763 ;; 1+6+2+1=10 extra () before this:
3764 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3766 ;; 1+6+2+1+1=11 extra () before this
3767 "\\<sub\\>" ; sub with proto/attr
3769 cperl-white-and-comment-rex
3770 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3772 cperl-maybe-white-and-comment-rex
3773 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
3775 ;; 1+6+2+1+1+6=17 extra () before this:
3776 "\\$\\(['{]\\)" ; $' or ${foo}
3778 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3779 ;; we do not support intervening comments...):
3780 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3781 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
3783 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3784 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
3786 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
3792 (message "Scanning for \"hard\" Perl constructions..."))
3793 ;;(message "find: %s --> %s" min max)
3794 (and cperl-pod-here-fontify
3795 ;; We had evals here, do not know why...
3796 (setq face cperl-pod-face
3797 head-face cperl-pod-head-face
3798 here-face cperl-here-face))
3799 (remove-text-properties min max
3800 '(syntax-type t in-pod t syntax-table t
3811 ;; Need to remove face as well...
3813 ;; 'emx not supported by Emacs since at least 21.1.
3814 (and (featurep 'xemacs) (eq system-type 'emx)
3816 (let ((case-fold-search t))
3817 (looking-at "extproc[ \t]")) ; Analogue of #!
3818 (cperl-commentify min
3823 (re-search-forward search max t))
3824 (setq tmpend nil) ; Valid for most cases
3825 (setq b (match-beginning 0)
3826 state (save-excursion (parse-partial-sexp
3827 state-point b nil nil state))
3830 ;; 1+6+2+1+1+6=17 extra () before this:
3832 ((match-beginning 18) ; $' or ${foo}
3833 (if (eq (preceding-char) ?\') ; $'
3835 (setq b (1- (point))
3836 state (parse-partial-sexp
3837 state-point (1- b) nil nil state)
3839 (if (nth 3 state) ; in string
3840 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3843 (setq bb (match-beginning 0))
3844 (cperl-modify-syntax-type bb cperl-st-punct)))
3845 ;; No processing in strings/comments beyond this point:
3846 ((or (nth 3 state) (nth 4 state))
3847 t) ; Do nothing in comment/string
3848 ((match-beginning 1) ; POD section
3849 ;; "\\(\\`\n?\\|^\n\\)="
3850 (setq b (match-beginning 0)
3851 state (parse-partial-sexp
3852 state-point b nil nil state)
3854 (if (or (nth 3 state) (nth 4 state)
3855 (looking-at "cut\\>"))
3856 (if (or (nth 3 state) (nth 4 state) ignore-max)
3857 nil ; Doing a chunk only
3858 (message "=cut is not preceded by a POD section")
3859 (or (car err-l) (setcar err-l (point))))
3864 tb (match-beginning 0)
3865 b1 nil) ; error condition
3866 ;; We do not search to max, since we may be called from
3867 ;; some hook of fontification, and max is random
3868 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3871 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3873 (message "=cut is not preceded by an empty line")
3875 (or (car err-l) (setcar err-l b))))))
3876 (beginning-of-line 2) ; An empty line after =cut is not POD!
3880 (remove-text-properties
3881 max e '(syntax-type t in-pod t syntax-table t
3893 (put-text-property b e 'in-pod t)
3894 (put-text-property b e 'syntax-type 'in-pod)
3896 (while (re-search-forward "\n\n[ \t]" e t)
3897 ;; We start 'pod 1 char earlier to include the preceding line
3899 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3900 (cperl-put-do-not-fontify b (point) t)
3901 ;; mark the non-literal parts as PODs
3902 (if cperl-pod-here-fontify
3903 (cperl-postpone-fontification b (point) 'face face t))
3904 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3907 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3908 (cperl-put-do-not-fontify (point) e t)
3909 (if cperl-pod-here-fontify
3911 ;; mark the non-literal parts as PODs
3912 (cperl-postpone-fontification (point) e 'face face t)
3915 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3917 (cperl-postpone-fontification
3918 (match-beginning 1) (match-end 1)
3920 (while (re-search-forward
3922 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3925 (cperl-postpone-fontification
3926 (match-beginning 1) (match-end 1)
3928 (cperl-commentify bb e nil)
3930 (or (eq e (point-max))
3931 (forward-char -1)))) ; Prepare for immediate POD start.
3933 ;; We can do many here-per-line;
3934 ;; but multiline quote on the same line as <<HERE confuses us...
3935 ;; ;; One extra () before this:
3938 ;; ;; First variant "BLAH" or just ``.
3939 ;; "[ \t]*" ; Yes, whitespace is allowed!
3940 ;; "\\([\"'`]\\)" ; 2 + 1
3941 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3944 ;; ;; Second variant: Identifier or \ID or empty
3945 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3946 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3947 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3948 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3950 ((match-beginning 2) ; 1 + 1
3952 tb (match-beginning 0)
3953 c (and ; not HERE-DOC
3956 (or (looking-at "[ \t]*(") ; << function_call()
3957 (save-excursion ; 1 << func_name, or $foo << 10
3961 ;;; XXX What to do: foo <<bar ???
3962 ;;; XXX Need to support print {a} <<B ???
3965 ; $foo << b; $f .= <<B;
3966 ; ($f+1) << b; a($f) . <<B;
3967 ; foo 1, <<B; $x{a} <<b;
3969 ((looking-at "[0-9$({]")
3972 (looking-at "[ \t]*<<")
3978 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
3980 (error nil))) ; func(<<EOF)
3981 (and (not (match-beginning 6)) ; Empty
3983 "[ \t]*[=0-9$@%&(]"))))))
3984 (if c ; Not here-doc
3986 (setq c (match-end 2)) ; 1 + 1
3987 (if (match-beginning 5) ;4 + 1
3988 (setq b1 (match-beginning 5) ; 4 + 1
3989 e1 (match-end 5)) ; 4 + 1
3990 (setq b1 (match-beginning 4) ; 3 + 1
3991 e1 (match-end 4))) ; 3 + 1
3992 (setq tag (buffer-substring b1 e1)
3993 qtag (regexp-quote tag))
3994 (cond (cperl-pod-here-fontify
3995 ;; Highlight the starting delimiter
3996 (cperl-postpone-fontification
3997 b1 e1 'face my-cperl-delimiters-face)
3998 (cperl-put-do-not-fontify b1 e1 t)))
4002 (goto-char end-of-here-doc))
4004 ;; We do not search to max, since we may be called from
4005 ;; some hook of fontification, and max is random
4006 (or (and (re-search-forward (concat "^" qtag "$")
4008 ;;;(eq (following-char) ?\n) ; XXXX WHY???
4010 (progn ; Pretend we matched at the end
4011 (goto-char (point-max))
4012 (re-search-forward "\\'")
4013 (message "End of here-document `%s' not found." tag)
4014 (or (car err-l) (setcar err-l b))))
4015 (if cperl-pod-here-fontify
4017 ;; Highlight the ending delimiter
4018 (cperl-postpone-fontification
4019 (match-beginning 0) (match-end 0)
4020 'face my-cperl-delimiters-face)
4021 (cperl-put-do-not-fontify b (match-end 0) t)
4022 ;; Highlight the HERE-DOC
4023 (cperl-postpone-fontification b (match-beginning 0)
4025 (setq e1 (cperl-1+ (match-end 0)))
4026 (put-text-property b (match-beginning 0)
4027 'syntax-type 'here-doc)
4028 (put-text-property (match-beginning 0) e1
4029 'syntax-type 'here-doc-delim)
4030 (put-text-property b e1 'here-doc-group t)
4031 ;; This makes insertion at the start of HERE-DOC update
4032 ;; the whole construct:
4033 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
4034 (cperl-commentify b e1 nil)
4035 (cperl-put-do-not-fontify b (match-end 0) t)
4036 ;; Cache the syntax info...
4037 (setq cperl-syntax-state (cons state-point state))
4038 ;; ... and process the rest of the line...
4040 (elt ; non-inter ignore-max
4041 (cperl-find-pods-heres c i t end t e1) 1))
4042 (if (and overshoot (> overshoot (point)))
4043 (goto-char overshoot)
4044 (setq overshoot e1))
4048 ((match-beginning 8)
4049 ;; 1+6=7 extra () before this:
4050 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4052 name (if (match-beginning 8) ; 7 + 1
4053 (buffer-substring (match-beginning 8) ; 7 + 1
4054 (match-end 8)) ; 7 + 1
4056 tb (match-beginning 0))
4058 (put-text-property (point-at-bol) b 'first-format-line 't)
4059 (if cperl-pod-here-fontify
4060 (while (and (eq (forward-line) 0)
4061 (not (looking-at "^[.;]$")))
4063 ((looking-at "^#")) ; Skip comments
4064 ((and argument ; Skip argument multi-lines
4065 (looking-at "^[ \t]*{"))
4067 (setq argument nil))
4068 (argument ; Skip argument lines
4069 (setq argument nil))
4072 (setq argument (looking-at "^[^\n]*[@^]"))
4074 ;; Highlight the format line
4075 (cperl-postpone-fontification b1 (point)
4076 'face font-lock-string-face)
4077 (cperl-commentify b1 (point) nil)
4078 (cperl-put-do-not-fontify b1 (point) t))))
4079 ;; We do not search to max, since we may be called from
4080 ;; some hook of fontification, and max is random
4081 (re-search-forward "^[.;]$" stop-point 'toend))
4083 (if (looking-at "^\\.$") ; ";" is not supported yet
4085 ;; Highlight the ending delimiter
4086 (cperl-postpone-fontification (point) (+ (point) 2)
4087 'face font-lock-string-face)
4088 (cperl-commentify (point) (+ (point) 2) nil)
4089 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
4090 (message "End of format `%s' not found." name)
4091 (or (car err-l) (setcar err-l b)))
4095 (put-text-property b (point) 'syntax-type 'format))
4096 ;; qq-like String or Regexp:
4097 ((or (match-beginning 10) (match-beginning 11))
4098 ;; 1+6+2=9 extra () before this:
4099 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
4101 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
4102 (setq b1 (if (match-beginning 10) 10 11)
4103 argument (buffer-substring
4104 (match-beginning b1) (match-end b1))
4105 b (point) ; end of qq etc
4107 c (char-after (match-beginning b1))
4108 bb (char-after (1- (match-beginning b1))) ; tmp holder
4109 ;; bb == "Not a stringy"
4110 bb (if (eq b1 10) ; user variables/whatever
4111 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4112 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4113 ((eq bb ?\:) ; $opt::s
4115 (- (match-beginning b1) 2))
4117 ((eq bb ?\>) ; $foo->s
4119 (- (match-beginning b1) 2))
4122 (not (eq (char-after ; &&m/blah/
4123 (- (match-beginning b1) 2))
4126 ;; <file> or <$file>
4128 ;; Do not stringify <FH>, <$fh> :
4131 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
4132 tb (match-beginning 0))
4133 (goto-char (match-beginning b1))
4134 (cperl-backward-to-noncomment (point-min))
4136 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
4141 ;; What is below: regexp-p?
4143 (or (memq (preceding-char)
4144 (append (if (memq c '(?\? ?\<))
4147 "~{(=|&+-*!,;:[") nil))
4148 (and (eq (preceding-char) ?\})
4149 (cperl-after-block-p (point-min)))
4150 (and (eq (char-syntax (preceding-char)) ?w)
4153 ;; After these keywords `/' starts a RE. One should add all the
4154 ;; functions/builtins which expect an argument, but ...
4155 (if (eq (preceding-char) ?-)
4157 (looking-at "[a-zA-Z]\\>")
4159 (not (memq (preceding-char)
4162 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4163 (and (eq (preceding-char) ?.)
4164 (eq (char-after (- (point) 2)) ?.))
4166 ;; m|blah| ? foo : bar;
4169 cperl-use-syntax-table-text-property
4173 (looking-at "\\s|"))))))
4176 ;; Check for $a -> y
4177 (setq b1 (preceding-char)
4180 (eq (char-after (- go 2)) ?-))
4186 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4187 (goto-char (match-end 0))
4188 (skip-chars-forward " \t\n\f"))
4189 (cond ((and (eq (following-char) ?\})
4191 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4193 (skip-chars-backward " \t\n\f")
4194 (if (memq (preceding-char) (append "$@%&*" nil))
4200 (looking-at ; $foo -> {s}
4201 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4202 (and ; $foo[12] -> {s}
4203 (memq (following-char) '(?\{ ?\[))
4206 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4209 ((and (eq (following-char) ?=)
4210 (eq (char-after (1+ (point))) ?\>))
4211 ;; Check for { foo => 1, s => 2 }
4212 ;; Apparently s=> is never a substitution...
4214 ((and (eq (following-char) ?:)
4215 (eq b1 ?\{) ; Check for $ { s::bar }
4216 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
4219 (skip-chars-backward " \t\n\f")
4220 (memq (preceding-char)
4221 (append "$@%&*" nil))))
4227 ;; Skip whitespace and comments...
4228 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4229 (goto-char (match-end 0))
4230 (skip-chars-forward " \t\n\f"))
4232 (put-text-property b (point) 'syntax-type 'prestring))
4233 ;; qtag means two-arg matcher, may be reset to
4234 ;; 2 or 3 later if some special quoting is needed.
4235 ;; e1 means matching-char matcher.
4236 (setq b (point) ; before the first delimiter
4238 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
4239 ;; We do not search to max, since we may be called from
4240 ;; some hook of fontification, and max is random
4241 i (cperl-forward-re stop-point end
4243 st-l err-l argument)
4244 ;; If `go', then it is considered as 1-arg, `b1' is nil
4245 ;; as in s/foo//x; the point is before final "slash"
4246 b1 (nth 1 i) ; start of the second part
4247 tag (nth 2 i) ; ender-char, true if second part
4248 ; is with matching chars []
4249 go (nth 4 i) ; There is a 1-char part after the end
4250 i (car i) ; intermediate point
4252 ;; Before end of the second part if non-matching: ///
4253 tail (if (and i (not tag))
4255 e (if i i e1) ; end of the first part
4256 qtag nil ; need to preserve backslashitis
4257 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4258 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
4259 ;; Commenting \\ is dangerous, what about ( ?
4261 (eq (char-after i) ?\\)
4263 (and (if go (looking-at ".\\sw*x")
4264 (looking-at "\\sw*x")) ; qr//x
4266 (and (if go (looking-at ".\\sw*o")
4267 (looking-at "\\sw*o")) ; //o
4270 ;; Considered as 1arg form
4272 (cperl-commentify b (point) t)
4273 (put-text-property b (point) 'syntax-type 'string)
4275 ;; ignore other text properties:
4276 (string-match "^qw$" argument))
4277 (put-text-property b (point) 'indentable t))
4279 (setq e1 (cperl-1+ e1))
4282 (cperl-commentify b i t)
4283 (if (looking-at "\\sw*e") ; s///e
4285 ;; Cache the syntax info...
4286 (setq cperl-syntax-state (cons state-point state))
4289 (car (cperl-find-pods-heres b1 (1- (point)) t end))
4291 (goto-char (1+ max)))
4292 (if (and tag (eq (preceding-char) ?\>))
4294 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
4295 (cperl-modify-syntax-type i cperl-st-bra)))
4296 (put-text-property b i 'syntax-type 'string)
4297 (put-text-property i (point) 'syntax-type 'multiline)
4299 (put-text-property b i 'indentable t)))
4300 (cperl-commentify b1 (point) t)
4301 (put-text-property b (point) 'syntax-type 'string)
4303 (put-text-property b i 'indentable t))
4305 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
4307 ;; Now: tail: if the second part is non-matching without ///e
4308 (if (eq (char-syntax (following-char)) ?w)
4310 (forward-word-strictly 1) ; skip modifiers s///s
4311 (if tail (cperl-commentify tail (point) t))
4312 (cperl-postpone-fontification
4313 e1 (point) 'face my-cperl-REx-modifiers-face)))
4314 ;; Check whether it is m// which means "previous match"
4315 ;; and highlight differently
4317 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4318 (or (not (= (length argument) 0))
4322 ;; split // *is* using zero-pattern
4328 (not (looking-at "split\\>")))
4330 (cperl-postpone-fontification
4331 b e 'face font-lock-warning-face)
4332 (if (or i2 ; Has 2 args
4333 (and cperl-fontify-m-as-s
4335 (string-match "^\\(m\\|qr\\)$" argument)
4336 (and (eq 0 (length argument))
4337 (not (eq ?\< (char-after b)))))))
4339 (cperl-postpone-fontification
4340 b (cperl-1+ b) 'face my-cperl-delimiters-face)
4341 (cperl-postpone-fontification
4342 (1- e) e 'face my-cperl-delimiters-face)))
4343 (if (and is-REx cperl-regexp-scan)
4344 ;; Process RExen: embedded comments, charclasses and ]
4345 ;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4346 ;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4347 ;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4348 ;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4349 ;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4350 ;;;m^a[\^b]c^ + m.a[^b]\.c.;
4354 (cperl-look-at-leading-count is-x-REx e)
4358 (if (eq (char-after b) ?\#)
4359 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4360 "\\((\\?#\\)\\|\\(#\\)")
4361 ;; keep the same count: add a fake group
4362 (if (eq (char-after b) ?\#)
4363 "\\((\\?\\\\#\\)\\(\\)"
4364 "\\((\\?#\\)\\(\\)"))
4370 ;; XXXX Will not be able to use it in s)))
4371 (if (eq (char-after b) ?\) )
4372 "\\())))\\)" ; Will never match
4373 (if (eq (char-after b) ?? )
4374 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4375 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4376 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4377 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4378 "\\(" ;; XXXX 1-char variables, exc. |()\s
4381 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4383 "{[^{}]*}" ; only one-level allowed
4387 "\\(" ;;8,9:code part of array/hash elt
4393 ;; XXXX: what if u is delim?
4401 "\\\\[luLUEQbBAzZG]"
4404 "\\(" ; 10 group opener follower
4405 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4407 "\\?[:=!>?{]" ; "?" something
4409 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4411 "\\?([0-9]+)" ; (?(1)foo|bar)
4419 "\\\\\\(.\\)" ; 12=\SYMBOL
4422 (and (< (point) (1- e))
4423 (re-search-forward hairy-RE (1- e) 'to-end))
4424 (goto-char (match-beginning 0))
4425 (setq REx-subgr-start (point)
4426 was-subgr (following-char))
4428 ((match-beginning 6) ; 0-length builtins, groups
4429 (goto-char (match-end 0))
4430 (if (match-beginning 11)
4431 (goto-char (match-beginning 11)))
4434 (cperl-postpone-fontification
4435 (match-beginning 0) (point)
4438 ((eq was-subgr ?\) )
4443 (if (if (eq (char-after b) ?? )
4444 (looking-at "(\\\\\\?")
4445 (eq (char-after (1+ (point))) ?\?))
4446 my-cperl-REx-0length-face
4447 my-cperl-REx-ctl-face)
4448 font-lock-warning-face))
4449 (error font-lock-warning-face)))
4450 ((eq was-subgr ?\| )
4451 my-cperl-REx-ctl-face)
4452 ((eq was-subgr ?\$ )
4453 (if (> (point) (1+ REx-subgr-start))
4456 (match-beginning 0) (point)
4459 (if (and (eq (match-beginning 0)
4463 font-lock-variable-name-face)
4464 my-cperl-REx-spec-char-face))
4465 ((memq was-subgr (append "^." nil) )
4466 my-cperl-REx-spec-char-face)
4467 ((eq was-subgr ?\( )
4468 (if (not (match-beginning 10))
4469 my-cperl-REx-ctl-face
4470 my-cperl-REx-0length-face))
4471 (t my-cperl-REx-0length-face)))
4472 (if (and (memq was-subgr (append "(|" nil))
4473 (not (string-match "(\\?[-imsx]+)"
4475 (cperl-look-at-leading-count is-x-REx e))
4476 (setq was-subgr nil)) ; We do stuff here
4477 ((match-beginning 12) ; \SYMBOL
4481 ;; How many chars to not highlight:
4482 ;; 0-len special-alnums in other branch =>
4483 ;; Generic: \non-alnum (1), \alnum (1+face)
4484 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4485 (setq REx-subgr-start (point)
4486 qtag (preceding-char))
4487 (cperl-postpone-fontification
4488 (- (point) 2) (- (point) 1) 'face
4490 (append "ghijkmoqvFHIJKMORTVY" nil))
4491 font-lock-warning-face
4492 my-cperl-REx-0length-face))
4493 (if (and (eq (char-after b) qtag)
4494 (memq qtag (append ".])^$|*?+" nil)))
4496 (if (and cperl-use-syntax-table-text-property
4499 REx-subgr-start (1- (point))
4500 'syntax-table cperl-st-punct))
4501 (cperl-postpone-fontification
4502 (1- (point)) (point) 'face
4503 ; \] can't appear below
4504 (if (memq qtag (append ".]^$" nil))
4505 'my-cperl-REx-spec-char-face
4506 (if (memq qtag (append "*?+" nil))
4507 'my-cperl-REx-0length-face
4508 'my-cperl-REx-ctl-face))))) ; )|
4509 ;; Test for arguments:
4511 ;; This is not pretty: the 5.8.7 logic:
4512 ;; \0numx -> octal (up to total 3 dig)
4513 ;; \DIGIT -> backref unless \0
4514 ;; \DIGITs -> backref if valid
4515 ;; otherwise up to 3 -> octal
4516 ;; Do not try to distinguish, we guess
4517 ((or (and (memq qtag (append "01234567" nil))
4519 "\\=[01234567]?[01234567]?"
4521 (and (memq qtag (append "89" nil))
4523 "\\=[0123456789]*" (1- e) 'to-end))
4526 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4528 (and (memq qtag (append "pPN" nil))
4529 (re-search-forward "\\={[^{}]+}\\|."
4531 (eq (char-syntax qtag) ?w))
4532 (cperl-postpone-fontification
4533 (1- REx-subgr-start) (point)
4534 'face my-cperl-REx-length1-face))))
4535 (setq was-subgr nil)) ; We do stuff here
4536 ((match-beginning 3) ; [charclass]
4537 ;; Highlight leader, trailer, POSIX classes
4539 (if (eq (char-after b) ?^ )
4540 (and (eq (following-char) ?\\ )
4541 (eq (char-after (cperl-1+ (point)))
4544 (and (eq (following-char) ?^ )
4546 (setq argument b ; continue? & end of last POSIX
4547 tag nil ; list of POSIX classes
4548 qtag (point)) ; after leading ^ if present
4549 (if (eq (char-after b) ?\] )
4550 (and (eq (following-char) ?\\ )
4551 (eq (char-after (cperl-1+ (point)))
4553 (setq qtag (1+ qtag))
4555 (and (eq (following-char) ?\] )
4557 (setq REx-subgr-end qtag) ;End smart-highlighted
4558 ;; Apparently, I can't put \] into a charclass
4559 ;; in m]]: m][\\\]\]] produces [\\]]
4560 ;;; POSIX? [:word:] [:^word:] only inside []
4561 ;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4562 (while ; look for unescaped ]
4565 (if (eq (char-after b) ?\] )
4566 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4567 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4569 ;; Is this ] an end of POSIX class?
4572 (search-backward "[" argument t)
4573 (< REx-subgr-start (point))
4574 (setq argument (point)) ; POSIX-start
4575 (or ; Should work with delim = \
4576 (not (eq (preceding-char) ?\\ ))
4577 ;; XXXX Double \\ is needed with 19.33
4578 (= (% (skip-chars-backward "\\\\") 2) 0))
4581 ((eq (char-after b) ?\] )
4582 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4583 ((eq (char-after b) ?\: )
4584 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4585 ((eq (char-after b) ?^ )
4586 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:]")
4587 ((eq (char-syntax (char-after b))
4590 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4591 (char-to-string (char-after b))
4593 (t "\\\\*\\[:\\^?\\sw*:]")))
4594 (goto-char REx-subgr-end)
4595 (cperl-highlight-charclass
4596 argument my-cperl-REx-spec-char-face
4597 my-cperl-REx-0length-face my-cperl-REx-length1-face)))
4598 (setq tag (cons (cons argument (point))
4601 REx-subgr-end argument) ; continue
4602 (setq argument nil)))
4604 (message "Couldn't find end of charclass in a REx, pos=%s"
4606 (setq argument (1- (point)))
4607 (goto-char REx-subgr-end)
4608 (cperl-highlight-charclass
4609 argument my-cperl-REx-spec-char-face
4610 my-cperl-REx-0length-face my-cperl-REx-length1-face)
4612 ;; Highlight starter, trailer, POSIX
4613 (if (and cperl-use-syntax-table-text-property
4614 (> (- (point) 2) REx-subgr-start))
4616 (1+ REx-subgr-start) (1- (point))
4617 'syntax-table cperl-st-punct))
4618 (cperl-postpone-fontification
4619 REx-subgr-start qtag
4620 'face my-cperl-REx-spec-char-face)
4621 (cperl-postpone-fontification
4622 (1- (point)) (point) 'face
4623 my-cperl-REx-spec-char-face)
4624 (if (eq (char-after b) ?\] )
4625 (cperl-postpone-fontification
4626 (- (point) 2) (1- (point))
4627 'face my-cperl-REx-0length-face))
4629 (cperl-postpone-fontification
4630 (car (car tag)) (cdr (car tag))
4631 'face font-lock-variable-name-face) ;my-cperl-REx-length1-face
4632 (setq tag (cdr tag)))
4633 (setq was-subgr nil)) ; did facing already
4635 ((and (match-beginning 2) ; #-comment
4636 (/= (match-beginning 2) (match-end 2)))
4637 (beginning-of-line 2)
4639 (goto-char (1- e))))
4640 ((match-beginning 4) ; character "]"
4641 (setq was-subgr nil) ; We do stuff here
4642 (goto-char (match-end 0))
4643 (if cperl-use-syntax-table-text-property
4645 (1- (point)) (point)
4646 'syntax-table cperl-st-punct))
4647 (cperl-postpone-fontification
4648 (1- (point)) (point)
4649 'face font-lock-warning-face))
4650 ((match-beginning 5) ; before (?{}) (??{})
4651 (setq tag (match-end 0))
4653 (cperl-forward-group-in-re st-l))
4655 (setq qtag "no matching `)' found"))
4656 (and (not (eq (char-after (- (point) 2))
4658 (setq qtag "Can't find })")))
4661 (message "%s" qtag))
4662 (cperl-postpone-fontification
4663 (1- tag) (1- (point))
4664 'face font-lock-variable-name-face)
4665 (cperl-postpone-fontification
4666 REx-subgr-start (1- tag)
4667 'face my-cperl-REx-spec-char-face)
4668 (cperl-postpone-fontification
4669 (1- (point)) (point)
4670 'face my-cperl-REx-spec-char-face)
4671 (if cperl-use-syntax-table-text-property
4674 (- (point) 2) (1- (point))
4675 'syntax-table cperl-st-cfence)
4677 (+ REx-subgr-start 2)
4678 (+ REx-subgr-start 3)
4679 'syntax-table cperl-st-cfence))))
4680 (setq was-subgr nil))
4682 ;; Inside "(" and "\" arn't special in any way
4683 ;; Works also if the outside delimiters are ().
4684 (or;;(if (eq (char-after b) ?\) )
4685 ;;(re-search-forward
4686 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4688 (search-forward ")" (1- e) 'toend)
4691 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4697 (setq REx-subgr-end (point))
4699 REx-subgr-start REx-subgr-end nil)
4700 (cperl-postpone-fontification
4701 REx-subgr-start REx-subgr-end
4702 'face font-lock-comment-face))))))
4703 (if (and is-REx is-x-REx)
4704 (put-text-property (1+ b) (1- e)
4705 'syntax-subtype 'x-REx)))
4706 (if (and i2 e1 (or (not b1) (> e1 b1)))
4707 (progn ; No errors finding the second part...
4708 (cperl-postpone-fontification
4709 (1- e1) e1 'face my-cperl-delimiters-face)
4710 (if (and (not (eobp))
4711 (assoc (char-after b) cperl-starters))
4713 (cperl-postpone-fontification
4714 b1 (1+ b1) 'face my-cperl-delimiters-face)
4715 (put-text-property b1 (1+ b1)
4719 ((match-beginning 17) ; sub with prototype or attribute
4720 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4721 ;;"\\<sub\\>\\(" ;12
4722 ;; cperl-white-and-comment-rex ;13
4723 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4724 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4725 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4726 (setq b1 (match-beginning 14) e1 (match-end 14))
4727 (if (memq (char-after (1- b))
4728 '(?\$ ?\@ ?\% ?\& ?\*))
4731 (if (eq (char-after (match-beginning 17)) ?\( )
4733 (cperl-commentify ; Prototypes; mark as string
4734 (match-beginning 17) (match-end 17) t)
4735 (goto-char (match-end 0))
4736 ;; Now look for attributes after prototype:
4737 (forward-comment (buffer-size))
4738 (and (looking-at ":[^:]")
4739 (cperl-find-sub-attrs st-l b1 e1 b)))
4740 ;; treat attributes without prototype
4741 (goto-char (match-beginning 17))
4742 (cperl-find-sub-attrs st-l b1 e1 b))))
4743 ;; 1+6+2+1+1+6+1=18 extra () before this:
4744 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4745 ((match-beginning 19) ; old $abc'efg syntax
4746 (setq bb (match-end 0))
4747 ;;;(if (nth 3 state) nil ; in string
4748 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
4750 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
4751 ;; "__\\(END\\|DATA\\)__"
4752 ((match-beginning 20) ; __END__, __DATA__
4753 (setq bb (match-end 0))
4754 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4755 (cperl-commentify b bb nil)
4757 ;; "\\\\\\(['`\"($]\\)"
4758 ((match-beginning 21)
4759 ;; Trailing backslash; make non-quoting outside string/comment
4760 (setq bb (match-end 0))
4762 (skip-chars-backward "\\\\")
4763 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4764 (cperl-modify-syntax-type b cperl-st-punct)
4766 (t (error "Error in regexp of the sniffer")))
4767 (if (> (point) stop-point)
4770 (message "Garbage after __END__/__DATA__ ignored")
4771 (message "Unbalanced syntax found while scanning")
4772 (or (car err-l) (setcar err-l b)))
4773 (goto-char stop-point))))
4774 (setq cperl-syntax-state (cons state-point state)
4775 ;; Do not mark syntax as done past tmpend???
4776 cperl-syntax-done-to (or tmpend (max (point) max)))
4777 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4779 (if (car err-l) (goto-char (car err-l))
4781 (message "Scanning for \"hard\" Perl constructions... done"))))
4782 (and (buffer-modified-p)
4784 (set-buffer-modified-p nil))
4785 ;; I do not understand what this is doing here. It breaks font-locking
4786 ;; because it resets the syntax-table from font-lock-syntax-table to
4787 ;; cperl-mode-syntax-table.
4788 ;; (set-syntax-table cperl-mode-syntax-table)
4790 (list (car err-l) overshoot)))
4792 (defun cperl-find-pods-heres-region (min max)
4794 (cperl-find-pods-heres min max))
4796 (defun cperl-backward-to-noncomment (lim)
4797 ;; Stops at lim or after non-whitespace that is not in comment
4798 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
4800 (while (and (not stop) (> (point) (or lim (point-min))))
4801 (skip-chars-backward " \t\n\f" lim)
4804 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4805 '(pod here-doc here-doc-delim))
4807 (cperl-unwind-to-safe nil)
4808 (setq pr (get-text-property (point) 'syntax-type))))
4809 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4810 (not (memq pr '(string prestring))))
4811 (progn (cperl-to-comment-or-eol) (bolp))
4813 (skip-chars-backward " \t")
4814 (if (< p (point)) (goto-char p))
4817 ;; Used only in `cperl-calculate-indent'...
4818 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4819 ;; Positions is before ?\{. Checks whether it starts a block.
4820 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4821 (cperl-backward-to-noncomment (point-min))
4822 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4823 ; Label may be mixed up with `$blah :'
4824 (save-excursion (cperl-after-label))
4825 (get-text-property (cperl-1- (point)) 'attrib-group)
4826 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4829 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr', `constant'
4830 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4831 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\|constant\\)\\>")))
4832 ;; sub bless::foo {}
4834 (cperl-backward-to-noncomment (point-min))
4835 (and (eq (preceding-char) ?b)
4838 (looking-at "sub[ \t\n\f#]")))))))))
4840 ;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4841 ;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4842 ;;; may be a part of an in-statement construct, such as
4843 ;;; ${something()}, print {FH} $data.
4844 ;;; Moreover, one takes positive approach (looks for else,grep etc)
4845 ;;; another negative (looks for bless,tr etc)
4846 (defun cperl-after-block-p (lim &optional pre-block)
4847 "Return true if the preceding } (if PRE-BLOCK, following {) delimits a block.
4848 Would not look before LIM. Assumes that LIM is a good place to begin a
4849 statement. The kind of block we treat here is one after which a new
4850 statement would start; thus the block in ${func()} does not count."
4854 (or pre-block (forward-sexp -1))
4855 (cperl-backward-to-noncomment lim)
4856 (or (eq (point) lim)
4857 ;; if () {} // sub f () {} // sub f :a(') {}
4858 (eq (preceding-char) ?\) )
4860 (save-excursion (cperl-after-label))
4862 (get-text-property (cperl-1- (point)) 'attrib-group)
4863 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
4866 ;; else {} but not else::func {}
4867 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4868 (not (looking-at "\\(\\sw\\|_\\)+::")))
4871 (cperl-backward-to-noncomment lim)
4872 (and (eq (preceding-char) ?b)
4875 (looking-at "sub[ \t\n\f#]"))))))
4876 ;; What precedes is not word... XXXX Last statement in sub???
4877 (cperl-after-expr-p lim))))
4880 (defun cperl-after-expr-p (&optional lim chars test)
4881 "Return true if the position is good for start of expression.
4882 TEST is the expression to evaluate at the found position. If absent,
4883 CHARS is a string that contains good characters to have before us (however,
4884 `}' is treated \"smartly\" if it is not in the list)."
4885 (let ((lim (or lim (point-min)))
4887 (cperl-update-syntaxification (point) (point))
4889 (while (and (not stop) (> (point) lim))
4890 (skip-chars-backward " \t\n\f" lim)
4893 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4894 ;; '(pod here-doc here-doc-delim))
4895 (if (get-text-property (point) 'here-doc-group)
4898 (cperl-beginning-of-property (point) 'here-doc-group))
4899 (beginning-of-line 0)))
4900 (if (get-text-property (point) 'in-pod)
4903 (cperl-beginning-of-property (point) 'in-pod))
4904 (beginning-of-line 0)))
4905 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
4906 ;; Else: last iteration, or a label
4907 (cperl-to-comment-or-eol) ; Will not move past "." after a format
4908 (skip-chars-backward " \t")
4909 (if (< p (point)) (goto-char p))
4911 (if (and (eq (preceding-char) ?:)
4914 (skip-chars-backward " \t\n\f" lim)
4915 (memq (char-syntax (preceding-char)) '(?w ?_))))
4916 (forward-sexp -1) ; Possibly label. Skip it
4919 (or (bobp) ; ???? Needed
4921 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
4923 (if test (eval test)
4924 (or (memq (preceding-char) (append (or chars "{;") nil))
4925 (and (eq (preceding-char) ?\})
4926 (cperl-after-block-p lim))
4927 (and (eq (following-char) ?.) ; in format: see comment above
4928 (eq (get-text-property (point) 'syntax-type)
4931 (defun cperl-backward-to-start-of-expr (&optional lim)
4934 (while (and (or (not lim)
4936 (not (cperl-after-expr-p lim)))
4938 ;; May be after $, @, $# etc of a variable
4939 (skip-chars-backward "$@%#")))
4942 (defun cperl-at-end-of-expr (&optional lim)
4943 ;; Since the SEXP approach below is very fragile, do some overengineering
4944 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4947 ;; If nothing interesting after, does as (forward-sexp -1);
4948 ;; otherwise fails, or ends at a start of following sexp.
4949 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4950 ;; may be stuck after @ or $; just put some stupid workaround now:
4954 (while (memq (preceding-char) (append "%&@$*" nil))
4957 (cperl-after-expr-p lim))))
4960 (defun cperl-forward-to-end-of-expr (&optional lim)
4964 (while (and (< (point) (or lim (point-max)))
4965 (not (cperl-at-end-of-expr)))
4969 (defun cperl-backward-to-start-of-continued-exp (lim)
4970 (if (memq (preceding-char) (append ")]}\"'`" nil))
4973 (if (<= (point) lim)
4974 (goto-char (1+ lim)))
4975 (skip-chars-forward " \t"))
4977 (defun cperl-after-block-and-statement-beg (lim)
4978 ;; We assume that we are after ?\}
4980 (cperl-after-block-p lim)
4983 (cperl-backward-to-noncomment (point-min))
4986 (not (= (char-syntax (preceding-char)) ?w))
4991 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
4994 (defun cperl-indent-exp ()
4995 "Simple variant of indentation of continued-sexp.
4997 Will not indent comment if it starts at `comment-indent' or looks like
4998 continuation of the comment on the previous line.
5000 If `cperl-indent-region-fix-constructs', will improve spacing on
5001 conditional/loop constructs."
5004 (let ((tmp-end (point-at-eol)) top done)
5009 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
5010 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
5011 (setq top (point))) ; Get the outermost parens in line
5013 (while (< (point) tmp-end)
5014 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5015 (or (eolp) (forward-sexp 1)))
5016 (if (> (point) tmp-end) ; Yes, there an unfinished block
5018 (if (eq ?\) (preceding-char))
5019 (progn ;; Plan B: find by REGEXP block followup this line
5024 (if (eq (following-char) ?$ ) ; for my $var (list)
5027 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5028 (forward-sexp -1))))
5030 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5031 "\\|for\\(each\\)?\\>\\(\\("
5032 cperl-maybe-white-and-comment-rex
5033 "\\(my\\|local\\|our\\)\\)?"
5034 cperl-maybe-white-and-comment-rex
5035 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5039 (setq top (point)))))
5040 (error (setq done t)))
5042 (if (looking-at ; Try Plan C: continuation block
5043 (concat cperl-maybe-white-and-comment-rex
5044 "\\<\\(else\\|elsif\\|continue\\)\\>"))
5046 (goto-char (match-end 0))
5047 (setq tmp-end (point-at-eol)))
5049 (setq tmp-end (point-at-eol)))
5051 (setq tmp-end (point-marker)))
5052 (if cperl-indent-region-fix-constructs
5053 (cperl-fix-line-spacing tmp-end))
5054 (cperl-indent-region (point) tmp-end))))
5056 (defun cperl-fix-line-spacing (&optional end parse-data)
5057 "Improve whitespace in a conditional/loop construct.
5058 Returns some position at the last line."
5061 (setq end (point-max)))
5062 (let ((ee (point-at-eol))
5063 (cperl-indent-region-fix-constructs
5064 (or cperl-indent-region-fix-constructs 1))
5065 p pp ml have-brace ret)
5072 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5073 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5074 nil ; Do not need to do anything
5078 (if cperl-merge-trailing-else
5080 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5082 (search-forward "}")
5084 (skip-chars-forward " \t\n")
5085 (delete-region p (point))
5086 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5087 (beginning-of-line)))
5088 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5090 (search-forward "}")
5091 (delete-horizontal-space)
5094 (if (cperl-indent-line parse-data)
5096 (cperl-fix-line-spacing end parse-data)
5097 (setq ret (point)))))))
5100 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5102 (search-forward "}")
5103 (delete-horizontal-space)
5104 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5105 (beginning-of-line)))
5109 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5111 (forward-word-strictly 1)
5112 (delete-horizontal-space)
5113 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5114 (beginning-of-line)))
5118 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5120 (forward-word-strictly 2)
5121 (delete-horizontal-space)
5122 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5123 (beginning-of-line)))
5125 ;; foreach my $var (
5127 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5130 (delete-horizontal-space)
5132 (make-string cperl-indent-region-fix-constructs ?\s))
5133 (beginning-of-line)))
5134 ;; Looking at (with or without "}" at start, ending after "({"):
5135 ;; } foreach my $var () OR {
5137 "[ \t]*\\(}[ \t]*\\)?\\<\\(\\els\\(e\\|if\\)\\|continue\\|if\\|unless\\|while\\|for\\(each\\)?\\(\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\$[_a-zA-Z0-9]+\\)?\\|until\\)\\>\\([ \t]*(\\|[ \t\n]*{\\)\\|[ \t]*{")
5139 (setq ml (match-beginning 8)) ; "(" or "{" after control word
5140 (re-search-forward "[({]")
5143 (if (eq (following-char) ?\( )
5146 (setq pp (point))) ; past parenthesis-group
5147 ;; after `else' or nothing
5148 (if ml ; after `else'
5149 (skip-chars-backward " \t\n")
5150 (beginning-of-line))
5152 ;; Now after the sexp before the brace
5153 ;; Multiline expr should be special
5154 (setq ml (and pp (save-excursion (goto-char p)
5155 (search-forward "\n" pp t))))
5156 (if (and (or (not pp) (< pp end)) ; Do not go too far...
5157 (looking-at "[ \t\n]*{"))
5160 ((bolp) ; Were before `{', no if/else/etc
5162 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
5163 (delete-horizontal-space)
5165 cperl-extra-newline-before-brace-multiline
5166 cperl-extra-newline-before-brace)
5168 (delete-horizontal-space)
5171 (if (cperl-indent-line parse-data)
5173 (cperl-fix-line-spacing end parse-data)
5174 (setq ret (point)))))
5176 (make-string cperl-indent-region-fix-constructs ?\s))))
5177 ((and (looking-at "[ \t]*\n")
5179 cperl-extra-newline-before-brace-multiline
5180 cperl-extra-newline-before-brace)))
5182 (skip-chars-forward " \t\n")
5183 (delete-region pp (point))
5185 (make-string cperl-indent-region-fix-constructs ?\ )))
5186 ((and (looking-at "[\t ]*{")
5187 (if ml cperl-extra-newline-before-brace-multiline
5188 cperl-extra-newline-before-brace))
5189 (delete-horizontal-space)
5192 (if (cperl-indent-line parse-data)
5194 (cperl-fix-line-spacing end parse-data)
5195 (setq ret (point))))))
5196 ;; Now we are before `{'
5197 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5199 (skip-chars-forward " \t\n")
5204 (setq ml (search-forward "\n" p t))
5205 (if (or cperl-break-one-line-blocks-when-indent ml)
5206 ;; not good: multi-line BLOCK
5209 (delete-horizontal-space)
5212 (if (cperl-indent-line parse-data)
5213 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5215 (setq p (point) pp (point-at-eol)) ; May be different from ee.
5216 ;; Now check whether there is a hanging `}'
5220 cperl-fix-hanging-brace-when-indent
5222 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5226 (if (and (<= (point) pp)
5227 (eq (preceding-char) ?\} )
5228 (cperl-after-block-and-statement-beg (point-min)))
5235 (skip-chars-backward " \t")
5237 ;; `}' was the first thing on the line, insert NL *after* it.
5239 (cperl-indent-line parse-data)
5240 (search-forward "}")
5241 (delete-horizontal-space)
5243 (delete-horizontal-space)
5244 (or (eq (preceding-char) ?\;)
5246 (and (eq (preceding-char) ?\} )
5247 (cperl-after-block-p (point-min)))
5251 (if (cperl-indent-line parse-data)
5252 (setq ret (cperl-fix-line-spacing end parse-data)))
5253 (beginning-of-line)))))
5256 (defvar cperl-update-start) ; Do not need to make them local
5257 (defvar cperl-update-end)
5258 (defun cperl-delay-update-hook (beg end old-len)
5259 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5260 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
5262 (defun cperl-indent-region (start end)
5263 "Simple variant of indentation of region in CPerl mode.
5264 Should be slow. Will not indent comment if it starts at `comment-indent'
5265 or looks like continuation of the comment on the previous line.
5266 Indents all the lines whose first character is between START and END
5269 If `cperl-indent-region-fix-constructs', will improve spacing on
5270 conditional/loop constructs."
5272 (cperl-update-syntaxification end end)
5274 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
5275 (let ((indent-info (if cperl-emacs-can-parse
5276 (list nil nil nil) ; Cannot use '(), since will modify
5279 after-change-functions ; Speed it up!
5280 st comm old-comm-indent new-comm-indent p pp i empty)
5281 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
5283 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5285 new-comm-indent old-comm-indent)
5287 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5288 (or (bolp) (beginning-of-line 2))
5289 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5292 (setq empty (looking-at "[ \t]*\n"))
5293 (and (setq comm (looking-at "[ \t]*#"))
5294 (or (eq (current-indentation) (or old-comm-indent
5296 (setq old-comm-indent nil))))
5297 (if (and old-comm-indent
5299 (= (current-indentation) old-comm-indent)
5300 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5301 (not (eq (get-text-property (point) 'syntax-table)
5303 (let ((comment-column new-comm-indent))
5304 (indent-for-comment)))
5306 (setq i (cperl-indent-line indent-info))
5310 (if cperl-indent-region-fix-constructs
5311 (goto-char (cperl-fix-line-spacing end indent-info)))
5312 (if (setq old-comm-indent
5313 (and (cperl-to-comment-or-eol)
5314 (not (memq (get-text-property (point)
5317 (not (eq (get-text-property (point)
5321 (progn (indent-for-comment)
5322 (skip-chars-backward " \t")
5323 (skip-chars-backward "#")
5324 (setq new-comm-indent (current-column))))))))
5325 (beginning-of-line 2)))
5326 ;; Now run the update hooks
5327 (and after-change-functions
5330 (goto-char cperl-update-end)
5333 (goto-char cperl-update-start)
5335 (delete-char -1))))))
5337 ;; Stolen from lisp-mode with a lot of improvements
5339 (defun cperl-fill-paragraph (&optional justify iteration)
5340 "Like `fill-paragraph', but handle CPerl comments.
5341 If any of the current line is a comment, fill the comment or the
5342 block of it that point is in, preserving the comment's initial
5343 indentation and initial hashes. Behaves usually outside of comment."
5344 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
5345 (let (;; Non-nil if the current line contains a comment.
5347 fill-paragraph-function ; do not recurse
5348 ;; If has-comment, the appropriate fill-prefix for the comment.
5350 ;; Line that contains code and comment (or nil)
5352 c spaces len dc (comment-column comment-column))
5353 ;; Figure out what kind of comment we are looking at.
5358 ;; A line with nothing but a comment on it?
5359 ((looking-at "[ \t]*#[# \t]*")
5361 comment-fill-prefix (buffer-substring (match-beginning 0)
5364 ;; A line with some code, followed by a comment? Remember that the
5365 ;; semi which starts the comment shouldn't be part of a string or
5367 ((cperl-to-comment-or-eol)
5368 (setq has-comment t)
5369 (looking-at "#+[ \t]*")
5370 (setq start (point) c (current-column)
5372 (concat (make-string (current-column) ?\s)
5373 (buffer-substring (match-beginning 0) (match-end 0)))
5374 spaces (progn (skip-chars-backward " \t")
5375 (buffer-substring (point) start))
5376 dc (- c (current-column)) len (- start (point))
5377 start (point-marker))
5379 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
5380 (if (not has-comment)
5381 (fill-paragraph justify) ; Do the usual thing outside of comment
5382 ;; Narrow to include only the comment, and then fill the region.
5385 ;; Find the first line we should include in the region to fill.
5386 (if start (progn (beginning-of-line) (point))
5388 (while (and (zerop (forward-line -1))
5389 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5390 ;; We may have gone to far. Go forward again.
5391 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5394 ;; Find the beginning of the first line past the region to fill.
5396 (while (progn (forward-line 1)
5397 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5399 ;; Remove existing hashes
5400 (goto-char (point-min))
5402 (while (progn (forward-line 1) (< (point) (point-max)))
5403 (skip-chars-forward " \t")
5404 (if (looking-at "#+")
5406 (if (and (eq (point) (match-beginning 0))
5407 (not (eq (point) (match-end 0)))) nil
5409 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5410 (delete-char (- (match-end 0) (match-beginning 0)))))))
5412 ;; Lines with only hashes on them can be paragraph boundaries.
5413 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5414 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5415 (fill-prefix comment-fill-prefix))
5416 (fill-paragraph justify)))
5421 (progn (delete-char dc) (insert spaces)))
5422 (if (or (= (current-column) c) iteration) nil
5423 (setq comment-column c)
5424 (indent-for-comment)
5425 ;; Repeat once more, flagging as iteration
5426 (cperl-fill-paragraph justify t))))))
5429 (defun cperl-do-auto-fill ()
5430 ;; Break out if the line is short enough
5431 (if (> (save-excursion
5435 (let ((c (save-excursion (beginning-of-line)
5436 (cperl-to-comment-or-eol) (point)))
5437 (s (memq (following-char) '(?\s ?\t))) marker)
5439 ;; Don't break line inside code: only inside comment.
5441 (setq marker (point-marker))
5442 (fill-paragraph nil)
5444 ;; Is not enough, sometimes marker is a start of line
5445 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5446 (goto-char (match-end 0))))
5447 ;; Following space could have gone:
5448 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
5451 ;; Previous space could have gone:
5452 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
5454 (defun cperl-imenu-addback (lst &optional isback name)
5455 ;; We suppose that the lst is a DAG, unless the first element only
5456 ;; loops back, and ISBACK is set. Thus this function cannot be
5457 ;; applied twice without ISBACK set.
5458 (cond ((not cperl-imenu-addback) lst)
5461 (setq name "+++BACK+++"))
5463 (if (and (listp elt) (listp (cdr elt)))
5465 ;; In the other order it goes up
5466 ;; one level only ;-(
5467 (setcdr elt (cons (cons name lst)
5469 (cperl-imenu-addback (cdr elt) t name))))
5470 (if isback (cdr lst) lst))
5473 (defun cperl-imenu--create-perl-index (&optional regexp)
5474 (require 'imenu) ; May be called from TAGS creator
5475 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
5476 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5477 (index-meth-alist '()) meth
5478 packages ends-ranges p marker is-proto
5479 (prev-pos 0) is-pack index index1 name (end-range 0) package)
5480 (goto-char (point-min))
5481 (cperl-update-syntaxification (point-max) (point-max))
5482 ;; Search for the function
5483 (progn ;;save-match-data
5484 (while (re-search-forward
5485 (or regexp cperl-imenu--function-name-regexp-perl)
5487 ;; 2=package-group, 5=package-name 8=sub-name
5489 ((and ; Skip some noise if building tags
5490 (match-beginning 5) ; package name
5491 ;;(eq (char-after (match-beginning 2)) ?p) ; package
5492 (not (save-match-data
5493 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
5496 (or (match-beginning 2)
5497 (match-beginning 8)) ; package or sub
5498 ;; Skip if quoted (will not skip multi-line ''-strings :-():
5499 (null (get-text-property (match-beginning 1) 'syntax-table))
5500 (null (get-text-property (match-beginning 1) 'syntax-type))
5501 (null (get-text-property (match-beginning 1) 'in-pod)))
5502 (setq is-pack (match-beginning 2))
5503 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5504 ;; (goto-char (match-end 0))) ; Messes what follows
5507 (while (and ends-ranges (>= p (car ends-ranges)))
5508 ;; delete obsolete entries
5509 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5510 (setq package (or (car packages) "")
5511 end-range (or (car ends-ranges) 0))
5512 (if is-pack ; doing "package"
5514 (if (match-beginning 5) ; named package
5515 (setq name (buffer-substring (match-beginning 5)
5518 (set-text-properties 0 (length name) nil name)
5520 package (concat name "::")
5521 name (concat "package " name))
5522 ;; Support nameless packages
5523 (setq name "package;" package ""))
5526 (parse-partial-sexp (point) (point-max) -1) (point))
5527 ends-ranges (cons end-range ends-ranges)
5528 packages (cons package packages)))
5530 (or (eq (following-char) ?\;)
5531 (eq 0 (get-text-property (point) 'attrib-group)))))
5532 ;; Skip this function name if it is a prototype declaration.
5533 (if (and is-proto (not is-pack)) nil
5536 (buffer-substring (match-beginning 8) (match-end 8)))
5537 (set-text-properties 0 (length name) nil name))
5538 (setq marker (make-marker))
5539 (set-marker marker (match-end (if is-pack 2 8)))
5541 ((string-match "[:']" name)
5543 ((> p end-range) nil)
5545 (setq name (concat package name) meth t)))
5546 (setq index (cons name marker))
5548 (push index index-pack-alist)
5549 (push index index-alist))
5550 (if meth (push index index-meth-alist))
5551 (push index index-unsorted-alist)))
5552 ((match-beginning 16) ; POD section
5553 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5554 marker (make-marker))
5555 (set-marker marker (match-beginning 17))
5556 (set-text-properties 0 (length name) nil name)
5557 (setq name (concat (make-string
5558 (* 3 (- (char-after (match-beginning 16)) ?1))
5561 index (cons name marker))
5562 (setq index1 (cons (concat "=" name) (cdr index)))
5563 (push index index-pod-alist)
5564 (push index1 index-unsorted-alist)))))
5566 (if (default-value 'imenu-sort-function)
5567 (sort index-alist (default-value 'imenu-sort-function))
5568 (nreverse index-alist)))
5569 (and index-pod-alist
5570 (push (cons "+POD headers+..."
5571 (nreverse index-pod-alist))
5573 (and (or index-pack-alist index-meth-alist)
5574 (let ((lst index-pack-alist) hier-list pack elt group name)
5575 ;; Remove "package ", reverse and uniquify.
5577 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5578 (if (assoc name hier-list) nil
5579 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5580 (setq lst index-meth-alist)
5582 (setq elt (car lst) lst (cdr lst))
5583 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5584 (setq pack (substring (car elt) 0 (match-beginning 0)))
5585 (if (setq group (assoc pack hier-list))
5586 (if (listp (cdr group))
5587 ;; Have some functions already
5589 (cons (cons (substring
5591 (+ 2 (match-beginning 0)))
5594 (setcdr group (list (cons (substring
5596 (+ 2 (match-beginning 0)))
5600 (list (cons (substring
5602 (+ 2 (match-beginning 0)))
5605 (push (cons "+Hierarchy+..."
5608 (and index-pack-alist
5609 (push (cons "+Packages+..."
5610 (nreverse index-pack-alist))
5612 (and (or index-pack-alist index-pod-alist
5613 (default-value 'imenu-sort-function))
5614 index-unsorted-alist
5615 (push (cons "+Unsorted List+..."
5616 (nreverse index-unsorted-alist))
5618 (cperl-imenu-addback index-alist)))
5621 ;; Suggested by Mark A. Hershberger
5622 (defun cperl-outline-level ()
5623 (looking-at outline-regexp)
5624 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
5625 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5626 ((match-beginning 2) 0) ; package
5627 ((match-beginning 8) 1) ; sub
5628 ((match-beginning 16)
5629 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5630 (t 5))) ; should not happen
5633 (defun cperl-windowed-init ()
5634 "Initialization under windowed version."
5635 (cond ((featurep 'ps-print)
5636 (or cperl-faces-init
5638 (and (boundp 'font-lock-multiline)
5639 (setq cperl-font-lock-multiline t))
5640 (cperl-init-faces))))
5641 ((not cperl-faces-init)
5642 (add-hook 'font-lock-mode-hook
5645 (if (memq major-mode '(perl-mode cperl-mode))
5647 (or cperl-faces-init (cperl-init-faces)))))))
5648 (if (fboundp 'eval-after-load)
5651 '(or cperl-faces-init (cperl-init-faces)))))))
5653 (defvar cperl-font-lock-keywords-1 nil
5654 "Additional expressions to highlight in Perl mode. Minimal set.")
5655 (defvar cperl-font-lock-keywords nil
5656 "Additional expressions to highlight in Perl mode. Default set.")
5657 (defvar cperl-font-lock-keywords-2 nil
5658 "Additional expressions to highlight in Perl mode. Maximal set")
5660 (defun cperl-load-font-lock-keywords ()
5661 (or cperl-faces-init (cperl-init-faces))
5662 cperl-font-lock-keywords)
5664 (defun cperl-load-font-lock-keywords-1 ()
5665 (or cperl-faces-init (cperl-init-faces))
5666 cperl-font-lock-keywords-1)
5668 (defun cperl-load-font-lock-keywords-2 ()
5669 (or cperl-faces-init (cperl-init-faces))
5670 cperl-font-lock-keywords-2)
5672 (defun cperl-init-faces-weak ()
5673 ;; Allow `cperl-find-pods-heres' to run.
5674 (or (boundp 'font-lock-constant-face)
5675 (cperl-force-face font-lock-constant-face
5676 "Face for constant and label names"))
5677 (or (boundp 'font-lock-warning-face)
5678 (cperl-force-face font-lock-warning-face
5679 "Face for things which should stand out"))
5680 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5683 (defun cperl-init-faces ()
5684 (condition-case errs
5686 (require 'font-lock)
5687 (and (fboundp 'font-lock-fontify-anchored-keywords)
5688 (featurep 'font-lock-extra)
5689 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5690 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
5691 (if (fboundp 'font-lock-fontify-anchored-keywords)
5692 (setq font-lock-anchored t))
5694 t-font-lock-keywords
5696 `("[ \t]+$" 0 ',cperl-invalid-face t)
5699 "\\(^\\|[^$@%&\\]\\)\\<\\("
5702 '("if" "until" "while" "elsif" "else" "unless" "for"
5703 "foreach" "continue" "exit" "die" "last" "goto" "next"
5704 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
5705 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
5706 "\\|") ; Flow control
5707 "\\)\\>") 2) ; was "\\)[ \n\t;():,|&]"
5708 ; In what follows we use `type' style
5709 ; for overwritable builtins
5712 "\\(^\\|[^$@%&\\]\\)\\<\\("
5713 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5714 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5715 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5716 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5717 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5718 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5719 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5720 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5721 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5722 ;; "gethostbyname" "gethostent" "getlogin"
5723 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5724 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5725 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5726 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5727 ;; "getservbyport" "getservent" "getsockname"
5728 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5729 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5730 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
5731 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5732 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5733 ;; "quotemeta" "rand" "read" "readdir" "readline"
5734 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5735 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5736 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5737 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5738 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5739 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5740 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5741 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
5742 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
5743 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5744 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5745 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5746 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
5747 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5748 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5749 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5750 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5751 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5752 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5753 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5754 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5755 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5756 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5757 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5758 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5759 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5760 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5761 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5762 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
5763 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5764 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5765 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5766 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5767 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5768 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5769 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5770 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
5771 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
5772 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5773 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5774 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5775 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5776 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5777 "\\)\\>") 2 'font-lock-type-face)
5778 ;; In what follows we use `other' style
5779 ;; for nonoverwritable builtins
5780 ;; Somehow 's', 'm' are not auto-generated???
5783 "\\(^\\|[^$@%&\\]\\)\\<\\("
5784 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
5785 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5786 ;; "eval" "exists" "for" "foreach" "format" "goto"
5787 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
5788 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
5789 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5790 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5791 ;; "undef" "unless" "unshift" "untie" "until" "use"
5793 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
5794 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
5795 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5796 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
5797 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5798 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
5799 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5800 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5801 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5802 "\\|[sm]" ; Added manually
5803 "\\)\\>") 2 'cperl-nonoverridable-face)
5804 ;; (mapconcat 'identity
5805 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5806 ;; "#include" "#define" "#undef")
5808 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5809 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5810 ;; This highlights declarations and definitions differently.
5811 ;; We do not try to highlight in the case of attributes:
5812 ;; it is already done by `cperl-find-pods-heres'
5813 (list (concat "\\<sub"
5814 cperl-white-and-comment-rex ; whitespace/comments
5815 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5817 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5818 "([^()]*)\\)?" ; prototype
5819 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5821 2 (if cperl-font-lock-multiline
5822 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5823 'font-lock-function-name-face
5824 'font-lock-variable-name-face)
5825 ;; need to manually set 'multiline' for older font-locks
5827 (if (< 1 (count-lines (match-beginning 0)
5830 (+ 3 (match-beginning 0)) (match-end 0)
5831 'syntax-type 'multiline))
5832 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5833 'font-lock-function-name-face
5834 'font-lock-variable-name-face))))
5835 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5836 2 font-lock-function-name-face)
5837 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5838 1 font-lock-function-name-face)
5839 (cond ((featurep 'font-lock-extra)
5840 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5841 (2 font-lock-string-face t)
5842 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5844 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5845 (2 font-lock-string-face t)
5846 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5848 (1 font-lock-string-face t))))
5849 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5850 2 font-lock-string-face t)))
5851 '("[[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
5852 font-lock-string-face t)
5853 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
5854 font-lock-constant-face) ; labels
5855 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
5856 2 font-lock-constant-face)
5857 ;; Uncomment to get perl-mode-like vars
5858 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5859 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5860 ;;; (2 (cons font-lock-variable-name-face '(underline))))
5861 (cond ((featurep 'font-lock-extra)
5862 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5863 (3 font-lock-variable-name-face)
5865 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5866 (1 font-lock-variable-name-face)
5867 (2 '(restart 2 nil) nil t)))
5868 nil t))) ; local variables, multiple
5870 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
5871 `(,(concat "\\<\\(my\\|local\\|our\\)"
5872 cperl-maybe-white-and-comment-rex
5874 cperl-maybe-white-and-comment-rex
5875 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5876 (5 ,(if cperl-font-lock-multiline
5877 'font-lock-variable-name-face
5878 '(progn (setq cperl-font-lock-multiline-start
5879 (match-beginning 0))
5880 'font-lock-variable-name-face)))
5882 cperl-maybe-white-and-comment-rex
5884 cperl-maybe-white-and-comment-rex
5885 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5886 ;; Bug in font-lock: limit is used not only to limit
5887 ;; searches, but to set the "extend window for
5888 ;; facification" property. Thus we need to minimize.
5889 ,(if cperl-font-lock-multiline
5890 '(if (match-beginning 3)
5892 (goto-char (match-beginning 3))
5898 (error nil)))) ; typeahead
5899 (1- (point))) ; report limit
5900 (forward-char -2)) ; disable continued expr
5901 '(if (match-beginning 3)
5902 (point-max) ; No limit for continuation
5903 (forward-char -2))) ; disable continued expr
5904 ,(if cperl-font-lock-multiline
5907 ;; "my" may be already fontified (POD),
5908 ;; so cperl-font-lock-multiline-start is nil
5909 (if (or (not cperl-font-lock-multiline-start)
5911 cperl-font-lock-multiline-start
5915 (1+ cperl-font-lock-multiline-start) (point)
5916 'syntax-type 'multiline))
5917 (setq cperl-font-lock-multiline-start nil)))
5918 (3 font-lock-variable-name-face))))
5919 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
5920 3 font-lock-variable-name-face)))
5921 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
5922 4 font-lock-variable-name-face)
5923 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntactically
5924 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
5925 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
5927 t-font-lock-keywords-1
5928 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
5929 ;; not yet as of XEmacs 19.12, works with 21.1.11
5931 (not (featurep 'xemacs))
5932 (string< "21.1.9" emacs-version)
5933 (and (string< "21.1.10" emacs-version)
5934 (string< emacs-version "21.1.2")))
5936 ("\\(\\([@%]\\|\\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5937 (if (eq (char-after (match-beginning 2)) ?%)
5940 t) ; arrays and hashes
5941 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5943 (if (= (- (match-end 2) (match-beginning 2)) 1)
5944 (if (eq (char-after (match-beginning 3)) ?{)
5946 'cperl-array-face) ; arrays and hashes
5947 font-lock-variable-name-face) ; Just to put something
5949 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5950 (1 cperl-array-face)
5951 (2 font-lock-variable-name-face))
5952 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5954 (2 font-lock-variable-name-face))
5955 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5956 ;;; Too much noise from \s* @s[ and friends
5957 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
5958 ;;(3 font-lock-function-name-face t t)
5960 ;; (if (cperl-slash-is-regexp)
5961 ;; font-lock-function-name-face 'default) nil t))
5963 (if cperl-highlight-variables-indiscriminately
5964 (setq t-font-lock-keywords-1
5965 (append t-font-lock-keywords-1
5966 (list '("\\([$*]{?\\sw+\\)" 1
5967 font-lock-variable-name-face)))))
5968 (setq cperl-font-lock-keywords-1
5969 (if cperl-syntaxify-by-font-lock
5970 (cons 'cperl-fontify-update
5971 t-font-lock-keywords)
5972 t-font-lock-keywords)
5973 cperl-font-lock-keywords cperl-font-lock-keywords-1
5974 cperl-font-lock-keywords-2 (append
5975 cperl-font-lock-keywords-1
5976 t-font-lock-keywords-1)))
5977 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5978 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
5979 (eval ; Avoid a warning
5980 '(font-lock-require-faces
5982 ;; Color-light Color-dark Gray-light Gray-dark Mono
5983 (list 'font-lock-comment-face
5984 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5989 (list 'font-lock-string-face
5990 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5995 (list 'font-lock-function-name-face
5997 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5998 (cdr (assq 'background-color ; if mono
5999 (frame-parameters))))
6002 (cdr (assq 'foreground-color ; if mono
6003 (frame-parameters))))
6007 (list 'font-lock-variable-name-face
6008 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6013 (list 'font-lock-type-face
6014 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6019 (list 'font-lock-warning-face
6020 ["Pink" "Red" "Gray50" "LightGray"]
6027 (list 'font-lock-constant-face
6028 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6033 (list 'cperl-nonoverridable-face
6034 ["chartreuse3" ("orchid1" "orange")
6040 (list 'cperl-array-face
6041 ["blue" "yellow" nil "Gray80"]
6042 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6047 (list 'cperl-hash-face
6048 ["red" "red" nil "Gray80"]
6049 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6054 ;; Do it the dull way, without choose-color
6055 (defvar cperl-guessed-background nil
6056 "Display characteristics as guessed by cperl.")
6057 ;; (or (fboundp 'x-color-defined-p)
6058 ;; (defalias 'x-color-defined-p
6059 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6060 ;; ;; XEmacs >= 19.12
6061 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6063 ;; (t 'x-valid-color-name-p))))
6064 (cperl-force-face font-lock-constant-face
6065 "Face for constant and label names")
6066 (cperl-force-face font-lock-variable-name-face
6067 "Face for variable names")
6068 (cperl-force-face font-lock-type-face
6069 "Face for data types")
6070 (cperl-force-face cperl-nonoverridable-face
6071 "Face for data types from another group")
6072 (cperl-force-face font-lock-warning-face
6073 "Face for things which should stand out")
6074 (cperl-force-face font-lock-comment-face
6075 "Face for comments")
6076 (cperl-force-face font-lock-function-name-face
6077 "Face for function names")
6078 (cperl-force-face cperl-hash-face
6080 (cperl-force-face cperl-array-face
6082 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6083 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6084 ;;(or (boundp 'font-lock-type-face)
6085 ;; (defconst font-lock-type-face
6086 ;; 'font-lock-type-face
6087 ;; "Face to use for data types."))
6088 ;;(or (boundp 'cperl-nonoverridable-face)
6089 ;; (defconst cperl-nonoverridable-face
6090 ;; 'cperl-nonoverridable-face
6091 ;; "Face to use for data types from another group."))
6092 ;;(if (not (featurep 'xemacs)) nil
6093 ;; (or (boundp 'font-lock-comment-face)
6094 ;; (defconst font-lock-comment-face
6095 ;; 'font-lock-comment-face
6096 ;; "Face to use for comments."))
6097 ;; (or (boundp 'font-lock-keyword-face)
6098 ;; (defconst font-lock-keyword-face
6099 ;; 'font-lock-keyword-face
6100 ;; "Face to use for keywords."))
6101 ;; (or (boundp 'font-lock-function-name-face)
6102 ;; (defconst font-lock-function-name-face
6103 ;; 'font-lock-function-name-face
6104 ;; "Face to use for function names.")))
6106 (not (cperl-is-face 'cperl-array-face))
6107 (cperl-is-face 'font-lock-emphasized-face))
6108 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
6110 (not (cperl-is-face 'cperl-hash-face))
6111 (cperl-is-face 'font-lock-other-emphasized-face))
6112 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
6114 (not (cperl-is-face 'cperl-nonoverridable-face))
6115 (cperl-is-face 'font-lock-other-type-face))
6116 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
6117 ;;(or (boundp 'cperl-hash-face)
6118 ;; (defconst cperl-hash-face
6120 ;; "Face to use for hashes."))
6121 ;;(or (boundp 'cperl-array-face)
6122 ;; (defconst cperl-array-face
6123 ;; 'cperl-array-face
6124 ;; "Face to use for arrays."))
6125 ;; Here we try to guess background
6127 (if (boundp 'font-lock-background-mode)
6128 font-lock-background-mode
6130 (face-list (and (fboundp 'face-list) (face-list))))
6131 ;;;; (fset 'cperl-is-face
6132 ;;;; (cond ((fboundp 'find-face)
6133 ;;;; (symbol-function 'find-face))
6135 ;;;; (function (lambda (face) (member face face-list))))
6137 ;;;; (function (lambda (face) (boundp face))))))
6138 (defvar cperl-guessed-background
6139 (if (and (boundp 'font-lock-display-type)
6140 (eq font-lock-display-type 'grayscale))
6143 "Background as guessed by CPerl mode")
6144 (and (not (cperl-is-face 'font-lock-constant-face))
6145 (cperl-is-face 'font-lock-reference-face)
6146 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
6147 (if (cperl-is-face 'font-lock-type-face) nil
6148 (copy-face 'default 'font-lock-type-face)
6150 ((eq background 'light)
6151 (set-face-foreground 'font-lock-type-face
6152 (if (x-color-defined-p "seagreen")
6155 ((eq background 'dark)
6156 (set-face-foreground 'font-lock-type-face
6157 (if (x-color-defined-p "os2pink")
6161 (set-face-background 'font-lock-type-face "gray90"))))
6162 (if (cperl-is-face 'cperl-nonoverridable-face)
6164 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
6166 ((eq background 'light)
6167 (set-face-foreground 'cperl-nonoverridable-face
6168 (if (x-color-defined-p "chartreuse3")
6171 ((eq background 'dark)
6172 (set-face-foreground 'cperl-nonoverridable-face
6173 (if (x-color-defined-p "orchid1")
6176 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6177 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6179 ;;; ((eq background 'light)
6180 ;;; (set-face-background 'font-lock-other-emphasized-face
6181 ;;; (if (x-color-defined-p "lightyellow2")
6183 ;;; (if (x-color-defined-p "lightyellow")
6185 ;;; "light yellow"))))
6186 ;;; ((eq background 'dark)
6187 ;;; (set-face-background 'font-lock-other-emphasized-face
6188 ;;; (if (x-color-defined-p "navy")
6190 ;;; (if (x-color-defined-p "darkgreen")
6192 ;;; "dark green"))))
6193 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6194 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6195 ;;; (copy-face 'bold 'font-lock-emphasized-face)
6197 ;;; ((eq background 'light)
6198 ;;; (set-face-background 'font-lock-emphasized-face
6199 ;;; (if (x-color-defined-p "lightyellow2")
6201 ;;; "lightyellow")))
6202 ;;; ((eq background 'dark)
6203 ;;; (set-face-background 'font-lock-emphasized-face
6204 ;;; (if (x-color-defined-p "navy")
6206 ;;; (if (x-color-defined-p "darkgreen")
6208 ;;; "dark green"))))
6209 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
6210 (if (cperl-is-face 'font-lock-variable-name-face) nil
6211 (copy-face 'italic 'font-lock-variable-name-face))
6212 (if (cperl-is-face 'font-lock-constant-face) nil
6213 (copy-face 'italic 'font-lock-constant-face))))
6214 (setq cperl-faces-init t))
6215 (error (message "cperl-init-faces (ignored): %s" errs))))
6218 (defvar ps-bold-faces)
6219 (defvar ps-italic-faces)
6220 (defvar ps-underlined-faces)
6222 (defun cperl-ps-print-init ()
6223 "Initialization of `ps-print' components for faces used in CPerl."
6224 (eval-after-load "ps-print"
6225 '(setq ps-bold-faces
6226 ;; font-lock-variable-name-face
6227 ;; font-lock-constant-face
6228 (append '(cperl-array-face cperl-hash-face)
6231 ;; font-lock-constant-face
6232 (append '(cperl-nonoverridable-face cperl-hash-face)
6235 ;; font-lock-type-face
6236 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
6237 ps-underlined-faces))))
6239 (defvar ps-print-face-extension-alist)
6241 (defun cperl-ps-print (&optional file)
6242 "Pretty-print in CPerl style.
6243 If optional argument FILE is an empty string, prints to printer, otherwise
6244 to the file FILE. If FILE is nil, prompts for a file name.
6246 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6249 (setq file (read-from-minibuffer
6250 "Print to file (if empty - to printer): "
6251 (concat (buffer-file-name) ".ps")
6252 nil nil 'file-name-history)))
6253 (or (> (length file) 0)
6255 (require 'ps-print) ; To get ps-print-face-extension-alist
6256 (let ((ps-print-color-p t)
6257 (ps-print-face-extension-alist ps-print-face-extension-alist))
6258 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6259 (ps-print-buffer-with-faces file)))
6261 ;;; (defun cperl-ps-print-init ()
6262 ;;; "Initialization of `ps-print' components for faces used in CPerl."
6263 ;;; ;; Guard against old versions
6264 ;;; (defvar ps-underlined-faces nil)
6265 ;;; (defvar ps-bold-faces nil)
6266 ;;; (defvar ps-italic-faces nil)
6267 ;;; (setq ps-bold-faces
6268 ;;; (append '(font-lock-emphasized-face
6269 ;;; cperl-array-face
6270 ;;; font-lock-keyword-face
6271 ;;; font-lock-variable-name-face
6272 ;;; font-lock-constant-face
6273 ;;; font-lock-reference-face
6274 ;;; font-lock-other-emphasized-face
6275 ;;; cperl-hash-face)
6277 ;;; (setq ps-italic-faces
6278 ;;; (append '(cperl-nonoverridable-face
6279 ;;; font-lock-constant-face
6280 ;;; font-lock-reference-face
6281 ;;; font-lock-other-emphasized-face
6282 ;;; cperl-hash-face)
6283 ;;; ps-italic-faces))
6284 ;;; (setq ps-underlined-faces
6285 ;;; (append '(font-lock-emphasized-face
6286 ;;; cperl-array-face
6287 ;;; font-lock-other-emphasized-face
6289 ;;; cperl-nonoverridable-face font-lock-type-face)
6290 ;;; ps-underlined-faces))
6291 ;;; (cons 'font-lock-type-face ps-underlined-faces))
6294 (if (cperl-enable-font-lock) (cperl-windowed-init))
6296 (defconst cperl-styles-entries
6297 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6298 cperl-label-offset cperl-extra-newline-before-brace
6299 cperl-extra-newline-before-brace-multiline
6300 cperl-merge-trailing-else
6301 cperl-continued-statement-offset))
6303 (defconst cperl-style-examples
6304 "##### Numbers etc are: cperl-indent-level cperl-brace-offset
6305 ##### cperl-continued-brace-offset cperl-label-offset
6306 ##### cperl-continued-statement-offset
6307 ##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6309 ########### (Do not forget cperl-extra-newline-before-brace-multiline)
6311 ### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6323 ### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6335 ### GNU 2/0/0/-2/2/nil/t
6350 ### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6365 ### BSD (=C++, but will not change preexisting merge-trailing-else
6366 ### and extra-newline-before-brace ) 4/0/-4/-4/4
6381 ### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6382 ### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6397 ### Whitesmith (=PerlStyle, but will not change preexisting
6398 ### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6413 "Examples of if/else with different indent styles (with v4.23).")
6415 (defconst cperl-style-alist
6416 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
6417 (cperl-indent-level . 2)
6418 (cperl-brace-offset . 0)
6419 (cperl-continued-brace-offset . 0)
6420 (cperl-label-offset . -2)
6421 (cperl-continued-statement-offset . 2)
6422 (cperl-extra-newline-before-brace . nil)
6423 (cperl-extra-newline-before-brace-multiline . nil)
6424 (cperl-merge-trailing-else . t))
6426 ("PerlStyle" ; CPerl with 4 as indent
6427 (cperl-indent-level . 4)
6428 (cperl-brace-offset . 0)
6429 (cperl-continued-brace-offset . 0)
6430 (cperl-label-offset . -4)
6431 (cperl-continued-statement-offset . 4)
6432 (cperl-extra-newline-before-brace . nil)
6433 (cperl-extra-newline-before-brace-multiline . nil)
6434 (cperl-merge-trailing-else . t))
6437 (cperl-indent-level . 2)
6438 (cperl-brace-offset . 0)
6439 (cperl-continued-brace-offset . 0)
6440 (cperl-label-offset . -2)
6441 (cperl-continued-statement-offset . 2)
6442 (cperl-extra-newline-before-brace . t)
6443 (cperl-extra-newline-before-brace-multiline . t)
6444 (cperl-merge-trailing-else . nil))
6447 (cperl-indent-level . 5)
6448 (cperl-brace-offset . 0)
6449 (cperl-continued-brace-offset . -5)
6450 (cperl-label-offset . -5)
6451 (cperl-continued-statement-offset . 5)
6452 ;;(cperl-extra-newline-before-brace . nil) ; ???
6453 ;;(cperl-extra-newline-before-brace-multiline . nil)
6454 (cperl-merge-trailing-else . nil))
6457 (cperl-indent-level . 4)
6458 (cperl-brace-offset . 0)
6459 (cperl-continued-brace-offset . -4)
6460 (cperl-label-offset . -4)
6461 (cperl-continued-statement-offset . 4)
6462 ;;(cperl-extra-newline-before-brace . nil) ; ???
6463 ;;(cperl-extra-newline-before-brace-multiline . nil)
6464 ;;(cperl-merge-trailing-else . nil) ; ???
6468 (cperl-indent-level . 4)
6469 (cperl-brace-offset . 0)
6470 (cperl-continued-brace-offset . -4)
6471 (cperl-label-offset . -4)
6472 (cperl-continued-statement-offset . 4)
6473 (cperl-extra-newline-before-brace . t)
6474 (cperl-extra-newline-before-brace-multiline . t)
6475 (cperl-merge-trailing-else . nil))
6478 (cperl-indent-level . 4)
6479 (cperl-brace-offset . 0)
6480 (cperl-continued-brace-offset . 0)
6481 (cperl-label-offset . -4)
6482 (cperl-continued-statement-offset . 4)
6483 ;;(cperl-extra-newline-before-brace . nil) ; ???
6484 ;;(cperl-extra-newline-before-brace-multiline . nil)
6485 ;;(cperl-merge-trailing-else . nil) ; ???
6488 "List of variables to set to get a particular indentation style.
6489 Should be used via `cperl-set-style' or via Perl menu.
6491 See examples in `cperl-style-examples'.")
6493 (defun cperl-set-style (style)
6494 "Set CPerl mode variables to use one of several different indentation styles.
6495 The arguments are a string representing the desired style.
6496 The list of styles is in `cperl-style-alist', available styles
6497 are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
6499 The current value of style is memorized (unless there is a memorized
6500 data already), may be restored by `cperl-set-style-back'.
6502 Choosing \"Current\" style will not change style, so this may be used for
6503 side-effect of memorizing only. Examples in `cperl-style-examples'."
6505 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
6506 cperl-style-alist)))
6507 (list (completing-read "Enter style: " list nil 'insist))))
6509 (setq cperl-old-style
6512 (cons name (eval name))))
6513 cperl-styles-entries)))
6514 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
6516 (setq setting (car style) style (cdr style))
6517 (set (car setting) (cdr setting)))))
6519 (defun cperl-set-style-back ()
6520 "Restore a style memorized by `cperl-set-style'."
6522 (or cperl-old-style (error "The style was not changed"))
6524 (while cperl-old-style
6525 (setq setting (car cperl-old-style)
6526 cperl-old-style (cdr cperl-old-style))
6527 (set (car setting) (cdr setting)))))
6529 (defun cperl-check-syntax ()
6531 (require 'mode-compile)
6532 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6533 (eval '(mode-compile)))) ; Avoid a warning
6535 (declare-function Info-find-node "info"
6536 (filename nodename &optional no-going-back strict-case))
6538 (defun cperl-info-buffer (type)
6539 ;; Returns buffer with documentation. Creates if missing.
6540 ;; If TYPE, this vars buffer.
6541 ;; Special care is taken to not stomp over an existing info buffer
6542 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6543 (info (get-buffer bname))
6544 (oldbuf (get-buffer "*info*")))
6546 (save-window-excursion
6551 (rename-buffer "*info-perl-tmp*")))
6552 (save-window-excursion
6554 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6555 (set-buffer "*info*")
6556 (rename-buffer bname)
6558 (set-buffer "*info-perl-tmp*")
6559 (rename-buffer "*info*")
6560 (set-buffer bname)))
6561 (make-local-variable 'window-min-height)
6562 (setq window-min-height 2)
6563 (current-buffer)))))
6565 (defun cperl-word-at-point (&optional p)
6566 "Return the word at point or at P."
6568 (if p (goto-char p))
6569 (or (cperl-word-at-point-hard)
6572 (funcall (or (and (boundp 'find-tag-default-function)
6573 find-tag-default-function)
6574 (get major-mode 'find-tag-default-function)
6575 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6576 ;; automatically used within `find-tag-default':
6577 'find-tag-default))))))
6579 (defun cperl-info-on-command (command)
6580 "Show documentation for Perl command COMMAND in other window.
6581 If perl-info buffer is shown in some frame, uses this frame.
6582 Customized by setting variables `cperl-shrink-wrap-info-frame',
6583 `cperl-max-help-size'."
6585 (let* ((default (cperl-word-at-point))
6587 (format "Find doc for Perl function (default %s): "
6589 (list (if (equal read "")
6593 (let ((buffer (current-buffer))
6594 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6595 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6596 max-height char-height buf-list)
6597 (if (string-match "^-[a-zA-Z]$" command)
6598 (setq cmd-desc "^-X[ \t\n]"))
6599 (setq isvar (string-match "^[$@%]" command)
6600 buf (cperl-info-buffer isvar)
6601 iniwin (selected-window)
6602 fr1 (window-frame iniwin))
6604 (goto-char (point-min))
6606 (progn (re-search-forward "^-X[ \t\n]")
6608 (if (re-search-forward cmd-desc nil t)
6610 ;; Go back to beginning of the group (ex, for qq)
6611 (if (re-search-backward "^[ \t\n\f]")
6616 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6617 (while (and (not win) buf-list)
6618 (setq win (get-buffer-window (car buf-list) t))
6619 (setq buf-list (cdr buf-list)))
6621 (eq (window-buffer win) buf)
6622 (set-window-buffer win buf))
6623 (and win (setq fr2 (window-frame win)))
6624 (if (or (not fr2) (eq fr1 fr2))
6626 (special-display-popup-frame buf) ; Make it visible
6627 (select-window win))
6628 (goto-char pos) ; Needed (?!).
6630 (setq iniheight (window-height)
6631 frheight (frame-height)
6632 not-loner (< iniheight (1- frheight))) ; Are not alone
6633 (cond ((if not-loner cperl-max-help-size
6634 cperl-shrink-wrap-info-frame)
6640 (if (re-search-forward
6641 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6642 (match-beginning 0) (point-max)))))
6645 (/ (* (- frheight 3) cperl-max-help-size) 100)
6646 (setq char-height (frame-char-height))
6647 ;; Non-functioning under OS/2:
6648 (if (eq char-height 1) (setq char-height 18))
6649 ;; Title, menubar, + 2 for slack
6650 (- (/ (display-pixel-height) char-height) 4)))
6651 (if (> height max-height) (setq height max-height))
6652 ;;(message "was %s doing %s" iniheight height)
6654 (enlarge-window (- height iniheight))
6655 (set-frame-height (window-frame win) (1+ height)))))
6656 (set-window-start (selected-window) pos))
6657 (message "No entry for %s found." command))
6658 ;;(pop-to-buffer buffer)
6659 (select-window iniwin)))
6661 (defun cperl-info-on-current-command ()
6662 "Show documentation for Perl command at point in other window."
6664 (cperl-info-on-command (cperl-word-at-point)))
6666 (defun cperl-imenu-info-imenu-search ()
6667 (if (looking-at "^-X[ \t\n]") nil
6669 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6672 (defun cperl-imenu-info-imenu-name ()
6674 (match-beginning 1) (match-end 1)))
6676 (declare-function imenu-choose-buffer-index "imenu" (&optional prompt alist))
6678 (defun cperl-imenu-on-info ()
6679 "Shows imenu for Perl Info Buffer.
6680 Opens Perl Info buffer if needed."
6683 (let* ((buffer (current-buffer))
6684 imenu-create-index-function
6685 imenu-prev-index-position-function
6686 imenu-extract-index-name-function
6687 (index-item (save-restriction
6688 (save-window-excursion
6689 (set-buffer (cperl-info-buffer nil))
6690 (setq imenu-create-index-function
6691 'imenu-default-create-index-function
6692 imenu-prev-index-position-function
6693 'cperl-imenu-info-imenu-search
6694 imenu-extract-index-name-function
6695 'cperl-imenu-info-imenu-name)
6696 (imenu-choose-buffer-index)))))
6700 (pop-to-buffer "*info-perl*")
6702 ((markerp (cdr index-item))
6703 (goto-char (marker-position (cdr index-item))))
6705 (goto-char (cdr index-item))))
6706 (set-window-start (selected-window) (point))
6707 (pop-to-buffer buffer)))))
6709 (defun cperl-lineup (beg end &optional step minshift)
6710 "Lineup construction in a region.
6711 Beginning of region should be at the start of a construction.
6712 All first occurrences of this construction in the lines that are
6713 partially contained in the region are lined up at the same column.
6715 MINSHIFT is the minimal amount of space to insert before the construction.
6716 STEP is the tabwidth to position constructions.
6717 If STEP is nil, `cperl-lineup-step' will be used
6718 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
6719 Will not move the position at the start to the left."
6721 (let (search col tcol seen b)
6725 (setq end (point-marker))
6727 (skip-chars-forward " \t\f")
6728 (setq beg (point-marker))
6729 (indent-region beg end nil)
6731 (setq col (current-column))
6732 (if (looking-at "[a-zA-Z0-9_]")
6733 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6737 (buffer-substring (match-beginning 0)
6738 (match-end 0))) "\\>"))
6739 (error "Cannot line up in a middle of the word"))
6740 (if (looking-at "$")
6741 (error "Cannot line up end of line"))
6742 (setq search (regexp-quote (char-to-string (following-char)))))
6743 (setq step (or step cperl-lineup-step cperl-indent-level))
6744 (or minshift (setq minshift 1))
6746 (beginning-of-line 2)
6747 (and (< (point) end)
6748 (re-search-forward search end t)
6749 (goto-char (match-beginning 0))))
6750 (setq tcol (current-column) seen t)
6751 (if (> tcol col) (setq col tcol)))
6753 (error "The construction to line up occurred only once"))
6755 (setq col (+ col minshift))
6756 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
6759 (cperl-make-indent col)
6760 (beginning-of-line 2)
6761 (and (< (point) end)
6762 (re-search-forward search end t)
6763 (goto-char (match-beginning 0)))))))) ; No body
6765 (defun cperl-etags (&optional add all files) ;; NOT USED???
6766 "Run etags with appropriate options for Perl files.
6767 If optional argument ALL is `recursive', will process Perl files
6768 in subdirectories too."
6771 (args '("-l" "none" "-r"
6772 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6773 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6775 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6777 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
6779 (if add (setq args (cons "-a" args)))
6780 (or files (setq files (list buffer-file-name)))
6782 ((eq all 'recursive)
6783 ;;(error "Not implemented: recursive")
6784 (setq args (append (list "-e"
6785 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6787 find(\\&wanted, '.');
6792 ;;(error "Not implemented: all")
6793 (setq args (append (list "-e"
6794 "push @ARGV, <*.PL *.pl *.pm>;
6799 (setq args (append args files))))
6800 (setq res (apply 'call-process cmd nil nil nil args))
6802 (message "etags returned \"%s\"" res))))
6804 (defun cperl-toggle-auto-newline ()
6805 "Toggle the state of `cperl-auto-newline'."
6807 (setq cperl-auto-newline (not cperl-auto-newline))
6808 (message "Newlines will %sbe auto-inserted now."
6809 (if cperl-auto-newline "" "not ")))
6811 (defun cperl-toggle-abbrev ()
6812 "Toggle the state of automatic keyword expansion in CPerl mode."
6814 (abbrev-mode (if abbrev-mode 0 1))
6815 (message "Perl control structure will %sbe auto-inserted now."
6816 (if abbrev-mode "" "not ")))
6819 (defun cperl-toggle-electric ()
6820 "Toggle the state of parentheses doubling in CPerl mode."
6822 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
6823 (message "Parentheses will %sbe auto-doubled now."
6824 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6826 (defun cperl-toggle-autohelp ()
6827 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6828 Delay of auto-help controlled by `cperl-lazy-help-time'."
6830 (if (fboundp 'run-with-idle-timer)
6832 (if cperl-lazy-installed
6833 (cperl-lazy-unstall)
6834 (cperl-lazy-install))
6835 (message "Perl help messages will %sbe automatically shown now."
6836 (if cperl-lazy-installed "" "not ")))
6837 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6839 (defun cperl-toggle-construct-fix ()
6840 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6842 (setq cperl-indent-region-fix-constructs
6843 (if cperl-indent-region-fix-constructs
6846 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
6847 (if cperl-indent-region-fix-constructs "" "not ")))
6849 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6850 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6851 Nonpositive numeric argument disables debugging messages. The message
6852 summarizes which regions it was decided to rescan for syntactic constructs.
6854 The message looks like this:
6856 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6858 Numbers are character positions in the buffer. REQ provides the range to
6859 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6860 for correct operation it should start and end outside any special syntactic
6861 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6865 (setq arg (if (eq cperl-syntaxify-by-font-lock
6866 (if backtrace 'backtrace 'message)) 0 1)))
6867 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6868 (setq cperl-syntaxify-by-font-lock arg)
6869 (message "Debugging messages of syntax unwind %sabled."
6870 (if (eq arg t) "dis" "en")))
6872 ;;;; Tags file creation.
6874 (defvar cperl-tmp-buffer " *cperl-tmp*")
6876 (defun cperl-setup-tmp-buf ()
6877 (set-buffer (get-buffer-create cperl-tmp-buffer))
6878 (set-syntax-table cperl-mode-syntax-table)
6879 (buffer-disable-undo)
6881 (if cperl-use-syntax-table-text-property-for-tags
6883 (make-local-variable 'parse-sexp-lookup-properties)
6884 ;; Do not introduce variable if not needed, we check it!
6885 (set 'parse-sexp-lookup-properties t))))
6887 ;; Copied from imenu-example--name-and-position.
6888 (defvar imenu-use-markers)
6890 (defun cperl-imenu-name-and-position ()
6891 "Return the current/previous sexp and its (beginning) location.
6892 Does not move point."
6895 (let ((beg (if imenu-use-markers (point-marker) (point)))
6896 (end (progn (forward-sexp) (point))))
6897 (cons (buffer-substring beg end)
6900 (defun cperl-xsub-scan ()
6902 (let ((index-alist '())
6903 (prev-pos 0) index index1 name package prefix)
6904 (goto-char (point-min))
6905 ;; Search for the function
6906 (progn ;;save-match-data
6907 (while (re-search-forward
6908 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6911 ((match-beginning 2) ; SECTION
6912 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6913 (goto-char (match-beginning 0))
6914 (skip-chars-forward " \t")
6916 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6917 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6919 ((not package) nil) ; C language section
6920 ((match-beginning 3) ; XSUB
6921 (goto-char (1+ (match-beginning 3)))
6922 (setq index (cperl-imenu-name-and-position))
6923 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6924 (if (and prefix (string-match (concat "^" prefix) name))
6925 (setq name (substring name (length prefix))))
6926 (cond ((string-match "::" name) nil)
6928 (setq index1 (cons (concat package "::" name) (cdr index)))
6929 (push index1 index-alist)))
6931 (push index index-alist))
6933 ;; (beginning-of-line)
6934 (setq index (cperl-imenu-name-and-position))
6935 (setcar index (concat package "::BOOT:"))
6936 (push index index-alist)))))
6939 (defvar cperl-unreadable-ok nil)
6941 (defun cperl-find-tags (ifile xs topdir)
6942 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6943 (cperl-pod-here-fontify nil) f file)
6945 (if b (set-buffer b)
6946 (cperl-setup-tmp-buf))
6949 (setq file (car (insert-file-contents ifile)))
6950 (error (if cperl-unreadable-ok nil
6952 (format "File %s unreadable. Continue? " ifile))
6953 (setq cperl-unreadable-ok t)
6954 (error "Aborting: unreadable file %s" ifile)))))
6956 (message "Unreadable file %s" ifile)
6957 (message "Scanning file %s ..." file)
6958 (if (and cperl-use-syntax-table-text-property-for-tags
6960 (condition-case err ; after __END__ may have garbage
6961 (cperl-find-pods-heres nil nil noninteractive)
6962 (error (message "While scanning for syntax: %s" err))))
6964 (setq lst (cperl-xsub-scan))
6965 (setq ind (cperl-imenu--create-perl-index))
6966 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6971 (cond ((string-match "^[_a-zA-Z]" (car elt))
6972 (goto-char (cdr elt))
6973 (beginning-of-line) ; pos should be of the start of the line
6976 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6977 (buffer-substring (progn
6978 (goto-char (cdr elt))
6979 ;; After name now...
6980 (or (eolp) (forward-char 1))
6988 (setq elt (car lst) lst (cdr lst))
6993 (if (string-match "^package " (car elt))
6994 (substring (car elt) 8)
6997 (number-to-string (elt elt 2)) ; Line
6999 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
7001 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
7002 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
7004 ;; Need to insert the name without package as well
7005 (setq lst (cons (cons (substring (elt elt 3)
7013 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7014 (set-text-properties 0 (length rel) nil rel)
7015 (and (equal topdir (substring rel 0 (length topdir)))
7016 (setq rel (substring file (length topdir))))
7017 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7018 (setq ret (buffer-substring 1 (point-max)))
7021 (message "Scanning file %s finished" file))
7024 (defun cperl-add-tags-recurse-noxs ()
7025 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
7027 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7028 -f cperl-add-tags-recurse-noxs
7030 (cperl-write-tags nil nil t t nil t))
7032 (defun cperl-add-tags-recurse-noxs-fullpath ()
7033 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7034 Writes down fullpath, so TAGS is relocatable (but if the build directory
7035 is relocated, the file TAGS inside it breaks). Use as
7036 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7037 -f cperl-add-tags-recurse-noxs-fullpath
7039 (cperl-write-tags nil nil t t nil t ""))
7041 (defun cperl-add-tags-recurse ()
7042 "Add to TAGS file data for Perl files in the current directory and kids.
7044 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7045 -f cperl-add-tags-recurse
7047 (cperl-write-tags nil nil t t))
7049 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7050 ;; If INBUFFER, do not select buffer, and do not save
7051 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7054 (setq file (if dir default-directory (buffer-file-name)))
7055 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7057 (setq topdir default-directory))
7058 (let ((tags-file-name "TAGS")
7059 (case-fold-search (and (featurep 'xemacs) (eq system-type 'emx)))
7062 (cond (inbuffer nil) ; Already there
7063 ((file-exists-p tags-file-name)
7064 (if (featurep 'xemacs)
7065 (visit-tags-table-buffer)
7066 (visit-tags-table-buffer tags-file-name)))
7067 (t (set-buffer (find-file-noselect tags-file-name))))
7070 (cond ((eq erase 'ignore))
7073 (setq erase 'ignore)))
7076 (directory-files file t
7077 (if recurse nil cperl-scan-files-regexp)
7080 (if cperl-unreadable-ok nil
7082 (format "Directory %s unreadable. Continue? " file))
7083 (setq cperl-unreadable-ok t
7084 tm nil) ; Return empty list
7085 (error "Aborting: unreadable directory %s" file)))))))
7089 ((string-match cperl-noscan-files-regexp file)
7091 ((not (file-directory-p file))
7092 (if (string-match cperl-scan-files-regexp file)
7093 (cperl-write-tags file erase recurse nil t noxs topdir)))
7095 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7098 (setq xs (string-match "\\.xs$" file))
7099 (if (not (and xs noxs))
7101 (cond ((eq erase 'ignore) (goto-char (point-max)))
7102 (erase (erase-buffer))
7106 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7107 (set-text-properties 0 (length rel) nil rel)
7108 (and (equal topdir (substring rel 0 (length topdir)))
7109 (setq rel (substring file (length topdir))))
7110 (if (search-forward (concat "\f\n" rel ",") nil t)
7112 (search-backward "\f\n")
7113 (delete-region (point)
7116 (if (search-forward "\f\n"
7120 (goto-char (point-max)))))
7121 (insert (cperl-find-tags file xs topdir))))))
7122 (if inbuffer nil ; Delegate to the caller
7123 (save-buffer 0) ; No backup
7124 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7125 (initialize-new-tags-table))))))
7127 (defvar cperl-tags-hier-regexp-list
7134 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7136 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7139 (defvar cperl-hierarchy '(() ())
7140 "Global hierarchy of classes.")
7142 ;; Follows call to (autoloaded) visit-tags-table.
7143 (declare-function file-of-tag "etags" (&optional relative))
7144 (declare-function etags-snarf-tag "etags" (&optional use-explicit))
7146 (defun cperl-tags-hier-fill ()
7147 ;; Suppose we are in a tag table cooked by cperl.
7149 (let (type pack name pos line chunk ord cons1 file str info fileind)
7150 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
7151 (setq pos (match-beginning 0)
7152 pack (match-beginning 2))
7154 (if (looking-at (concat
7163 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7164 name (buffer-substring (match-beginning 2) (match-end 2))
7165 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
7166 line (buffer-substring (match-beginning 3) (match-end 3))
7169 fileind (format "%s:%s" file line)
7170 ;; Moves to beginning of the next line:
7171 info (cperl-etags-snarf-tag file line))
7174 ;; Make new member of hierarchy name ==> file ==> pos if needed
7175 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7177 (setcdr cons1 (cons (cons fileind (vector file info))
7179 ;; First occurrence of the name, start alist
7180 (setq cons1 (cons name (list (cons fileind (vector file info)))))
7182 (setcar (cdr cperl-hierarchy)
7183 (cons cons1 (nth 1 cperl-hierarchy)))
7184 (setcar cperl-hierarchy
7185 (cons cons1 (car cperl-hierarchy)))))))
7188 (declare-function x-popup-menu "menu.c" (position menu))
7189 (declare-function etags-goto-tag-location "etags" (tag-info))
7191 (defun cperl-tags-hier-init (&optional update)
7192 "Show hierarchical menu of classes and methods.
7193 Finds info about classes by a scan of loaded TAGS files.
7194 Supposes that the TAGS files contain fully qualified function names.
7195 One may build such TAGS files from CPerl mode menu."
7199 (if (or update (null (nth 2 cperl-hierarchy)))
7200 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7203 (setcdr elt (cdr (nth 1 elt)))))))
7204 pack name cons1 to l1 l2 l3 l4 b)
7205 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7206 (setq cperl-hierarchy (list l1 l2 l3))
7207 (if (featurep 'xemacs) ; Not checked
7210 ;; Does this work in XEmacs?
7211 (call-interactively 'visit-tags-table))
7212 (message "Updating list of classes...")
7213 (set-buffer (get-file-buffer tags-file-name))
7214 (cperl-tags-hier-fill))
7216 (call-interactively 'visit-tags-table))
7220 (message "Updating list of classes... %s" tagsfile)
7221 (set-buffer (get-file-buffer tagsfile))
7222 (cperl-tags-hier-fill)))
7224 (message "Updating list of classes... postprocessing..."))
7225 (mapc remover (car cperl-hierarchy))
7226 (mapc remover (nth 1 cperl-hierarchy))
7227 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7228 (cons "Methods: " (car cperl-hierarchy))))
7229 (cperl-tags-treeify to 1)
7230 (setcar (nthcdr 2 cperl-hierarchy)
7231 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7232 (message "Updating list of classes: done, requesting display...")
7233 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7235 (or (nth 2 cperl-hierarchy)
7236 (error "No items found"))
7238 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
7239 (if (if (fboundp 'display-popup-menus-p)
7240 (let ((f 'display-popup-menus-p))
7243 (x-popup-menu t (nth 2 cperl-hierarchy))
7245 (tmm-prompt (nth 2 cperl-hierarchy))))
7246 (if (and update (listp update))
7247 (progn (while (cdr update) (setq update (cdr update)))
7248 (setq update (car update)))) ; Get the last from the list
7249 (if (vectorp update)
7251 (find-file (elt update 0))
7252 (cperl-etags-goto-tag-location (elt update 1))))
7253 (if (eq update -999) (cperl-tags-hier-init t)))
7255 (defun cperl-tags-treeify (to level)
7256 ;; cadr of `to' is read-write. On start it is a cons
7257 (let* ((regexp (concat "^\\(" (mapconcat
7259 (make-list level "[_a-zA-Z0-9]+")
7262 (packages (cdr (nth 1 to)))
7263 (methods (cdr (nth 2 to)))
7264 l1 head tail cons1 cons2 ord writeto packs recurse
7265 root-packages root-functions ms many_ms same_name ps
7269 (cond ((and (string-match regexp (car elt))
7270 (or (eq ord 1) (match-end 2)))
7271 (setq head (substring (car elt) 0 (match-end 1))
7272 tail (if (match-end 2) (substring (car elt)
7275 (if (setq cons1 (assoc head writeto)) nil
7276 ;; Need to init new head
7277 (setcdr writeto (cons (list head (list "Packages: ")
7280 (setq cons1 (nth 1 writeto)))
7281 (setq cons2 (nth ord cons1)) ; Either packs or meths
7282 (setcdr cons2 (cons elt (cdr cons2))))
7284 (setq root-functions (cons elt root-functions)))
7286 (setq root-packages (cons elt root-packages))))))))
7287 (setcdr to l1) ; Init to dynamic space
7290 (mapc move-deeper packages)
7292 (mapc move-deeper methods)
7294 (mapc (function (lambda (elt)
7295 (cperl-tags-treeify elt (1+ level))))
7297 ;;Now clean up leaders with one child only
7298 (mapc (function (lambda (elt)
7299 (if (not (and (listp (cdr elt))
7300 (eq (length elt) 2))) nil
7301 (setcar elt (car (nth 1 elt)))
7302 (setcdr elt (cdr (nth 1 elt))))))
7304 ;; Sort the roots of subtrees
7305 (if (default-value 'imenu-sort-function)
7307 (sort (cdr to) (default-value 'imenu-sort-function))))
7308 ;; Now add back functions removed from display
7309 (mapc (function (lambda (elt)
7310 (setcdr to (cons elt (cdr to)))))
7311 (if (default-value 'imenu-sort-function)
7313 (sort root-functions (default-value 'imenu-sort-function)))
7315 ;; Now add back packages removed from display
7316 (mapc (function (lambda (elt)
7317 (setcdr to (cons (cons (concat "package " (car elt))
7320 (if (default-value 'imenu-sort-function)
7322 (sort root-packages (default-value 'imenu-sort-function)))
7326 ;;; '(keymap "Name1"
7330 ;;; ("Tail1" "x") ("Tail2" "y"))))
7332 (defun cperl-list-fold (list name limit)
7333 (let (list1 list2 elt1 (num 0))
7334 (if (<= (length list) limit) list
7335 (setq list1 nil list2 nil)
7340 (if (<= num imenu-max-items)
7341 (setq list2 (cons elt1 list2))
7342 (setq list1 (cons (cons name
7347 (nreverse (cons (cons name
7351 (defun cperl-menu-to-keymap (menu &optional name)
7357 (cond ((listp (cdr elt))
7358 (setq list (cperl-list-fold
7359 (cdr elt) (car elt) imenu-max-items))
7362 (cperl-menu-to-keymap list))))
7364 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7365 (cperl-list-fold menu "Root" imenu-max-items)))))
7368 (defvar cperl-bad-style-regexp
7369 (mapconcat 'identity
7370 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
7371 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
7373 "Finds places such that insertion of a whitespace may help a lot.")
7375 (defvar cperl-not-bad-style-regexp
7378 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7379 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7380 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
7381 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
7382 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
7389 "\\\\[&$@*\\\\]" ; \&func
7392 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
7395 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
7396 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
7397 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7401 "If matches at the start of match found by `my-bad-c-style-regexp',
7402 insertion of a whitespace will not help.")
7406 (defun cperl-find-bad-style ()
7407 "Find places in the buffer where insertion of a whitespace may help.
7408 Prompts user for insertion of spaces.
7409 Currently it is tuned to C and Perl syntax."
7411 (let (found-bad (p (point)))
7412 (setq last-nonmenu-event 13) ; To disable popup
7413 (goto-char (point-min))
7414 (map-y-or-n-p "Insert space here? "
7415 (lambda (arg) (insert " "))
7416 'cperl-next-bad-style
7417 '("location" "locations" "insert a space into")
7418 '((?\C-r (lambda (arg)
7419 (let ((buffer-quit-function
7420 'exit-recursive-edit))
7421 (message "Exit with Esc Esc")
7423 t)) ; Consider acted upon
7424 "edit, exit with Esc Esc")
7426 (let ((buffer-quit-function
7427 'exit-recursive-edit))
7428 (message "Exit with Esc Esc")
7430 t)) ; Consider acted upon
7431 "edit, exit with Esc Esc"))
7433 (if found-bad (goto-char found-bad)
7435 (message "No appropriate place found"))))
7437 (defun cperl-next-bad-style ()
7438 (let (p (not-found t) (point (point)) found)
7439 (while (and not-found
7440 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7442 (goto-char (match-beginning 0))
7444 (looking-at cperl-not-bad-style-regexp)
7445 ;; Check for a < -b and friends
7446 (and (eq (following-char) ?\-)
7448 (skip-chars-backward " \t\n")
7449 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
7450 ;; Now check for syntax type
7452 (setq found (point))
7453 (beginning-of-defun)
7454 (let ((pps (parse-partial-sexp (point) found)))
7455 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7456 (goto-char (match-end 0))
7464 (defvar cperl-have-help-regexp
7468 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
7469 "[$@]\\^[a-zA-Z]" ; Special variable
7470 "[$@][^ \n\t]" ; Special variable
7471 "-[a-zA-Z]" ; File test
7472 "\\\\[a-zA-Z0]" ; Special chars
7473 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
7474 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7475 "[a-zA-Z_0-9:]+" ; symbol or number
7482 "Matches places in the buffer we can find help for.")
7484 (defvar cperl-message-on-help-error t)
7485 (defvar cperl-help-from-timer nil)
7487 (defun cperl-word-at-point-hard ()
7488 ;; Does not save-excursion
7489 ;; Get to the something meaningful
7490 (or (eobp) (eolp) (forward-char 1))
7491 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
7495 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7496 ;; (skip-chars-backward " \n\t\r({[]});,")
7497 ;; (or (bobp) (backward-char 1))))
7500 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7501 (skip-chars-backward "a-zA-Z0-9_:")
7503 ((and (eq (preceding-char) ?^) ; $^I
7504 (eq (char-after (- (point) 2)) ?\$))
7506 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7508 ((and (eq (preceding-char) ?\=)
7509 (eq (current-column) 1))
7510 (forward-char -1))) ; =head1
7511 (if (and (eq (preceding-char) ?\<)
7512 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7514 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7516 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7518 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7519 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7521 ((and (eq (preceding-char) ?\$)
7522 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7524 ((and (eq (following-char) ?\>)
7525 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7528 (and (eq (preceding-char) ?\<)
7529 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7530 (search-backward "<"))))
7531 ((and (eq (following-char) ?\$)
7532 (eq (preceding-char) ?\<)
7533 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7535 (if (looking-at cperl-have-help-regexp)
7536 (buffer-substring (match-beginning 0) (match-end 0))))
7538 (defun cperl-get-help ()
7539 "Get one-line docs on the symbol at the point.
7540 The data for these docs is a little bit obsolete and may be in fact longer
7541 than a line. Your contribution to update/shorten it is appreciated."
7543 (save-match-data ; May be called "inside" query-replace
7545 (let ((word (cperl-word-at-point-hard)))
7547 (if (and cperl-help-from-timer ; Bail out if not in mainland
7548 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7549 (or (memq (get-text-property (point) 'face)
7550 '(font-lock-comment-face font-lock-string-face))
7551 (memq (get-text-property (point) 'syntax-type)
7552 '(pod here-doc format))))
7554 (cperl-describe-perl-symbol word))
7555 (if cperl-message-on-help-error
7556 (message "Nothing found for %s..."
7557 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7559 ;;; Stolen from perl-descr.el by Johan Vromans:
7561 (defvar cperl-doc-buffer " *perl-doc*"
7562 "Where the documentation can be found.")
7564 (defun cperl-describe-perl-symbol (val)
7565 "Display the documentation of symbol at point, a Perl operator."
7566 (let ((enable-recursive-minibuffers t)
7569 ((string-match "^[&*][a-zA-Z_]" val)
7570 (setq val (concat (substring val 0 1) "NAME")))
7571 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7572 (setq val (concat "@" (substring val 1 (match-end 1)))))
7573 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7574 (setq val (concat "%" (substring val 1 (match-end 1)))))
7575 ((and (string= val "x") (string-match "^x=" val))
7577 ((string-match "^\\$[\C-a-\C-z]" val)
7578 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7579 ((string-match "^CORE::" val)
7580 (setq val "CORE::"))
7581 ((string-match "^SUPER::" val)
7582 (setq val "SUPER::"))
7583 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7584 (setq val "<NAME>")))
7585 (setq regexp (concat "^"
7586 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
7588 "\\([ \t([/]\\|$\\)"))
7590 ;; get the buffer with the documentation text
7591 (cperl-switch-to-doc-buffer)
7593 ;; lookup in the doc
7594 (goto-char (point-min))
7595 (let ((case-fold-search nil))
7597 (if (re-search-forward regexp (point-max) t)
7599 (beginning-of-line 1)
7600 (let ((lnstart (point)))
7602 (message "%s" (buffer-substring lnstart (point)))))
7603 (if cperl-message-on-help-error
7604 (message "No definition for %s" val)))))))
7606 (defvar cperl-short-docs 'please-ignore-this-line
7607 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7608 "# based on \\='@(#)@ perl-descr.el 1.9 - describe-perl-symbol\\=' [Perl 5]
7609 ... Range (list context); flip/flop [no flop when flip] (scalar context).
7610 ! ... Logical negation.
7611 ... != ... Numeric inequality.
7612 ... !~ ... Search pattern, substitution, or translation (negated).
7613 $! In numeric context: errno. In a string context: error string.
7614 $\" The separator which joins elements of arrays interpolated in strings.
7615 $# The output format for printed numbers. Default is %.15g or close.
7616 $$ Process number of this script. Changes in the fork()ed child process.
7617 $% The current page number of the currently selected output channel.
7619 The following variables are always local to the current block:
7621 $1 Match of the 1st set of parentheses in the last match (auto-local).
7622 $2 Match of the 2nd set of parentheses in the last match (auto-local).
7623 $3 Match of the 3rd set of parentheses in the last match (auto-local).
7624 $4 Match of the 4th set of parentheses in the last match (auto-local).
7625 $5 Match of the 5th set of parentheses in the last match (auto-local).
7626 $6 Match of the 6th set of parentheses in the last match (auto-local).
7627 $7 Match of the 7th set of parentheses in the last match (auto-local).
7628 $8 Match of the 8th set of parentheses in the last match (auto-local).
7629 $9 Match of the 9th set of parentheses in the last match (auto-local).
7630 $& The string matched by the last pattern match (auto-local).
7631 $\\=' The string after what was matched by the last match (auto-local).
7632 $\\=` The string before what was matched by the last match (auto-local).
7634 $( The real gid of this process.
7635 $) The effective gid of this process.
7636 $* Deprecated: Set to 1 to do multiline matching within a string.
7637 $+ The last bracket matched by the last search pattern.
7638 $, The output field separator for the print operator.
7639 $- The number of lines left on the page.
7640 $. The current input line number of the last filehandle that was read.
7641 $/ The input record separator, newline by default.
7642 $0 Name of the file containing the current perl script (read/write).
7643 $: String may be broken after these characters to fill ^-lines in a format.
7644 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
7645 $< The real uid of this process.
7646 $= The page length of the current output channel. Default is 60 lines.
7647 $> The effective uid of this process.
7648 $? The status returned by the last \\=`\\=`, pipe close or `system'.
7649 $@ The perl error message from the last eval or do @var{EXPR} command.
7650 $ARGV The name of the current file used with <> .
7651 $[ Deprecated: The index of the first element/char in an array/string.
7652 $\\ The output record separator for the print operator.
7653 $] The perl version string as displayed with perl -v.
7654 $^ The name of the current top-of-page format.
7655 $^A The current value of the write() accumulator for format() lines.
7656 $^D The value of the perl debug (-D) flags.
7657 $^E Information about the last system error other than that provided by $!.
7658 $^F The highest system file descriptor, ordinarily 2.
7659 $^H The current set of syntax checks enabled by `use strict'.
7660 $^I The value of the in-place edit extension (perl -i option).
7661 $^L What formats output to perform a formfeed. Default is \\f.
7662 $^M A buffer for emergency memory allocation when running out of memory.
7663 $^O The operating system name under which this copy of Perl was built.
7664 $^P Internal debugging flag.
7665 $^T The time the script was started. Used by -A/-M/-C file tests.
7666 $^W True if warnings are requested (perl -w flag).
7667 $^X The name under which perl was invoked (argv[0] in C-speech).
7668 $_ The default input and pattern-searching space.
7669 $| Auto-flush after write/print on current output channel? Default 0.
7670 $~ The name of the current report format.
7671 ... % ... Modulo division.
7672 ... %= ... Modulo division assignment.
7673 %ENV Contains the current environment.
7674 %INC List of files that have been require-d or do-ne.
7675 %SIG Used to set signal handlers for various signals.
7676 ... & ... Bitwise and.
7677 ... && ... Logical and.
7678 ... &&= ... Logical and assignment.
7679 ... &= ... Bitwise and assignment.
7680 ... * ... Multiplication.
7681 ... ** ... Exponentiation.
7682 *NAME Glob: all objects referred by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7683 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
7684 ... + ... Addition. +EXPR Makes EXPR into scalar context.
7685 ++ Auto-increment (magical on strings). ++EXPR EXPR++
7686 ... += ... Addition assignment.
7688 ... - ... Subtraction.
7689 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7690 ... -= ... Subtraction assignment.
7691 -A Access time in days since script started.
7692 -B File is a non-text (binary) file.
7693 -C Inode change time in days since script started.
7694 -M Age in days since script started.
7695 -O File is owned by real uid.
7696 -R File is readable by real uid.
7697 -S File is a socket .
7698 -T File is a text file.
7699 -W File is writable by real uid.
7700 -X File is executable by real uid.
7701 -b File is a block special file.
7702 -c File is a character special file.
7703 -d File is a directory.
7705 -f File is a plain file.
7706 -g File has setgid bit set.
7707 -k File has sticky bit set.
7708 -l File is a symbolic link.
7709 -o File is owned by effective uid.
7710 -p File is a named pipe (FIFO).
7711 -r File is readable by effective uid.
7712 -s File has non-zero size.
7713 -t Tests if filehandle (STDIN by default) is opened to a tty.
7714 -u File has setuid bit set.
7715 -w File is writable by effective uid.
7716 -x File is executable by effective uid.
7717 -z File has zero size.
7718 . Concatenate strings.
7719 .. Range (list context); flip/flop (scalar context) operator.
7720 .= Concatenate assignment strings
7721 ... / ... Division. /PATTERN/ioxsmg Pattern match
7722 ... /= ... Division assignment.
7723 /PATTERN/ioxsmg Pattern match.
7724 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
7725 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7726 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7727 <> Reads line from union of files in @ARGV (= command line) and STDIN.
7728 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7729 ... <= ... Numeric less than or equal to.
7730 ... <=> ... Numeric compare.
7731 ... = ... Assignment.
7732 ... == ... Numeric equality.
7733 ... =~ ... Search pattern, substitution, or translation
7734 ... > ... Numeric greater than.
7735 ... >= ... Numeric greater than or equal to.
7736 ... >> ... Bitwise shift right.
7737 ... >>= ... Bitwise shift right assignment.
7738 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7739 ?PATTERN? One-time pattern match.
7740 @ARGV Command line arguments (not including the command name - see $0).
7741 @INC List of places to look for perl scripts during do/include/use.
7742 @_ Parameter array for subroutines; result of split() unless in list context.
7743 \\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
7744 \\0 Octal char, e.g. \\033.
7745 \\E Case modification terminator. See \\Q, \\L, and \\U.
7746 \\L Lowercase until \\E . See also \\l, lc.
7747 \\U Upcase until \\E . See also \\u, uc.
7748 \\Q Quote metacharacters until \\E . See also quotemeta.
7749 \\a Alarm character (octal 007).
7750 \\b Backspace character (octal 010).
7751 \\c Control character, e.g. \\c[ .
7752 \\e Escape character (octal 033).
7753 \\f Formfeed character (octal 014).
7754 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
7755 \\n Newline character (octal 012 on most systems).
7756 \\r Return character (octal 015 on most systems).
7757 \\t Tab character (octal 011).
7758 \\u Upcase the next character. See also \\U and \\l, ucfirst.
7759 \\x Hex character, e.g. \\x1b.
7760 ... ^ ... Bitwise exclusive or.
7761 __END__ Ends program source.
7762 __DATA__ Ends program source.
7763 __FILE__ Current (source) filename.
7764 __LINE__ Current line in current source.
7765 __PACKAGE__ Current package.
7766 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7767 ARGVOUT Output filehandle with -i flag.
7768 BEGIN { ... } Immediately executed (during compilation) piece of code.
7769 END { ... } Pseudo-subroutine executed after the script finishes.
7770 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7771 INIT { ... } Pseudo-subroutine executed before the script starts running.
7772 DATA Input filehandle for what follows after __END__ or __DATA__.
7773 accept(NEWSOCKET,GENERICSOCKET)
7786 ... cmp ... String compare.
7787 connect(SOCKET,NAME)
7788 continue of { block } continue { block }. Is executed after `next' or at end.
7790 crypt(PLAINTEXT,SALT)
7792 dbmopen(%HASH,DBNAME,MODE)
7796 do { ... }|SUBR while|until EXPR executes at least once
7797 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7807 ... eq ... String equality.
7808 eval(EXPR) or eval { BLOCK }
7809 exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
7812 fcntl(FILEHANDLE,FUNCTION,SCALAR)
7814 flock(FILEHANDLE,OPERATION)
7815 for (EXPR;EXPR;EXPR) { ... }
7816 foreach [VAR] (@ARRAY) { ... }
7818 ... ge ... String greater than or equal.
7823 gethostbyaddr(ADDR,ADDRTYPE)
7827 getnetbyaddr(ADDR,ADDRTYPE)
7833 getpriority(WHICH,WHO)
7834 getprotobyname(NAME)
7835 getprotobynumber(NUMBER)
7840 getservbyname(NAME,PROTO)
7841 getservbyport(PORT,PROTO)
7844 getsockopt(SOCKET,LEVEL,OPTNAME)
7847 ... gt ... String greater than.
7849 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7850 index(STR,SUBSTR[,OFFSET])
7852 ioctl(FILEHANDLE,FUNCTION,SCALAR)
7857 ... le ... String less than or equal.
7859 link(OLDFILE,NEWFILE)
7860 listen(SOCKET,QUEUESIZE)
7864 lstat(EXPR|FILEHANDLE|VAR)
7865 ... lt ... String less than.
7867 mkdir(FILENAME,MODE)
7870 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7871 msgsnd(ID,MSG,FLAGS)
7872 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
7873 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
7874 ... ne ... String inequality.
7877 open(FILEHANDLE[,EXPR])
7878 opendir(DIRHANDLE,EXPR)
7879 ord(EXPR) ASCII value of the first char of the string.
7881 package NAME Introduces package context.
7882 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7884 print [FILEHANDLE] [(LIST)]
7885 printf [FILEHANDLE] (FORMAT,LIST)
7887 q/STRING/ Synonym for \\='STRING\\='
7888 qq/STRING/ Synonym for \"STRING\"
7889 qx/STRING/ Synonym for \\=`STRING\\=`
7891 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7894 recv(SOCKET,SCALAR,LEN,FLAGS)
7896 rename(OLDNAME,NEWNAME)
7897 require [FILENAME | PERL_VERSION]
7901 rewinddir(DIRHANDLE)
7902 rindex(STR,SUBSTR[,OFFSET])
7904 s/PATTERN/REPLACEMENT/gieoxsm
7906 seek(FILEHANDLE,POSITION,WHENCE)
7907 seekdir(DIRHANDLE,POS)
7908 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7909 semctl(ID,SEMNUM,CMD,ARG)
7910 semget(KEY,NSEMS,SIZE,FLAGS)
7912 send(SOCKET,MSG,FLAGS[,TO])
7914 sethostent(STAYOPEN)
7917 setpriority(WHICH,WHO,PRIORITY)
7918 setprotoent(STAYOPEN)
7920 setservent(STAYOPEN)
7921 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7924 shmget(KEY,SIZE,FLAGS)
7925 shmread(ID,VAR,POS,SIZE)
7926 shmwrite(ID,STRING,POS,SIZE)
7927 shutdown(SOCKET,HOW)
7930 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7931 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7932 sort [SUBROUTINE] (LIST)
7933 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7934 split[(/PATTERN/[,EXPR[,LIMIT]])]
7935 sprintf(FORMAT,LIST)
7938 stat(EXPR|FILEHANDLE|VAR)
7940 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7941 substr(EXPR,OFFSET[,LEN])
7942 symlink(OLDFILE,NEWFILE)
7944 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7945 system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
7946 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7951 tr/SEARCHLIST/REPLACEMENTLIST/cds
7952 truncate(FILE|EXPR,LENGTH)
7955 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7957 unpack(TEMPLATE,EXPR)
7959 until (EXPR) { ... } EXPR until EXPR
7962 vec(EXPR,OFFSET,BITS)
7965 wantarray Returns true if the sub/eval is called in list context.
7967 while (EXPR) { ... } EXPR while EXPR
7968 write[(EXPR|FILEHANDLE)]
7969 ... x ... Repeat string or array.
7970 x= ... Repetition assignment.
7971 y/SEARCHLIST/REPLACEMENTLIST/
7972 ... | ... Bitwise or.
7973 ... || ... Logical or.
7974 ~ ... Unary bitwise complement.
7975 #! OS interpreter indicator. If contains `perl', used for options, and -x.
7976 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7977 CORE:: Prefix to access builtin function if imported sub obscures it.
7978 SUPER:: Prefix to lookup for a method in @ISA classes.
7979 DESTROY Shorthand for `sub DESTROY {...}'.
7980 ... EQ ... Obsolete synonym of `eq'.
7981 ... GE ... Obsolete synonym of `ge'.
7982 ... GT ... Obsolete synonym of `gt'.
7983 ... LE ... Obsolete synonym of `le'.
7984 ... LT ... Obsolete synonym of `lt'.
7985 ... NE ... Obsolete synonym of `ne'.
7986 abs [ EXPR ] absolute value
7987 ... and ... Low-precedence synonym for &&.
7988 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7989 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq \\='\\='!
7990 chr Converts a number to char with the same ordinal.
7991 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7992 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7993 exists $HASH{KEY} True if the key exists.
7994 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7995 formline PICTURE, LIST Backdoor into \"format\" processing.
7996 glob EXPR Synonym of <EXPR>.
7997 lc [ EXPR ] Returns lowercased EXPR.
7998 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
7999 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
8000 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
8001 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
8002 not ... Low-precedence synonym for ! - negation.
8003 ... or ... Low-precedence synonym for ||.
8004 pos STRING Set/Get end-position of the last match over this string, see \\G.
8005 quotemeta [ EXPR ] Quote regexp metacharacters.
8006 qw/WORD1 .../ Synonym of split(\\='\\=', \\='WORD1 ...\\=')
8007 readline FH Synonym of <FH>.
8008 readpipe CMD Synonym of \\=`CMD\\=`.
8009 ref [ EXPR ] Type of EXPR when dereferenced.
8010 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
8011 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
8012 tied Returns internal object for a tied data.
8013 uc [ EXPR ] Returns upcased EXPR.
8014 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
8015 untie VAR Unlink an object from a simple Perl variable.
8016 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
8017 ... xor ... Low-precedence synonym for exclusive or.
8018 prototype \\&SUB Returns prototype of the function given a reference.
8019 =head1 Top-level heading.
8020 =head2 Second-level heading.
8021 =head3 Third-level heading (is there such?).
8022 =over [ NUMBER ] Start list.
8023 =item [ TITLE ] Start new item in the list.
8025 =cut Switch from POD to Perl.
8026 =pod Switch from Perl to POD.
8029 (defun cperl-switch-to-doc-buffer (&optional interactive)
8030 "Go to the perl documentation buffer and insert the documentation."
8032 (let ((buf (get-buffer-create cperl-doc-buffer)))
8034 (switch-to-buffer-other-window buf)
8036 (if (= (buffer-size) 0)
8038 (insert (documentation-property 'cperl-short-docs
8039 'variable-documentation))
8040 (setq buffer-read-only t)))))
8042 (defun cperl-beautify-regexp-piece (b e embed level)
8043 ;; b is before the starting delimiter, e before the ending
8044 ;; e should be a marker, may be changed, but remains "correct".
8045 ;; EMBED is nil if we process the whole REx.
8046 ;; The REx is guaranteed to have //x
8047 ;; LEVEL shows how many levels deep to go
8048 ;; position at enter and at leave is not defined
8049 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8053 (setq c (if (eq embed t) (current-indentation) (current-column)))
8054 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8058 ((looking-at "(\\?[^a-zA-Z]")
8060 ((looking-at "(\\?") ; (?i)
8065 (setq c (1- (current-column))))
8066 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
8067 (or (looking-at "[ \t]*[\n#]")
8072 (if (re-search-forward "[^ \t]" e t)
8073 (progn ; Something before the ending delimiter
8075 (delete-horizontal-space)
8077 (cperl-make-indent c)
8078 (set-marker e (point))))
8081 (while (< (point) (marker-position e))
8085 (skip-chars-forward " \t")
8086 (delete-region s (point))
8087 (cperl-make-indent c1)
8091 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8092 "\\|" ; Embedded variable
8093 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8096 "\\|" ; simple-code simple-code*?
8097 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8101 "\\((\\(\\?\\)?\\)" ; 7 8
8104 (goto-char (match-end 0))
8106 (cond ((match-beginning 1) ; Alphanum word + junk
8108 ((or (match-beginning 3) ; $ab[12]
8109 (and (match-beginning 5) ; X* X+ X{2,3}
8110 (eq (preceding-char) ?\{)))
8113 ((and ; [], already syntaxified
8116 cperl-use-syntax-table-text-property)
8119 (or (eq (preceding-char) ?\])
8120 (error "[]-group not terminated"))
8122 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8123 ((match-beginning 6) ; []
8125 (if (looking-at "\\^?\\]")
8126 (goto-char (match-end 0)))
8127 ;; XXXX POSIX classes?!
8128 (while (and (not pos)
8129 (re-search-forward "\\[:\\|\\]" e t))
8130 (if (eq (preceding-char) ?:)
8131 (or (re-search-forward ":\\]" e t)
8132 (error "[:POSIX:]-group in []-group not terminated"))
8134 (or (eq (preceding-char) ?\])
8135 (error "[]-group not terminated"))
8137 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8138 ((match-beginning 7) ; ()
8139 (goto-char (match-beginning 0))
8140 (setq pos (current-column))
8143 (delete-horizontal-space)
8145 (cperl-make-indent c1)))
8148 ;; (or (forward-sexp 1)
8151 ;; (error "()-group not terminated")))
8152 (set-marker m (1- (point)))
8153 (set-marker m1 (point))
8155 (if (progn ; indent rigidly if multiline
8156 ;; In fact does not make a lot of sense, since
8157 ;; the starting position can be already lost due
8158 ;; to insertion of "\n" and " "
8160 (search-forward "\n" m1 t))
8161 (indent-rigidly (point) m1 (- c1 pos)))
8162 (setq level (1- level))
8164 ((not (match-beginning 8))
8165 (cperl-beautify-regexp-piece tmp m t level))
8166 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8168 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8169 (goto-char (+ 2 tmp))
8171 (cperl-beautify-regexp-piece (point) m t level))
8172 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8173 (goto-char (+ 3 tmp))
8174 (cperl-beautify-regexp-piece (point) m t level))
8176 (cperl-beautify-regexp-piece tmp m t level))))
8178 (cond ((looking-at "[*+?]\\??")
8179 (goto-char (match-end 0)))
8180 ((eq (following-char) ?\{)
8182 (if (eq (following-char) ?\?)
8184 (skip-chars-forward " \t")
8186 (if (looking-at "[#\n]")
8188 (or (eolp) (indent-for-comment))
8189 (beginning-of-line 2))
8190 (delete-horizontal-space)
8194 ((match-beginning 9) ; |
8198 (if (re-search-forward "[^ \t]" tmp t)
8201 (delete-horizontal-space)
8204 (delete-region (point) tmp))
8205 (cperl-make-indent c)
8207 (skip-chars-forward " \t")
8209 (if (looking-at "[#\n]")
8210 (beginning-of-line 2)
8211 (delete-horizontal-space)
8215 (or (looking-at "[ \t\n]")
8218 (skip-chars-forward " \t"))
8219 (or (looking-at "[#\n]")
8220 (error "Unknown code `%s' in a regexp"
8221 (buffer-substring (point) (1+ (point)))))
8222 (and inline (end-of-line 2)))
8223 ;; Special-case the last line of group
8224 (if (and (>= (point) (marker-position e))
8225 (/= (current-indentation) c))
8228 (cperl-make-indent c)))))
8230 (defun cperl-make-regexp-x ()
8231 ;; Returns position of the start
8232 ;; XXX this is called too often! Need to cache the result!
8234 (or cperl-use-syntax-table-text-property
8235 (error "I need to have a regexp marked!"))
8237 (if (looking-at "\\s|")
8239 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8240 (and (eq (preceding-char) ?q)
8241 (looking-at "\\(r\\)\\s|")))
8242 (goto-char (match-end 1))
8243 (re-search-backward "\\s|"))) ; Assume it is scanned already.
8245 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8246 (sub-p (eq (preceding-char) ?s)) s)
8248 (set-marker e (1- (point)))
8249 (setq delim (preceding-char))
8250 (if (and sub-p (eq delim (char-after (- (point) 2))))
8251 (error "Possible s/blah// - do not know how to deal with"))
8252 (if sub-p (forward-sexp 1))
8253 (if (looking-at "\\sw*x")
8256 ;; Protect fragile " ", "#"
8259 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8265 (defun cperl-beautify-regexp (&optional deep)
8266 "Do it. (Experimental, may change semantics, recheck the result.)
8267 We suppose that the regexp is scanned already."
8269 (setq deep (if deep (prefix-numeric-value deep) -1))
8271 (goto-char (cperl-make-regexp-x))
8272 (let ((b (point)) (e (make-marker)))
8274 (set-marker e (1- (point)))
8275 (cperl-beautify-regexp-piece b e nil deep))))
8277 (defun cperl-regext-to-level-start ()
8278 "Goto start of an enclosing group in regexp.
8279 We suppose that the regexp is scanned already."
8281 (let ((limit (cperl-make-regexp-x)) done)
8283 (or (eq (following-char) ?\()
8284 (search-backward "(" (1+ limit) t)
8285 (error "Cannot find `(' which starts a group"))
8288 (skip-chars-backward "\\")
8289 (looking-at "\\(\\\\\\\\\\)*(")))
8290 (or done (forward-char -1)))))
8292 (defun cperl-contract-level ()
8293 "Find an enclosing group in regexp and contract it.
8294 \(Experimental, may change semantics, recheck the result.)
8295 We suppose that the regexp is scanned already."
8297 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
8298 (cperl-regext-to-level-start)
8299 (let ((b (point)) (e (make-marker)) c)
8301 (set-marker e (1- (point)))
8303 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8305 ((match-beginning 1) ; #-comment
8306 (or c (setq c (current-indentation)))
8307 (beginning-of-line 2) ; Skip
8308 (cperl-make-indent c))
8311 (just-one-space))))))
8313 (defun cperl-contract-levels ()
8314 "Find an enclosing group in regexp and contract all the kids.
8315 \(Experimental, may change semantics, recheck the result.)
8316 We suppose that the regexp is scanned already."
8320 (cperl-regext-to-level-start)
8321 (error ; We are outside outermost group
8322 (goto-char (cperl-make-regexp-x))))
8323 (let ((b (point)) (e (make-marker)) s c)
8325 (set-marker e (1- (point)))
8327 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
8329 ((match-beginning 1) ; Skip
8332 (cperl-contract-level)))))))
8334 (defun cperl-beautify-level (&optional deep)
8335 "Find an enclosing group in regexp and beautify it.
8336 \(Experimental, may change semantics, recheck the result.)
8337 We suppose that the regexp is scanned already."
8339 (setq deep (if deep (prefix-numeric-value deep) -1))
8341 (cperl-regext-to-level-start)
8342 (let ((b (point)) (e (make-marker)))
8344 (set-marker e (1- (point)))
8345 (cperl-beautify-regexp-piece b e 'level deep))))
8347 (defun cperl-invert-if-unless-modifiers ()
8348 "Change `B if A;' into `if (A) {B}' etc if possible.
8351 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8352 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8353 (and (= (char-syntax (preceding-char)) ?w)
8355 (setq pre-if (point))
8356 (cperl-backward-to-start-of-expr)
8357 (setq pre-B (point))
8358 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8359 (cperl-forward-to-end-of-expr)
8360 (setq post-A (point))
8362 (or (looking-at w-rex)
8363 ;; Find the position
8364 (progn (goto-char post-A)
8366 (not (looking-at w-rex))
8369 (setq pre-if (point))))
8370 (or (looking-at w-rex)
8371 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8372 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8373 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8374 ;; First, simple part: find code boundaries
8376 (setq post-if (point))
8379 (setq post-B (point))
8380 (cperl-backward-to-start-of-expr)
8381 (setq pre-B (point))
8382 (setq B (buffer-substring pre-B post-B))
8386 ;; May be after $, @, $# etc of a variable
8387 (skip-chars-backward "$@%#")
8388 (setq pre-A (point))
8389 (cperl-forward-to-end-of-expr)
8390 (setq post-A (point))
8391 (setq A (buffer-substring pre-A post-A))
8392 ;; Now modify (from end, to not break the stuff)
8393 (skip-chars-forward " \t;")
8394 (delete-region pre-A (point)) ; we move to pre-A
8395 (insert "\n" B ";\n}")
8396 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8397 (delete-region pre-if post-if)
8398 (delete-region pre-B post-B)
8400 (insert if-string " (" A ") {")
8401 (setq post-B (point))
8402 (if (looking-at "[ \t]+$")
8403 (delete-horizontal-space)
8404 (if (looking-at "[ \t]*#")
8405 (cperl-indent-for-comment)
8408 (if (looking-at "[ \t]*$")
8409 (progn ; delete line
8410 (delete-horizontal-space)
8411 (delete-region (point) (1+ (point)))))
8413 (goto-char (1- post-B))
8418 (defun cperl-invert-if-unless ()
8419 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8420 If the cursor is not on the leading keyword of the BLOCK flavor of
8421 construct, will assume it is the STATEMENT flavor, so will try to find
8422 the appropriate statement modifier."
8424 (and (= (char-syntax (preceding-char)) ?w)
8426 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
8427 (let ((pre-if (point))
8428 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8429 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
8431 (setq post-A (point))
8433 (setq pre-A (point))
8434 (setq is-block (and (eq (following-char) ?\( )
8440 (eq (following-char) ?\{ ))
8446 (setq post-B (point))
8448 (setq pre-B (point))
8449 (if (and (eq (following-char) ?\{ )
8451 (cperl-backward-to-noncomment post-A)
8452 (eq (preceding-char) ?\) )))
8453 (if (condition-case nil
8458 (looking-at "\\<els\\(e\\|if\\)\\>"))
8461 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8462 (goto-char (1- post-B))
8463 (cperl-backward-to-noncomment pre-B)
8464 (if (eq (preceding-char) ?\;)
8466 (setq end-B-code (point))
8468 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
8469 (setq p (match-beginning 0)
8470 A (buffer-substring p (match-end 0))
8471 state (parse-partial-sexp pre-B p))
8475 (error "`%s' inside `%s' BLOCK" A if-string))
8476 (goto-char (match-end 0)))
8478 (goto-char (1+ pre-B))
8479 (skip-chars-forward " \t\n")
8480 (setq B (buffer-substring (point) end-B-code))
8481 (goto-char end-B-code)
8482 (or (looking-at ";?[ \t\n]*}")
8484 (skip-chars-forward "; \t\n")
8486 (buffer-substring (point) (1- post-B)))))
8489 (goto-char (1- post-A))
8490 (cperl-backward-to-noncomment pre-A)
8491 (or (looking-at "[ \t\n]*)")
8492 (goto-char (1- post-A)))
8494 (goto-char (1+ pre-A))
8495 (skip-chars-forward " \t\n")
8496 (setq A (buffer-substring (point) p))
8497 (delete-region pre-B post-B)
8498 (delete-region pre-A post-A)
8501 (and B-comment (insert B-comment " "))
8503 (forward-word-strictly 1)
8504 (setq pre-A (point))
8506 (delete-horizontal-space)
8507 (setq post-B (point))
8508 (if (looking-at "#")
8509 (indent-for-comment))
8512 (delete-horizontal-space)
8516 (setq pre-A (set-marker (make-marker) pre-A))
8517 (while (<= (point) (marker-position pre-A))
8520 (goto-char (marker-position pre-A))
8524 (indent-for-comment)
8525 (goto-char (marker-position pre-A)))))
8526 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8527 ;; (error "`%s' not with an (EXPR)" if-string)
8529 (cperl-invert-if-unless-modifiers)))
8530 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8531 (cperl-invert-if-unless-modifiers)))
8533 (declare-function Man-getpage-in-background "man" (topic))
8535 ;;; By Anthony Foiani <afoiani@uswest.com>
8536 ;;; Getting help on modules in C-h f ?
8537 ;;; This is a modified version of `man'.
8538 ;;; Need to teach it how to lookup functions
8540 (defun cperl-perldoc (word)
8541 "Run `perldoc' on WORD."
8543 (list (let* ((default-entry (cperl-word-at-point))
8545 (format "perldoc entry%s: "
8546 (if (string= default-entry "")
8548 (format " (default %s)" default-entry))))))
8549 (if (string= input "")
8550 (if (string= default-entry "")
8551 (error "No perldoc args given")
8555 (let* ((case-fold-search nil)
8557 (string-match "^[a-z]+$" word)
8558 (string-match (concat "^" word "\\>")
8559 (documentation-property
8561 'variable-documentation))))
8563 (manual-program (if is-func "perldoc -f" "perldoc")))
8566 (let ((Manual-program "perldoc")
8567 (Manual-switches (if is-func (list "-f"))))
8568 (manual-entry word)))
8570 (Man-getpage-in-background word)))))
8573 (defun cperl-perldoc-at-point ()
8574 "Run a `perldoc' on the word around point."
8576 (cperl-perldoc (cperl-word-at-point)))
8578 (defcustom pod2man-program "pod2man"
8579 "File name for `pod2man'."
8583 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
8584 (defun cperl-pod-to-manpage ()
8585 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8588 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8589 (bufname (concat "Man " buffer-file-name))
8590 (buffer (generate-new-buffer bufname)))
8591 (with-current-buffer buffer
8592 (let ((process-environment (copy-sequence process-environment)))
8593 ;; Prevent any attempt to use display terminal fanciness.
8594 (setenv "TERM" "dumb")
8595 (set-process-sentinel
8596 (start-process pod2man-program buffer "sh" "-c"
8597 (format (cperl-pod2man-build-command) pod2man-args))
8598 'Man-bgproc-sentinel)))))
8600 ;;; Updated version by him too
8601 (defun cperl-build-manpage ()
8602 "Create a virtual manpage in Emacs from the POD in the file."
8607 (let ((Manual-program "perldoc"))
8608 (manual-entry buffer-file-name)))
8610 (let* ((manual-program "perldoc")
8612 (Man-getpage-in-background buffer-file-name)))))
8614 (defun cperl-pod2man-build-command ()
8615 "Builds the entire background manpage and cleaning command."
8616 (let ((command (concat pod2man-program " %s 2>/dev/null"))
8617 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
8618 (while (and flist (car flist))
8619 (let ((pcom (car (car flist)))
8620 (pargs (cdr (car flist))))
8622 (concat command " | " pcom " "
8623 (mapconcat (lambda (phrase)
8624 (if (not (stringp phrase))
8625 (error "Malformed Man-filter-list"))
8628 (setq flist (cdr flist))))
8632 (defun cperl-next-interpolated-REx-1 ()
8633 "Move point to next REx which has interpolated parts without //o.
8634 Skips RExes consisting of one interpolated variable.
8636 Note that skipped RExen are not performance hits."
8638 (cperl-next-interpolated-REx 1))
8640 (defun cperl-next-interpolated-REx-0 ()
8641 "Move point to next REx which has interpolated parts without //o."
8643 (cperl-next-interpolated-REx 0))
8645 (defun cperl-next-interpolated-REx (&optional skip beg limit)
8646 "Move point to next REx which has interpolated parts.
8647 SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8648 point and the limit of search (default to point and end of buffer).
8650 SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8651 semantic may be used as a numeric argument.
8653 Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8654 a result of qr//, this is not a performance hit), t for the rest."
8656 (if (numberp skip) (setq skip (list 0 skip)))
8657 (or beg (setq beg (point)))
8658 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8660 (and (eq (get-text-property beg 'syntax-type) 'string)
8661 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8662 (cperl-map-pods-heres
8663 (function (lambda (s e p)
8664 (if (memq (get-text-property s 'REx-interpolated) skip)
8668 'REx-interpolated beg limit)
8669 (if pp (goto-char pp)
8670 (message "No more interpolated REx"))))
8672 ;;; Initial version contributed by Trey Belew
8673 (defun cperl-here-doc-spell (&optional beg end)
8674 "Spell-check HERE-documents in the Perl buffer.
8675 If a region is highlighted, restricts to the region."
8677 (cperl-pod-spell t beg end))
8679 (defun cperl-pod-spell (&optional do-heres beg end)
8680 "Spell-check POD documentation.
8681 If invoked with prefix argument, will do HERE-DOCs instead.
8682 If a region is highlighted, restricts to the region."
8686 (if (cperl-mark-active)
8687 (setq beg (min (mark) (point))
8688 end (max (mark) (point)))
8689 (setq beg (point-min)
8691 (cperl-map-pods-heres (function
8694 (setq e (save-excursion
8700 (if do-heres 'here-doc-group 'in-pod)
8703 (defun cperl-map-pods-heres (func &optional prop s end)
8704 "Executes a function over regions of pods or here-documents.
8705 PROP is the text-property to search for; default to `in-pod'. Stop when
8706 function returns nil."
8707 (let (pos posend has-prop (cont t))
8708 (or prop (setq prop 'in-pod))
8709 (or s (setq s (point-min)))
8710 (or end (setq end (point-max)))
8711 (cperl-update-syntaxification end end)
8713 (goto-char (setq pos s))
8714 (while (and cont (< pos end))
8715 (setq has-prop (get-text-property pos prop))
8716 (setq posend (next-single-property-change pos prop nil end))
8718 (setq cont (funcall func pos posend prop)))
8719 (setq pos posend)))))
8721 ;;; Based on code by Masatake YAMATO:
8722 (defun cperl-get-here-doc-region (&optional pos pod)
8723 "Return HERE document region around the point.
8724 Return nil if the point is not in a HERE document region. If POD is non-nil,
8725 will return a POD section if point is in a POD section."
8726 (or pos (setq pos (point)))
8727 (cperl-update-syntaxification pos pos)
8728 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8730 (eq 'pod (get-text-property pos 'syntax-type))))
8731 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8732 (e (next-single-property-change pos 'syntax-type)))
8733 (cons b (or e (point-max))))))
8735 (defun cperl-narrow-to-here-doc (&optional pos)
8736 "Narrows editing region to the HERE-DOC at POS.
8737 POS defaults to the point."
8739 (or pos (setq pos (point)))
8740 (let ((p (cperl-get-here-doc-region pos)))
8741 (or p (error "Not inside a HERE document"))
8742 (narrow-to-region (car p) (cdr p))
8744 "When you are finished with narrow editing, type C-x n w")))
8746 (defun cperl-select-this-pod-or-here-doc (&optional pos)
8747 "Select the HERE-DOC (or POD section) at POS.
8748 POS defaults to the point."
8750 (let ((p (cperl-get-here-doc-region pos t)))
8754 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8755 (message "I do not think POS is in POD or a HERE-doc..."))))
8757 (defun cperl-facemenu-add-face-function (face end)
8758 "A callback to process user-initiated font-change requests.
8759 Translates `bold', `italic', and `bold-italic' requests to insertion of
8760 corresponding POD directives, and `underline' to C<> POD directive.
8762 Such requests are usually bound to M-o LETTER."
8763 (or (get-text-property (point) 'in-pod)
8764 (error "Faces can only be set within POD"))
8765 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8766 (cdr (or (assq face '((bold . "B<")
8768 (bold-italic . "B<I<")
8769 (underline . "C<")))
8770 (error "Face %s not configured for cperl-mode"
8773 (defun cperl-time-fontification (&optional l step lim)
8774 "Times how long it takes to do incremental fontification in a region.
8775 L is the line to start at, STEP is the number of lines to skip when
8776 doing next incremental fontification, LIM is the maximal number of
8777 incremental fontification to perform. Messages are accumulated in
8780 May be used for pinpointing which construct slows down buffer fontification:
8781 start with default arguments, then refine the slowdown regions."
8782 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8784 (or step (setq step 500))
8785 (or lim (setq lim 40))
8786 (let* ((timems (function (lambda ()
8787 (let ((tt (current-time)))
8788 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8789 (tt (funcall timems)) (c 0) delta tot)
8790 (goto-char (point-min))
8791 (forward-line (1- l))
8793 (setq tot (- (- tt (setq tt (funcall timems)))))
8794 (message "cperl-mode at %s: %s" l tot)
8795 (while (and (< c lim) (not (eobp)))
8799 (cperl-update-syntaxification (point) (point))
8800 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8801 (message "to %s:%6s,%7s" l delta tot))
8804 (defvar font-lock-cache-position)
8806 (defun cperl-emulate-lazy-lock (&optional window-size)
8807 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8808 Start fontifying the buffer from the start (or end) using the given
8809 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8810 goes backwards; default is -50. This function is not CPerl-specific; it
8811 may be used to debug problems with delayed incremental fontification."
8813 "nSize of window for incremental fontification, negative goes backwards: ")
8814 (or window-size (setq window-size -50))
8815 (let ((pos (if (> window-size 0)
8821 ;; Why needed??? With older font-locks???
8822 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8823 (while (if (> window-size 0)
8825 (> pos (point-min)))
8827 (forward-line window-size)
8829 (font-lock-fontify-region (min p pos) (max p pos))
8833 (defun cperl-lazy-install ()) ; Avoid a warning
8834 (defun cperl-lazy-unstall ()) ; Avoid a warning
8836 (if (fboundp 'run-with-idle-timer)
8838 (defvar cperl-help-shown nil
8839 "Non-nil means that the help was already shown now.")
8841 (defvar cperl-lazy-installed nil
8842 "Non-nil means that the lazy-help handlers are installed now.")
8844 (defun cperl-lazy-install ()
8845 "Switches on Auto-Help on Perl constructs (put in the message area).
8846 Delay of auto-help controlled by `cperl-lazy-help-time'."
8848 (make-local-variable 'cperl-help-shown)
8849 (if (and (cperl-val 'cperl-lazy-help-time)
8850 (not cperl-lazy-installed))
8852 (add-hook 'post-command-hook 'cperl-lazy-hook)
8853 (run-with-idle-timer
8854 (cperl-val 'cperl-lazy-help-time 1000000 5)
8856 'cperl-get-help-defer)
8857 (setq cperl-lazy-installed t))))
8859 (defun cperl-lazy-unstall ()
8860 "Switches off Auto-Help on Perl constructs (put in the message area).
8861 Delay of auto-help controlled by `cperl-lazy-help-time'."
8863 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8864 (cancel-function-timers 'cperl-get-help-defer)
8865 (setq cperl-lazy-installed nil))
8867 (defun cperl-lazy-hook ()
8868 (setq cperl-help-shown nil))
8870 (defun cperl-get-help-defer ()
8871 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
8872 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8874 (setq cperl-help-shown t))))
8875 (cperl-lazy-install)))
8878 ;;; Plug for wrong font-lock:
8880 (defun cperl-font-lock-unfontify-region-function (beg end)
8881 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8882 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8883 (inhibit-modification-hooks t)
8884 deactivate-mark buffer-file-name buffer-file-truename)
8885 (remove-text-properties beg end '(face nil))
8886 (if (and (not modified) (buffer-modified-p))
8887 (set-buffer-modified-p nil))))
8889 (defun cperl-font-lock-fontify-region-function (beg end loudly)
8890 "Extends the region to safe positions, then calls the default function.
8891 Newer `font-lock's can do it themselves.
8892 We unwind only as far as needed for fontification. Syntaxification may
8893 do extra unwind via `cperl-unwind-to-safe'."
8899 (eq (get-text-property (setq beg (point)) 'syntax-type)
8901 (let ((new-beg (cperl-beginning-of-property beg 'syntax-type)))
8902 (setq beg (if (= new-beg beg) nil new-beg))
8903 (goto-char new-beg)))
8908 (or (bolp) (condition-case nil
8911 (eq (get-text-property (setq end (point)) 'syntax-type)
8913 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8916 (font-lock-default-fontify-region beg end loudly))
8918 (defvar cperl-d-l nil)
8919 (defun cperl-fontify-syntaxically (end)
8920 ;; Some vars for debugging only
8921 ;; (message "Syntaxifying...")
8922 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
8923 (istate (car cperl-syntax-state))
8924 start from-start edebug-backtrace-buffer)
8925 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8928 (let ((f 'edebug-backtrace))
8929 (funcall f)))) ; Avoid compile-time warning
8930 (or cperl-syntax-done-to
8931 (setq cperl-syntax-done-to (point-min)
8933 (setq start (if (and cperl-hook-after-change
8935 cperl-syntax-done-to ; Fontify without change; ignore start
8936 ;; Need to forget what is after `start'
8937 (min cperl-syntax-done-to (point))))
8940 (setq start (point))
8941 (and cperl-syntaxify-unwind
8942 (setq end (cperl-unwind-to-safe t end)
8945 (setq cperl-syntax-done-to start) ; In case what follows fails
8946 (cperl-find-pods-heres start end t nil t))
8947 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8948 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8949 dbg iend start end idone cperl-syntax-done-to
8950 istate (car cperl-syntax-state))) ; For debugging
8951 nil)) ; Do not iterate
8953 (defun cperl-fontify-update (end)
8954 (let ((pos (point-min)) prop posend)
8955 (setq end (point-max))
8957 (setq prop (get-text-property pos 'cperl-postpone)
8958 posend (next-single-property-change pos 'cperl-postpone nil end))
8959 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8961 nil) ; Do not iterate
8963 (defun cperl-fontify-update-bad (end)
8964 ;; Since fontification happens with different region than syntaxification,
8965 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8966 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8968 (setq pos (or (cperl-beginning-of-property
8969 (cperl-1+ pos) 'cperl-postpone)
8972 (setq posend (next-single-property-change pos 'cperl-postpone))
8973 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8975 (setq prop (get-text-property pos 'cperl-postpone))))
8976 nil) ; Do not iterate
8978 ;; Called when any modification is made to buffer text.
8979 (defun cperl-after-change-function (beg end old-len)
8980 ;; We should have been informed about changes by `font-lock'. Since it
8981 ;; does not inform as which calls are deferred, do it ourselves
8982 (if cperl-syntax-done-to
8983 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8985 (defun cperl-update-syntaxification (from to)
8987 ((not cperl-use-syntax-table-text-property) nil)
8988 ((fboundp 'syntax-propertize) (syntax-propertize to))
8989 ((and cperl-syntaxify-by-font-lock
8990 (or (null cperl-syntax-done-to)
8991 (< cperl-syntax-done-to to)))
8994 (cperl-fontify-syntaxically to)))))
8996 (defvar cperl-version
8997 (let ((v "Revision: 6.2"))
8998 (string-match ":\\s *\\([0-9.]+\\)" v)
8999 (substring v (match-beginning 1) (match-end 1)))
9000 "Version of IZ-supported CPerl package this file is based on.")
9002 (provide 'cperl-mode)
9004 ;;; cperl-mode.el ends here